| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Ogre::GLES2RenderSystem Class Reference
RenderSystems » GLES2

Implementation of GL ES 2.x as a rendering system. More...

`#include <OgreGLES2RenderSystem.h>`

Inheritance diagram for Ogre::GLES2RenderSystem:
[legend]

## Public Types
typedef MapIterator< Ogre::RenderTargetMap > | RenderTargetIterator
| Iterator over RenderTargets. More...

## Public Member Functions
| GLES2RenderSystem ()
virtual | ~GLES2RenderSystem ()
void | _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)
| Update a perspective projection matrix to use 'oblique depth projection'. More...
void | _beginFrame (void)
| Signifies the beginning of a frame, i.e. More...
virtual void | _beginGeometryCount (void)
| The RenderSystem will keep a count of tris rendered, this resets the count. More...
void | _bindVao (GLContext *context, uint32 vao)
| Bind VAO, context should be equal to current context, as VAOs are not shared. More...
void | _cleanupDepthBuffers (bool bCleanManualBuffers=true)
| Removes all depth buffers. More...
void | _completeDeferredVaoFboDestruction ()
| Complete destruction of VAOs and FBOs deferred while creator context was not current. More...
void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool)
| Converts a uniform projection matrix to suitable for this render system. More...
void | _copyContentsToMemory (Viewport *vp, const Box &src, const PixelBox &dst, RenderWindow::FrameBuffer buffer)
| Copies the current contents of the render target to a pixelbox. More...
DepthBuffer * | _createDepthBufferFor (RenderTarget *renderTarget)
| Creates a DepthBuffer that can be attached to the specified RenderTarget. More...
RenderWindow * | _createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
| Creates a new rendering window. More...
virtual bool | _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
| Creates multiple rendering windows. More...
uint32 | _createVao ()
| Create VAO on current context. More...
void | _destroyDepthBuffer (RenderTarget *pRenderWnd)
void | _destroyFbo (GLContext *context, uint32 fbo)
| Destroy FBO immediately or defer if it was created on other context. More...
void | _destroyVao (GLContext *context, uint32 vao)
| Destroy VAO immediately or defer if it was created on other context. More...
virtual void | _disableTextureUnit (size_t texUnit)
| Turns off a texture unit. More...
virtual void | _disableTextureUnitsFrom (size_t texUnit)
| Disables all texture units from the given unit upwards. More...
void | _endFrame (void)
| Ends rendering of a frame to the current viewport. More...
virtual unsigned int | _getBatchCount (void) const
| Reports the number of batches rendered since the last _beginGeometryCount call. More...
virtual CullingMode | _getCullingMode (void) const
GLContext * | _getCurrentContext ()
| Returns the current context. More...
const String & | _getDefaultViewportMaterialScheme (void) const
| Returns the default material scheme used by the render system. More...
void | _getDepthStencilFormatFor (PixelFormat internalColourFormat, GLenum *depthFormat, GLenum *stencilFormat)
| Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE. More...
virtual unsigned int | _getFaceCount (void) const
| Reports the number of tris rendered since the last _beginGeometryCount call. More...
GLContext * | _getMainContext ()
| Returns the main context. More...
GLES2StateCacheManager * | _getStateCacheManager ()
virtual unsigned int | _getVertexCount (void) const
| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. More...
virtual Viewport * | _getViewport (void)
| Get the current active viewport for rendering. More...
RenderWindow * | _initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render NativeWindowType")
| Start up the renderer using the settings selected (Or the defaults if none have been selected). More...
void | _initRenderTargets (void)
| Utility method for initialising all render targets attached to this rendering system. More...
void | _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds an orthographic projection matrix suitable for this render system. More...
void | _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds a perspective projection matrix suitable for this render system. More...
void | _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds a perspective projection matrix for the case when frustum is not centered around camera. More...
void | _notifyCameraRemoved (const Camera *cam)
| Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. More...
void | _oneTimeContextInitialization ()
| One time initialization for the RenderState of a context. More...
virtual RenderSystemContext * | _pauseFrame (void)
| Pause rendering for a frame. More...
void | _render (const RenderOperation &op)
| Render something to the active viewport. More...
virtual void | _resumeFrame (RenderSystemContext *context)
| Resume rendering for a frame. More...
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)
| Sets the global alpha rejection approach for future renders. More...
virtual void | _setBindingType (TextureUnitState::BindingType bindigType)
void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)
| Sets whether or not colour buffer writing is enabled, and for which channels. More...
void | _setCullingMode (CullingMode mode)
| Sets the culling mode for the render system based on the 'vertex winding'. More...
void | _setDepthBias (float constantBias, float slopeScaleBias)
| Sets the depth bias, NB you should use the Material version of this. More...
void | _setDepthBufferCheckEnabled (bool enabled=true)
| Sets whether or not the depth buffer check is performed before a pixel write. More...
void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)
| Sets the comparison function for the depth buffer check. More...
void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)
| Sets the mode of operation for depth buffer tests from this point onwards. More...
void | _setDepthBufferWriteEnabled (bool enabled=true)
| Sets whether or not the depth buffer is updated after a pixel write. More...
virtual void | _setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=1.0, Real linearStart=0.0, Real linearEnd=1.0)
| Sets the fogging mode for future geometry. More...
virtual void | _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)
| Sets the size of points and how they are attenuated with distance. More...
virtual void | _setPointSpritesEnabled (bool enabled)
| Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More...
void | _setPolygonMode (PolygonMode level)
| Sets how to rasterise triangles, as points, wireframe or solid polys. More...
virtual void | _setProjectionMatrix (const Matrix4 &m)
| Sets the projection transform matrix. More...
void | _setRenderTarget (RenderTarget *target)
| Set current render target to target, enabling its GL context if needed. More...
void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op)
| Sets the global blending factors for combining subsequent renders with the existing frame contents. More...
void | _setSceneBlendingOperation (SceneBlendOperation op)
void | _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp)
| Sets the global blending factors for combining subsequent renders with the existing frame contents. More...
void | _setSeparateSceneBlendingOperation (SceneBlendOperation op, SceneBlendOperation alphaOp)
virtual void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking=TVC_NONE)
| Sets the surface properties to be used for future rendering. More...
void | _setTexture (size_t unit, bool enabled, const TexturePtr &tex)
| Sets the texture to bind to a given texture unit. More...
void | _setTextureAddressingMode (size_t stage, const TextureUnitState::UVWAddressingMode &uvw)
| Sets the texture addressing mode for a texture unit. More...
virtual void | _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
| Sets the texture blend modes from a TextureUnitState record. More...
void | _setTextureBorderColour (size_t stage, const ColourValue &colour)
| Sets the texture border colour for a texture unit. More...
virtual void | _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)
| Sets a method for automatically calculating texture coordinates for a stage. More...
void | _setTextureCoordSet (size_t stage, size_t index)
| Sets the texture coordinate set to use for a texture unit. More...
void | _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)
| Sets the maximal anisotropy for the specified texture unit. More...
virtual void | _setTextureMatrix (size_t unit, const Matrix4 &xform)
| Sets the texture coordinate transformation matrix for a texture unit. More...
void | _setTextureMipmapBias (size_t unit, float bias)
| Sets the mipmap bias value for a given texture unit. More...
virtual void | _setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos)
| Notify the rendersystem that it should adjust texture projection to be relative to a different origin. More...
void | _setTextureUnitCompareEnabled (size_t unit, bool compare)
| Sets whether the compare func is enabled or not for this texture unit. More...
void | _setTextureUnitCompareFunction (size_t unit, CompareFunction function)
| Sets the compare function to use for a given texture unit. More...
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
| Sets a single filter for a given texture unit. More...
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
| Utility function for setting all the properties of a texture unit at once. More...
virtual void | _setVertexTexture (size_t unit, const TexturePtr &tex)
| Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler. More...
virtual void | _setViewMatrix (const Matrix4 &m)
| Sets the view transform matrix. More...
void | _setViewport (Viewport *vp)
| Sets the provided viewport as the active one for future rendering operations. More...
virtual void | _setWorldMatrix (const Matrix4 &m)
| Sets the world transform matrix. More...
virtual void | _swapAllRenderTargetBuffers ()
| Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. More...
void | _switchContext (GLContext *context)
| Switch GL context, dealing with involved internal cached states too. More...
void | _unregisterContext (GLContext *context)
| Unregister a render target->context mapping. More...
virtual void | _updateAllRenderTargets (bool swapBuffers=true)
| Internal method for updating all render targets attached to this rendering system. More...
virtual void | _useLights (const LightList &lights, unsigned short limit)
| Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits) More...
void | addClipPlane (const Plane &p)
| Add a user clipping plane. More...
void | addListener (Listener *l)
| Adds a listener to the custom events that this render system can raise. More...
bool | areFixedFunctionLightsInViewSpace () const
| Are fixed-function lights provided in view space? Affects optimisation. More...
void | attachRenderTarget (RenderTarget &target)
| Attaches the passed render target to the render system. More...
virtual void | beginProfileEvent (const String &eventName)
| This marks the beginning of an event for GPU profiling. More...
void | bindGpuProgram (GpuProgram *prg)
| Binds a given GpuProgram (but not the parameters). More...
void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 mask)
| Bind Gpu program parameters. More...
void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)
| Only binds Gpu program parameters used for passes that have more than one iteration rendering. More...
bool | checkExtension (const String &ext) const
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. More...
void | convertColourValue (const ColourValue &colour, uint32 *pDest)
| Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem. More...
GLint | convertCompareFunction (CompareFunction func) const
GLint | convertStencilOp (StencilOperation op, bool invert=false) const
HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)
| Create an object for performing hardware occlusion queries. More...
virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)
| Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...
virtual RenderSystemCapabilities * | createRenderSystemCapabilities () const
| Query the real capabilities of the GPU and driver in the RenderSystem. More...
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
| Destroy a hardware occlusion query object. More...
virtual void | destroyRenderTarget (const String &name)
| Destroys a render target of any sort. More...
virtual void | destroyRenderTexture (const String &name)
| Destroys a render texture. More...
void | destroyRenderWindow (const String &name)
| Destroys a render window. More...
virtual RenderTarget * | detachRenderTarget (const String &name)
| Detaches the render target with the passed name from the render system and returns a pointer to it. More...
virtual void | endProfileEvent (void)
| Ends the currently active GPU profiling event. More...
const RenderSystemCapabilities * | getCapabilities (void) const
| Gets the capabilities of the render system. More...
VertexElementType | getColourVertexElementType (void) const
| Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. More...
ConfigOptionMap & | getConfigOptions (void)
| Returns the details of this API's configuration options. More...
virtual void | getCustomAttribute (const String &name, void *pData)
| Gets a custom (maybe platform-specific) attribute. More...
unsigned int | getDisplayMonitorCount () const
| Gets the number of display monitors. More...
const DriverVersion & | getDriverVersion (void) const
| Returns the driver version. More...
HardwareVertexBufferSharedPtr | getGlobalInstanceVertexBuffer () const
| Returns the global instance vertex buffer. More...
VertexDeclaration * | getGlobalInstanceVertexBufferVertexDeclaration () const
| Gets vertex declaration for the global vertex buffer for the global instancing. More...
size_t | getGlobalNumberOfInstances () const
| Gets the global number of instances. More...
GLES2Support * | getGLSupportRef ()
Real | getHorizontalTexelOffset (void)
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
bool | getInvertVertexWinding (void) const
| Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...
Real | getMaximumDepthInputValue (void)
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More...
Real | getMinimumDepthInputValue (void)
| Gets the minimum (closest) depth value to be used when rendering using identity transforms. More...
RenderSystemCapabilities * | getMutableCapabilities ()
| Get a pointer to the current capabilities being used by the RenderSystem. More...
const String & | getName (void) const
| Returns the name of the rendering system. More...
uint16 | getNativeShadingLanguageVersion () const
| Gets the native shading language version for this render system. More...
const StringVector & | getRenderSystemEvents (void) const
| Gets a list of the rendersystem specific events that this rendersystem can raise. More...
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. More...
RenderTargetIterator | getRenderTargetIterator (void)
| Returns a specialised MapIterator over all render targets attached to the RenderSystem. More...
Real | getVerticalTexelOffset (void)
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
bool | getWBufferEnabled (void) const
| Returns true if the renderer will try to use W-buffers when available. More...
virtual bool | hasAnisotropicMipMapFilter () const
| Determines if the system has anisotropic mip map filter support. More...
bool | hasMinGLVersion (int major, int minor) const
void | initialiseContext (RenderWindow *primary)
void | initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary)
| Initialize the render system from the capabilities. More...
bool | isGpuProgramBound (GpuProgramType gptype)
| Returns whether or not a Gpu program of the given type is currently bound. More...
virtual bool | isStaticBufferLockable () const
| Returns whether under the current render system buffers marked as TU_STATIC can be locked for update More...
virtual void | markProfileEvent (const String &eventName)
| Marks an instantaneous event for graphics profilers. More...
| OGRE_MUTEX (mThreadInitMutex)
void | postExtraThreadsStarted ()
| Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered. More...
void | preExtraThreadsStarted ()
| Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered. More...
void | registerThread ()
| Register the an additional thread which may make calls to rendersystem-related objects. More...
void | reinitialise (void)
| Restart the renderer (normally following a change in settings). More...
void | removeListener (Listener *l)
| Remove a listener to the custom events that this render system can raise. More...
void | resetClipPlanes ()
| Clears the user clipping region. More...
virtual void | setAmbientLight (float r, float g, float b)
| Sets the colour & strength of the ambient (global directionless) light in the world. More...
void | setAmbientLight (const ColourValue &c)
virtual void | setClipPlanes (const PlaneList &clipPlanes)
| Sets the user clipping region. More...
void | setClipPlanesImpl (const Ogre::PlaneList &planeList)
| Internal method used to set the underlying clip planes when needed. More...
void | setConfigOption (const String &name, const String &value)
| Sets an option for this API. More...
virtual void | setCurrentPassIterationCount (const size_t count)
| set the current multi pass count value. More...
void | setDepthBufferFor (RenderTarget *renderTarget)
| Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More...
void | setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f)
| Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. More...
virtual bool | setDrawBuffer (ColourBufferType colourBuffer)
| Sets the colour buffer that the render system will to draw. More...
void | setGlobalInstanceVertexBuffer (const HardwareVertexBufferSharedPtr &val)
| Sets the global instance vertex buffer. More...
void | setGlobalInstanceVertexBufferVertexDeclaration (VertexDeclaration *val)
| Sets vertex declaration for the global vertex buffer for the global instancing. More...
void | setGlobalNumberOfInstances (const size_t val)
| Sets the global number of instances. More...
void | setInvertVertexWinding (bool invert)
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. More...
virtual void | setLightingEnabled (bool enabled)
| Sets whether or not dynamic lighting is enabled. More...
virtual void | setNormaliseNormals (bool normalise)
| Sets whether or not normals are to be automatically normalised. More...
void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)
| Sets the 'scissor region' i.e. More...
virtual void | setShadingType (ShadeOptions so)
| Sets the type of light shading required (default = Gouraud). More...
void | setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 compareMask=0xFFFFFFFF, uint32 writeMask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false, bool readBackAsTexture=false)
| Determines if this system supports hardware accelerated stencil buffer. More...
void | setStencilCheckEnabled (bool enabled)
| Turns depth-stencil buffer checking on or off. More...
void | setWBufferEnabled (bool enabled)
| Sets whether or not W-buffers are enabled if they are available for this renderer. More...
void | shutdown (void)
| Shutdown the renderer and cleanup resources. More...
void | unbindGpuProgram (GpuProgramType gptype)
| Unbinds GpuPrograms of a given GpuProgramType. More...
void | unregisterThread ()
| Unregister an additional thread which may make calls to rendersystem-related objects. More...
void | useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
| Force the render system to use the special capabilities. More...
String | validateConfigOptions (void)
| Validates the options set for the rendering system, returning a message if there are problems. More...

