group__dgl__bitmap__mod.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Bitmap Modulation</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. </div><!-- top -->
  51. <!-- window showing the filter options -->
  52. <div id="MSearchSelectWindow"
  53. onmouseover="return searchBox.OnSearchSelectShow()"
  54. onmouseout="return searchBox.OnSearchSelectHide()"
  55. onkeydown="return searchBox.OnSearchSelectKey(event)">
  56. </div>
  57. <!-- iframe showing the search results (closed by default) -->
  58. <div id="MSearchResultsWindow">
  59. <div id="MSearchResults">
  60. <div class="SRPage">
  61. <div id="SRIndex">
  62. <div id="SRResults"></div>
  63. <div class="SRStatus" id="Loading">Loading...</div>
  64. <div class="SRStatus" id="Searching">Searching...</div>
  65. <div class="SRStatus" id="NoMatches">No Matches</div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#func-members">Functions</a> </div>
  73. <div class="headertitle"><div class="title">Bitmap Modulation<div class="ingroups"><a class="el" href="group__dgl.html">Cross-Platform OpenGL Support</a></div></div></div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:gab4608b13a5e6538ba43a769026fcae08" id="r_gab4608b13a5e6538ba43a769026fcae08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__mod.html#gab4608b13a5e6538ba43a769026fcae08">dglSetBitmapModulation</a> (const <a class="el" href="class_color_f.html">ColorF</a> &amp;in_rColor)</td></tr>
  80. <tr class="separator:gab4608b13a5e6538ba43a769026fcae08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga7dcc264677a511db3fa991be5b24dffc" id="r_ga7dcc264677a511db3fa991be5b24dffc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__mod.html#ga7dcc264677a511db3fa991be5b24dffc">dglGetBitmapModulation</a> (<a class="el" href="class_color_f.html">ColorF</a> *color)</td></tr>
  82. <tr class="separator:ga7dcc264677a511db3fa991be5b24dffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:gade883de8e8f212eabb4745b75f3717c3" id="r_gade883de8e8f212eabb4745b75f3717c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__mod.html#gade883de8e8f212eabb4745b75f3717c3">dglGetBitmapModulation</a> (<a class="el" href="class_color_i.html">ColorI</a> *color)</td></tr>
  84. <tr class="separator:gade883de8e8f212eabb4745b75f3717c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga5e88b0fd70db59ae9f5a3f1c555cbcba" id="r_ga5e88b0fd70db59ae9f5a3f1c555cbcba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__mod.html#ga5e88b0fd70db59ae9f5a3f1c555cbcba">dglClearBitmapModulation</a> ()</td></tr>
  86. <tr class="separator:ga5e88b0fd70db59ae9f5a3f1c555cbcba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89. <p>These functions control a modulation color that is used to modulate all drawn objects </p>
  90. <h2 class="groupheader">Function Documentation</h2>
  91. <a id="ga5e88b0fd70db59ae9f5a3f1c555cbcba" name="ga5e88b0fd70db59ae9f5a3f1c555cbcba"></a>
  92. <h2 class="memtitle"><span class="permalink"><a href="#ga5e88b0fd70db59ae9f5a3f1c555cbcba">&#9670;&#160;</a></span>dglClearBitmapModulation()</h2>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">void dglClearBitmapModulation </td>
  98. <td>(</td>
  99. <td class="paramname"></td><td>)</td>
  100. <td></td>
  101. </tr>
  102. </table>
  103. </div><div class="memdoc">
  104. <p>Sets current color modulation to white, so no modulation takes place </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__bitmap__mod.html#gab4608b13a5e6538ba43a769026fcae08">dglSetBitmapModulation</a> </dd>
  105. <dd>
  106. <a class="el" href="group__dgl__bitmap__mod.html#ga7dcc264677a511db3fa991be5b24dffc">dglGetBitmapModulation</a> </dd></dl>
  107. </div>
  108. </div>
  109. <a id="ga7dcc264677a511db3fa991be5b24dffc" name="ga7dcc264677a511db3fa991be5b24dffc"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#ga7dcc264677a511db3fa991be5b24dffc">&#9670;&#160;</a></span>dglGetBitmapModulation() <span class="overload">[1/2]</span></h2>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname">void dglGetBitmapModulation </td>
  116. <td>(</td>
  117. <td class="paramtype"><a class="el" href="class_color_f.html">ColorF</a> *&#160;</td>
  118. <td class="paramname"><em>color</em></td><td>)</td>
  119. <td></td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Gets the current color modulation in float format [0,1] </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__bitmap__mod.html#gab4608b13a5e6538ba43a769026fcae08">dglSetBitmapModulation</a> </dd>
  124. <dd>
  125. <a class="el" href="group__dgl__bitmap__mod.html#ga5e88b0fd70db59ae9f5a3f1c555cbcba">dglClearBitmapModulation</a> </dd></dl>
  126. </div>
  127. </div>
  128. <a id="gade883de8e8f212eabb4745b75f3717c3" name="gade883de8e8f212eabb4745b75f3717c3"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#gade883de8e8f212eabb4745b75f3717c3">&#9670;&#160;</a></span>dglGetBitmapModulation() <span class="overload">[2/2]</span></h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">void dglGetBitmapModulation </td>
  135. <td>(</td>
  136. <td class="paramtype"><a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
  137. <td class="paramname"><em>color</em></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. <p>Gets the current color modulation in integer format [0,256) </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__bitmap__mod.html#gab4608b13a5e6538ba43a769026fcae08">dglSetBitmapModulation</a> </dd>
  143. <dd>
  144. <a class="el" href="group__dgl__bitmap__mod.html#ga5e88b0fd70db59ae9f5a3f1c555cbcba">dglClearBitmapModulation</a> </dd></dl>
  145. </div>
  146. </div>
  147. <a id="gab4608b13a5e6538ba43a769026fcae08" name="gab4608b13a5e6538ba43a769026fcae08"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#gab4608b13a5e6538ba43a769026fcae08">&#9670;&#160;</a></span>dglSetBitmapModulation()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">void dglSetBitmapModulation </td>
  154. <td>(</td>
  155. <td class="paramtype">const <a class="el" href="class_color_f.html">ColorF</a> &amp;&#160;</td>
  156. <td class="paramname"><em>in_rColor</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Sets the current color to modulate objects with, similar to glColor3fv() </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__bitmap__mod.html#ga7dcc264677a511db3fa991be5b24dffc">dglGetBitmapModulation</a> </dd>
  162. <dd>
  163. <a class="el" href="group__dgl__bitmap__mod.html#ga5e88b0fd70db59ae9f5a3f1c555cbcba">dglClearBitmapModulation</a> </dd></dl>
  164. </div>
  165. </div>
  166. </div><!-- contents -->
  167. <!-- start footer part -->
  168. <hr class="footer"/><address class="footer"><small>
  169. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  170. </small></address>
  171. </body>
  172. </html>