libTextSuite is a library to render text with OpenGl or OpenGLES. The rendered text can be arranged in single lines or text blocks.
+All api functions use the stdcall calling convention!
+| pointer | +pointer with no data type | +
| boolean | +8bit value (zero is FALSE, all other values are TRUE) | +
| int8 | +8bit signed integer | +
| int16 | +16bit signed integer | +
| int32 | +32bit signed integer | +
| int64 | +64bit signed integer | +
| uint8 | +8bit unsigned integer | +
| uint16 | +16bit unsigned integer | +
| uint32 | +32bit unsigned integer | +
| uint64 | +64bit unsigned integer | +
| float | +32bit floating point | +
| double | +64bit floating point | +
| AnsiChar | +uint8 | +
| AnsiString | +pointer to null terminated AnsiChar string | +
| WideChar | +uint16 | +
| WideString | +pointer to null terminated WideChar string | +
Function that are used to initialize or control the library.
+ +initializes the internal library variables. must be called once before using any other function
+ returns +uint32error code
+returns the last error code of the last raised error. the error code will not be reseted after the call.
+ returns +uint32error code
+returns the error message of the last raised error
+ returns +AnsiStringerror message
+cleans up internal library variables. should be called once before program exits
+ returns +uint32error code
+The context is a wrapper object that owns all created objects. When you delete the context, all assigned objects will destroyed also.
+ +creates a new context handle
+ returns +pointercontext handle or NULL on failure
+get the current code page of a context
+ parameters +pointercontext handle
+pointer to uint32value to fill with current code page
+ returns +uint32error code
+get the current default char of a context
+ parameters +pointercontext handle
+WideCharvalue to fill with current default char
+ returns +uint32error code
+set the code page of a context
+ parameters +pointercontext handle
+uint32new code page value
+ return +uint32error code
+set the default char of a context
+ parameters +pointercontext handle
+WideCharnew default char value
+ returns +uint32error code
+convert an AnsiString to a WideString
+ parameters +pointercontext handle
+AnsiStringstring to convert
+ returns +WideStringconverted string or NULL on failure
+destroy a context handle
+ parameters +pointercontext handle
+ returns +uint32error code
+Renderers are objects to display text on the screen. You are able to decide which API you want to use for rendering. Out of the box OpenGL and OpenGLES is supported, but you are free to create your own renderer.
+ +create a new renderer
+ parameters +pointercontext handle
+uint32type of renderer (see RenderType constants)
+uint32texture format (see Format constants)
+ returns +pointerrenderer handle or NULL on failure
+create a new custom renderer that can be controlled by the user
+ parameters +pointercontext handle
+uint32texture format (see Format constants)
+pointer to RendererCustomDatadata of custom renderer (RendererCustomData data type)
+ returns +pointerrenderer handle or NULL on failure
+begin a new text block
+ parameters +pointerrenderer handle
+int32top of text block
+int32left of text block
+int32width of text block
+int32height of text block
+uint32text block flags (see TextBlockFlags constants)
+ returns +pointertext block handle
+finish a text block and draw the assigned text
+ parameters +pointerrenderer handle
+pointertext block handle
+ returns +uint32error code
+finish a text block but does not draw the assigned text
+ parameters +pointerrenderer handle
+pointertext block handle
+ returns +uint32error code
+calculate the size of a certain string
+ parameters +pointerrenderer handle
+pointerfont handle to use for rendering text
+AnsiStringstring to calculate width for
+ returns +int32width of the given text or -1 on failure
+calculate the size of a certain string
+ parameters +pointerrenderer handle
+pointerfont handle to use for rendering text
+WideStringstring to calculate width for
+ returns +int32width of the given text or -1 on failure
+destroy a renderer handle
+ parameters +pointerrenderer handle to destroy
+ returns +uint32error code
+Font creators are objects that will load glyphs for a certain char. Out of the box a GDI and a FreeType font creator are supported, but you are free to write your own one.
+ +creates a new font creator handle
+ parameters +pointercontext handle
+uint32type of font creator to create (see FontCreatorType constants)
+ returns +pointerhandle to new font creator or NULL on failure
+create a font handle using the name of the font
+ parameters +pointerfont creator handle
+AnsiStringname of the font
+int32font size
+uint32font style flags (see FontStyleFlag constants)
+uint32font anti aliasing (see FontAntiAliasing constants)
+ returns +pointerfont handle or NULL on failure
+create a font handle using a font file
+ parameters +pointerfont creator handle
+AnsiStringfile name of the font file
+int32font size
+uint32font style flags (see FontStyleFlag constants)
+uint32font anti aliasing (see FontAntiAliasing constants)
+ returns +pointerfont handle or NULL on failure
+create a font handle using a data stream
+ parameters +pointerfont creator handle
+pointer to Streamstream to load font from (see Stream data type)
+int32font size
+uint32font style flags (see FontStyleFlag constants)
+uint32font anti aliasing (see FontAntiAliasing constants)
+ returns +pointerfont handle or NULL on failure
+destroy a font creator
+ parameters +pointerfont creator handle to destroy
+ returns +uint32error code
+Font objects are used to define the appearance (size, style, ...) of text. They are created using a font creator.
+ +get the current post processor of a font
+ parameters +pointerfont handle
+ returns +pointercurrent assigned post processor
+get the current tab with of a font
+ parameters +pointerfont handle
+pointer to int32value to write current tab width to
+ returns +uint32error code
+get the current char spacing of a font
+ parameters +pointerfont handle
+pointer to int32value to write current char spacing to
+ returns +uint32error code
+get the current line spacing of a font
+ parameters +pointerfont handle
+pointer to floatvalue to write current line spacing to
+ returns +uint32error code
+get the metric of a font
+ parameters +pointerfont handle
+pointer to FontMetricvalue to write font metric to (see FontMetric data type)
+ returns +uint32error code
+get name of a font
+ parameters +pointerfont handle
+ returns +AnsiStringfont name or NULL on failure
+get face name of a font
+ parameters +pointerfont handle
+ returns +AnsiStringface name or NULL on failure
+get style name of a font
+ parameters +pointerfont handle
+ returns +AnsiStringstyle name or NULL on failure
+get full name of a font
+ parameters +pointerfont handle
+ returns +AnsiStringfull name or NULL on failure
+get copyright of a font
+ parameters +pointerfont handle
+ returns +AnsiStringcopyright or NULL on failure
+set post processor of a font
+ parameters +pointerfont handle
+pointerpost processor handle
+ returns +uint32error code
+set tab with of a font
+ parameters +pointerfont handle
+int32new tab with value
+ returns +uint32error code
+set char spacing of a font
+ parameters +pointerfont handle
+int32new char spacing value
+ returns +uint32error code
+set line spacing of a font
+ parameters +pointerfont handle
+floatnew line spacing value
+ returns +uint32error code
+destroy a font handle
+ parameters +pointerfont handle to destroy
+ returns +uint32error code
+Text block objects are used to arrange text in a block: automatic line break, alignment, text color, text font, ...
+ +get text block rectangle
+ parameters +pointertext block handle
+pointer to Rectvalue to store text block rectangle in
+ returns +uint32error code
+get the width of a text block
+ parameters +pointertext block handle
+pointer to int32value to write text block width to
+ returns +uint32error code
+get the height of a text block
+ parameters +pointertext block handle
+pointer to int32value to write text block height to
+ returns +uint32error code
+get text block flags
+ parameters +pointertext block handle
+pointer to int32value to write text block flags to (see TextBlockFlags constants)
+ returns +uint32error code
+get the top position of a text block
+ parameters +pointertext block handle
+pointer to int32value to write text block top position to
+ returns +uint32error code
+get the left position of a text block
+ parameters +pointertext block handle
+pointer to int32value to write text block left position to
+ returns +uint32error code
+get the vertical alignment of a text block
+ parameters +pointertext block handle
+pointer to int32value to write vertical alignment to (see VertAlignment constants)
+ returns +uint32error code
+get the horizontal alignment of a text block
+ parameters +pointertext block handle
+pointer to int32value to write horizontal alignment to (see HorzAlignment constants)
+ returns +uint32error code
+get the clipping value of a text block
+ parameters +pointertext block handle
+pointer to int32value to write clipping to (see TextBlockClipping constants)
+ returns +uint32error code
+get the current color of a text block
+ parameters +pointertext block handle
+pointer to Colorvalue to write color to (see Color data type)
+ returns +uint32error code
+get the current font handle of a text block
+ parameters +pointertext block handle
+pointer to pointervalue to write font handle to
+ returns +uint32error code
+set the top position of a text block
+ parameters +pointertext block handle
+int32new value for top position
+ returns +uint32error code
+set the left position of a text block
+ parameters +pointertext block handle
+int32new value for left position
+ returns +uint32error code
+set the vertical alignment of a text block
+ parameters +pointertext block handle
+int32new value for vertical alignment (see VertAlignment constants)
+ returns +uint32error code
+set the horizontal alignment of a text block
+ parameters +pointertext block handle
+int32new value for horizontal alignment (see HorzAlignment constants)
+ returns +uint32error code
+set the a text block clipping
+ parameters +pointertext block handle
+int32new value for text block clipping (see TextBlockClipping constants)
+ returns +uint32error code
+set color to render text with
+ parameters +pointertext block handle
+int32new value for text color (see Color data type)
+ returns +uint32error code
+set font to render text with
+ parameters +pointertext block handle
+pointerfont handle
+ returns +uint32error code
+get the used size of a text block
+ parameters +pointertext block handle
+ returns +int32actual used size of the text block or -1 on error
+get the width of a certain text
+ parameters +pointertext block handle
+AnsiStringstring to calculate width for
+ returns +int32width of the passed text or -1 on error
+get the width of a certain text
+ parameters +pointertext block handle
+WideStringstring to calculate width for
+ returns +int32width of the passed text or -1 on error
+write text to the text block using the current font and color
+ parameters +pointertext block handle
+AnsiStringtext to write to text block
+ returns +uint32error code
+write text to the text block using the current font and color
+ parameters +pointertext block handle
+WideStringtext to write to text block
+ returns +uint32error code
+destroy a text block
+ parameters +pointertext block handle
+ returns +uint32error code
+Image objects are used to store glyph data. You can manipulate the stored data through a post processor before the glyph is rendered.
+ +create a new image
+ parameters +pointercontext handle
+ returns +pointerimage handle or NULL on error
+check if an image is empty
+ parameters +pointerimage handle
+pointer to booleanvalue to write result to
+ returns +uint32error code
+get the width of an image
+ parameters +pointerimage handle
+ returns +int32image width or -1 on error
+get the height of an image
+ parameters +pointerimage handle
+ returns +int32image height or -1 on error
+get the data size of a single line (in bytes)
+ parameters +pointerimage handle
+ returns +int32line size or -1 on error
+get the data size of the complete image (in bytes)
+ parameters +pointerimage handle
+ returns +int32data size or -1 on error
+get the format of an image
+ parameters +pointerimage handle
+pointer to int32value to write image format to (see ImageFormat constants)
+ returns +uint32error code
+get a pointer to the image data
+ parameters +pointerimage handle
+ returns +pointerpointer to the image data or NULL on failure
+get a pointer to a certain image line
+ parameters +pointerimage handle
+int32line index
+ returns +pointerpointer to the image line or NULL on failure
+get the color of a single pixel
+ parameters +pointerimage handle
+int32x position
+int32y position
+pointer to Colorvalue to write color to (see Color data type)
+ returns +uint32error code
+assign the source image to another image (duplicate the image object)
+ parameters +pointerimage handle
+pointerimage handle of source image
+ returns +uint32error code
+initialize image with a certain size and format
+ parameters +pointerimage handle
+ImageFormatdata format of the image (see ImageFormat constants)
+int32width of the image (in pixel)
+int32height of the image (in pixel)
+ returns +uint32error code
+load image data from callback function
+ parameters +pointerimage handle
+ImageLoadFunccallback function (see ImageLoadFunc data type)
+pointeruser defined arguments (will passed to callback function)
+ returns +uint32error code
+change the size of an image
+ parameters +pointerimage handle
+int32new image width
+int32new image height
+int32x position of the old image inside the new one
+int32y position of the old image inside the new one
+ returns +uint32error code
+fill the complete image with a color
+ parameters +pointerimage handle
+Colorcolor to fill image with (see Color data type)
+uint32flags of color channel to fill (see ColorChannels constants)
+ImageModesimage mode to use for color fill (see ImageModes data type)
+ returns +uint32error code
+fill the complete image with a image pattern
+ parameters +pointerimage handle to fill with pattern
+pointerpattern image handle
+int32x position of pattern inside the image
+int32y position of pattern inside the image
+uint32flags of color channel to fill (see ColorChannels constants)
+ImageModesimage mode to use (see ImageModes data type)
+ returns +uint32error code
+blend one image inside of another image
+ parameters +pointerhandle to destination image
+pointerhandle to source image
+int32x position of source image inside the destination image
+int32y position of source image inside the destination image
+ImageBlendFunccallback function to use for blending (see ImageBlendFunc data type)
+pointeruser defined arguments (will be passed to callback function)
+ returns +uint32error code
+use blur filter on an image
+ parameters +pointerimage handle
+floathorizontal blur radius
+floathorizontal blur strength
+floatvertical blur radius
+floatvertical blur strength
+uint32flags of color channel to blur (see ColorChannels constants)
+ returns +uint32error code
+destroy an image
+ parameters +pointerimage handle
+ returns +uint32error code
+Post processor objects are used to manipulate glyph data before it is rendered. You are able to add shadows, borders or something like that.
+ +add char range to use post processor at
+ parameters +pointerpost processor handle
+int32usage of the char range (see CharRangeUsage constants)
+WideCharfirst char of the range
+WideCharlast char of the range
+ returns +uint32error code
+add chars to use post processor at
+ parameters +pointerpost processor handle
+int32usage of the char range (see CharRangeUsage constants)
+WideStringchars to use post processor at
+ returns +uint32error code
+clear all defined char ranges and chars
+ parameters +pointerpost processor handle
+ returns +uint32error code
+execute the post processor
+ parameters +pointerpost processor handle
+pointerchar handle to execute post processor at
+pointerimage handle to execute post processor at
+ returns +uint32error code
+creates a new post processor that will fill a char with a given color
+ parameters +pointercontext handle
+Colorcolor to fill char with (see Color data type)
+ImageModesimage modes to use (see ImageModes data type)
+uint32flags of color channels to fill (see ColorChannels constants)
+ returns +pointerpost processor handle or NULL on failure
+creates a new post processor that will fill a char with a given pattern
+ parameters +pointercontext handle
+pointerimage handle to use as pattern
+booleanTRUE: image handle is destroyed with post processor; FALSE: user must destroy image handle when finished
+Positionposition to place pattern at
+ImageModesimage modes to use (see ImageModes data type)
+uint32flags of color channels to fill (see ColorChannels constants)
+ returns +pointerpost processor handle or NULL on failure
+creates a new post processor that will create a border around a char
+ parameters +pointercontext handle
+floatborder width
+floatborder strength
+Colorborder color (see Color data type)
+booleanTRUE: do not change the char size; FALSE: add border to char size;
+ returns +pointerpost processor handle or NULL on failure
+creates a new post processor that will create a shadow under a char
+ parameters +pointercontext handle
+floatshadow radius
+floatshadow strength
+Positionshadow offset (see Position data type)
+Colorshadow color (see Color data type)
+ returns +pointerpost processor handle or NULL on failure
+creates a new post processor that will execute custom code
+ parameters +pointercontext handle
+pointer to PostProcessorCustomDataall needed data for custom code (see PostProcessorCustomData data type)
+ returns +pointerpost processor handle or NULL on failure
+destroy post processor
+ parameters +pointerpost processor handle
+ returns +uint32error code
+Char objects are used to store the size of a glyph. The data can be manipulated using a post processor.
+ +get the char code of a char object
+ parameters +pointerchar handle
+pointer to WideCharvalue to store char code in
+ returns +uint32error code
+get glyph metric of a char
+ parameters +pointerchar handle
+pointer to GlyphMetricvalue to store glyph metric in (see GlyphMetric data type)
+ returns +uint32error code
+set glyph metric of a char
+ parameters +pointerchar handle
+pointer to GlyphMetricnew glyph metric value (see GlyphMetric data type)
+ returns +uint32error code
+