## Static Public Member Functions
static Listener * | getSharedListener (void)
| Retrieve a pointer to the current shared render system listener. More...
static void | setSharedListener (Listener *listener)
| Sets shared listener. More...

## Friends
class | ShaderGeneratorTechniqueResolverListener

## Detailed Description

Implementation of GL ES 2.x as a rendering system.

## Member Typedef Documentation

## ◆ RenderTargetIterator

typedef MapIterator<Ogre::RenderTargetMap> Ogre::RenderSystem::RenderTargetIterator
| inherited

Iterator over RenderTargets.

## Member Function Documentation

## ◆ _getMainContext()

GLContext* Ogre::GLRenderSystemCommon::_getMainContext | ( |  | ) |
| inline inherited

Returns the main context.

## ◆ _getCurrentContext()

GLContext* Ogre::GLRenderSystemCommon::_getCurrentContext | ( |  | ) |
| inline inherited

Returns the current context.

## ◆ getHorizontalTexelOffset()

Real Ogre::GLRenderSystemCommon::getHorizontalTexelOffset | ( | void |  | ) |
| inline virtual inherited

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.

## ◆ getVerticalTexelOffset()

Real Ogre::GLRenderSystemCommon::getVerticalTexelOffset | ( | void |  | ) |
| inline virtual inherited

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.

