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

#include <OgreOSXGLSupport.h>

+ Inheritance diagram for Ogre::OSXGLSupport:
+ Collaboration diagram for Ogre::OSXGLSupport:

Public Member Functions

 OSXGLSupport ()
 
 ~OSXGLSupport ()
 
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...
 
bool checkMinGLVersion (const String &v) const
 Compare GL version numbers. More...
 
virtual GLPBuffercreatePBuffer (PixelComponentType format, size_t width, size_t height)
 
virtual GLPBuffercreatePBuffer (PixelComponentType format, uint32 width, uint32 height)
 
RenderWindowcreateWindow (bool autoCreateWindow, GLRenderSystem *renderSystem, const String &windowTitle)
 
virtual ConfigOptionMapgetConfigOptions (void)
 
virtual unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors. More...
 
const StringgetGLVendor (void) const
 Get vendor information. More...
 
const StringgetGLVersion (void) const
 Get version information. More...
 
void * getProcAddress (const char *name)
 Get the address of a function. More...
 
void * getProcAddress (const String &procname)
 Get the address of a function. More...
 
GLStateCacheManagergetStateCacheManager () const
 
virtual void initialiseExtensions ()
 Initialises GL extensions, must be done AFTER the GL context has been established. More...
 
virtual RenderWindownewWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
 Creates a new rendering window. More...
 
bool OSVersionIsAtLeast (String newVersion)
 
virtual void setConfigOption (const String &name, const String &value)
 
void setStateCacheManager (GLStateCacheManager *stateCacheMgr)
 
void start ()
 Start anything special. More...
 
void stop ()
 Stop anything special. More...
 
virtual bool supportsPBuffers ()
 
String validateConfig (void)
 Make sure all the extra options are valid. More...
 

Static Public Member Functions

static CFComparisonResult _compareModes (const void *val1, const void *val2, void *context)
 
static Boolean _getDictionaryBoolean (CFDictionaryRef dict, const void *key)
 
static long _getDictionaryLong (CFDictionaryRef dict, const void *key)
 

Protected Attributes

set< String >::type extensionList
 
String mAPI
 
String mContextType
 
class OSXGLSupportImpl * mImpl
 
ConfigOptionMap mOptions
 

Detailed Description

Definition at line 37 of file OgreOSXGLSupport.h.

Constructor & Destructor Documentation

Ogre::OSXGLSupport::OSXGLSupport ( )
Ogre::OSXGLSupport::~OSXGLSupport ( )

Member Function Documentation

static CFComparisonResult Ogre::OSXGLSupport::_compareModes ( const void *  val1,
const void *  val2,
void *  context 
)
static
static Boolean Ogre::OSXGLSupport::_getDictionaryBoolean ( CFDictionaryRef  dict,
const void *  key 
)
static
static long Ogre::OSXGLSupport::_getDictionaryLong ( CFDictionaryRef  dict,
const void *  key 
)
static
void Ogre::OSXGLSupport::addConfig ( void  )
virtual

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::GLSupport.

virtual bool Ogre::GLSupport::checkExtension ( const String ext) const
virtualinherited

Check if an extension is available.

Reimplemented in Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

bool Ogre::GLSupport::checkMinGLVersion ( const String v) const
inherited

Compare GL version numbers.

virtual GLPBuffer* Ogre::GLSupport::createPBuffer ( PixelComponentType  format,
size_t  width,
size_t  height 
)
virtualinherited

Reimplemented in Ogre::Win32GLSupport, and Ogre::GLXGLSupport.

virtual GLPBuffer* Ogre::OSXGLSupport::createPBuffer ( PixelComponentType  format,
uint32  width,
uint32  height 
)
virtual
RenderWindow* Ogre::OSXGLSupport::createWindow ( bool  autoCreateWindow,
GLRenderSystem renderSystem,
const String windowTitle 
)
virtual

Implements Ogre::GLSupport.

virtual ConfigOptionMap& Ogre::GLSupport::getConfigOptions ( void  )
virtualinherited
virtual unsigned int Ogre::GLSupport::getDisplayMonitorCount ( ) const
inlinevirtualinherited

Gets the number of display monitors.

See also
Root::getDisplayMonitorCount

Reimplemented in Ogre::Win32GLSupport, and Ogre::Win32GLSupport.

Definition at line 130 of file OgreGLSupport.h.

const String& Ogre::GLSupport::getGLVendor ( void  ) const
inlineinherited

Get vendor information.

Definition at line 97 of file OgreGLSupport.h.

const String& Ogre::GLSupport::getGLVersion ( void  ) const
inlineinherited

Get version information.

Definition at line 105 of file OgreGLSupport.h.

void* Ogre::OSXGLSupport::getProcAddress ( const char *  name)

Get the address of a function.

void* Ogre::OSXGLSupport::getProcAddress ( const String procname)
virtual

Get the address of a function.

Implements Ogre::GLSupport.

GLStateCacheManager* Ogre::GLSupport::getStateCacheManager ( ) const
inlineinherited

Definition at line 75 of file OgreGLSupport.h.

virtual void Ogre::GLSupport::initialiseExtensions ( )
virtualinherited

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

Reimplemented in Ogre::Win32GLSupport, Ogre::Win32GLSupport, Ogre::GLXGLSupport, Ogre::GLXGLSupport, Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

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

Creates a new rendering window.

Remarks
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().
Parameters
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::GLSupport.

bool Ogre::OSXGLSupport::OSVersionIsAtLeast ( String  newVersion)
virtual void Ogre::GLSupport::setConfigOption ( const String name,
const String value 
)
virtualinherited
void Ogre::GLSupport::setStateCacheManager ( GLStateCacheManager stateCacheMgr)
inlineinherited

Definition at line 80 of file OgreGLSupport.h.

void Ogre::OSXGLSupport::start ( )
virtual

Start anything special.

Implements Ogre::GLSupport.

void Ogre::OSXGLSupport::stop ( )
virtual

Stop anything special.

Implements Ogre::GLSupport.

virtual bool Ogre::OSXGLSupport::supportsPBuffers ( )
virtual

Reimplemented from Ogre::GLSupport.

String Ogre::OSXGLSupport::validateConfig ( void  )
virtual

Make sure all the extra options are valid.

Implements Ogre::GLSupport.

Member Data Documentation

set<String>::type Ogre::GLSupport::extensionList
protectedinherited

Definition at line 140 of file OgreGLSupport.h.

String Ogre::OSXGLSupport::mAPI
protected

Definition at line 89 of file OgreOSXGLSupport.h.

String Ogre::OSXGLSupport::mContextType
protected

Definition at line 90 of file OgreOSXGLSupport.h.

class OSXGLSupportImpl* Ogre::OSXGLSupport::mImpl
protected

Definition at line 93 of file OgreOSXGLSupport.h.

ConfigOptionMap Ogre::GLSupport::mOptions
protectedinherited

Definition at line 137 of file OgreGLSupport.h.


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