jurjen.ladeniusandClaude Opus 4.8
f3340e86c6
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
382 lines
66 KiB
HTML
382 lines
66 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>print.h</title><link rel="stylesheet" type="text/css" href="../styles/main.css" /><script type="text/javascript" src="../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../styles/");</script></head>
|
|
|
|
<!-- Generated by Natural Docs, version 2.2 -->
|
|
|
|
<!-- saved from url=(0016)http://localhost -->
|
|
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
|
|
<a name="Initialization"></a><a name="Topic902"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Initialization</div>
|
|
<div class="CBody"><p>Font initialization functions</p></div>
|
|
</div>
|
|
|
|
<a name="Print_SetFontData"></a><a name="Topic903"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetFontData</div>
|
|
<div id="NDPrototype903" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetFontData(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Print_Data* </td><td class="PName last">data</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the current font data structure to use for print functions.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">data<div class="CDLParameterType">Print_Data*</div></td><td class="CDLDefinition"><p>Address of the font data structure to use for print functions.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_Initialize"></a><a name="Topic904"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Initialize</div>
|
|
<div id="NDPrototype904" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">bool</span> Print_Initialize()</div></div>
|
|
<div class="CBody"><p>Initialize print module. Must be called after VDP_SetMode().</p></div>
|
|
</div>
|
|
|
|
<a name="Print_SetMode"></a><a name="Topic905"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetMode</div>
|
|
<div id="NDPrototype905" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetMode(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">mode</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Change current print mode.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">mode<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Print mode to select. Can be:</p></td></tr></table><pre class="CText">PRINT_MODE_BITMAP Draw characters from RAM (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.<br />PRINT_MODE_BITMAP_TRANS Draw characters from RAM with transparency (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.<br />PRINT_MODE_BITMAP_VRAM Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.<br />PRINT_MODE_BITMAP_VRAM_TRANS Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.<br />PRINT_MODE_SPRITE Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system). Need PRINT_USE_SPRITE compile option.<br />PRINT_MODE_TEXT Draw characters as pattern names (text mode). Need PRINT_USE_TEXT compile option.</pre></div>
|
|
</div>
|
|
|
|
<a name="Print_SetFont"></a><a name="Topic906"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetFont</div>
|
|
<div id="NDPrototype906" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the current font (and set mode to RAM).</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetFontEx"></a><a name="Topic907"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetFontEx</div>
|
|
<div id="NDPrototype907" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetFontEx(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">patternX,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">patternY,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">sizeX,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">sizeY,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">firstChr,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">lastChr,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">patterns</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the current font</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">patternX<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Width of the character data (should be always 8)</p></td></tr><tr><td class="CDLEntry">patternY<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Height of the character data</p></td></tr><tr><td class="CDLEntry">sizeX<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Width of the chatacter to display (can be different than the one of the data)</p></td></tr><tr><td class="CDLEntry">sizeY<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Height of the chatacter to display (can be different than the one of the data)</p></td></tr><tr><td class="CDLEntry">firstChr<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>ASCII code of the first character included in the font data</p></td></tr><tr><td class="CDLEntry">lastChr<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>ASCII code of the last character included in the font data</p></td></tr><tr><td class="CDLEntry">patterns<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Address of the character data table</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_GetFontInfo"></a><a name="Topic908"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_GetFontInfo</div>
|
|
<div id="NDPrototype908" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline const</span> Print_Data* Print_GetFontInfo()</div></div>
|
|
<div class="CBody"><p>Get information on the current font.</p><div class="CHeading">Return</div><p>Current font information structure</p></div>
|
|
</div>
|
|
|
|
<a name="Print_SetPosition"></a><a name="Topic909"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetPosition</div>
|
|
<div id="NDPrototype909" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetPosition(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set cursor position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">X<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Print cursor position X coordinate</p></td></tr><tr><td class="CDLEntry">Y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Print cursor position Y coordinate</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetPositionX"></a><a name="Topic910"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetPositionX</div>
|
|
<div id="NDPrototype910" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetPositionX(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set cursor X coordinate.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">X<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Print cursor position X coordinate</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetPositionY"></a><a name="Topic911"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetPositionY</div>
|
|
<div id="NDPrototype911" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetPositionY(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UY </td><td class="PName last">y</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set cursor Y coordinate.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">Y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Print cursor position Y coordinate</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetCharSize"></a><a name="Topic912"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetCharSize</div>
|
|
<div id="NDPrototype912" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetCharSize(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">x,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">y</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set character size.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">X<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Character width</p></td></tr><tr><td class="CDLEntry">Y<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Character height</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetTabSize"></a><a name="Topic913"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetTabSize</div>
|
|
<div id="NDPrototype913" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetTabSize(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">size</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set tabulation size in pixel.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">size<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Size of the tabulation in pixel (must be a power of 2 like 16, 32, 64, ...)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetBitmapFont"></a><a name="Topic914"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetBitmapFont</div>
|
|
<div id="NDPrototype914" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetBitmapFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Initialize print module and set a font in RAM. This function requires PRINT_USE_BITMAP compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetVRAMFont"></a><a name="Topic915"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetVRAMFont</div>
|
|
<div id="NDPrototype915" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetVRAMFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font,</td></tr><tr><td class="first"></td><td class="PType">UY </td><td class="PName last">y,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">color,</td></tr><tr><td class="first"></td><td class="PType"><span class="SHKeyword">bool</span> </td><td class="PName last">trans</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the current font and upload data to VRAM . This function requires PRINT_USE_VRAM compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Y position to store the font in VRAM</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Color of the font</p></td></tr><tr><td class="CDLEntry">trans<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>Use transparency</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetTextFont"></a><a name="Topic916"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetTextFont</div>
|
|
<div id="NDPrototype916" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetTextFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">offset</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Initialize print module and set a font in RAM. This function requires PRINT_USE_TEXT compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr><tr><td class="CDLEntry">offset<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Pattern index where to start to store the font</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SelectTextFont"></a><a name="Topic917"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SelectTextFont</div>
|
|
<div id="NDPrototype917" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SelectTextFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">offset</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set print mode to text mode. This function requires PRINT_USE_TEXT compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr><tr><td class="CDLEntry">offset<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Pattern index where to start to store the font</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_GetPatternOffset"></a><a name="Topic918"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_GetPatternOffset</div>
|
|
<div id="NDPrototype918" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Print_GetPatternOffset()</div></div>
|
|
<div class="CBody"><p>Get pattern index where the font is stored. This function requires PRINT_USE_TEXT compile option to be set to TRUE.</p><div class="CHeading">Return</div><p>Pattern index where the font is stored</p></div>
|
|
</div>
|
|
|
|
<a name="Print_SetPatternOffset"></a><a name="Topic919"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetPatternOffset</div>
|
|
<div id="NDPrototype919" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetPatternOffset(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">offset</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set pattern index where the font is stored. This function requires PRINT_USE_TEXT compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">offset<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Pattern index where to start to store the font</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetSpriteFont"></a><a name="Topic920"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetSpriteFont</div>
|
|
<div id="NDPrototype920" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetSpriteFont(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">font,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">patIdx,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">sprtIdx</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the current font and upload to Sprite Pattern Table. This function requires PRINT_USE_SPRITE compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">font<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font structure. Character patterns plus a 4 bytes headers (character width/height, spacing width/height, 1st character code, last character code).</p></td></tr><tr><td class="CDLEntry">patIdx<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Pattern index to put font character</p></td></tr><tr><td class="CDLEntry">sprtIdx<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Sprite index of the first sprite the module can use to display text</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_GetSpritePattern"></a><a name="Topic921"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_GetSpritePattern</div>
|
|
<div id="NDPrototype921" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Print_GetSpritePattern()</div></div>
|
|
<div class="CBody"><p>Get pattern index of the 1st sprite character. This function requires PRINT_USE_SPRITE compile option to be set to TRUE.</p><div class="CHeading">Return</div><p>Pattern index where the font is stored</p></div>
|
|
</div>
|
|
|
|
<a name="Print_GetSpriteID"></a><a name="Topic922"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_GetSpriteID</div>
|
|
<div id="NDPrototype922" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Print_GetSpriteID()</div></div>
|
|
<div class="CBody"><p>Get the next sprite index. This function requires PRINT_USE_SPRITE compile option to be set to TRUE.</p><div class="CHeading">Return</div><p>Sprite index of the first sprite the module can use to display text</p></div>
|
|
</div>
|
|
|
|
<a name="Print_SetSpriteID"></a><a name="Topic923"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetSpriteID</div>
|
|
<div id="NDPrototype923" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_SetSpriteID(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">id</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the next sprite index. This function requires PRINT_USE_SPRITE compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">id<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Sprite index of the first sprite the module can use to display text</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Draw"></a><a name="Topic924"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Draw</div>
|
|
<div class="CBody"><p>Text draw functions</p></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawChar"></a><a name="Topic925"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawChar</div>
|
|
<div id="NDPrototype925" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawChar(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">chr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a single character</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chr<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>ASCII code of the character to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawCharX"></a><a name="Topic926"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawCharX</div>
|
|
<div id="NDPrototype926" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawCharX(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">c8 </td><td class="PName last">chr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">num</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print the same character many times</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>ASCII code of the character to draw</p></td></tr><tr><td class="CDLEntry">num<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Number of the same character to display in a row</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawText"></a><a name="Topic927"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawText</div>
|
|
<div id="NDPrototype927" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawText(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">string</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a character string</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">string<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Null-terminated string to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawHex8"></a><a name="Topic928"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawHex8</div>
|
|
<div id="NDPrototype928" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawHex8(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 8-bits binary value</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8 bits integer to draw in hexadecimal form</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawHex16"></a><a name="Topic929"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawHex16</div>
|
|
<div id="NDPrototype929" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawHex16(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 16-bits hexadecimal value</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>16 bits integer to draw in hexadecimal form</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawBin8"></a><a name="Topic930"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawBin8</div>
|
|
<div id="NDPrototype930" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawBin8(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 8-bits binary value</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8 bits integer to draw in binary form (0 or 1)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawHex32"></a><a name="Topic931"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawHex32</div>
|
|
<div id="NDPrototype931" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawHex32(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u32 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 32-bits hexadecimal value This function requires PRINT_USE_32B compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u32</div></td><td class="CDLDefinition"><p>32 bits integer to draw in hexadecimal form</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawInt"></a><a name="Topic932"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawInt</div>
|
|
<div id="NDPrototype932" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawInt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">i32 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 32-bits signed decimal value. This function requires PRINT_USE_32B compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">i32</div></td><td class="CDLDefinition"><p>32 bits signed integer to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawInt(2)"></a><a name="Topic933"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawInt</div>
|
|
<div id="NDPrototype933" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawInt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">i16 </td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 16-bits signed decimal value. This function requires PRINT_USE_32B compile option to be set to FALSE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">i16</div></td><td class="CDLDefinition"><p>16 bits signed integer to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_Space"></a><a name="Topic934"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Space</div>
|
|
<div id="NDPrototype934" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_Space()</div></div>
|
|
<div class="CBody"><p>Print space.</p></div>
|
|
</div>
|
|
|
|
<a name="Print_Tab"></a><a name="Topic935"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Tab</div>
|
|
<div id="NDPrototype935" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_Tab()</div></div>
|
|
<div class="CBody"><p>Print tabulation.</p></div>
|
|
</div>
|
|
|
|
<a name="Print_Return"></a><a name="Topic936"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Return</div>
|
|
<div id="NDPrototype936" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_Return()</div></div>
|
|
<div class="CBody"><p>Print return.</p></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawFormat"></a><a name="Topic1450"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawFormat</div>
|
|
<div id="NDPrototype1450" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawFormat(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td></td><td class="PName last">format,</td></tr><tr><td class="first"></td><td></td><td class="PSymbols">...</td><td class="last"></td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a formatted string with a variable number of parameters. This function requires PRINT_USE_FORMAT compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">format<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Printf style format</p></td></tr></table><pre class="CText">%i or %d 16 bits signed integer<br />%u 16 bits unsigned integer<br />%[N]x 16 bits hexadecimal with N digits (default: 4)<br />%c ASCII coded character<br />%s Null-terminated string<br />%I or %D 32 bits signed integer<br />%U 32 bits unsigned integer<br />%[N]X 32 bits hexadecimal with N digits (default: 4)<br />\t Tabulation<br />\n Return to new line</pre><p>... - Variadic parameters</p></div>
|
|
</div>
|
|
|
|
<a name="Helper"></a><a name="Topic938"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Helper</div>
|
|
</div>
|
|
|
|
<a name="Print_Clear"></a><a name="Topic939"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Clear</div>
|
|
<div id="NDPrototype939" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> Print_Clear()</div></div>
|
|
<div class="CBody"><p>Clear screen</p></div>
|
|
</div>
|
|
|
|
<a name="Print_Backspace"></a><a name="Topic940"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_Backspace</div>
|
|
<div id="NDPrototype940" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_Backspace(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">num</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Clear X character back from current cursor position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">num<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Number of character to clear</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextAt"></a><a name="Topic941"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawTextAt</div>
|
|
<div id="NDPrototype941" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawTextAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">UX </td><td class="PName last">x,</td></tr><tr><td class="first"></td><td class="PType">UY </td><td class="PName last">y,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">str</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw text at a given position on screen.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">str<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Null-terminated string to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextAtV"></a><a name="Topic942"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawTextAtV</div>
|
|
<div id="NDPrototype942" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawTextAtV(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">UX </td><td class="PName last">x,</td></tr><tr><td class="first"></td><td class="PType">UY </td><td class="PName last">y,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">str</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw a vertical text at a given position on screen.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">str<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Null-terminated string to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawCharAt"></a><a name="Topic943"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawCharAt</div>
|
|
<div id="NDPrototype943" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawCharAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">c8 </td><td class="PName last">chr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a single character at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>Character to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawCharXAt"></a><a name="Topic944"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawCharXAt</div>
|
|
<div id="NDPrototype944" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawCharXAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">c8 </td><td class="PName last">chr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">len</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print the same character many times at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>Character to draw</p></td></tr><tr><td class="CDLEntry">len<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Number of character to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawCharYAt"></a><a name="Topic945"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawCharYAt</div>
|
|
<div id="NDPrototype945" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawCharYAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">c8 </td><td class="PName last">chr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">len</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print vertically the same character many times at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>Character to draw</p></td></tr><tr><td class="CDLEntry">len<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Number of character to draw</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawHex8At"></a><a name="Topic946"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawHex8At</div>
|
|
<div id="NDPrototype946" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawHex8At(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 8-bits binary value at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8 bits integer to draw in hexadecimal form</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawHex16At"></a><a name="Topic947"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawHex16At</div>
|
|
<div id="NDPrototype947" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawHex16At(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u16 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 16-bits hexadecimal value at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>16 bits integer to draw in hexadecimal form</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawBin8At"></a><a name="Topic948"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawBin8At</div>
|
|
<div id="NDPrototype948" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawBin8At(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 8-bits binary value at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8 bits integer to draw in binary form (0 or 1)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawIntAt"></a><a name="Topic949"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawIntAt</div>
|
|
<div id="NDPrototype949" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawIntAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">i16 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a 16-bits signed decimal value at a given position.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">i16</div></td><td class="CDLDefinition"><p>16 bits integer to display</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="FX"></a><a name="Topic950"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">FX</div>
|
|
</div>
|
|
|
|
<a name="Print_SetColor"></a><a name="Topic951"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetColor</div>
|
|
<div id="NDPrototype951" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetColor(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">text,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">bg</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the draw color.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">text<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Text color (16 color index or 8 bits RGB)</p></td></tr><tr><td class="CDLEntry">bg<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Background color (16 color index or 8 bits RGB)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetColorShade"></a><a name="Topic952"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetColorShade</div>
|
|
<div id="NDPrototype952" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetColorShade(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">shade</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set colors shade. This function requires PRINT_COLOR_NUM compile option to be set to greater than 1 value.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">shade<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to font color (1 color for each line)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetShadow"></a><a name="Topic953"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetShadow</div>
|
|
<div id="NDPrototype953" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetShadow(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">bool</span> </td><td class="PName last">enable,</td></tr><tr><td class="PType first">i8 </td><td class="PName last">offsetX,</td></tr><tr><td class="PType first">i8 </td><td class="PName last">offsetY,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set shadow effect. This function requires PRINT_USE_FX_SHADOW compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">offsetX<div class="CDLParameterType">i8</div></td><td class="CDLDefinition"><p>Offset on X coordinate (can be negative).</p></td></tr><tr><td class="CDLEntry">offsetY<div class="CDLParameterType">i8</div></td><td class="CDLDefinition"><p>Offset on Y coordinate (can be negative).</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Shadow's color.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_EnableShadow"></a><a name="Topic954"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_EnableShadow</div>
|
|
<div id="NDPrototype954" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_EnableShadow(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">bool</span> </td><td class="PName last">enable</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Activate/desactivate shadow effect. This function requires PRINT_USE_FX_SHADOW compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">enable<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>TRUE to enable shadow effect, FALSE to disable.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextShadow"></a><a name="Topic955"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawTextShadow</div>
|
|
<div id="NDPrototype955" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawTextShadow(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">string,</td></tr><tr><td class="first"></td><td class="PType">i8 </td><td class="PName last">offsetX,</td></tr><tr><td class="first"></td><td class="PType">i8 </td><td class="PName last">offsetY,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a character string with shadow FX using 2 pass rendering (to have clean shadow over all characters). This function requires PRINT_USE_2_PASS_FX and PRINT_USE_FX_SHADOW compile options to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">string<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Pointer to the null-terminated string to display.</p></td></tr><tr><td class="CDLEntry">offsetX<div class="CDLParameterType">i8</div></td><td class="CDLDefinition"><p>Shadow position offset (X coordinate).</p></td></tr><tr><td class="CDLEntry">offsetY<div class="CDLParameterType">i8</div></td><td class="CDLDefinition"><p>Shadow position offset (X coordinate).</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Shadow color.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_SetOutline"></a><a name="Topic956"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_SetOutline</div>
|
|
<div id="NDPrototype956" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_SetOutline(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">bool</span> </td><td class="PName last">enable,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set shadow effect. This function requires PRINT_USE_FX_OUTLINE compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">enable<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>TRUE to enable outline effect, FALSE to disable.</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Color of the outline effect</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_EnableOutline"></a><a name="Topic957"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_EnableOutline</div>
|
|
<div id="NDPrototype957" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_EnableOutline(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">bool</span> </td><td class="PName last">enable</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Activate/desactivate shadow effect This function requires PRINT_USE_FX_OUTLINE compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">enable<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>TRUE to enable outline effect, FALSE to disable.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextOutline"></a><a name="Topic958"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawTextOutline</div>
|
|
<div id="NDPrototype958" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawTextOutline(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">string,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a character string using outline FX. This function requires PRINT_USE_2_PASS_FX and PRINT_USE_FX_OUTLINE compile options to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">string<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Pointer to the null-terminated string to display</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Outline color</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Graph"></a><a name="Topic959"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Graph</div>
|
|
<div class="CBody"><p>Boxes draw functions</p></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawLineH"></a><a name="Topic960"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawLineH</div>
|
|
<div id="NDPrototype960" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawLineH(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">len</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw an horizontal line using characters This function requires PRINT_USE_GRAPH compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Start position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Start position Y coordinate</p></td></tr><tr><td class="CDLEntry">len<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Lenght of the horizontal line (in print mode unit)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawLineV"></a><a name="Topic961"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawLineV</div>
|
|
<div id="NDPrototype961" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawLineV(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">len</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw a vertical line using characters This function requires PRINT_USE_GRAPH compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Start position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Start position Y coordinate</p></td></tr><tr><td class="CDLEntry">len<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Lenght of the vertical line (in print mode unit)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawBox"></a><a name="Topic962"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawBox</div>
|
|
<div id="NDPrototype962" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Print_DrawBox(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">UX </td><td class="PName last">x,</td></tr><tr><td class="PType first">UY </td><td class="PName last">y,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">width,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">height</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw a box using characters This function requires PRINT_USE_GRAPH compile option to be set to TRUE.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Start position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Start position Y coordinate</p></td></tr><tr><td class="CDLEntry">width<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Box width (in print mode unit)</p></td></tr><tr><td class="CDLEntry">height<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Box height (in print mode unit)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextAlign"></a><a name="Topic963"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Print_DrawTextAlign</div>
|
|
<div id="NDPrototype963" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawTextAlign(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">str,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">align</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Print a character string</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">str<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Null-terminated string to draw</p></td></tr><tr><td class="CDLEntry">align<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Alignement flag: PRINT_ALIGN_LEFT, PRINT_ALIGN_CENTER, PRINT_ALIGN_RIGHT</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Print_DrawTextAlignAt"></a><a name="Topic964"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">Print_DrawTextAlignAt</div>
|
|
<div id="NDPrototype964" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Print_DrawTextAlignAt(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">UX </td><td class="PName last">x,</td></tr><tr><td class="first"></td><td class="PType">UY </td><td class="PName last">y,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">str,</td></tr><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">align</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Draw text at a given position on screen.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">UX</div></td><td class="CDLDefinition"><p>Position X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">UY</div></td><td class="CDLDefinition"><p>Position Y coordinate</p></td></tr><tr><td class="CDLEntry">str<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Null-terminated string to draw</p></td></tr><tr><td class="CDLEntry">align<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Alignement flag: PRINT_ALIGN_LEFT, PRINT_ALIGN_CENTER, PRINT_ALIGN_RIGHT</p></td></tr></table></div>
|
|
</div>
|
|
|
|
</body></html> |