OGRE  1.12.4
Object-Oriented Graphics Rendering Engine
Ogre::GLES2RenderSystem Class Reference

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

#include <OgreGLES2RenderSystem.h>

+ Inheritance diagram for Ogre::GLES2RenderSystem:

Public Types

typedef MapIterator< Ogre::RenderTargetMapRenderTargetIterator
 Iterator over RenderTargets. More...
 
typedef std::vector< VideoModeVideoModes
 

Public Member Functions

 GLES2RenderSystem ()
 
virtual ~GLES2RenderSystem ()
 
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...
 
virtual void _dispatchCompute (const Vector3i &workgroupDim)
 
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...
 
virtual void _getDepthStencilFormatFor (PixelFormat internalColourFormat, uint32 *depthFormat, uint32 *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...
 
void _initialise () override
 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 _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...
 
void _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)
 
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...
 
void _setFog (FogMode f)
 
void _setLineWidth (float width)
 Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More...
 
virtual void _setPointParameters (bool attenuationEnabled, Real minSize, Real maxSize)
 
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...
 
void _setProjectionMatrix (Matrix4 m)
 
void _setRenderTarget (RenderTarget *target)
 Set current render target to target, enabling its GL context if needed. More...
 
void _setSampler (size_t unit, Sampler &sampler)
 set the sampler settings for the given texture unit More...
 
void _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD)
 
void _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp)
 
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 Sampler::UVWAddressingMode &uvw)
 
virtual void _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
 Sets the texture blend modes from a TextureUnitState record. 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...
 
virtual void _setTextureCoordSet (size_t unit, size_t index)
 Sets the texture coordinate set to use for a texture unit. More...
 
virtual void _setTextureMatrix (size_t unit, const Matrix4 &xform)
 Sets the texture coordinate transformation matrix for a 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...
 
virtual void _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
 
void _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
 
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...
 
void _setViewMatrix (const Matrix4 &m)
 
void _setViewport (Viewport *vp)
 Sets the provided viewport as the active one for future rendering operations. More...
 
void _setWorldMatrix (const Matrix4 &m)
 
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 (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 addListener (Listener *l)
 Adds a listener to the custom events that this render system can raise. More...
 
virtual void applyFixedFunctionParams (const GpuProgramParametersPtr &params, uint16 variabilityMask)
 
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, const GpuProgramParametersPtr &params, uint16 mask)
 Bind Gpu program parameters. More...
 
virtual void bindGpuProgramPassIterationParameters (GpuProgramType gptype)
 
bool checkExtension (const String &ext) const
 Check if an extension is available. More...
 
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
 
HardwareOcclusionQuerycreateHardwareOcclusionQuery (void)
 Create an object for performing hardware occlusion queries. More...
 
virtual MultiRenderTargetcreateMultiRenderTarget (const String &name)
 Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...
 
