OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RenderSystem Class Referenceabstract

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

#include <OgreRenderSystem.h>

+ Inheritance diagram for Ogre::RenderSystem:
+ Collaboration diagram for Ogre::RenderSystem:

Classes

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

Public Types

typedef MapIterator
< Ogre::RenderTargetMap
RenderTargetIterator
 Iterator over RenderTargets. More...
 

Public Member Functions

 RenderSystem ()
 Default Constructor. More...
 
virtual ~RenderSystem ()
 Destructor. More...
 
virtual void _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)=0
 Update a perspective projection matrix to use 'oblique depth projection'. More...
 
virtual void _beginFrame (void)=0
 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 _cleanupDepthBuffers (bool bCleanManualBuffers=true)
 Removes all depth buffers. More...
 
virtual void _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)=0
 Converts a uniform projection matrix to suitable for this render system. More...
 
virtual DepthBuffer_createDepthBufferFor (RenderTarget *renderTarget)=0
 Creates a DepthBuffer that can be attached to the specified RenderTarget. More...
 
virtual RenderWindow_createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0
 Creates a new rendering window. More...
 
virtual bool _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
 Creates multiple rendering windows. 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 _endFrame (void)=0
 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
 
virtual const String_getDefaultViewportMaterialScheme (void) const
 Returns the default material scheme used by the render system. More...
 
virtual unsigned int _getFaceCount (void) const
 Reports the number of tris rendered since the last _beginGeometryCount call. More...
 
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...
 
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). More...
 
virtual void _initRenderTargets (void)
 Utility method for initialising all render targets attached to this rendering system. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual RenderSystemContext_pauseFrame (void)
 Pause rendering for a frame. More...
 
virtual void _render (const RenderOperation &op)
 Render something to the active viewport. More...
 
virtual void _renderUsingReadBackAsTexture (unsigned int secondPass, Ogre::String variableName, unsigned int StartSlot)
 
virtual void _resumeFrame (RenderSystemContext *context)
 Resume rendering for a frame. More...
 
virtual void _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)=0
 Sets the global alpha rejection approach for future renders. More...
 
virtual void _setBindingType (TextureUnitState::BindingType bindigType)
 Set texture unit binding type. More...
 
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. More...
 
virtual void _setComputeTexture (size_t unit, const TexturePtr &tex)
 
virtual void _setCullingMode (CullingMode mode)=0
 Sets the culling mode for the render system based on the 'vertex winding'. More...
 
virtual void _setDepthBias (float constantBias, float slopeScaleBias=0.0f)=0
 Sets the depth bias, NB you should use the Material version of this. More...
 
virtual void _setDepthBufferCheckEnabled (bool enabled=true)=0
 Sets whether or not the depth buffer check is performed before a pixel write. More...
 
virtual void _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)=0
 Sets the comparison function for the depth buffer check. More...
 
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. More...
 
virtual void _setDepthBufferWriteEnabled (bool enabled=true)=0
 Sets whether or not the depth buffer is updated after a pixel write. More...
 
virtual void _setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=1.0, Real linearStart=0.0, Real linearEnd=1.0)=0
 Sets the fogging mode for future geometry. More...
 
virtual void _setGeometryTexture (size_t unit, const TexturePtr &tex)
 
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. More...
 
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. More...
 
virtual void _setPolygonMode (PolygonMode level)=0
 Sets how to rasterise triangles, as points, wireframe or solid polys. More...
 
virtual void _setProjectionMatrix (const Matrix4 &m)=0
 Sets the projection transform matrix. More...
 
virtual void _setRenderTarget (RenderTarget *target)=0
 Set current render target to target, enabling its device context if needed. More...
 
virtual void _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD)=0
 Sets the global blending factors for combining subsequent renders with the existing frame contents. More...
 
virtual void _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op=SBO_ADD, SceneBlendOperation alphaOp=SBO_ADD)=0
 Sets the global blending factors for combining subsequent renders with the existing frame contents. More...
 
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. More...
 
virtual void _setTessellationDomainTexture (size_t unit, const TexturePtr &tex)
 
virtual void _setTessellationHullTexture (size_t unit, const TexturePtr &tex)
 
virtual void _setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)=0
 Sets the texture to bind to a given texture unit. More...
 
virtual void _setTexture (size_t unit, bool enabled, const String &texname)
 Sets the texture to bind to a given texture unit. More...
 
virtual void _setTextureAddressingMode (size_t unit, const TextureUnitState::UVWAddressingMode &uvw)=0
 Sets the texture addressing mode for a texture unit. More...
 
virtual void _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)=0
 Sets the texture blend modes from a TextureUnitState record. More...
 
virtual void _setTextureBorderColour (size_t unit, const ColourValue &colour)=0
 Sets the texture border colour for a texture unit. More...
 
virtual void _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)=0
 Sets a method for automatically calculating texture coordinates for a stage. More...
 
virtual void _setTextureCoordSet (size_t unit, size_t index)=0
 Sets the texture coordinate set to use for a texture unit. More...
 
virtual void _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)=0
 Sets the maximal anisotropy for the specified texture unit. More...
 
virtual void _setTextureMatrix (size_t unit, const Matrix4 &xform)=0
 Sets the texture coordinate transformation matrix for a texture unit. More...
 
