Image codec [C++ API].

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

Member Functions

Construction & Destruction

BLImageCodec()

BLImageCodec(BLImageCodec&& other)

BLImageCodec(const BLImageCodec& other)

~BLImageCodec()

Overloaded Operators

operator bool() const

BLImageCodec& operator=(const BLImageCodec& other)

bool operator==(const BLImageCodec& other) const

bool operator!=(const BLImageCodec& other) const

Common Functionality

BLResult reset()

void swap(BLImageCodecCore& other)

BLResult assign(const BLImageCodecCore& other)

bool isValid() const

bool equals(const BLImageCodecCore& other) const

Accessors

const BLString& name() const

const BLString& vendor() const

const BLString& mimeType() const

const BLString& extensions() const

BLImageCodecFeatures features() const

bool hasFeature(BLImageCodecFeatures feature) 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)

Find Functionality

BLResult findByName(const char* name)

BLResult findByName(const char* name, const BLArray<BLImageCodec>& codecs)

BLResult findByName(BLStringView name)

BLResult findByName(BLStringView name, const BLArray<BLImageCodec>& codecs)

BLResult findByExtension(const char* name)

BLResult findByExtension(const char* name, const BLArray<BLImageCodec>& codecs)

BLResult findByExtension(BLStringView name)

BLResult findByExtension(BLStringView name, const BLArray<BLImageCodec>& codecs)

BLResult findByData(const void* data, size_t size)

BLResult findByData(const void* data, size_t size, const BLArray<BLImageCodec>& codecs)

BLResult findByData(const BLArrayView<uint8_t>& view)

BLResult findByData(const BLArrayView<uint8_t>& view, const BLArray<BLImageCodec>& codecs)

BLResult findByData(const BLArray<uint8_t>& buffer)

BLResult findByData(const BLArray<uint8_t>& buffer, const BLArray<BLImageCodec>& codecs)

Codec Functionality

uint32_t inspectData(const BLArray<uint8_t>& buffer) const

uint32_t inspectData(const BLArrayView<uint8_t>& view) const

uint32_t inspectData(const void* data, size_t size) const

BLResult createDecoder(BLImageDecoderCore* dst) const

BLResult createEncoder(BLImageEncoderCore* dst) const

Static Functions

Built-In Codecs

static BLArray<BLImageCodec> builtInCodecs()

static BLResult addToBuiltIn(const BLImageCodecCore& codec)

static BLResult removeFromBuiltIn(const BLImageCodecCore& codec)

Additional Inherited Members

Public Attributes inherited from BLObjectCore

Member Function Documentation

bool BLImageCodec::isValid() const◆

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

const BLString& BLImageCodec::name() const◆

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

const BLString& BLImageCodec::vendor() const◆

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

const BLString& BLImageCodec::mimeType() const◆

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

const BLString& BLImageCodec::extensions() const◆

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

BLImageCodecFeatures BLImageCodec::features() const◆

Returns image codec flags, see BLImageCodecFeatures.

bool BLImageCodec::hasFeature(BLImageCodecFeatures feature) const◆

Tests whether the image codec has a flag flag.

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

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

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

Sets a property of the given name to value.

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