## ◆ getMinimumDepthInputValue()

Real Ogre::GLRenderSystemCommon::getMinimumDepthInputValue | ( | void |  | ) |
| inline virtual inherited

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::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

## ◆ getMaximumDepthInputValue()

Real Ogre::GLRenderSystemCommon::getMaximumDepthInputValue | ( | void |  | ) |
| inline virtual inherited

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::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

## ◆ getColourVertexElementType()

VertexElementType Ogre::GLRenderSystemCommon::getColourVertexElementType | ( | void |  | ) | const
| inline virtual inherited

Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.

Implements Ogre::RenderSystem.

References Ogre::VET_COLOUR_ABGR.

## ◆ reinitialise()

void Ogre::GLRenderSystemCommon::reinitialise | ( | void |  | ) |
| inline virtual inherited

Restart the renderer (normally following a change in settings).

Implements Ogre::RenderSystem.

## ◆ _convertProjectionMatrix()

void Ogre::GLRenderSystemCommon::_convertProjectionMatrix | ( | const Matrix4 & | matrix,
|  | Matrix4 & | dest,
|  | bool | forGpuProgram
| ) |  |
| inline virtual inherited

Converts a uniform projection matrix to suitable for this render system.

Remarks
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

## ◆ _makeProjectionMatrix() [1/2]

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