virtual RenderSystemCapabilitiescreateRenderSystemCapabilities () 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 RenderTargetdetachRenderTarget (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 RenderSystemCapabilitiesgetCapabilities (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...
 
const ConfigOptionMapgetConfigOptions () const
 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 DriverVersiongetDriverVersion (void) const
 Returns the driver version. More...
 
virtual const GpuProgramParametersPtrgetFixedFunctionParams (TrackVertexColourType tracking, FogMode fog)
 
HardwareVertexBufferSharedPtr getGlobalInstanceVertexBuffer () const
 Returns the global instance vertex buffer. More...
 
VertexDeclarationgetGlobalInstanceVertexBufferVertexDeclaration () 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...
 
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...
 
RenderSystemCapabilitiesgetMutableCapabilities ()
 Get a pointer to the current capabilities being used by the RenderSystem. More...
 
const StringgetName (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 StringVectorgetRenderSystemEvents (void) const
 Gets a list of the rendersystem specific events that this rendersystem can raise. More...
 
RenderTargetgetRenderTarget (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...
 
RenderWindowDescription getRenderWindowDescription () const
 get a RenderWindowDescription from the current ConfigOptionMap More...
 
Real getVerticalTexelOffset (void)
 Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
 
bool hasMinGLVersion (int major, int minor) const
 Check if GL Version is supported. More...
 
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...
 
bool isReverseDepthBufferEnabled () const
 Returns if reverse Z-buffer is enabled. 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...
 
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...
 
virtual void setClipPlanes (const PlaneList &clipPlanes)
 Sets the user clipping region. More...
 
virtual void setColourBlendState (const ColourBlendState &state)
 Sets the global blending factors for combining subsequent renders with the existing frame contents. 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)
 This method allows you to set all the stencil buffer parameters in one call. More...
 
void setStencilCheckEnabled (bool enabled)
 Turns stencil buffer checking on or off. 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 ()
 Validates the options set for the rendering system, returning a message if there are problems. More...
 

Static Public Member Functions

static ListenergetSharedListener (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

◆ VideoModes

typedef std::vector<VideoMode> Ogre::GLRenderSystemCommon::VideoModes
inherited

◆ RenderTargetIterator

Iterator over RenderTargets.

Member Function Documentation

◆ setConfigOption()

void Ogre::GLRenderSystemCommon::setConfigOption ( const String name,
const String value 
)
virtualinherited

Sets an option for this API.

Remarks
Used to confirm the settings (normally chosen by the user) in order to make the renderer able to initialise with the settings as required. This may be video mode, D3D driver, full screen / windowed etc. Called automatically by the default configuration dialog, and by the restoration of saved settings. These settings are stored and only activated when RenderSystem::initialise or RenderSystem::reinitialise are called.
If using a custom configuration dialog, it is advised that the caller calls RenderSystem::getConfigOptions again, since some options can alter resulting from a selection.
Parameters
nameThe name of the option to alter.
valueThe value to set the option to.

Implements Ogre::RenderSystem.

◆ _getMainContext()

GLContext* Ogre::GLRenderSystemCommon::_getMainContext ( )
inlineinherited

Returns the main context.

◆ _getCurrentContext()

GLContext* Ogre::GLRenderSystemCommon::_getCurrentContext ( )
inlineinherited

Returns the current context.

◆ hasMinGLVersion()

bool Ogre::GLRenderSystemCommon::hasMinGLVersion ( int  major,
int  minor 
) const
inherited

Check if GL Version is supported.

◆ checkExtension()

bool Ogre::GLRenderSystemCommon::checkExtension ( const String ext) const
inherited

Check if an extension is available.

◆ validateConfigOptions()

String Ogre::GLRenderSystemCommon::validateConfigOptions ( )
inlinevirtualinherited

Validates the options set for the rendering system, returning a message if there are problems.

Note
If the returned string is empty, there are no problems.

Implements Ogre::RenderSystem.

References Ogre::BLANKSTRING.

◆ getHorizontalTexelOffset()

Real Ogre::GLRenderSystemCommon::getHorizontalTexelOffset ( void  )
inlinevirtualinherited

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  )
inlinevirtualinherited

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  )
inlinevirtualinherited

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  )
inlinevirtualinherited

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
inlinevirtualinherited

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  )
inlinevirtualinherited

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

Implements Ogre::RenderSystem.

◆ _convertProjectionMatrix()

void Ogre::GLRenderSystemCommon::_convertProjectionMatrix ( const Matrix4 matrix,
Matrix4 dest,
bool  forGpuProgram 
)
virtualinherited

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.

◆ _getDepthStencilFormatFor()

virtual void Ogre::GLRenderSystemCommon::_getDepthStencilFormatFor ( PixelFormat  internalColourFormat,
uint32 depthFormat,
uint32 stencilFormat 
)
virtualinherited

Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE.

Reimplemented in Ogre::GL3PlusRenderSystem.

◆ _completeDeferredVaoFboDestruction()

void Ogre::GLRenderSystemCommon::_completeDeferredVaoFboDestruction ( )
inherited

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

◆ registerThread()

void Ogre::GLRenderSystemCommon::registerThread ( )
virtualinherited

Register the an additional thread which may make calls to rendersystem-related objects.

