PowerVR Software Development Kit


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

PVRShell.h File Reference

Shell to make programming 3D APIs easier. More...

#include <stdlib.h>

Include dependency graph for PVRShell.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Classes

struct  SCmdLineOpt
 Stores a variable name/value pair for an individual command-line option. More...

class  PVRShell
 Inherited by the application; responsible for abstracting the OS and API. More...


Defines

#define EXIT_NOERR_CODE   0
#define EXIT_ERR_CODE   (!EXIT_NOERR_CODE)

Enumerations

enum  PVRShellKeyName {
  PVRShellKeyNameNull, PVRShellKeyNameQUIT, PVRShellKeyNameSELECT, PVRShellKeyNameACTION1,
  PVRShellKeyNameACTION2, PVRShellKeyNameUP, PVRShellKeyNameDOWN, PVRShellKeyNameLEFT,
  PVRShellKeyNameRIGHT, PVRShellKeyNameScreenshot
}
enum  prefNameBoolEnum {
  prefFullScreen, prefIsRotated, prefPBufferContext, prefPixmapContext,
  prefPixmapDisableCopy, prefZbufferContext, prefLockableBackBuffer, prefSoftwareRendering,
  prefStencilBufferContext, prefOpenVGContext
}
 Boolean Shell preferences. More...

enum  prefNameFloatEnum { prefQuitAfterTime }
 Float Shell preferences. More...

enum  prefNameIntEnum {
  prefWidth, prefHeight, prefPositionX, prefPositionY,
  prefQuitAfterFrame, prefSwapInterval, prefInitRepeats, prefFSAAMode,
  prefCommandLineOptNum
}
 Integer Shell preferences. More...

enum  prefNamePtrEnum { prefD3DDevice, prefHINSTANCE, prefNativeWindowType }
 Pointers/Handlers Shell preferences. More...

enum  prefNameConstPtrEnum {
  prefAppName, prefDataPath, prefCommandLine, prefCommandLineOpts,
  prefExitMessage, prefVersion
}
 Constant pointers Shell preferences. More...


Functions

PVRShellNewDemo ()


Detailed Description

Shell to make programming 3D APIs easier.

Copyright:
Copyright (C) 2005 - 2006 by Imagination Technologies Limited.
Platform:
Independant
Description:
Makes programming for 3D APIs easier by wrapping surface initialization, Texture allocation and other functions for use by a demo.

Define Documentation



EXIT_ERR_CODE


#define EXIT_ERR_CODE   (!EXIT_NOERR_CODE)
 



EXIT_NOERR_CODE


#define EXIT_NOERR_CODE   0
 


Enumeration Type Documentation



prefNameBoolEnum


enum prefNameBoolEnum
 

Boolean Shell preferences.

Enumeration values:
prefFullScreen  Set to: 1 for full-screen rendering; 0 for windowed
prefIsRotated  Query this to learn whether screen is rotated
prefPBufferContext  1 if you need pbuffer support (default is pbuffer not needed)
prefPixmapContext  1 to use a pixmap as a render-target (default off)
prefPixmapDisableCopy  1 to disable the copy if pixmaps are used
prefZbufferContext  1 if you wish to have zbuffer support (default to on)
prefLockableBackBuffer  DX9 only: true to use D3DPRESENTFLAG_LOCKABLE_BACKBUFFER (default: false)
prefSoftwareRendering  1 to select software rendering (default: off, i.e. use hardware)
prefStencilBufferContext  1 if you wish to have stencil support (default: off)
prefOpenVGContext  EGL only: 1 to initialize OpenVG instead of OpenGL ES (default: off)



prefNameConstPtrEnum


enum prefNameConstPtrEnum
 

Constant pointers Shell preferences.

Enumeration values:
prefAppName  ptrValue is char*
prefDataPath  ptrValue is char*; will include a trailing slash
prefCommandLine  used to retrieve the entire application command line
prefCommandLineOpts  ptrValue is SCmdLineOpt*; retrieves an array of arg/value pairs (parsed from the command line)
prefExitMessage  ptrValue is char*; gives the shell a message to show on exit, typically an error
prefVersion  ptrValue is char*



prefNameFloatEnum


enum prefNameFloatEnum
 

Float Shell preferences.

Enumeration values:
prefQuitAfterTime  Shell will quit after this number of seconds (-1 to disable)



prefNameIntEnum


enum prefNameIntEnum
 

Integer Shell preferences.

Enumeration values:
prefWidth  Width of render target
prefHeight  Height of render target
prefPositionX  X position of the window
prefPositionY  Y position of the window
prefQuitAfterFrame  Shell will quit after this number of frames (-1 to disable)
prefSwapInterval  0 to preventing waiting for monitor vertical syncs
prefInitRepeats  Number of times to reinitialise (if >0 when app returns false from RenderScene(), shell will ReleaseView(), InitView() then re-enter RenderScene() loop). Decrements on each initialisation.
prefFSAAMode  Set to: 0 to disable full-screen anti-aliasing; 1 for 2x; 2 for 4x.
prefCommandLineOptNum  Returns the length of the array returned by prefCommandLineOpts



prefNamePtrEnum


enum prefNamePtrEnum
 

Pointers/Handlers Shell preferences.

Enumeration values:
prefD3DDevice  Returns the device pointer in D3D shells
prefHINSTANCE  Returns the window handle
prefNativeWindowType  Returns the window handle



PVRShellKeyName


enum PVRShellKeyName
 

Keyboard mapping.

Enumeration values:
PVRShellKeyNameNull 
PVRShellKeyNameQUIT 
PVRShellKeyNameSELECT 
PVRShellKeyNameACTION1 
PVRShellKeyNameACTION2 
PVRShellKeyNameUP 
PVRShellKeyNameDOWN 
PVRShellKeyNameLEFT 
PVRShellKeyNameRIGHT 
PVRShellKeyNameScreenshot 

Function Documentation



NewDemo


PVRShell* NewDemo  ) 
 

Returns:
The demo supplied by the user
Description:
This function must be implemented by the user of the shell. The user should return its PVRShell object defining the behaviour of the application


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


Generated by DOXYGEN 1.3.6