# Ogre::GLRenderSystem Class Reference

Implementation of GL as a rendering system. More...

`#include <OgreGLRenderSystem.h>`

Inheritance diagram for Ogre::GLRenderSystem:

List of all members.

## Public Types

typedef MapIterator< Ogre::RenderTargetMap > | RenderTargetIterator
| Iterator over RenderTargets.

## Public Member Functions

| GLRenderSystem ()
| ~GLRenderSystem ()
const String & | getName (void) const
| See RenderSystem.
ConfigOptionMap & | getConfigOptions (void)
| See RenderSystem.
void | setConfigOption (const String &name, const String &value)
| See RenderSystem.
String | validateConfigOptions (void)
| See RenderSystem.
RenderWindow * | initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
| See RenderSystem.
void | reinitialise (void)
| See RenderSystem.
void | shutdown (void)
| See RenderSystem.
void | setAmbientLight (float r, float g, float b)
| See RenderSystem.
void | setShadingType (ShadeOptions so)
| See RenderSystem.
void | setLightingEnabled (bool enabled)
| See RenderSystem.
RenderWindow * | createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)

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 getRenderWindow.
  | 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 platorms unless indicated otherwise:

Key: "title" Description: The title of the window that will appear in the title bar Values: string Default: RenderTarget name

Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific]

Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true

Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None)

Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None)

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate

Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0

Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize

Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false

Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false

virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)
| Surfaces can be bound and unbound at will. This fails if mCapabilities->numMultiRenderTargets() is smaller than 2.
void | destroyRenderWindow (RenderWindow *pWin)
| See RenderSystem.
String | getErrorDescription (long errorNumber) const
| See RenderSystem.
VertexElementType | getColourVertexElementType (void) const
| See RenderSystem.
void | setNormaliseNormals (bool normalise)
| See RenderSystem.
void | _useLights (const LightList &lights, unsigned short limit)
| See RenderSystem.
void | _setWorldMatrix (const Matrix4 &m)
| See RenderSystem.
void | _setViewMatrix (const Matrix4 &m)
| See RenderSystem.
void | _setProjectionMatrix (const Matrix4 &m)
| See RenderSystem.
void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking)
| See RenderSystem.
void | _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)
| See RenderSystem.
void | _setPointSpritesEnabled (bool enabled)
| See RenderSystem.
void | _setTexture (size_t unit, bool enabled, const String &texname)
| See RenderSystem.
void | _setTextureCoordSet (size_t stage, size_t index)
| See RenderSystem.
void | _setTextureCoordCalculation (size_t stage, TexCoordCalcMethod m, const Frustum *frustum=0)
| See RenderSystem.
void | _setTextureBlendMode (size_t stage, const LayerBlendModeEx &bm)
| See RenderSystem.
void | _setTextureAddressingMode (size_t stage, const TextureUnitState::UVWAddressingMode &uvw)
| See RenderSystem.
void | _setTextureBorderColour (size_t stage, const ColourValue &colour)
| See RenderSystem.
void | _setTextureMatrix (size_t stage, const Matrix4 &xform)
| See RenderSystem.
void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor)
| See RenderSystem.
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value)
| See RenderSystem.
void | _setViewport (Viewport *vp)
| See RenderSystem.
void | _beginFrame (void)
| See RenderSystem.
void | _endFrame (void)
| See RenderSystem.
void | _setCullingMode (CullingMode mode)
| See RenderSystem.
void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)
| See RenderSystem.
void | _setDepthBufferCheckEnabled (bool enabled=true)
| See RenderSystem.
void | _setDepthBufferWriteEnabled (bool enabled=true)
| See RenderSystem.
void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)
| See RenderSystem.
void | _setDepthBias (ushort bias)
| See RenderSystem.
void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)
| See RenderSystem.
void | _setFog (FogMode mode, const ColourValue &colour, Real density, Real start, Real end)
| See RenderSystem.
void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)
| See RenderSystem.
void | _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| See RenderSystem.
void | _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| See RenderSystem.
void | _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| See RenderSystem.
void | _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)
| See RenderSystem.
void | setClipPlane (ushort index, Real A, Real B, Real C, Real D)
| See RenderSystem.
void | enableClipPlane (ushort index, bool enable)
| See RenderSystem.
void | _setPolygonMode (PolygonMode level)
| See RenderSystem.
void | setStencilCheckEnabled (bool enabled)
| See RenderSystem.
void | setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 mask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false)
| See RenderSystem.
void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
| See RenderSystem.
void | _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)
| See RenderSystem.
void | setVertexDeclaration (VertexDeclaration *decl)
| See RenderSystem.
void | setVertexBufferBinding (VertexBufferBinding *binding)
| See RenderSystem.
void | _render (const RenderOperation &op)
| See RenderSystem.
void | bindGpuProgram (GpuProgram *prg)
| See RenderSystem.
void | unbindGpuProgram (GpuProgramType gptype)
| See RenderSystem.
void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params)
| See RenderSystem.
void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)
| See RenderSystem.
void | setClipPlanes (const PlaneList &clipPlanes)
| See RenderSystem.
void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)
| See RenderSystem.
void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)
| Clears one or more frame buffers on the active render target.
HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)
| Create an object for performing hardware occlusion queries.
Real | getHorizontalTexelOffset (void)
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getVerticalTexelOffset (void)
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getMinimumDepthInputValue (void)
| Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Real | getMaximumDepthInputValue (void)
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
void | _oneTimeContextInitialization ()
| One time initialization for the RenderState of a context.
void | _switchContext (GLContext *context)
| Switch GL context, dealing with involved internal cached states too.
void | _setRenderTarget (RenderTarget *target)
| Set current render target to target, enabling its GL context if needed.
void | _unregisterContext (GLContext *context)
| Unregister a render target->context mapping.
GLContext * | _getMainContext ()
| Get the main context.
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
| Destroy a hardware occlusion query object.
void | setWBufferEnabled (bool enabled)
| Sets whether or not W-buffers are enabled if they are avalible for this renderer.
bool | getWBufferEnabled (void) const
| Returns true if the renderer will try to use W-buffers when avalible.
RenderTexture * | createRenderTexture (const String &name, unsigned int width, unsigned int height, TextureType texType=TEX_TYPE_2D, PixelFormat internalFormat=PF_X8R8G8B8, const NameValuePairList *miscParams=0)
| Creates and registers a render texture object.
virtual void | destroyRenderWindow (const String &name)
| Destroys a render window.
virtual void | destroyRenderTexture (const String &name)
| Destroys a render texture.
virtual void | destroyRenderTarget (const String &name)
| Destroys a render target of any sort.
virtual void | attachRenderTarget (RenderTarget &target)
| Attaches the passed render target to the render system.
virtual RenderTarget * | getRenderTarget (const String &name)
| Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.
virtual RenderTarget * | detachRenderTarget (const String &name)
| Detaches the render target with the passed name from the render system and returns a pointer to it.
virtual RenderTargetIterator | getRenderTargetIterator (void)
| Returns a specialised MapIterator over all render targets attached to the RenderSystem.
void | setWaitForVerticalBlank (bool enabled)
| Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers.
bool | getWaitForVerticalBlank (void) const
| Returns true if the system is synchronising frames with the monitor vertical blank.
virtual void | _setWorldMatrices (const Matrix4 *m, unsigned short count)
| Sets multiple world matrices (vertex blending).
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
| Utility function for setting all the properties of a texture unit at once.
virtual void | _disableTextureUnit (size_t texUnit)
| Turns off a texture unit.
virtual void | _disableTextureUnitsFrom (size_t texUnit)
| Disables all texture units from the given unit upwards.
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
| Sets the filtering options for a given texture unit.
virtual Viewport * | _getViewport (void)
| Get the current active viewport for rendering.
virtual CullingMode | _getCullingMode (void) const
virtual void | _beginGeometryCount (void)
| The RenderSystem will keep a count of tris rendered, this resets the count.
virtual unsigned int | _getFaceCount (void) const
| Reports the number of tris rendered since the last _beginGeometryCount call.
virtual unsigned int | _getVertexCount (void) const
| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
virtual void | convertColourValue (const ColourValue &colour, uint32 *pDest)
| Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
const RenderSystemCapabilities * | getCapabilities (void) const
| Gets the capabilities of the render system.
virtual bool | isGpuProgramBound (GpuProgramType gptype)
| Returns whether or not a Gpu program of the given type is currently bound.
virtual void | _initRenderTargets (void)
| Utility method for initialising all render targets attached to this rendering system.
virtual void | _notifyCameraRemoved (const Camera *cam)
| Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer.
virtual void | _updateAllRenderTargets (void)
| Internal method for updating all render targets attached to this rendering system.
virtual void | setClipPlane (ushort index, const Plane &p)
| Set a clipping plane.
virtual void | setInvertVertexWinding (bool invert)
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
void | setCurrentPassIterationCount (const size_t count)
| set the current multi pass count value.
virtual void | addListener (Listener *l)
| Adds a listener to the custom events that this render system can raise.
virtual void | removeListener (Listener *l)
| Remove a listener to the custom events that this render system can raise.
virtual const StringVector & | getRenderSystemEvents (void) const
| Gets a list of the rendersystem specific events that this rendersystem can raise.

