OGRE: Ogre::RenderSystem Class Reference - OGRE Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

# Ogre::RenderSystem Class Reference

Defines the functionality of a 3D API. More...

`#include <OgreRenderSystem.h>`

List of all members.

## Public Types

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

## Public Member Functions

| RenderSystem ()
| Default Constructor.
virtual | ~RenderSystem ()
| Destructor.
virtual const String & | getName (void) const =0
| Returns the name of the rendering system.
virtual ConfigOptionMap & | getConfigOptions (void)=0
| Returns the details of this API's configuration options.
virtual void | setConfigOption (const String &name, const String &value)=0
| Sets an option for this API.
virtual HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)=0
| Create an object for performing hardware occlusion queries.
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
| Destroy a hardware occlusion query object.
virtual String | validateConfigOptions (void)=0
| Validates the options set for the rendering system, returning a message if there are problems.
virtual RenderWindow * | initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
| Start up the renderer using the settings selected (Or the defaults if none have been selected).
virtual void | reinitialise (void)=0
| Restart the renderer (normally following a change in settings).
virtual void | shutdown (void)
| Shutdown the renderer and cleanup resources.
virtual void | setAmbientLight (float r, float g, float b)=0
| Sets the colour & strength of the ambient (global directionless) light in the world.
virtual void | setShadingType (ShadeOptions so)=0
| Sets the type of light shading required (default = Gouraud).
virtual void | setLightingEnabled (bool enabled)=0
| Sets whether or not dynamic lighting is enabled.
void | setWBufferEnabled (bool enabled)
| Sets whether or not W-buffers are enabled if they are avalible for this renderer.
bool | getWBufferEnabled (void) const
| Returns true if the renderer will try to use W-buffers when avalible.
virtual RenderWindow * | createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0
| Creates a new rendering window.
RenderTexture * | createRenderTexture (const String &name, unsigned int width, unsigned int height, TextureType texType=TEX_TYPE_2D, PixelFormat internalFormat=PF_X8R8G8B8, const NameValuePairList *miscParams=0)
| Creates and registers a render texture object.
virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)=0
| Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once.
virtual void | destroyRenderWindow (const String &name)
| Destroys a render window.
virtual void | destroyRenderTexture (const String &name)
| Destroys a render texture.
virtual void | destroyRenderTarget (const String &name)
| Destroys a render target of any sort.
virtual void | attachRenderTarget (RenderTarget &target)
| Attaches the passed render target to the render system.
virtual RenderTarget * | getRenderTarget (const String &name)
| Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.
virtual RenderTarget * | detachRenderTarget (const String &name)
| Detaches the render target with the passed name from the render system and returns a pointer to it.
virtual RenderTargetIterator | getRenderTargetIterator (void)
| Returns a specialised MapIterator over all render targets attached to the RenderSystem.
virtual String | getErrorDescription (long errorNumber) const =0
| Returns a description of an error code.
void | setWaitForVerticalBlank (bool enabled)
| Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers.
bool | getWaitForVerticalBlank (void) const
| Returns true if the system is synchronising frames with the monitor vertical blank.
virtual void | _useLights (const LightList &lights, unsigned short limit)=0
| 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).
virtual void | _setWorldMatrix (const Matrix4 &m)=0
| Sets the world transform matrix.
virtual void | _setWorldMatrices (const Matrix4 *m, unsigned short count)
| Sets multiple world matrices (vertex blending).
virtual void | _setViewMatrix (const Matrix4 &m)=0
| Sets the view transform matrix.
virtual void | _setProjectionMatrix (const Matrix4 &m)=0
| Sets the projection transform matrix.
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
| Utility function for setting all the properties of a texture unit at once.
virtual void | _disableTextureUnit (size_t texUnit)
| Turns off a texture unit.
virtual void | _disableTextureUnitsFrom (size_t texUnit)
| Disables all texture units from the given unit upwards.
virtual void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking=TVC_NONE)=0
| Sets the surface properties to be used for future rendering.
virtual void | _setPointSpritesEnabled (bool enabled)=0
| Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
virtual void | _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)=0
| Sets the size of points and how they are attenuated with distance.
virtual void | _setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)=0
| Sets the texture to bind to a given texture unit.
virtual void | _setTexture (size_t unit, bool enabled, const String &texname)
| Sets the texture to bind to a given texture unit.
virtual void | _setVertexTexture (size_t unit, const TexturePtr &tex)
| Binds a texture to a vertex sampler.
virtual void | _setTextureCoordSet (size_t unit, size_t index)=0
| Sets the texture coordinate set to use for a texture unit.
virtual void | _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)=0
| Sets a method for automatically calculating texture coordinates for a stage.
virtual void | _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)=0
| Sets the texture blend modes from a TextureUnitState record.
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
| Sets the filtering options for a given texture unit.
virtual void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)=0
| Sets a single filter for a given texture unit.
virtual void | _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)=0
| Sets the maximal anisotropy for the specified texture unit.
virtual void | _setTextureAddressingMode (size_t unit, const TextureUnitState::UVWAddressingMode &uvw)=0
| Sets the texture addressing mode for a texture unit.
virtual void | _setTextureBorderColour (size_t unit, const ColourValue &colour)=0
| Sets the texture border colour for a texture unit.
virtual void | _setTextureMipmapBias (size_t unit, float bias)=0
| Sets the mipmap bias value for a given texture unit.
virtual void | _setTextureMatrix (size_t unit, const Matrix4 &xform)=0
| Sets the texture coordinate transformation matrix for a texture unit.
virtual void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor)=0
| Sets the global blending factors for combining subsequent renders with the existing frame contents.
virtual void | _setAlphaRejectSettings (CompareFunction func, unsigned char value)=0
| Sets the global alpha rejection approach for future renders.
virtual void | _beginFrame (void)=0
| Signifies the beginning of a frame, ie the start of rendering on a single viewport.
virtual void | _endFrame (void)=0
| Ends rendering of a frame to the current viewport.
virtual void | _setViewport (Viewport *vp)=0
| Sets the provided viewport as the active one for future rendering operations.
virtual Viewport * | _getViewport (void)
| Get the current active viewport for rendering.
virtual void | _setCullingMode (CullingMode mode)=0
| Sets the culling mode for the render system based on the 'vertex winding'.
virtual CullingMode | _getCullingMode (void) const
virtual void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)=0
| Sets the mode of operation for depth buffer tests from this point onwards.
virtual void | _setDepthBufferCheckEnabled (bool enabled=true)=0
| Sets whether or not the depth buffer check is performed before a pixel write.
virtual void | _setDepthBufferWriteEnabled (bool enabled=true)=0
| Sets whether or not the depth buffer is updated after a pixel write.
virtual void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)=0
| Sets the comparison function for the depth buffer check.
virtual void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)=0
| Sets whether or not colour buffer writing is enabled, and for which channels.
virtual void | _setDepthBias (float constantBias, float slopeScaleBias=0.0f)=0
| Sets the depth bias, NB you should use the Material version of this.
virtual void | _setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=1.0, Real linearStart=0.0, Real linearEnd=1.0)=0
| Sets the fogging mode for future geometry.
virtual void | _beginGeometryCount (void)
| The RenderSystem will keep a count of tris rendered, this resets the count.
virtual unsigned int | _getFaceCount (void) const
| Reports the number of tris rendered since the last _beginGeometryCount call.
virtual unsigned int | _getBatchCount (void) const
| Reports the number of batches rendered since the last _beginGeometryCount call.
virtual unsigned int | _getVertexCount (void) const
| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
virtual void | convertColourValue (const ColourValue &colour, uint32 *pDest)
| Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
virtual VertexElementType | getColourVertexElementType (void) const =0
| Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
virtual void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)=0
| Converts a uniform projection matrix to suitable for this render system.
virtual void | _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0
| Builds a perspective projection matrix suitable for this render system.
virtual void | _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0
| Builds a perspective projection matrix for the case when frustum is not centered around camera.
virtual void | _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0
| Builds an orthographic projection matrix suitable for this render system.
virtual void | _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)=0
| Update a perspective projection matrix to use 'oblique depth projection'.
virtual void | _setPolygonMode (PolygonMode level)=0
| Sets how to rasterise triangles, as points, wireframe or solid polys.
virtual void | setStencilCheckEnabled (bool enabled)=0
| Turns stencil buffer checking on or off.
virtual void | setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 mask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false)=0
| This method allows you to set all the stencil buffer parameters in one call.
virtual void | setVertexDeclaration (VertexDeclaration *decl)=0
| Sets the current vertex declaration, ie the source of vertex data.
virtual void | setVertexBufferBinding (VertexBufferBinding *binding)=0
| Sets the current vertex buffer binding state.
virtual void | setNormaliseNormals (bool normalise)=0
| Sets whether or not normals are to be automatically normalised.
virtual void | _render (const RenderOperation &op)
| Render something to the active viewport.
const RenderSystemCapabilities * | getCapabilities (void) const
| Gets the capabilities of the render system.
virtual void | bindGpuProgram (GpuProgram *prg)
| Binds a given GpuProgram (but not the parameters).
virtual void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params)=0
| Bind Gpu program parameters.
virtual void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)=0
| Only binds Gpu program parameters used for passes that have more than one iteration rendering.
virtual void | unbindGpuProgram (GpuProgramType gptype)
| Unbinds GpuPrograms of a given GpuProgramType.
virtual bool | isGpuProgramBound (GpuProgramType gptype)
| Returns whether or not a Gpu program of the given type is currently bound.
virtual void | setClipPlanes (const PlaneList &clipPlanes)=0
| sets the clipping region.
virtual void | _initRenderTargets (void)
| Utility method for initialising all render targets attached to this rendering system.
virtual void | _notifyCameraRemoved (const Camera *cam)
| Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer.
virtual void | _updateAllRenderTargets (void)
| Internal method for updating all render targets attached to this rendering system.
virtual void | setClipPlane (ushort index, const Plane &p)
| Set a clipping plane.
virtual void | setClipPlane (ushort index, Real A, Real B, Real C, Real D)=0
| Set a clipping plane.
virtual void | enableClipPlane (ushort index, bool enable)=0
| Enable the clipping plane.
virtual void | setInvertVertexWinding (bool invert)
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
virtual void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)=0
| Sets the 'scissor region' ie the region of the target in which rendering can take place.
virtual void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)=0
| Clears one or more frame buffers on the active render target.
virtual Real | getHorizontalTexelOffset (void)=0
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
virtual Real | getVerticalTexelOffset (void)=0
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
virtual Real | getMinimumDepthInputValue (void)=0
| Gets the minimum (closest) depth value to be used when rendering using identity transforms.
virtual Real | getMaximumDepthInputValue (void)=0
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
void | setCurrentPassIterationCount (const size_t count)
| set the current multi pass count value.
virtual void | addListener (Listener *l)
| Adds a listener to the custom events that this render system can raise.
virtual void | removeListener (Listener *l)
| Remove a listener to the custom events that this render system can raise.
virtual const StringVector & | getRenderSystemEvents (void) const
| Gets a list of the rendersystem specific events that this rendersystem can raise.
virtual void | preExtraThreadsStarted ()=0
| Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.
virtual void | postExtraThreadsStarted ()=0
virtual void | registerThread ()=0
| Register the an additional thread which may make calls to rendersystem-related objects.
virtual void | unregisterThread ()=0
| Unregister an additional thread which may make calls to rendersystem-related objects.

