IndexImagingBLImageCodec

BLImageCodec Class Referencefinal [¶]

Image codec [C++ API].

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

Member Functions

Construction & Destruction
Overloaded Operators
Common Functionality
Accessors
Properties
Find Functionality
Codec Functionality

Static Functions

Built-In Codecs

Additional Inherited Members

Public Attributes inherited from BLObjectCore

bool BLImageCodec::is_valid() constnodiscardnoexcept[¶]

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

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

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

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

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

const BLString& BLImageCodec::mime_type() constnodiscardnoexcept[¶]

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

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

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

BLImageCodecFeatures BLImageCodec::features() constnodiscardnoexcept[¶]

Returns image codec flags, see BLImageCodecFeatures.

bool BLImageCodec::has_feature() constnodiscardnoexcept[¶]

Tests whether the image codec has a flag flag.

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

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

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

Sets a property of the given name to value.

BLResult BLImageCodec::set_property(
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::built_in_codecs()staticnodiscardnoexcept[¶]

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

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

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

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

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