Cobbletext  0.2.0
Complex text layout and rendering engine
Typedefs | Functions
common.h File Reference
#include <stdint.h>
#include "macros.h"
Include dependency graph for common.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef uint32_t CobbletextFontID
 Unique font face ID. More...
 
typedef uint32_t CobbletextGlyphID
 Unique glyph ID. More...
 
typedef uint32_t CobbletextInlineObjectID
 A user-provided identifer for inline objects. More...
 
typedef uint64_t CobbletextCustomPropertyID
 A user-provided integer for custom properties. More...
 

Functions

int32_t cobbletext_get_version_major ()
 Returns X from the X.Y.Z version. More...
 
int32_t cobbletext_get_version_minor ()
 Returns Y from the X.Y.Z version. More...
 
int32_t cobbletext_get_version_patch ()
 Returns Z from the X.Y.Z version. More...
 
const char * cobbletext_get_version ()
 Returns the version string formatted as X.Y.Z. More...
 

Typedef Documentation

◆ CobbletextCustomPropertyID

typedef uint64_t CobbletextCustomPropertyID

A user-provided integer for custom properties.

The user decides on how to interpret this integer for implementing custom properties to runs of text.

The value could be a ID to a mapping or a direct color value.

◆ CobbletextFontID

typedef uint32_t CobbletextFontID

Unique font face ID.

A plain integer that can be used to identify a font face.

It will always be unique per library context.

◆ CobbletextGlyphID

typedef uint32_t CobbletextGlyphID

Unique glyph ID.

A plain integer that can be used to identify a glyph for a font face, at a specific font size.

It will always be unique per library context.

IDs are recycled to different glyphs if no engine holds references to the ID.

◆ CobbletextInlineObjectID

typedef uint32_t CobbletextInlineObjectID

A user-provided identifer for inline objects.

The user decides how to interpret this identifer for custom objects.

Function Documentation

◆ cobbletext_get_version()

const char* cobbletext_get_version ( )

Returns the version string formatted as X.Y.Z.

  • Do not free.

◆ cobbletext_get_version_major()

int32_t cobbletext_get_version_major ( )

Returns X from the X.Y.Z version.

◆ cobbletext_get_version_minor()

int32_t cobbletext_get_version_minor ( )

Returns Y from the X.Y.Z version.

◆ cobbletext_get_version_patch()

int32_t cobbletext_get_version_patch ( )

Returns Z from the X.Y.Z version.