virtual void _setTextureMipmapBias (size_t unit, float bias)=0
 Sets the mipmap bias value for a given texture unit. More...
 
virtual void _setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos)
 Notify the rendersystem that it should adjust texture projection to be relative to a different origin. More...
 
virtual void _setTextureUnitCompareEnabled (size_t unit, bool compare)=0
 Sets whether the compare func is enabled or not for this texture unit. More...
 
virtual void _setTextureUnitCompareFunction (size_t unit, CompareFunction function)=0
 Sets the compare function to use for a given texture unit. More...
 
virtual void _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
 Sets the filtering options for a given texture unit. More...
 
virtual void _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)=0
 Sets a single filter for a given texture unit. More...
 
virtual void _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
 Utility function for setting all the properties of a texture unit at once. More...
 
virtual void _setVertexTexture (size_t unit, const TexturePtr &tex)
 Binds a texture to a vertex, geometry, compute, tessellation hull or tessellation domain sampler. More...
 
virtual void _setViewMatrix (const Matrix4 &m)=0
 Sets the view transform matrix. More...
 
virtual void _setViewport (Viewport *vp)=0
 Sets the provided viewport as the active one for future rendering operations. More...
 
virtual void _setWorldMatrices (const Matrix4 *m, unsigned short count)
 Sets multiple world matrices (vertex blending). More...
 
virtual void _setWorldMatrix (const Matrix4 &m)=0
 Sets the world transform matrix. More...
 
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) More...
 
virtual void addClipPlane (const Plane &p)
 Add a user clipping plane. More...
 
virtual void addClipPlane (Real A, Real B, Real C, Real D)
 Add a user clipping plane. More...
 
virtual void addListener (Listener *l)
 Adds a listener to the custom events that this render system can raise. More...
 
virtual bool areFixedFunctionLightsInViewSpace () const
 Are fixed-function lights provided in view space? Affects optimisation. More...
 
virtual void attachRenderTarget (RenderTarget &target)
 Attaches the passed render target to the render system. More...
 
virtual void beginProfileEvent (const String &eventName)=0
 This marks the beginning of an event for GPU profiling. More...
 
virtual void bindGpuProgram (GpuProgram *prg)
 Binds a given GpuProgram (but not the parameters). More...
 
virtual void bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 variabilityMask)=0
 Bind Gpu program parameters. More...
 
virtual void bindGpuProgramPassIterationParameters (GpuProgramType gptype)=0
 Only binds Gpu program parameters used for passes that have more than one iteration rendering. More...
 
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. More...
 
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. More...
 
virtual HardwareOcclusionQuerycreateHardwareOcclusionQuery (void)=0
 Create an object for performing hardware occlusion queries. More...
 
virtual MultiRenderTargetcreateMultiRenderTarget (const String &name)=0
 Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...
 
virtual RenderSystemCapabilitiescreateRenderSystemCapabilities () const =0
 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...
 
virtual 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)=0
 Ends the currently active GPU profiling event. More...
 
const RenderSystemCapabilitiesgetCapabilities (void) const
 Gets the capabilities of the render system. More...
 
virtual VertexElementType getColourVertexElementType (void) const =0
 Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. More...
 
virtual ConfigOptionMapgetConfigOptions (void)=0
 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...
 
virtual unsigned int getDisplayMonitorCount () const =0
 Gets the number of display monitors. More...
 
virtual const DriverVersiongetDriverVersion (void) const
 Returns the driver version. More...
 
virtual String getErrorDescription (long errorNumber) const =0
 Returns a description of an error code. More...
 
bool getFixedPipelineEnabled (void) const
 Returns true if fixed pipeline rendering is enabled on the system. More...
 
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...
 
virtual Real getHorizontalTexelOffset (void)=0
 Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
 
virtual bool getInvertVertexWinding (void) const
 Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...
 
virtual Real getMaximumDepthInputValue (void)=0
 Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More...
 
virtual Real getMinimumDepthInputValue (void)=0
 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...
 
virtual const StringgetName (void) const =0
 Returns the name of the rendering system. More...
 
uint16 getNativeShadingLanguageVersion () const
 Gets the native shading language version for this render system. More...
 
virtual const StringVectorgetRenderSystemEvents (void) const
 Gets a list of the rendersystem specific events that this rendersystem can raise. More...
 
virtual 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...
 
virtual RenderTargetIterator getRenderTargetIterator (void)
 Returns a specialised MapIterator over all render targets attached to the RenderSystem. More...
 
virtual Real getVerticalTexelOffset (void)=0
 Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
 
bool getWBufferEnabled (void) const
 Returns true if the renderer will try to use W-buffers when available. More...
 
virtual bool hasAnisotropicMipMapFilter () const =0
 Determines if the system has anisotropic mip map filter support. More...
 
virtual bool isGpuProgramBound (GpuProgramType gptype)
 Returns whether or not a Gpu program of the given type is currently bound. More...
 
virtual bool isStaticBufferLockable () const
 
virtual void markProfileEvent (const String &event)=0
 Marks an instantaneous event for graphics profilers. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void postExtraThreadsStarted ()=0
 
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. More...
 
