GEO::ImageSerializer_xpm Class Reference

Inheritance diagram for GEO::ImageSerializer_xpm:

Public Member Functions
Image *	serialize_read_from_stream (std::istream &stream) override
	reads an image from a stream.
bool	read_supported () const override
	Tests whether reading is implemented.
bool	binary () const override
	Tests whether the file format is binary or ASCII.
Public Member Functions inherited from GEO::ImageSerializer
virtual Image *	serialize_read (const std::string &file_name)
	reads an image from a file.
virtual bool	serialize_write (const std::string &file_name, const Image *image)
	writes an image into a file.
virtual bool	serialize_write_to_stream (std::ostream &stream, const Image *image)
	writes an image into a stream.
virtual bool	streams_supported () const
	Tests whether the functions that use streams are supported.
virtual bool	write_supported () const
	Tests whether writing is implemented.
Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.
void	unref () const
	Decrements the reference count.
bool	is_shared () const
	Check if the object is shared.
int	nb_refs () const
	Gets the number of references that point to this object.

Static Public Member Functions
static Image *	create_image_from_xpm_data (const char *s)
	Creates an image from XPM data.
Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.
static void	unref (const Counted *counted)
	Decrements the reference count.

Static Protected Member Functions
static Image *	serialize_read_static (std::istream &stream)
static Image *	read_xpm_1_byte_per_pixel (int width, int height, int num_colors, std::istream &input)
static Image *	read_xpm_2_bytes_per_pixel (int width, int height, int num_colors, std::istream &input)
static char *	next_xpm_data (std::istream &input)

Additional Inherited Members
Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.
virtual	~Counted ()
	Destroys a reference counted object.

Detailed Description

Definition at line 50 of file image_serializer_xpm.h.

Member Function Documentation

binary()

bool GEO::ImageSerializer_xpm::binary ( ) const

overridevirtual

Tests whether the file format is binary or ASCII.

It is used to determine whether a stream should be opened in ASCII or binary mode for loading image files. Default implementation in base class returns true.

Return values

true	if the file format is binary
false	if the file format is ASCII

Reimplemented from GEO::ImageSerializer.

create_image_from_xpm_data()

static Image * GEO::ImageSerializer_xpm::create_image_from_xpm_data ( const char *  s )

static

Creates an image from XPM data.

Parameters

[in]

s

the string with the XPM data.

Returns

the created image.

read_supported()

bool GEO::ImageSerializer_xpm::read_supported ( ) const

overridevirtual

Tests whether reading is implemented.

Some serializers implement only reading or only writing. Default implementation returns false

Return values

true	if reading is supported
false	otherwise

Reimplemented from GEO::ImageSerializer.

serialize_read_from_stream()

Image * GEO::ImageSerializer_xpm::serialize_read_from_stream ( std::istream &  stream )

overridevirtual

reads an image from a stream.

Parameters

[in,out]

stream

the stream where the image should be read from

Returns

a pointer to the loaded image or nil if the image could not be loaded

Note

the loaded image can be stored in an Image_var

Reimplemented from GEO::ImageSerializer.

---

The documentation for this class was generated from the following file:

• geogram/image/image_serializer_xpm.h