OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
Ogre::GLES2Support Class Referenceabstract

#include <OgreGLES2Support.h>

Inheritance diagram for Ogre::GLES2Support:

Public Member Functions

 GLES2Support ()
virtual ~GLES2Support ()
virtual void addConfig ()=0
 Add any special config values to the system.
virtual bool checkExtension (const String &ext) const
 Check if an extension is available.
virtual RenderWindow * createWindow (bool autoCreateWindow, GLES2RenderSystem *renderSystem, const String &windowTitle)=0
virtual ConfigOptionMapgetConfigOptions ()
virtual unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors.
const StringgetGLVendor () const
 Get vendor information.
const DriverVersiongetGLVersion () const
 Get version information.
virtual void * getProcAddress (const char *procname) const =0
 Get the address of a function.
const StringgetShaderCachePath () const
 Get shader cache path.
const StringgetShaderLibraryPath () const
 Get shader library path.
bool hasMinGLVersion (int major, int minor) const
 Check if GL Version is supported.
virtual void initialiseExtensions ()
 Initialises GL extensions, must be done AFTER the GL context has been established.
virtual RenderWindow * newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0
 Creates a new rendering window.
virtual void setConfigOption (const String &name, const String &value)
void setShaderCachePath (String path)
 Set shader cache path.
void setShaderLibraryPath (String path)
 Set shader library path.
virtual void start ()=0
 Start anything special.
virtual void stop ()=0
 Stop anything special.
virtual String validateConfig ()=0
 Make sure all the extra options are valid.

Constructor & Destructor Documentation

◆ GLES2Support()

Ogre::GLES2Support::GLES2Support ( )
inline

◆ ~GLES2Support()

virtual Ogre::GLES2Support::~GLES2Support ( )
inlinevirtual

Member Function Documentation

◆ addConfig()

virtual void Ogre::GLES2Support::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

Implemented in Ogre::EGLSupport.

◆ checkExtension()

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

Check if an extension is available.

◆ createWindow()

virtual RenderWindow * Ogre::GLES2Support::createWindow ( bool autoCreateWindow,
GLES2RenderSystem * renderSystem,
const String & windowTitle )
pure virtual

Implemented in Ogre::EGLSupport.

◆ getConfigOptions()

virtual ConfigOptionMap & Ogre::GLES2Support::getConfigOptions ( )
virtual

◆ getDisplayMonitorCount()

virtual unsigned int Ogre::GLES2Support::getDisplayMonitorCount ( ) const
inlinevirtual

Gets the number of display monitors.

See also
Root::getDisplayMonitorCount

◆ getGLVendor()

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

Get vendor information.

◆ getGLVersion()

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

Get version information.

◆ getProcAddress()

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

Get the address of a function.

Implemented in Ogre::EGLSupport.

◆ getShaderCachePath()

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

Get shader cache path.

◆ getShaderLibraryPath()

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

Get shader library path.

◆ hasMinGLVersion()

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

Check if GL Version is supported.

◆ initialiseExtensions()

virtual void Ogre::GLES2Support::initialiseExtensions ( )
virtual

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

◆ newWindow()

virtual RenderWindow * Ogre::GLES2Support::newWindow ( const String & name,
unsigned int width,
unsigned int height,
bool fullScreen,
const NameValuePairList * miscParams = 0 )
pure 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:
KeyType/ValuesDefaultDescriptionNotes
titleAny stringRenderTarget nameThe title of the window that will appear in the title bar 
colourDepth16, 32Desktop depthColour depth of the resulting rendering window; only applies if fullScreenWin32 Specific
leftPositive integersCentredScreen x coordinate from left 
topPositive integersCentredScreen y coordinate from left 
depthBuffertrue, falsetrueUse depth bufferDirectX9 specific
externalWindowHandleWin32: 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. iOS: UIWindow address as an integer
0 (none)External window handle, for embedding the OGRE render in an existing window 
externalGLControltrue, falsefalseLet 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
externalGLContextContext as Unsigned Long0 (create own context)Use an externally created GL contextOpenGL Specific
parentWindowHandleWin32: 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 
contentScalingFactorPositive Float greater than 1.0The default content scaling factor of the screenSpecifies 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 
externalViewHandleUIView pointer as an integer0External view handle, for rendering OGRE render in an existing viewiOS Specific 
externalViewControllerHandleUIViewController pointer as an integer0External view controller handle, for embedding OGRE in an existing view controlleriOS Specific 
externalSharegroupEAGLSharegroup pointer as an integer0External sharegroup, used to shared GL resources between contextsiOS Specific 
Full Screentrue, falsefalseSpecify whether to create the window in full screen modeOS X Specific 
MSAAPositive integer (usually 1, 2, 4, 8, 16)1Multisample antialiasing factor 
MSAA_QualityDepends on RenderSystem and hardware. Currently supports:
0 ... infinite number (depends on HW)
BlankFull screen antialiasing hint 
displayFrequencyRefresh rate in Hertz (e.g. 60, 75, 100)Desktop vsync rateDisplay frequency rate, for fullscreen mode 
vsynctrue, falsefalseSynchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate 
vsyncInterval1, 2, 3, 41If 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. 
bordernone, fixed, resizeresizeThe type of window border (in windowed mode) 
outerDimensionstrue, falsefalseWhether the width/height is expressed as the size of the outer window, rather than the content area 
useNVPerfHUDtrue, falsefalseEnable the use of nVidia NVPerfHUD 
gammatrue, falsefalseEnable hardware conversion from linear colour space to gamma colour space on rendering to the window. 
enableDoubleClicktrue, falsefalseEnable the window to keep track and transmit double click messages.Win32 Specific
MSAAPositive integer (usually 0, 2, 4, 8, 16)0Full screen antialiasing factorAndroid Specific
CSAAPositive integer (usually 0, 2, 4, 8, 16)0Coverage sampling factor (https://www.khronos.org/registry/egl/extensions/NV/EGL_NV_coverage_sample.txt)Android Specific
maxColourBufferSizePositive integer (usually 16, 32)32Max EGL_BUFFER_SIZEAndroid Specific
minColourBufferSizePositive integer (usually 16, 32)16Min EGL_BUFFER_SIZEAndroid Specific
maxStencilBufferSizePositive integer (usually 0, 8)0EGL_STENCIL_SIZEAndroid Specific
maxDepthBufferSizePositive integer (usually 0, 16, 24)16EGL_DEPTH_SIZEAndroid Specific
"/startdir/src/ogre-next-3.0.0/RenderSystems/GLES2/include/OgreGLES2Support.h"

Implemented in Ogre::AndroidEGLSupport, Ogre::EmscriptenEGLSupport, Ogre::Win32EGLSupport, and Ogre::X11EGLSupport.

◆ setConfigOption()

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

Reimplemented in Ogre::EGLSupport.

◆ setShaderCachePath()

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

Set shader cache path.

◆ setShaderLibraryPath()

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

Set shader library path.

◆ start()

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

Start anything special.

Implemented in Ogre::EGLSupport.

◆ stop()

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

Stop anything special.

Implemented in Ogre::EGLSupport.

◆ validateConfig()

virtual String Ogre::GLES2Support::validateConfig ( )
pure virtual

Make sure all the extra options are valid.

Returns
string with error message

Implemented in Ogre::EGLSupport.


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