## Protected Types

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

## Protected Member Functions

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

## Protected Attributes

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

## Classes

class | Listener
| Defines a listener on the custom events that this render system can raise. More...

## Detailed Description

Defines the functionality of a 3D API.

Remarks:
  The RenderSystem class provides a base interface which abstracts the general functionality of the 3D API e.g. Direct3D or OpenGL. Whilst a few of the general methods have implementations, most of this class is abstract, requiring a subclass based on a specific API to be constructed to provide the full functionality. Note there are 2 levels to the interface - one which will be used often by the caller of the Ogre library, and one which is at a lower level and will be used by the other classes provided by Ogre. These lower level methods are prefixed with '_' to differentiate them. The advanced user of the library may use these lower level methods to access the 3D API at a more fundamental level (dealing direct with render states and rendering primitives), but still benefitting from Ogre's abstraction of exactly which 3D API is in use.

Author:
  Steven Streeting

Version:
  1.0

Definition at line 114 of file OgreRenderSystem.h.

## Member Typedef Documentation

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

| Definition at line 1220 of file OgreRenderSystem.h.

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

| Definition at line 1217 of file OgreRenderSystem.h.

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

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

## Constructor & Destructor Documentation

Ogre::RenderSystem::RenderSystem | ( |  | ) |

| Default Constructor.

