#include <OgreGLXGLSupport.h>

Inheritance diagram for Ogre::GLXGLSupport:

Public Member Functions
	GLXGLSupport ()
	GLXGLSupport ()
	~GLXGLSupport ()
	~GLXGLSupport ()
void	addConfig (void)
void	addConfig (void)
virtual bool	checkExtension (const String &ext) const
	Check if an extension is available.
virtual bool	checkExtension (const String &ext) const
	Check if an extension is available.
bool	checkMinGLVersion (const String &v) const
	Compare GL version numbers.
bool	checkMinGLVersion (const String &v) const
	Compare GL version numbers.
GLXFBConfig *	chooseFBConfig (const GLint attribList, GLint nElements)
	Portable replacement for glXChooseFBConfig.
GLXFBConfig *	chooseFBConfig (const GLint attribList, GLint nElements)
	Portable replacement for glXChooseFBConfig.
::GLXContext	createNewContext (GLXFBConfig fbConfig, GLint renderType,::GLXContext shareList, GLboolean direct) const
	Portable replacement for glXCreateNewContext.
::GLXContext	createNewContext (GLXFBConfig fbConfig, GLint renderType,::GLXContext shareList, GLboolean direct) const
	Portable replacement for glXCreateNewContext.
GLPBuffer *	createPBuffer (PixelComponentType format, size_t width, size_t height)
RenderWindow *	createWindow (bool autoCreateWindow, GLRenderSystem *renderSystem, const String &windowTitle)
RenderWindow *	createWindow (bool autoCreateWindow, GL3PlusRenderSystem *renderSystem, const String &windowTitle)
virtual ConfigOptionMap &	getConfigOptions (void)
virtual ConfigOptionMap &	getConfigOptions (void)
virtual unsigned int	getDisplayMonitorCount () const
virtual unsigned int	getDisplayMonitorCount () const
String	getDisplayName (void)
	Get the name of the display and screen used for rendering.
String	getDisplayName (void)
	Get the name of the display and screen used for rendering.
GLint	getFBConfigAttrib (GLXFBConfig fbConfig, GLint attribute, GLint *value)
	Portable replacement for glXGetFBConfigAttrib.
GLint	getFBConfigAttrib (GLXFBConfig fbConfig, GLint attribute, GLint *value)
	Portable replacement for glXGetFBConfigAttrib.
GLXFBConfig	getFBConfigFromContext (::GLXContext context)
	Get the GLXFBConfig used to create a GLXContext.
GLXFBConfig	getFBConfigFromContext (::GLXContext context)
	Get the GLXFBConfig used to create a ::GLXContext.
GLXFBConfig	getFBConfigFromDrawable (GLXDrawable drawable, unsigned int width, unsigned int height)
	Get the GLXFBConfig used to create a GLXDrawable.
GLXFBConfig	getFBConfigFromDrawable (GLXDrawable drawable, unsigned int width, unsigned int height)
	Get the GLXFBConfig used to create a GLXDrawable.
GLXFBConfig	getFBConfigFromVisualID (VisualID visualid)
	Gets a GLXFBConfig compatible with a VisualID.
GLXFBConfig	getFBConfigFromVisualID (VisualID visualid)
	Gets a GLXFBConfig compatible with a VisualID.
Display *	getGLDisplay (void)
	Get the Display connection used for rendering.
Display *	getGLDisplay (void)
	Get the Display connection used for rendering.
const String &	getGLVendor (void) const
	Get vendor information.
const String &	getGLVendor (void) const
	Get vendor information.
const String &	getGLVersion (void) const
	Get version information.
const String &	getGLVersion (void) const
	Get version information.
void *	getProcAddress (const String &procname)
void *	getProcAddress (const String &procname)
const String &	getShaderCachePath (void) const
	Get shader cache path.
const String &	getShaderLibraryPath (void) const
	Get shader library path.
GLStateCacheManager *	getStateCacheManager () const
XVisualInfo *	getVisualFromFBConfig (GLXFBConfig fbConfig)
	Portable replacement for glXGetVisualFromFBConfig.
XVisualInfo *	getVisualFromFBConfig (GLXFBConfig fbConfig)
	Portable replacement for glXGetVisualFromFBConfig.
Display *	getXDisplay (void)
	Get the Display connection used for window management & events.
Display *	getXDisplay (void)
	Get the Display connection used for window management & events.
void	initialiseExtensions ()
void	initialiseExtensions ()
bool	loadIcon (const String &name, Pixmap pix, Pixmap mask)
	Loads an icon from an Ogre resource into the X Server.