## Protected Types

typedef std::list< Listener * > | ListenerList
typedef std::list< HardwareOcclusionQuery * > | HardwareOcclusionQueryList

## Protected Member Functions

bool | updatePassIterationRenderState (void)
| updates pass iteration rendering state including bound gpu program parameter pass iteration auto constant entry
virtual void | fireEvent (const String &name, const NameValuePairList *params=0)
| Internal method for firing a rendersystem event.

## Protected Attributes

RenderTargetMap | mRenderTargets
| The render targets.
RenderTargetPriorityMap | mPrioritisedRenderTargets
| The render targets, ordered by priority.
RenderTarget * | mActiveRenderTarget
| The Active render target.
GpuProgramParametersSharedPtr | mActiveVertexGpuProgramParameters
| The Active GPU programs and gpu program parameters.
GpuProgramParametersSharedPtr | mActiveFragmentGpuProgramParameters
TextureManager * | mTextureManager
RenderSystemCapabilities * | mCapabilities
| Used to store the capabilities of the graphics card.
Viewport * | mActiveViewport
CullingMode | mCullingMode
bool | mVSync
bool | mWBuffer
size_t | mFaceCount
size_t | mVertexCount
Matrix4 | mWorldMatrices [256]
| Saved set of world matrices.
ColourValue | mManualBlendColours [OGRE_MAX_TEXTURE_LAYERS][2]
| Saved manual colour blends.
bool | mInvertVertexWinding
size_t | mCurrentPassIterationCount
| number of times to render the current state
StringVector | mEventNames
| List of names of events this rendersystem may raise.
ListenerList | mEventListeners
HardwareOcclusionQueryList | mHwOcclusionQueries
bool | mVertexProgramBound
bool | mFragmentProgramBound

## Private Types

typedef std::vector< Vector4 > | PlaneList2

## Private Member Functions