Builds a perspective projection matrix suitable for this render system.

Remarks
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

## ◆ _makeProjectionMatrix() [2/2]

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

Builds a perspective projection matrix for the case when frustum is not centered around camera.

Remarks
  Viewport coordinates are in camera coordinate frame, i.e. camera is at the origin.

Implements Ogre::RenderSystem.

## ◆ _makeOrthoMatrix()

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

Builds an orthographic projection matrix suitable for this render system.

Remarks
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

## ◆ _applyObliqueDepthProjection()

void Ogre::GLRenderSystemCommon::_applyObliqueDepthProjection | ( | Matrix4 & | matrix,
|  | const Plane & | plane,
|  | bool | forGpuProgram
| ) |  |
| virtual inherited

Update a perspective projection matrix to use 'oblique depth projection'.

Remarks
  This method can be used to change the nature of a perspective transform in order to make the near plane not perpendicular to the camera view direction, but to be at some different orientation. This can be useful for performing arbitrary clipping (e.g. to a reflection plane) which could otherwise only be done using user clip planes, which are more expensive, and not necessarily supported on all cards.

Parameters

  matrix | The existing projection matrix. Note that this must be a perspective transform (not orthographic), and must not have already been altered by this method. The matrix will be altered in-place.
  plane | The plane which is to be used as the clipping plane. This plane must be in CAMERA (view) space.
  forGpuProgram | Is this for use with a Gpu program or fixed-function

Implements Ogre::RenderSystem.

## ◆ _completeDeferredVaoFboDestruction()

void Ogre::GLRenderSystemCommon::_completeDeferredVaoFboDestruction | ( |  | ) |
| inherited

Complete destruction of VAOs and FBOs deferred while creator context was not current.

## ◆ destroyHardwareOcclusionQuery()

virtual void Ogre::RenderSystem::destroyHardwareOcclusionQuery | ( | HardwareOcclusionQuery * | hq | ) |
| virtual inherited

Destroy a hardware occlusion query object.

## ◆ isStaticBufferLockable()

virtual bool Ogre::RenderSystem::isStaticBufferLockable | ( |  | ) | const
| inline virtual inherited

Returns whether under the current render system buffers marked as TU_STATIC can be locked for update

Remarks
  Needed in the implementation of DirectX9 with DirectX9Ex driver

Reimplemented in Ogre::D3D9RenderSystem.

## ◆ getMutableCapabilities()

