raqm_create ()

raqm_t *
raqm_create (void);

Creates a new raqm_t with all its internal states initialized to their defaults.

Since: 0.1

raqm_reference ()

raqm_t *
raqm_reference (raqm_t *rq);

Increases the reference count on rq by one. This prevents rq from being destroyed until a matching call to raqm_destroy() is made.

Since: 0.1

raqm_destroy ()

void
raqm_destroy (raqm_t *rq);

Decreases the reference count on rq by one. If the result is zero, then rq and all associated resources are freed. See raqm_reference().

Since: 0.1

raqm_clear_contents ()

void
raqm_clear_contents (raqm_t *rq);

Clears internal state of previously used raqm_t object, making it ready for reuse and keeping some of allocated memory to increase performance.

Since: 0.9

raqm_set_text ()

bool
raqm_set_text (raqm_t *rq,
               const uint32_t *text,
               size_t len);

Adds text to rq to be used for layout. It must be a valid UTF-32 text, any invalid character will be replaced with U+FFFD. The text should typically represent a full paragraph, since doing the layout of chunks of text separately can give improper output.

Since: 0.1

raqm_set_text_utf8 ()

bool
raqm_set_text_utf8 (raqm_t *rq,
                    const char *text,
                    size_t len);

Same as raqm_set_text(), but for text encoded in UTF-8 encoding.

Since: 0.1

raqm_set_text_utf16 ()

bool
raqm_set_text_utf16 (raqm_t *rq,
                     const uint16_t *text,
                     size_t len);

Same as raqm_set_text(), but for text encoded in UTF-16 encoding.

Since: 0.10

raqm_set_par_direction ()

bool
raqm_set_par_direction (raqm_t *rq,
                        raqm_direction_t dir);

Sets the paragraph direction, also known as block direction in CSS. For horizontal text, this controls the overall direction in the Unicode Bidirectional Algorithm, so when the text is mainly right-to-left (with or without some left-to-right) text, then the base direction should be set to RAQM_DIRECTION_RTL and vice versa.

The default is RAQM_DIRECTION_DEFAULT, which determines the paragraph direction based on the first character with strong bidi type (see rule P2 in Unicode Bidirectional Algorithm), which can be good enough for many cases but has problems when a mainly right-to-left paragraph starts with a left-to-right character and vice versa as the detected paragraph direction will be the wrong one, or when text does not contain any characters with string bidi types (e.g. only punctuation or numbers) as this will default to left-to-right paragraph direction.

For vertical, top-to-bottom text, RAQM_DIRECTION_TTB should be used. Raqm, however, provides limited vertical text support and does not handle rotated horizontal text in vertical text, instead everything is treated as vertical text.

Since: 0.1

raqm_set_language ()

bool
raqm_set_language (raqm_t *rq,
                   const char *lang,
                   size_t start,
                   size_t len);

Sets a BCP47 language code to be used for len -number of characters staring at start . The start and len are input string array indices (i.e. counting bytes in UTF-8 and scaler values in UTF-32).

This method can be used repeatedly to set different languages for different parts of the text.

Since: 0.2

Stability Level: Unstable

raqm_set_freetype_face ()

bool
raqm_set_freetype_face (raqm_t *rq,
                        FT_Face face);

Sets an FT_Face to be used for all characters in rq .

See also raqm_set_freetype_face_range().

Since: 0.1

raqm_set_freetype_face_range ()

bool
raqm_set_freetype_face_range (raqm_t *rq,
                              FT_Face face,
                              size_t start,
                              size_t len);

Sets an FT_Face to be used for len -number of characters staring at start . The start and len are input string array indices, counting elements according to the underlying encoding. start must always be aligned to the start of an encoded codepoint, and len must always end at a codepoint's final element.

This method can be used repeatedly to set different faces for different parts of the text. It is the responsibility of the client to make sure that face ranges cover the whole text, and is properly aligned.

See also raqm_set_freetype_face().

Since: 0.1

raqm_set_freetype_load_flags ()

bool
raqm_set_freetype_load_flags (raqm_t *rq,
                              int flags);

Sets the load flags passed to FreeType when loading glyphs, should be the same flags used by the client when rendering FreeType glyphs.

This requires version of HarfBuzz that has hb_ft_font_set_load_flags(), for older version the flags will be ignored.

Since: 0.3

raqm_set_freetype_load_flags_range ()

bool
raqm_set_freetype_load_flags_range (raqm_t *rq,
                                    int flags,
                                    size_t start,
                                    size_t len);

Sets the load flags passed to FreeType when loading glyphs for len -number of characters staring at start . Flags should be the same as used by the client when rendering corresponding FreeType glyphs. The start and len are input string array indices (i.e. counting bytes in UTF-8 and scaler values in UTF-32).

This method can be used repeatedly to set different flags for different parts of the text. It is the responsibility of the client to make sure that flag ranges cover the whole text.

This requires version of HarfBuzz that has hb_ft_font_set_load_flags(), for older version the flags will be ignored.

See also raqm_set_freetype_load_flags().

Since: 0.9

raqm_set_letter_spacing_range ()

