GEO::ImageSerializerSTB Class Reference

Loads and saves images. More...

#include <geogram/image/image_serializer_stb.h>

Inheritance diagram for GEO::ImageSerializerSTB:

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

Additional Inherited Members
Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count. More...
static void	unref (const Counted *counted)
	Decrements the reference count. More...
Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object. More...
virtual	~Counted ()
	Destroys a reference counted object. More...

Detailed Description

Loads and saves images.

Definition at line 62 of file image_serializer_stb.h.

Constructor & Destructor Documentation

ImageSerializerSTB()

GEO::ImageSerializerSTB::ImageSerializerSTB	(	bool	read,
		bool	write
	)

ImageSerializerSTB constructor.

Parameters

[in]	read	true if reading is supported
[in]	write	true if writing is supported

Member Function Documentation

binary()

bool GEO::ImageSerializerSTB::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.

read_supported()

bool GEO::ImageSerializerSTB::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()

Image* GEO::ImageSerializerSTB::serialize_read ( const std::string &  file_name )

overridevirtual

Reimplemented from GEO::ImageSerializer.

serialize_write()

bool GEO::ImageSerializerSTB::serialize_write ( const std::string &  file_name, const Image *  image  )

overridevirtual

Reimplemented from GEO::ImageSerializer.

streams_supported()

bool GEO::ImageSerializerSTB::streams_supported ( ) const

overridevirtual

Tests whether the functions that use streams are supported.

Default implementation in base class returns true.

Return values

true	if the functions that use streams are supported
false	otherwise

This version returns false

Reimplemented from GEO::ImageSerializer.

write_supported()

bool GEO::ImageSerializerSTB::write_supported ( ) const

overridevirtual

Tests whether writing is implemented.

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

Return values

true	if writing is supported
false	otherwise

Reimplemented from GEO::ImageSerializer.

---

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

• geogram/image/image_serializer_stb.h