PVRTBackground_8h-source.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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>PVRTBackground.h</h1><a href="PVRTBackground_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span>
  24. 00002 <span class="comment"></span>
  25. 00003 <span class="comment"> @File PVRTBackground.h</span>
  26. 00004 <span class="comment"></span>
  27. 00005 <span class="comment"> @Title PVRTBackground</span>
  28. 00006 <span class="comment"></span>
  29. 00007 <span class="comment"> @Version </span>
  30. 00008 <span class="comment"></span>
  31. 00009 <span class="comment"> @Copyright Copyright (C) Imagination Technologies Limited.</span>
  32. 00010 <span class="comment"></span>
  33. 00011 <span class="comment"> @Platform ANSI compatible</span>
  34. 00012 <span class="comment"></span>
  35. 00013 <span class="comment"> @Description Function to draw a background texture.</span>
  36. 00014 <span class="comment"></span>
  37. 00015 <span class="comment">******************************************************************************/</span>
  38. 00016 <span class="preprocessor">#ifndef __PVRTBACKGROUND_H__</span>
  39. 00017 <span class="preprocessor"></span><span class="preprocessor">#define __PVRTBACKGROUND_H__</span>
  40. 00018 <span class="preprocessor"></span>
  41. 00019 <span class="preprocessor">#include "<a class="code" href="PVRTGlobal_8h.html">PVRTGlobal.h</a>"</span>
  42. 00020 <span class="preprocessor">#include "<a class="code" href="PVRTContext_8h.html">PVRTContext.h</a>"</span>
  43. 00021 <span class="preprocessor">#include "<a class="code" href="PVRTString_8h.html">PVRTString.h</a>"</span>
  44. 00022 <span class="preprocessor">#include "<a class="code" href="PVRTError_8h.html">PVRTError.h</a>"</span>
  45. 00023
  46. 00024 <span class="comment">/****************************************************************************</span>
  47. 00025 <span class="comment">** Structures</span>
  48. 00026 <span class="comment">****************************************************************************/</span>
  49. 00027 <span class="comment">/*!***************************************************************************</span>
  50. 00028 <span class="comment">@Struct SPVRTBackgroundAPI</span>
  51. 00029 <span class="comment">@Brief A struct for storing API specific variables</span>
  52. 00030 <span class="comment">*****************************************************************************/</span>
  53. 00031 <span class="keyword">struct </span><a class="code" href="structSPVRTBackgroundAPI.html">SPVRTBackgroundAPI</a>;
  54. 00032
  55. 00033 <span class="comment">/*!***************************************************************************</span>
  56. 00034 <span class="comment">@Class CPVRTBackground</span>
  57. 00035 <span class="comment">@Brief A class for drawing a fullscreen textured background</span>
  58. 00036 <span class="comment">*****************************************************************************/</span>
  59. <a name="l00037"></a><a class="code" href="classCPVRTBackground.html">00037</a> <span class="keyword">class </span><a class="code" href="classCPVRTBackground.html">CPVRTBackground</a>
  60. 00038 {
  61. 00039 <span class="keyword">public</span>:
  62. 00040 <span class="comment">/*!***************************************************************************</span>
  63. 00041 <span class="comment"> @Function CPVRTBackground</span>
  64. 00042 <span class="comment"> @Description Init some values.</span>
  65. 00043 <span class="comment"> *****************************************************************************/</span>
  66. 00044 <a class="code" href="classCPVRTBackground.html#a0">CPVRTBackground</a>(<span class="keywordtype">void</span>);
  67. 00045 <span class="comment">/*!***************************************************************************</span>
  68. 00046 <span class="comment"> @Function ~CPVRTBackground</span>
  69. 00047 <span class="comment"> @Description Calls Destroy()</span>
  70. 00048 <span class="comment"> *****************************************************************************/</span>
  71. 00049 <a class="code" href="classCPVRTBackground.html#a1">~CPVRTBackground</a>(<span class="keywordtype">void</span>);
  72. 00050 <span class="comment">/*!***************************************************************************</span>
  73. 00051 <span class="comment"> @Function Destroy</span>
  74. 00052 <span class="comment"> @Description Destroys the background. It's called by the destructor.</span>
  75. 00053 <span class="comment"> *****************************************************************************/</span>
  76. 00054 <span class="keywordtype">void</span> <a class="code" href="classCPVRTBackground.html#a2">Destroy</a>();
  77. 00055 <span class="comment">/*!***************************************************************************</span>
  78. 00056 <span class="comment"> @Function Init</span>
  79. 00057 <span class="comment"> @Input pContext A pointer to a PVRTContext</span>
  80. 00058 <span class="comment"> @Input bRotate true to rotate texture 90 degrees.</span>
  81. 00059 <span class="comment"> @Input pszError An option string for returning errors</span>
  82. 00060 <span class="comment"> @Return PVR_SUCCESS on success</span>
  83. 00061 <span class="comment"> @Description Initialises the background</span>
  84. 00062 <span class="comment"> *****************************************************************************/</span>
  85. 00063 <a class="code" href="PVRTError_8h.html#a5">EPVRTError</a> <a class="code" href="classCPVRTBackground.html#a3">Init</a>(<span class="keyword">const</span> <a class="code" href="structSPVRTContext.html">SPVRTContext</a> * <span class="keyword">const</span> pContext, <span class="keyword">const</span> <span class="keywordtype">bool</span> bRotate, <a class="code" href="classCPVRTString.html">CPVRTString</a> *pszError = 0);
  86. 00064
  87. 00065 <span class="preprocessor">#if defined(BUILD_OGL) || defined(BUILD_OGLES) || defined(BUILD_OGLES2)</span>
  88. 00066 <span class="preprocessor"></span> <span class="comment">/*!***************************************************************************</span>
  89. 00067 <span class="comment"> @Function Draw</span>
  90. 00068 <span class="comment"> @Input ui32Texture Texture to use</span>
  91. 00069 <span class="comment"> @Return PVR_SUCCESS on success</span>
  92. 00070 <span class="comment"> @Description Draws a texture on a quad covering the whole screen.</span>
  93. 00071 <span class="comment"> *****************************************************************************/</span>
  94. 00072 <a class="code" href="PVRTError_8h.html#a5">EPVRTError</a> Draw(<span class="keyword">const</span> GLuint ui32Texture);
  95. 00073 <span class="preprocessor">#elif defined(BUILD_DX10)</span>
  96. 00074 <span class="preprocessor"></span> <span class="comment">/*!***************************************************************************</span>
  97. 00075 <span class="comment"> @Function Draw</span>
  98. 00076 <span class="comment"> @Input pTexture Texture to use</span>
  99. 00077 <span class="comment"> @Return PVR_SUCCESS on success</span>
  100. 00078 <span class="comment"> @Description Draws a texture on a quad covering the whole screen.</span>
  101. 00079 <span class="comment"> *****************************************************************************/</span>
  102. 00080 <a class="code" href="PVRTError_8h.html#a5">EPVRTError</a> Draw(ID3D10ShaderResourceView *pTexture);
  103. 00081 <span class="preprocessor">#endif</span>
  104. 00082 <span class="preprocessor"></span>
  105. 00083 <span class="keyword">protected</span>:
  106. 00084 <span class="keywordtype">bool</span> <a class="code" href="classCPVRTBackground.html#p0">m_bInit</a>;
  107. 00085 <a class="code" href="structSPVRTBackgroundAPI.html">SPVRTBackgroundAPI</a> *<a class="code" href="classCPVRTBackground.html#p1">m_pAPI</a>;
  108. 00086 };
  109. 00087
  110. <a name="l00088"></a><a class="code" href="classCPVRTBackground.html#p0">00088</a>
  111. <a name="l00089"></a><a class="code" href="classCPVRTBackground.html#p1">00089</a> <span class="preprocessor">#endif </span><span class="comment">/* __PVRTBACKGROUND_H__ */</span>
  112. 00090
  113. 00091 <span class="comment">/*****************************************************************************</span>
  114. 00092 <span class="comment"> End of file (PVRTBackground.h)</span>
  115. 00093 <span class="comment">*****************************************************************************/</span>
  116. 00094
  117. </pre></div><br>
  118. <br>
  119. <P align=left><FONT size=2><STRONG><A
  120. href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
  121. 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
  122. <hr>
  123. <address style="align: left;"><small><FONT color=f0f>
  124. Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
  125. </body>
  126. </html>