RenderSystemCapabilities* Ogre::RenderSystem::getMutableCapabilities | ( |  | ) |
| inline inherited

Get a pointer to the current capabilities being used by the RenderSystem.

Remarks
  The capabilities may be modified using this pointer, this will only have an effect before the RenderSystem has been initialised. It's intended use is to allow a listener of the RenderSystemCapabilitiesCreated event to customise the capabilities on the fly before the RenderSystem is initialised.

## ◆ useCustomRenderSystemCapabilities()

void Ogre::RenderSystem::useCustomRenderSystemCapabilities | ( | RenderSystemCapabilities * | capabilities | ) |
| inherited

Force the render system to use the special capabilities.

Can only be called before the render system has been fully initializer (before createWindow is called)

Parameters

  capabilities | has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities.

## ◆ setAmbientLight() [1/2]

virtual void Ogre::RenderSystem::setAmbientLight | ( | float | r,
|  | float | g,
|  | float | b
| ) |  |
| inline virtual inherited

Sets the colour & strength of the ambient (global directionless) light in the world.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ setAmbientLight() [2/2]

void Ogre::RenderSystem::setAmbientLight | ( | const ColourValue & | c | ) |
| inline inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::ColourValue::r, and Ogre::RenderSystem::setAmbientLight().

Referenced by Ogre::RenderSystem::setAmbientLight().

## ◆ setShadingType()

virtual void Ogre::RenderSystem::setShadingType | ( | ShadeOptions | so | ) |
| inline virtual inherited

Sets the type of light shading required (default = Gouraud).

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ setLightingEnabled()

virtual void Ogre::RenderSystem::setLightingEnabled | ( | bool | enabled | ) |
| inline virtual inherited

Sets whether or not dynamic lighting is enabled.

Parameters

  enabled | If true, dynamic lighting is performed on geometry with normals supplied, geometry without normals will not be displayed. If false, no lighting is applied and all geometry will be full brightness.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ setWBufferEnabled()

void Ogre::RenderSystem::setWBufferEnabled | ( | bool | enabled | ) |
| inherited

Sets whether or not W-buffers are enabled if they are available 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 available. W-buffers are enabled by default for 16bit depth buffers and disabled for all other depths.

## ◆ getWBufferEnabled()

bool Ogre::RenderSystem::getWBufferEnabled | ( | void |  | ) | const
| inherited

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

## ◆ _createRenderWindows()

virtual bool Ogre::RenderSystem::_createRenderWindows | ( | const RenderWindowDescriptionList & | renderWindowDescriptions,
|  | RenderWindowList & | createdWindows
| ) |  |
| virtual inherited

Creates multiple rendering windows.

Parameters

  renderWindowDescriptions | Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow: name width height fullScreen miscParams See _createRenderWindow for details about each member.
  createdWindows | This array will hold the created render windows.

Returns
  true on success.

Reimplemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.

## ◆ destroyRenderTexture()

virtual void Ogre::RenderSystem::destroyRenderTexture | ( | const String & | name | ) |
| virtual inherited

Destroys a render texture.

## ◆ destroyRenderTarget()

virtual void Ogre::RenderSystem::destroyRenderTarget | ( | const String & | name | ) |
| virtual inherited

Destroys a render target of any sort.

Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

## ◆ attachRenderTarget()

void Ogre::RenderSystem::attachRenderTarget | ( | RenderTarget & | target | ) |
| inherited

Attaches the passed render target to the render system.

## ◆ getRenderTarget()

RenderTarget* Ogre::RenderSystem::getRenderTarget | ( | const String & | name | ) |
| inherited

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

## ◆ detachRenderTarget()

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.

Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

## ◆ getRenderTargetIterator()

RenderTargetIterator Ogre::RenderSystem::getRenderTargetIterator | ( | void |  | ) |
| inline inherited

Returns a specialised MapIterator over all render targets attached to the RenderSystem.

## ◆ getGlobalInstanceVertexBuffer()

HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer | ( |  | ) | const
| inherited

Returns the global instance vertex buffer.

## ◆ setGlobalInstanceVertexBuffer()

void Ogre::RenderSystem::setGlobalInstanceVertexBuffer | ( | const HardwareVertexBufferSharedPtr & | val | ) |
| inherited

Sets the global instance vertex buffer.

## ◆ getGlobalInstanceVertexBufferVertexDeclaration()

VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration | ( |  | ) | const
| inherited

Gets vertex declaration for the global vertex buffer for the global instancing.

## ◆ setGlobalInstanceVertexBufferVertexDeclaration()

void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration | ( | VertexDeclaration * | val | ) |
| inherited

Sets vertex declaration for the global vertex buffer for the global instancing.

## ◆ getGlobalNumberOfInstances()

size_t Ogre::RenderSystem::getGlobalNumberOfInstances | ( |  | ) | const
| inherited

Gets the global number of instances.

## ◆ setGlobalNumberOfInstances()

void Ogre::RenderSystem::setGlobalNumberOfInstances | ( | const size_t | val | ) |
| inherited

Sets the global number of instances.

## ◆ setDepthBufferFor()

void Ogre::RenderSystem::setDepthBufferFor | ( | RenderTarget * | renderTarget | ) |
| inherited

Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.

Remarks
  RenderTarget's pool ID is respected.

See also
  RenderTarget::setDepthBufferPool()

