| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
Ogre::GLES2Support Class Reference

`#include <OgreGLES2Support.h>`

## Public Member Functions
| GLES2Support (GLNativeSupport *native)
virtual | ~GLES2Support ()
void | addConfig ()
| Add any special config values to the system. More...
bool | checkExtension (const String &ext) const
| Check if an extension is available. More...
ConfigOptionMap & | getConfigOptions (void)
unsigned int | getDisplayMonitorCount () const
| Gets the number of display monitors. More...
const String & | getGLVendor (void) const
| Get vendor information. More...
const DriverVersion & | getGLVersion (void) const
| Get version information. More...
void * | getProcAddress (const char *procname)
| Get the address of a function. More...
const String & | getShaderCachePath (void) const
| Get shader cache path. More...
const String & | getShaderLibraryPath (void) const
| Get shader library path. More...
bool | hasMinGLVersion (int major, int minor) const
| Check if GL Version is supported. More...
void | initialiseExtensions ()
| Initialises GL extensions, must be done AFTER the GL context has been established. More...
RenderWindow * | newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
| Creates a new rendering window. More...
NameValuePairList | parseOptions (uint &w, uint &h, bool &fullscreen)
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 | start ()
| Start anything special. More...
void | stop ()
| Stop anything special. More...
String | validateConfig ()
| Make sure all the extra options are valid. More...

## Constructor & Destructor Documentation

## ◆ GLES2Support()

Ogre::GLES2Support::GLES2Support | ( | GLNativeSupport * | native | ) |
| inline

## ◆ ~GLES2Support()

virtual Ogre::GLES2Support::~GLES2Support | ( |  | ) |
| inline virtual

## Member Function Documentation

## ◆ addConfig()

void Ogre::GLES2Support::addConfig | ( |  | ) |
| inline

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

## ◆ setConfigOption()

void Ogre::GLES2Support::setConfigOption | ( | const String & | name,
|  | const String & | value
| ) |  |
| inline

## ◆ validateConfig()

String Ogre::GLES2Support::validateConfig | ( |  | ) |
| inline

Make sure all the extra options are valid.

Returns
  string with error message

## ◆ getConfigOptions()

ConfigOptionMap& Ogre::GLES2Support::getConfigOptions | ( | void |  | ) |
| inline

## ◆ parseOptions()

NameValuePairList Ogre::GLES2Support::parseOptions | ( | uint & | w,
|  | uint & | h,
|  | bool & | fullscreen
| ) |  |
| inline

## ◆ newWindow()

RenderWindow* Ogre::GLES2Support::newWindow | ( | const String & | name,
|  | unsigned int | width,
|  | unsigned int | height,
|  | bool | fullScreen,
|  | const NameValuePairList * | miscParams = `0`
| ) |  |
| inline

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 |
  left | Positive integers | Centred | Screen x coordinate from left |
  top | Positive integers | Centred | Screen y coordinate from left |
  border | none, fixed, resize | resize | The type of window border (in windowed mode) |
  hidden | true, false | false | hide the created window |
  FSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Full screen antialiasing factor |
  gamma | true, false | false | Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. |
  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. |
  Full Screen | true, false | false | Specify whether to create the window in full screen mode |
  displayFrequency | Refresh rate in Hertz (e.g. 60, 75, 100) | Desktop vsync rate | Display frequency rate, for fullscreen mode |
  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 |
  externalWindowHandle | Win32: HWND as integer GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) OS X Cocoa: OgreGLView address as an integer. You can pass NSView or NSWindow too, but should perform OgreGLView callbacks into the Ogre manually. OS X Carbon: WindowRef 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
  currentGLContext | true, false | false | Use an externally created GL context. (Must be current) | OpenGL Specific
  minColourBufferSize | Positive integer (usually 16, 32) | 16 | Min total colour buffer size. See EGL_BUFFER_SIZE | OpenGL Specific
  colourDepth | 16, 32 | Desktop depth | Colour depth of the resulting rendering window; only applies if fullScreen | Win32 Specific
  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 | Win32 Specific
  outerDimensions | true, false | false | Whether the width/height is expressed as the size of the outer window, rather than the content area | Win32 Specific
  monitorIndex |  | -1 |  | Win 32 Specific
  monitorHandle |  | 0 (none) |  | Win 32 Specific (OpenGL)
  enableDoubleClick | true, false | false | Enable the window to keep track and transmit double click messages. | Win32 Specific
  useNVPerfHUD | true, false | false | Enable the use of nVidia NVPerfHUD | DirectX Specific
  depthBuffer | true, false | true | Use depth buffer | DirectX9 Specific
  NSOpenGLCPSurfaceOrder | -1 or 1 | 1 | NSOpenGLCPSurfaceOrder | 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
  MSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Full screen antialiasing factor | Android Specific
  CSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Coverage sampling factor | Android Specific
  maxColourBufferSize | Positive integer (usually 16, 32) | 32 | Max EGL_BUFFER_SIZE | Android Specific
  maxStencilBufferSize | Positive integer (usually 0, 8) | 0 | EGL_STENCIL_SIZE | Android Specific
  maxDepthBufferSize | Positive integer (usually 0, 16, 24) | 16 | EGL_DEPTH_SIZE | Android Specific

## ◆ getGLVendor()

const String& Ogre::GLES2Support::getGLVendor | ( | void |  | ) | const
| inline

Get vendor information.

## ◆ getGLVersion()

const DriverVersion& Ogre::GLES2Support::getGLVersion | ( | void |  | ) | const
| inline

Get version information.

## ◆ getShaderCachePath()

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

Get shader cache path.

## ◆ getShaderLibraryPath()

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

Get shader library path.

## ◆ setShaderCachePath()

void Ogre::GLES2Support::setShaderCachePath | ( | String | path | ) |
| inline

Set shader cache path.

## ◆ setShaderLibraryPath()

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

Set shader library path.

## ◆ hasMinGLVersion()

bool Ogre::GLES2Support::hasMinGLVersion | ( | int | major,
|  | int | minor
| ) |  | const

Check if GL Version is supported.

## ◆ getProcAddress()

void* Ogre::GLES2Support::getProcAddress | ( | const char * | procname | ) |
| inline

Get the address of a function.

## ◆ initialiseExtensions()

void Ogre::GLES2Support::initialiseExtensions | ( |  | ) |

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

## ◆ checkExtension()

bool Ogre::GLES2Support::checkExtension | ( | const String & | ext | ) | const

Check if an extension is available.

## ◆ getDisplayMonitorCount()

unsigned int Ogre::GLES2Support::getDisplayMonitorCount | ( |  | ) | const
| inline

Gets the number of display monitors.

See also
  Root::getDisplayMonitorCount

## ◆ start()

void Ogre::GLES2Support::start | ( |  | ) |
| inline

Start anything special.

## ◆ stop()

void Ogre::GLES2Support::stop | ( |  | ) |
| inline

Stop anything special.

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

- OgreGLES2Support.h