OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ogre::GtkEGLSupport Class Reference

#include <OgreGtkEGLSupport.h>

+ Inheritance diagram for Ogre::GtkEGLSupport:
+ Collaboration diagram for Ogre::GtkEGLSupport:

Public Member Functions

 GtkEGLSupport ()
 
virtual ~GtkEGLSupport ()
 
void addConfig (void)
 Add any special config values to the system. More...
 
virtual bool checkExtension (const String &ext) const
 Check if an extension is available. More...
 
EGLConfig * chooseGLConfig (const EGLint *attribList, EGLint *nElements)
 
::EGLContext createNewContext (EGLDisplay eglDisplay,::EGLConfig glconfig,::EGLContext shareList) const
 
virtual GLESPBuffercreatePBuffer (PixelComponentType format, size_t width, size_t height)
 
RenderWindowcreateWindow (bool autoCreateWindow, GLESRenderSystem *renderSystem, const String &windowTitle)
 
virtual ConfigOptionMapgetConfigOptions (void)
 
virtual unsigned int getDisplayMonitorCount () const
 
String getDisplayName (void)
 
EGLBoolean getGLConfigAttrib (EGLConfig fbConfig, EGLint attribute, EGLint *value)
 
::EGLConfig getGLConfigFromContext (::EGLContext context)
 
::EGLConfig getGLConfigFromDrawable (::EGLSurface drawable, unsigned int *w, unsigned int *h)
 
EGLDisplay getGLDisplay ()
 
const StringgetGLVendor (void) const
 Get vendor information. More...
 
const StringgetGLVersion (void) const
 Get version information. More...
 
NativeDisplayType getNativeDisplay (void)
 
void * getProcAddress (const Ogre::String &name)
 Get the address of a function. More...
 
XVisualInfo * getVisualFromFBConfig (::EGLConfig glConfig)
 
virtual void initialiseExtensions ()
 Initialises GL extensions, must be done AFTER the GL context has been established. More...
 
RenderWindownewWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
 Creates a new rendering window. More...
 
::EGLConfig selectGLConfig (const EGLint *minAttribs, const EGLint *maxAttribs)
 
void setConfigOption (const String &name, const String &value)
 
void setGLDisplay (EGLDisplay val)
 
void start (void)
 Start anything special. More...
 
void stop (void)
 Stop anything special. More...
 
void switchMode (void)
 
virtual void switchMode (uint &width, uint &height, short &frequency)
 
String validateConfig (void)
 Make sure all the extra options are valid. More...
 

Public Attributes

Atom mAtomDeleteWindow
 
Atom mAtomFullScreen
 
Atom mAtomState
 

Protected Types

typedef short Rate
 
typedef std::pair< uint, uintScreenSize
 
typedef std::pair< ScreenSize,
Rate
VideoMode
 
typedef std::vector< VideoModeVideoModes
 

Protected Member Functions

void refreshConfig (void)
 

Protected Attributes

std::set< StringextensionList
 
VideoMode mCurrentMode
 
EGLDisplay mGLDisplay
 
bool mIsExternalDisplay
 
NativeDisplayType mNativeDisplay
 
ConfigOptionMap mOptions
 
VideoMode mOriginalMode
 
bool mRandr
 
StringVector mSampleLevels
 
VideoModes mVideoModes
 

Detailed Description

Definition at line 139 of file OgreGtkEGLSupport.h.

Member Typedef Documentation

typedef short Ogre::EGLSupport::Rate
protectedinherited

Definition at line 58 of file OgreEGLSupport.h.

typedef std::pair<uint, uint> Ogre::EGLSupport::ScreenSize
protectedinherited

Definition at line 57 of file OgreEGLSupport.h.

typedef std::pair<ScreenSize, Rate> Ogre::EGLSupport::VideoMode
protectedinherited

Definition at line 59 of file OgreEGLSupport.h.

typedef std::vector<VideoMode> Ogre::EGLSupport::VideoModes
protectedinherited

Definition at line 60 of file OgreEGLSupport.h.

Constructor & Destructor Documentation

Ogre::GtkEGLSupport::GtkEGLSupport ( )
virtual Ogre::GtkEGLSupport::~GtkEGLSupport ( )
virtual

Member Function Documentation

void Ogre::EGLSupport::addConfig ( void  )
virtualinherited

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::GLESSupport.

virtual bool Ogre::GLESSupport::checkExtension ( const String ext) const
virtualinherited

Check if an extension is available.

EGLConfig* Ogre::EGLSupport::chooseGLConfig ( const EGLint *  attribList,
EGLint *  nElements 
)
inherited
::EGLContext Ogre::EGLSupport::createNewContext ( EGLDisplay  eglDisplay,
::EGLConfig  glconfig,
::EGLContext  shareList 
) const
inherited
virtual GLESPBuffer* Ogre::GtkEGLSupport::createPBuffer ( PixelComponentType  format,
size_t  width,
size_t  height 
)
virtual

Implements Ogre::EGLSupport.

RenderWindow* Ogre::EGLSupport::createWindow ( bool  autoCreateWindow,
GLESRenderSystem renderSystem,
const String windowTitle 
)
virtualinherited

