Image decoder [C++ API].

Member Functions

Construction & Destruction

BLImageDecoder()

BLImageDecoder(BLImageDecoder&& other)

BLImageDecoder(const BLImageDecoder& other)

~BLImageDecoder()

Overloaded Operators

operator bool() const

BLImageDecoder& operator=(BLImageDecoder&& other)

BLImageDecoder& operator=(const BLImageDecoder& other)

bool operator==(const BLImageDecoder& other) const

bool operator!=(const BLImageDecoder& other) const

Common Functionality

BLResult reset()

void swap(BLImageDecoderCore& other)

BLResult assign(BLImageDecoderCore&& other)

BLResult assign(const BLImageDecoderCore& other)

bool isValid() const

bool equals(const BLImageDecoderCore& 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)

Decoder Functionality

BLResult restart()

BLResult readInfo(BLImageInfo& dst, const BLArray<uint8_t>& buffer)

BLResult readInfo(BLImageInfo& dst, const BLArrayView<uint8_t>& view)

BLResult readInfo(BLImageInfo& dst, const void* data, size_t size)

BLResult readFrame(BLImageCore& dst, const BLArray<uint8_t>& buffer)

BLResult readFrame(BLImageCore& dst, const BLArrayView<uint8_t>& view)

BLResult readFrame(BLImageCore& dst, const void* data, size_t size)

Public Member Functions inherited from BLImageDecoderCore

Additional Inherited Members

Public Attributes inherited from BLObjectCore

Member Function Documentation

bool BLImageDecoder::isValid() const◆

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

BLResult BLImageDecoder::lastResult() const◆

Returns the last decoding result.

uint64_t BLImageDecoder::frameIndex() const◆

Returns the current frame index (to be decoded).

size_t BLImageDecoder::bufferIndex() const◆

Returns the position in source buffer.

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

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

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

Sets a property of the given name to value.

BLResult BLImageDecoder::setProperty(BLStringView name, const BLObjectCore& value)[2/2]◆