Remarks
This method should only be called by additional threads during their initialisation. If they intend to use hardware rendering system resources they should call this method before doing anything related to the render system. Some rendering APIs require a per-thread setup and this method will sort that out. It is also necessary to call unregisterThread before the thread shuts down.
Note
This method takes no parameters - it must be called from the thread being registered and that context is enough.

Implements Ogre::RenderSystem.

◆ unregisterThread()

void Ogre::GLRenderSystemCommon::unregisterThread ( )
virtualinherited

Unregister an additional thread which may make calls to rendersystem-related objects.

See also
RenderSystem::registerThread

Implements Ogre::RenderSystem.

◆ preExtraThreadsStarted()

void Ogre::GLRenderSystemCommon::preExtraThreadsStarted ( )
virtualinherited

Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.

Remarks
Call this from your main thread before starting your other threads.
Note
If you start your own threads, there is a specific startup sequence which must be respected and requires synchronisation between the threads:
  1. [Main thread] Call preExtraThreadsStarted()
  2. [Main thread] Start other thread, wait
  3. [Other thread] Call registerThread(), notify main thread & continue
  4. [Main thread] Wake up & call postExtraThreadsStarted()
Once this init sequence is completed the threads are independent but this startup sequence must be respected.

Implements Ogre::RenderSystem.

◆ postExtraThreadsStarted()

void Ogre::GLRenderSystemCommon::postExtraThreadsStarted ( )
virtualinherited

Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered.

See also
RenderSystem::preExtraThreadsStarted

Implements Ogre::RenderSystem.

◆ getConfigOptions()

const ConfigOptionMap& Ogre::RenderSystem::getConfigOptions ( ) const
inlineinherited

Returns the details of this API's configuration options.

Remarks
Each render system must be able to inform the world of what options must/can be specified for it's operation.
These are passed as strings for portability, but grouped into a structure (ConfigOption) which includes both options and current value.
Note that the settings returned from this call are affected by the options that have been set so far, since some options are interdependent.
This routine is called automatically by the default configuration dialogue produced by Root::showConfigDialog or may be used by the caller for custom settings dialogs
Returns
A 'map' of options, i.e. a list of options which is also indexed by option name.

◆ getRenderWindowDescription()

RenderWindowDescription Ogre::RenderSystem::getRenderWindowDescription ( ) const
inherited

get a RenderWindowDescription from the current ConfigOptionMap

◆ destroyHardwareOcclusionQuery()

virtual void Ogre::RenderSystem::destroyHardwareOcclusionQuery ( HardwareOcclusionQuery hq)
virtualinherited

Destroy a hardware occlusion query object.

◆ isStaticBufferLockable()

virtual bool Ogre::RenderSystem::isStaticBufferLockable ( ) const
inlinevirtualinherited

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 ( )
inlineinherited

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
capabilitieshas to be a subset of the real capabilities and the caller is responsible for deallocating capabilities.

◆ getFixedFunctionParams()

virtual const GpuProgramParametersPtr& Ogre::RenderSystem::getFixedFunctionParams ( TrackVertexColourType  tracking,
FogMode  fog 
)
inlinevirtualinherited

◆ _setProjectionMatrix()

void Ogre::RenderSystem::_setProjectionMatrix ( Matrix4  m)
inherited
Deprecated:
migrate to getFixedFunctionParams ASAP. this is very slow now.

◆ _setViewMatrix()

void Ogre::RenderSystem::_setViewMatrix ( const Matrix4 m)
inlineinherited
Deprecated:
migrate to getFixedFunctionParams ASAP. this is very slow now.

References Ogre::GPV_GLOBAL.

◆ _setWorldMatrix()

void Ogre::RenderSystem::_setWorldMatrix ( const Matrix4 m)
inlineinherited
Deprecated:
migrate to getFixedFunctionParams ASAP. this is very slow now.

References Ogre::GPV_PER_OBJECT.

◆ _setFog()

void Ogre::RenderSystem::_setFog ( FogMode  f)
inlineinherited
Deprecated:
migrate to getFixedFunctionParams ASAP. this is very slow now.

