PNG Class Reference

Encodes or decodes PNG compression. More...

Public Member Functions
void	Decode (const Byte *input, std::size_t size, Containers::Image &output)
	Decodes the given PNG data. More...
void	Decode (const std::string &input, Containers::Image &output)
	Decodes the given PNG data. More...
void	Decode (std::istream &input, Containers::Image &output)
	Decodes the given PNG data. More...
void	Decode (std::vector< Byte > &input, Containers::Image &output)
	Decodes the given PNG data. More...
void	Encode (const Containers::Image &input, const std::string &output, bool replace_colormode=false)
	Encodes a given input. More...
void	Encode (const Containers::Image &input, std::ostream &output, bool replace_colormode=false)
	Encodes a given input. More...
void	Encode (const Containers::Image &input, std::vector< Byte > &output, bool replace_colormode=false)
	Encodes a given input. More...

Protected Member Functions
void	decode (png::Reader *reader, Containers::Image &output)
	Performs actual decoding. More...
void	encode (const Containers::Image &input, png::Writer *write, bool replace_colormode)
	Performs actual encoding. More...

Detailed Description

Encodes or decodes PNG compression.

Member Function Documentation

Decode() [1/4]

void Decode	(	const Byte *	input,
		std::size_t	size,
		Containers::Image &	output
	)

Decodes the given PNG data.

This function may produce an image with the following color modes: Grayscale, Grayscale_Alpha, RGB, RGBA. In this variant data is read from an array.

Exceptions

runtime_error

in case of a read error

References PNG::decode().

Decode() [2/4]

void Decode	(	const std::string &	input,
		Containers::Image &	output
	)

Decodes the given PNG data.

This function may produce an image with the following color modes: Grayscale, Grayscale_Alpha, RGB, RGBA. This variant opens and reads data from a file.

Exceptions

runtime_error

in case of a read error

References PNG::decode().

decode()

void decode ( png::Reader *  reader, Containers::Image &  output  )

protected

Performs actual decoding.

References basic_Image< T_ >::GetChannelsPerPixel(), Gorgon::Graphics::Grayscale, basic_Size< T_ >::Height, Gorgon::Graphics::Invalid, basic_Image< T_ >::RawData(), basic_Image< T_ >::Resize(), Gorgon::Graphics::RGB, Gorgon::Graphics::RGBA, and basic_Size< T_ >::Width.

Decode() [3/4]

void Decode	(	std::istream &	input,
		Containers::Image &	output
	)

Decodes the given PNG data.

This function may produce an image with the following color modes: Grayscale, Grayscale_Alpha, RGB, RGBA. This variant reads data from the file.

Exceptions

runtime_error

in case of a read error

References PNG::decode().

Decode() [4/4]

void Decode	(	std::vector< Byte > &	input,
		Containers::Image &	output
	)

Decodes the given PNG data.

This function may produce an image with the following color modes: Grayscale, Grayscale_Alpha, RGB, RGBA. This variant reads data from the vector.

Exceptions

runtime_error

in case of a read error

References PNG::decode().

Encode() [1/3]

void Encode	(	const Containers::Image &	input,
		const std::string &	output,
		bool	replace_colormode = false
	)

Encodes a given input.

This variant opens the given file and writes on that file

Exceptions

runtime_error

in case of an encoding error

References PNG::encode().

encode()

void encode ( const Containers::Image &  input, png::Writer *  write, bool  replace_colormode  )

protected

Performs actual encoding.

References Gorgon::Graphics::Alpha, basic_Image< T_ >::GetChannelsPerPixel(), basic_Image< T_ >::GetMode(), basic_Image< T_ >::GetSize(), basic_Image< T_ >::GetTotalSize(), Gorgon::Graphics::Grayscale, basic_Size< T_ >::Height, Gorgon::Graphics::Invalid, basic_Image< T_ >::RawData(), Gorgon::Graphics::RGB, Gorgon::Graphics::RGBA, and basic_Size< T_ >::Width.

Encode() [2/3]

void Encode	(	const Containers::Image &	input,
		std::ostream &	output,
		bool	replace_colormode = false
	)

Encodes a given input.

This variant writes to a stream

Warning

Array write buffer should either be a nullptr of type Byte or an array allocated with malloc. This system uses realloc or malloc to resize raw arrays.

Exceptions

runtime_error

in case of an encoding error

References PNG::encode().

Encode() [3/3]

void Encode	(	const Containers::Image &	input,
		std::vector< Byte > &	output,
		bool	replace_colormode = false
	)

Encodes a given input.

This variant writes data to a vector. Vector is resized automatically.

Warning

Array write buffer should either be a nullptr of type Byte or an array allocated with malloc. This system uses realloc or malloc to resize raw arrays.

Exceptions

runtime_error

in case of an encoding error

References PNG::encode().

---

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

• Gorgon/Encoding/PNG.h
• Gorgon/Encoding/PNG.cpp