classCPVRTBackground.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>PowerVR SDK</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. <table width="100%">
  7. <tr>
  8. <td width="33%">
  9. <p align="left">&nbsp;<a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
  10. </td>
  11. <td width="33%">
  12. <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
  13. </td>
  14. <td width="34%">
  15. <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
  16. </td>
  17. </tr>
  18. </table>
  19. <hr>
  20. </head><body>
  21. <!-- Generated by Doxygen 1.3.6 -->
  22. <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
  23. <h1>CPVRTBackground Class Reference</h1>A class for drawing a fullscreen textured background.
  24. <a href="#_details">More...</a>
  25. <p>
  26. <code>#include &lt;<a class="el" href="PVRTBackground_8h-source.html">PVRTBackground.h</a>&gt;</code>
  27. <p>
  28. Collaboration diagram for CPVRTBackground:<p><center><img src="classCPVRTBackground__coll__graph.png" border="0" usemap="#CPVRTBackground__coll__map" alt="Collaboration graph"></center>
  29. <map name="CPVRTBackground__coll__map">
  30. <area href="structSPVRTBackgroundAPI.html" shape="rect" coords="7,7,167,34" alt="">
  31. </map>
  32. <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classCPVRTBackground-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  33. <tr><td></td></tr>
  34. <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  35. <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#a0">CPVRTBackground</a> (void)</td></tr>
  36. <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#a1">~CPVRTBackground</a> (void)</td></tr>
  37. <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#a2">Destroy</a> ()</td></tr>
  38. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="PVRTError_8h.html#a5">EPVRTError</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#a3">Init</a> (const <a class="el" href="structSPVRTContext.html">SPVRTContext</a> *const pContext, const bool bRotate, <a class="el" href="classCPVRTString.html">CPVRTString</a> *pszError=0)</td></tr>
  39. <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
  40. <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#p0">m_bInit</a></td></tr>
  41. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structSPVRTBackgroundAPI.html">SPVRTBackgroundAPI</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBackground.html#p1">m_pAPI</a></td></tr>
  42. </table>
  43. <hr><a name="_details"></a><h2>Detailed Description</h2>
  44. A class for drawing a fullscreen textured background.
  45. <p>
  46. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  47. <a class="anchor" name="a0" doxytag="CPVRTBackground::CPVRTBackground" ></a><p>
  48. <br><br><h3>CPVRTBackground</h3><br><div>
  49. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  50. <tr>
  51. <td class="mdRow">
  52. <table cellpadding="0" cellspacing="0" border="0">
  53. <tr>
  54. <td class="md" nowrap valign="top"> CPVRTBackground::CPVRTBackground </td>
  55. <td class="md" valign="top">(&nbsp;</td>
  56. <td class="md" nowrap valign="top">void&nbsp;</td>
  57. <td class="mdname1" valign="top" nowrap> </td>
  58. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  59. <td class="md" nowrap></td>
  60. </tr>
  61. </table>
  62. </td>
  63. </tr>
  64. </table>
  65. <table cellspacing=5 cellpadding=0 border=0>
  66. <tr>
  67. <td>
  68. &nbsp;
  69. </td>
  70. <td>
  71. <p>
  72. <dl compact><dt><b>Description:</b></dt><dd>Init some values. </dd></dl>
  73. </td>
  74. </tr>
  75. </table>
  76. <a class="anchor" name="a1" doxytag="CPVRTBackground::~CPVRTBackground" ></a><p>
  77. <br><br><h3>~CPVRTBackground</h3><br><div>
  78. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  79. <tr>
  80. <td class="mdRow">
  81. <table cellpadding="0" cellspacing="0" border="0">
  82. <tr>
  83. <td class="md" nowrap valign="top"> CPVRTBackground::~<a class="el" href="classCPVRTBackground.html">CPVRTBackground</a> </td>
  84. <td class="md" valign="top">(&nbsp;</td>
  85. <td class="md" nowrap valign="top">void&nbsp;</td>
  86. <td class="mdname1" valign="top" nowrap> </td>
  87. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  88. <td class="md" nowrap></td>
  89. </tr>
  90. </table>
  91. </td>
  92. </tr>
  93. </table>
  94. <table cellspacing=5 cellpadding=0 border=0>
  95. <tr>
  96. <td>
  97. &nbsp;
  98. </td>
  99. <td>
  100. <p>
  101. <dl compact><dt><b>Description:</b></dt><dd>Calls <a class="el" href="classCPVRTBackground.html#a2">Destroy()</a> </dd></dl>
  102. </td>
  103. </tr>
  104. </table>
  105. <hr><h2>Member Function Documentation</h2>
  106. <a class="anchor" name="a2" doxytag="CPVRTBackground::Destroy" ></a><p>
  107. <br><br><h3>Destroy</h3><br><div>
  108. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  109. <tr>
  110. <td class="mdRow">
  111. <table cellpadding="0" cellspacing="0" border="0">
  112. <tr>
  113. <td class="md" nowrap valign="top"> void CPVRTBackground::Destroy </td>
  114. <td class="md" valign="top">(&nbsp;</td>
  115. <td class="mdname1" valign="top" nowrap> </td>
  116. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  117. <td class="md" nowrap></td>
  118. </tr>
  119. </table>
  120. </td>
  121. </tr>
  122. </table>
  123. <table cellspacing=5 cellpadding=0 border=0>
  124. <tr>
  125. <td>
  126. &nbsp;
  127. </td>
  128. <td>
  129. <p>
  130. <dl compact><dt><b>Description:</b></dt><dd>Destroys the background. It's called by the destructor. </dd></dl>
  131. </td>
  132. </tr>
  133. </table>
  134. <a class="anchor" name="a3" doxytag="CPVRTBackground::Init" ></a><p>
  135. <br><br><h3>Init</h3><br><div>
  136. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  137. <tr>
  138. <td class="mdRow">
  139. <table cellpadding="0" cellspacing="0" border="0">
  140. <tr>
  141. <td class="md" nowrap valign="top"> <a class="el" href="PVRTError_8h.html#a5">EPVRTError</a> CPVRTBackground::Init </td>
  142. <td class="md" valign="top">(&nbsp;</td>
  143. <td class="md" nowrap valign="top">const <a class="el" href="structSPVRTContext.html">SPVRTContext</a> *const&nbsp;</td>
  144. <td class="mdname" nowrap> <em>pContext</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="md" nowrap align="right"></td>
  148. <td></td>
  149. <td class="md" nowrap>const bool&nbsp;</td>
  150. <td class="mdname" nowrap> <em>bRotate</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="md" nowrap align="right"></td>
  154. <td></td>
  155. <td class="md" nowrap><a class="el" href="classCPVRTString.html">CPVRTString</a> *&nbsp;</td>
  156. <td class="mdname" nowrap> <em>pszError</em> = 0</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td class="md">)&nbsp;</td>
  161. <td class="md" colspan="2"></td>
  162. </tr>
  163. </table>
  164. </td>
  165. </tr>
  166. </table>
  167. <table cellspacing=5 cellpadding=0 border=0>
  168. <tr>
  169. <td>
  170. &nbsp;
  171. </td>
  172. <td>
  173. <p>
  174. <dl compact><dt><b>Inputs:</b></dt><dd>
  175. <table border="0" cellspacing="2" cellpadding="0">
  176. <tr><td valign=top><em>pContext</em>&nbsp;</td><td>A pointer to a PVRTContext </td></tr>
  177. <tr><td valign=top><em>bRotate</em>&nbsp;</td><td>true to rotate texture 90 degrees. </td></tr>
  178. <tr><td valign=top><em>pszError</em>&nbsp;</td><td>An option string for returning errors </td></tr>
  179. </table>
  180. </dl>
  181. <dl compact><dt><b>Returns:</b></dt><dd>PVR_SUCCESS on success </dd></dl>
  182. <dl compact><dt><b>Description:</b></dt><dd>Initialises the background </dd></dl>
  183. </td>
  184. </tr>
  185. </table>
  186. <hr><h2>Member Data Documentation</h2>
  187. <a class="anchor" name="p0" doxytag="CPVRTBackground::m_bInit" ></a><p>
  188. <br><br><h3>m_bInit</h3><br><div>
  189. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  190. <tr>
  191. <td class="mdRow">
  192. <table cellpadding="0" cellspacing="0" border="0">
  193. <tr>
  194. <td class="md" nowrap valign="top"> bool <a class="el" href="classCPVRTBackground.html#p0">CPVRTBackground::m_bInit</a><code> [protected]</code>
  195. </table>
  196. </td>
  197. </tr>
  198. </table>
  199. <table cellspacing=5 cellpadding=0 border=0>
  200. <tr>
  201. <td>
  202. &nbsp;
  203. </td>
  204. <td>
  205. <p>
  206. </td>
  207. </tr>
  208. </table>
  209. <a class="anchor" name="p1" doxytag="CPVRTBackground::m_pAPI" ></a><p>
  210. <br><br><h3>m_pAPI</h3><br><div>
  211. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  212. <tr>
  213. <td class="mdRow">
  214. <table cellpadding="0" cellspacing="0" border="0">
  215. <tr>
  216. <td class="md" nowrap valign="top"> <a class="el" href="structSPVRTBackgroundAPI.html">SPVRTBackgroundAPI</a>* <a class="el" href="classCPVRTBackground.html#p1">CPVRTBackground::m_pAPI</a><code> [protected]</code>
  217. </table>
  218. </td>
  219. </tr>
  220. </table>
  221. <table cellspacing=5 cellpadding=0 border=0>
  222. <tr>
  223. <td>
  224. &nbsp;
  225. </td>
  226. <td>
  227. <p>
  228. </td>
  229. </tr>
  230. </table>
  231. <hr>The documentation for this class was generated from the following file:<ul>
  232. <li><a class="el" href="PVRTBackground_8h-source.html">PVRTBackground.h</a></ul>
  233. <br>
  234. <br>
  235. <P align=left><FONT size=2><STRONG><A
  236. href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
  237. 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
  238. <hr>
  239. <address style="align: left;"><small><FONT color=f0f>
  240. Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
  241. </body>
  242. </html>