jurjenwerk/mazegame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
mazegame/engine/doc/html/files/tile-h.html
T

104 lines
18 KiB
HTML
Raw Permalink Blame History

<!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>tile.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="Bank"></a><a name="Topic826"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Bank</div>
<div class="CBody"><p>Bank managment functions.</p></div>
</div>
<a name="Tile_SetBankPage"></a><a name="Topic827"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_SetBankPage</div>
<div id="NDPrototype827" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_SetBankPage(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">page</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set page number where pattern are located in VRAM. Must be called before load data there.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">page<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>VRAM page number (0-3)</p></td></tr></table></div>
</div>
<a name="Tile_LoadBankEx"></a><a name="Topic828"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_LoadBankEx</div>
<div id="NDPrototype828" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Tile_LoadBankEx(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">bank,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">u8*&nbsp;</td><td class="PName last">data,</td></tr><tr><td class="first"></td><td class="PType">u16&nbsp;</td><td class="PName last">offset,</td></tr><tr><td class="first"></td><td class="PType">u16&nbsp;</td><td class="PName last">num</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Load data to the given bank (in the selected page ; see <a href="../index.html#File:tile.h:Tile_SetBankPage" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,827);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Tile_SetBankPage</a>).</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr><tr><td class="CDLEntry">data<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to source data (format depends on screen mode)</p></td></tr><tr><td class="CDLEntry">offset<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Tiles offset in the bank</p></td></tr><tr><td class="CDLEntry">num<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Number of tiles to load</p></td></tr></table></div>
</div>
<a name="Tile_GetBankAddressEx"></a><a name="Topic829"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_GetBankAddressEx</div>
<div id="NDPrototype829" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u32 Tile_GetBankAddressEx(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">bank,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">offset</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Get the VRAM address at a given offset in a given bank.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr><tr><td class="CDLEntry">offset<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Tiles offset in the bank</p></td></tr></table><div class="CHeading">Returns</div><p>VRAM address of the given bank and offset</p></div>
</div>
<a name="Tile_GetBankAddressEx(2)"></a><a name="Topic830"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_GetBankAddressEx</div>
<div class="CBody"><p>Get the VRAM start address of a given bank.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank</td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr></table><div class="CHeading">Returns</div><p>VRAM address of the given bank and offset</p></div>
</div>
<a name="Tile_LoadBank"></a><a name="Topic831"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_LoadBank</div>
<div id="NDPrototype831" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_LoadBank(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">bank,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">u8*&nbsp;</td><td class="PName last">data,</td></tr><tr><td class="first"></td><td class="PType">u16&nbsp;</td><td class="PName last">num</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Load data to the given bank (in the selected page ; see <a href="../index.html#File:tile.h:Tile_SetBankPage" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,827);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Tile_SetBankPage</a>).</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr><tr><td class="CDLEntry">data<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to source data (format depends on screen mode)</p></td></tr><tr><td class="CDLEntry">num<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Number of tiles to load</p></td></tr></table></div>
</div>
<a name="Tile_FillBank"></a><a name="Topic832"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_FillBank</div>
<div id="NDPrototype832" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_FillBank(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">bank,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">value</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Fill the whole bank with the given color.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr><tr><td class="CDLEntry">value<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>color to fill the whole bank</p></td></tr></table></div>
</div>
<a name="Draw"></a><a name="Topic833"></a><div class="CTopic TGroup LC">
<div class="CTitle">Draw</div>
<div class="CBody"><p>Tiles draw functions.</p></div>
</div>
<a name="Tile_SelectBank"></a><a name="Topic834"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_SelectBank</div>
<div id="NDPrototype834" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_SelectBank(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">bank</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set current pattern bank. Must be called at least once before using drawing functions.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Bank number in current page (number of bank depend of the size of 256 tiles)</p></td></tr></table></div>
</div>
<a name="Tile_SetDrawPage"></a><a name="Topic835"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_SetDrawPage</div>
<div id="NDPrototype835" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_SetDrawPage(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">page</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set page number where to draw in VRAM. Must be called at least once before using drawing functions.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">page<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>VRAM page number (0-3)</p></td></tr></table></div>
</div>
<a name="Tile_DrawTile"></a><a name="Topic836"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_DrawTile</div>
<div id="NDPrototype836" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_DrawTile(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">x,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">y,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">tile</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Draw a tile at the given coordinate.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Y coordinate</p></td></tr><tr><td class="CDLEntry">tile<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Tile index to draw</p></td></tr></table></div>
</div>
<a name="Tile_FillTile"></a><a name="Topic837"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_FillTile</div>
<div id="NDPrototype837" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_FillTile(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">x,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">y,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Fill a cell at the given position with the given color.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Y coordinate</p></td></tr><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Color to fill</p></td></tr></table></div>
</div>
<a name="Tile_DrawMapChunk"></a><a name="Topic838"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_DrawMapChunk</div>
<div id="NDPrototype838" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Tile_DrawMapChunk(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">x,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">y,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">u8*&nbsp;</td><td class="PName last">map,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">width,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">height</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Drawn a chunk of tilemap at a given coordinate.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">x<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Destination X coordinate</p></td></tr><tr><td class="CDLEntry">y<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Destination Y coordinate</p></td></tr><tr><td class="CDLEntry">map<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to source tilemap data</p></td></tr><tr><td class="CDLEntry">width<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Width of the tilemap</p></td></tr><tr><td class="CDLEntry">height<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Height of the tilemap</p></td></tr></table></div>
</div>
<a name="Tile_DrawBlock"></a><a name="Topic839"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_DrawBlock</div>
<div id="NDPrototype839" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_DrawBlock(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dx,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">dy,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">sx,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">sy,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">width,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">height</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Drawn a block of tilemap at a given coordinate.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dx<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Destination X coordinate</p></td></tr><tr><td class="CDLEntry">dy<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Destination Y coordinate</p></td></tr><tr><td class="CDLEntry">sx<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Source X coordinate</p></td></tr><tr><td class="CDLEntry">sy<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Source Y coordinate</p></td></tr><tr><td class="CDLEntry">width<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Width to draw</p></td></tr><tr><td class="CDLEntry">height<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Height to draw</p></td></tr></table></div>
</div>
<a name="Tile_DrawScreen"></a><a name="Topic840"></a><div class="CTopic TFunction LC">
<div class="CTitle">Tile_DrawScreen</div>
<div id="NDPrototype840" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Tile_DrawScreen(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">u8*&nbsp;</td><td class="PName last">map</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Draw a whole screen with using a tilemap.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">map<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to source tilemap data</p></td></tr></table></div>
</div>
<a name="Tile_FillScreen"></a><a name="Topic841"></a><div class="CTopic TFunction LC last">
<div class="CTitle">Tile_FillScreen</div>
<div id="NDPrototype841" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Tile_FillScreen(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">color</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Fill the screen with the given color.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">color<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Color to fill the screen with</p></td></tr></table></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink