|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
- <meta name="generator" content="Railroad Diagram Generator 1.40.1033" />
- <style type="text/css">
- body
- { font-family: 'Calibri', 'Arial'; color: #0F0C00; background: #FFFCF0; counter-reset: h1; }
- a
- { text-decoration: none; color: inherit }
- a:hover
- { text-decoration: underline }
- a.back
- { font-size: 10pt; margin: 0px 10px; font-weight: normal; }
- h1 { counter-reset: h2 h3; }
- h1::before
- { counter-increment: h1; content: counter(h1) ". " }
- h2 { counter-reset: h3; }
- h2::before
- { counter-increment: h2; content: counter(h1) "." counter(h2) ". " }
- h3 { }
- h3::before
- { counter-increment: h3; content: counter(h1) "." counter(h2) "." counter(h3) ". " }
- h1, h2, h3, h4, h5, h6, h7, h8
- { margin-bottom: 0; }
- ul.dict
- { counter-reset: orderedlist; list-style-type: none; padding: 0; }
- ul.dict li::before
- { counter-increment: orderedlist; content: counters(orderedlist,".") " "; display: block; float: left; width: 100px; }
-
- div.content
- { padding-left: 15px; }
- tr.empty
- { height: 1em; }
- #typestable td
- { padding: 1px 5px; }
- #typestable td:first-child
- { width: 150px; }
- .func > p
- { margin: 0 0 0 25px; }
- .func > p > i
- { float: left; display: block; width: 250px; }
- </style>
- <script type="text/javascript">
- /* <![CDATA[ */
- function getElementsByTagNames(list,obj) {
- if (!obj) var obj = document;
- var tagNames = list.split(',');
- var resultArray = new Array();
- for (var i = 0; i < tagNames.length; ++i) {
- var tags = obj.getElementsByTagName(tagNames[i]);
- for (var j = 0; j < tags.length; ++j) {
- resultArray.push(tags[j]);
- }
- }
- var testNode = resultArray[0];
- if (!testNode) return [];
- if (testNode.sourceIndex) {
- resultArray.sort(function (a,b) {
- return a.sourceIndex - b.sourceIndex;
- });
- }
- else if (testNode.compareDocumentPosition) {
- resultArray.sort(function (a,b) {
- return 3 - (a.compareDocumentPosition(b) & 6);
- });
- }
- return resultArray;
- }
-
- window.onload = function () {
- var hElements = getElementsByTagNames('h1,h2,h3,h4');
- for (var i = 0; i < hElements.length; ++i)
- {
- var a = document.createElement('a');
- a.href = document.referrer;
- a.innerHTML = 'back';
- a.className = 'back';
- hElements[i].appendChild(a);
- }
- };
- /* ]]> */
- </script>
- </head>
- <body>
- <h1 id="content">Content</h1>
- <div class="content">
- <ul style="padding-left: 15px;" class="dict">
- <li><a href="#content">Content</a></li>
- <li><a href="#general">General</a></li>
- <li>
- <a href="#datatypes">Data Types</a>
- <ul class="dict">
- <li><a href="#datatypessimple">Simple</a></li>
- <li><a href="#datatypesstructs">Structures</a></li>
- </ul>
- </li>
- <li><a href="#constants">Constants</a></li>
- <li>
- <a href="#functions">Functions</a>
- <ul class="dict">
- <li><a href="#funcgeneral">General</a></li>
- <li><a href="#funccontext">Context</a></li>
- <li><a href="#funcrenderer">Renderer</a></li>
- <li><a href="#funcfontcreator">Font Creator</a></li>
- <li><a href="#funcfont">Font</a></li>
- <li><a href="#functextblock">Text Block</a></li>
- <li><a href="#funcimage">Image</a></li>
- <li><a href="#funcpostprocessor">Post Processor</a></li>
- <li><a href="#funcchar">Char</a></li>
- </ul>
- </li>
- </ul>
- </div>
-
- <h1 id="general">General</h1>
- <div class="content">
- <p>libTextSuite is a library to render text with OpenGl or OpenGLES. The rendered text can be arranged in single lines or text blocks.</p>
- <p>All api functions use the <b>stdcall</b> calling convention!</p>
- </div>
-
- <h1 id="datatypes">Data Types</h1>
- <div class="content">
-
- <h2 id="datatypessimple">Simple</h2>
- <div class="content">
- <table id="typestable">
- <tr>
- <td>pointer</td>
- <td>pointer with no data type</td>
- </tr>
- <tr>
- <td>boolean</td>
- <td>8bit value (zero is FALSE, all other values are TRUE)</td>
- </tr>
- <tr class="empty" />
- <tr>
- <td>int8</td>
- <td>8bit signed integer</td>
- </tr>
- <tr>
- <td>int16</td>
- <td>16bit signed integer</td>
- </tr>
- <tr>
- <td>int32</td>
- <td>32bit signed integer</td>
- </tr>
- <tr>
- <td>int64</td>
- <td>64bit signed integer</td>
- </tr>
- <tr class="empty" />
- <tr>
- <td>uint8</td>
- <td>8bit unsigned integer</td>
- </tr>
- <tr>
- <td>uint16</td>
- <td>16bit unsigned integer</td>
- </tr>
- <tr>
- <td>uint32</td>
- <td>32bit unsigned integer</td>
- </tr>
- <tr>
- <td>uint64</td>
- <td>64bit unsigned integer</td>
- </tr>
- <tr class="empty" />
- <tr>
- <td>float</td>
- <td>32bit floating point</td>
- </tr>
- <tr>
- <td>double</td>
- <td>64bit floating point</td>
- </tr>
- <tr class="empty" />
- <tr>
- <td>AnsiChar</td>
- <td>uint8</td>
- </tr>
- <tr>
- <td>AnsiString</td>
- <td>pointer to null terminated AnsiChar string</td>
- </tr>
- <tr>
- <td>WideChar</td>
- <td>uint16</td>
- </tr>
- <tr>
- <td>WideString</td>
- <td>pointer to null terminated WideChar string</td>
- </tr>
- </table>
- </div>
-
- <h2 id="datatypesstructs">Structures</h2>
- <div class="content">
- RendererCustomData
- Stream
- FontMetric
- Position
- Rect
- Color
- ImageModes
- GlyphMetric
- PostProcessorCustomData
-
- ImageLoadFunc
- ImageBlendFunc
- </div>
- </div>
-
- <h1 id="constants">Constants</h1>
- <div class="content">
- RenderType
- Format
- TextBlockFlags
- FontStyleFlags
- FontCreatorType
- FontAntiAliasing
- VertAlignment
- HorzAlignment
- TextBlockClipping
- ImageFormat
- ColorChannels
- CharRangeUsage
- </div>
-
- <h1 id="functions">Functions</h1>
- <div class="content">
-
- <h2 id="funcgeneral">General</h2>
- <div class="content">
- <p>Function that are used to initialize or control the library.</p>
-
- <h3>ltsInitialize</h3>
- <div class="content func">
- <b>description</b>
- <p>initializes the internal library variables. must be called once before using any other function</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsGetLastErrorCode</h3>
- <div class="content func">
- <b>description</b>
- <p>returns the last error code of the last raised error. the error code will <b>not</b> be reseted after the call.</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsGetLastErrorMsg</h3>
- <div class="content func">
- <b>description</b>
- <p>returns the error message of the last raised error</p>
- <b>returns</b>
- <p><i>AnsiString</i>error message</p>
- </div>
-
- <h3>ltsFinalize</h3>
- <div class="content func">
- <b>description</b>
- <p>cleans up internal library variables. should be called once before program exits</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funccontext">Context</h2>
- <div class="content">
- <p>The context is a wrapper object that owns all created objects. When you delete the context, all assigned objects will destroyed also.</p>
-
- <h3>ltsContextCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new context handle</p>
- <b>returns</b>
- <p><i>pointer</i>context handle or NULL on failure</p>
- </div>
-
- <h3>ltsContextGetCodePage</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current code page of a context</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>pointer to uint32</i>value to fill with current code page</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsContextGetDefaultChar</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current default char of a context</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>WideChar</i>value to fill with current default char</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsContextSetCodePage</h3>
- <div class="content func">
- <b>description</b>
- <p>set the code page of a context</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>uint32</i>new code page value</p>
- <b>return</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsContextSetDefaultChar</h3>
- <div class="content func">
- <b>description</b>
- <p>set the default char of a context</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>WideChar</i>new default char value</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsContextAnsiToWide</h3>
- <div class="content func">
- <b>description</b>
- <p>convert an AnsiString to a WideString</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>AnsiString</i>string to convert</p>
- <b>returns</b>
- <p><i>WideString</i>converted string or NULL on failure</p>
- </div>
-
- <h3>ltsContextDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy a context handle</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcrenderer">Renderer</h2>
- <div class="content">
- <p>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.</p>
-
- <h3>ltsRendererCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>create a new renderer</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>uint32</i>type of renderer (see RenderType constants)</p>
- <p><i>uint32</i>texture format (see Format constants)</p>
- <b>returns</b>
- <p><i>pointer</i>renderer handle or NULL on failure</p>
- </div>
-
- <h3>ltsRendererCustomCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>create a new custom renderer that can be controlled by the user</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>uint32</i>texture format (see Format constants)</p>
- <p><i>pointer to RendererCustomData</i>data of custom renderer (RendererCustomData data type)</p>
- <b>returns</b>
- <p><i>pointer</i>renderer handle or NULL on failure</p>
- </div>
-
- <h3>ltsRendererBeginBlock</h3>
- <div class="content func">
- <b>description</b>
- <p>begin a new text block</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle</p>
- <p><i>int32</i>top of text block</p>
- <p><i>int32</i>left of text block</p>
- <p><i>int32</i>width of text block</p>
- <p><i>int32</i>height of text block</p>
- <p><i>uint32</i>text block flags (see TextBlockFlags constants)</p>
- <b>returns</b>
- <p><i>pointer</i>text block handle</p>
- </div>
-
- <h3>ltsRendererEndBlock</h3>
- <div class="content func">
- <b>description</b>
- <p>finish a text block and draw the assigned text</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle</p>
- <p><i>pointer</i>text block handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsRendererAbortBlock</h3>
- <div class="content func">
- <b>description</b>
- <p>finish a text block but does not draw the assigned text</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle</p>
- <p><i>pointer</i>text block handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsRendererGetTextWidthA</h3>
- <div class="content func">
- <b>description</b>
- <p>calculate the size of a certain string</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle</p>
- <p><i>pointer</i>font handle to use for rendering text</p>
- <p><i>AnsiString</i>string to calculate width for</p>
- <b>returns</b>
- <p><i>int32</i>width of the given text or -1 on failure</p>
- </div>
-
- <h3>ltsRendererGetTextWidthW</h3>
- <div class="content func">
- <b>description</b>
- <p>calculate the size of a certain string</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle</p>
- <p><i>pointer</i>font handle to use for rendering text</p>
- <p><i>WideString</i>string to calculate width for</p>
- <b>returns</b>
- <p><i>int32</i>width of the given text or -1 on failure</p>
- </div>
-
- <h3>ltsRendererDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy a renderer handle</p>
- <b>parameters</b>
- <p><i>pointer</i>renderer handle to destroy</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcfontcreator">Font Creator</h2>
- <div class="content">
- <p>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.</p>
-
- <h3>ltsFontCreatorCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new font creator handle</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>uint32</i>type of font creator to create (see FontCreatorType constants)</p>
- <b>returns</b>
- <p><i>pointer</i>handle to new font creator or NULL on failure</p>
- </div>
-
- <h3>ltsFontCreatorGetFontByName</h3>
- <div class="content func">
- <b>description</b>
- <p>create a font handle using the name of the font</p>
- <b>parameters</b>
- <p><i>pointer</i>font creator handle</p>
- <p><i>AnsiString</i>name of the font</p>
- <p><i>int32</i>font size</p>
- <p><i>uint32</i>font style flags (see FontStyleFlag constants)</p>
- <p><i>uint32</i>font anti aliasing (see FontAntiAliasing constants)</p>
- <b>returns</b>
- <p><i>pointer</i>font handle or NULL on failure</p>
- </div>
-
-
- <h3>ltsFontCreatorGetFontByFile</h3>
- <div class="content func">
- <b>description</b>
- <p>create a font handle using a font file</p>
- <b>parameters</b>
- <p><i>pointer</i>font creator handle</p>
- <p><i>AnsiString</i>file name of the font file</p>
- <p><i>int32</i>font size</p>
- <p><i>uint32</i>font style flags (see FontStyleFlag constants)</p>
- <p><i>uint32</i>font anti aliasing (see FontAntiAliasing constants)</p>
- <b>returns</b>
- <p><i>pointer</i>font handle or NULL on failure</p>
- </div>
-
- <h3>ltsFontCreatorGetFontByStream</h3>
- <div class="content func">
- <b>description</b>
- <p>create a font handle using a data stream</p>
- <b>parameters</b>
- <p><i>pointer</i>font creator handle</p>
- <p><i>pointer to Stream</i>stream to load font from (see Stream data type)</p>
- <p><i>int32</i>font size</p>
- <p><i>uint32</i>font style flags (see FontStyleFlag constants)</p>
- <p><i>uint32</i>font anti aliasing (see FontAntiAliasing constants)</p>
- <b>returns</b>
- <p><i>pointer</i>font handle or NULL on failure</p>
- </div>
-
- <h3>ltsFontCreatorDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy a font creator</p>
- <b>parameters</b>
- <p><i>pointer</i>font creator handle to destroy</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcfont">Font</h2>
- <div class="content">
- <p>Font objects are used to define the appearance (size, style, ...) of text. They are created using a font creator.</p>
-
- <h3>ltsFontGetPostProcessor</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current post processor of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>pointer</i>current assigned post processor</p>
- </div>
-
- <h3>ltsFontGetTabWidth</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current tab with of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>pointer to int32</i>value to write current tab width to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontGetCharSpacing</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current char spacing of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>pointer to int32</i>value to write current char spacing to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontGetLineSpacing</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current line spacing of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>pointer to float</i>value to write current line spacing to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontGetMetric</h3>
- <div class="content func">
- <b>description</b>
- <p>get the metric of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>pointer to FontMetric</i>value to write font metric to (see FontMetric data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontGetFontname</h3>
- <div class="content func">
- <b>description</b>
- <p>get name of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>AnsiString</i>font name or NULL on failure</p>
- </div>
-
- <h3>ltsFontGetFacename</h3>
- <div class="content func">
- <b>description</b>
- <p>get face name of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>AnsiString</i>face name or NULL on failure</p>
- </div>
-
- <h3>ltsFontGetStylename</h3>
- <div class="content func">
- <b>description</b>
- <p>get style name of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>AnsiString</i>style name or NULL on failure</p>
- </div>
-
- <h3>ltsFontGetFullname</h3>
- <div class="content func">
- <b>description</b>
- <p>get full name of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>AnsiString</i>full name or NULL on failure</p>
- </div>
-
- <h3>ltsFontGetCopyright</h3>
- <div class="content func">
- <b>description</b>
- <p>get copyright of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>AnsiString</i>copyright or NULL on failure</p>
- </div>
-
- <h3>ltsFontSetPostProcessor</h3>
- <div class="content func">
- <b>description</b>
- <p>set post processor of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>pointer</i>post processor handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontSetTabWidth</h3>
- <div class="content func">
- <b>description</b>
- <p>set tab with of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>int32</i>new tab with value</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontSetCharSpacing</h3>
- <div class="content func">
- <b>description</b>
- <p>set char spacing of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>int32</i>new char spacing value</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontSetLineSpacing</h3>
- <div class="content func">
- <b>description</b>
- <p>set line spacing of a font</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle</p>
- <p><i>float</i>new line spacing value</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsFontDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy a font handle</p>
- <b>parameters</b>
- <p><i>pointer</i>font handle to destroy</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="functextblock">Text Block</h2>
- <div class="content">
- <p>Text block objects are used to arrange text in a block: automatic line break, alignment, text color, text font, ...</p>
-
- <h3>ltsTextBlockGetRect</h3>
- <div class="content func">
- <b>description</b>
- <p>get text block rectangle</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to Rect</i>value to store text block rectangle in</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetWidth</h3>
- <div class="content func">
- <b>description</b>
- <p>get the width of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write text block width to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetHeight</h3>
- <div class="content func">
- <b>description</b>
- <p>get the height of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write text block height to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetFlags</h3>
- <div class="content func">
- <b>description</b>
- <p>get text block flags</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write text block flags to (see TextBlockFlags constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
-
- <h3>ltsTextBlockGetTop</h3>
- <div class="content func">
- <b>description</b>
- <p>get the top position of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write text block top position to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetLeft</h3>
- <div class="content func">
- <b>description</b>
- <p>get the left position of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write text block left position to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetVertAlign</h3>
- <div class="content func">
- <b>description</b>
- <p>get the vertical alignment of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write vertical alignment to (see VertAlignment constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetHorzAlign</h3>
- <div class="content func">
- <b>description</b>
- <p>get the horizontal alignment of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write horizontal alignment to (see HorzAlignment constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetClipping</h3>
- <div class="content func">
- <b>description</b>
- <p>get the clipping value of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to int32</i>value to write clipping to (see TextBlockClipping constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetColor</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current color of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to Color</i>value to write color to (see Color data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetFont</h3>
- <div class="content func">
- <b>description</b>
- <p>get the current font handle of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer to pointer</i>value to write font handle to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetTop</h3>
- <div class="content func">
- <b>description</b>
- <p>set the top position of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for top position</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetLeft</h3>
- <div class="content func">
- <b>description</b>
- <p>set the left position of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for left position</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetVertAlign</h3>
- <div class="content func">
- <b>description</b>
- <p>set the vertical alignment of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for vertical alignment (see VertAlignment constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetHorzAlign</h3>
- <div class="content func">
- <b>description</b>
- <p>set the horizontal alignment of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for horizontal alignment (see HorzAlignment constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetClipping</h3>
- <div class="content func">
- <b>description</b>
- <p>set the a text block clipping</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for text block clipping (see TextBlockClipping constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetColor</h3>
- <div class="content func">
- <b>description</b>
- <p>set color to render text with</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>int32</i>new value for text color (see Color data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockSetFont</h3>
- <div class="content func">
- <b>description</b>
- <p>set font to render text with</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>pointer</i>font handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockGetActualHeight</h3>
- <div class="content func">
- <b>description</b>
- <p>get the used size of a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <b>returns</b>
- <p><i>int32</i>actual used size of the text block or -1 on error</p>
- </div>
-
- <h3>ltsTextBlockGetTextWidthA</h3>
- <div class="content func">
- <b>description</b>
- <p>get the width of a certain text</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>AnsiString</i>string to calculate width for</p>
- <b>returns</b>
- <p><i>int32</i>width of the passed text or -1 on error</p>
- </div>
-
- <h3>ltsTextBlockGetTextWidthW</h3>
- <div class="content func">
- <b>description</b>
- <p>get the width of a certain text</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>WideString</i>string to calculate width for</p>
- <b>returns</b>
- <p><i>int32</i>width of the passed text or -1 on error</p>
- </div>
-
- <h3>ltsTextBlockTextOutA</h3>
- <div class="content func">
- <b>description</b>
- <p>write text to the text block using the current font and color</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>AnsiString</i>text to write to text block</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockTextOutW</h3>
- <div class="content func">
- <b>description</b>
- <p>write text to the text block using the current font and color</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <p><i>WideString</i>text to write to text block</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsTextBlockDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy a text block</p>
- <b>parameters</b>
- <p><i>pointer</i>text block handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcimage">Image</h2>
- <div class="content">
- <p>Image objects are used to store glyph data. You can manipulate the stored data through a post processor before the glyph is rendered.</p>
-
- <h3>ltsImageCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>create a new image</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <b>returns</b>
- <p><i>pointer</i>image handle or NULL on error</p>
- </div>
-
- <h3>ltsImageIsEmpty</h3>
- <div class="content func">
- <b>description</b>
- <p>check if an image is empty</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>pointer to boolean</i>value to write result to</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageGetWidth</h3>
- <div class="content func">
- <b>description</b>
- <p>get the width of an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>int32</i>image width or -1 on error</p>
- </div>
-
- <h3>ltsImageGetHeight</h3>
- <div class="content func">
- <b>description</b>
- <p>get the height of an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>int32</i>image height or -1 on error</p>
- </div>
-
- <h3>ltsImageGetLineSize</h3>
- <div class="content func">
- <b>description</b>
- <p>get the data size of a single line (in bytes)</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>int32</i>line size or -1 on error</p>
- </div>
-
- <h3>ltsImageGetDataSize</h3>
- <div class="content func">
- <b>description</b>
- <p>get the data size of the complete image (in bytes)</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>int32</i>data size or -1 on error</p>
- </div>
-
- <h3>ltsImageGetFormat</h3>
- <div class="content func">
- <b>description</b>
- <p>get the format of an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>pointer to int32</i>value to write image format to (see ImageFormat constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageGetData</h3>
- <div class="content func">
- <b>description</b>
- <p>get a pointer to the image data</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>pointer</i>pointer to the image data or NULL on failure</p>
- </div>
-
- <h3>ltsImageGetScanline</h3>
- <div class="content func">
- <b>description</b>
- <p>get a pointer to a certain image line</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>int32</i>line index</p>
- <b>returns</b>
- <p><i>pointer</i>pointer to the image line or NULL on failure</p>
- </div>
-
- <h3>ltsImageGetPixelAt</h3>
- <div class="content func">
- <b>description</b>
- <p>get the color of a single pixel</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>int32</i>x position</p>
- <p><i>int32</i>y position</p>
- <p><i>pointer to Color</i>value to write color to (see Color data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageAssign</h3>
- <div class="content func">
- <b>description</b>
- <p>assign the source image to another image (duplicate the image object)</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>pointer</i>image handle of source image</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageCreateEmpty</h3>
- <div class="content func">
- <b>description</b>
- <p>initialize image with a certain size and format</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>ImageFormat</i>data format of the image (see ImageFormat constants)</p>
- <p><i>int32</i>width of the image (in pixel)</p>
- <p><i>int32</i>height of the image (in pixel)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageLoadFromFunc</h3>
- <div class="content func">
- <b>description</b>
- <p>load image data from callback function</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>ImageLoadFunc</i>callback function (see ImageLoadFunc data type)</p>
- <p><i>pointer</i>user defined arguments (will passed to callback function)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageResize</h3>
- <div class="content func">
- <b>description</b>
- <p>change the size of an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>int32</i>new image width</p>
- <p><i>int32</i>new image height</p>
- <p><i>int32</i>x position of the old image inside the new one</p>
- <p><i>int32</i>y position of the old image inside the new one</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageFillColor</h3>
- <div class="content func">
- <b>description</b>
- <p>fill the complete image with a color</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>Color</i>color to fill image with (see Color data type)</p>
- <p><i>uint32</i>flags of color channel to fill (see ColorChannels constants)</p>
- <p><i>ImageModes</i>image mode to use for color fill (see ImageModes data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageFillPattern</h3>
- <div class="content func">
- <b>description</b>
- <p>fill the complete image with a image pattern</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle to fill with pattern</p>
- <p><i>pointer</i>pattern image handle</p>
- <p><i>int32</i>x position of pattern inside the image</p>
- <p><i>int32</i>y position of pattern inside the image</p>
- <p><i>uint32</i>flags of color channel to fill (see ColorChannels constants)</p>
- <p><i>ImageModes</i>image mode to use (see ImageModes data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageBlend</h3>
- <div class="content func">
- <b>description</b>
- <p>blend one image inside of another image</p>
- <b>parameters</b>
- <p><i>pointer</i>handle to destination image</p>
- <p><i>pointer</i>handle to source image</p>
- <p><i>int32</i>x position of source image inside the destination image</p>
- <p><i>int32</i>y position of source image inside the destination image</p>
- <p><i>ImageBlendFunc</i>callback function to use for blending (see ImageBlendFunc data type)</p>
- <p><i>pointer</i>user defined arguments (will be passed to callback function)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageBlur</h3>
- <div class="content func">
- <b>description</b>
- <p>use blur filter on an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <p><i>float</i>horizontal blur radius</p>
- <p><i>float</i>horizontal blur strength</p>
- <p><i>float</i>vertical blur radius</p>
- <p><i>float</i>vertical blur strength</p>
- <p><i>uint32</i>flags of color channel to blur (see ColorChannels constants)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsImageDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy an image</p>
- <b>parameters</b>
- <p><i>pointer</i>image handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcpostprocessor">Post Processor</h2>
- <div class="content">
- <p>Post processor objects are used to manipulate glyph data before it is rendered. You are able to add shadows, borders or something like that.</p>
-
- <h3>ltsPostProcessorAddRange</h3>
- <div class="content func">
- <b>description</b>
- <p>add char range to use post processor at</p>
- <b>parameters</b>
- <p><i>pointer</i>post processor handle</p>
- <p><i>int32</i>usage of the char range (see CharRangeUsage constants)</p>
- <p><i>WideChar</i>first char of the range</p>
- <p><i>WideChar</i>last char of the range</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsPostProcessorAddChars</h3>
- <div class="content func">
- <b>description</b>
- <p>add chars to use post processor at</p>
- <b>parameters</b>
- <p><i>pointer</i>post processor handle</p>
- <p><i>int32</i>usage of the char range (see CharRangeUsage constants)</p>
- <p><i>WideString</i>chars to use post processor at</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsPostProcessorClearRanges</h3>
- <div class="content func">
- <b>description</b>
- <p>clear all defined char ranges and chars</p>
- <b>parameters</b>
- <p><i>pointer</i>post processor handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsPostProcessorClearRanges</h3>
- <div class="content func">
- <b>description</b>
- <p>execute the post processor</p>
- <b>parameters</b>
- <p><i>pointer</i>post processor handle</p>
- <p><i>pointer</i>char handle to execute post processor at</p>
- <p><i>pointer</i>image handle to execute post processor at</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsPostProcessorFillColorCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new post processor that will fill a char with a given color</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>Color</i>color to fill char with (see Color data type)</p>
- <p><i>ImageModes</i>image modes to use (see ImageModes data type)</p>
- <p><i>uint32</i>flags of color channels to fill (see ColorChannels constants)</p>
- <b>returns</b>
- <p><i>pointer</i>post processor handle or NULL on failure</p>
- </div>
-
- <h3>ltsPostProcessorFillPatterCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new post processor that will fill a char with a given pattern</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>pointer</i>image handle to use as pattern</p>
- <p><i>boolean</i>TRUE: image handle is destroyed with post processor; FALSE: user must destroy image handle when finished</p>
- <p><i>Position</i>position to place pattern at</p>
- <p><i>ImageModes</i>image modes to use (see ImageModes data type)</p>
- <p><i>uint32</i>flags of color channels to fill (see ColorChannels constants)</p>
- <b>returns</b>
- <p><i>pointer</i>post processor handle or NULL on failure</p>
- </div>
-
- <h3>ltsPostProcessorBorderCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new post processor that will create a border around a char</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>float</i>border width</p>
- <p><i>float</i>border strength</p>
- <p><i>Color</i>border color (see Color data type)</p>
- <p><i>boolean</i>TRUE: do not change the char size; FALSE: add border to char size;</p>
- <b>returns</b>
- <p><i>pointer</i>post processor handle or NULL on failure</p>
- </div>
-
- <h3>ltsPostProcessorShadowCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new post processor that will create a shadow under a char</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>float</i>shadow radius</p>
- <p><i>float</i>shadow strength</p>
- <p><i>Position</i>shadow offset (see Position data type)</p>
- <p><i>Color</i>shadow color (see Color data type)</p>
- <b>returns</b>
- <p><i>pointer</i>post processor handle or NULL on failure</p>
- </div>
-
- <h3>ltsPostProcessorCustomCreate</h3>
- <div class="content func">
- <b>description</b>
- <p>creates a new post processor that will execute custom code</p>
- <b>parameters</b>
- <p><i>pointer</i>context handle</p>
- <p><i>pointer to PostProcessorCustomData</i>all needed data for custom code (see PostProcessorCustomData data type)</p>
- <b>returns</b>
- <p><i>pointer</i>post processor handle or NULL on failure</p>
- </div>
-
- <h3>ltsPostProcessorDestroy</h3>
- <div class="content func">
- <b>description</b>
- <p>destroy post processor</p>
- <b>parameters</b>
- <p><i>pointer</i>post processor handle</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
-
- <h2 id="funcchar">Char</h2>
- <div class="content">
- <p>Char objects are used to store the size of a glyph. The data can be manipulated using a post processor.</p>
-
- <h3>ltsCharGetCharCode</h3>
- <div class="content func">
- <b>description</b>
- <p>get the char code of a char object</p>
- <b>parameters</b>
- <p><i>pointer</i>char handle</p>
- <p><i>pointer to WideChar</i>value to store char code in</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsCharGetGlyphMetric</h3>
- <div class="content func">
- <b>description</b>
- <p>get glyph metric of a char</p>
- <b>parameters</b>
- <p><i>pointer</i>char handle</p>
- <p><i>pointer to GlyphMetric</i>value to store glyph metric in (see GlyphMetric data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
-
- <h3>ltsCharSetGlyphMetric</h3>
- <div class="content func">
- <b>description</b>
- <p>set glyph metric of a char</p>
- <b>parameters</b>
- <p><i>pointer</i>char handle</p>
- <p><i>pointer to GlyphMetric</i>new glyph metric value (see GlyphMetric data type)</p>
- <b>returns</b>
- <p><i>uint32</i>error code</p>
- </div>
- </div>
- </div>
- </body>
- </html>
|