OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::EAGL2Support Class Reference

#include <OgreEAGL2Support.h>

+ Inheritance diagram for Ogre::EAGL2Support:
+ Collaboration diagram for Ogre::EAGL2Support:

Public Member Functions

 EAGL2Support ()
virtual ~EAGL2Support ()
void addConfig (void)
 Add any special config values to the system. More...
virtual bool checkExtension (const String &ext) const
 Check if an extension is available. More...
CFDictionaryRef chooseGLConfig (const GLint *attribList, GLint *nElements)
RenderWindowcreateWindow (bool autoCreateWindow, GLES2RenderSystem *renderSystem, const String &windowTitle)
virtual ConfigOptionMapgetConfigOptions (void)
float getCurrentOSVersion (void)
virtual unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors. More...
virtual String getDisplayName (void)
GLint getGLConfigAttrib (CFDictionaryRef fbConfig, GLint attribute, GLint *value)
const StringgetGLVendor (void) const
 Get vendor information. More...
const StringgetGLVersion (void) const
 Get version information. More...
void * getProcAddress (const Ogre::String &name)
 Get the address of a function. More...
const StringgetShaderCachePath (void) const
 Get shader cache path. More...
const StringgetShaderLibraryPath (void) const
 Get shader library path. More...
GLES2StateCacheManagergetStateCacheManager () const
 Get the state cache manager. More...
virtual void initialiseExtensions ()
 Initialises GL extensions, must be done AFTER the GL context has been established. More...
RenderWindownewWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
 Creates a new rendering window. More...
CFDictionaryRef selectGLConfig (const int *minAttribs, const int *maxAttribs)
virtual void setConfigOption (const String &name, const String &value)
void setShaderCachePath (String path)
 Set shader cache path. More...
void setShaderLibraryPath (String path)
 Set shader library path. More...
void setStateCacheManager (GLES2StateCacheManager *stateCacheMgr)
 Set a valid state cache manager. More...
void start (void)
 Start anything special. More...
void stop (void)
 Stop anything special. More...
String validateConfig (void)
 Make sure all the extra options are valid. More...

Protected Attributes

set< String >::type extensionList
float mCurrentOSVersion
ConfigOptionMap mOptions

Detailed Description

Definition at line 53 of file OgreEAGL2Support.h.

Constructor & Destructor Documentation

Ogre::EAGL2Support::EAGL2Support ( )
virtual Ogre::EAGL2Support::~EAGL2Support ( )

Member Function Documentation

void Ogre::EAGL2Support::addConfig ( void  )

Add any special config values to the system.

Must have a "Full Screen" value that is a bool and a "Video Mode" value that is a string in the form of wxh

Implements Ogre::GLES2Support.

virtual bool Ogre::GLES2Support::checkExtension ( const String ext) const

Check if an extension is available.

