 |
OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
|
OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
Defines the functionality of a 3D API. More...
#include <OgreRenderSystem.h>
Inheritance diagram for Ogre::RenderSystem:Classes | |
| class | Listener |
| Defines a listener on the custom events that this render system can raise. More... | |
| struct | RenderSystemContext |
| Dummy structure for render system contexts - implementing RenderSystems can extend as needed. More... | |
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 |
| 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... | |
| 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... | |
| void | _notifyCameraRemoved (const Camera *cam) |
| Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. More... | |
| 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) |
| 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) |
| Sets the size of points and how they are attenuated with distance. More... | |
| virtual void | _setPointSpritesEnabled (bool enabled) |
| Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More... | |
| virtual void | _setPolygonMode (PolygonMode level)=0 |
| Sets how to rasterise triangles, as points, wireframe or solid polys. More... | |
| virtual void | _setProjectionMatrix (const Matrix4 &m) |
| 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) |
| Sets the surface properties to be used for future rendering. More... | |
| virtual void | _setTesselationDomainTexture (size_t unit, const TexturePtr &tex) |
| virtual void | _setTesselationHullTexture (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) |
| 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) |
| 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) |
| 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) |
| 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, FilterType ftype, FilterOptions filter)=0 |
| Sets a single filter for a given texture unit. More... | |
| virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
| virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl) |
| Utility function for setting all the properties of a texture unit at once. More... | |
| virtual void | _setVertexTexture (size_t unit, const TexturePtr &tex) |
| Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler. More... | |
| virtual void | _setViewMatrix (const Matrix4 &m) |
| Sets the view transform matrix. More... | |
| 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) |
| Sets the world transform matrix. More... | |
| virtual void | _swapAllRenderTargetBuffers () |
| Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. More... | |
| virtual void | _updateAllRenderTargets (bool swapBuffers=true) |
| Internal method for updating all render targets attached to this rendering system. More... | |
| virtual void | _useLights (const LightList &lights, unsigned short limit) |
| Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits) More... | |
| void | addClipPlane (const Plane &p) |
| Add a user clipping plane. More... | |
| void | addClipPlane (Real A, Real B, Real C, Real D) |
| Add a user clipping plane. More... | |
| 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... | |
| 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... | |
| 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 HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)=0 |
| Create an object for performing hardware occlusion queries. More... | |
| virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)=0 |
| Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More... | |
| virtual RenderSystemCapabilities * | createRenderSystemCapabilities () 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 RenderTarget * | detachRenderTarget (const String &name) |
| Detaches the render target with the passed name from the render system and returns a pointer to it. More... | |
| virtual void | endProfileEvent (void)=0 |
| Ends the currently active GPU profiling event. More... | |
| const RenderSystemCapabilities * | getCapabilities (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 ConfigOptionMap & | getConfigOptions (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... | |
| const DriverVersion & | getDriverVersion (void) const |
| Returns the driver version. More... | |
| virtual String | getErrorDescription (long errorNumber) const |
| 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... | |
| VertexDeclaration * | getGlobalInstanceVertexBufferVertexDeclaration () const |
| Gets vertex declaration for the global vertex buffer for the global instancing. More... | |
| size_t | getGlobalNumberOfInstances () const |
| Gets the global number of instances. More... | |
| virtual Real | getHorizontalTexelOffset (void)=0 |
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More... | |
| bool | getInvertVertexWinding (void) const |
| Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More... | |
| 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... | |
| RenderSystemCapabilities * | getMutableCapabilities () |
| Get a pointer to the current capabilities being used by the RenderSystem. More... | |
| virtual const String & | getName (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... | |
| const StringVector & | getRenderSystemEvents (void) const |
| Gets a list of the rendersystem specific events that this rendersystem can raise. More... | |
| RenderTarget * | getRenderTarget (const String &name) |
| Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found. More... | |
| RenderTargetIterator | getRenderTargetIterator (void) |
| Returns a specialised MapIterator over all render targets attached to the RenderSystem. More... | |
| 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... | |
| bool | isGpuProgramBound (GpuProgramType gptype) |
| Returns whether or not a Gpu program of the given type is currently bound. More... | |
| virtual bool | isStaticBufferLockable () const |
| Returns whether under the current render system buffers marked as TU_STATIC can be locked for update. More... | |
| virtual void | markProfileEvent (const String &event)=0 |
| Marks an instantaneous event for graphics profilers. More... | |
| virtual void | postExtraThreadsStarted ()=0 |
| Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered. More... | |
| 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... | |
| void | removeListener (Listener *l) |
| Remove a listener to the custom events that this render system can raise. More... | |
| void | resetClipPlanes () |
| Clears the user clipping region. More... | |
| virtual void | setAmbientLight (float r, float g, float b) |
| Sets the colour & strength of the ambient (global directionless) light in the world. More... | |
| 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... | |
| void | setDepthBufferFor (RenderTarget *renderTarget) |
| Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More... | |
| void | setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f) |
| Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. More... | |
| virtual bool | setDrawBuffer (ColourBufferType colourBuffer) |
| Sets the colour buffer that the render system will to draw. More... | |
| void | 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... | |
| void | setInvertVertexWinding (bool invert) |
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. More... | |
| virtual void | setLightingEnabled (bool enabled) |
| Sets whether or not dynamic lighting is enabled. More... | |
| virtual void | setNormaliseNormals (bool normalise) |
| Sets whether or not normals are to be automatically normalised. More... | |
| 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) |
| 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)=0 |
| 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) |
| Sets the current vertex buffer binding state. More... | |
| virtual void | setVertexDeclaration (VertexDeclaration *decl) |
| 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... | |
| 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... | |
Static Public Member Functions | |
| static Listener * | getSharedListener (void) |
| Retrieve a pointer to the current shared render system listener. More... | |
| static void | setSharedListener (Listener *listener) |
| Sets shared listener. More... | |
Defines the functionality of a 3D API.
Iterator over RenderTargets.
| Ogre::RenderSystem::RenderSystem | ( | ) |
Default Constructor.
|
virtual |
Destructor.
|
pure virtual |
Returns the name of the rendering system.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Returns the details of this API's configuration options.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets an option for this API.
| name | The name of the option to alter. |
| value | The value to set the option to. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Create an object for performing hardware occlusion queries.
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Destroy a hardware occlusion query object.
|
pure virtual |
Validates the options set for the rendering system, returning a message if there are problems.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Start up the renderer using the settings selected (Or the defaults if none have been selected).
| autoCreateWindow | If true, creates a render window automatically, based on settings chosen so far. This saves an extra call to _createRenderWindow for the main render window. |
| windowTitle | Sets the app window title |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Returns whether under the current render system buffers marked as TU_STATIC can be locked for update.
Reimplemented in Ogre::D3D9RenderSystem.
|
pure virtual |
Query the real capabilities of the GPU and driver in the RenderSystem.
Implemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inline |
Get a pointer to the current capabilities being used by the RenderSystem.
| void Ogre::RenderSystem::useCustomRenderSystemCapabilities | ( | RenderSystemCapabilities * | capabilities | ) |
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)
| capabilities | has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities. |
|
pure virtual |
Restart the renderer (normally following a change in settings).
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
virtual |
Shutdown the renderer and cleanup resources.
Reimplemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets the colour & strength of the ambient (global directionless) light in the world.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets the type of light shading required (default = Gouraud).
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets whether or not dynamic lighting is enabled.
| enabled | If true, dynamic lighting is performed on geometry with normals supplied, geometry without normals will not be displayed. If false, no lighting is applied and all geometry will be full brightness. |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
| void Ogre::RenderSystem::setWBufferEnabled | ( | bool | enabled | ) |
Sets whether or not W-buffers are enabled if they are available for this renderer.
| enabled | If true and the renderer supports them W-buffers will be used. If false W-buffers will not be used even if available. W-buffers are enabled by default for 16bit depth buffers and disabled for all other depths. |
| bool Ogre::RenderSystem::getWBufferEnabled | ( | void | ) | const |
Returns true if the renderer will try to use W-buffers when available.
|
pure virtual |
Creates a new rendering window.
| name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| width | The width of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| height | The height of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fullScreen | Specify true to make the window full screen without borders, title bar or menu bar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
|
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Creates multiple rendering windows.
| renderWindowDescriptions | Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow: name width height fullScreen miscParams See _createRenderWindow for details about each member. |
| createdWindows | This array will hold the created render windows. |
Reimplemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
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::D3D9RenderSystem, Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Destroys a render window.
Reimplemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Destroys a render texture.
|
virtual |
Destroys a render target of any sort.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
| void Ogre::RenderSystem::attachRenderTarget | ( | RenderTarget & | target | ) |
Attaches the passed render target to the render system.
| RenderTarget* Ogre::RenderSystem::getRenderTarget | ( | const String & | name | ) |
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.
|
virtual |
Detaches the render target with the passed name from the render system and returns a pointer to it.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
|
inline |
Returns a specialised MapIterator over all render targets attached to the RenderSystem.
|
inlinevirtual |
Returns a description of an error code.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
References Ogre::BLANKSTRING.
| HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer | ( | ) | const |
Returns the global instance vertex buffer.
| void Ogre::RenderSystem::setGlobalInstanceVertexBuffer | ( | const HardwareVertexBufferSharedPtr & | val | ) |
Sets the global instance vertex buffer.
| VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration | ( | ) | const |
Gets vertex declaration for the global vertex buffer for the global instancing.
| void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration | ( | VertexDeclaration * | val | ) |
Sets vertex declaration for the global vertex buffer for the global instancing.
| size_t Ogre::RenderSystem::getGlobalNumberOfInstances | ( | ) | const |
Gets the global number of instances.
| void Ogre::RenderSystem::setGlobalNumberOfInstances | ( | const size_t | val | ) |
Sets the global number of instances.
| void Ogre::RenderSystem::setFixedPipelineEnabled | ( | bool | enabled | ) |
Sets if fixed pipeline rendering is enabled on the system.
| bool Ogre::RenderSystem::getFixedPipelineEnabled | ( | void | ) | const |
Returns true if fixed pipeline rendering is enabled on the system.
| void Ogre::RenderSystem::setDepthBufferFor | ( | RenderTarget * | renderTarget | ) |
Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.
|
inlinevirtual |
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)
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Are fixed-function lights provided in view space? Affects optimisation.
Reimplemented in Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets the world transform matrix.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
virtual |
Sets multiple world matrices (vertex blending).
|
inlinevirtual |
Sets the view transform matrix.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets the projection transform matrix.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
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 |
Set texture unit binding type.
Reimplemented in Ogre::D3D11RenderSystem.
|
virtual |
Turns off a texture unit.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
|
virtual |
Disables all texture units from the given unit upwards.
|
inlinevirtual |
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.
| ambient | The amount of ambient (sourceless and directionless) light an object reflects. Affected by the colour/amount of ambient light in the scene. |
| diffuse | The amount of light from directed sources that is reflected (affected by colour/amount of point, directed and spot light sources) |
| specular | The amount of specular light reflected. This is also affected by directed light sources but represents the colour at the highlights of the object. |
| emissive | The colour of light emitted from the object. Note that this will make an object seem brighter and not dependent on lights in the scene, but it will not act as a light, so will not illuminate other objects. Use a light attached to the same SceneNode as the object for this purpose. |
| shininess | A value which only has an effect on specular highlights (so specular must be non-black). The higher this value, the smaller and crisper the specular highlights will be, imitating a more highly polished surface. This value is not constrained to 0.0-1.0, in fact it is likely to be more (10.0 gives a modest sheen to an object). |
| tracking | A bit field that describes which of the ambient, diffuse, specular and emissive colours follow the vertex colour of the primitive. When a bit in this field is set its ColourValue is ignored. This is a combination of TVC_AMBIENT, TVC_DIFFUSE, TVC_SPECULAR(note that the shininess value is still taken from shininess) and TVC_EMISSIVE. TVC_NONE means that there will be no material property tracking the vertex colours. |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
| enabled | True enables point sprites, false returns to normal point rendering. |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets the size of points and how they are attenuated with distance.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
pure virtual |
Sets the texture to bind to a given texture unit.
User processes would not normally call this direct unless rendering primitives themselves.
| unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits) |
| enabled | Boolean to turn the unit on/off |
| texPtr | Pointer to the texture to use. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
|
virtual |
Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler.
Reimplemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
virtual |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
virtual |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
virtual |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
virtual |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
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.
| unit | Texture unit as above |
| index | The index of the texture coordinate set to use. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets a method for automatically calculating texture coordinates for a stage.
Should not be used by apps - for use by Ogre only.
| unit | Texture unit as above |
| m | Calculation method to use |
| frustum | Optional Frustum param, only used for projective effects |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
inlinevirtual |
Sets the texture blend modes from a TextureUnitState record.
Meant for use internally only - apps should use the Material and TextureUnitState classes.
| unit | Texture unit as above |
| bm | Details of the blending mode |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
pure virtual |
Sets a single filter for a given texture unit.
| unit | The texture unit to set the filtering options for |
| ftype | The filter type |
| filter | The filter to be used |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| unit | The texture unit to set the filtering options for |
| minFilter | The filter used when a texture is reduced in size |
| magFilter | The filter used when a texture is magnified |
| mipFilter | The filter used between mipmap levels, FO_NONE disables mipmapping |
Reimplemented in Ogre::GLES2RenderSystem.
|
pure virtual |
Sets whether the compare func is enabled or not for this texture unit.
| unit | The texture unit to set the filtering options for |
| compare | The state (enabled/disabled) |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the compare function to use for a given texture unit.
| unit | The texture unit to set the filtering options for |
| function | The comparison function |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the maximal anisotropy for the specified texture unit.
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the texture addressing mode for a texture unit.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the texture border colour for a texture unit.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the mipmap bias value for a given texture unit.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets the texture coordinate transformation matrix for a texture unit.
| unit | Texture unit to affect |
| xform | The 4x4 matrix |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
References Ogre::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.
| sourceFactor | The source factor in the above calculation, i.e. multiplied by the texture colour components. |
| destFactor | The destination factor in the above calculation, i.e. multiplied by the pixel colour components. |
| op | The blend operation mode for combining pixels |
Implemented in Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLRenderSystem.
|
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.
| sourceFactor | The source factor in the above calculation, i.e. multiplied by the texture colour components. |
| destFactor | The destination factor in the above calculation, i.e. multiplied by the pixel colour components. |
| sourceFactorAlpha | The source factor in the above calculation for the alpha channel, i.e. multiplied by the texture alpha components. |
| destFactorAlpha | The destination factor in the above calculation for the alpha channel, i.e. multiplied by the pixel alpha components. |
| op | The blend operation mode for combining pixels |
| alphaOp | The blend operation mode for combining pixel alpha values |
Implemented in Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLRenderSystem.
|
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.
| func | The comparison function which must pass for a pixel to be written. |
| value | The value to compare each pixels alpha value to (0-255) |
| alphaToCoverage | Whether to enable alpha to coverage, if supported |
Implemented in Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLES2RenderSystem, and Ogre::GLRenderSystem.
|
virtual |
Notify the rendersystem that it should adjust texture projection to be relative to a different origin.
|
pure virtual |
Creates a DepthBuffer that can be attached to the specified RenderTarget.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
| void Ogre::RenderSystem::_cleanupDepthBuffers | ( | bool | bCleanManualBuffers = true | ) |
Removes all depth buffers.
Should be called on device lost and shutdown
|
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::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
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 |
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.
| context | the render system context, as returned by _pauseFrame |
Reimplemented in Ogre::D3D9RenderSystem.
|
pure virtual |
Ends rendering of a frame to the current viewport.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
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.
| vp | Pointer to the appropriate viewport. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Get the current active viewport for rendering.
|
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::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
|
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.
| depthTest | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. |
| depthWrite | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. |
| depthFunction | Sets the function required for the depth test. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets whether or not the depth buffer check is performed before a pixel write.
| enabled | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets whether or not the depth buffer is updated after a pixel write.
| enabled | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
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)
| func | The comparison between the new depth and the existing depth which must return true for the new pixel to be written. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets whether or not colour buffer writing is enabled, and for which channels.
| red,green,blue,alpha | Whether writing is enabled for each of the 4 colour channels. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the depth bias, NB you should use the Material version of this.
| constantBias | The constant bias value, expressed as a value in homogeneous depth coordinates. |
| slopeScaleBias | The bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards. |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets the fogging mode for future geometry.
| mode | Set up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off. |
| colour | The colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox. |
| expDensity | The density of the fog in FOG_EXP or FOG_EXP2 mode, as a value between 0 and 1. The default is 1. i.e. completely opaque, lower values can mean that fog never completely obscures the scene. |
| linearStart | Distance at which linear fog starts to encroach. The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR. |
| linearEnd | Distance at which linear fog becomes completely opaque.The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR. |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
References Ogre::CMPF_ALWAYS_PASS, and Ogre::SOP_KEEP.
|
virtual |
The RenderSystem will keep a count of tris rendered, this resets the count.
|
virtual |
Reports the number of tris rendered since the last _beginGeometryCount call.
|
virtual |
Reports the number of batches rendered since the last _beginGeometryCount call.
|
virtual |
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
| void Ogre::RenderSystem::convertColourValue | ( | const ColourValue & | colour, |
| uint32 * | pDest | ||
| ) |
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
| colour | The colour to convert |
| pDest | Pointer to location to put the result. |
|
pure virtual |
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Converts a uniform projection matrix to suitable for this render system.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Builds a perspective projection matrix suitable for this render system.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Builds a perspective projection matrix for the case when frustum is not centered around camera.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Builds an orthographic projection matrix suitable for this render system.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Update a perspective projection matrix to use 'oblique depth projection'.
| matrix | The existing projection matrix. Note that this must be a perspective transform (not orthographic), and must not have already been altered by this method. The matrix will be altered in-place. |
| plane | The plane which is to be used as the clipping plane. This plane must be in CAMERA (view) space. |
| forGpuProgram | Is this for use with a Gpu program or fixed-function |
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Sets how to rasterise triangles, as points, wireframe or solid polys.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Turns depth-stencil buffer checking on or off.
Implemented in Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Determines if this system supports hardware accelerated stencil buffer.
(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.
| func | The comparison function applied. |
| refValue | The reference value used in the comparison |
| compareMask | The bitmask applied to both the stencil value and the reference value before comparison |
| writeMask | The bitmask the controls which bits from refValue will be written to stencil buffer (valid for operations such as SOP_REPLACE). the stencil |
| stencilFailOp | The action to perform when the stencil check fails |
| depthFailOp | The action to perform when the stencil check passes, but the depth buffer check still fails |
| passOp | The action to take when both the stencil and depth check pass. |
| twoSidedOperation | If set to true, then if you render both back and front faces (you'll have to turn off culling) then these parameters will apply for front faces, and the inverse of them will happen for back faces (keep remains the same). |
| readBackAsTexture | D3D11 specific |
Implemented in Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Sets the current vertex declaration, ie the source of vertex data.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
|
inlinevirtual |
Sets the current vertex buffer binding state.
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::D3D9RenderSystem.
|
inlinevirtual |
Sets whether or not normals are to be automatically normalised.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::GLRenderSystem.
|
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
| op | A rendering operation instance, which contains details of the operation to be performed. |
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Reimplemented in Ogre::D3D11RenderSystem.
|
inline |
Gets the capabilities of the render system.
|
inline |
Returns the driver version.
| const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme | ( | void | ) | const |
Returns the default material scheme used by the render system.
Systems that use the RTSS to emulate a fixed function pipeline (e.g. OpenGL ES 2, GL3+, DX11) need to return the default material scheme of the RTSS ShaderGenerator.
This is currently only used to set the default material scheme for viewports. It is a necessary step on these render systems for render textures to be rendered into properly.
|
virtual |
Binds a given GpuProgram (but not the parameters).
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Bind Gpu program parameters.
| gptype | The type of program to bind the parameters to |
| params | The parameters to bind |
| variabilityMask | A mask of GpuParamVariability identifying which params need binding |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Only binds Gpu program parameters used for passes that have more than one iteration rendering.
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Unbinds GpuPrograms of a given GpuProgramType.
Reimplemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
| bool Ogre::RenderSystem::isGpuProgramBound | ( | GpuProgramType | gptype | ) |
Returns whether or not a Gpu program of the given type is currently bound.
|
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
References Ogre::ColourValue::Black.
|
virtual |
Sets the user clipping region.
| void Ogre::RenderSystem::addClipPlane | ( | const Plane & | p | ) |
Add a user clipping plane.
Add a user clipping plane.
| void Ogre::RenderSystem::resetClipPlanes | ( | ) |
Clears the user clipping region.
| void Ogre::RenderSystem::_initRenderTargets | ( | void | ) |
Utility method for initialising all render targets attached to this rendering system.
| void Ogre::RenderSystem::_notifyCameraRemoved | ( | const Camera * | cam | ) |
Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer.
|
virtual |
Internal method for updating all render targets attached to this rendering system.
Reimplemented in Ogre::D3D11RenderSystem.
|
virtual |
Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter.
Reimplemented in Ogre::D3D11RenderSystem.
| void Ogre::RenderSystem::setInvertVertexWinding | ( | bool | invert | ) |
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
| bool Ogre::RenderSystem::getInvertVertexWinding | ( | void | ) | const |
Indicates whether or not the vertex windings set will be inverted for the current render (e.g.
reflections)
|
pure virtual |
Sets the 'scissor region' i.e.
the region of the target in which rendering can take place.
| enabled | True to enable the scissor test, false to disable it. |
| left,top,right,bottom | The location of the corners of the rectangle, expressed in pixels. |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Clears one or more frame buffers on the active render target.
| buffers | Combination of one or more elements of FrameBufferType denoting which buffers are to be cleared |
| colour | The colour to clear the colour buffer with, if enabled |
| depth | The value to initialise the depth buffer with, if enabled |
| stencil | The value to initialise the stencil buffer with, if enabled. |
Implemented in Ogre::D3D11RenderSystem, Ogre::GLRenderSystem, Ogre::D3D9RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
pure virtual |
Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, and Ogre::GLRenderSystemCommon.
|
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.
| count | Number of times to render the current state. |
|
inline |
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
| derive | True to tell the RS to derive this automatically |
| baseValue | The base value to which the multiplier should be added |
| multiplier | The amount of depth bias to apply per iteration |
| slopeScale | The constant slope scale bias for completeness |
|
pure virtual |
Set current render target to target, enabling its device context if needed.
Implemented in Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, Ogre::GLES2RenderSystem, and Ogre::D3D9RenderSystem.
|
static |
Sets shared listener.
|
static |
Retrieve a pointer to the current shared render system listener.
| void Ogre::RenderSystem::addListener | ( | Listener * | l | ) |
Adds a listener to the custom events that this render system can raise.
| void Ogre::RenderSystem::removeListener | ( | Listener * | l | ) |
Remove a listener to the custom events that this render system can raise.
|
inline |
Gets a list of the rendersystem specific events that this rendersystem can raise.
|
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.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Register the an additional thread which may make calls to rendersystem-related objects.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Unregister an additional thread which may make calls to rendersystem-related objects.
Implemented in Ogre::D3D11RenderSystem, Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Gets the number of display monitors.
Implemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
This marks the beginning of an event for GPU profiling.
Implemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Ends the currently active GPU profiling event.
Implemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Marks an instantaneous event for graphics profilers.
This is equivalent to calling
Implemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Determines if the system has anisotropic mip map filter support.
Implemented in Ogre::D3D9RenderSystem, Ogre::GLRenderSystem, Ogre::D3D11RenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Gets a custom (maybe platform-specific) attribute.
| name | The name of the attribute. |
| pData | Pointer to memory of the right kind of structure to receive the info. |
Reimplemented in Ogre::D3D11RenderSystem.
|
inlinevirtual |
Sets the colour buffer that the render system will to draw.
If the render system implementation or configuration does not support a particular value, then false will be returned and the current colour buffer value will not be modified.
| colourBuffer | Specifies the colour buffer that will be drawn into. |
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::D3D11RenderSystem.
References OGRE_MAX_TEXTURE_LAYERS.
1.8.13