bool
raqm_set_letter_spacing_range (raqm_t *rq,
                               int spacing,
                               size_t start,
                               size_t len);

Set the letter spacing or tracking for a given range, the value will be added onto the advance and offset for RTL, and the advance for other directions. Letter spacing will be applied between characters, so the last character will not have spacing applied after it. Note that not all scripts have a letter-spacing tradition, for example, Arabic does not, while Devanagari does.

This will also add “disable liga, clig, hlig, dlig, and calt” font features to the internal features list, so call this function after setting the font features for best spacing results.

Since: 0.10

raqm_set_word_spacing_range ()

bool
raqm_set_word_spacing_range (raqm_t *rq,
                             int spacing,
                             size_t start,
                             size_t len);

Set the word spacing for a given range. Word spacing will only be applied to 'word separator' characters, such as 'space', 'no break space' and Ethiopic word separator'. The value will be added onto the advance and offset for RTL, and the advance for other directions.

Since: 0.10

raqm_set_invisible_glyph ()

bool
raqm_set_invisible_glyph (raqm_t *rq,
                          int gid);

Sets the glyph id to be used for invisible glyhphs.

If gid is negative, invisible glyphs will be suppressed from the output.

If gid is zero, invisible glyphs will be rendered as space.

If gid is a positive number, it will be used for invisible glyphs.

Since: 0.6

raqm_add_font_feature ()

bool
raqm_add_font_feature (raqm_t *rq,
                       const char *feature,
                       int len);

Adds a font feature to be used by the raqm_t during text layout. This is usually used to turn on optional font features that are not enabled by default, for example dlig or ss01, but can be also used to turn off default font features.

feature is string representing a single font feature, in the syntax understood by hb_feature_from_string().

This function can be called repeatedly, new features will be appended to the end of the features list and can potentially override previous features.

Since: 0.1

raqm_layout ()

bool
raqm_layout (raqm_t *rq);

Run the text layout process on rq . This is the main Raqm function where the Unicode Bidirectional Text algorithm will be applied to the text in rq , text shaping, and any other part of the layout process.

Since: 0.1

raqm_get_glyphs ()

raqm_glyph_t *
raqm_get_glyphs (raqm_t *rq,
                 size_t *length);

Gets the final result of Raqm layout process, an array of raqm_glyph_t containing the glyph indices in the font, their positions and other possible information.

Since: 0.1

raqm_get_par_resolved_direction ()

raqm_direction_t
raqm_get_par_resolved_direction (raqm_t *rq);

Gets the resolved direction of the paragraph;

Since: 0.8

raqm_get_direction_at_index ()

raqm_direction_t
raqm_get_direction_at_index (raqm_t *rq,
                             size_t index);

Gets the resolved direction of the character at specified index;

Since: 0.8

raqm_index_to_position ()

bool
raqm_index_to_position (raqm_t *rq,
                        size_t *index,
                        int *x,
                        int *y);

Calculates the cursor position after the character at index . If the character is right-to-left, then the cursor will be at the left of it, whereas if the character is left-to-right, then the cursor will be at the right of it.

Since: 0.2

raqm_position_to_index ()

bool
raqm_position_to_index (raqm_t *rq,
                        int x,
                        int y,
                        size_t *index);

Returns the index of the character at x and y position within text. If the position is outside the text, the last character is chosen as index .

Since: 0.2

raqm_version ()

void
raqm_version (unsigned int *major,
              unsigned int *minor,
              unsigned int *micro);

Returns library version as three integer components.

Since: 0.7

raqm_version_atleast ()

bool
raqm_version_atleast (unsigned int major,
                      unsigned int minor,
                      unsigned int micro);

Checks if library version is less than or equal the specified version.

Since: 0.7

raqm_version_string ()

const char *
raqm_version_string (void);

Returns library version as a string with three components.

Since: 0.7

RAQM_VERSION_ATLEAST()

#define             RAQM_VERSION_ATLEAST(major,minor,micro)

Checks if library version is less than or equal the specified version.

Since: 0.7

RAQM_VERSION_MAJOR

#define RAQM_VERSION_MAJOR 0

Library major version component.

Since: 0.7

RAQM_VERSION_MICRO

#define RAQM_VERSION_MICRO 2

Library micro version component.

Since: 0.7

RAQM_VERSION_MINOR

#define RAQM_VERSION_MINOR 10

Library minor version component.

Since: 0.7

RAQM_VERSION_STRING

#define RAQM_VERSION_STRING "0.10.2"

Library version as a string with three components.

Since: 0.7

raqm_t

typedef struct _raqm raqm_t;

This is the main object holding all state of the currently processed text as well as its output.

Since: 0.1

enum raqm_direction_t

Base paragraph direction, see raqm_set_par_direction().

Since: 0.1

raqm_glyph_t

typedef struct {
    unsigned int index;
    int x_advance;
    int y_advance;
    int x_offset;
    int y_offset;
    uint32_t cluster;
    FT_Face ftface;
} raqm_glyph_t;

The structure that holds information about output glyphs, returned from raqm_get_glyphs().