| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: Bitmap Drawing Functions</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle"><div class="title">Bitmap Drawing Functions<div class="ingroups"><a class="el" href="group__dgl.html">Cross-Platform OpenGL Support</a></div></div></div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga692e3779c55b71841ca83896b5fc167c" id="r_ga692e3779c55b71841ca83896b5fc167c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga692e3779c55b71841ca83896b5fc167c">dglDrawBitmap</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_point2_i.html">Point2I</a> &in_rAt, const U32 in_flip=GFlip_None)</td></tr>
- <tr class="separator:ga692e3779c55b71841ca83896b5fc167c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1543c6ed7f32bed07f87bbd8ddd24a36" id="r_ga1543c6ed7f32bed07f87bbd8ddd24a36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga1543c6ed7f32bed07f87bbd8ddd24a36">dglDrawBitmapTile</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &in_rTile, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
- <tr class="separator:ga1543c6ed7f32bed07f87bbd8ddd24a36"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab0750d6b08029306213c6ca340e3ef57" id="r_gab0750d6b08029306213c6ca340e3ef57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#gab0750d6b08029306213c6ca340e3ef57">dglDrawBitmapStretch</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &in_rStretch, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
- <tr class="separator:gab0750d6b08029306213c6ca340e3ef57"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga45c1e5189d9d9ef07c585ec683425bbf" id="r_ga45c1e5189d9d9ef07c585ec683425bbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga45c1e5189d9d9ef07c585ec683425bbf">dglDrawBitmapSR</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_point2_i.html">Point2I</a> &in_rAt, const <a class="el" href="class_rect_i.html">RectI</a> &in_rSubRegion, const U32 in_flip=GFlip_None)</td></tr>
- <tr class="separator:ga45c1e5189d9d9ef07c585ec683425bbf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf8c319111cce8c52b1f3b19b9df3bbc1" id="r_gaf8c319111cce8c52b1f3b19b9df3bbc1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#gaf8c319111cce8c52b1f3b19b9df3bbc1">dglDrawBitmapStretchSR</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &in_rStretch, const <a class="el" href="class_rect_i.html">RectI</a> &in_rSubRegion, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
- <tr class="separator:gaf8c319111cce8c52b1f3b19b9df3bbc1"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>These functions allow you to draw a bitmap. Each function will draw the bitmap in a specific way regarding stretching </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga692e3779c55b71841ca83896b5fc167c" name="ga692e3779c55b71841ca83896b5fc167c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga692e3779c55b71841ca83896b5fc167c">◆ </a></span>dglDrawBitmap()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglDrawBitmap </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> * </td>
- <td class="paramname"><em>texObject</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>in_rAt</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Draws a bitmap, starting from the lower left corner, going up and right </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
- <tr><td class="paramname">in_rAt</td><td>where to draw the texture in 2d coordinates </td></tr>
- <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga45c1e5189d9d9ef07c585ec683425bbf" name="ga45c1e5189d9d9ef07c585ec683425bbf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga45c1e5189d9d9ef07c585ec683425bbf">◆ </a></span>dglDrawBitmapSR()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglDrawBitmapSR </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> * </td>
- <td class="paramname"><em>texObject</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>in_rAt</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>in_rSubRegion</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Draws a sub region of a texture </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
- <tr><td class="paramname">in_rAt</td><td>point where the texture is to be drawn </td></tr>
- <tr><td class="paramname">in_rSubRegion</td><td>portion of the texture to be drawn </td></tr>
- <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gab0750d6b08029306213c6ca340e3ef57" name="gab0750d6b08029306213c6ca340e3ef57"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gab0750d6b08029306213c6ca340e3ef57">◆ </a></span>dglDrawBitmapStretch()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglDrawBitmapStretch </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> * </td>
- <td class="paramname"><em>texObject</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>in_rStretch</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bSilhouette</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Draws a bitmap that is stretched </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
- <tr><td class="paramname">in_rStretch</td><td>rectangle where the texture will be drawn in 2d coordinates </td></tr>
- <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gaf8c319111cce8c52b1f3b19b9df3bbc1" name="gaf8c319111cce8c52b1f3b19b9df3bbc1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaf8c319111cce8c52b1f3b19b9df3bbc1">◆ </a></span>dglDrawBitmapStretchSR()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglDrawBitmapStretchSR </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> * </td>
- <td class="paramname"><em>texObject</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>in_rStretch</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>in_rSubRegion</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bSilhouette</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Draws a stretched sub region of a texture </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
- <tr><td class="paramname">in_rStretch</td><td>rectangle where the texture object will be drawn </td></tr>
- <tr><td class="paramname">in_rSubRegion</td><td>sub region of the texture that will be applied over the stretch region of the screen </td></tr>
- <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga1543c6ed7f32bed07f87bbd8ddd24a36" name="ga1543c6ed7f32bed07f87bbd8ddd24a36"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga1543c6ed7f32bed07f87bbd8ddd24a36">◆ </a></span>dglDrawBitmapTile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglDrawBitmapTile </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> * </td>
- <td class="paramname"><em>texObject</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>in_rTile</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bSilhouette</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Draws a power-of-two bitmap that is tiled. Requires a POT bitmap to draw properly. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
- <tr><td class="paramname">in_rTile</td><td>rectangle where the texture will be drawn in 2d coordinates </td></tr>
- <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|