virtual void registerThread ()=0
 Register the an additional thread which may make calls to rendersystem-related objects. More...
 
virtual void reinitialise (void)=0
 Restart the renderer (normally following a change in settings). More...
 
virtual void removeListener (Listener *l)
 Remove a listener to the custom events that this render system can raise. More...
 
virtual void resetClipPlanes ()
 Clears the user clipping region. More...
 
virtual void setAmbientLight (float r, float g, float b)=0
 Sets the colour & strength of the ambient (global directionless) light in the world. More...
 
virtual void setClipPlanes (const PlaneList &clipPlanes)
 Sets the user clipping region. More...
 
virtual void setConfigOption (const String &name, const String &value)=0
 Sets an option for this API. More...
 
virtual void setCurrentPassIterationCount (const size_t count)
 set the current multi pass count value. More...
 
virtual void setDepthBufferFor (RenderTarget *renderTarget)
 Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More...
 
virtual 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...
 
void setFixedPipelineEnabled (bool enabled)
 Sets if fixed pipeline rendering is enabled on the system. 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...
 
virtual 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)=0
 Sets whether or not dynamic lighting is enabled. More...
 
virtual void setNormaliseNormals (bool normalise)=0
 Sets whether or not normals are to be automatically normalised. More...
 
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' i.e. More...
 
virtual void setShadingType (ShadeOptions so)=0
 Sets the type of light shading required (default = Gouraud). More...
 
virtual void setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 compareMask=0xFFFFFFFF, uint32 writeMask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false, bool readBackAsTexture=false)
 Determines if this system supports hardware accelerated stencil buffer. More...
 
virtual void setStencilCheckEnabled (bool enabled)=0
 Turns depth-stencil buffer checking on or off. More...
 
virtual void setVertexBufferBinding (VertexBufferBinding *binding)=0
 Sets the current vertex buffer binding state. More...
 
virtual void setVertexDeclaration (VertexDeclaration *decl)=0
 Sets the current vertex declaration, ie the source of vertex data. More...
 
void setWBufferEnabled (bool enabled)
 Sets whether or not W-buffers are enabled if they are available for this renderer. More...
 
virtual void shutdown (void)
 Shutdown the renderer and cleanup resources. More...
 
virtual void unbindGpuProgram (GpuProgramType gptype)
 Unbinds GpuPrograms of a given GpuProgramType. More...
 
virtual void unregisterThread ()=0
 Unregister an additional thread which may make calls to rendersystem-related objects. More...
 
virtual void useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
 Force the render system to use the special capabilities. More...
 
virtual String validateConfigOptions (void)=0
 Validates the options set for the rendering system, returning a message if there are problems. More...
 

Protected Types

typedef list
< HardwareOcclusionQuery * >
::type 
HardwareOcclusionQueryList
 
typedef list< Listener * >::type ListenerList
 

Protected Member Functions

virtual void fireEvent (const String &name, const NameValuePairList *params=0)
 Internal method for firing a rendersystem event. More...
 
virtual void initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary)=0
 Initialize the render system from the capabilities. More...
 
virtual void setClipPlanesImpl (const PlaneList &clipPlanes)=0
 Internal method used to set the underlying clip planes when needed. More...
 
bool updatePassIterationRenderState (void)
 updates pass iteration rendering state including bound gpu program parameter pass iteration auto constant entry More...
 

Protected Attributes

GpuProgramParametersSharedPtr mActiveComputeGpuProgramParameters
 
GpuProgramParametersSharedPtr mActiveFragmentGpuProgramParameters
 
GpuProgramParametersSharedPtr mActiveGeometryGpuProgramParameters
 
RenderTargetmActiveRenderTarget
 The Active render target. More...
 
GpuProgramParametersSharedPtr mActiveTessellationDomainGpuProgramParameters
 
GpuProgramParametersSharedPtr mActiveTessellationHullGpuProgramParameters
 
GpuProgramParametersSharedPtr mActiveVertexGpuProgramParameters
 The Active GPU programs and gpu program parameters. More...
 
ViewportmActiveViewport
 
size_t mBatchCount
 
PlaneList mClipPlanes
 
bool mClipPlanesDirty
 
bool mComputeProgramBound
 
CullingMode mCullingMode
 
RenderSystemCapabilitiesmCurrentCapabilities
 
size_t mCurrentPassIterationCount
 number of times to render the current state More...
 
size_t mCurrentPassIterationNum
 
DepthBufferMap mDepthBufferPool
 DepthBuffers to be attached to render targets. More...
 
bool mDerivedDepthBias
 Whether to update the depth bias per render call. More...
 
float mDerivedDepthBiasBase
 
float mDerivedDepthBiasMultiplier
 
float mDerivedDepthBiasSlopeScale
 
size_t mDisabledTexUnitsFrom
 Texture units from this upwards are disabled. More...
 
DriverVersion mDriverVersion
 
bool mEnableFixedPipeline
 is fixed pipeline enabled More...
 
ListenerList mEventListeners
 
StringVector mEventNames
 List of names of events this rendersystem may raise. More...
 
size_t mFaceCount
 
bool mFragmentProgramBound
 
bool mGeometryProgramBound
 
