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

Image codec [C++ API].

Provides a unified interface for inspecting image data and creating image decoders & encoders.

Member Functions

Construction & Destruction
BLImageCodec() noexcept
BLImageCodec(BLImageCodec&& other) noexcept
BLImageCodec(const BLImageCodec& other) noexcept
~BLImageCodec()
Overloaded Operators
operator bool() const noexcept
BLImageCodec& operator=(const BLImageCodec& other) noexcept
bool operator==(const BLImageCodec& other) const noexcept
bool operator!=(const BLImageCodec& other) const noexcept
Common Functionality
BLResult reset() noexcept
void swap(BLImageCodecCore& other) noexcept
BLResult assign(const BLImageCodecCore& other) noexcept
bool isValid() const noexcept
bool equals(const BLImageCodecCore& other) const noexcept
Accessors
const BLString& name() const noexcept
const BLString& vendor() const noexcept
const BLString& mimeType() const noexcept
const BLString& extensions() const noexcept
BLImageCodecFeatures features() const noexcept
bool hasFeature(BLImageCodecFeatures feature) 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
Find Functionality
BLResult findByName(const char* name) noexcept
BLResult findByName(const char* name, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByName(BLStringView name) noexcept
BLResult findByName(BLStringView name, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByExtension(const char* name) noexcept
BLResult findByExtension(const char* name, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByExtension(BLStringView name) noexcept
BLResult findByExtension(BLStringView name, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByData(const void* data, size_t size) noexcept
BLResult findByData(const void* data, size_t size, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByData(const BLArrayView<uint8_t>& view) noexcept
BLResult findByData(const BLArrayView<uint8_t>& view, const BLArray<BLImageCodec>& codecs) noexcept
BLResult findByData(const BLArray<uint8_t>& buffer) noexcept
BLResult findByData(const BLArray<uint8_t>& buffer, const BLArray<BLImageCodec>& codecs) noexcept
Codec Functionality
uint32_t inspectData(const BLArray<uint8_t>& buffer) const noexcept
uint32_t inspectData(const BLArrayView<uint8_t>& view) const noexcept
uint32_t inspectData(const void* data, size_t size) const noexcept
BLResult createDecoder(BLImageDecoderCore* dst) const noexcept
BLResult createEncoder(BLImageEncoderCore* dst) const noexcept

Static Functions

Built-In Codecs
static BLArray<BLImageCodec> builtInCodecs() noexcept
static BLResult addToBuiltIn(const BLImageCodecCore& codec) noexcept
static BLResult removeFromBuiltIn(const BLImageCodecCore& codec) noexcept

Additional Inherited Members

- Public Attributes inherited from BLObjectCore

bool BLImageCodec::isValid() constnoexcept[¶]

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

const BLString& BLImageCodec::name() constnoexcept[¶]

Returns image codec name (i.e, "PNG", "JPEG", etc...).

const BLString& BLImageCodec::vendor() constnoexcept[¶]

Returns the image codec vendor (i.e. "Blend2D" for all built-in codecs).

const BLString& BLImageCodec::mimeType() constnoexcept[¶]

Returns a mime-type associated with the image codec's format.

const BLString& BLImageCodec::extensions() constnoexcept[¶]

Returns a list of file extensions used to store image of this codec, separated by '|' character.

BLImageCodecFeatures BLImageCodec::features() constnoexcept[¶]

Returns image codec flags, see BLImageCodecFeatures.

bool BLImageCodec::hasFeature(
BLImageCodecFeatures feature
) constnoexcept[¶]

Tests whether the image codec has a flag flag.

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

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

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

Sets a property of the given name to value.

BLResult BLImageCodec::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.

BLArray<BLImageCodec>BLImageCodec::builtInCodecs()staticnoexcept[¶]

Returns an array of built-in codecs, which are present in a global registry.

BLResult BLImageCodec::addToBuiltIn(
const BLImageCodecCore& codec
)staticnoexcept[¶]

Adds a codec to a global built-in codecs registry.

BLResult BLImageCodec::removeFromBuiltIn(
const BLImageCodecCore& codec
)staticnoexcept[¶]

Removes a codec from a global built-in codecs registry.

© 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.