bool	loadIcon (const String &name, Pixmap pix, Pixmap mask)
	Loads an icon from an Ogre resource into the X Server.
RenderWindow *	newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
RenderWindow *	newWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
GLXFBConfig	selectFBConfig (const int minAttribs, const int maxAttribs)
	Select an FBConfig given a list of required and a list of desired properties.
GLXFBConfig	selectFBConfig (const int minAttribs, const int maxAttribs)
	Select an FBConfig given a list of required and a list of desired properties.
void	setConfigOption (const String &name, const String &value)
void	setConfigOption (const String &name, const String &value)
void	setShaderCachePath (String path)
	Set shader cache path.
void	setShaderLibraryPath (String path)
	Set shader library path.
void	setStateCacheManager (GLStateCacheManager *stateCacheMgr)
void	start ()
void	start ()
void	stop ()
void	stop ()
virtual bool	supportsPBuffers ()
void	switchMode (uint &width, uint &height, short &frequency)
	Switch video modes.
void	switchMode (void)
	Switch back to original video mode.
void	switchMode (uint &width, uint &height, short &frequency)
	Switch video modes.
void	switchMode (void)
	Switch back to original video mode.
String	validateConfig (void)
String	validateConfig (void)
Public Attributes
Atom	mAtomDeleteWindow
Atom	mAtomFullScreen
Atom	mAtomState
Protected Attributes
set< String >::type	extensionList
set< String >::type	extensionList
ConfigOptionMap	mOptions
ConfigOptionMap	mOptions
Private Types
typedef short	Rate
typedef short	Rate
typedef std::pair< uint, uint >	ScreenSize
typedef std::pair< uint, uint >	ScreenSize
typedef std::pair< ScreenSize, Rate >	VideoMode
typedef std::pair< ScreenSize, Rate >	VideoMode
typedef std::vector< VideoMode >	VideoModes
typedef std::vector< VideoMode >	VideoModes
Private Member Functions
void	initialiseGLXEW (void)
	Initialise GLXEW without requiring a current GL context.
void	refreshConfig (void)
	Refresh config options to reflect dependencies.
void	refreshConfig (void)
	Refresh config options to reflect dependencies.
Private Attributes
VideoMode	mCurrentMode
Display *	mGLDisplay
bool	mIsExternalDisplay
VideoMode	mOriginalMode
StringVector	mSampleLevels
VideoModes	mVideoModes
Display *	mXDisplay

Detailed Description

Definition at line 11 of file include/GLX/OgreGLXGLSupport.h.

Member Typedef Documentation

typedef short Ogre::GLXGLSupport::Rate [private]

Definition at line 187 of file include/GLX/OgreGLXGLSupport.h.

typedef short Ogre::GLXGLSupport::Rate [private]

Definition at line 205 of file Plus/include/GLX/OgreGLXGLSupport.h.

typedef std::pair<uint, uint> Ogre::GLXGLSupport::ScreenSize [private]

Definition at line 186 of file include/GLX/OgreGLXGLSupport.h.

typedef std::pair<uint, uint> Ogre::GLXGLSupport::ScreenSize [private]

Definition at line 204 of file Plus/include/GLX/OgreGLXGLSupport.h.

typedef std::pair<ScreenSize, Rate> Ogre::GLXGLSupport::VideoMode [private]

Definition at line 188 of file include/GLX/OgreGLXGLSupport.h.

typedef std::pair<ScreenSize, Rate> Ogre::GLXGLSupport::VideoMode [private]

Definition at line 206 of file Plus/include/GLX/OgreGLXGLSupport.h.

typedef std::vector<VideoMode> Ogre::GLXGLSupport::VideoModes [private]

Definition at line 189 of file include/GLX/OgreGLXGLSupport.h.

typedef std::vector<VideoMode> Ogre::GLXGLSupport::VideoModes [private]

Definition at line 207 of file Plus/include/GLX/OgreGLXGLSupport.h.

Constructor & Destructor Documentation

Ogre::GLXGLSupport::GLXGLSupport ( )

Ogre::GLXGLSupport::~GLXGLSupport ( )

Ogre::GLXGLSupport::GLXGLSupport ( )

Ogre::GLXGLSupport::~GLXGLSupport ( )

Member Function Documentation