void | setGLClipPlanes () const
void | initConfigOptions (void)
void | initInputDevices (void)
void | processInputDevices (void)
void | setGLLight (size_t index, Light *lt)
void | makeGLMatrix (GLfloat gl_matrix[16], const Matrix4 &m)
GLint | getBlendMode (SceneBlendFactor ogreBlend) const
GLint | getTextureAddressingMode (TextureUnitState::TextureAddressingMode tam) const
void | setLights ()
GLint | convertCompareFunction (CompareFunction func) const
GLint | convertStencilOp (StencilOperation op, bool invert=false) const
GLfloat | _getCurrentAnisotropy (size_t unit)
void | setGLLightPositionDirection (Light *lt, GLenum lightindex)
| Internal method to set pos / direction of a light.
void | initGL (RenderTarget *primary)
GLuint | getCombinedMinMipFilter (void) const

## Private Attributes

bool | mStopRendering
Light * | mLights [MAX_LIGHTS]
PlaneList2 | mClipPlanes
Matrix4 | mViewMatrix
Matrix4 | mWorldMatrix
Matrix4 | mTextureMatrix
FilterOptions | mMinFilter
FilterOptions | mMipFilter
size_t | mTextureCoordIndex [OGRE_MAX_TEXTURE_COORD_SETS]
GLenum | mTextureTypes [OGRE_MAX_TEXTURE_LAYERS]
| holds texture type settings for every stage
unsigned short | mFixedFunctionTextureUnits
| Number of fixed-function texture units.
bool | mDepthWrite
uint32 | mStencilMask
bool | mColourWrite [4]
GLSupport * | mGLSupport
| GL support class, used for creating windows etc.
bool | mUseAutoTextureMatrix
GLfloat | mAutoTextureMatrix [16]
bool | mGLInitialized
HardwareBufferManager * | mHardwareBufferManager
GLGpuProgramManager * | mGpuProgramManager
unsigned short | mCurrentLights
GLGpuProgram * | mCurrentVertexProgram
GLGpuProgram * | mCurrentFragmentProgram
GLContext * | mMainContext
GLContext * | mCurrentContext
GLRTTManager * | mRTTManager
| Manager object for creating render textures.

## Detailed Description

Implementation of GL as a rendering system.

Definition at line 40 of file OgreGLRenderSystem.h.

## Member Typedef Documentation

typedef std::list<HardwareOcclusionQuery*> Ogre::RenderSystem::HardwareOcclusionQueryList `[protected, inherited]`

| Definition at line 1111 of file OgreRenderSystem.h.

typedef std::list<Listener*> Ogre::RenderSystem::ListenerList `[protected, inherited]`

| Definition at line 1108 of file OgreRenderSystem.h.

typedef std::vector<Vector4> Ogre::GLRenderSystem::PlaneList2 `[private]`

| Definition at line 52 of file OgreGLRenderSystem.h.

typedef MapIterator<Ogre::RenderTargetMap> Ogre::RenderSystem::RenderTargetIterator `[inherited]`

| Iterator over RenderTargets. Definition at line 399 of file OgreRenderSystem.h.

## Constructor & Destructor Documentation

Ogre::GLRenderSystem::GLRenderSystem | ( |  | ) |

Ogre::GLRenderSystem::~GLRenderSystem | ( |  | ) |

## Member Function Documentation