References Ogre::TVC_NONE.

◆ _setSceneBlending()

void Ogre::RenderSystem::_setSceneBlending ( SceneBlendFactor  sourceFactor,
SceneBlendFactor  destFactor,
SceneBlendOperation  op = SBO_ADD 
)
inlineinherited
Deprecated:
use setColourBlendState

◆ applyFixedFunctionParams()

virtual void Ogre::RenderSystem::applyFixedFunctionParams ( const GpuProgramParametersPtr params,
uint16  variabilityMask 
)
inlinevirtualinherited

◆ setShadingType()

virtual void Ogre::RenderSystem::setShadingType ( ShadeOptions  so)
inlinevirtualinherited

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)
inlinevirtualinherited

Sets whether or not dynamic lighting is enabled.

Parameters
enabledIf 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.

◆ _createRenderWindows()

virtual bool Ogre::RenderSystem::_createRenderWindows ( const RenderWindowDescriptionList renderWindowDescriptions,
RenderWindowList createdWindows 
)
virtualinherited

Creates multiple rendering windows.

Parameters
renderWindowDescriptionsArray 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.
createdWindowsThis 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)
virtualinherited

Destroys a render texture.

◆ destroyRenderTarget()

virtual void Ogre::RenderSystem::destroyRenderTarget ( const String name)
virtualinherited

Destroys a render target of any sort.

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

◆ 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)
virtualinherited

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::D3D9RenderSystem, and Ogre::D3D11RenderSystem.

◆ getRenderTargetIterator()

RenderTargetIterator Ogre::RenderSystem::getRenderTargetIterator ( void  )
inlineinherited

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()

◆ isReverseDepthBufferEnabled()

bool Ogre::RenderSystem::isReverseDepthBufferEnabled ( ) const
inherited

Returns if reverse Z-buffer is enabled.

If you have large scenes and need big far clip distance but still want to draw objects closer (for example cockpit of a plane) you can enable reverse depth buffer so that the depth buffer precision is greater further away. This enables the OGRE_REVERSED_Z preprocessor define for shaders.

Return values
trueIf reverse Z-buffer is enabled.
falseIf reverse Z-buffer is disabled (default).
See also
setReverseDepthBuffer

◆ _useLights()

virtual void Ogre::RenderSystem::_useLights ( unsigned short  limit)
inlinevirtualinherited

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.

◆ _setTextureUnitSettings()

virtual void Ogre::RenderSystem::_setTextureUnitSettings ( size_t  texUnit,
TextureUnitState tl 
)
virtualinherited

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.

◆ _disableTextureUnit()

virtual void Ogre::RenderSystem::_disableTextureUnit ( size_t  texUnit)
virtualinherited

Turns off a texture unit.

Reimplemented in Ogre::D3D9RenderSystem.

◆ _disableTextureUnitsFrom()

virtual void Ogre::RenderSystem::_disableTextureUnitsFrom ( size_t  texUnit)
virtualinherited

Disables all texture units from the given unit upwards.

◆ _setPointSpritesEnabled()

virtual void Ogre::RenderSystem::_setPointSpritesEnabled ( bool  enabled)
inlinevirtualinherited

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

Parameters
enabledTrue 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 ( bool  attenuationEnabled,
Real  minSize,
Real  maxSize 
)
inlinevirtualinherited
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 
)
virtualinherited

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.

◆ _setTextureCoordSet()

virtual void Ogre::RenderSystem::_setTextureCoordSet ( size_t  unit,
size_t  index 
)
inlinevirtualinherited

Sets the texture coordinate set to use for a texture unit.

Meant for use internally - not generally used directly by apps - the Material and TextureUnitState classes let you manage textures far more easily.

Parameters
unitTexture unit as above
indexThe index of the texture coordinate set to use.
Deprecated:
only needed for fixed function APIs

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

◆ _setTextureCoordCalculation()

virtual void Ogre::RenderSystem::_setTextureCoordCalculation ( size_t  unit,
TexCoordCalcMethod  m,
const Frustum frustum = 0 
)
inlinevirtualinherited

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

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