HardwareVertexBufferSharedPtr mGlobalInstanceVertexBuffer
 a global vertex buffer for global instancing More...
 
VertexDeclarationmGlobalInstanceVertexBufferVertexDeclaration
 a vertex declaration for the global vertex buffer for the global instancing More...
 
size_t mGlobalNumberOfInstances
 the number of global instances (this number will be multiply by the render op instance number) More...
 
HardwareOcclusionQueryList mHwOcclusionQueries
 
bool mInvertVertexWinding
 
ColourValue mManualBlendColours [OGRE_MAX_TEXTURE_LAYERS][2]
 Saved manual colour blends. More...
 
uint16 mNativeShadingLanguageVersion
 
RenderSystemCapabilitiesmRealCapabilities
 Used to store the capabilities of the graphics card. More...
 
RenderTargetMap mRenderTargets
 The render targets. More...
 
bool mTessellationDomainProgramBound
 
bool mTessellationHullProgramBound
 
bool mTexProjRelative
 
Vector3 mTexProjRelativeOrigin
 
TextureManagermTextureManager
 
bool mUseCustomCapabilities
 
size_t mVertexCount
 
bool mVertexProgramBound
 
bool mWBuffer
 

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 benefiting from Ogre's abstraction of exactly which 3D API is in use.
Author
Steven Streeting
Version
1.0

Definition at line 97 of file OgreRenderSystem.h.

Member Typedef Documentation

typedef list<Listener*>::type Ogre::RenderSystem::ListenerList
protected

Definition at line 1566 of file OgreRenderSystem.h.

Iterator over RenderTargets.

Definition at line 551 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
matrixThe 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.
planeThe plane which is to be used as the clipping plane. This plane must be in CAMERA (view) space.
forGpuProgramIs this for use with a Gpu program or fixed-function

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_beginFrame ( void  )
pure virtual

Signifies the beginning of a frame, i.e.

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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

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

void Ogre::RenderSystem::_cleanupDepthBuffers ( bool  bCleanManualBuffers = true)

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual DepthBuffer* Ogre::RenderSystem::_createDepthBufferFor ( RenderTarget renderTarget)
pure virtual

Creates a DepthBuffer that can be attached to the specified RenderTarget.

Remarks
It doesn't attach anything, it just returns a pointer to a new DepthBuffer Caller is responsible for putting this buffer into the right pool, for attaching, and deleting it. Here's where API-specific magic happens. Don't call this directly unless you know what you're doing.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLESRenderSystem.

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
nameThe name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
widthThe width of the new window.
heightThe height of the new window.
fullScreenSpecify true to make the window full screen without borders, title bar or menu bar.
miscParamsA NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
Key Type/Values Default Description Notes
title Any string RenderTarget name The title of the window that will appear in the title bar  
colourDepth 16, 32 Desktop depth Colour depth of the resulting rendering window; only applies if fullScreen Win32 Specific
left Positive integers Centred Screen x coordinate from left  
top Positive integers Centred Screen y coordinate from left  
depthBuffer true, false true Use depth buffer DirectX9 specific
externalWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
OS X: WindowRef for Carbon or NSWindow for Cocoa address as an integer iOS: UIWindow address as an integer
0 (none) External window handle, for embedding the OGRE render in an existing window  
externalGLControl true, false false Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. OpenGL specific
externalGLContext Context as Unsigned Long 0 (create own context) Use an externally created GL context OpenGL Specific
parentWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
0 (none) Parent window handle, for embedding the OGRE in a child of an external window  
macAPI String: "cocoa" or "carbon" "carbon" Specifies the type of rendering window on the Mac Platform. Mac OS X Specific  
macAPICocoaUseNSView bool "true" or "false" "false" On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm. Mac OS X Specific  
contentScalingFactor Positive Float greater than 1.0 The default content scaling factor of the screen Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor. iOS Specific  
externalViewHandle UIView pointer as an integer 0 External view handle, for rendering OGRE render in an existing view iOS Specific  
externalViewControllerHandle UIViewController pointer as an integer 0 External view controller handle, for embedding OGRE in an existing view controller iOS Specific  
externalSharegroup EAGLSharegroup pointer as an integer 0 External sharegroup, used to shared GL resources between contexts iOS Specific  
Full Screen true, false false Specify whether to create the window in full screen mode OS X Specific  
FSAA Positive integer (usually 0, 2, 4, 8, 16) 0 Full screen antialiasing factor  
FSAAHint Depends on RenderSystem and hardware. Currently supports:
"Quality": on systems that have an option to prefer higher AA quality over speed, use it
Blank Full screen antialiasing hint  
displayFrequency Refresh rate in Hertz (e.g. 60, 75, 100) Desktop vsync rate Display frequency rate, for fullscreen mode  
vsync true, false false Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate  
vsyncInterval 1, 2, 3, 4 1 If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30.  
border none, fixed, resize resize The type of window border (in windowed mode)  
outerDimensions true, false false Whether the width/height is expressed as the size of the outer window, rather than the content area  
useNVPerfHUD true, false false Enable the use of nVidia NVPerfHUD  
gamma true, false false Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.  
enableDoubleClick true, false false Enable the window to keep track and transmit double click messages. Win32 Specific

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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

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

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