virtual Ogre::RenderSystem::~RenderSystem | ( |  | ) | `[virtual]`

| Destructor.

## Member Function Documentation

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

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

virtual void Ogre::RenderSystem::_beginFrame | ( | void |  | ) | `[pure virtual]`

| Signifies the beginning of a frame, ie the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist.

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

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

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

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.

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

| Turns off a texture unit.

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

| Disables all texture units from the given unit upwards.

virtual void Ogre::RenderSystem::_endFrame | ( | void |  | ) | `[pure virtual]`

| Ends rendering of a frame to the current viewport.

virtual unsigned int Ogre::RenderSystem::_getBatchCount | ( | void |  | ) | const`[virtual]`

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

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

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

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

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

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

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

| Get the current active viewport for rendering.

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

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

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

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.

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

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.

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

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.

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

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

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

Render something to the active viewport.

Low-level rendering interface to perform rendering operations. Unlikely to be used directly by client applications, since the SceneManager and various support classes will be responsible for calling this method. Can only be called between _beginScene and _endScene

Parameters:

  | op | A rendering operation instance, which contains details of the operation to be performed.

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

Sets the global alpha rejection approach for future renders.

By default images are rendered regardless of texture alpha. This method lets you change that.

Parameters:

  | func | The comparison function which must pass for a pixel to be written.
  | val | The value to compare each pixels alpha value to (0-255)

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