void Ogre::GLRenderSystem::_applyObliqueDepthProjection | ( | Matrix4 & | matrix,
|  | const Plane & | plane,
|  | bool | forGpuProgram
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_beginFrame | ( | void |  | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_beginGeometryCount | ( | void |  | ) | `[virtual, inherited]`

| The RenderSystem will keep a count of tris rendered, this resets the count.

void Ogre::GLRenderSystem::_convertProjectionMatrix | ( | const Matrix4 & | matrix,
|  | Matrix4 & | dest,
|  | bool | forGpuProgram = `false`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_disableTextureUnit | ( | size_t | texUnit | ) | `[virtual, inherited]`

| Turns off a texture unit.

virtual void Ogre::RenderSystem::_disableTextureUnitsFrom | ( | size_t | texUnit | ) | `[virtual, inherited]`

| Disables all texture units from the given unit upwards.

void Ogre::GLRenderSystem::_endFrame | ( | void |  | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual CullingMode Ogre::RenderSystem::_getCullingMode | ( | void |  | ) | const`[virtual, inherited]`

GLfloat Ogre::GLRenderSystem::_getCurrentAnisotropy | ( | size_t | unit | ) | `[private]`

virtual unsigned int Ogre::RenderSystem::_getFaceCount | ( | void |  | ) | const`[virtual, inherited]`

| Reports the number of tris rendered since the last _beginGeometryCount call.

GLContext* Ogre::GLRenderSystem::_getMainContext | ( |  | ) |

| Get the main context. This is generally the context with which a new context wants to share buffers and textures.

virtual unsigned int Ogre::RenderSystem::_getVertexCount | ( | void |  | ) | const`[virtual, inherited]`

| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.

virtual Viewport* Ogre::RenderSystem::_getViewport | ( | void |  | ) | `[virtual, inherited]`

| Get the current active viewport for rendering.

virtual void Ogre::RenderSystem::_initRenderTargets | ( | void |  | ) | `[virtual, inherited]`

| Utility method for initialising all render targets attached to this rendering system.

void Ogre::GLRenderSystem::_makeOrthoMatrix | ( | const Radian & | fovy,
|  | Real | aspect,
|  | Real | nearPlane,
|  | Real | farPlane,
|  | Matrix4 & | dest,
|  | bool | forGpuProgram = `false`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_makeProjectionMatrix | ( | Real | left,
|  | Real | right,
|  | Real | bottom,
|  | Real | top,
|  | Real | nearPlane,
|  | Real | farPlane,
|  | Matrix4 & | dest,
|  | bool | forGpuProgram = `false`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_makeProjectionMatrix | ( | const Radian & | fovy,
|  | Real | aspect,
|  | Real | nearPlane,
|  | Real | farPlane,
|  | Matrix4 & | dest,
|  | bool | forGpuProgram = `false`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_notifyCameraRemoved | ( | const Camera * | cam | ) | `[virtual, inherited]`

| Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer.

void Ogre::GLRenderSystem::_oneTimeContextInitialization | ( |  | ) |

| One time initialization for the RenderState of a context. Things that only need to be set once, like the LightingModel can be defined here.

void Ogre::GLRenderSystem::_render | ( | const RenderOperation & | op | ) | `[virtual]`

| See RenderSystem. Reimplemented from Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setAlphaRejectSettings | ( | CompareFunction | func,
|  | unsigned char | value
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setColourBufferWriteEnabled | ( | bool | red,
|  | bool | green,
|  | bool | blue,
|  | bool | alpha
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setCullingMode | ( | CullingMode | mode | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setDepthBias | ( | ushort | bias | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setDepthBufferCheckEnabled | ( | bool | enabled = `true` | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setDepthBufferFunction | ( | CompareFunction | func = `CMPF_LESS_EQUAL` | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setDepthBufferParams | ( | bool | depthTest = `true`,
|  | bool | depthWrite = `true`,
|  | CompareFunction | depthFunction = `CMPF_LESS_EQUAL`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setDepthBufferWriteEnabled | ( | bool | enabled = `true` | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setFog | ( | FogMode | mode,
|  | const ColourValue & | colour,
|  | Real | density,
|  | Real | start,
|  | Real | end
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setPointParameters | ( | Real | size,
|  | bool | attenuationEnabled,
|  | Real | constant,
|  | Real | linear,
|  | Real | quadratic,
|  | Real | minSize,
|  | Real | maxSize
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setPointSpritesEnabled | ( | bool | enabled | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setPolygonMode | ( | PolygonMode | level | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setProjectionMatrix | ( | const Matrix4 & | m | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setRenderTarget | ( | RenderTarget * | target | ) |

| Set current render target to target, enabling its GL context if needed.

void Ogre::GLRenderSystem::_setSceneBlending | ( | SceneBlendFactor | sourceFactor,
|  | SceneBlendFactor | destFactor
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setSurfaceParams | ( | const ColourValue & | ambient,
|  | const ColourValue & | diffuse,
|  | const ColourValue & | specular,
|  | const ColourValue & | emissive,
|  | Real | shininess,
|  | TrackVertexColourType | tracking
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTexture | ( | size_t | unit,
|  | bool | enabled,
|  | const String & | texname
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureAddressingMode | ( | size_t | stage,
|  | const TextureUnitState::UVWAddressingMode & | uvw
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureBlendMode | ( | size_t | stage,
|  | const LayerBlendModeEx & | bm
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureBorderColour | ( | size_t | stage,
|  | const ColourValue & | colour
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureCoordCalculation | ( | size_t | stage,
|  | TexCoordCalcMethod | m,
|  | const Frustum * | frustum = `0`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureCoordSet | ( | size_t | stage,
|  | size_t | index
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureLayerAnisotropy | ( | size_t | unit,
|  | unsigned int | maxAnisotropy
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setTextureMatrix | ( | size_t | stage,
|  | const Matrix4 & | xform
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_setTextureUnitFiltering | ( | size_t | unit,
|  | FilterOptions | minFilter,
|  | FilterOptions | magFilter,
|  | FilterOptions | mipFilter
| ) | `[virtual, inherited]`

Sets the filtering options for a given texture unit.

Parameters:

  | unit | The texture unit to set the filtering options for
  | minFilter | The filter used when a texture is reduced in size
  | magFilter | The filter used when a texture is magnified
  | mipFilter | The filter used between mipmap levels, FO_NONE disables mipmapping

void Ogre::GLRenderSystem::_setTextureUnitFiltering | ( | size_t | unit,
|  | FilterType | ftype,
|  | FilterOptions | filter
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_setTextureUnitSettings | ( | size_t | texUnit,
|  | TextureUnitState & | tl
| ) | `[virtual, inherited]`

| Utility function for setting all the properties of a texture unit at once. This method is also worth using over the individual texture unit settings because it only sets those settings which are different from the current settings for this unit, thus minimising render state changes.

void Ogre::GLRenderSystem::_setViewMatrix | ( | const Matrix4 & | m | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_setViewport | ( | Viewport * | vp | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_setWorldMatrices | ( | const Matrix4 * | m,
|  | unsigned short | count
| ) | `[virtual, inherited]`

| Sets multiple world matrices (vertex blending).

void Ogre::GLRenderSystem::_setWorldMatrix | ( | const Matrix4 & | m | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::_switchContext | ( | GLContext * | context | ) |

| Switch GL context, dealing with involved internal cached states too.

void Ogre::GLRenderSystem::_unregisterContext | ( | GLContext * | context | ) |

Unregister a render target->context mapping.

If the context of target is the current context, change the context to the main context so it can be destroyed safely.

Note:
  This is automatically called by the destructor of GLContext.

virtual void Ogre::RenderSystem::_updateAllRenderTargets | ( | void |  | ) | `[virtual, inherited]`

| Internal method for updating all render targets attached to this rendering system.

void Ogre::GLRenderSystem::_useLights | ( | const LightList & | lights,
|  | unsigned short | limit
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::addListener | ( | Listener * | l | ) | `[virtual, inherited]`

Adds a listener to the custom events that this render system can raise.

Remarks:
  Some render systems have quite specific, internally generated events that the application may wish to be notified of. Many applications don't have to worry about these events, and can just trust OGRE to handle them, but if you want to know, you can add a listener here.

  Events are raised very generically by string name. Perhaps the most common example of a render system specific event is the loss and restoration of a device in DirectX; which OGRE deals with, but you may wish to know when it happens.

See also:
  RenderSystem::getRenderSystemEvents

virtual void Ogre::RenderSystem::attachRenderTarget | ( | RenderTarget & | target | ) | `[virtual, inherited]`

| Attaches the passed render target to the render system.

void Ogre::GLRenderSystem::bindGpuProgram | ( | GpuProgram * | prg | ) | `[virtual]`

| See RenderSystem. Reimplemented from Ogre::RenderSystem.

void Ogre::GLRenderSystem::bindGpuProgramParameters | ( | GpuProgramType | gptype,
|  | GpuProgramParametersSharedPtr | params
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::bindGpuProgramPassIterationParameters | ( | GpuProgramType | gptype | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::clearFrameBuffer | ( | unsigned int | buffers,
|  | const ColourValue & | colour = `ColourValue::Black`,
|  | Real | depth = `1.0f`,
|  | unsigned short | stencil = `0`
| ) | `[virtual]`

Clears one or more frame buffers on the active render target.

Parameters:

  | buffers | Combination of one or more elements of FrameBufferType denoting which buffers are to be cleared
  | colour | The colour to clear the colour buffer with, if enabled
  | depth | The value to initialise the depth buffer with, if enabled
  | stencil | The value to initialise the stencil buffer with, if enabled.

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::convertColourValue | ( | const ColourValue & | colour,
|  | uint32 * | pDest
| ) | `[virtual, inherited]`

Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.

Remarks:
  Since different render systems have different colour data formats (eg RGBA for GL, ARGB for D3D) this method allows you to use 1 method for all.

Parameters:

  | colour | The colour to convert
  | pDest | Pointer to location to put the result.

GLint Ogre::GLRenderSystem::convertCompareFunction | ( | CompareFunction | func | ) | const`[private]`

GLint Ogre::GLRenderSystem::convertStencilOp | ( | StencilOperation | op,
|  | bool | invert = `false`
| ) | const`[private]`

HardwareOcclusionQuery* Ogre::GLRenderSystem::createHardwareOcclusionQuery | ( | void |  | ) | `[virtual]`

| Create an object for performing hardware occlusion queries. Implements Ogre::RenderSystem.

virtual MultiRenderTarget* Ogre::GLRenderSystem::createMultiRenderTarget | ( | const String & | name | ) | `[virtual]`

| Surfaces can be bound and unbound at will. This fails if mCapabilities->numMultiRenderTargets() is smaller than 2. Implements Ogre::RenderSystem.

RenderTexture* Ogre::RenderSystem::createRenderTexture | ( | const String & | name,
|  | unsigned int | width,
|  | unsigned int | height,
|  | TextureType | texType = `TEX_TYPE_2D`,
|  | PixelFormat | internalFormat = `PF_X8R8G8B8`,
|  | const NameValuePairList * | miscParams = `0`
| ) | `[inherited]`

Creates and registers a render texture object.

Parameters:

  | name | The name for the new render texture. Note that names must be unique.
  | width | The requested width for the render texture. See Remarks for more info.
  | height | The requested width for the render texture. See Remarks for more info.
  | texType | The type of texture; defaults to TEX_TYPE_2D
  | internalFormat | The internal format of the texture; defaults to PF_X8R8G8B8
  | miscParams | This parameter is ignored.

Returns:
  On succes, a pointer to a new platform-dependernt, RenderTexture-derived class is returned. On failiure, NULL is returned.

Remarks:
  Because a render texture is basically a wrapper around a texture object, the width and height parameters of this method just hint the preferred size for the texture. Depending on the hardware driver or the underlying API, these values might change when the texture is created. The same applies to the internalFormat parameter.

Deprecated:
  This method is deprecated, and exists only for backward compatibility.

You can create arbitrary rendertextures with the TextureManager::createManual call with usage TU_RENDERTEXTURE.

Reimplemented in Ogre::D3D9RenderSystem.

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

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 getRenderWindow.
  | 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 platorms unless indicated otherwise:

Key: "title" Description: The title of the window that will appear in the title bar Values: string Default: RenderTarget name

Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific]

Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true

Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None)

Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None)

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate

Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0

Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize

Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false

Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::destroyHardwareOcclusionQuery | ( | HardwareOcclusionQuery * | hq | ) | `[virtual, inherited]`

| Destroy a hardware occlusion query object.

virtual void Ogre::RenderSystem::destroyRenderTarget | ( | const String & | name | ) | `[virtual, inherited]`

| Destroys a render target of any sort. Reimplemented in Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::destroyRenderTexture | ( | const String & | name | ) | `[virtual, inherited]`

| Destroys a render texture.

virtual void Ogre::RenderSystem::destroyRenderWindow | ( | const String & | name | ) | `[virtual, inherited]`

| Destroys a render window.

void Ogre::GLRenderSystem::destroyRenderWindow | ( | RenderWindow * | pWin | ) |

| See RenderSystem.

virtual RenderTarget* Ogre::RenderSystem::detachRenderTarget | ( | const String & | name | ) | `[virtual, inherited]`

Detaches the render target with the passed name from the render system and returns a pointer to it.

Note:
  If the render target cannot be found, NULL is returned.

void Ogre::GLRenderSystem::enableClipPlane | ( | ushort | index,
|  | bool | enable
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::fireEvent | ( | const String & | name,
|  | const NameValuePairList * | params = `0`
| ) | `[protected, virtual, inherited]`

| Internal method for firing a rendersystem event.

GLint Ogre::GLRenderSystem::getBlendMode | ( | SceneBlendFactor | ogreBlend | ) | const`[private]`

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities | ( | void |  | ) | const`[inherited]`

| Gets the capabilities of the render system. Definition at line 893 of file OgreRenderSystem.h.

VertexElementType Ogre::GLRenderSystem::getColourVertexElementType | ( | void |  | ) | const`[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

GLuint Ogre::GLRenderSystem::getCombinedMinMipFilter | ( | void |  | ) | const`[private]`

ConfigOptionMap& Ogre::GLRenderSystem::getConfigOptions | ( | void |  | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

String Ogre::GLRenderSystem::getErrorDescription | ( | long | errorNumber | ) | const`[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

Real Ogre::GLRenderSystem::getHorizontalTexelOffset | ( | void |  | ) | `[virtual]`

Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.

Remarks:
  Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the horizontal direction.

Implements Ogre::RenderSystem.

Real Ogre::GLRenderSystem::getMaximumDepthInputValue | ( | void |  | ) | `[virtual]`

Gets the maximum (farthest) depth value to be used when rendering using identity transforms.

Remarks:
  When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.

See also:
  Renderable::useIdentityView, Renderable::useIdentityProjection

Implements Ogre::RenderSystem.

Real Ogre::GLRenderSystem::getMinimumDepthInputValue | ( | void |  | ) | `[virtual]`

Gets the minimum (closest) depth value to be used when rendering using identity transforms.

Remarks:
  When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.

See also:
  Renderable::useIdentityView, Renderable::useIdentityProjection

Implements Ogre::RenderSystem.

const String& Ogre::GLRenderSystem::getName | ( | void |  | ) | const`[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual const StringVector& Ogre::RenderSystem::getRenderSystemEvents | ( | void |  | ) | const`[virtual, inherited]`

Gets a list of the rendersystem specific events that this rendersystem can raise.

See also:
  RenderSystem::addListener

Definition at line 1051 of file OgreRenderSystem.h.

virtual RenderTarget* Ogre::RenderSystem::getRenderTarget | ( | const String & | name | ) | `[virtual, inherited]`

| Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.

virtual RenderTargetIterator Ogre::RenderSystem::getRenderTargetIterator | ( | void |  | ) | `[virtual, inherited]`

| Returns a specialised MapIterator over all render targets attached to the RenderSystem. Definition at line 402 of file OgreRenderSystem.h.

GLint Ogre::GLRenderSystem::getTextureAddressingMode | ( | TextureUnitState::TextureAddressingMode | tam | ) | const`[private]`

Real Ogre::GLRenderSystem::getVerticalTexelOffset | ( | void |  | ) | `[virtual]`

Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.

Remarks:
  Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the vertical direction.

Implements Ogre::RenderSystem.

bool Ogre::RenderSystem::getWaitForVerticalBlank | ( | void |  | ) | const`[inherited]`

| Returns true if the system is synchronising frames with the monitor vertical blank.

bool Ogre::RenderSystem::getWBufferEnabled | ( | void |  | ) | const`[inherited]`

| Returns true if the renderer will try to use W-buffers when avalible.

void Ogre::GLRenderSystem::initConfigOptions | ( | void |  | ) | `[private]`

void Ogre::GLRenderSystem::initGL | ( | RenderTarget * | primary | ) | `[private]`

RenderWindow* Ogre::GLRenderSystem::initialise | ( | bool | autoCreateWindow,
|  | const String & | windowTitle = `"OGRE Render Window"`
| ) | `[virtual]`

| See RenderSystem. Reimplemented from Ogre::RenderSystem.

void Ogre::GLRenderSystem::initInputDevices | ( | void |  | ) | `[private]`

virtual bool Ogre::RenderSystem::isGpuProgramBound | ( | GpuProgramType | gptype | ) | `[virtual, inherited]`

| Returns whether or not a Gpu program of the given type is currently bound.

void Ogre::GLRenderSystem::makeGLMatrix | ( | GLfloat | gl_matrix[16],
|  | const Matrix4 & | m
| ) | `[private]`

void Ogre::GLRenderSystem::processInputDevices | ( | void |  | ) | `[private]`

void Ogre::GLRenderSystem::reinitialise | ( | void |  | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::removeListener | ( | Listener * | l | ) | `[virtual, inherited]`

| Remove a listener to the custom events that this render system can raise.

void Ogre::GLRenderSystem::setAmbientLight | ( | float | r,
|  | float | g,
|  | float | b
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::setClipPlane | ( | ushort | index,
|  | const Plane & | p
| ) | `[virtual, inherited]`

| Set a clipping plane.

void Ogre::GLRenderSystem::setClipPlane | ( | ushort | index,
|  | Real | A,
|  | Real | B,
|  | Real | C,
|  | Real | D
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setClipPlanes | ( | const PlaneList & | clipPlanes | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

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

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::RenderSystem::setCurrentPassIterationCount | ( | const size_t | count | ) | `[inherited]`

set the current multi pass count value.

This must be set prior to calling _render() if multiple renderings of the same pass state are required.

Parameters:

  | count | Number of times to render the current state.

Definition at line 1009 of file OgreRenderSystem.h.

void Ogre::GLRenderSystem::setGLClipPlanes | ( |  | ) | const`[private]`

void Ogre::GLRenderSystem::setGLLight | ( | size_t | index,
|  | Light * | lt
| ) | `[private]`

void Ogre::GLRenderSystem::setGLLightPositionDirection | ( | Light * | lt,
|  | GLenum | lightindex
| ) | `[private]`

| Internal method to set pos / direction of a light.

virtual void Ogre::RenderSystem::setInvertVertexWinding | ( | bool | invert | ) | `[virtual, inherited]`

| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.

void Ogre::GLRenderSystem::setLightingEnabled | ( | bool | enabled | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setLights | ( |  | ) | `[private]`

void Ogre::GLRenderSystem::setNormaliseNormals | ( | bool | normalise | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setScissorTest | ( | bool | enabled,
|  | size_t | left = `0`,
|  | size_t | top = `0`,
|  | size_t | right = `800`,
|  | size_t | bottom = `600`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setShadingType | ( | ShadeOptions | so | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setStencilBufferParams | ( | CompareFunction | func = `CMPF_ALWAYS_PASS`,
|  | uint32 | refValue = `0`,
|  | uint32 | mask = `0xFFFFFFFF`,
|  | StencilOperation | stencilFailOp = `SOP_KEEP`,
|  | StencilOperation | depthFailOp = `SOP_KEEP`,
|  | StencilOperation | passOp = `SOP_KEEP`,
|  | bool | twoSidedOperation = `false`
| ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setStencilCheckEnabled | ( | bool | enabled | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setVertexBufferBinding | ( | VertexBufferBinding * | binding | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::GLRenderSystem::setVertexDeclaration | ( | VertexDeclaration * | decl | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

void Ogre::RenderSystem::setWaitForVerticalBlank | ( | bool | enabled | ) | `[inherited]`

Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers.

Remarks:
  By default, all rendering windows wait for a vertical blank (when the CRT beam turns off briefly to move from the bottom right of the screen back to the top left) before flipping the screen buffers. This ensures that the image you see on the screen is steady. However it restricts the frame rate to the refresh rate of the monitor, and can slow the frame rate down. You can speed this up by not waiting for the blank, but this has the downside of introducing 'tearing' artefacts where part of the previous frame is still displayed as the buffers are switched. Speed vs quality, you choose.

Note:
  Has NO effect on windowed mode render targets. Only affects fullscreen mode.

Parameters:

  | enabled | If true, the system waits for vertical blanks - quality over speed. If false it doesn't - speed over quality.

void Ogre::RenderSystem::setWBufferEnabled | ( | bool | enabled | ) | `[inherited]`

Sets whether or not W-buffers are enabled if they are avalible for this renderer.

Parameters:

  | enabled | If true and the renderer supports them W-buffers will be used. If false W-buffers will not be used even if avalible. W-buffers are enabled by default for 16bit depth buffers and disabled for all other depths.

void Ogre::GLRenderSystem::shutdown | ( | void |  | ) | `[virtual]`

| See RenderSystem. Reimplemented from Ogre::RenderSystem.

void Ogre::GLRenderSystem::unbindGpuProgram | ( | GpuProgramType | gptype | ) | `[virtual]`

| See RenderSystem. Reimplemented from Ogre::RenderSystem.

bool Ogre::RenderSystem::updatePassIterationRenderState | ( | void |  | ) | `[protected, inherited]`

updates pass iteration rendering state including bound gpu program parameter pass iteration auto constant entry

Returns:
  True if more iterations are required

String Ogre::GLRenderSystem::validateConfigOptions | ( | void |  | ) | `[virtual]`

| See RenderSystem. Implements Ogre::RenderSystem.

## Member Data Documentation

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveFragmentGpuProgramParameters `[protected, inherited]`

| Definition at line 1063 of file OgreRenderSystem.h.

RenderTarget* Ogre::RenderSystem::mActiveRenderTarget `[protected, inherited]`

| The Active render target. Definition at line 1060 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveVertexGpuProgramParameters `[protected, inherited]`

| The Active GPU programs and gpu program parameters. Definition at line 1062 of file OgreRenderSystem.h.

Viewport* Ogre::RenderSystem::mActiveViewport `[protected, inherited]`

| Definition at line 1075 of file OgreRenderSystem.h.

GLfloat Ogre::GLRenderSystem::mAutoTextureMatrix[16]`[private]`

| Definition at line 107 of file OgreGLRenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::mCapabilities `[protected, inherited]`

| Used to store the capabilities of the graphics card. Definition at line 1072 of file OgreRenderSystem.h.

PlaneList2 Ogre::GLRenderSystem::mClipPlanes `[private]`

| Definition at line 53 of file OgreGLRenderSystem.h.

bool Ogre::GLRenderSystem::mColourWrite[4]`[private]`

| Definition at line 92 of file OgreGLRenderSystem.h.

CullingMode Ogre::RenderSystem::mCullingMode `[protected, inherited]`

| Definition at line 1077 of file OgreRenderSystem.h.

GLContext* Ogre::GLRenderSystem::mCurrentContext `[private]`

| Definition at line 127 of file OgreGLRenderSystem.h.

GLGpuProgram* Ogre::GLRenderSystem::mCurrentFragmentProgram `[private]`

| Definition at line 122 of file OgreGLRenderSystem.h.

unsigned short Ogre::GLRenderSystem::mCurrentLights `[private]`

| Definition at line 117 of file OgreGLRenderSystem.h.

size_t Ogre::RenderSystem::mCurrentPassIterationCount `[protected, inherited]`

| number of times to render the current state Definition at line 1094 of file OgreRenderSystem.h.

GLGpuProgram* Ogre::GLRenderSystem::mCurrentVertexProgram `[private]`

| Definition at line 121 of file OgreGLRenderSystem.h.

bool Ogre::GLRenderSystem::mDepthWrite `[private]`

| Definition at line 88 of file OgreGLRenderSystem.h.

ListenerList Ogre::RenderSystem::mEventListeners `[protected, inherited]`

| Definition at line 1109 of file OgreRenderSystem.h.

StringVector Ogre::RenderSystem::mEventNames `[protected, inherited]`

| List of names of events this rendersystem may raise. Definition at line 1103 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mFaceCount `[protected, inherited]`

| Definition at line 1082 of file OgreRenderSystem.h.

unsigned short Ogre::GLRenderSystem::mFixedFunctionTextureUnits `[private]`

| Number of fixed-function texture units. Definition at line 73 of file OgreGLRenderSystem.h.

bool Ogre::RenderSystem::mFragmentProgramBound `[protected, inherited]`

| Definition at line 1115 of file OgreRenderSystem.h.

bool Ogre::GLRenderSystem::mGLInitialized `[private]`

| Definition at line 110 of file OgreGLRenderSystem.h.

GLSupport* Ogre::GLRenderSystem::mGLSupport `[private]`

| GL support class, used for creating windows etc. Definition at line 101 of file OgreGLRenderSystem.h.

GLGpuProgramManager* Ogre::GLRenderSystem::mGpuProgramManager `[private]`

| Definition at line 115 of file OgreGLRenderSystem.h.

HardwareBufferManager* Ogre::GLRenderSystem::mHardwareBufferManager `[private]`

| Definition at line 114 of file OgreGLRenderSystem.h.

HardwareOcclusionQueryList Ogre::RenderSystem::mHwOcclusionQueries `[protected, inherited]`

| Definition at line 1112 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mInvertVertexWinding `[protected, inherited]`

| Definition at line 1091 of file OgreRenderSystem.h.

Light* Ogre::GLRenderSystem::mLights[MAX_LIGHTS]`[private]`

| Definition at line 49 of file OgreGLRenderSystem.h.

GLContext* Ogre::GLRenderSystem::mMainContext `[private]`

| Definition at line 125 of file OgreGLRenderSystem.h.

ColourValue Ogre::RenderSystem::mManualBlendColours[OGRE_MAX_TEXTURE_LAYERS][2]`[protected, inherited]`

| Saved manual colour blends. Definition at line 1089 of file OgreRenderSystem.h.

FilterOptions Ogre::GLRenderSystem::mMinFilter `[private]`

| Definition at line 63 of file OgreGLRenderSystem.h.

FilterOptions Ogre::GLRenderSystem::mMipFilter `[private]`

| Definition at line 64 of file OgreGLRenderSystem.h.

RenderTargetPriorityMap Ogre::RenderSystem::mPrioritisedRenderTargets `[protected, inherited]`

| The render targets, ordered by priority. Definition at line 1058 of file OgreRenderSystem.h.

RenderTargetMap Ogre::RenderSystem::mRenderTargets `[protected, inherited]`

| The render targets. Definition at line 1056 of file OgreRenderSystem.h.

GLRTTManager* Ogre::GLRenderSystem::mRTTManager `[private]`

| Manager object for creating render textures. Direct render to texture via GL_EXT_framebuffer_object is preferable to pbuffers, which depend on the GL support used and are generally unwieldy and slow. However, FBO support for stencil buffers is poor. Definition at line 134 of file OgreGLRenderSystem.h.

uint32 Ogre::GLRenderSystem::mStencilMask `[private]`

| Definition at line 90 of file OgreGLRenderSystem.h.

bool Ogre::GLRenderSystem::mStopRendering `[private]`

| Definition at line 44 of file OgreGLRenderSystem.h.

size_t Ogre::GLRenderSystem::mTextureCoordIndex[OGRE_MAX_TEXTURE_COORD_SETS]`[private]`

| Definition at line 67 of file OgreGLRenderSystem.h.

TextureManager* Ogre::RenderSystem::mTextureManager `[protected, inherited]`

| Definition at line 1069 of file OgreRenderSystem.h.

Matrix4 Ogre::GLRenderSystem::mTextureMatrix `[private]`

| Definition at line 60 of file OgreGLRenderSystem.h.

GLenum Ogre::GLRenderSystem::mTextureTypes[OGRE_MAX_TEXTURE_LAYERS]`[private]`

| holds texture type settings for every stage Definition at line 70 of file OgreGLRenderSystem.h.

bool Ogre::GLRenderSystem::mUseAutoTextureMatrix `[private]`

| Definition at line 106 of file OgreGLRenderSystem.h.

size_t Ogre::RenderSystem::mVertexCount `[protected, inherited]`

| Definition at line 1083 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mVertexProgramBound `[protected, inherited]`

| Definition at line 1114 of file OgreRenderSystem.h.

Matrix4 Ogre::GLRenderSystem::mViewMatrix `[private]`

| Definition at line 58 of file OgreGLRenderSystem.h.

bool Ogre::RenderSystem::mVSync `[protected, inherited]`

| Definition at line 1079 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mWBuffer `[protected, inherited]`

| Definition at line 1080 of file OgreRenderSystem.h.

Matrix4 Ogre::RenderSystem::mWorldMatrices[256]`[protected, inherited]`

| Saved set of world matrices. Definition at line 1086 of file OgreRenderSystem.h.

Matrix4 Ogre::GLRenderSystem::mWorldMatrix `[private]`

| Definition at line 59 of file OgreGLRenderSystem.h.

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

- OgreGLRenderSystem.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 17 15:49:17 2006