Implements Ogre::GLESSupport.

virtual ConfigOptionMap& Ogre::GLESSupport::getConfigOptions ( void  )
virtualinherited
virtual unsigned int Ogre::GLESSupport::getDisplayMonitorCount ( ) const
inlinevirtualinherited

Definition at line 103 of file OgreGLESSupport.h.

String Ogre::GtkEGLSupport::getDisplayName ( void  )
virtual

Reimplemented from Ogre::EGLSupport.

EGLBoolean Ogre::EGLSupport::getGLConfigAttrib ( EGLConfig  fbConfig,
EGLint  attribute,
EGLint *  value 
)
inherited
::EGLConfig Ogre::EGLSupport::getGLConfigFromContext ( ::EGLContext  context)
inherited
::EGLConfig Ogre::EGLSupport::getGLConfigFromDrawable ( ::EGLSurface  drawable,
unsigned int *  w,
unsigned int *  h 
)
inherited
EGLDisplay Ogre::GtkEGLSupport::getGLDisplay ( )
const String& Ogre::GLESSupport::getGLVendor ( void  ) const
inlineinherited

Get vendor information.

Definition at line 75 of file OgreGLESSupport.h.

const String& Ogre::GLESSupport::getGLVersion ( void  ) const
inlineinherited

Get version information.

Definition at line 83 of file OgreGLESSupport.h.

NativeDisplayType Ogre::GtkEGLSupport::getNativeDisplay ( void  )
void* Ogre::EGLSupport::getProcAddress ( const Ogre::String procname)
virtualinherited

Get the address of a function.

Implements Ogre::GLESSupport.

XVisualInfo* Ogre::GtkEGLSupport::getVisualFromFBConfig ( ::EGLConfig  glConfig)
virtual void Ogre::GLESSupport::initialiseExtensions ( )
virtualinherited

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

RenderWindow* Ogre::GtkEGLSupport::newWindow ( const String name,
unsigned int  width,
unsigned int  height,
bool  fullScreen,
const NameValuePairList miscParams = 0 
)
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:
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*)
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  
macAPI String: "cocoa" or "carbon" "carbon" Specifies the type of rendering window on the Mac Platform.  
macAPICocoaUseNSView bool "true" or "false" "false" On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm.  
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.  
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.  

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::refreshConfig ( void  )
protectedinherited
::EGLConfig Ogre::EGLSupport::selectGLConfig ( const EGLint *  minAttribs,
const EGLint *  maxAttribs 
)
inherited
void Ogre::EGLSupport::setConfigOption ( const String name,
const String value 
)
virtualinherited

Reimplemented from Ogre::GLESSupport.

void Ogre::EGLSupport::setGLDisplay ( EGLDisplay  val)
inherited
void Ogre::EGLSupport::start ( void  )
virtualinherited

Start anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::stop ( void  )
virtualinherited

Stop anything special.

Implements Ogre::GLESSupport.

void Ogre::EGLSupport::switchMode ( void  )
inherited
virtual void Ogre::GtkEGLSupport::switchMode ( uint width,
uint height,
short &  frequency 
)
virtual

Implements Ogre::EGLSupport.

String Ogre::EGLSupport::validateConfig ( void  )
virtualinherited

Make sure all the extra options are valid.

Returns
string with error message

Implements Ogre::GLESSupport.

Member Data Documentation

std::set<String> Ogre::GLESSupport::extensionList
protectedinherited

Definition at line 127 of file OgreGLESSupport.h.

Atom Ogre::GtkEGLSupport::mAtomDeleteWindow

Definition at line 159 of file OgreGtkEGLSupport.h.

Atom Ogre::GtkEGLSupport::mAtomFullScreen

Definition at line 160 of file OgreGtkEGLSupport.h.

Atom Ogre::GtkEGLSupport::mAtomState

Definition at line 161 of file OgreGtkEGLSupport.h.

VideoMode Ogre::EGLSupport::mCurrentMode
protectedinherited

Definition at line 63 of file OgreEGLSupport.h.

EGLDisplay Ogre::EGLSupport::mGLDisplay
protectedinherited

Definition at line 52 of file OgreEGLSupport.h.

bool Ogre::EGLSupport::mIsExternalDisplay
protectedinherited

Definition at line 55 of file OgreEGLSupport.h.

NativeDisplayType Ogre::EGLSupport::mNativeDisplay
protectedinherited

Definition at line 53 of file OgreEGLSupport.h.

ConfigOptionMap Ogre::GLESSupport::mOptions
protectedinherited

Definition at line 124 of file OgreGLESSupport.h.

VideoMode Ogre::EGLSupport::mOriginalMode
protectedinherited

Definition at line 62 of file OgreEGLSupport.h.

bool Ogre::EGLSupport::mRandr
protectedinherited

Definition at line 56 of file OgreEGLSupport.h.

StringVector Ogre::EGLSupport::mSampleLevels
protectedinherited

Definition at line 64 of file OgreEGLSupport.h.

VideoModes Ogre::EGLSupport::mVideoModes
protectedinherited

Definition at line 61 of file OgreEGLSupport.h.


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