Class vl::EncodedImage#

The camera image encoded to a binary file format.

#include <encodedimage.h>

Public Functions#

Type	Name
	EncodedImage ()
	EncodedImage (const EncodedImage & img) = default
	EncodedImage (const Image & img, const EncodingSettings & enc) Construct new encoded image from raw image, given the respective EncodingSettings .
void	create (const Image & img, const EncodingSettings & enc) Create new encoded image (in-place)
const std::vector< uint8_t > &	data () const The encoded image data (comparable to a binary file read)
ImageEncoding	encoding () const Get the encoded image's encoding type.
ImageFormat	format () const Get the encoded image's image format.
size_t	height () const Get the encoded image's height.
MemoryResource *	memoryResource () const Get the encoded image's raw memory resource.
const uint8_t *	ptr () const The raw encoded image data (comparable to a binary file read)
size_t	size () const Full size of encoded image (comparable to file size of binary file)
bool	valid () const Flag, indicating the validity of the image.
size_t	width () const Get the encoded image's width.
virtual	~EncodedImage ()

Public Functions Documentation#

function EncodedImage [1/3]#

vl::EncodedImage::EncodedImage ()

function EncodedImage [2/3]#

vl::EncodedImage::EncodedImage (
    const  EncodedImage & img
) = default

function EncodedImage [3/3]#

Construct new encoded image from raw image, given the respective EncodingSettings .

vl::EncodedImage::EncodedImage (
    const  Image & img,
    const  EncodingSettings & enc
)

Parameters:

img the raw image to be encoded
enc the EncodingSettings to apply

function create#

Create new encoded image (in-place)

void vl::EncodedImage::create (
    const  Image & img,
    const  EncodingSettings & enc
)

Parameters:

img the raw image to be encoded
enc the EncodingSettings to apply

function data#

The encoded image data (comparable to a binary file read)

const std::vector< uint8_t > & vl::EncodedImage::data () const

Returns:

bytes

function encoding#

Get the encoded image's encoding type.

ImageEncoding vl::EncodedImage::encoding () const

Returns:

ImageEncoding

function format#

Get the encoded image's image format.

ImageFormat vl::EncodedImage::format () const

Returns:

ImageFormat

function height#

Get the encoded image's height.

size_t vl::EncodedImage::height () const

Returns:

height in px

function memoryResource#

Get the encoded image's raw memory resource.

MemoryResource * vl::EncodedImage::memoryResource () const

Returns:

MemoryResource

function ptr#

The raw encoded image data (comparable to a binary file read)

const  uint8_t * vl::EncodedImage::ptr () const

Returns:

raw pointer

function size#

Full size of encoded image (comparable to file size of binary file)

size_t vl::EncodedImage::size () const

Returns:

size of image

function valid#

Flag, indicating the validity of the image.

bool vl::EncodedImage::valid () const

Returns:

true if valid

function width#

Get the encoded image's width.

size_t vl::EncodedImage::width () const

Returns:

width in px

function ~EncodedImage#

virtual vl::EncodedImage::~EncodedImage ()

The documentation for this class was generated from the following file docs/libvl/build/2.0.0/doxygen/source/vl/encodedimage.h