## ◆ _useLights()

virtual void Ogre::RenderSystem::_useLights | ( | const LightList & | lights,
|  | unsigned short | limit
| ) |  |
| inline virtual inherited

Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits)

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setWorldMatrix()

virtual void Ogre::RenderSystem::_setWorldMatrix | ( | const Matrix4 & | m | ) |
| inline virtual inherited

Sets the world transform matrix.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setViewMatrix()

virtual void Ogre::RenderSystem::_setViewMatrix | ( | const Matrix4 & | m | ) |
| inline virtual inherited

Sets the view transform matrix.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setProjectionMatrix()

virtual void Ogre::RenderSystem::_setProjectionMatrix | ( | const Matrix4 & | m | ) |
| inline virtual inherited

Sets the projection transform matrix.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setTextureUnitSettings()

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.

## ◆ _setBindingType()

virtual void Ogre::RenderSystem::_setBindingType | ( | TextureUnitState::BindingType | bindigType | ) |
| inline virtual inherited

## ◆ _disableTextureUnit()

virtual void Ogre::RenderSystem::_disableTextureUnit | ( | size_t | texUnit | ) |
| virtual inherited

Turns off a texture unit.

Reimplemented in Ogre::D3D9RenderSystem.

## ◆ _disableTextureUnitsFrom()

virtual void Ogre::RenderSystem::_disableTextureUnitsFrom | ( | size_t | texUnit | ) |
| virtual inherited

Disables all texture units from the given unit upwards.

## ◆ _setSurfaceParams()

virtual void Ogre::RenderSystem::_setSurfaceParams | ( | const ColourValue & | ambient,
|  | const ColourValue & | diffuse,
|  | const ColourValue & | specular,
|  | const ColourValue & | emissive,
|  | Real | shininess,
|  | TrackVertexColourType | tracking = `TVC_NONE`
| ) |  |
| inline virtual inherited

Sets the surface properties to be used for future rendering.

