Ogre::X11EGLSupport Class Reference

`#include <OgreX11EGLSupport.h>`

Inheritance diagram for Ogre::X11EGLSupport:
[legend]

List of all members.

## Public Member Functions

| X11EGLSupport ()
virtual | ~X11EGLSupport ()
virtual GLESPBuffer * | createPBuffer (PixelComponentType format, size_t width, size_t height)
virtual void | switchMode (uint &width, uint &height, short &frequency)
String | getDisplayName (void)
NativeDisplayType | getNativeDisplay (void)
XVisualInfo * | getVisualFromFBConfig (::EGLConfig glConfig)
EGLDisplay | getGLDisplay ()
RenderWindow * | newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
| X11EGLSupport ()
virtual | ~X11EGLSupport ()
virtual void | switchMode (uint &width, uint &height, short &frequency)
String | getDisplayName (void)
NativeDisplayType | getNativeDisplay (void)
XVisualInfo * | getVisualFromFBConfig (::EGLConfig glConfig)
EGLDisplay | getGLDisplay ()
RenderWindow * | newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
void | start (void)
| Start anything special.
void | start (void)
| Start anything special.
void | stop (void)
| Stop anything special.
void | stop (void)
| Stop anything special.
void | addConfig (void)
| Add any special config values to the system.
void | addConfig (void)
| Add any special config values to the system.
String | validateConfig (void)
| Make sure all the extra options are valid.
String | validateConfig (void)
| Make sure all the extra options are valid.
void | setConfigOption (const String &name, const String &value)
void | setConfigOption (const String &name, const String &value)
void | setGLDisplay (EGLDisplay val)
void | setGLDisplay (EGLDisplay val)
EGLConfig * | chooseGLConfig (const EGLint *attribList, EGLint *nElements)
EGLConfig * | chooseGLConfig (const EGLint *attribList, EGLint *nElements)
EGLBoolean | getGLConfigAttrib (EGLConfig fbConfig, EGLint attribute, EGLint *value)
EGLBoolean | getGLConfigAttrib (EGLConfig fbConfig, EGLint attribute, EGLint *value)
void * | getProcAddress (const Ogre::String &name)
| Get the address of a function.
void * | getProcAddress (const Ogre::String &name)
| Get the address of a function.
::EGLContext | createNewContext (EGLDisplay eglDisplay,::EGLConfig glconfig,::EGLContext shareList) const
::EGLContext | createNewContext (EGLDisplay eglDisplay,::EGLConfig glconfig,::EGLContext shareList) const
RenderWindow * | createWindow (bool autoCreateWindow, GLESRenderSystem *renderSystem, const String &windowTitle)
RenderWindow * | createWindow (bool autoCreateWindow, GLES2RenderSystem *renderSystem, const String &windowTitle)
::EGLConfig | getGLConfigFromContext (::EGLContext context)
::EGLConfig | getGLConfigFromContext (::EGLContext context)
::EGLConfig | getGLConfigFromDrawable (::EGLSurface drawable, unsigned int *w, unsigned int *h)
::EGLConfig | getGLConfigFromDrawable (::EGLSurface drawable, unsigned int *w, unsigned int *h)
::EGLConfig | selectGLConfig (const EGLint *minAttribs, const EGLint *maxAttribs)
::EGLConfig | selectGLConfig (const EGLint *minAttribs, const EGLint *maxAttribs)
void | switchMode (void)
EGLConfig * | getConfigs (EGLint *nElements)
virtual ConfigOptionMap & | getConfigOptions (void)
virtual ConfigOptionMap & | getConfigOptions (void)
const String & | getGLVendor (void) const
| Get vendor information.
const String & | getGLVendor (void) const
| Get vendor information.
const String & | getGLVersion (void) const
| Get version information.
const String & | getGLVersion (void) const
| Get version information.
const String & | getShaderCachePath (void) const
| Get shader cache path.
const String & | getShaderLibraryPath (void) const
| Get shader library path.
void | setShaderCachePath (String path)
| Set shader cache path.
void | setShaderLibraryPath (String path)
| Set shader library path.
virtual void | initialiseExtensions ()
| Initialises GL extensions, must be done AFTER the GL context has been established.
virtual void | initialiseExtensions ()
| Initialises GL extensions, must be done AFTER the GL context has been established.
virtual bool | checkExtension (const String &ext) const
| Check if an extension is available.
virtual bool | checkExtension (const String &ext) const
| Check if an extension is available.
virtual unsigned int | getDisplayMonitorCount () const
virtual unsigned int | getDisplayMonitorCount () const