Parameters
unitTexture unit as above
mCalculation method to use
frustumOptional 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 
)
inlinevirtualinherited

Sets the texture blend modes from a TextureUnitState record.

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

Parameters
unitTexture unit as above
bmDetails 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 
)
inlinevirtualinherited

Sets the texture coordinate transformation matrix for a texture unit.

Parameters
unitTexture unit to affect
xformThe 4x4 matrix
Deprecated:
only needed for fixed function APIs

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

◆ setColourBlendState()

◆ _setTextureProjectionRelativeTo()

virtual void Ogre::RenderSystem::_setTextureProjectionRelativeTo ( bool  enabled,
const Vector3 pos 
)
virtualinherited

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  )
virtualinherited

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)
virtualinherited

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
contextthe render system context, as returned by _pauseFrame

Reimplemented in Ogre::D3D9RenderSystem.

◆ _getViewport()

virtual Viewport* Ogre::RenderSystem::_getViewport ( void  )
virtualinherited

Get the current active viewport for rendering.

◆ _getCullingMode()

virtual CullingMode Ogre::RenderSystem::_getCullingMode ( void  ) const
virtualinherited

◆ _beginGeometryCount()

virtual void Ogre::RenderSystem::_beginGeometryCount ( void  )
virtualinherited

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

◆ _getFaceCount()

virtual unsigned int Ogre::RenderSystem::_getFaceCount ( void  ) const
virtualinherited

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

◆ _getBatchCount()

virtual unsigned int Ogre::RenderSystem::_getBatchCount ( void  ) const
virtualinherited

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

◆ _getVertexCount()

virtual unsigned int Ogre::RenderSystem::_getVertexCount ( void  ) const
virtualinherited

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
colourThe colour to convert
pDestPointer to location to put the result.

◆ setNormaliseNormals()

virtual void Ogre::RenderSystem::setNormaliseNormals ( bool  normalise)
inlinevirtualinherited

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.

◆ _dispatchCompute()

virtual void Ogre::RenderSystem::_dispatchCompute ( const Vector3i workgroupDim)
inlinevirtualinherited

◆ getCapabilities()

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities ( void  ) const
inlineinherited

Gets the capabilities of the render system.

◆ getDriverVersion()

const DriverVersion& Ogre::RenderSystem::getDriverVersion ( void  ) const
inlineinherited

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.

◆ bindGpuProgramPassIterationParameters()

virtual void Ogre::RenderSystem::bindGpuProgramPassIterationParameters ( GpuProgramType  gptype)
inlinevirtualinherited
Deprecated:
do not use

◆ 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
inlineinherited

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

References Ogre::ColourValue::Black.

◆ setClipPlanes()

virtual void Ogre::RenderSystem::setClipPlanes ( const PlaneList clipPlanes)
virtualinherited

Sets the user clipping region.

Deprecated:
only needed for fixed function APIs

◆ _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)
virtualinherited

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

Reimplemented in Ogre::D3D11RenderSystem.

◆ _swapAllRenderTargetBuffers()

virtual void Ogre::RenderSystem::_swapAllRenderTargetBuffers ( )
virtualinherited

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)
inlinevirtualinherited

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
countNumber 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 
)
inlineinherited

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
deriveTrue to tell the RS to derive this automatically
baseValueThe base value to which the multiplier should be added
multiplierThe amount of depth bias to apply per iteration
slopeScaleThe constant slope scale bias for completeness

◆ setSharedListener()

static void Ogre::RenderSystem::setSharedListener ( Listener listener)
staticinherited

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  )
staticinherited

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
inlineinherited

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 
)
virtualinherited

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
nameThe name of the attribute.
pDataPointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D11RenderSystem.

◆ setDrawBuffer()

virtual bool Ogre::RenderSystem::setDrawBuffer ( ColourBufferType  colourBuffer)
inlinevirtualinherited

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
colourBufferSpecifies the colour buffer that will be drawn into.

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

References OGRE_MAX_TEXTURE_LAYERS.


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