PVRShell_8h.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649
  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>PVRShell.h File Reference</h1><code>#include &lt;stdlib.h&gt;</code><br>
  24. <p>
  25. Include dependency graph for PVRShell.h:<p><center><img src="PVRShell_8h__incl.png" border="0" usemap="#PVRShell.h_map" alt="Include dependency graph"></center>
  26. <p>
  27. This graph shows which files directly or indirectly include this file:<p><center><img src="PVRShell_8h__dep__incl.png" border="0" usemap="#PVRShell.hdep_map" alt="Included by dependency graph"></center>
  28. <map name="PVRShell.hdep_map">
  29. <area href="PVRShellAPI_8cpp.html" shape="rect" coords="7,7,132,34" alt="">
  30. <area href="PVRShellOS_8cpp.html" shape="rect" coords="156,7,279,34" alt="">
  31. <area href="PVRShell_8cpp.html" shape="rect" coords="303,7,407,34" alt="">
  32. </map>
  33. <p>
  34. <a href="PVRShell_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  35. <tr><td></td></tr>
  36. <tr><td colspan=2><br><h2>Classes</h2></td></tr>
  37. <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structSCmdLineOpt.html">SCmdLineOpt</a></td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores a variable name/value pair for an individual command-line option. </em> <a href="structSCmdLineOpt.html#_details">More...</a><em><br><br></td></tr>
  39. <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html">PVRShell</a></td></tr>
  40. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inherited by the application; responsible for abstracting the OS and API. </em> <a href="classPVRShell.html#_details">More...</a><em><br><br></td></tr>
  41. <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  42. <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a0">EXIT_NOERR_CODE</a>&nbsp;&nbsp;&nbsp;0</td></tr>
  43. <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a1">EXIT_ERR_CODE</a>&nbsp;&nbsp;&nbsp;(!EXIT_NOERR_CODE)</td></tr>
  44. <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a2">PVRSHELL_UNREFERENCED_PARAMETER</a>(x)&nbsp;&nbsp;&nbsp;((void) x)</td></tr>
  45. <tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
  46. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a72">PVRShellKeyName</a> { <br>
  47. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a72a3">PVRShellKeyNameNull</a>,
  48. <a class="el" href="PVRShell_8h.html#a72a4">PVRShellKeyNameQUIT</a>,
  49. <a class="el" href="PVRShell_8h.html#a72a5">PVRShellKeyNameSELECT</a>,
  50. <a class="el" href="PVRShell_8h.html#a72a6">PVRShellKeyNameACTION1</a>,
  51. <br>
  52. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a72a7">PVRShellKeyNameACTION2</a>,
  53. <a class="el" href="PVRShell_8h.html#a72a8">PVRShellKeyNameUP</a>,
  54. <a class="el" href="PVRShell_8h.html#a72a9">PVRShellKeyNameDOWN</a>,
  55. <a class="el" href="PVRShell_8h.html#a72a10">PVRShellKeyNameLEFT</a>,
  56. <br>
  57. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a72a11">PVRShellKeyNameRIGHT</a>,
  58. <a class="el" href="PVRShell_8h.html#a72a12">PVRShellKeyNameScreenshot</a>
  59. <br>
  60. }</td></tr>
  61. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a73">PVRShellKeyRotate</a> { <a class="el" href="PVRShell_8h.html#a73a13">PVRShellKeyRotateNone</a> = 0,
  62. <a class="el" href="PVRShell_8h.html#a73a14">PVRShellKeyRotate90</a>,
  63. <a class="el" href="PVRShell_8h.html#a73a15">PVRShellKeyRotate180</a>,
  64. <a class="el" href="PVRShell_8h.html#a73a16">PVRShellKeyRotate270</a>
  65. }</td></tr>
  66. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a74">EPVRShellButtonState</a> { <a class="el" href="PVRShell_8h.html#a74a17">ePVRShellButtonLeft</a> = 0x1,
  67. <a class="el" href="PVRShell_8h.html#a74a18">ePVRShellButtonRight</a> = 0x2,
  68. <a class="el" href="PVRShell_8h.html#a74a19">ePVRShellButtonMiddle</a> = 0x4
  69. }</td></tr>
  70. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a> { <br>
  71. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a75a20">prefFullScreen</a>,
  72. <a class="el" href="PVRShell_8h.html#a75a21">prefIsRotated</a>,
  73. <a class="el" href="PVRShell_8h.html#a75a22">prefPBufferContext</a>,
  74. <a class="el" href="PVRShell_8h.html#a75a23">prefPixmapContext</a>,
  75. <br>
  76. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a75a24">prefPixmapDisableCopy</a>,
  77. <a class="el" href="PVRShell_8h.html#a75a25">prefZbufferContext</a>,
  78. <a class="el" href="PVRShell_8h.html#a75a26">prefLockableBackBuffer</a>,
  79. <a class="el" href="PVRShell_8h.html#a75a27">prefSoftwareRendering</a>,
  80. <br>
  81. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a75a28">prefStencilBufferContext</a>,
  82. <a class="el" href="PVRShell_8h.html#a75a29">prefOpenVGContext</a>,
  83. <a class="el" href="PVRShell_8h.html#a75a30">prefAlphaFormatPre</a>,
  84. <a class="el" href="PVRShell_8h.html#a75a31">prefPowerSaving</a>,
  85. <br>
  86. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a75a32">prefOutputInfo</a>,
  87. <a class="el" href="PVRShell_8h.html#a75a33">prefNoShellSwapBuffer</a>
  88. <br>
  89. }</td></tr>
  90. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Boolean Shell preferences. <a href="#a75">More...</a><br><br></td></tr>
  91. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a> { <a class="el" href="PVRShell_8h.html#a76a34">prefQuitAfterTime</a>
  92. }</td></tr>
  93. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Float Shell preferences. <a href="#a76">More...</a><br><br></td></tr>
  94. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a> { <br>
  95. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a35">prefEGLMajorVersion</a>,
  96. <a class="el" href="PVRShell_8h.html#a77a36">prefEGLMinorVersion</a>,
  97. <a class="el" href="PVRShell_8h.html#a77a37">prefWidth</a>,
  98. <a class="el" href="PVRShell_8h.html#a77a38">prefHeight</a>,
  99. <br>
  100. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a39">prefPositionX</a>,
  101. <a class="el" href="PVRShell_8h.html#a77a40">prefPositionY</a>,
  102. <a class="el" href="PVRShell_8h.html#a77a41">prefQuitAfterFrame</a>,
  103. <a class="el" href="PVRShell_8h.html#a77a42">prefSwapInterval</a>,
  104. <br>
  105. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a43">prefInitRepeats</a>,
  106. <a class="el" href="PVRShell_8h.html#a77a44">prefFSAAMode</a>,
  107. <a class="el" href="PVRShell_8h.html#a77a45">prefCommandLineOptNum</a>,
  108. <a class="el" href="PVRShell_8h.html#a77a46">prefColorBPP</a>,
  109. <br>
  110. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a47">prefDepthBPP</a>,
  111. <a class="el" href="PVRShell_8h.html#a77a48">prefRotateKeys</a>,
  112. <a class="el" href="PVRShell_8h.html#a77a49">prefButtonState</a>,
  113. <a class="el" href="PVRShell_8h.html#a77a50">prefCaptureFrameStart</a>,
  114. <br>
  115. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a51">prefCaptureFrameStop</a>,
  116. <a class="el" href="PVRShell_8h.html#a77a52">prefPriority</a>,
  117. <a class="el" href="PVRShell_8h.html#a77a53">prefConfig</a>,
  118. <a class="el" href="PVRShell_8h.html#a77a54">prefRequestedConfig</a>,
  119. <br>
  120. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a77a55">prefNativeDisplay</a>
  121. <br>
  122. }</td></tr>
  123. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Integer Shell preferences. <a href="#a77">More...</a><br><br></td></tr>
  124. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a> { <br>
  125. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a78a56">prefD3DDevice</a>,
  126. <a class="el" href="PVRShell_8h.html#a78a57">prefEGLDisplay</a>,
  127. <a class="el" href="PVRShell_8h.html#a78a58">prefEGLSurface</a>,
  128. <a class="el" href="PVRShell_8h.html#a78a59">prefHINSTANCE</a>,
  129. <br>
  130. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a78a60">prefNativeWindowType</a>,
  131. <a class="el" href="PVRShell_8h.html#a78a61">prefAccelerometer</a>,
  132. <a class="el" href="PVRShell_8h.html#a78a62">prefPointerLocation</a>,
  133. <a class="el" href="PVRShell_8h.html#a78a63">prefPVR2DContext</a>
  134. <br>
  135. }</td></tr>
  136. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointers/Handlers Shell preferences. <a href="#a78">More...</a><br><br></td></tr>
  137. <tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a> { <br>
  138. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a79a64">prefAppName</a>,
  139. <a class="el" href="PVRShell_8h.html#a79a65">prefReadPath</a>,
  140. <a class="el" href="PVRShell_8h.html#a79a66">prefWritePath</a>,
  141. <a class="el" href="PVRShell_8h.html#a79a67">prefCommandLine</a>,
  142. <br>
  143. &nbsp;&nbsp;<a class="el" href="PVRShell_8h.html#a79a68">prefCommandLineOpts</a>,
  144. <a class="el" href="PVRShell_8h.html#a79a69">prefExitMessage</a>,
  145. <a class="el" href="PVRShell_8h.html#a79a70">prefVersion</a>
  146. <br>
  147. }</td></tr>
  148. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant pointers Shell preferences. <a href="#a79">More...</a><br><br></td></tr>
  149. <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  150. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classPVRShell.html">PVRShell</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="PVRShell_8h.html#a71">NewDemo</a> ()</td></tr>
  151. </table>
  152. <hr><h2>Define Documentation</h2>
  153. <a class="anchor" name="a1" doxytag="PVRShell.h::EXIT_ERR_CODE" ></a><p>
  154. <br><br><h3>EXIT_ERR_CODE</h3><br><div>
  155. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  156. <tr>
  157. <td class="mdRow">
  158. <table cellpadding="0" cellspacing="0" border="0">
  159. <tr>
  160. <td class="md" nowrap valign="top"> #define EXIT_ERR_CODE&nbsp;&nbsp;&nbsp;(!EXIT_NOERR_CODE)
  161. </table>
  162. </td>
  163. </tr>
  164. </table>
  165. <table cellspacing=5 cellpadding=0 border=0>
  166. <tr>
  167. <td>
  168. &nbsp;
  169. </td>
  170. <td>
  171. <p>
  172. </td>
  173. </tr>
  174. </table>
  175. <a class="anchor" name="a0" doxytag="PVRShell.h::EXIT_NOERR_CODE" ></a><p>
  176. <br><br><h3>EXIT_NOERR_CODE</h3><br><div>
  177. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  178. <tr>
  179. <td class="mdRow">
  180. <table cellpadding="0" cellspacing="0" border="0">
  181. <tr>
  182. <td class="md" nowrap valign="top"> #define EXIT_NOERR_CODE&nbsp;&nbsp;&nbsp;0
  183. </table>
  184. </td>
  185. </tr>
  186. </table>
  187. <table cellspacing=5 cellpadding=0 border=0>
  188. <tr>
  189. <td>
  190. &nbsp;
  191. </td>
  192. <td>
  193. <p>
  194. </td>
  195. </tr>
  196. </table>
  197. <a class="anchor" name="a2" doxytag="PVRShell.h::PVRSHELL_UNREFERENCED_PARAMETER" ></a><p>
  198. <br><br><h3>PVRSHELL_UNREFERENCED_PARAMETER</h3><br><div>
  199. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  200. <tr>
  201. <td class="mdRow">
  202. <table cellpadding="0" cellspacing="0" border="0">
  203. <tr>
  204. <td class="md" nowrap valign="top"> #define PVRSHELL_UNREFERENCED_PARAMETER</td>
  205. <td class="md" valign="top">(&nbsp;</td>
  206. <td class="md" nowrap valign="top">x&nbsp;</td>
  207. <td class="mdname1" valign="top" nowrap> </td>
  208. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  209. <td class="md" nowrap>&nbsp;&nbsp;&nbsp;((void) x)
  210. </table>
  211. </td>
  212. </tr>
  213. </table>
  214. <table cellspacing=5 cellpadding=0 border=0>
  215. <tr>
  216. <td>
  217. &nbsp;
  218. </td>
  219. <td>
  220. <p>
  221. </td>
  222. </tr>
  223. </table>
  224. <hr><h2>Enumeration Type Documentation</h2>
  225. <a class="anchor" name="a74" doxytag="PVRShell.h::EPVRShellButtonState" ></a><p>
  226. <br><br><h3>EPVRShellButtonState</h3><br><div>
  227. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  228. <tr>
  229. <td class="mdRow">
  230. <table cellpadding="0" cellspacing="0" border="0">
  231. <tr>
  232. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a74">EPVRShellButtonState</a>
  233. </table>
  234. </td>
  235. </tr>
  236. </table>
  237. <table cellspacing=5 cellpadding=0 border=0>
  238. <tr>
  239. <td>
  240. &nbsp;
  241. </td>
  242. <td>
  243. <p>
  244. Pointer button mapping. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  245. <table border=0 cellspacing=2 cellpadding=0>
  246. <tr><td valign=top><em><a class="anchor" name="a74a17" doxytag="ePVRShellButtonLeft" ></a>ePVRShellButtonLeft</em>&nbsp;</td><td>
  247. </td></tr>
  248. <tr><td valign=top><em><a class="anchor" name="a74a18" doxytag="ePVRShellButtonRight" ></a>ePVRShellButtonRight</em>&nbsp;</td><td>
  249. </td></tr>
  250. <tr><td valign=top><em><a class="anchor" name="a74a19" doxytag="ePVRShellButtonMiddle" ></a>ePVRShellButtonMiddle</em>&nbsp;</td><td>
  251. </td></tr>
  252. </table>
  253. </dl>
  254. </td>
  255. </tr>
  256. </table>
  257. <a class="anchor" name="a75" doxytag="PVRShell.h::prefNameBoolEnum" ></a><p>
  258. <br><br><h3>prefNameBoolEnum</h3><br><div>
  259. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  260. <tr>
  261. <td class="mdRow">
  262. <table cellpadding="0" cellspacing="0" border="0">
  263. <tr>
  264. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a>
  265. </table>
  266. </td>
  267. </tr>
  268. </table>
  269. <table cellspacing=5 cellpadding=0 border=0>
  270. <tr>
  271. <td>
  272. &nbsp;
  273. </td>
  274. <td>
  275. <p>
  276. Boolean Shell preferences.
  277. <p>
  278. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  279. <table border=0 cellspacing=2 cellpadding=0>
  280. <tr><td valign=top><em><a class="anchor" name="a75a20" doxytag="prefFullScreen" ></a>prefFullScreen</em>&nbsp;</td><td>
  281. Set to: 1 for full-screen rendering; 0 for windowed </td></tr>
  282. <tr><td valign=top><em><a class="anchor" name="a75a21" doxytag="prefIsRotated" ></a>prefIsRotated</em>&nbsp;</td><td>
  283. Query this to learn whether screen is rotated </td></tr>
  284. <tr><td valign=top><em><a class="anchor" name="a75a22" doxytag="prefPBufferContext" ></a>prefPBufferContext</em>&nbsp;</td><td>
  285. 1 if you need pbuffer support (default is pbuffer not needed) </td></tr>
  286. <tr><td valign=top><em><a class="anchor" name="a75a23" doxytag="prefPixmapContext" ></a>prefPixmapContext</em>&nbsp;</td><td>
  287. 1 to use a pixmap as a render-target (default off) </td></tr>
  288. <tr><td valign=top><em><a class="anchor" name="a75a24" doxytag="prefPixmapDisableCopy" ></a>prefPixmapDisableCopy</em>&nbsp;</td><td>
  289. 1 to disable the copy if pixmaps are used </td></tr>
  290. <tr><td valign=top><em><a class="anchor" name="a75a25" doxytag="prefZbufferContext" ></a>prefZbufferContext</em>&nbsp;</td><td>
  291. 1 if you wish to have zbuffer support (default to on) </td></tr>
  292. <tr><td valign=top><em><a class="anchor" name="a75a26" doxytag="prefLockableBackBuffer" ></a>prefLockableBackBuffer</em>&nbsp;</td><td>
  293. DX9 only: true to use D3DPRESENTFLAG_LOCKABLE_BACKBUFFER (default: false) </td></tr>
  294. <tr><td valign=top><em><a class="anchor" name="a75a27" doxytag="prefSoftwareRendering" ></a>prefSoftwareRendering</em>&nbsp;</td><td>
  295. 1 to select software rendering (default: off, i.e. use hardware) </td></tr>
  296. <tr><td valign=top><em><a class="anchor" name="a75a28" doxytag="prefStencilBufferContext" ></a>prefStencilBufferContext</em>&nbsp;</td><td>
  297. 1 if you wish to have stencil support (default: off) </td></tr>
  298. <tr><td valign=top><em><a class="anchor" name="a75a29" doxytag="prefOpenVGContext" ></a>prefOpenVGContext</em>&nbsp;</td><td>
  299. EGL only: 1 to initialize OpenVG instead of OpenGL ES (default: off) </td></tr>
  300. <tr><td valign=top><em><a class="anchor" name="a75a30" doxytag="prefAlphaFormatPre" ></a>prefAlphaFormatPre</em>&nbsp;</td><td>
  301. EGL only: 1 to create the EGL surface with EGL_ALPHA_FORMAT_PRE (default: 0) </td></tr>
  302. <tr><td valign=top><em><a class="anchor" name="a75a31" doxytag="prefPowerSaving" ></a>prefPowerSaving</em>&nbsp;</td><td>
  303. If true then the app will go into powersaving mode (if available) when not in use. </td></tr>
  304. <tr><td valign=top><em><a class="anchor" name="a75a32" doxytag="prefOutputInfo" ></a>prefOutputInfo</em>&nbsp;</td><td>
  305. If true then the app will output helpful information such as colour buffer format via PVRShellOutputDebug. </td></tr>
  306. <tr><td valign=top><em><a class="anchor" name="a75a33" doxytag="prefNoShellSwapBuffer" ></a>prefNoShellSwapBuffer</em>&nbsp;</td><td>
  307. EGL: If true then the shell won't call eglswapbuffers at the end of each frame. </td></tr>
  308. </table>
  309. </dl>
  310. </td>
  311. </tr>
  312. </table>
  313. <a class="anchor" name="a79" doxytag="PVRShell.h::prefNameConstPtrEnum" ></a><p>
  314. <br><br><h3>prefNameConstPtrEnum</h3><br><div>
  315. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  316. <tr>
  317. <td class="mdRow">
  318. <table cellpadding="0" cellspacing="0" border="0">
  319. <tr>
  320. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a>
  321. </table>
  322. </td>
  323. </tr>
  324. </table>
  325. <table cellspacing=5 cellpadding=0 border=0>
  326. <tr>
  327. <td>
  328. &nbsp;
  329. </td>
  330. <td>
  331. <p>
  332. Constant pointers Shell preferences.
  333. <p>
  334. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  335. <table border=0 cellspacing=2 cellpadding=0>
  336. <tr><td valign=top><em><a class="anchor" name="a79a64" doxytag="prefAppName" ></a>prefAppName</em>&nbsp;</td><td>
  337. ptrValue is char* </td></tr>
  338. <tr><td valign=top><em><a class="anchor" name="a79a65" doxytag="prefReadPath" ></a>prefReadPath</em>&nbsp;</td><td>
  339. ptrValue is char*; will include a trailing slash </td></tr>
  340. <tr><td valign=top><em><a class="anchor" name="a79a66" doxytag="prefWritePath" ></a>prefWritePath</em>&nbsp;</td><td>
  341. ptrValue is char*; will include a trailing slash </td></tr>
  342. <tr><td valign=top><em><a class="anchor" name="a79a67" doxytag="prefCommandLine" ></a>prefCommandLine</em>&nbsp;</td><td>
  343. used to retrieve the entire application command line </td></tr>
  344. <tr><td valign=top><em><a class="anchor" name="a79a68" doxytag="prefCommandLineOpts" ></a>prefCommandLineOpts</em>&nbsp;</td><td>
  345. ptrValue is SCmdLineOpt*; retrieves an array of arg/value pairs (parsed from the command line) </td></tr>
  346. <tr><td valign=top><em><a class="anchor" name="a79a69" doxytag="prefExitMessage" ></a>prefExitMessage</em>&nbsp;</td><td>
  347. ptrValue is char*; gives the shell a message to show on exit, typically an error </td></tr>
  348. <tr><td valign=top><em><a class="anchor" name="a79a70" doxytag="prefVersion" ></a>prefVersion</em>&nbsp;</td><td>
  349. ptrValue is char* </td></tr>
  350. </table>
  351. </dl>
  352. </td>
  353. </tr>
  354. </table>
  355. <a class="anchor" name="a76" doxytag="PVRShell.h::prefNameFloatEnum" ></a><p>
  356. <br><br><h3>prefNameFloatEnum</h3><br><div>
  357. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  358. <tr>
  359. <td class="mdRow">
  360. <table cellpadding="0" cellspacing="0" border="0">
  361. <tr>
  362. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a>
  363. </table>
  364. </td>
  365. </tr>
  366. </table>
  367. <table cellspacing=5 cellpadding=0 border=0>
  368. <tr>
  369. <td>
  370. &nbsp;
  371. </td>
  372. <td>
  373. <p>
  374. Float Shell preferences.
  375. <p>
  376. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  377. <table border=0 cellspacing=2 cellpadding=0>
  378. <tr><td valign=top><em><a class="anchor" name="a76a34" doxytag="prefQuitAfterTime" ></a>prefQuitAfterTime</em>&nbsp;</td><td>
  379. Shell will quit after this number of seconds (-1 to disable) </td></tr>
  380. </table>
  381. </dl>
  382. </td>
  383. </tr>
  384. </table>
  385. <a class="anchor" name="a77" doxytag="PVRShell.h::prefNameIntEnum" ></a><p>
  386. <br><br><h3>prefNameIntEnum</h3><br><div>
  387. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  388. <tr>
  389. <td class="mdRow">
  390. <table cellpadding="0" cellspacing="0" border="0">
  391. <tr>
  392. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a>
  393. </table>
  394. </td>
  395. </tr>
  396. </table>
  397. <table cellspacing=5 cellpadding=0 border=0>
  398. <tr>
  399. <td>
  400. &nbsp;
  401. </td>
  402. <td>
  403. <p>
  404. Integer Shell preferences.
  405. <p>
  406. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  407. <table border=0 cellspacing=2 cellpadding=0>
  408. <tr><td valign=top><em><a class="anchor" name="a77a35" doxytag="prefEGLMajorVersion" ></a>prefEGLMajorVersion</em>&nbsp;</td><td>
  409. EGL: returns the major version as returned by eglInitialize() </td></tr>
  410. <tr><td valign=top><em><a class="anchor" name="a77a36" doxytag="prefEGLMinorVersion" ></a>prefEGLMinorVersion</em>&nbsp;</td><td>
  411. EGL: returns the minor version as returned by eglInitialize() </td></tr>
  412. <tr><td valign=top><em><a class="anchor" name="a77a37" doxytag="prefWidth" ></a>prefWidth</em>&nbsp;</td><td>
  413. Width of render target </td></tr>
  414. <tr><td valign=top><em><a class="anchor" name="a77a38" doxytag="prefHeight" ></a>prefHeight</em>&nbsp;</td><td>
  415. Height of render target </td></tr>
  416. <tr><td valign=top><em><a class="anchor" name="a77a39" doxytag="prefPositionX" ></a>prefPositionX</em>&nbsp;</td><td>
  417. X position of the window </td></tr>
  418. <tr><td valign=top><em><a class="anchor" name="a77a40" doxytag="prefPositionY" ></a>prefPositionY</em>&nbsp;</td><td>
  419. Y position of the window </td></tr>
  420. <tr><td valign=top><em><a class="anchor" name="a77a41" doxytag="prefQuitAfterFrame" ></a>prefQuitAfterFrame</em>&nbsp;</td><td>
  421. Shell will quit after this number of frames (-1 to disable) </td></tr>
  422. <tr><td valign=top><em><a class="anchor" name="a77a42" doxytag="prefSwapInterval" ></a>prefSwapInterval</em>&nbsp;</td><td>
  423. 0 to preventing waiting for monitor vertical syncs </td></tr>
  424. <tr><td valign=top><em><a class="anchor" name="a77a43" doxytag="prefInitRepeats" ></a>prefInitRepeats</em>&nbsp;</td><td>
  425. Number of times to reinitialise (if &gt;0 when app returns false from RenderScene(), shell will ReleaseView(), InitView() then re-enter RenderScene() loop). Decrements on each initialisation. </td></tr>
  426. <tr><td valign=top><em><a class="anchor" name="a77a44" doxytag="prefFSAAMode" ></a>prefFSAAMode</em>&nbsp;</td><td>
  427. Set to: 0 to disable full-screen anti-aliasing; 1 for 2x; 2 for 4x. </td></tr>
  428. <tr><td valign=top><em><a class="anchor" name="a77a45" doxytag="prefCommandLineOptNum" ></a>prefCommandLineOptNum</em>&nbsp;</td><td>
  429. Returns the length of the array returned by prefCommandLineOpts </td></tr>
  430. <tr><td valign=top><em><a class="anchor" name="a77a46" doxytag="prefColorBPP" ></a>prefColorBPP</em>&nbsp;</td><td>
  431. Allows you to specify a desired color buffer size e.g. 16, 32. </td></tr>
  432. <tr><td valign=top><em><a class="anchor" name="a77a47" doxytag="prefDepthBPP" ></a>prefDepthBPP</em>&nbsp;</td><td>
  433. Allows you to specify a desired depth buffer size e.g. 16, 24. </td></tr>
  434. <tr><td valign=top><em><a class="anchor" name="a77a48" doxytag="prefRotateKeys" ></a>prefRotateKeys</em>&nbsp;</td><td>
  435. Allows you to specify and retrieve how the keyboard input is transformed </td></tr>
  436. <tr><td valign=top><em><a class="anchor" name="a77a49" doxytag="prefButtonState" ></a>prefButtonState</em>&nbsp;</td><td>
  437. pointer button state </td></tr>
  438. <tr><td valign=top><em><a class="anchor" name="a77a50" doxytag="prefCaptureFrameStart" ></a>prefCaptureFrameStart</em>&nbsp;</td><td>
  439. The frame to start capturing screenshots from </td></tr>
  440. <tr><td valign=top><em><a class="anchor" name="a77a51" doxytag="prefCaptureFrameStop" ></a>prefCaptureFrameStop</em>&nbsp;</td><td>
  441. The frame to stop capturing screenshots at </td></tr>
  442. <tr><td valign=top><em><a class="anchor" name="a77a52" doxytag="prefPriority" ></a>prefPriority</em>&nbsp;</td><td>
  443. EGL: If supported will set the egl context priority; 0 for low, 1 for med and 2 for high. </td></tr>
  444. <tr><td valign=top><em><a class="anchor" name="a77a53" doxytag="prefConfig" ></a>prefConfig</em>&nbsp;</td><td>
  445. EGL: Get the chosen EGL config. </td></tr>
  446. <tr><td valign=top><em><a class="anchor" name="a77a54" doxytag="prefRequestedConfig" ></a>prefRequestedConfig</em>&nbsp;</td><td>
  447. EGL: Force the shell to use a particular EGL config. </td></tr>
  448. <tr><td valign=top><em><a class="anchor" name="a77a55" doxytag="prefNativeDisplay" ></a>prefNativeDisplay</em>&nbsp;</td><td>
  449. EGL: Allows you to specify the native display to use if the device has more that one. </td></tr>
  450. </table>
  451. </dl>
  452. </td>
  453. </tr>
  454. </table>
  455. <a class="anchor" name="a78" doxytag="PVRShell.h::prefNamePtrEnum" ></a><p>
  456. <br><br><h3>prefNamePtrEnum</h3><br><div>
  457. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  458. <tr>
  459. <td class="mdRow">
  460. <table cellpadding="0" cellspacing="0" border="0">
  461. <tr>
  462. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a>
  463. </table>
  464. </td>
  465. </tr>
  466. </table>
  467. <table cellspacing=5 cellpadding=0 border=0>
  468. <tr>
  469. <td>
  470. &nbsp;
  471. </td>
  472. <td>
  473. <p>
  474. Pointers/Handlers Shell preferences.
  475. <p>
  476. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  477. <table border=0 cellspacing=2 cellpadding=0>
  478. <tr><td valign=top><em><a class="anchor" name="a78a56" doxytag="prefD3DDevice" ></a>prefD3DDevice</em>&nbsp;</td><td>
  479. D3D: returns the device pointer </td></tr>
  480. <tr><td valign=top><em><a class="anchor" name="a78a57" doxytag="prefEGLDisplay" ></a>prefEGLDisplay</em>&nbsp;</td><td>
  481. EGL: returns the EGLDisplay </td></tr>
  482. <tr><td valign=top><em><a class="anchor" name="a78a58" doxytag="prefEGLSurface" ></a>prefEGLSurface</em>&nbsp;</td><td>
  483. EGL: returns the EGLSurface </td></tr>
  484. <tr><td valign=top><em><a class="anchor" name="a78a59" doxytag="prefHINSTANCE" ></a>prefHINSTANCE</em>&nbsp;</td><td>
  485. Windows: returns the application instance handle </td></tr>
  486. <tr><td valign=top><em><a class="anchor" name="a78a60" doxytag="prefNativeWindowType" ></a>prefNativeWindowType</em>&nbsp;</td><td>
  487. Returns the window handle </td></tr>
  488. <tr><td valign=top><em><a class="anchor" name="a78a61" doxytag="prefAccelerometer" ></a>prefAccelerometer</em>&nbsp;</td><td>
  489. Accelerometer values </td></tr>
  490. <tr><td valign=top><em><a class="anchor" name="a78a62" doxytag="prefPointerLocation" ></a>prefPointerLocation</em>&nbsp;</td><td>
  491. Mouse pointer/touch location values </td></tr>
  492. <tr><td valign=top><em><a class="anchor" name="a78a63" doxytag="prefPVR2DContext" ></a>prefPVR2DContext</em>&nbsp;</td><td>
  493. PVR2D: returns the PVR2D context </td></tr>
  494. </table>
  495. </dl>
  496. </td>
  497. </tr>
  498. </table>
  499. <a class="anchor" name="a72" doxytag="PVRShell.h::PVRShellKeyName" ></a><p>
  500. <br><br><h3>PVRShellKeyName</h3><br><div>
  501. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  502. <tr>
  503. <td class="mdRow">
  504. <table cellpadding="0" cellspacing="0" border="0">
  505. <tr>
  506. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a72">PVRShellKeyName</a>
  507. </table>
  508. </td>
  509. </tr>
  510. </table>
  511. <table cellspacing=5 cellpadding=0 border=0>
  512. <tr>
  513. <td>
  514. &nbsp;
  515. </td>
  516. <td>
  517. <p>
  518. Keyboard mapping. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  519. <table border=0 cellspacing=2 cellpadding=0>
  520. <tr><td valign=top><em><a class="anchor" name="a72a3" doxytag="PVRShellKeyNameNull" ></a>PVRShellKeyNameNull</em>&nbsp;</td><td>
  521. </td></tr>
  522. <tr><td valign=top><em><a class="anchor" name="a72a4" doxytag="PVRShellKeyNameQUIT" ></a>PVRShellKeyNameQUIT</em>&nbsp;</td><td>
  523. </td></tr>
  524. <tr><td valign=top><em><a class="anchor" name="a72a5" doxytag="PVRShellKeyNameSELECT" ></a>PVRShellKeyNameSELECT</em>&nbsp;</td><td>
  525. </td></tr>
  526. <tr><td valign=top><em><a class="anchor" name="a72a6" doxytag="PVRShellKeyNameACTION1" ></a>PVRShellKeyNameACTION1</em>&nbsp;</td><td>
  527. </td></tr>
  528. <tr><td valign=top><em><a class="anchor" name="a72a7" doxytag="PVRShellKeyNameACTION2" ></a>PVRShellKeyNameACTION2</em>&nbsp;</td><td>
  529. </td></tr>
  530. <tr><td valign=top><em><a class="anchor" name="a72a8" doxytag="PVRShellKeyNameUP" ></a>PVRShellKeyNameUP</em>&nbsp;</td><td>
  531. </td></tr>
  532. <tr><td valign=top><em><a class="anchor" name="a72a9" doxytag="PVRShellKeyNameDOWN" ></a>PVRShellKeyNameDOWN</em>&nbsp;</td><td>
  533. </td></tr>
  534. <tr><td valign=top><em><a class="anchor" name="a72a10" doxytag="PVRShellKeyNameLEFT" ></a>PVRShellKeyNameLEFT</em>&nbsp;</td><td>
  535. </td></tr>
  536. <tr><td valign=top><em><a class="anchor" name="a72a11" doxytag="PVRShellKeyNameRIGHT" ></a>PVRShellKeyNameRIGHT</em>&nbsp;</td><td>
  537. </td></tr>
  538. <tr><td valign=top><em><a class="anchor" name="a72a12" doxytag="PVRShellKeyNameScreenshot" ></a>PVRShellKeyNameScreenshot</em>&nbsp;</td><td>
  539. </td></tr>
  540. </table>
  541. </dl>
  542. </td>
  543. </tr>
  544. </table>
  545. <a class="anchor" name="a73" doxytag="PVRShell.h::PVRShellKeyRotate" ></a><p>
  546. <br><br><h3>PVRShellKeyRotate</h3><br><div>
  547. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  548. <tr>
  549. <td class="mdRow">
  550. <table cellpadding="0" cellspacing="0" border="0">
  551. <tr>
  552. <td class="md" nowrap valign="top"> enum <a class="el" href="PVRShell_8h.html#a73">PVRShellKeyRotate</a>
  553. </table>
  554. </td>
  555. </tr>
  556. </table>
  557. <table cellspacing=5 cellpadding=0 border=0>
  558. <tr>
  559. <td>
  560. &nbsp;
  561. </td>
  562. <td>
  563. <p>
  564. <dl compact><dt><b>Enumeration values: </b></dt><dd>
  565. <table border=0 cellspacing=2 cellpadding=0>
  566. <tr><td valign=top><em><a class="anchor" name="a73a13" doxytag="PVRShellKeyRotateNone" ></a>PVRShellKeyRotateNone</em>&nbsp;</td><td>
  567. </td></tr>
  568. <tr><td valign=top><em><a class="anchor" name="a73a14" doxytag="PVRShellKeyRotate90" ></a>PVRShellKeyRotate90</em>&nbsp;</td><td>
  569. </td></tr>
  570. <tr><td valign=top><em><a class="anchor" name="a73a15" doxytag="PVRShellKeyRotate180" ></a>PVRShellKeyRotate180</em>&nbsp;</td><td>
  571. </td></tr>
  572. <tr><td valign=top><em><a class="anchor" name="a73a16" doxytag="PVRShellKeyRotate270" ></a>PVRShellKeyRotate270</em>&nbsp;</td><td>
  573. </td></tr>
  574. </table>
  575. </dl>
  576. </td>
  577. </tr>
  578. </table>
  579. <hr><h2>Function Documentation</h2>
  580. <a class="anchor" name="a71" doxytag="PVRShell.h::NewDemo" ></a><p>
  581. <br><br><h3>NewDemo</h3><br><div>
  582. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  583. <tr>
  584. <td class="mdRow">
  585. <table cellpadding="0" cellspacing="0" border="0">
  586. <tr>
  587. <td class="md" nowrap valign="top"> <a class="el" href="classPVRShell.html">PVRShell</a>* NewDemo </td>
  588. <td class="md" valign="top">(&nbsp;</td>
  589. <td class="mdname1" valign="top" nowrap> </td>
  590. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  591. <td class="md" nowrap></td>
  592. </tr>
  593. </table>
  594. </td>
  595. </tr>
  596. </table>
  597. <table cellspacing=5 cellpadding=0 border=0>
  598. <tr>
  599. <td>
  600. &nbsp;
  601. </td>
  602. <td>
  603. <p>
  604. <dl compact><dt><b>Returns:</b></dt><dd>The demo supplied by the user </dd></dl>
  605. <dl compact><dt><b>Description:</b></dt><dd>This function must be implemented by the user of the shell. The user should return its <a class="el" href="classPVRShell.html">PVRShell</a> object defining the behaviour of the application </dd></dl>
  606. </td>
  607. </tr>
  608. </table>
  609. <br>
  610. <br>
  611. <P align=left><FONT size=2><STRONG><A
  612. href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
  613. 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
  614. <hr>
  615. <address style="align: left;"><small><FONT color=f0f>
  616. Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
  617. </body>
  618. </html>