This method sets the the properties of the surfaces of objects to be rendered after it. In this context these surface properties are the amount of each type of light the object reflects (determining it's colour under different types of light), whether it emits light itself, and how shiny it is. Textures are not dealt with here, see the _setTetxure method for details. This method is used by _setMaterial so does not need to be called direct if that method is being used.

Parameters

  ambient | The amount of ambient (sourceless and directionless) light an object reflects. Affected by the colour/amount of ambient light in the scene.
  diffuse | The amount of light from directed sources that is reflected (affected by colour/amount of point, directed and spot light sources)
  specular | The amount of specular light reflected. This is also affected by directed light sources but represents the colour at the highlights of the object.
  emissive | The colour of light emitted from the object. Note that this will make an object seem brighter and not dependent on lights in the scene, but it will not act as a light, so will not illuminate other objects. Use a light attached to the same SceneNode as the object for this purpose.
  shininess | A value which only has an effect on specular highlights (so specular must be non-black). The higher this value, the smaller and crisper the specular highlights will be, imitating a more highly polished surface. This value is not constrained to 0.0-1.0, in fact it is likely to be more (10.0 gives a modest sheen to an object).
  tracking | A bit field that describes which of the ambient, diffuse, specular and emissive colours follow the vertex colour of the primitive. When a bit in this field is set its ColourValue is ignored. This is a combination of TVC_AMBIENT, TVC_DIFFUSE, TVC_SPECULAR(note that the shininess value is still taken from shininess) and TVC_EMISSIVE. TVC_NONE means that there will be no material property tracking the vertex colours.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setPointSpritesEnabled()

virtual void Ogre::RenderSystem::_setPointSpritesEnabled | ( | bool | enabled | ) |
| inline virtual inherited

Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.

Parameters

  enabled | True enables point sprites, false returns to normal point rendering.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setPointParameters()

virtual void Ogre::RenderSystem::_setPointParameters | ( | Real | size,
|  | bool | attenuationEnabled,
|  | Real | constant,
|  | Real | linear,
|  | Real | quadratic,
|  | Real | minSize,
|  | Real | maxSize
| ) |  |
| inline virtual inherited

Sets the size of points and how they are attenuated with distance.

Remarks
  When performing point rendering or point sprite rendering, point size can be attenuated with distance. The equation for doing this is attenuation = 1 / (constant + linear * dist + quadratic * d^2) .

  For example, to disable distance attenuation (constant screensize) you would set constant to 1, and linear and quadratic to 0. A standard perspective attenuation would be 0, 1, 0 respectively.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setVertexTexture()

virtual void Ogre::RenderSystem::_setVertexTexture | ( | size_t | unit,
|  | const TexturePtr & | tex
| ) |  |
| virtual inherited

Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler.

Remarks
  Not all rendersystems support separate vertex samplers. For those that do, you can set a texture for them, separate to the regular texture samplers, using this method. For those that don't, you should use the regular texture samplers which are shared between the vertex and fragment units; calling this method will throw an exception.

Deprecated:
  only needed for D3D9

Reimplemented in Ogre::D3D9RenderSystem.

## ◆ _setTextureCoordCalculation()

virtual void Ogre::RenderSystem::_setTextureCoordCalculation | ( | size_t | unit,
|  | TexCoordCalcMethod | m,
|  | const Frustum * | frustum = `0`
| ) |  |
| inline virtual inherited

Sets a method for automatically calculating texture coordinates for a stage.

Should not be used by apps - for use by Ogre only.

Parameters

  unit | Texture unit as above
  m | Calculation method to use
  frustum | Optional Frustum param, only used for projective effects

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setTextureBlendMode()

virtual void Ogre::RenderSystem::_setTextureBlendMode | ( | size_t | unit,
|  | const LayerBlendModeEx & | bm
| ) |  |
| inline virtual inherited

Sets the texture blend modes from a TextureUnitState record.

Meant for use internally only - apps should use the Material and TextureUnitState classes.

Parameters

  unit | Texture unit as above
  bm | Details of the blending mode

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setTextureMatrix()

virtual void Ogre::RenderSystem::_setTextureMatrix | ( | size_t | unit,
|  | const Matrix4 & | xform
| ) |  |
| inline virtual inherited

Sets the texture coordinate transformation matrix for a texture unit.

Parameters

  unit | Texture unit to affect
  xform | The 4x4 matrix

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _setTextureProjectionRelativeTo()

virtual void Ogre::RenderSystem::_setTextureProjectionRelativeTo | ( | bool | enabled,
|  | const Vector3 & | pos
| ) |  |
| virtual inherited

Notify the rendersystem that it should adjust texture projection to be relative to a different origin.

## ◆ _cleanupDepthBuffers()

void Ogre::RenderSystem::_cleanupDepthBuffers | ( | bool | bCleanManualBuffers = `true` | ) |
| inherited

Removes all depth buffers.

Should be called on device lost and shutdown

Remarks
  Advanced users can call this directly with bCleanManualBuffers=false to remove all depth buffers created for RTTs; when they think the pool has grown too big or they've used lots of depth buffers they don't need anymore, freeing GPU RAM.

## ◆ _pauseFrame()

virtual RenderSystemContext* Ogre::RenderSystem::_pauseFrame | ( | void |  | ) |
| virtual inherited

Pause rendering for a frame.

This has to be called after _beginFrame and before _endFrame. Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.

Reimplemented in Ogre::D3D9RenderSystem.

## ◆ _resumeFrame()

virtual void Ogre::RenderSystem::_resumeFrame | ( | RenderSystemContext * | context | ) |
| virtual inherited

Resume rendering for a frame.

This has to be called after a _pauseFrame call Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.

Parameters

  context | the render system context, as returned by _pauseFrame

Reimplemented in Ogre::D3D9RenderSystem.

## ◆ _getViewport()

virtual Viewport* Ogre::RenderSystem::_getViewport | ( | void |  | ) |
| virtual inherited

Get the current active viewport for rendering.

## ◆ _getCullingMode()

virtual CullingMode Ogre::RenderSystem::_getCullingMode | ( | void |  | ) | const
| virtual inherited

## ◆ _setFog()

virtual void Ogre::RenderSystem::_setFog | ( | FogMode | mode = `FOG_NONE`,
|  | const ColourValue & | colour = `ColourValue::White`,
|  | Real | expDensity = `1.0`,
|  | Real | linearStart = `0.0`,
|  | Real | linearEnd = `1.0`
| ) |  |
| inline virtual inherited

Sets the fogging mode for future geometry.

Parameters

  mode | Set up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off.
  colour | The colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox.
  expDensity | The density of the fog in FOG_EXP or FOG_EXP2 mode, as a value between 0 and 1. The default is 1. i.e. completely opaque, lower values can mean that fog never completely obscures the scene.
  linearStart | Distance at which linear fog starts to encroach. The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR.
  linearEnd | Distance at which linear fog becomes completely opaque.The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ _beginGeometryCount()

virtual void Ogre::RenderSystem::_beginGeometryCount | ( | void |  | ) |
| virtual inherited

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

## ◆ _getFaceCount()

virtual unsigned int Ogre::RenderSystem::_getFaceCount | ( | void |  | ) | const
| virtual inherited

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

## ◆ _getBatchCount()

virtual unsigned int Ogre::RenderSystem::_getBatchCount | ( | void |  | ) | const
| virtual inherited

Reports the number of batches rendered since the last _beginGeometryCount call.

## ◆ _getVertexCount()

virtual unsigned int Ogre::RenderSystem::_getVertexCount | ( | void |  | ) | const
| virtual inherited

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

## ◆ convertColourValue()

void Ogre::RenderSystem::convertColourValue | ( | const ColourValue & | colour,
|  | uint32 * | pDest
| ) |  |
| 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.

## ◆ setNormaliseNormals()

virtual void Ogre::RenderSystem::setNormaliseNormals | ( | bool | normalise | ) |
| inline virtual inherited

Sets whether or not normals are to be automatically normalised.

Remarks
  This is useful when, for example, you are scaling SceneNodes such that normals may not be unit-length anymore. Note though that this has an overhead so should not be turn on unless you really need it.

  You should not normally call this direct unless you are rendering world geometry; set it on the Renderable because otherwise it will be overridden by material settings.

Deprecated:
  only needed for fixed function APIs

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

## ◆ getCapabilities()

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities | ( | void |  | ) | const
| inline inherited

Gets the capabilities of the render system.

## ◆ getDriverVersion()

const DriverVersion& Ogre::RenderSystem::getDriverVersion | ( | void |  | ) | const
| inline inherited

Returns the driver version.

## ◆ _getDefaultViewportMaterialScheme()

const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme | ( | void |  | ) | const
| inherited

Returns the default material scheme used by the render system.

Systems that use the RTSS to emulate a fixed function pipeline (e.g. OpenGL ES 2, GL3+, DX11) need to return the default material scheme of the RTSS ShaderGenerator.

This is currently only used to set the default material scheme for viewports. It is a necessary step on these render systems for render textures to be rendered into properly.

## ◆ isGpuProgramBound()

bool Ogre::RenderSystem::isGpuProgramBound | ( | GpuProgramType | gptype | ) |
| inherited

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

## ◆ getNativeShadingLanguageVersion()

uint16 Ogre::RenderSystem::getNativeShadingLanguageVersion | ( |  | ) | const
| inline inherited

Gets the native shading language version for this render system.

Formatted so that it can be used within a shading program. For example, OpenGL 3.2 would return 150, while 3.3 would return 330

## ◆ setClipPlanes()

virtual void Ogre::RenderSystem::setClipPlanes | ( | const PlaneList & | clipPlanes | ) |
| virtual inherited

Sets the user clipping region.

## ◆ addClipPlane()

void Ogre::RenderSystem::addClipPlane | ( | const Plane & | p | ) |
| inherited

Add a user clipping plane.

## ◆ resetClipPlanes()

void Ogre::RenderSystem::resetClipPlanes | ( |  | ) |
| inherited

Clears the user clipping region.

## ◆ _initRenderTargets()

void Ogre::RenderSystem::_initRenderTargets | ( | void |  | ) |
| inherited

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

## ◆ _notifyCameraRemoved()

void Ogre::RenderSystem::_notifyCameraRemoved | ( | const Camera * | cam | ) |
| inherited

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

## ◆ _updateAllRenderTargets()

virtual void Ogre::RenderSystem::_updateAllRenderTargets | ( | bool | swapBuffers = `true` | ) |
| virtual inherited

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

Reimplemented in Ogre::D3D11RenderSystem.

## ◆ _swapAllRenderTargetBuffers()

virtual void Ogre::RenderSystem::_swapAllRenderTargetBuffers | ( |  | ) |
| virtual inherited

Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter.

Reimplemented in Ogre::D3D11RenderSystem.

## ◆ setInvertVertexWinding()

void Ogre::RenderSystem::setInvertVertexWinding | ( | bool | invert | ) |
| inherited

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

## ◆ getInvertVertexWinding()

bool Ogre::RenderSystem::getInvertVertexWinding | ( | void |  | ) | const
| inherited

Indicates whether or not the vertex windings set will be inverted for the current render (e.g.

reflections)

See also
  RenderSystem::setInvertVertexWinding

## ◆ setCurrentPassIterationCount()

virtual void Ogre::RenderSystem::setCurrentPassIterationCount | ( | const size_t | count | ) |
| inline virtual 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.

## ◆ setDeriveDepthBias()

void Ogre::RenderSystem::setDeriveDepthBias | ( | bool | derive,
|  | float | baseValue = `0.0f`,
|  | float | multiplier = `0.0f`,
|  | float | slopeScale = `0.0f`
| ) |  |
| inline inherited

Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount.

The depth bias set will be baseValue + iteration * multiplier

Parameters

  derive | True to tell the RS to derive this automatically
  baseValue | The base value to which the multiplier should be added
  multiplier | The amount of depth bias to apply per iteration
  slopeScale | The constant slope scale bias for completeness

## ◆ setSharedListener()

static void Ogre::RenderSystem::setSharedListener | ( | Listener * | listener | ) |
| static inherited

Sets shared listener.

Remarks
  Shared listener could be set even if no render system is selected yet. This listener will receive "RenderSystemChanged" event on each Root::setRenderSystem call.

## ◆ getSharedListener()

static Listener* Ogre::RenderSystem::getSharedListener | ( | void |  | ) |
| static inherited

Retrieve a pointer to the current shared render system listener.

## ◆ addListener()

void Ogre::RenderSystem::addListener | ( | Listener * | l | ) |
| 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

## ◆ removeListener()

void Ogre::RenderSystem::removeListener | ( | Listener * | l | ) |
| inherited

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

## ◆ getRenderSystemEvents()

const StringVector& Ogre::RenderSystem::getRenderSystemEvents | ( | void |  | ) | const
| inline inherited

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

See also
  RenderSystem::addListener

## ◆ getCustomAttribute()

virtual void Ogre::RenderSystem::getCustomAttribute | ( | const String & | name,
|  | void * | pData
| ) |  |
| virtual inherited

Gets a custom (maybe platform-specific) attribute.

Remarks
  This is a nasty way of satisfying any API's need to see platform-specific details.

Parameters

  name | The name of the attribute.
  pData | Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D11RenderSystem.

## ◆ setDrawBuffer()

virtual bool Ogre::RenderSystem::setDrawBuffer | ( | ColourBufferType | colourBuffer | ) |
| inline virtual inherited

Sets the colour buffer that the render system will to draw.

If the render system implementation or configuration does not support a particular value, then false will be returned and the current colour buffer value will not be modified.

Parameters

  colourBuffer | Specifies the colour buffer that will be drawn into.

Reimplemented in Ogre::D3D9RenderSystem, and Ogre::D3D11RenderSystem.

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

- OgreGLES2RenderSystem.h