## Public Attributes

Atom | mAtomDeleteWindow
Atom | mAtomFullScreen
Atom | mAtomState

## Protected Types

typedef std::pair< uint, uint > | ScreenSize
typedef std::pair< uint, uint > | ScreenSize
typedef short | Rate
typedef short | Rate
typedef std::pair< ScreenSize, Rate > | VideoMode
typedef std::pair< ScreenSize, Rate > | VideoMode
typedef std::vector< VideoMode > | VideoModes
typedef std::vector< VideoMode > | VideoModes

## Protected Member Functions

void | refreshConfig (void)
void | refreshConfig (void)

## Protected Attributes

EGLDisplay | mGLDisplay
NativeDisplayType | mNativeDisplay
bool | mIsExternalDisplay
bool | mRandr
VideoModes | mVideoModes
VideoMode | mOriginalMode
VideoMode | mCurrentMode
StringVector | mSampleLevels
ConfigOptionMap | mOptions
ConfigOptionMap | mOptions
set< String >::type | extensionList
std::set< String > | extensionList

## Detailed Description

Definition at line 139 of file include/EGL/X11/OgreX11EGLSupport.h.

## Member Typedef Documentation

typedef short Ogre::EGLSupport::Rate`[protected, inherited]`

Definition at line 58 of file include/EGL/OgreEGLSupport.h.

typedef short Ogre::EGLSupport::Rate`[protected, inherited]`

Definition at line 58 of file /include/EGL/OgreEGLSupport.h.

typedef std::pair<uint, uint> Ogre::EGLSupport::ScreenSize`[protected, inherited]`

Definition at line 57 of file /include/EGL/OgreEGLSupport.h.

typedef std::pair<uint, uint> Ogre::EGLSupport::ScreenSize`[protected, inherited]`

Definition at line 57 of file include/EGL/OgreEGLSupport.h.

typedef std::pair<ScreenSize, Rate> Ogre::EGLSupport::VideoMode`[protected, inherited]`

Definition at line 59 of file include/EGL/OgreEGLSupport.h.

typedef std::pair<ScreenSize, Rate> Ogre::EGLSupport::VideoMode`[protected, inherited]`

Definition at line 59 of file /include/EGL/OgreEGLSupport.h.

typedef std::vector<VideoMode> Ogre::EGLSupport::VideoModes`[protected, inherited]`

Definition at line 60 of file /include/EGL/OgreEGLSupport.h.

typedef std::vector<VideoMode> Ogre::EGLSupport::VideoModes`[protected, inherited]`

Definition at line 60 of file include/EGL/OgreEGLSupport.h.

## Constructor & Destructor Documentation

Ogre::X11EGLSupport::X11EGLSupport | ( |  | ) |

virtual Ogre::X11EGLSupport::~X11EGLSupport | ( |  | ) | `[virtual]`

Ogre::X11EGLSupport::X11EGLSupport | ( |  | ) |

virtual Ogre::X11EGLSupport::~X11EGLSupport | ( |  | ) | `[virtual]`

## Member Function Documentation

void Ogre::EGLSupport::addConfig | ( | void |  | ) | `[virtual, inherited]`

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

void Ogre::EGLSupport::addConfig | ( | void |  | ) | `[virtual, inherited]`

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

virtual bool Ogre::GLESSupport::checkExtension | ( | const String & | ext | ) | const`[virtual, inherited]`

Check if an extension is available.

virtual bool Ogre::GLES2Support::checkExtension | ( | const String & | ext | ) | const`[virtual, inherited]`

Check if an extension is available.

