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

provides OpenGL Context creation using GLX, WGL, EGL, Cocoa More...

#include <OgreGLNativeSupport.h>

Public Types

enum  ContextProfile { CONTEXT_CORE = 1 , CONTEXT_COMPATIBILITY = 2 , CONTEXT_ES = 4 }
typedef std::set< StringExtensionList

Public Member Functions

 GLNativeSupport (int profile)
virtual ~GLNativeSupport ()
bool checkExtension (const String &ext) const
virtual GLPBuffercreatePBuffer (PixelComponentType format, size_t width, size_t height)
virtual ConfigOptionMap getConfigOptions ()
 Add any special config values to the system. More...
ContextProfile getContextProfile () const
const std::vector< int > & getFSAALevels () const
virtual void * getProcAddress (const char *procname) const =0
 Get the address of a function. More...
const VideoModesgetVideoModes () const
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 void start ()=0
 Start anything special. More...
virtual void stop ()=0
 Stop anything special. More...

Detailed Description

provides OpenGL Context creation using GLX, WGL, EGL, Cocoa

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

◆ 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 Platform
title 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
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
border none, fixed, resize resize The type of window border (in windowed mode) Windows, OSX
displayFrequency Refresh rate in Hertz (e.g. 60, 75, 100) Desktop vsync rate Display frequency rate, for fullscreen mode
  • Win32: HWND as int
  • Linux: X11 Window as ulong
  • OSX: OgreGLView address as an integer. You can pass NSView or NSWindow too, but should perform OgreGLView callbacks into the Ogre manually
  • iOS: UIWindow address as an integer
  • Emscripten: canvas selector String ("#canvas")
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
currentGLContext true, false false Use an externally created GL context. (Must be current) OpenGL
minColourBufferSize Positive integer (usually 16, 32) 16 Min total colour buffer size. See EGL_BUFFER_SIZE OpenGL
windowProc WNDPROC DefWindowProc function that processes window messages Win 32
colourDepth 16, 32 Desktop depth Colour depth of the resulting rendering window; only applies if fullScreen Win32
FSAAHint RenderSystem specific. Currently enables EQAA/ CSAA mode on D3D: if you want 4f8x (8x CSAA), set FSAA=4 and this to "f8" Blank FSAA mode hint D3D
outerDimensions true, false false Whether the width/height is expressed as the size of the outer window, rather than the content area Win32
monitorIndex -1 Win 32
monitorHandle 0 (none) Win 32 (OpenGL)
enableDoubleClick true, false false Enable the window to keep track and transmit double click messages. Win32
useNVPerfHUD true, false false Enable the use of nVidia NVPerfHUD D3D
depthBuffer true, false true Use depth buffer D3D
NSOpenGLCPSurfaceOrder -1 or 1 1 NSOpenGLCPSurfaceOrder OSX
contentScalingFactor Positive Float The default content scaling factor of the screen On IOS specifies the CAEAGLLayer content scaling factor. 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. OSX, iOS, Android
externalViewHandle UIView pointer as an integer 0 External view handle, for rendering OGRE render in an existing view iOS
externalViewControllerHandle UIViewController pointer as an integer 0 External view controller handle, for embedding OGRE in an existing view controller iOS
externalSharegroup EAGLSharegroup pointer as an integer 0 External sharegroup, used to shared GL resources between contexts iOS
CSAA Positive integer (usually 0, 2, 4, 8, 16) 0 Coverage sampling factor Android
maxColourBufferSize Positive integer (usually 16, 32) 32 Max EGL_BUFFER_SIZE Android
maxStencilBufferSize Positive integer (usually 0, 8) 0 EGL_STENCIL_SIZE Android
maxDepthBufferSize Positive integer (usually 0, 16, 24) 16 EGL_DEPTH_SIZE Android

◆ createPBuffer()

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

◆ getProcAddress()

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

Get the address of a function.

◆ checkExtension()

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

◆ start()

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

Start anything special.

◆ stop()

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

Stop anything special.

◆ getConfigOptions()

virtual ConfigOptionMap Ogre::GLNativeSupport::getConfigOptions ( )

Add any special config values to the system.

◆ getFSAALevels()

const std::vector<int>& Ogre::GLNativeSupport::getFSAALevels ( ) const

◆ getVideoModes()

const VideoModes& Ogre::GLNativeSupport::getVideoModes ( ) const

◆ getContextProfile()

ContextProfile Ogre::GLNativeSupport::getContextProfile ( ) const

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