IndexImagingBLImageEncoder

BLImageEncoder Class Referencefinal [¶]

Image encoder [C++ API].

Member Functions

Construction & Destruction
Overloaded Operators
Common Functionality
Accessors
Properties
Encoder Functionality
Public Member Functions inherited from BLImageEncoderCore

Additional Inherited Members

Public Attributes inherited from BLObjectCore

bool BLImageEncoder::is_valid() constnodiscardnoexcept[¶]

Tests whether the image encoder is a built-in null instance.

BLResult BLImageEncoder::last_result() constnodiscardnoexcept[¶]

Returns the last encoding result.

uint64_t BLImageEncoder::frame_index() constnodiscardnoexcept[¶]

Returns the current frame index (yet to be written).

size_t BLImageEncoder::buffer_index() constnodiscardnoexcept[¶]

Returns the position in destination buffer.

BLResult BLImageEncoder::get_property(
const char* name,
BLVarCore& value_out
) constnoexcept[1/2][¶]

Gets a property of the given name and assigns it to an initialized value_out.

BLResult BLImageEncoder::get_property(
BLVarCore& value_out
) constnoexcept[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

BLResult BLImageEncoder::set_property(
const char* name,
const BLObjectCore& value
)noexcept[1/2][¶]

Sets a property of the given name to value.

BLResult BLImageEncoder::set_property(
const BLObjectCore& value
)noexcept[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

BLResult BLImageEncoder::write_frame(
BLArray<uint8_t>& dst,
const BLImageCore& image
)noexcept[¶]

Encodes the given image and writes the encoded data to the destination buffer dst.