Sets whether or not colour buffer writing is enabled, and for which channels.

Remarks:
  For some advanced effects, you may wish to turn off the writing of certain colour channels, or even all of the colour channels so that only the depth buffer is updated in a rendering pass. However, the chances are that you really want to use this option through the Material class.

Parameters:

  | red,green,blue,alpha | Whether writing is enabled for each of the 4 colour channels.

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

| Sets the culling mode for the render system based on the 'vertex winding'. A typical way for the rendering engine to cull triangles is based on the 'vertex winding' of triangles. Vertex winding refers to the direction in which the vertices are passed or indexed to in the rendering operation as viewed from the camera, and will wither be clockwise or anticlockwise (that's 'counterclockwise' for you Americans out there ;) The default is CULL_CLOCKWISE i.e. that only triangles whose vertices are passed/indexed in anticlockwise order are rendered - this is a common approach and is used in 3D studio models for example. You can alter this culling mode if you wish but it is not advised unless you know what you are doing. You may wish to use the CULL_NONE option for mesh data that you cull yourself where the vertex winding is uncertain.

virtual void Ogre::RenderSystem::_setDepthBias | ( | float | constantBias,
|  | float | slopeScaleBias = `0.0f`
| ) | `[pure virtual]`

Sets the depth bias, NB you should use the Material version of this.

Remarks:
  When polygons are coplanar, you can get problems with 'depth fighting' where the pixels from the two polys compete for the same screen pixel. This is particularly a problem for decals (polys attached to another surface to represent details such as bulletholes etc.).

  A way to combat this problem is to use a depth bias to adjust the depth buffer value used for the decal such that it is slightly higher than the true value, ensuring that the decal appears on top.

Note:
  The final bias value is a combination of a constant bias and a bias proportional to the maximum depth slope of the polygon being rendered. The final bias is constantBias + slopeScaleBias * maxslope. Slope scale biasing is generally preferable but is not available on older hardware.

Parameters:

  | constantBias | The constant bias value, expressed as a value in homogenous depth coordinates.
  | slopeScaleBias | The bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards.

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

Sets whether or not the depth buffer check is performed before a pixel write.

Parameters:

  | enabled | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written.

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

Sets the comparison function for the depth buffer check.

Advanced use only - allows you to choose the function applied to compare the depth values of new and existing pixels in the depth buffer. Only an issue if the deoth buffer check is enabled (see _setDepthBufferCheckEnabled)

Parameters:

  | func | The comparison between the new depth and the existing depth which must return true for the new pixel to be written.

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

Sets the mode of operation for depth buffer tests from this point onwards.

Sometimes you may wish to alter the behaviour of the depth buffer to achieve special effects. Because it's unlikely that you'll set these options for an entire frame, but rather use them to tweak settings between rendering objects, this is an internal method (indicated by the '_' prefix) which will be used by a SceneManager implementation rather than directly from the client application. If this method is never called the settings are automatically the same as the default parameters.

Parameters:

  | depthTest | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written.
  | depthWrite | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written.
  | depthFunction | Sets the function required for the depth test.

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

Sets whether or not the depth buffer is updated after a pixel write.

Parameters:

  | enabled | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written.

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`
| ) | `[pure virtual]`

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.

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

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.

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

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.

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

| Sets how to rasterise triangles, as points, wireframe or solid polys.

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

| Sets the projection transform matrix.

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

Sets the global blending factors for combining subsequent renders with the existing frame contents.

The result of the blending operation is:

final = (texture * sourceFactor) + (pixel * destFactor) Each of the factors is specified as one of a number of options, as specified in the SceneBlendFactor enumerated type.

Parameters:

  | sourceFactor | The source factor in the above calculation, i.e. multiplied by the texture colour components.
  | destFactor | The destination factor in the above calculation, i.e. multiplied by the pixel colour components.

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

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.

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

Sets the texture to bind to a given texture unit.

User processes would not normally call this direct unless rendering primitives themselves.

Parameters:

  | unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits)
  | enabled | Boolean to turn the unit on/off
  | texname | The name of the texture to use - this should have already been loaded with TextureManager::load.

virtual void Ogre::RenderSystem::_setTexture | ( | size_t | unit,
|  | bool | enabled,
|  | const TexturePtr & | texPtr
| ) | `[pure virtual]`

Sets the texture to bind to a given texture unit.

User processes would not normally call this direct unless rendering primitives themselves.

Parameters:

  | unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits)
  | enabled | Boolean to turn the unit on/off
  | texPtr | Pointer to the texture to use.

virtual void Ogre::RenderSystem::_setTextureAddressingMode | ( | size_t | unit,
|  | const TextureUnitState::UVWAddressingMode & | uvw
| ) | `[pure virtual]`

| Sets the texture addressing mode for a texture unit.

virtual void Ogre::RenderSystem::_setTextureBlendMode | ( | size_t | unit,
|  | const LayerBlendModeEx & | bm
| ) | `[pure virtual]`

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

virtual void Ogre::RenderSystem::_setTextureBorderColour | ( | size_t | unit,
|  | const ColourValue & | colour
| ) | `[pure virtual]`

| Sets the texture border colour for a texture unit.

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

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

virtual void Ogre::RenderSystem::_setTextureCoordSet | ( | size_t | unit,
|  | size_t | index
| ) | `[pure virtual]`

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:

  | unit | Texture unit as above
  | index | The index of the texture coordinate set to use.

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

| Sets the maximal anisotropy for the specified texture unit.

virtual void Ogre::RenderSystem::_setTextureMatrix | ( | size_t | unit,
|  | const Matrix4 & | xform
| ) | `[pure virtual]`

Sets the texture coordinate transformation matrix for a texture unit.

Parameters:

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

virtual void Ogre::RenderSystem::_setTextureMipmapBias | ( | size_t | unit,
|  | float | bias
| ) | `[pure virtual]`

Sets the mipmap bias value for a given texture unit.

Remarks:
  This allows you to adjust the mipmap calculation up or down for a given texture unit. Negative values force a larger mipmap to be used, positive values force a smaller mipmap to be used. Units are in numbers of levels, so +1 forces the mipmaps to one smaller level.

Note:
  Only does something if render system has capability RSC_MIPMAP_LOD_BIAS.

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

Sets a single filter for a given texture unit.

Parameters:

  | unit | The texture unit to set the filtering options for
  | ftype | The filter type
  | filter | The filter to be used

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

Sets the filtering options for a given texture unit.

Parameters:

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

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

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

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

Binds a texture to a vertex 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.

See also:
  RenderSystemCapabilites::getVertexTextureUnitsShared

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

| Sets the view transform matrix.

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

Sets the provided viewport as the active one for future rendering operations.

This viewport is aware of it's own camera and render target. Must be implemented by subclass.

Parameters:

  | target | Pointer to the appropriate viewport.

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

| Sets multiple world matrices (vertex blending).

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

| Sets the world transform matrix.

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

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

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

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

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

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

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

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

See also:
  RenderSystem::getRenderSystemEvents

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

| Attaches the passed render target to the render system.

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

Binds a given GpuProgram (but not the parameters).

Remarks:
  Only one GpuProgram of each type can be bound at once, binding another one will simply replace the exsiting one.

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

| Bind Gpu program parameters.

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

| Only binds Gpu program parameters used for passes that have more than one iteration rendering.

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

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

Parameters:

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

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

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.

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

| Create an object for performing hardware occlusion queries.

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

| Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. Surfaces can be bound and unbound at will. This fails if mCapabilities->numMultiRenderTargets() is smaller than 2.

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

Creates and registers a render texture object.

Parameters:

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

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

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

Deprecated:
  This method is deprecated, and exists only for backward compatibility. You can create arbitrary rendertextures with the TextureManager::createManual call with usage TU_RENDERTARGET.

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

Creates a new rendering window.

Remarks:
  This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.

  After creation, this window can be retrieved using getRenderTarget().

Parameters:

  | name | The name of the window. Used in other methods later like setRenderTarget and getRenderWindow.
  | width | The width of the new window.
  | height | The height of the new window.
  | fullScreen | Specify true to make the window full screen without borders, title bar or menu bar.
  | miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platorms unless indicated otherwise:

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

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

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

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

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

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

Key: "externalGLControl" [Win32 OpenGL specific] Description: Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. The Ogre OpenGL context can be retrieved after Ogre initialisation by calling wglGetCurrentDC() and wglGetCurrentContext(). It is only used when the externalWindowHandle parameter is used. Values: true, false Default: false

Key: "externalGLContext" [Win32 OpenGL specific] Description: Use an externally created GL context Values: <context as="" unsigned="" long=""> Default: 0 (create own context)

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

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

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

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

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

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

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

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

| Destroy a hardware occlusion query object.

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

| Destroys a render target of any sort.

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

| Destroys a render texture.

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

| Destroys a render window.

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

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.

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

| Enable the clipping plane.

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

| Internal method for firing a rendersystem event.

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

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

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

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

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

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.

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

| Returns a description of an error code.

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

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

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

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

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

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

See also:
  Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

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

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

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

See also:
  Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

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

| Returns the name of the rendering system.

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

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

See also:
  RenderSystem::addListener

Definition at line 1116 of file OgreRenderSystem.h.

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

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

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

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

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

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

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

bool Ogre::RenderSystem::getWaitForVerticalBlank | ( | void |  | ) | const

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

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

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

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

Start up the renderer using the settings selected (Or the defaults if none have been selected).

Remarks:
  Called by Root::setRenderSystem. Shouldn't really be called directly, although this can be done if the app wants to.

Parameters:

  | autoCreateWindow | If true, creates a render window automatically, based on settings chosen so far. This saves an extra call to RenderSystem::createRenderWindow for the main render window.

  If an application has more specific window requirements, however (e.g. a level design app), it should specify false for this parameter and do it manually.

Returns:
  A pointer to the automatically created window, if requested, otherwise null.

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

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

virtual void Ogre::RenderSystem::postExtraThreadsStarted | ( |  | ) | `[pure virtual]`

virtual void Ogre::RenderSystem::preExtraThreadsStarted | ( |  | ) | `[pure virtual]`

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 (which themselves should call registerThread()). Note that 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.

virtual void Ogre::RenderSystem::registerThread | ( |  | ) | `[pure virtual]`

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.

virtual void Ogre::RenderSystem::reinitialise | ( | void |  | ) | `[pure virtual]`

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

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

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

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

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

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

| Set a clipping plane.

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

| Set a clipping plane.

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

| sets the clipping region.

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

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:

  | name | The name of the option to alter.
  | value | The value to set the option to.

void Ogre::RenderSystem::setCurrentPassIterationCount | ( | const size_t | count | ) |

set the current multi pass count value.

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

Parameters:

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

Definition at line 1074 of file OgreRenderSystem.h.

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

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

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

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.

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

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.

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

Sets the 'scissor region' ie the region of the target in which rendering can take place.

Remarks:
  This method allows you to 'mask off' rendering in all but a given rectangular area as identified by the parameters to this method.

Note:
  Not all systems support this method. Check the RenderSystemCapabilities for the RSC_SCISSOR_TEST capability to see if it is supported.

Parameters:

  | enabled | True to enable the scissor test, false to disable it.
  | left,top,right,bottom | The location of the corners of the rectangle, expressed in pixels.

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

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

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

This method allows you to set all the stencil buffer parameters in one call.

Remarks:
  The stencil buffer is used to mask out pixels in the render target, allowing you to do effects like mirrors, cut-outs, stencil shadows and more. Each of your batches of rendering is likely to ignore the stencil buffer, update it with new values, or apply it to mask the output of the render. The stencil test is:

                  (Reference Value & Mask) CompareFunction (Stencil Buffer Value & Mask)

  The result of this will cause one of 3 actions depending on whether the test fails, succeeds but with the depth buffer check still failing, or succeeds with the depth buffer check passing too.

  Unlike other render states, stencilling is left for the application to turn on and off when it requires. This is because you are likely to want to change parameters between batches of arbitrary objects and control the ordering yourself. In order to batch things this way, you'll want to use OGRE's separate render queue groups (see RenderQueue) and register a RenderQueueListener to get notifications between batches.

  There are individual state change methods for each of the parameters set using this method. Note that the default values in this method represent the defaults at system start up too.

Parameters:

  | func | The comparison function applied.
  | refValue | The reference value used in the comparison
  | mask | The bitmask applied to both the stencil value and the reference value before comparison
  | stencilFailOp | The action to perform when the stencil check fails
  | depthFailOp | The action to perform when the stencil check passes, but the depth buffer check still fails
  | passOp | The action to take when both the stencil and depth check pass.
  | twoSidedOperation | If set to true, then if you render both back and front faces (you'll have to turn off culling) then these parameters will apply for front faces, and the inverse of them will happen for back faces (keep remains the same).

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

Turns stencil buffer checking on or off.

Remarks:
  Stencilling (masking off areas of the rendering target based on the stencil buffer) canbe turned on or off using this method. By default, stencilling is disabled.

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

| Sets the current vertex buffer binding state.

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

| Sets the current vertex declaration, ie the source of vertex data.

void Ogre::RenderSystem::setWaitForVerticalBlank | ( | bool | enabled | ) |

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

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

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

Parameters:

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

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

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

Parameters:

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

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

| Shutdown the renderer and cleanup resources.

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

Unbinds GpuPrograms of a given GpuProgramType.

Remarks:
  This returns the pipeline to fixed-function processing for this type.

virtual void Ogre::RenderSystem::unregisterThread | ( |  | ) | `[pure virtual]`

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

See also:
  RenderSystem::registerThread

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

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

Returns:
  True if more iterations are required

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

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.

## Member Data Documentation

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

| Definition at line 1171 of file OgreRenderSystem.h.

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

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

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

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

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

| Definition at line 1183 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mBatchCount`[protected]`

| Definition at line 1190 of file OgreRenderSystem.h.

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

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

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

| Definition at line 1185 of file OgreRenderSystem.h.

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

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

size_t Ogre::RenderSystem::mDisabledTexUnitsFrom`[protected]`

| Texture units from this upwards are disabled. Definition at line 1200 of file OgreRenderSystem.h.

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

| Definition at line 1218 of file OgreRenderSystem.h.

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

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

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

| Definition at line 1191 of file OgreRenderSystem.h.

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

| Definition at line 1224 of file OgreRenderSystem.h.

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

| Definition at line 1221 of file OgreRenderSystem.h.

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

| Definition at line 1197 of file OgreRenderSystem.h.

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

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

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

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

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

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

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

| Definition at line 1177 of file OgreRenderSystem.h.

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

| Definition at line 1192 of file OgreRenderSystem.h.

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

| Definition at line 1223 of file OgreRenderSystem.h.

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

| Definition at line 1187 of file OgreRenderSystem.h.

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

| Definition at line 1188 of file OgreRenderSystem.h.

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

- OgreRenderSystem.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Mar 6 09:48:04 2008