EGLConfig* Ogre::EGLSupport::chooseGLConfig | ( | const EGLint * | attribList,
|  | EGLint * | nElements
| ) |  | `[inherited]`

EGLConfig* Ogre::EGLSupport::chooseGLConfig | ( | const EGLint * | attribList,
|  | EGLint * | nElements
| ) |  | `[inherited]`

::EGLContext Ogre::EGLSupport::createNewContext | ( | EGLDisplay | eglDisplay,
|  | ::EGLConfig | glconfig,
|  | ::EGLContext | shareList
| ) |  | const`[inherited]`

::EGLContext Ogre::EGLSupport::createNewContext | ( | EGLDisplay | eglDisplay,
|  | ::EGLConfig | glconfig,
|  | ::EGLContext | shareList
| ) |  | const`[inherited]`

virtual GLESPBuffer* Ogre::X11EGLSupport::createPBuffer | ( | PixelComponentType | format,
|  | size_t | width,
|  | size_t | height
| ) |  | `[virtual]`

Implements Ogre::EGLSupport.

RenderWindow* Ogre::EGLSupport::createWindow | ( | bool | autoCreateWindow,
|  | GLESRenderSystem * | renderSystem,
|  | const String & | windowTitle
| ) |  | `[virtual, inherited]`

Implements Ogre::GLESSupport.

RenderWindow* Ogre::EGLSupport::createWindow | ( | bool | autoCreateWindow,
|  | GLES2RenderSystem * | renderSystem,
|  | const String & | windowTitle
| ) |  | `[virtual, inherited]`

Implements Ogre::GLES2Support.

virtual ConfigOptionMap& Ogre::GLES2Support::getConfigOptions | ( | void |  | ) | `[virtual, inherited]`

virtual ConfigOptionMap& Ogre::GLESSupport::getConfigOptions | ( | void |  | ) | `[virtual, inherited]`

EGLConfig* Ogre::EGLSupport::getConfigs | ( | EGLint * | nElements | ) | `[inherited]`

virtual unsigned int Ogre::GLESSupport::getDisplayMonitorCount | ( |  | ) | const`[virtual, inherited]`

Definition at line 103 of file OgreGLESSupport.h.

virtual unsigned int Ogre::GLES2Support::getDisplayMonitorCount | ( |  | ) | const`[virtual, inherited]`

Gets the number of display monitors.

See also:
  Root::getDisplayMonitorCount

Definition at line 134 of file OgreGLES2Support.h.

String Ogre::X11EGLSupport::getDisplayName | ( | void |  | ) | `[virtual]`

Reimplemented from Ogre::EGLSupport.

String Ogre::X11EGLSupport::getDisplayName | ( | void |  | ) | `[virtual]`

Reimplemented from Ogre::EGLSupport.

EGLBoolean Ogre::EGLSupport::getGLConfigAttrib | ( | EGLConfig | fbConfig,
|  | EGLint | attribute,
|  | EGLint * | value
| ) |  | `[inherited]`

EGLBoolean Ogre::EGLSupport::getGLConfigAttrib | ( | EGLConfig | fbConfig,
|  | EGLint | attribute,
|  | EGLint * | value
| ) |  | `[inherited]`

::EGLConfig Ogre::EGLSupport::getGLConfigFromContext | ( | ::EGLContext | context | ) | `[inherited]`

::EGLConfig Ogre::EGLSupport::getGLConfigFromContext | ( | ::EGLContext | context | ) | `[inherited]`

::EGLConfig Ogre::EGLSupport::getGLConfigFromDrawable | ( | ::EGLSurface | drawable,
|  | unsigned int * | w,
|  | unsigned int * | h
| ) |  | `[inherited]`

::EGLConfig Ogre::EGLSupport::getGLConfigFromDrawable | ( | ::EGLSurface | drawable,
|  | unsigned int * | w,
|  | unsigned int * | h
| ) |  | `[inherited]`

EGLDisplay Ogre::X11EGLSupport::getGLDisplay | ( |  | ) |

Reimplemented from Ogre::EGLSupport.

