GL support in a GTK window. More...

#include <OgreGTKGLSupport.h>

Inheritance diagram for Ogre::GTKGLSupport:

Public Member Functions
	GTKGLSupport ()

void	addConfig ()
	Add any special config values to the system.

void	begin_context (RenderTarget *_target=0)

bool	checkExtension (const String &ext) const
	Check if an extension is available.

bool	checkMinGLVersion (const String &v) const

RenderWindow *	createWindow (bool autoCreateWindow, GL3PlusRenderSystem *renderSystem, const String &windowTitle)

void	end_context ()

virtual ConfigOptionMap &	getConfigOptions (void)

virtual unsigned int	getDisplayMonitorCount () const
	Gets the number of display monitors.

const String &	getGLVendor (void) const
	Get vendor information.

const DriverVersion &	getGLVersion (void) const
	Get version information.

Glib::RefPtr< const Gdk::GL::Context >	getMainContext () const

void *	getProcAddress (const char *procname) const
	Get the address of a function.

const String &	getShaderCachePath (void) const
	Get shader cache path.

const String &	getShaderLibraryPath (void) const
	Get shader library path.

bool	hasMinGLVersion (int major, int minor) const
	Check if GL Version is supported.

void	initialiseExtensions (void)
	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.

RenderWindow *	newWindow (const String &name, unsigned int width, unsigned int height, unsigned int colourDepth, bool fullScreen, int left, int top, bool depthBuffer, RenderWindow *parentWindowHandle, bool vsync)

virtual void	setConfigOption (const String &name, const String &value)

void	setConfigOptions (const String &name, const String &value)

void	setShaderCachePath (String path)
	Set shader cache path.

void	setShaderLibraryPath (String path)
	Set shader library path.

void	start ()
	Start anything special.

void	stop ()
	Stop anything special.

String	validateConfig ()
	Make sure all the extra options are valid.

Static Public Member Functions
static GTKGLSupport &	getSingleton (void)
	Override standard Singleton retrieval.

static GTKGLSupport *	getSingletonPtr (void)
	Override standard Singleton retrieval.

Detailed Description

GL support in a GTK window.

I made this a Singleton, so that the main context can be queried by GTKWindows.

Constructor & Destructor Documentation

◆ GTKGLSupport()

Ogre::GTKGLSupport::GTKGLSupport ( )

Member Function Documentation

◆ addConfig()

void Ogre::GTKGLSupport::addConfig ( )

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

Implements Ogre::GL3PlusSupport.

◆ begin_context()

void Ogre::GTKGLSupport::begin_context ( RenderTarget * _target = 0 )

◆ checkExtension()

bool Ogre::GTKGLSupport::checkExtension ( const String & ext ) const

virtual

Check if an extension is available.

Reimplemented from Ogre::GL3PlusSupport.

◆ checkMinGLVersion()

bool Ogre::GTKGLSupport::checkMinGLVersion ( const String & v ) const

◆ createWindow()

RenderWindow * Ogre::GTKGLSupport::createWindow	(	bool	autoCreateWindow,
		GL3PlusRenderSystem *	renderSystem,
		const String &	windowTitle
	)

virtual

Implements Ogre::GL3PlusSupport.

◆ end_context()

void Ogre::GTKGLSupport::end_context ( )

◆ getConfigOptions()

virtual ConfigOptionMap & Ogre::GL3PlusSupport::getConfigOptions ( void )

virtualinherited

◆ getDisplayMonitorCount()

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

inlinevirtualinherited

Gets the number of display monitors.

See also: Root::getDisplayMonitorCount

Reimplemented in Ogre::Win32GLSupport.

◆ getGLVendor()

const String & Ogre::GL3PlusSupport::getGLVendor ( void ) const

inlineinherited

Get vendor information.

◆ getGLVersion()

const DriverVersion & Ogre::GL3PlusSupport::getGLVersion ( void ) const

inlineinherited

Get version information.

◆ getMainContext()

Glib::RefPtr< const Gdk::GL::Context > Ogre::GTKGLSupport::getMainContext ( ) const

