classgameplay_1_1_texture_1_1_sampler.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>gameplay: Main Page</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_texture.html">Texture</a> </li>
  81. <li class="navelem"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html">Sampler</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-methods">Public Member Functions</a> &#124;
  88. <a href="#pub-static-methods">Static Public Member Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">gameplay::Texture::Sampler Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <!-- doxytag: class="gameplay::Texture::Sampler" --><!-- doxytag: inherits="gameplay::Ref" -->
  94. <p><code>#include &lt;Texture.h&gt;</code></p>
  95. <div class="dynheader">
  96. Inheritance diagram for gameplay::Texture::Sampler:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="classgameplay_1_1_texture_1_1_sampler.png" usemap="#gameplay::Texture::Sampler_map" alt=""/>
  100. <map id="gameplay::Texture::Sampler_map" name="gameplay::Texture::Sampler_map">
  101. <area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,166,24"/>
  102. </map>
  103. </div></div>
  104. <p><a href="classgameplay_1_1_texture_1_1_sampler-members.html">List of all members.</a></p>
  105. <table class="memberdecls">
  106. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  107. Public Member Functions</h2></td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a6b7511f2e22063449253dc8fefb8ad8c">~Sampler</a> ()</td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a2f9c27dca323324bd37faa4de1803602">setWrapMode</a> (<a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a> wrapS, <a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a> wrapT, <a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a> wrapR=REPEAT)</td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a503df7c6724baf9c1fdd49722cc391c1">setFilterMode</a> (<a class="el" href="classgameplay_1_1_texture.html#a17d2554f8fb6b579843f5fe348dc887e">Filter</a> minificationFilter, <a class="el" href="classgameplay_1_1_texture.html#a17d2554f8fb6b579843f5fe348dc887e">Filter</a> magnificationFilter)</td></tr>
  111. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_texture.html">Texture</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a6970128beb567c88b9fead66ba910bab">getTexture</a> () const </td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a25372f518083a0a6fa43c01499b77005">bind</a> ()</td></tr>
  113. <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
  114. Static Public Member Functions</h2></td></tr>
  115. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html">Sampler</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#afab865d64e103a3bf438d5e77c6bc853">create</a> (<a class="el" href="classgameplay_1_1_texture.html">Texture</a> *texture)</td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html">Sampler</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#af62fc552f762475c7cd6ecf5d117ab37">create</a> (const char *path, bool <a class="el" href="classgameplay_1_1_texture.html#a502cf79334ec038207332c1047fff0cf">generateMipmaps</a>=false)</td></tr>
  117. </table>
  118. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  119. <div class="textblock"><p>Defines a texture sampler.</p>
  120. <p>A texture sampler is basically an instance of a texture that can be used to sample a texture from a material. In addition to the texture itself, a sampler stores per-instance texture state information, such as wrap and filter modes. </p>
  121. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  122. <a class="anchor" id="a6b7511f2e22063449253dc8fefb8ad8c"></a><!-- doxytag: member="gameplay::Texture::Sampler::~Sampler" ref="a6b7511f2e22063449253dc8fefb8ad8c" args="()" -->
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">virtual <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a6b7511f2e22063449253dc8fefb8ad8c">gameplay::Texture::Sampler::~Sampler</a> </td>
  128. <td>(</td>
  129. <td class="paramname"></td><td>)</td>
  130. <td><code> [virtual]</code></td>
  131. </tr>
  132. </table>
  133. </div>
  134. <div class="memdoc">
  135. <p>Destructor. </p>
  136. </div>
  137. </div>
  138. <hr/><h2>Member Function Documentation</h2>
  139. <a class="anchor" id="a25372f518083a0a6fa43c01499b77005"></a><!-- doxytag: member="gameplay::Texture::Sampler::bind" ref="a25372f518083a0a6fa43c01499b77005" args="()" -->
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">void <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a25372f518083a0a6fa43c01499b77005">gameplay::Texture::Sampler::bind</a> </td>
  145. <td>(</td>
  146. <td class="paramname"></td><td>)</td>
  147. <td></td>
  148. </tr>
  149. </table>
  150. </div>
  151. <div class="memdoc">
  152. <p>Binds the texture of this sampler to the renderer and applies the sampler state. </p>
  153. </div>
  154. </div>
  155. <a class="anchor" id="afab865d64e103a3bf438d5e77c6bc853"></a><!-- doxytag: member="gameplay::Texture::Sampler::create" ref="afab865d64e103a3bf438d5e77c6bc853" args="(Texture *texture)" -->
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">static <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html">Sampler</a>* <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#afab865d64e103a3bf438d5e77c6bc853">gameplay::Texture::Sampler::create</a> </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html">Texture</a> *&#160;</td>
  163. <td class="paramname"><em>texture</em></td><td>)</td>
  164. <td><code> [static]</code></td>
  165. </tr>
  166. </table>
  167. </div>
  168. <div class="memdoc">
  169. <p>Creates a sampler for the specified texture.</p>
  170. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  171. <table class="params">
  172. <tr><td class="paramname">texture</td><td>The texture.</td></tr>
  173. </table>
  174. </dd>
  175. </dl>
  176. <dl class="return"><dt><b>Returns:</b></dt><dd>The new sampler. </dd></dl>
  177. </div>
  178. </div>
  179. <a class="anchor" id="af62fc552f762475c7cd6ecf5d117ab37"></a><!-- doxytag: member="gameplay::Texture::Sampler::create" ref="af62fc552f762475c7cd6ecf5d117ab37" args="(const char *path, bool generateMipmaps=false)" -->
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">static <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html">Sampler</a>* <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#afab865d64e103a3bf438d5e77c6bc853">gameplay::Texture::Sampler::create</a> </td>
  185. <td>(</td>
  186. <td class="paramtype">const char *&#160;</td>
  187. <td class="paramname"><em>path</em>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">bool&#160;</td>
  193. <td class="paramname"><em>generateMipmaps</em> = <code>false</code>&#160;</td>
  194. </tr>
  195. <tr>
  196. <td></td>
  197. <td>)</td>
  198. <td></td><td><code> [static]</code></td>
  199. </tr>
  200. </table>
  201. </div>
  202. <div class="memdoc">
  203. <p>Creates a sampler for the specified texture.</p>
  204. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  205. <table class="params">
  206. <tr><td class="paramname">path</td><td>Path to the texture to create a sampler for. </td></tr>
  207. <tr><td class="paramname">generateMipmaps</td><td>True to force a full mipmap chain to be generated for the texture, false otherwise.</td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. <dl class="return"><dt><b>Returns:</b></dt><dd>The new sampler. </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="a6970128beb567c88b9fead66ba910bab"></a><!-- doxytag: member="gameplay::Texture::Sampler::getTexture" ref="a6970128beb567c88b9fead66ba910bab" args="() const " -->
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname"><a class="el" href="classgameplay_1_1_texture.html">Texture</a>* <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a6970128beb567c88b9fead66ba910bab">gameplay::Texture::Sampler::getTexture</a> </td>
  220. <td>(</td>
  221. <td class="paramname"></td><td>)</td>
  222. <td> const</td>
  223. </tr>
  224. </table>
  225. </div>
  226. <div class="memdoc">
  227. <p>Gets the texture for this sampler.</p>
  228. <dl class="return"><dt><b>Returns:</b></dt><dd>The texture for this sampler. </dd></dl>
  229. </div>
  230. </div>
  231. <a class="anchor" id="a503df7c6724baf9c1fdd49722cc391c1"></a><!-- doxytag: member="gameplay::Texture::Sampler::setFilterMode" ref="a503df7c6724baf9c1fdd49722cc391c1" args="(Filter minificationFilter, Filter magnificationFilter)" -->
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a503df7c6724baf9c1fdd49722cc391c1">gameplay::Texture::Sampler::setFilterMode</a> </td>
  237. <td>(</td>
  238. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html#a17d2554f8fb6b579843f5fe348dc887e">Filter</a>&#160;</td>
  239. <td class="paramname"><em>minificationFilter</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html#a17d2554f8fb6b579843f5fe348dc887e">Filter</a>&#160;</td>
  245. <td class="paramname"><em>magnificationFilter</em>&#160;</td>
  246. </tr>
  247. <tr>
  248. <td></td>
  249. <td>)</td>
  250. <td></td><td></td>
  251. </tr>
  252. </table>
  253. </div>
  254. <div class="memdoc">
  255. <p>Sets the texture filter modes for this sampler.</p>
  256. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  257. <table class="params">
  258. <tr><td class="paramname">minificationFilter</td><td>The texture minification filter. </td></tr>
  259. <tr><td class="paramname">magnificationFilter</td><td>The texture magnification filter. </td></tr>
  260. </table>
  261. </dd>
  262. </dl>
  263. </div>
  264. </div>
  265. <a class="anchor" id="a2f9c27dca323324bd37faa4de1803602"></a><!-- doxytag: member="gameplay::Texture::Sampler::setWrapMode" ref="a2f9c27dca323324bd37faa4de1803602" args="(Wrap wrapS, Wrap wrapT, Wrap wrapR=REPEAT)" -->
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">void <a class="el" href="classgameplay_1_1_texture_1_1_sampler.html#a2f9c27dca323324bd37faa4de1803602">gameplay::Texture::Sampler::setWrapMode</a> </td>
  271. <td>(</td>
  272. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a>&#160;</td>
  273. <td class="paramname"><em>wrapS</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a>&#160;</td>
  279. <td class="paramname"><em>wrapT</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype"><a class="el" href="classgameplay_1_1_texture.html#a1be9d041e4548acc075d5254c642a4ac">Wrap</a>&#160;</td>
  285. <td class="paramname"><em>wrapR</em> = <code>REPEAT</code>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </div>
  294. <div class="memdoc">
  295. <p>Sets the wrap mode for this sampler.</p>
  296. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  297. <table class="params">
  298. <tr><td class="paramname">wrapS</td><td>The horizontal wrap mode. </td></tr>
  299. <tr><td class="paramname">wrapT</td><td>The vertical wrap mode. </td></tr>
  300. <tr><td class="paramname">wrapR</td><td>The depth wrap mode. </td></tr>
  301. </table>
  302. </dd>
  303. </dl>
  304. </div>
  305. </div>
  306. </div><!-- contents -->
  307. <!-- window showing the filter options -->
  308. <div id="MSearchSelectWindow"
  309. onmouseover="return searchBox.OnSearchSelectShow()"
  310. onmouseout="return searchBox.OnSearchSelectHide()"
  311. onkeydown="return searchBox.OnSearchSelectKey(event)">
  312. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  313. <!-- iframe showing the search results (closed by default) -->
  314. <div id="MSearchResultsWindow">
  315. <iframe src="javascript:void(0)" frameborder="0"
  316. name="MSearchResults" id="MSearchResults">
  317. </iframe>
  318. </div>
  319. <hr class="footer"/><address class="footer"><small>
  320. Generated on Sat Jan 24 2015 15:29:44 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  321. <img class="footer" src="doxygen.png" alt="doxygen"/>
  322. </a> 1.7.6.1
  323. </small></address>
  324. </body>
  325. </html>