EGLDisplay Ogre::X11EGLSupport::getGLDisplay | ( |  | ) |

Reimplemented from Ogre::EGLSupport.

const String& Ogre::GLES2Support::getGLVendor | ( | void |  | ) | const`[inherited]`

Get vendor information.

Definition at line 73 of file OgreGLES2Support.h.

const String& Ogre::GLESSupport::getGLVendor | ( | void |  | ) | const`[inherited]`

Get vendor information.

Definition at line 75 of file OgreGLESSupport.h.

const String& Ogre::GLES2Support::getGLVersion | ( | void |  | ) | const`[inherited]`

Get version information.

Definition at line 81 of file OgreGLES2Support.h.

const String& Ogre::GLESSupport::getGLVersion | ( | void |  | ) | const`[inherited]`

Get version information.

Definition at line 83 of file OgreGLESSupport.h.

NativeDisplayType Ogre::X11EGLSupport::getNativeDisplay | ( | void |  | ) |

NativeDisplayType Ogre::X11EGLSupport::getNativeDisplay | ( | void |  | ) |

void* Ogre::EGLSupport::getProcAddress | ( | const Ogre::String & | procname | ) | `[virtual, inherited]`

Get the address of a function.

Implements Ogre::GLESSupport.

void* Ogre::EGLSupport::getProcAddress | ( | const Ogre::String & | procname | ) | `[virtual, inherited]`

Get the address of a function.

Implements Ogre::GLESSupport.

const String& Ogre::GLES2Support::getShaderCachePath | ( | void |  | ) | const`[inherited]`

Get shader cache path.

Definition at line 89 of file OgreGLES2Support.h.

const String& Ogre::GLES2Support::getShaderLibraryPath | ( | void |  | ) | const`[inherited]`

Get shader library path.

Definition at line 97 of file OgreGLES2Support.h.

XVisualInfo* Ogre::X11EGLSupport::getVisualFromFBConfig | ( | ::EGLConfig | glConfig | ) |

XVisualInfo* Ogre::X11EGLSupport::getVisualFromFBConfig | ( | ::EGLConfig | glConfig | ) |

virtual void Ogre::GLESSupport::initialiseExtensions | ( |  | ) | `[virtual, inherited]`

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

virtual void Ogre::GLES2Support::initialiseExtensions | ( |  | ) | `[virtual, inherited]`

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

RenderWindow* Ogre::X11EGLSupport::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:

  name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
  width | The width of the new window.
  height | The height of the new window.
  fullScreen | Specify true to make the window full screen without borders, title bar or menu bar.

  miscParams

  A 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 |
  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::GLESSupport.

RenderWindow* Ogre::X11EGLSupport::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:

  name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
  width | The width of the new window.
  height | The height of the new window.
  fullScreen | Specify true to make the window full screen without borders, title bar or menu bar.

  miscParams

  A 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 |
  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::GLESSupport.

void Ogre::EGLSupport::refreshConfig | ( | void |  | ) | `[protected, inherited]`

void Ogre::EGLSupport::refreshConfig | ( | void |  | ) | `[protected, inherited]`

::EGLConfig Ogre::EGLSupport::selectGLConfig | ( | const EGLint * | minAttribs,
|  | const EGLint * | maxAttribs
| ) |  | `[inherited]`

::EGLConfig Ogre::EGLSupport::selectGLConfig | ( | const EGLint * | minAttribs,
|  | const EGLint * | maxAttribs
| ) |  | `[inherited]`

void Ogre::EGLSupport::setConfigOption | ( | const String & | name,
|  | const String & | value
| ) |  | `[virtual, inherited]`

Reimplemented from Ogre::GLESSupport.

void Ogre::EGLSupport::setConfigOption | ( | const String & | name,
|  | const String & | value
| ) |  | `[virtual, inherited]`

Reimplemented from Ogre::GLESSupport.

void Ogre::EGLSupport::setGLDisplay | ( | EGLDisplay | val | ) | `[inherited]`

void Ogre::EGLSupport::setGLDisplay | ( | EGLDisplay | val | ) | `[inherited]`