Turns off a texture unit.

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

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
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 const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme ( void  ) const
virtual

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 override this function 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.

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 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
autoCreateWindowIf true, creates a render window automatically, based on settings chosen so far. This saves an extra call to _createRenderWindow for the main render window.
windowTitleSets the app window title
Returns
A pointer to the automatically created window, if requested, otherwise null.

Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

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.

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
opA rendering operation instance, which contains details of the operation to be performed.

Reimplemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_renderUsingReadBackAsTexture ( unsigned int  secondPass,
Ogre::String  variableName,
unsigned int  StartSlot 
)
virtual

Reimplemented in Ogre::D3D11RenderSystem.

virtual void Ogre::RenderSystem::_resumeFrame ( RenderSystemContext context)
virtual

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.

virtual void Ogre::RenderSystem::_setAlphaRejectSettings ( CompareFunction  func,
unsigned char  value,
bool  alphaToCoverage 
)
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
funcThe comparison function which must pass for a pixel to be written.
valueThe value to compare each pixels alpha value to (0-255)
alphaToCoverageWhether to enable alpha to coverage, if supported

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setBindingType ( TextureUnitState::BindingType  bindigType)
virtual

Set texture unit binding type.

Reimplemented in Ogre::D3D11RenderSystem.

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,alphaWhether writing is enabled for each of the 4 colour channels.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D11RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setComputeTexture ( size_t  unit,
const TexturePtr tex 
)
virtual
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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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
constantBiasThe constant bias value, expressed as a value in homogeneous depth coordinates.
slopeScaleBiasThe bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D11RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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
funcThe comparison between the new depth and the existing depth which must return true for the new pixel to be written.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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
depthTestIf 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.
depthWriteIf 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.
depthFunctionSets the function required for the depth test.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setDepthBufferWriteEnabled ( bool  enabled = true)
pure virtual

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

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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
modeSet up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off.
colourThe colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox.
expDensityThe 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.
linearStartDistance 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.
linearEndDistance 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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D11RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setGeometryTexture ( size_t  unit,
const TexturePtr tex 
)
virtual
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.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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
enabledTrue enables point sprites, false returns to normal point rendering.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::_setPolygonMode ( PolygonMode  level)
pure virtual

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setProjectionMatrix ( const Matrix4 m)
pure virtual
virtual void Ogre::RenderSystem::_setRenderTarget ( RenderTarget target)
pure virtual

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setSceneBlending ( SceneBlendFactor  sourceFactor,
SceneBlendFactor  destFactor,
SceneBlendOperation  op = SBO_ADD 
)
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. By changing the operation you can change addition between the source and destination pixels to a different operator.

Parameters
sourceFactorThe source factor in the above calculation, i.e. multiplied by the texture colour components.
destFactorThe destination factor in the above calculation, i.e. multiplied by the pixel colour components.
opThe blend operation mode for combining pixels

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setSeparateSceneBlending ( SceneBlendFactor  sourceFactor,
SceneBlendFactor  destFactor,
SceneBlendFactor  sourceFactorAlpha,
SceneBlendFactor  destFactorAlpha,
SceneBlendOperation  op = SBO_ADD,
SceneBlendOperation  alphaOp = SBO_ADD 
)
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
sourceFactorThe source factor in the above calculation, i.e. multiplied by the texture colour components.
destFactorThe destination factor in the above calculation, i.e. multiplied by the pixel colour components.
sourceFactorAlphaThe source factor in the above calculation for the alpha channel, i.e. multiplied by the texture alpha components.
destFactorAlphaThe destination factor in the above calculation for the alpha channel, i.e. multiplied by the pixel alpha components.
opThe blend operation mode for combining pixels
alphaOpThe blend operation mode for combining pixel alpha values

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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
ambientThe amount of ambient (sourceless and directionless) light an object reflects. Affected by the colour/amount of ambient light in the scene.
diffuseThe amount of light from directed sources that is reflected (affected by colour/amount of point, directed and spot light sources)
specularThe amount of specular light reflected. This is also affected by directed light sources but represents the colour at the highlights of the object.
emissiveThe 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.
shininessA 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).
trackingA 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.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::_setTessellationDomainTexture ( size_t  unit,
const TexturePtr tex 
)
virtual
virtual void Ogre::RenderSystem::_setTessellationHullTexture ( size_t  unit,
const TexturePtr tex 
)
virtual
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
unitThe index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits)
enabledBoolean to turn the unit on/off
texPtrPointer to the texture to use.

Implemented in Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLESRenderSystem.

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
unitThe index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits)
enabledBoolean to turn the unit on/off
texnameThe name of the texture to use - this should have already been loaded with TextureManager::load.
virtual void Ogre::RenderSystem::_setTextureAddressingMode ( size_t  unit,
const TextureUnitState::UVWAddressingMode uvw 
)
pure virtual
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
unitTexture unit as above
bmDetails of the blending mode

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setTextureBorderColour ( size_t  unit,
const ColourValue colour 
)
pure virtual
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
unitTexture unit as above
mCalculation method to use
frustumOptional Frustum param, only used for projective effects

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLESRenderSystem.

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
unitTexture unit as above
indexThe index of the texture coordinate set to use.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::_setTextureLayerAnisotropy ( size_t  unit,
unsigned int  maxAnisotropy 
)
pure virtual