CFDictionaryRef Ogre::EAGL2Support::chooseGLConfig ( const GLint *  attribList,
GLint *  nElements 
RenderWindow* Ogre::EAGL2Support::createWindow ( bool  autoCreateWindow,
GLES2RenderSystem renderSystem,
const String windowTitle 

Implements Ogre::GLES2Support.

virtual ConfigOptionMap& Ogre::GLES2Support::getConfigOptions ( void  )
float Ogre::EAGL2Support::getCurrentOSVersion ( void  )

Definition at line 66 of file OgreEAGL2Support.h.

virtual unsigned int Ogre::GLES2Support::getDisplayMonitorCount ( ) const

Gets the number of display monitors.

See also

Definition at line 135 of file OgreGLES2Support.h.

virtual String Ogre::EAGL2Support::getDisplayName ( void  )
GLint Ogre::EAGL2Support::getGLConfigAttrib ( CFDictionaryRef  fbConfig,
GLint  attribute,
GLint *  value 
const String& Ogre::GLES2Support::getGLVendor ( void  ) const

Get vendor information.

Definition at line 74 of file OgreGLES2Support.h.

const String& Ogre::GLES2Support::getGLVersion ( void  ) const

Get version information.

Definition at line 82 of file OgreGLES2Support.h.

void* Ogre::EAGL2Support::getProcAddress ( const Ogre::String procname)

Get the address of a function.

Implements Ogre::GLES2Support.

const String& Ogre::GLES2Support::getShaderCachePath ( void  ) const

Get shader cache path.

Definition at line 90 of file OgreGLES2Support.h.

const String& Ogre::GLES2Support::getShaderLibraryPath ( void  ) const

Get shader library path.

Definition at line 98 of file OgreGLES2Support.h.

GLES2StateCacheManager* Ogre::GLES2Support::getStateCacheManager ( ) const

Get the state cache manager.

Definition at line 143 of file OgreGLES2Support.h.

virtual void Ogre::GLES2Support::initialiseExtensions ( )

Initialises GL extensions, must be done AFTER the GL context has been established.

RenderWindow* Ogre::EAGL2Support::newWindow ( const String name,
unsigned int  width,
unsigned int  height,
bool  fullScreen,
const NameValuePairList miscParams = 0 

Creates a new rendering window.

This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.
After creation, this window can be retrieved using getRenderTarget().
nameThe name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
widthThe width of the new window.
heightThe height of the new window.
fullScreenSpecify true to make the window full screen without borders, title bar or menu bar.
miscParamsA NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
Key Type/Values Default Description Notes
title Any string RenderTarget name The title of the window that will appear in the title bar  
colourDepth 16, 32 Desktop depth Colour depth of the resulting rendering window; only applies if fullScreen Win32 Specific
left Positive integers Centred Screen x coordinate from left  
top Positive integers Centred Screen y coordinate from left  
depthBuffer true, false true Use depth buffer DirectX9 specific
externalWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
OS X: WindowRef for Carbon or NSWindow for Cocoa address as an integer iOS: UIWindow address as an integer
0 (none) External window handle, for embedding the OGRE render in an existing window  
externalGLControl true, false false Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. OpenGL specific
externalGLContext Context as Unsigned Long 0 (create own context) Use an externally created GL context OpenGL Specific
parentWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
0 (none) Parent window handle, for embedding the OGRE in a child of an external window  
macAPI String: "cocoa" or "carbon" "carbon" Specifies the type of rendering window on the Mac Platform. Mac OS X Specific  
macAPICocoaUseNSView bool "true" or "false" "false" On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm. Mac OS X Specific  
contentScalingFactor Positive Float greater than 1.0 The default content scaling factor of the screen Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor. iOS Specific  
externalViewHandle UIView pointer as an integer 0 External view handle, for rendering OGRE render in an existing view iOS Specific  
externalViewControllerHandle UIViewController pointer as an integer 0 External view controller handle, for embedding OGRE in an existing view controller iOS Specific  
externalSharegroup EAGLSharegroup pointer as an integer 0 External sharegroup, used to shared GL resources between contexts iOS Specific  
Full Screen true, false false Specify whether to create the window in full screen mode OS X Specific  
FSAA Positive integer (usually 0, 2, 4, 8, 16) 0 Full screen antialiasing factor  
FSAAHint Depends on RenderSystem and hardware. Currently supports:
"Quality": on systems that have an option to prefer higher AA quality over speed, use it
Blank Full screen antialiasing hint  
displayFrequency Refresh rate in Hertz (e.g. 60, 75, 100) Desktop vsync rate Display frequency rate, for fullscreen mode  
vsync true, false false Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate  
vsyncInterval 1, 2, 3, 4 1 If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30.  
border none, fixed, resize resize The type of window border (in windowed mode)  
outerDimensions true, false false Whether the width/height is expressed as the size of the outer window, rather than the content area  
useNVPerfHUD true, false false Enable the use of nVidia NVPerfHUD  
gamma true, false false Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.  
enableDoubleClick true, false false Enable the window to keep track and transmit double click messages. Win32 Specific

Implements Ogre::GLES2Support.

CFDictionaryRef Ogre::EAGL2Support::selectGLConfig ( const int *  minAttribs,
const int *  maxAttribs 
virtual void Ogre::GLES2Support::setConfigOption ( const String name,
const String value 
void Ogre::GLES2Support::setShaderCachePath ( String  path)

Set shader cache path.

Definition at line 106 of file OgreGLES2Support.h.

void Ogre::GLES2Support::setShaderLibraryPath ( String  path)

Set shader library path.

Definition at line 114 of file OgreGLES2Support.h.

void Ogre::GLES2Support::setStateCacheManager ( GLES2StateCacheManager stateCacheMgr)

Set a valid state cache manager.

Definition at line 151 of file OgreGLES2Support.h.

void Ogre::EAGL2Support::start ( void  )

Start anything special.

Implements Ogre::GLES2Support.

void Ogre::EAGL2Support::stop ( void  )

Stop anything special.

Implements Ogre::GLES2Support.

String Ogre::EAGL2Support::validateConfig ( void  )

Make sure all the extra options are valid.

string with error message

Implements Ogre::GLES2Support.

Member Data Documentation

set<String>::type Ogre::GLES2Support::extensionList

Definition at line 176 of file OgreGLES2Support.h.

float Ogre::EAGL2Support::mCurrentOSVersion

Definition at line 87 of file OgreEAGL2Support.h.

ConfigOptionMap Ogre::GLES2Support::mOptions

Definition at line 173 of file OgreGLES2Support.h.

GLES2StateCacheManager* Ogre::GLES2Support::mStateCacheMgr

Definition at line 179 of file OgreGLES2Support.h.

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