void Ogre::GLES2Support::setShaderCachePath | ( | String | path | ) | `[inherited]`

Set shader cache path.

Definition at line 105 of file OgreGLES2Support.h.

void Ogre::GLES2Support::setShaderLibraryPath | ( | String | path | ) | `[inherited]`

Set shader library path.

Definition at line 113 of file OgreGLES2Support.h.

void Ogre::EGLSupport::start | ( | void |  | ) | `[virtual, inherited]`

Start anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::start | ( | void |  | ) | `[virtual, inherited]`

Start anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::stop | ( | void |  | ) | `[virtual, inherited]`

Stop anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::stop | ( | void |  | ) | `[virtual, inherited]`

Stop anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::switchMode | ( | void |  | ) | `[inherited]`

virtual void Ogre::X11EGLSupport::switchMode | ( | uint & | width,
|  | uint & | height,
|  | short & | frequency
| ) |  | `[virtual]`

Implements Ogre::EGLSupport.

virtual void Ogre::X11EGLSupport::switchMode | ( | uint & | width,
|  | uint & | height,
|  | short & | frequency
| ) |  | `[virtual]`

Implements Ogre::EGLSupport.

String Ogre::EGLSupport::validateConfig | ( | void |  | ) | `[virtual, inherited]`

Make sure all the extra options are valid.

Returns:
  string with error message

Implements Ogre::GLESSupport.

String Ogre::EGLSupport::validateConfig | ( | void |  | ) | `[virtual, inherited]`

Make sure all the extra options are valid.

Returns:
  string with error message

Implements Ogre::GLESSupport.

## Member Data Documentation

std::set<String> Ogre::GLESSupport::extensionList`[protected, inherited]`

Definition at line 127 of file OgreGLESSupport.h.

set<String>::type Ogre::GLES2Support::extensionList`[protected, inherited]`

Definition at line 159 of file OgreGLES2Support.h.

Atom Ogre::X11EGLSupport::mAtomDeleteWindow

Definition at line 159 of file include/EGL/X11/OgreX11EGLSupport.h.

Atom Ogre::X11EGLSupport::mAtomFullScreen

Definition at line 160 of file include/EGL/X11/OgreX11EGLSupport.h.

Atom Ogre::X11EGLSupport::mAtomState

Definition at line 161 of file include/EGL/X11/OgreX11EGLSupport.h.

VideoMode Ogre::EGLSupport::mCurrentMode`[protected, inherited]`

Definition at line 63 of file include/EGL/OgreEGLSupport.h.

EGLDisplay Ogre::EGLSupport::mGLDisplay`[protected, inherited]`

Definition at line 52 of file include/EGL/OgreEGLSupport.h.

bool Ogre::EGLSupport::mIsExternalDisplay`[protected, inherited]`

Definition at line 55 of file include/EGL/OgreEGLSupport.h.

NativeDisplayType Ogre::EGLSupport::mNativeDisplay`[protected, inherited]`

Definition at line 53 of file include/EGL/OgreEGLSupport.h.

ConfigOptionMap Ogre::GLESSupport::mOptions`[protected, inherited]`

Definition at line 124 of file OgreGLESSupport.h.

ConfigOptionMap Ogre::GLES2Support::mOptions`[protected, inherited]`

Definition at line 156 of file OgreGLES2Support.h.

VideoMode Ogre::EGLSupport::mOriginalMode`[protected, inherited]`

Definition at line 62 of file include/EGL/OgreEGLSupport.h.

bool Ogre::EGLSupport::mRandr`[protected, inherited]`

Definition at line 56 of file include/EGL/OgreEGLSupport.h.

StringVector Ogre::EGLSupport::mSampleLevels`[protected, inherited]`

Definition at line 64 of file include/EGL/OgreEGLSupport.h.

VideoModes Ogre::EGLSupport::mVideoModes`[protected, inherited]`

Definition at line 61 of file include/EGL/OgreEGLSupport.h.

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

- include/EGL/X11/OgreX11EGLSupport.h
- /include/EGL/X11/OgreX11EGLSupport.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:56