Sets the maximal anisotropy for the specified texture unit.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setTextureMatrix ( size_t  unit,
const Matrix4 xform 
)
pure virtual

Sets the texture coordinate transformation matrix for a texture unit.

Parameters
unitTexture unit to affect
xformThe 4x4 matrix

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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

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

virtual void Ogre::RenderSystem::_setTextureUnitCompareEnabled ( size_t  unit,
bool  compare 
)
pure virtual

Sets whether the compare func is enabled or not for this texture unit.

Parameters
unitThe texture unit to set the filtering options for
compareThe state (enabled/disabled)

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::_setTextureUnitCompareFunction ( size_t  unit,
CompareFunction  function 
)
pure virtual

Sets the compare function to use for a given texture unit.

Parameters
unitThe texture unit to set the filtering options for
functionThe comparison function

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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
unitThe texture unit to set the filtering options for
minFilterThe filter used when a texture is reduced in size
magFilterThe filter used when a texture is magnified
mipFilterThe filter used between mipmap levels, FO_NONE disables mipmapping

Reimplemented in Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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

Sets a single filter for a given texture unit.

Parameters
unitThe texture unit to set the filtering options for
ftypeThe filter type
filterThe filter to be used

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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, geometry, compute, tessellation 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.
See also
RenderSystemCapabilites::getVertexTextureUnitsShared

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

virtual void Ogre::RenderSystem::_setViewMatrix ( const Matrix4 m)
pure virtual
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
vpPointer to the appropriate viewport.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, and Ogre::D3D9RenderSystem.

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

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::addClipPlane ( const Plane p)
virtual

Add a user clipping plane.

virtual void Ogre::RenderSystem::addClipPlane ( Real  A,
Real  B,
Real  C,
Real  D 
)
virtual

Add a user clipping plane.

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 bool Ogre::RenderSystem::areFixedFunctionLightsInViewSpace ( ) const
inlinevirtual

Are fixed-function lights provided in view space? Affects optimisation.

Reimplemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

Definition at line 608 of file OgreRenderSystem.h.

virtual void Ogre::RenderSystem::attachRenderTarget ( RenderTarget target)
virtual

Attaches the passed render target to the render system.

virtual void Ogre::RenderSystem::beginProfileEvent ( const String eventName)
pure virtual
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 existing one.

Reimplemented in Ogre::GL3PlusRenderSystem, Ogre::GLRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::bindGpuProgramParameters ( GpuProgramType  gptype,
GpuProgramParametersSharedPtr  params,
uint16  variabilityMask 
)
pure virtual

Bind Gpu program parameters.

Parameters
gptypeThe type of program to bind the parameters to
paramsThe parameters to bind
variabilityMaskA mask of GpuParamVariability identifying which params need binding

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::bindGpuProgramPassIterationParameters ( GpuProgramType  gptype)
pure virtual

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

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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
buffersCombination of one or more elements of FrameBufferType denoting which buffers are to be cleared
colourThe colour to clear the colour buffer with, if enabled
depthThe value to initialise the depth buffer with, if enabled
stencilThe value to initialise the stencil buffer with, if enabled.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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
colourThe colour to convert
pDestPointer to location to put the result.
virtual HardwareOcclusionQuery* Ogre::RenderSystem::createHardwareOcclusionQuery ( void  )
pure virtual

Create an object for performing hardware occlusion queries.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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->getNumMultiRenderTargets() is smaller than 2.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

virtual RenderSystemCapabilities* Ogre::RenderSystem::createRenderSystemCapabilities ( ) const
pure virtual
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.

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

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.

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

virtual void Ogre::RenderSystem::endProfileEvent ( void  )
pure virtual
virtual void Ogre::RenderSystem::fireEvent ( const String name,
const NameValuePairList params = 0 
)
protectedvirtual

Internal method for firing a rendersystem event.

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

Gets the capabilities of the render system.

Definition at line 1205 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.

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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.

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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

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.

virtual unsigned int Ogre::RenderSystem::getDisplayMonitorCount ( ) const
pure virtual
virtual const DriverVersion& Ogre::RenderSystem::getDriverVersion ( void  ) const
inlinevirtual

Returns the driver version.

Definition at line 1210 of file OgreRenderSystem.h.

virtual String Ogre::RenderSystem::getErrorDescription ( long  errorNumber) const
pure virtual
bool Ogre::RenderSystem::getFixedPipelineEnabled ( void  ) const

Returns true if fixed pipeline rendering is enabled on the system.

HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer ( ) const

Returns the global instance vertex buffer.

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

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

size_t Ogre::RenderSystem::getGlobalNumberOfInstances ( ) const

Gets the global number of instances.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual bool Ogre::RenderSystem::getInvertVertexWinding ( void  ) const
virtual

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

reflections)

See also
RenderSystem::setInvertVertexWinding
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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

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.

Definition at line 203 of file OgreRenderSystem.h.

virtual const String& Ogre::RenderSystem::getName ( void  ) const
pure virtual
uint16 Ogre::RenderSystem::getNativeShadingLanguageVersion ( ) const
inline

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

