OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::GLNativeSupport Class Referenceabstract

#include <OgreGLNativeSupport.h>

Public Types

enum  ContextProfile { CONTEXT_CORE = 1, CONTEXT_COMPATIBILITY = 2, CONTEXT_ES = 4 }
typedef set< String >::type ExtensionList

Public Member Functions

 GLNativeSupport (int profile)
virtual ~GLNativeSupport ()
virtual void addConfig ()=0
 Add any special config values to the system. More...
bool checkExtension (const String &ext) const
virtual GLPBuffercreatePBuffer (PixelComponentType format, size_t width, size_t height)
ConfigOptionMapgetConfigOptions ()
virtual unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors. More...
virtual void * getProcAddress (const char *procname)=0
 Get the address of a function. More...
virtual RenderWindownewWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0
 Creates a new rendering window. More...
virtual NameValuePairList parseOptions (uint &w, uint &h, bool &fullscreen)=0
virtual void setConfigOption (const String &name, const String &value)
virtual void start ()=0
 Start anything special. More...
virtual void stop ()=0
 Stop anything special. More...
virtual String validateConfig ()
 Make sure all the extra options are valid. More...

Member Typedef Documentation

◆ ExtensionList

Member Enumeration Documentation

◆ ContextProfile


Constructor & Destructor Documentation

◆ GLNativeSupport()

Ogre::GLNativeSupport::GLNativeSupport ( int  profile)

◆ ~GLNativeSupport()

virtual Ogre::GLNativeSupport::~GLNativeSupport ( )

Member Function Documentation

◆ addConfig()

virtual void Ogre::GLNativeSupport::addConfig ( )
pure 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

◆ setConfigOption()

virtual void Ogre::GLNativeSupport::setConfigOption ( const String name,
const String value 

◆ validateConfig()

virtual String Ogre::GLNativeSupport::validateConfig ( )

Make sure all the extra options are valid.

string with error message

◆ parseOptions()

virtual NameValuePairList Ogre::GLNativeSupport::parseOptions ( uint w,
uint h,
bool &  fullscreen 
pure virtual

◆ newWindow()

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

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
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
  • 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
  • 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
macAPI String: "cocoa" or "carbon" "carbon" Specifies the type of rendering window on the Mac Platform. Mac OS X 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

◆ createPBuffer()

virtual GLPBuffer* Ogre::GLNativeSupport::createPBuffer ( PixelComponentType  format,
size_t  width,
size_t  height 

◆ getProcAddress()

virtual void* Ogre::GLNativeSupport::getProcAddress ( const char *  procname)
pure virtual

Get the address of a function.

◆ checkExtension()

bool Ogre::GLNativeSupport::checkExtension ( const String ext) const

◆ getDisplayMonitorCount()

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

Gets the number of display monitors.

See also

◆ start()

virtual void Ogre::GLNativeSupport::start ( )
pure virtual

Start anything special.

◆ stop()

virtual void Ogre::GLNativeSupport::stop ( )
pure virtual

Stop anything special.

◆ getConfigOptions()

ConfigOptionMap& Ogre::GLNativeSupport::getConfigOptions ( )

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