Offers capabilities to encode and decode JPEG format. More...

Static Public Member Functions
static nkMemory::Buffer	encode (const ImageView &image, const JpgCompressionSettings &settings=JpgCompressionSettings())

static bool	canDecode (nkMemory::BufferView< unsigned char > data)

static Image	decode (nkMemory::BufferView< unsigned char > data, const AlignmentDescriptor &alignmentDescriptor=AlignmentDescriptor())

Detailed Description

Offers capabilities to encode and decode JPEG format.

Member Function Documentation

static nkMemory::Buffer nkImages::JpgEncoder::encode	(	const ImageView &	image,
		const JpgCompressionSettings &	settings = `JpgCompressionSettings()`
	)

static

Encodes an image into a binary buffer fitting the Jpg format.

Parameters

image	The image to encode.
settings	The encoding settings driving compression method.

static bool nkImages::JpgEncoder::canDecode ( nkMemory::BufferView< unsigned char > data )

static

Checks whether a binary buffer can be decoded by this encoder. This checks the data first and last bytes for the magic markers.

Parameters

data	The binary data which need to be checked.

static Image nkImages::JpgEncoder::decode	(	nkMemory::BufferView< unsigned char >	data,
		const AlignmentDescriptor &	alignmentDescriptor = `AlignmentDescriptor()`
	)

static

Decodes a binary buffer into its image representation.

Currently supported features are :

Parameters

data	The binary buffer to decode.
alignmentDescriptor	If decoded image's data needs to fit some alignment requirements, they can be specified through this parameter.

Remarks: If something goes wrong, the error will be logged and an empty image will be returned.

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