◆ getProcAddress()

void * Ogre::GTKGLSupport::getProcAddress ( const char * procname ) const

virtual

Get the address of a function.

Implements Ogre::GL3PlusSupport.

◆ getShaderCachePath()

const String & Ogre::GL3PlusSupport::getShaderCachePath ( void ) const

inlineinherited

Get shader cache path.

◆ getShaderLibraryPath()

const String & Ogre::GL3PlusSupport::getShaderLibraryPath ( void ) const

inlineinherited

Get shader library path.

◆ getSingleton()

static GTKGLSupport & Ogre::GTKGLSupport::getSingleton ( void )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

◆ getSingletonPtr()

static GTKGLSupport * Ogre::GTKGLSupport::getSingletonPtr ( void )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

◆ hasMinGLVersion()

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

inherited

Check if GL Version is supported.

◆ initialiseExtensions()

void Ogre::GTKGLSupport::initialiseExtensions ( void )

virtual

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

Reimplemented from Ogre::GL3PlusSupport.

◆ newWindow() [1/2]

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

pure virtualinherited

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 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
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
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
Full Screen	true, false	false	Specify whether to create the window in full screen mode	OS X 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
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 (https://www.khronos.org/registry/egl/extensions/NV/EGL_NV_coverage_sample.txt)	Android Specific
maxColourBufferSize	Positive integer (usually 16, 32)	32	Max EGL_BUFFER_SIZE	Android Specific
minColourBufferSize	Positive integer (usually 16, 32)	16	Min 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

Implemented in Ogre::GLXGLSupport, Ogre::OSXGL3PlusSupport, Ogre::SDLGLSupport, and Ogre::Win32GLSupport.

◆ newWindow() [2/2]

RenderWindow * Ogre::GTKGLSupport::newWindow	(	const String &	name,
		unsigned int	width,
		unsigned int	height,
		unsigned int	colourDepth,
		bool	fullScreen,
		int	left,
		int	top,
		bool	depthBuffer,
		RenderWindow *	parentWindowHandle,
		bool	vsync
	)

◆ setConfigOption()

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

virtualinherited

Reimplemented in Ogre::GLXGLSupport, and Ogre::Win32GLSupport.

◆ setConfigOptions()

void Ogre::GTKGLSupport::setConfigOptions	(	const String &	name,
		const String &	value
	)

◆ setShaderCachePath()

void Ogre::GL3PlusSupport::setShaderCachePath ( String path )

inlineinherited

Set shader cache path.

◆ setShaderLibraryPath()

void Ogre::GL3PlusSupport::setShaderLibraryPath ( String path )

inlineinherited

Set shader library path.

◆ start()

void Ogre::GTKGLSupport::start ( )

virtual

Start anything special.

Implements Ogre::GL3PlusSupport.

◆ stop()

void Ogre::GTKGLSupport::stop ( )

virtual

Stop anything special.

Implements Ogre::GL3PlusSupport.

◆ validateConfig()

String Ogre::GTKGLSupport::validateConfig ( )

virtual

Make sure all the extra options are valid.

Returns: string with error message

Implements Ogre::GL3PlusSupport.

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

OgreGTKGLSupport.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GTKGLSupport()

Member Function Documentation

◆ addConfig()

◆ begin_context()

◆ checkExtension()

◆ checkMinGLVersion()

◆ createWindow()

◆ end_context()

◆ getConfigOptions()

◆ getDisplayMonitorCount()

◆ getGLVendor()

◆ getGLVersion()

◆ getMainContext()

◆ getProcAddress()

◆ getShaderCachePath()

◆ getShaderLibraryPath()

◆ getSingleton()

◆ getSingletonPtr()

◆ hasMinGLVersion()

◆ initialiseExtensions()

◆ newWindow() [1/2]

◆ newWindow() [2/2]

◆ setConfigOption()

◆ setConfigOptions()

◆ setShaderCachePath()

◆ setShaderLibraryPath()

◆ start()

◆ stop()

◆ validateConfig()