12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
- <title>PowerVR SDK</title>
- <link href="doxygen.css" rel="stylesheet" type="text/css">
- <link href="tabs.css" rel="stylesheet" type="text/css">
- <table width="100%">
- <tr>
- <td width="33%">
- <p align="left"> <a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
- </td>
- <td width="33%">
- <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
- </td>
- <td width="34%">
- <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
- </td>
- </tr>
- </table>
- <hr>
- </head><body>
- <!-- Generated by Doxygen 1.3.6 -->
- <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
- <h1>PVRShell Class Reference</h1>Inherited by the application; responsible for abstracting the OS and API.
- <a href="#_details">More...</a>
- <p>
- <code>#include <<a class="el" href="PVRShell_8h-source.html">PVRShell.h</a>></code>
- <p>
- Collaboration diagram for PVRShell:<p><center><img src="classPVRShell__coll__graph.png" border="0" usemap="#PVRShell__coll__map" alt="Collaboration graph"></center>
- <map name="PVRShell__coll__map">
- <area href="classPVRShellInit.html" shape="rect" coords="199,369,297,396" alt="">
- <area href="classPVRShellGLWidget.html" shape="rect" coords="253,188,392,215" alt="">
- <area href="structPVRShellData.html" shape="rect" coords="269,7,376,33" alt="">
- <area href="classPVRShellMainWindow.html" shape="rect" coords="87,460,244,487" alt="">
- <area href="classPVRShellInitAPI.html" shape="rect" coords="253,279,373,305" alt="">
- <area href="classPVRShellInitOS.html" shape="rect" coords="169,551,287,577" alt="">
- <area href="classPVRShellCommandLine.html" shape="rect" coords="7,279,172,305" alt="">
- <area href="structSCmdLineOpt.html" shape="rect" coords="36,188,143,215" alt="">
- </map>
- <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classPVRShell-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
- <tr><td></td></tr>
- <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a0">PVRShell</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a1">~PVRShell</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a2">InitApplication</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a3">QuitApplication</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a4">InitView</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a5">ReleaseView</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a6">RenderScene</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a7">PVRShellSet</a> (const <a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a> prefName, const bool value)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a8">PVRShellSet</a> (const <a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a> prefName, const float value)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a9">PVRShellSet</a> (const <a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a> prefName, const int value)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a10">PVRShellSet</a> (const <a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a> prefName, const void *const ptrValue)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a11">PVRShellSet</a> (const <a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a> prefName, const void *const ptrValue)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a12">PVRShellGet</a> (const <a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a> prefName) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a13">PVRShellGet</a> (const <a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a> prefName) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a14">PVRShellGet</a> (const <a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a> prefName) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a15">PVRShellGet</a> (const <a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a> prefName) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>const void * </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a16">PVRShellGet</a> (const <a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a> prefName) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a17">PVRShellScreenCaptureBuffer</a> (const int Width, const int Height, unsigned char **pLines)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a18">PVRShellScreenSave</a> (const char *const fname, const unsigned char *const pLines, char *const ofname=NULL)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a19">PVRShellWriteBMPFile</a> (const char *const pszFilename, const unsigned long uWidth, const unsigned long uHeight, const void *const pImageData)</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a20">PVRShellOutputDebug</a> (char const *const format,...) const </td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a21">PVRShellGetTime</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#a22">PVRShellIsKeyPressed</a> (const <a class="el" href="PVRShell_8h.html#a72">PVRShellKeyName</a> key)</td></tr>
- <tr><td colspan=2><br><h2>Friends</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#n0">PVRShellInitOS</a></td></tr>
- <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classPVRShell.html#n1">PVRShellInit</a></td></tr>
- </table>
- <hr><a name="_details"></a><h2>Detailed Description</h2>
- Inherited by the application; responsible for abstracting the OS and API.
- <p>
- <dl compact><dt><b>Description:</b></dt><dd></dd></dl>
- PVRShell is the main Shell class that an application uses. An application should supply a class which inherits PVRShell and supplies implementations of the virtual functions of PVRShell (<a class="el" href="classPVRShell.html#a2">InitApplication()</a>, <a class="el" href="classPVRShell.html#a3">QuitApplication()</a>, <a class="el" href="classPVRShell.html#a4">InitView()</a>, <a class="el" href="classPVRShell.html#a5">ReleaseView()</a>, <a class="el" href="classPVRShell.html#a6">RenderScene()</a>). Default stub functions are supplied; this means that an application is not required to supply a particular function if it does not need to do anything in it. The other, non-virtual, functions of PVRShell are utility functions that the application may call.
- <p>
- <hr><h2>Constructor & Destructor Documentation</h2>
- <a class="anchor" name="a0" doxytag="PVRShell::PVRShell" ></a><p>
- <br><br><h3>PVRShell</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> PVRShell::PVRShell </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Description:</b></dt><dd>Constructor </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a1" doxytag="PVRShell::~PVRShell" ></a><p>
- <br><br><h3>~PVRShell</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> PVRShell::~<a class="el" href="classPVRShell.html">PVRShell</a> </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Description:</b></dt><dd>Destructor </dd></dl>
- </td>
- </tr>
- </table>
- <hr><h2>Member Function Documentation</h2>
- <a class="anchor" name="a2" doxytag="PVRShell::InitApplication" ></a><p>
- <br><br><h3>InitApplication</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> virtual bool PVRShell::InitApplication </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success, false to exit the application </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function can be overloaded by the application. It will be called by PVRShell once only at the beginning of the PVRShell WinMain()/main() function. This function enables the user to perform any initialisation before the render API is initialised. From this function the user can call <a class="el" href="classPVRShell.html#a7">PVRShellSet()</a> to change default values, e.g. requesting a particular resolution or device setting. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a4" doxytag="PVRShell::InitView" ></a><p>
- <br><br><h3>InitView</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> virtual bool PVRShell::InitView </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success, false to exit the application </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function can be overloaded by the application. It will be called by PVRShell after the OS and rendering API are initialised, before entering the <a class="el" href="classPVRShell.html#a6">RenderScene()</a> loop. It is called any time the rendering API is initialised, i.e. once at the beginning, and possibly again if the resolution changes, or a power management even occurs, or if the app requests a reinialisation. The application should check here the configuration of the rendering API; it is possible that requests made in <a class="el" href="classPVRShell.html#a2">InitApplication()</a> were not successful. Since everything is initialised when this function is called, you can load textures and perform rendering API functions. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a16" doxytag="PVRShell::PVRShellGet" ></a><p>
- <br><br><h3>PVRShellGet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> const void * PVRShell::PVRShellGet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>prefName</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>Value asked for. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to get parameters from the PVRShell It can be called from any where in the program. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a15" doxytag="PVRShell::PVRShellGet" ></a><p>
- <br><br><h3>PVRShellGet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> void * PVRShell::PVRShellGet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>prefName</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>Value asked for. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to get parameters from the PVRShell It can be called from any where in the program. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a14" doxytag="PVRShell::PVRShellGet" ></a><p>
- <br><br><h3>PVRShellGet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> int PVRShell::PVRShellGet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>prefName</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>Value asked for. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to get parameters from the PVRShell It can be called from any where in the program. </dd></dl>
- </td>
- </tr>
- </table>
- <p>
- Here is the call graph for this function:<p><center><img src="classPVRShell_a14_cgraph.png" border="0" usemap="#classPVRShell_a14_cgraph_map" alt=""></center>
- <map name="classPVRShell_a14_cgraph_map">
- <area href="classPVRShellInit.html#a37" shape="rect" coords="223,7,369,33" alt="">
- <area href="classPVRShellInit.html#a27" shape="rect" coords="224,57,368,84" alt="">
- <area href="classPVRShellMainWindow.html#a7" shape="rect" coords="417,32,687,59" alt="">
- <area href="classPVRShellMainWindow.html#a6" shape="rect" coords="440,83,664,109" alt="">
- </map>
- <a class="anchor" name="a13" doxytag="PVRShell::PVRShellGet" ></a><p>
- <br><br><h3>PVRShellGet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> float PVRShell::PVRShellGet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>prefName</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>Value asked for. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to get parameters from the PVRShell It can be called from any where in the program. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a12" doxytag="PVRShell::PVRShellGet" ></a><p>
- <br><br><h3>PVRShellGet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellGet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>prefName</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>Value asked for. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to get parameters from the PVRShell It can be called from any where in the program. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a21" doxytag="PVRShell::PVRShellGetTime" ></a><p>
- <br><br><h3>PVRShellGetTime</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> unsigned long PVRShell::PVRShellGetTime </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>A value which increments once per millisecond. </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>The number itself should be considered meaningless; an application should use this function to determine how much time has passed between two points (e.g. between each frame). </dd></dl>
- </td>
- </tr>
- </table>
- <p>
- Here is the call graph for this function:<p><center><img src="classPVRShell_a21_cgraph.png" border="0" usemap="#classPVRShell_a21_cgraph_map" alt=""></center>
- <map name="classPVRShell_a21_cgraph_map">
- <area href="classPVRShellInit.html#a6" shape="rect" coords="253,7,456,33" alt="">
- </map>
- <a class="anchor" name="a22" doxytag="PVRShell::PVRShellIsKeyPressed" ></a><p>
- <br><br><h3>PVRShellIsKeyPressed</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellIsKeyPressed </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a72">PVRShellKeyName</a> </td>
- <td class="mdname1" valign="top" nowrap> <em>key</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>key</em> </td><td>Code of the key to test </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true if key was pressed </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>Check if a key was pressed. The keys on various devices are mapped to the PVRShell-supported keys (listed in <em>PVRShellKeyName</em>) in a platform-dependent manner, since most platforms have different input devices. Check the SDK release notes for details on how the enum values map to your device's input device. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a20" doxytag="PVRShell::PVRShellOutputDebug" ></a><p>
- <br><br><h3>PVRShellOutputDebug</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> void PVRShell::PVRShellOutputDebug </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">char const *const </td>
- <td class="mdname" nowrap> <em>format</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>... </td>
- <td class="mdname" nowrap></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"> const</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>format</em> </td><td>printf style format followed by arguments it requires </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Description:</b></dt><dd>Writes the resultant string to the debug output (e.g. using printf(), OutputDebugString(), ...). Check the SDK release notes for details on how the string is output. </dd></dl>
- </td>
- </tr>
- </table>
- <p>
- Here is the call graph for this function:<p><center><img src="classPVRShell_a20_cgraph.png" border="0" usemap="#classPVRShell_a20_cgraph_map" alt=""></center>
- <map name="classPVRShell_a20_cgraph_map">
- <area href="classPVRShellInit.html#a30" shape="rect" coords="280,7,520,33" alt="">
- </map>
- <a class="anchor" name="a17" doxytag="PVRShell::PVRShellScreenCaptureBuffer" ></a><p>
- <br><br><h3>PVRShellScreenCaptureBuffer</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellScreenCaptureBuffer </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const int </td>
- <td class="mdname" nowrap> <em>Width</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const int </td>
- <td class="mdname" nowrap> <em>Height</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>unsigned char ** </td>
- <td class="mdname" nowrap> <em>pLines</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>Width</em> </td><td>size of image to capture (relative to 0,0) </td></tr>
- <tr><td valign=top><em>Height</em> </td><td>size of image to capture (relative to 0,0) </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Modified:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>pLines</em> </td><td>receives a pointer to an area of memory containing the screen buffer. </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>It will be stored as 24-bit per pixel, 8-bit per chanel RGB. The memory should be freed with free() when no longer needed. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a18" doxytag="PVRShell::PVRShellScreenSave" ></a><p>
- <br><br><h3>PVRShellScreenSave</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> int PVRShell::PVRShellScreenSave </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const char *const </td>
- <td class="mdname" nowrap> <em>fname</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const unsigned char *const </td>
- <td class="mdname" nowrap> <em>pLines</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>char *const </td>
- <td class="mdname" nowrap> <em>ofname</em> = NULL</td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>fname</em> </td><td>base of file to save screen to </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Modified:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>pLines</em> </td><td>image data to write out (24bpp, 8-bit per channel RGB) </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Outputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>ofname</em> </td><td>If non-NULL, receives the filename actually used </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>Writes out the image data to a BMP file with basename fname. The file written will be fname suffixed with a number to make the file unique. For example, if fname is "abc", this function will attempt to save to "abc0000.bmp"; if that file already exists, it will try "abc0001.bmp", repeating until a new filename is found. The final filename used is returned in ofname. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a11" doxytag="PVRShell::PVRShellSet" ></a><p>
- <br><br><h3>PVRShellSet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellSet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a79">prefNameConstPtrEnum</a> </td>
- <td class="mdname" nowrap> <em>prefName</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const void *const </td>
- <td class="mdname" nowrap> <em>ptrValue</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- <tr><td valign=top><em>ptrValue</em> </td><td>Value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to pass preferences to the PVRShell. If used, it must be called from <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a10" doxytag="PVRShell::PVRShellSet" ></a><p>
- <br><br><h3>PVRShellSet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellSet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a78">prefNamePtrEnum</a> </td>
- <td class="mdname" nowrap> <em>prefName</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const void *const </td>
- <td class="mdname" nowrap> <em>ptrValue</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- <tr><td valign=top><em>ptrValue</em> </td><td>Value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to pass preferences to the PVRShell. If used, it must be called from <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <p>
- Here is the call graph for this function:<p><center><img src="classPVRShell_a10_cgraph.png" border="0" usemap="#classPVRShell_a10_cgraph_map" alt=""></center>
- <map name="classPVRShell_a10_cgraph_map">
- <area href="classPVRShellInit.html#a37" shape="rect" coords="277,7,424,34" alt="">
- <area href="classPVRShellInit.html#a26" shape="rect" coords="221,58,480,84" alt="">
- </map>
- <a class="anchor" name="a9" doxytag="PVRShell::PVRShellSet" ></a><p>
- <br><br><h3>PVRShellSet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellSet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a77">prefNameIntEnum</a> </td>
- <td class="mdname" nowrap> <em>prefName</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const int </td>
- <td class="mdname" nowrap> <em>value</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- <tr><td valign=top><em>value</em> </td><td>Value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to pass preferences to the PVRShell. If used, it must be called from <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a8" doxytag="PVRShell::PVRShellSet" ></a><p>
- <br><br><h3>PVRShellSet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellSet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a76">prefNameFloatEnum</a> </td>
- <td class="mdname" nowrap> <em>prefName</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const float </td>
- <td class="mdname" nowrap> <em>value</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- <tr><td valign=top><em>value</em> </td><td>Value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to pass preferences to the PVRShell. If used, it must be called from <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a7" doxytag="PVRShell::PVRShellSet" ></a><p>
- <br><br><h3>PVRShellSet</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> bool PVRShell::PVRShellSet </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="PVRShell_8h.html#a75">prefNameBoolEnum</a> </td>
- <td class="mdname" nowrap> <em>prefName</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const bool </td>
- <td class="mdname" nowrap> <em>value</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>prefName</em> </td><td>Name of preference to set to value </td></tr>
- <tr><td valign=top><em>value</em> </td><td>Value </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function is used to pass preferences to the PVRShell. If used, it must be called from <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a19" doxytag="PVRShell::PVRShellWriteBMPFile" ></a><p>
- <br><br><h3>PVRShellWriteBMPFile</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> int PVRShell::PVRShellWriteBMPFile </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const char *const </td>
- <td class="mdname" nowrap> <em>pszFilename</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const unsigned long </td>
- <td class="mdname" nowrap> <em>uWidth</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const unsigned long </td>
- <td class="mdname" nowrap> <em>uHeight</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td></td>
- <td class="md" nowrap>const void *const </td>
- <td class="mdname" nowrap> <em>pImageData</em></td>
- </tr>
- <tr>
- <td></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Inputs:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign=top><em>pszFilename</em> </td><td>file to save screen to </td></tr>
- <tr><td valign=top><em>uWidth</em> </td><td>the width of the data </td></tr>
- <tr><td valign=top><em>uHeight</em> </td><td>the height of the data </td></tr>
- <tr><td valign=top><em>pImageData</em> </td><td>image data to write out (24bpp, 8-bit per channel RGB) </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>0 on success </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>Writes out the image data to a BMP file with name fname. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a3" doxytag="PVRShell::QuitApplication" ></a><p>
- <br><br><h3>QuitApplication</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> virtual bool PVRShell::QuitApplication </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success, false to exit the application </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function can be overloaded by the application. It will be called by PVRShell just before finishing the program. It enables the application to release any memory/resources acquired in <a class="el" href="classPVRShell.html#a2">InitApplication()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a5" doxytag="PVRShell::ReleaseView" ></a><p>
- <br><br><h3>ReleaseView</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> virtual bool PVRShell::ReleaseView </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success, false to exit the application </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function can be overloaded by the application. It will be called after the <a class="el" href="classPVRShell.html#a6">RenderScene()</a> loop, before shutting down the render API. It enables the application to release any memory/resources acquired in <a class="el" href="classPVRShell.html#a4">InitView()</a>. </dd></dl>
- </td>
- </tr>
- </table>
- <a class="anchor" name="a6" doxytag="PVRShell::RenderScene" ></a><p>
- <br><br><h3>RenderScene</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> virtual bool PVRShell::RenderScene </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>true for success, false to exit the application </dd></dl>
- <dl compact><dt><b>Description:</b></dt><dd>This function can be overloaded by the application. It is main application function in which you have to do your own rendering. Will be called repeatedly until the application exits. </dd></dl>
- </td>
- </tr>
- </table>
- <hr><h2>Friends And Related Function Documentation</h2>
- <a class="anchor" name="n1" doxytag="PVRShell::PVRShellInit" ></a><p>
- <br><br><h3>PVRShellInit</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> friend class <a class="el" href="classPVRShellInit.html">PVRShellInit</a><code> [friend]</code>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- </td>
- </tr>
- </table>
- <a class="anchor" name="n0" doxytag="PVRShell::PVRShellInitOS" ></a><p>
- <br><br><h3>PVRShellInitOS</h3><br><div>
- <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"> friend class <a class="el" href="classPVRShellInitOS.html">PVRShellInitOS</a><code> [friend]</code>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- </td>
- </tr>
- </table>
- <hr>The documentation for this class was generated from the following files:<ul>
- <li><a class="el" href="PVRShell_8h-source.html">PVRShell.h</a><li><a class="el" href="PVRShellOS_8cpp.html">PVRShellOS.cpp</a><li><a class="el" href="PVRShell_8cpp.html">PVRShell.cpp</a></ul>
- <br>
- <br>
- <P align=left><FONT size=2><STRONG><A
- href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
- 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
- <hr>
- <address style="align: left;"><small><FONT color=f0f>
- Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
- </body>
- </html>
|