Index ⭢ Text ⭢ BLGlyphBuffer

BLGlyphBuffer Class Referencefinal [¶]

Glyph buffer [C++ API].

Can hold either text or glyphs and provides basic memory management that is used for text shaping, character to glyph mapping, glyph substitution, and glyph positioning.

Glyph buffer provides two separate buffers called 'primary' and 'secondary' that serve different purposes during processing. Primary buffer always holds actual text/glyph array, and secondary buffer is either used as a scratch buffer during glyph substitution or to hold glyph positions after the processing is complete and glyph positions were calculated.

Member Functions

Construction & Destruction

BLGlyphBuffer(const BLGlyphBuffer&) noexcept = delete

BLGlyphBuffer& operator=(const BLGlyphBuffer&) noexcept = delete

BLGlyphBuffer(BLGlyphBuffer&& other) noexcept

Overloaded Operators

operator bool() const noexcept

Accessors

bool is_empty() const noexcept

size_t size() const noexcept

uint32_t flags() const noexcept

uint32_t* content() const noexcept

BLGlyphInfo* info_data() const noexcept

BLGlyphPlacement* placement_data() const noexcept

const BLGlyphRun& glyph_run() const noexcept

bool has_flag(uint32_t flag) const noexcept

bool has_text() const noexcept

bool has_glyphs() const noexcept

bool has_invalid_chars() const noexcept

bool has_undefined_chars() const noexcept

bool has_invalid_font_data() const noexcept

Operations

BLResult reset() noexcept

BLResult clear() noexcept

BLResult set_text(const void* text_data, size_t size, BLTextEncoding encoding) noexcept

BLResult set_latin1_text(const char* text, size_t size = SIZE_MAX) noexcept

BLResult set_utf8_text(const char* text, size_t size = SIZE_MAX) noexcept

BLResult set_utf8_text(const uint8_t* text, size_t size = SIZE_MAX) noexcept

BLResult set_utf16_text(const uint16_t* text, size_t size = SIZE_MAX) noexcept

BLResult set_utf32_text(const uint32_t* text, size_t size = SIZE_MAX) noexcept

BLResult set_wchar_text(const wchar_t* text, size_t size = SIZE_MAX) noexcept

BLResult set_glyphs(const uint32_t* glyph_data, size_t size) noexcept

BLResult set_glyphs_from_struct(const void* glyph_data, size_t size, size_t glyph_id_size, intptr_t glyph_advance) noexcept

Debug Sink

BLResult set_debug_sink(BLDebugMessageSinkFunc sink, void* user_data = nullptr) noexcept

BLResult reset_debug_sink() noexcept

Additional Inherited Members

Public Attributes inherited from BLGlyphBufferCore

bool BLGlyphBuffer::has_flag(
uint32_t flag
) constnodiscardnoexcept[¶]

Tests whether the glyph-buffer has flag set.

bool BLGlyphBuffer::has_text() constnodiscardnoexcept[¶]

Tests whether the buffer contains unicode data.

bool BLGlyphBuffer::has_glyphs() constnodiscardnoexcept[¶]

Tests whether the buffer contains glyph-id data.

bool BLGlyphBuffer::has_invalid_chars() constnodiscardnoexcept[¶]

Tests whether the input string contained invalid characters (unicode encoding errors).

bool BLGlyphBuffer::has_undefined_chars() constnodiscardnoexcept[¶]

Tests whether the input string contained undefined characters that weren't mapped properly to glyphs.

bool BLGlyphBuffer::has_invalid_font_data() constnodiscardnoexcept[¶]

Tests whether one or more operation was terminated before completion because of invalid data in a font.

BLResult BLGlyphBuffer::reset()noexcept[¶]

Resets the BLGlyphBuffer into its default constructed state. The content will be cleared and allocated memory released.

BLResult BLGlyphBuffer::clear()noexcept[¶]

Clears the content of BLGlyphBuffer without releasing internal buffers.

BLResult BLGlyphBuffer::set_text(
const void* text_data,
size_t size,
BLTextEncoding encoding
)noexcept[¶]

Assigns a text content of this BLGlyphBuffer.

This is a generic function that accepts void* data, which is specified by encoding. The size argument depends on encoding as well. If the encoding specifies byte string (LATIN1 or UTF8) then it's bytes, if the encoding specifies UTF16 or UTF32 then it would describe the number of uint16_t or uint32_t code points, respectively.

Null-terminated string can be specified by passing SIZE_MAX as size.

BLResult BLGlyphBuffer::set_latin1_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[¶]

Assigns a text content of this BLGlyphBuffer from LATIN1 (ISO/IEC 8859-1) string.

BLResult BLGlyphBuffer::set_utf8_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[1/2][¶]

Assigns a text content of this BLGlyphBuffer from UTF-8 encoded string. The size parameter represents the length of the text in bytes.