void Ogre::GLXGLSupport::addConfig ( void ) [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::GLSupport.

void Ogre::GLXGLSupport::addConfig ( void ) [virtual]

GL3PlusSupport::addConfig

Implements Ogre::GLSupport.

virtual bool Ogre::GLSupport::checkExtension ( const String & ext ) const [virtual, inherited]

Check if an extension is available.

Reimplemented in Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

virtual bool Ogre::GL3PlusSupport::checkExtension ( const String & ext ) const [virtual, inherited]

Check if an extension is available.

Reimplemented in Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

bool Ogre::GLSupport::checkMinGLVersion ( const String & v ) const [inherited]

Compare GL version numbers.

Reimplemented in Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

bool Ogre::GL3PlusSupport::checkMinGLVersion ( const String & v ) const [inherited]

Compare GL version numbers.

Reimplemented in Ogre::GTKGLSupport, and Ogre::GTKGLSupport.

GLXFBConfig* Ogre::GLXGLSupport::chooseFBConfig	(	const GLint *	attribList,
		GLint *	nElements
	)

Portable replacement for glXChooseFBConfig.

GLXFBConfig* Ogre::GLXGLSupport::chooseFBConfig	(	const GLint *	attribList,
		GLint *	nElements
	)

Portable replacement for glXChooseFBConfig.

::GLXContext Ogre::GLXGLSupport::createNewContext	(	GLXFBConfig	fbConfig,
		GLint	renderType,
		::GLXContext	shareList,
		GLboolean	direct
	)		const

Portable replacement for glXCreateNewContext.

::GLXContext Ogre::GLXGLSupport::createNewContext	(	GLXFBConfig	fbConfig,
		GLint	renderType,
		::GLXContext	shareList,
		GLboolean	direct
	)		const

Portable replacement for glXCreateNewContext.

GLPBuffer* Ogre::GLXGLSupport::createPBuffer	(	PixelComponentType	format,
		size_t	width,
		size_t	height
	)		`[virtual]`

Reimplemented from Ogre::GLSupport.

RenderWindow* Ogre::GLXGLSupport::createWindow	(	bool	autoCreateWindow,
		GLRenderSystem *	renderSystem,
		const String &	windowTitle
	)		`[virtual]`

Implements Ogre::GLSupport.

RenderWindow* Ogre::GLXGLSupport::createWindow	(	bool	autoCreateWindow,
		GL3PlusRenderSystem *	renderSystem,
		const String &	windowTitle
	)		`[virtual]`

Implements Ogre::GL3PlusSupport.

virtual ConfigOptionMap& Ogre::GL3PlusSupport::getConfigOptions ( void ) [virtual, inherited]

virtual ConfigOptionMap& Ogre::GLSupport::getConfigOptions ( void ) [virtual, inherited]

virtual unsigned int Ogre::GLSupport::getDisplayMonitorCount ( ) const [virtual, inherited]

Gets the number of display monitors.

See also:: Root::getDisplayMonitorCount

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

Definition at line 130 of file OgreGLSupport.h.

virtual unsigned int Ogre::GL3PlusSupport::getDisplayMonitorCount ( ) const [virtual, inherited]

Gets the number of display monitors.

See also:: Root::getDisplayMonitorCount

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

Definition at line 139 of file OgreGL3PlusSupport.h.

String Ogre::GLXGLSupport::getDisplayName ( void )

Get the name of the display and screen used for rendering.

Ogre normally opens its own connection to the X server and renders onto the screen where the user logged in

However, if Ogre is passed a current GL context when the first RenderTarget is created, then it will connect to the X server using the same connection as that GL context and direct all subsequent rendering to the screen targeted by that GL context.

Returns:: Display name.

String Ogre::GLXGLSupport::getDisplayName ( void )

Get the name of the display and screen used for rendering.

Ogre normally opens its own connection to the X server and renders onto the screen where the user logged in

However, if Ogre is passed a current GL context when the first RenderTarget is created, then it will connect to the X server using the same connection as that GL context and direct all subsequent rendering to the screen targeted by that GL context.

Returns:: Display name.

GLint Ogre::GLXGLSupport::getFBConfigAttrib	(	GLXFBConfig	fbConfig,
		GLint	attribute,
		GLint *	value
	)

Portable replacement for glXGetFBConfigAttrib.

GLint Ogre::GLXGLSupport::getFBConfigAttrib	(	GLXFBConfig	fbConfig,
		GLint	attribute,
		GLint *	value
	)

Portable replacement for glXGetFBConfigAttrib.

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromContext ( ::GLXContext context )

Get the GLXFBConfig used to create a GLXContext.

Parameters:

context GLXContext

Returns:: GLXFBConfig used to create the context

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromContext ( ::GLXContext context )

Get the GLXFBConfig used to create a ::GLXContext.

Parameters:

drawable GLXContext

Returns:: GLXFBConfig used to create the context

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromDrawable	(	GLXDrawable	drawable,
		unsigned int *	width,
		unsigned int *	height
	)

Get the GLXFBConfig used to create a GLXDrawable.

Caveat: GLX version 1.3 is needed when the drawable is a GLXPixmap

Parameters:

drawable	GLXDrawable
width	Receiver for the drawable width
height	Receiver for the drawable height

Returns:: GLXFBConfig used to create the drawable

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromDrawable	(	GLXDrawable	drawable,
		unsigned int *	width,
		unsigned int *	height
	)

Get the GLXFBConfig used to create a GLXDrawable.

Caveat: GLX version 1.3 is needed when the drawable is a GLXPixmap

Parameters:

drawable	GLXDrawable
width	Receiver for the drawable width
height	Receiver for the drawable height

Returns:: GLXFBConfig used to create the drawable

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromVisualID ( VisualID visualid )

Gets a GLXFBConfig compatible with a VisualID.

Some platforms fail to implement glXGetFBconfigFromVisualSGIX as part of the GLX_SGIX_fbconfig extension, but this portable alternative suffices for the creation of compatible contexts.

Parameters:

visualid VisualID

Returns:: FBConfig for VisualID

GLXFBConfig Ogre::GLXGLSupport::getFBConfigFromVisualID ( VisualID visualid )

Gets a GLXFBConfig compatible with a VisualID.

Some platforms fail to implement glXGetFBconfigFromVisualSGIX as part of the GLX_SGIX_fbconfig extension, but this portable alternative suffices for the creation of compatible contexts.

Parameters:

visualid VisualID

Returns:: FBConfig for VisualID

Display* Ogre::GLXGLSupport::getGLDisplay ( void )

Get the Display connection used for rendering.

This function establishes the initial connection when necessary.

Returns:: Display connection

Display* Ogre::GLXGLSupport::getGLDisplay ( void )

Get the Display connection used for rendering.

This function establishes the initial connection when necessary.

Returns:: Display connection

const String& Ogre::GL3PlusSupport::getGLVendor ( void ) const [inherited]

Get vendor information.

Definition at line 73 of file OgreGL3PlusSupport.h.

const String& Ogre::GLSupport::getGLVendor ( void ) const [inherited]

Get vendor information.

Definition at line 97 of file OgreGLSupport.h.

const String& Ogre::GL3PlusSupport::getGLVersion ( void ) const [inherited]

Get version information.

Definition at line 81 of file OgreGL3PlusSupport.h.

const String& Ogre::GLSupport::getGLVersion ( void ) const [inherited]

Get version information.

Definition at line 105 of file OgreGLSupport.h.

void* Ogre::GLXGLSupport::getProcAddress ( const String & procname ) [virtual]

Get the address of a function.

Implements Ogre::GLSupport.

void* Ogre::GLXGLSupport::getProcAddress ( const String & procname ) [virtual]

GL3PlusSupport::getProcAddress

Implements Ogre::GLSupport.

const String& Ogre::GL3PlusSupport::getShaderCachePath ( void ) const [inherited]

Get shader cache path.

Definition at line 89 of file OgreGL3PlusSupport.h.

const String& Ogre::GL3PlusSupport::getShaderLibraryPath ( void ) const [inherited]

Get shader library path.

Definition at line 97 of file OgreGL3PlusSupport.h.

GLStateCacheManager* Ogre::GLSupport::getStateCacheManager ( ) const [inherited]

Definition at line 75 of file OgreGLSupport.h.

XVisualInfo* Ogre::GLXGLSupport::getVisualFromFBConfig ( GLXFBConfig fbConfig )

Portable replacement for glXGetVisualFromFBConfig.

XVisualInfo* Ogre::GLXGLSupport::getVisualFromFBConfig ( GLXFBConfig fbConfig )

Portable replacement for glXGetVisualFromFBConfig.

Display* Ogre::GLXGLSupport::getXDisplay ( void )

Get the Display connection used for window management & events.

Returns:: Display connection

Display* Ogre::GLXGLSupport::getXDisplay ( void )

Get the Display connection used for window management & events.

Returns:: Display connection

void Ogre::GLXGLSupport::initialiseExtensions ( ) [virtual]

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

Reimplemented from Ogre::GLSupport.

void Ogre::GLXGLSupport::initialiseExtensions ( ) [virtual]

GL3PlusSupport::initialiseExtensions

Reimplemented from Ogre::GLSupport.

void Ogre::GLXGLSupport::initialiseGLXEW ( void ) [private]

Initialise GLXEW without requiring a current GL context.

bool Ogre::GLXGLSupport::loadIcon	(	const String &	name,
		Pixmap *	pix,
		Pixmap *	mask
	)

Loads an icon from an Ogre resource into the X Server.

This currently only works for 24 and 32 bit displays. The image must be findable by the Ogre resource system, and of format PF_A8R8G8B8.

Parameters:

name	Name of image to load
pix	Receiver for the output pixmap
mask	Receiver for the output mask (alpha bitmap)

Returns:: true on success

bool Ogre::GLXGLSupport::loadIcon	(	const String &	name,
		Pixmap *	pix,
		Pixmap *	mask
	)

Loads an icon from an Ogre resource into the X Server.

This currently only works for 24 and 32 bit displays. The image must be findable by the Ogre resource system, and of format PF_A8R8G8B8.

Parameters:

display	X display
name	Name of image to load
pix	Receiver for the output pixmap
mask	Receiver for the output mask (alpha bitmap)

Returns:: true on success

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

Implements Ogre::GLSupport.

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

Implements Ogre::GLSupport.

void Ogre::GLXGLSupport::refreshConfig ( void ) [private]

Refresh config options to reflect dependencies.

void Ogre::GLXGLSupport::refreshConfig ( void ) [private]

Refresh config options to reflect dependencies.

GLXFBConfig Ogre::GLXGLSupport::selectFBConfig	(	const int *	minAttribs,
		const int *	maxAttribs
	)

Select an FBConfig given a list of required and a list of desired properties.

Parameters:

minAttribs	FBConfig attributes that must be provided with minimum values
maxAttribs	FBConfig attributes that are desirable with maximum values

Returns:: GLXFBConfig with attributes or 0 when unsupported.

GLXFBConfig Ogre::GLXGLSupport::selectFBConfig	(	const int *	minAttribs,
		const int *	maxAttribs
	)

Select an FBConfig given a list of required and a list of desired properties.

Parameters:

minAttribs	FBConfig attributes that must be provided with minimum values
maxAttribs	FBConfig attributes that are desirable with maximum values

Returns:: GLXFBConfig with attributes or 0 when unsupported.

void Ogre::GLXGLSupport::setConfigOption	(	const String &	name,
		const String &	value
	)		`[virtual]`

Reimplemented from Ogre::GLSupport.

void Ogre::GLXGLSupport::setConfigOption	(	const String &	name,
		const String &	value
	)		`[virtual]`

GL3PlusSupport::setConfigOption

Reimplemented from Ogre::GLSupport.

void Ogre::GL3PlusSupport::setShaderCachePath ( String path ) [inherited]

Set shader cache path.

Definition at line 105 of file OgreGL3PlusSupport.h.

void Ogre::GL3PlusSupport::setShaderLibraryPath ( String path ) [inherited]

Set shader library path.

Definition at line 113 of file OgreGL3PlusSupport.h.

void Ogre::GLSupport::setStateCacheManager ( GLStateCacheManager * stateCacheMgr ) [inherited]

Definition at line 80 of file OgreGLSupport.h.

void Ogre::GLXGLSupport::start ( ) [virtual]

Start anything special.

Implements Ogre::GLSupport.

void Ogre::GLXGLSupport::start ( ) [virtual]

GL3PlusSupport::start

Implements Ogre::GLSupport.

void Ogre::GLXGLSupport::stop ( ) [virtual]

Stop anything special.

Implements Ogre::GLSupport.

void Ogre::GLXGLSupport::stop ( ) [virtual]

GL3PlusSupport::stop

Implements Ogre::GLSupport.

virtual bool Ogre::GLSupport::supportsPBuffers ( ) [virtual, inherited]

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

void Ogre::GLXGLSupport::switchMode	(	uint &	width,
		uint &	height,
		short &	frequency
	)

Switch video modes.

Parameters:

width	Receiver for requested and final width
height	Receiver for requested and final drawable height
frequency	Receiver for requested and final drawable frequency

void Ogre::GLXGLSupport::switchMode ( void )

Switch back to original video mode.

void Ogre::GLXGLSupport::switchMode	(	uint &	width,
		uint &	height,
		short &	frequency
	)

Switch video modes.

Parameters:

width	Receiver for requested and final width
height	Receiver for requested and final drawable height
height	Receiver for requested and final drawable frequency

void Ogre::GLXGLSupport::switchMode ( void )

Switch back to original video mode.

String Ogre::GLXGLSupport::validateConfig ( void ) [virtual]

Make sure all the extra options are valid.