Image encoder [C++ API].

Member Functions

Construction & Destruction

BLImageEncoder()

BLImageEncoder(BLImageEncoder&& other)

BLImageEncoder(const BLImageEncoder& other)

~BLImageEncoder()

Overloaded Operators

operator bool() const

BLImageEncoder& operator=(BLImageEncoder&& other)

BLImageEncoder& operator=(const BLImageEncoder& other)

bool operator==(const BLImageEncoder& other) const

bool operator!=(const BLImageEncoder& other) const

Common Functionality

BLResult reset()

void swap(BLImageEncoderCore& other)

BLResult assign(BLImageEncoderCore&& other)

BLResult assign(const BLImageEncoderCore& other)

bool isValid() const

bool equals(const BLImageEncoderCore& other) const

Accessors

BLImageCodec& codec() const

BLResult lastResult() const

uint64_t frameIndex() const

size_t bufferIndex() const

Properties

BLResult getProperty(const char* name, BLVarCore& valueOut) const

BLResult getProperty(BLStringView name, BLVarCore& valueOut) const

BLResult setProperty(const char* name, const BLObjectCore& value)

BLResult setProperty(BLStringView name, const BLObjectCore& value)

Encoder Functionality

BLResult restart()

BLResult writeFrame(BLArray<uint8_t>& dst, const BLImageCore& image)

Public Member Functions inherited from BLImageEncoderCore

Additional Inherited Members

Public Attributes inherited from BLObjectCore

Member Function Documentation

bool BLImageEncoder::isValid() const◆

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

BLResult BLImageEncoder::lastResult() const◆

Returns the last encoding result.

uint64_t BLImageEncoder::frameIndex() const◆

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

size_t BLImageEncoder::bufferIndex() const◆

Returns the position in destination buffer.

BLResult BLImageEncoder::getProperty(const char* name, BLVarCore& valueOut) const[1/2]◆

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

BLResult BLImageEncoder::getProperty(BLStringView name, BLVarCore& valueOut) const[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::setProperty(const char* name, const BLObjectCore& value)[1/2]◆

Sets a property of the given name to value.

BLResult BLImageEncoder::setProperty(BLStringView name, const BLObjectCore& value)[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::writeFrame(BLArray<uint8_t>& dst, const BLImageCore& image)◆

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