Blend2D
2D Vector Graphics Engine
About
Roadmap
Performance
Docs
Blog
Research
Support
Download
{Fiddle}
Index ⭢ Imaging ⭢ BLImageDecoder
BLImageDecoder Class Referencefinal

Image decoder [C++ API].

Member Functions

Construction & Destruction
BLImageDecoder() noexcept
BLImageDecoder(BLImageDecoder&& other) noexcept
BLImageDecoder(const BLImageDecoder& other) noexcept
~BLImageDecoder()
Overloaded Operators
operator bool() const noexcept
BLImageDecoder& operator=(BLImageDecoder&& other) noexcept
BLImageDecoder& operator=(const BLImageDecoder& other) noexcept
bool operator==(const BLImageDecoder& other) const noexcept
bool operator!=(const BLImageDecoder& other) const noexcept
Common Functionality
BLResult reset() noexcept
void swap(BLImageDecoderCore& other) noexcept
BLResult assign(BLImageDecoderCore&& other) noexcept
BLResult assign(const BLImageDecoderCore& other) noexcept
bool isValid() const noexcept
bool equals(const BLImageDecoderCore& other) const noexcept
Accessors
BLImageCodec& codec() const noexcept
BLResult lastResult() const noexcept
uint64_t frameIndex() const noexcept
size_t bufferIndex() const noexcept
Properties
BLResult getProperty(const char* name, BLVarCore& valueOut) const noexcept
BLResult getProperty(BLStringView name, BLVarCore& valueOut) const noexcept
BLResult setProperty(const char* name, const BLObjectCore& value) noexcept
BLResult setProperty(BLStringView name, const BLObjectCore& value) noexcept
Decoder Functionality
BLResult restart() noexcept
BLResult readInfo(BLImageInfo& dst, const BLArray<uint8_t>& buffer) noexcept
BLResult readInfo(BLImageInfo& dst, const BLArrayView<uint8_t>& view) noexcept
BLResult readInfo(BLImageInfo& dst, const void* data, size_t size) noexcept
BLResult readFrame(BLImageCore& dst, const BLArray<uint8_t>& buffer) noexcept
BLResult readFrame(BLImageCore& dst, const BLArrayView<uint8_t>& view) noexcept
BLResult readFrame(BLImageCore& dst, const void* data, size_t size) noexcept
- Public Member Functions inherited from BLImageDecoderCore

Additional Inherited Members

- Public Attributes inherited from BLObjectCore

bool BLImageDecoder::isValid() constnoexcept[¶]

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

BLResult BLImageDecoder::lastResult() constnoexcept[¶]

Returns the last decoding result.

uint64_t BLImageDecoder::frameIndex() constnoexcept[¶]

Returns the current frame index (to be decoded).

size_t BLImageDecoder::bufferIndex() constnoexcept[¶]

Returns the position in source buffer.

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

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

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

Sets a property of the given name to value.

BLResult BLImageDecoder::setProperty(
BLStringView name,
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.

© 2017-2024 Blend2D Team | GitHub | Chat | Support | Download
Blend2D library and its dependencies are open source software released under the Zlib license and can be used safely in any open-source or commercial product, statically or dynamically linked, and without advertising the use of Blend2D. Code snippets and examples are released into public domain, see Unlicense for more details.