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

Image encoder [C++ API].

Member Functions

Construction & Destruction
BLImageEncoder() noexcept
BLImageEncoder(BLImageEncoder&& other) noexcept
BLImageEncoder(const BLImageEncoder& other) noexcept
~BLImageEncoder()
Overloaded Operators
operator bool() const noexcept
BLImageEncoder& operator=(BLImageEncoder&& other) noexcept
BLImageEncoder& operator=(const BLImageEncoder& other) noexcept
bool operator==(const BLImageEncoder& other) const noexcept
bool operator!=(const BLImageEncoder& other) const noexcept
Common Functionality
BLResult reset() noexcept
void swap(BLImageEncoderCore& other) noexcept
BLResult assign(BLImageEncoderCore&& other) noexcept
BLResult assign(const BLImageEncoderCore& other) noexcept
bool isValid() const noexcept
bool equals(const BLImageEncoderCore& 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
Encoder Functionality
BLResult restart() noexcept
BLResult writeFrame(BLArray<uint8_t>& dst, const BLImageCore& image) noexcept
- Public Member Functions inherited from BLImageEncoderCore

Additional Inherited Members

- Public Attributes inherited from BLObjectCore

bool BLImageEncoder::isValid() constnoexcept[¶]

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

BLResult BLImageEncoder::lastResult() constnoexcept[¶]

Returns the last encoding result.

uint64_t BLImageEncoder::frameIndex() constnoexcept[¶]

Returns the current frame index (yet to be written).

size_t BLImageEncoder::bufferIndex() constnoexcept[¶]

Returns the position in destination buffer.

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

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

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

Sets a property of the given name to value.

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

BLResult BLImageEncoder::writeFrame(
BLArray<uint8_t>& dst,
const BLImageCore& image
)noexcept[¶]

Encodes the given image and writes the encoded data to the destination buffer dst.

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