PowerVR Software Development Kit


Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PVRShellInit Class Reference

main PVRShell class for initialisation More...

#include <PVRShellImpl.h>

Inheritance diagram for PVRShellInit:

Inheritance graph
[legend]
Collaboration diagram for PVRShellInit:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 PVRShellInit ()
 ~PVRShellInit ()
void Init (PVRShell &Shell)
void CommandLine (char *str)
void CommandLine (int argc, char **argv)
bool DoIsKeyPressed (const PVRShellKeyName key)
void KeyPressed (PVRShellKeyName key)
const char * GetDataPath () const
void SetAppName (const char *const str)
void SetDataPath (const char *const str)
bool Run ()
void OsInit ()
bool OsInitOS ()
void OsReleaseOS ()
void OsExit ()
bool OsDoInitAPI ()
void OsDoReleaseAPI ()
void OsRenderComplete ()
bool OsPixmapCopy ()
void * OsGetNativeDisplayType ()
void * OsGetNativePixmapType ()
void * OsGetNativeWindowType ()
bool OsGet (const prefNamePtrEnum prefName, void **pp)
void OsDisplayDebugString (char const *const str)
unsigned long OsGetTime ()
bool ApiInitAPI ()
void ApiReleaseAPI ()
bool ApiScreenCaptureBuffer (int Width, int Height, unsigned char *pBuf)
void ApiRenderComplete ()
bool ApiGet (const prefNamePtrEnum prefName, void **pp)
void ApiActivatePreferences ()

Public Attributes

PVRShellm_pShell
PVRShellCommandLine m_CommandLine
bool gShellDone
EPVRShellState m_eState
PVRShellKeyName nLastKeyPressed
char * m_pDataPath

Friends

class PVRShell
class PVRShellInitOS
class PVRShellInitAPI

Detailed Description

main PVRShell class for initialisation


Constructor & Destructor Documentation



PVRShellInit


PVRShellInit::PVRShellInit  ) 
 

Description:
PVRShellInit Constructor



~PVRShellInit


PVRShellInit::~PVRShellInit  ) 
 

Description:
PVRShellInit Destructor

Member Function Documentation



ApiActivatePreferences


void PVRShellInit::ApiActivatePreferences  ) 
 

Description:
Run specific API code to perform the operations requested in preferences.



ApiGet


bool PVRShellInit::ApiGet const prefNamePtrEnum  prefName,
void **  pp
 

Description:
Get parameters which are specific of the API.



ApiInitAPI


bool PVRShellInit::ApiInitAPI  ) 
 

Description:
Initialisation for API-specific code.

Here is the call graph for this function:



ApiReleaseAPI


void PVRShellInit::ApiReleaseAPI  ) 
 

Description:
Releases all resources allocated by the API.



ApiRenderComplete


void PVRShellInit::ApiRenderComplete  ) 
 

Description:
Perform API operations required after a frame has finished (e.g., flipping).

Here is the call graph for this function:



ApiScreenCaptureBuffer


bool PVRShellInit::ApiScreenCaptureBuffer int  Width,
int  Height,
unsigned char *  pBuf
 

Description:
API-specific function to store the current content of the FrameBuffer into the memory allocated by the user.

Here is the call graph for this function:



CommandLine


void PVRShellInit::CommandLine int  argc,
char **  argv
 



CommandLine


void PVRShellInit::CommandLine char *  str  ) 
 

Description:
Receives the command-line from the application.



DoIsKeyPressed


bool PVRShellInit::DoIsKeyPressed const PVRShellKeyName  key  ) 
 

Description:
Return 'true' if the specific key has been pressed.



GetDataPath


const char * PVRShellInit::GetDataPath  )  const
 

Description:
Used by the OS-specific code to tell the Shell where the actual application resides.



Init


void PVRShellInit::Init PVRShell Shell  ) 
 

Description:
PVRShell Initialisation.



KeyPressed


void PVRShellInit::KeyPressed PVRShellKeyName  key  ) 
 

Description:
Used by the OS-specific code to tell the Shell that a key has been pressed.



OsDisplayDebugString


void PVRShellInit::OsDisplayDebugString char const *const  str  ) 
 

Description:
Prints a debug string



OsDoInitAPI


bool PVRShellInit::OsDoInitAPI  ) 
 

Description:
Perform GL initialization and bring up window / fullscreen



OsDoReleaseAPI


void PVRShellInit::OsDoReleaseAPI  ) 
 

Description:
Clean up after we're done



OsExit


void PVRShellInit::OsExit  ) 
 

Description:
Destroys main window



OsGet


bool PVRShellInit::OsGet const prefNamePtrEnum  prefName,
void **  pp
 

Description:
Retrieves OS-specific data



OsGetNativeDisplayType


void * PVRShellInit::OsGetNativeDisplayType  ) 
 

Description:
Called from InitAPI() to get the NativeDisplayType



OsGetNativePixmapType


void * PVRShellInit::OsGetNativePixmapType  ) 
 

Description:
Called from InitAPI() to get the NativePixmapType



OsGetNativeWindowType


void * PVRShellInit::OsGetNativeWindowType  ) 
 

Description:
Called from InitAPI() to get the NativeWindowType



OsGetTime


unsigned long PVRShellInit::OsGetTime  ) 
 

Description:
Gets the time in milliseconds since the beginning of the application



OsInit


void PVRShellInit::OsInit  ) 
 

Description:
Initialisation for OS-specific code.



OsInitOS


bool PVRShellInit::OsInitOS  ) 
 

Description:
Saves instance handle and creates main window In this function, we save the instance handle in a global variable and create and display the main program window.

Here is the call graph for this function:



OsPixmapCopy


bool PVRShellInit::OsPixmapCopy  ) 
 

Description:
When using pixmaps, copy the render to the display



OsReleaseOS


void PVRShellInit::OsReleaseOS  ) 
 

Description:
Destroys main window



OsRenderComplete


void PVRShellInit::OsRenderComplete  ) 
 

Description:
Main message loop / render loop



Run


bool PVRShellInit::Run  ) 
 

Description:
Called from the OS-specific code to perform the render. When this fucntion fails the application will quit.

Here is the call graph for this function:



SetAppName


void PVRShellInit::SetAppName const char *const  str  ) 
 

Description:
Sets the default app name (to be displayed by the OS)



SetDataPath


void PVRShellInit::SetDataPath const char *const  str  ) 
 

Description:
Set the path to where the application expects the data.

Friends And Related Function Documentation



PVRShell


friend class PVRShell [friend]
 



PVRShellInitAPI


friend class PVRShellInitAPI [friend]
 



PVRShellInitOS


friend class PVRShellInitOS [friend]
 


Member Data Documentation



gShellDone


bool PVRShellInit::gShellDone
 

Indicates that the application has finished



m_CommandLine


PVRShellCommandLine PVRShellInit::m_CommandLine
 

Our Commad-line class



m_eState


EPVRShellState PVRShellInit::m_eState
 

Current PVRShell state



m_pDataPath


char* PVRShellInit::m_pDataPath
 

Holds the path where the application will read the data from



m_pShell


PVRShell* PVRShellInit::m_pShell
 

Our PVRShell class



nLastKeyPressed


PVRShellKeyName PVRShellInit::nLastKeyPressed
 

Holds the last key pressed


The documentation for this class was generated from the following files:

Copyright © 1999-2006, PowerVR Technologies and partners. PowerVR Technologies is a division of Imagination Technologies Ltd.


Generated by DOXYGEN 1.3.6