BLResult BLGlyphBuffer::set_utf8_text(
const uint8_t* text,
size_t size = SIZE_MAX
)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 BLGlyphBuffer::set_utf16_text(
const uint16_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

Assigns a text content of this BLGlyphBuffer from UTF-16 encoded string. The size parameter represents the length of the text in 16-bit units.

BLResult BLGlyphBuffer::set_utf32_text(
const uint32_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

Assigns a text content of this BLGlyphBuffer from UTF-32 encoded string. The size parameter represents the length of the text in 32-bit units.

BLResult BLGlyphBuffer::set_wchar_text(
const wchar_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

Assigns a text content of this BLGlyphBuffer from wchar_t encoded string. The size parameter represents the length of the text in wchar_t units.

BLResult BLGlyphBuffer::set_glyphs(
const uint32_t* glyph_data,
size_t size
)noexcept[¶]

Assigns a glyph content of this BLGlyphBuffer from either the given glyph_data.

BLResult BLGlyphBuffer::set_glyphs_from_struct(
const void* glyph_data,
size_t size,
size_t glyph_id_size,
intptr_t glyph_advance
)noexcept[¶]

Assigns a glyph content of this BLGlyphBuffer from an array of glyphs or from a foreign structure that contains glyphs and possibly other members that have to be skipped. The glyph size can be either 16-bit (2) or 32-bit (4). The last parameter glyph_advance specifies how many bytes to advance after a glyph value is read.

BLGlyphBuffer Class Referencefinal [¶]

Member Functions

Additional Inherited Members

bool BLGlyphBuffer::has_flag(
uint32_t flag
) constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_text() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_glyphs() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_invalid_chars() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_undefined_chars() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_invalid_font_data() constnodiscardnoexcept[¶]

BLResult BLGlyphBuffer::reset()noexcept[¶]

BLResult BLGlyphBuffer::clear()noexcept[¶]

BLResult BLGlyphBuffer::set_text(
const void* text_data,
size_t size,
BLTextEncoding encoding
)noexcept[¶]

BLResult BLGlyphBuffer::set_latin1_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_utf8_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[1/2][¶]

BLResult BLGlyphBuffer::set_utf8_text(
const uint8_t* text,
size_t size = SIZE_MAX
)noexcept[2/2][¶]

BLResult BLGlyphBuffer::set_utf16_text(
const uint16_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_utf32_text(
const uint32_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_wchar_text(
const wchar_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs(
const uint32_t* glyph_data,
size_t size
)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs_from_struct(
const void* glyph_data,
size_t size,
size_t glyph_id_size,
intptr_t glyph_advance
)noexcept[¶]

More Information

Documentation

Support

Get Blend2D

BLGlyphBuffer Class Referencefinal [¶]

Member Functions

Additional Inherited Members

bool BLGlyphBuffer::has_flag(uint32_t flag) constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_text() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_glyphs() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_invalid_chars() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_undefined_chars() constnodiscardnoexcept[¶]

bool BLGlyphBuffer::has_invalid_font_data() constnodiscardnoexcept[¶]

BLResult BLGlyphBuffer::reset()noexcept[¶]

BLResult BLGlyphBuffer::clear()noexcept[¶]

BLResult BLGlyphBuffer::set_text(const void* text_data, size_t size, BLTextEncoding encoding)noexcept[¶]

BLResult BLGlyphBuffer::set_latin1_text(const char* text, size_t size = SIZE_MAX)noexcept[¶]

BLResult BLGlyphBuffer::set_utf8_text(const char* text, size_t size = SIZE_MAX)noexcept[1/2][¶]

BLResult BLGlyphBuffer::set_utf8_text(const uint8_t* text, size_t size = SIZE_MAX)noexcept[2/2][¶]

BLResult BLGlyphBuffer::set_utf16_text(const uint16_t* text, size_t size = SIZE_MAX)noexcept[¶]

BLResult BLGlyphBuffer::set_utf32_text(const uint32_t* text, size_t size = SIZE_MAX)noexcept[¶]

BLResult BLGlyphBuffer::set_wchar_text(const wchar_t* text, size_t size = SIZE_MAX)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs(const uint32_t* glyph_data, size_t size)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs_from_struct(const void* glyph_data, size_t size, size_t glyph_id_size, intptr_t glyph_advance)noexcept[¶]

More Information

Documentation

Support

Get Blend2D

bool BLGlyphBuffer::has_flag(
uint32_t flag
) constnodiscardnoexcept[¶]

BLResult BLGlyphBuffer::set_text(
const void* text_data,
size_t size,
BLTextEncoding encoding
)noexcept[¶]

BLResult BLGlyphBuffer::set_latin1_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_utf8_text(
const char* text,
size_t size = SIZE_MAX
)noexcept[1/2][¶]

BLResult BLGlyphBuffer::set_utf8_text(
const uint8_t* text,
size_t size = SIZE_MAX
)noexcept[2/2][¶]

BLResult BLGlyphBuffer::set_utf16_text(
const uint16_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_utf32_text(
const uint32_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_wchar_text(
const wchar_t* text,
size_t size = SIZE_MAX
)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs(
const uint32_t* glyph_data,
size_t size
)noexcept[¶]

BLResult BLGlyphBuffer::set_glyphs_from_struct(
const void* glyph_data,
size_t size,
size_t glyph_id_size,
intptr_t glyph_advance
)noexcept[¶]