Definition at line 1254 of file OgreRenderSystem.h.

virtual const StringVector& Ogre::RenderSystem::getRenderSystemEvents ( void  ) const
inlinevirtual

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

See also
RenderSystem::addListener

Definition at line 1414 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  )
inlinevirtual

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

Definition at line 554 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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

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

virtual bool Ogre::RenderSystem::hasAnisotropicMipMapFilter ( ) const
pure virtual

Determines if the system has anisotropic mip map filter support.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::initialiseFromRenderSystemCapabilities ( RenderSystemCapabilities caps,
RenderTarget primary 
)
protectedpure virtual
virtual bool Ogre::RenderSystem::isGpuProgramBound ( GpuProgramType  gptype)
virtual

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

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

Reimplemented in Ogre::D3D9RenderSystem.

Definition at line 191 of file OgreRenderSystem.h.

virtual void Ogre::RenderSystem::markProfileEvent ( const String event)
pure virtual

Marks an instantaneous event for graphics profilers.

This is equivalent to calling

See also
beginProfileEvent and
endProfileEvent back to back.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::reinitialise ( void  )
pure virtual

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

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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::resetClipPlanes ( )
virtual

Clears the user clipping region.

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.

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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

Sets the user clipping region.

virtual void Ogre::RenderSystem::setClipPlanesImpl ( const PlaneList clipPlanes)
protectedpure virtual

Internal method used to set the underlying clip planes when needed.

Implemented in Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.

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
nameThe name of the option to alter.
valueThe value to set the option to.

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::setCurrentPassIterationCount ( const size_t  count)
inlinevirtual

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.

Definition at line 1349 of file OgreRenderSystem.h.

virtual void Ogre::RenderSystem::setDepthBufferFor ( RenderTarget renderTarget)
virtual

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()
virtual void Ogre::RenderSystem::setDeriveDepthBias ( bool  derive,
float  baseValue = 0.0f,
float  multiplier = 0.0f,
float  slopeScale = 0.0f 
)
inlinevirtual

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

Definition at line 1360 of file OgreRenderSystem.h.

void Ogre::RenderSystem::setFixedPipelineEnabled ( bool  enabled)

Sets if fixed pipeline rendering is enabled on the system.

void Ogre::RenderSystem::setGlobalInstanceVertexBuffer ( const HardwareVertexBufferSharedPtr val)

Sets the global instance vertex buffer.

void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration ( VertexDeclaration val)

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

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

Sets the global number of instances.

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

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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.

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

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' i.e.

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
enabledTrue to enable the scissor test, false to disable it.
left,top,right,bottomThe location of the corners of the rectangle, expressed in pixels.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

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

Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

virtual void Ogre::RenderSystem::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 
)
inlinevirtual

Determines if this system supports hardware accelerated stencil buffer.

Remarks
Note that the lack of this function doesn't mean you can't do stencilling, but the stencilling operations will be provided in software, which will NOT be fast.
Generally hardware stencils are only supported in 32-bit colour modes, because the stencil buffer shares the memory of the z-buffer, and in most cards the z-buffer has to be the same depth as the colour buffer. This means that in 32-bit mode, 24 bits of the z-buffer are depth and 8 bits are stencil. In 16-bit mode there is no room for a stencil (although some cards support a 15:1 depth:stencil option, this isn't useful for very much) so 8 bits of stencil are provided in software. This can mean that if you use stencilling, your applications may be faster in 32-but colour than in 16-bit, which may seem odd to some people. 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
funcThe comparison function applied.
refValueThe reference value used in the comparison
compareMaskThe bitmask applied to both the stencil value and the reference value before comparison
writeMaskThe bitmask the controls which bits from refValue will be written to stencil buffer (valid for operations such as SOP_REPLACE). the stencil
stencilFailOpThe action to perform when the stencil check fails
depthFailOpThe action to perform when the stencil check passes, but the depth buffer check still fails
passOpThe action to take when both the stencil and depth check pass.
twoSidedOperationIf 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).

Reimplemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

Definition at line 1161 of file OgreRenderSystem.h.

virtual void Ogre::RenderSystem::setStencilCheckEnabled ( bool  enabled)
pure virtual

Turns depth-stencil buffer checking on or off.

Remarks
An inactive depth-stencil buffer can be read by a shader as a texture. An application that reads a depth-stencil buffer as a texture renders in two passes, the first pass writes to the depth-stencil buffer and the second pass reads from the buffer. This allows a shader to compare depth or stencil values previously written to the buffer against the value for the pixel currrently being rendered. The result of the comparison can be used to create effects such as shadow mapping or soft particles in a particle system. Turns stencil buffer checking on or off.
Stencilling (masking off areas of the rendering target based on the stencil buffer) can be turned on or off using this method. By default, stencilling is disabled.

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::setVertexBufferBinding ( VertexBufferBinding binding)
pure virtual
virtual void Ogre::RenderSystem::setVertexDeclaration ( VertexDeclaration decl)
pure virtual

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

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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

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

Parameters
enabledIf true and the renderer supports them W-buffers will be used. If false W-buffers will not be used even if available. W-buffers are enabled by default for 16bit depth buffers and disabled for all other depths.
virtual void Ogre::RenderSystem::shutdown ( void  )
virtual
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.

Reimplemented in Ogre::GL3PlusRenderSystem, Ogre::GLRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

virtual void Ogre::RenderSystem::unregisterThread ( )
pure virtual

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

See also
RenderSystem::registerThread

Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, Ogre::GLESRenderSystem, Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.

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 void Ogre::RenderSystem::useCustomRenderSystemCapabilities ( RenderSystemCapabilities capabilities)
virtual

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

Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLESRenderSystem.

Member Data Documentation

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveComputeGpuProgramParameters
protected

Definition at line 1508 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveFragmentGpuProgramParameters
protected

Definition at line 1505 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveGeometryGpuProgramParameters
protected

Definition at line 1504 of file OgreRenderSystem.h.

RenderTarget* Ogre::RenderSystem::mActiveRenderTarget
protected

The Active render target.

Definition at line 1500 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveTessellationDomainGpuProgramParameters
protected

Definition at line 1507 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveTessellationHullGpuProgramParameters
protected

Definition at line 1506 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveVertexGpuProgramParameters
protected

The Active GPU programs and gpu program parameters.

Definition at line 1503 of file OgreRenderSystem.h.

Viewport* Ogre::RenderSystem::mActiveViewport
protected

Definition at line 1517 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mBatchCount
protected

Definition at line 1523 of file OgreRenderSystem.h.

PlaneList Ogre::RenderSystem::mClipPlanes
protected

Definition at line 1580 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mClipPlanesDirty
protected

Definition at line 1582 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mComputeProgramBound
protected

Definition at line 1577 of file OgreRenderSystem.h.

CullingMode Ogre::RenderSystem::mCullingMode
protected

Definition at line 1519 of file OgreRenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::mCurrentCapabilities
protected

Definition at line 1586 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mCurrentPassIterationCount
protected

number of times to render the current state

Definition at line 1536 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mCurrentPassIterationNum
protected

Definition at line 1537 of file OgreRenderSystem.h.

DepthBufferMap Ogre::RenderSystem::mDepthBufferPool
protected

DepthBuffers to be attached to render targets.

Definition at line 1495 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mDerivedDepthBias
protected

Whether to update the depth bias per render call.

Definition at line 1539 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasBase
protected

Definition at line 1540 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasMultiplier
protected

Definition at line 1541 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasSlopeScale
protected

Definition at line 1542 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mDisabledTexUnitsFrom
protected

Texture units from this upwards are disabled.

Definition at line 1533 of file OgreRenderSystem.h.

DriverVersion Ogre::RenderSystem::mDriverVersion
protected

Definition at line 1596 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mEnableFixedPipeline
protected

is fixed pipeline enabled

Definition at line 1552 of file OgreRenderSystem.h.

ListenerList Ogre::RenderSystem::mEventListeners
protected

Definition at line 1567 of file OgreRenderSystem.h.

StringVector Ogre::RenderSystem::mEventNames
protected

List of names of events this rendersystem may raise.

Definition at line 1561 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mFaceCount
protected

Definition at line 1524 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mFragmentProgramBound
protected

Definition at line 1574 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mGeometryProgramBound
protected

Definition at line 1573 of file OgreRenderSystem.h.

HardwareVertexBufferSharedPtr Ogre::RenderSystem::mGlobalInstanceVertexBuffer
protected

a global vertex buffer for global instancing

Definition at line 1545 of file OgreRenderSystem.h.

VertexDeclaration* Ogre::RenderSystem::mGlobalInstanceVertexBufferVertexDeclaration
protected

a vertex declaration for the global vertex buffer for the global instancing

Definition at line 1547 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mGlobalNumberOfInstances
protected

the number of global instances (this number will be multiply by the render op instance number)

Definition at line 1549 of file OgreRenderSystem.h.

HardwareOcclusionQueryList Ogre::RenderSystem::mHwOcclusionQueries
protected

Definition at line 1570 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mInvertVertexWinding
protected

Definition at line 1530 of file OgreRenderSystem.h.

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

Saved manual colour blends.

Definition at line 1528 of file OgreRenderSystem.h.

uint16 Ogre::RenderSystem::mNativeShadingLanguageVersion
protected

Definition at line 1597 of file OgreRenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::mRealCapabilities
protected

Used to store the capabilities of the graphics card.

Definition at line 1585 of file OgreRenderSystem.h.

RenderTargetMap Ogre::RenderSystem::mRenderTargets
protected

The render targets.

Definition at line 1498 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mTessellationDomainProgramBound
protected

Definition at line 1576 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mTessellationHullProgramBound
protected

Definition at line 1575 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mTexProjRelative
protected

Definition at line 1599 of file OgreRenderSystem.h.

Vector3 Ogre::RenderSystem::mTexProjRelativeOrigin
protected

Definition at line 1600 of file OgreRenderSystem.h.

TextureManager* Ogre::RenderSystem::mTextureManager
protected

Definition at line 1514 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mUseCustomCapabilities
protected

Definition at line 1587 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mVertexCount
protected

Definition at line 1525 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mVertexProgramBound
protected

Definition at line 1572 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mWBuffer
protected

Definition at line 1521 of file OgreRenderSystem.h.


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