OgreRenderSystem.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __RenderSystem_H_
29#define __RenderSystem_H_
30
31// Precompiler options
32#include "OgrePrerequisites.h"
33
34#include "OgreString.h"
35
37#include "OgreCommon.h"
38
39#include "OgreMaterialManager.h"
40#include "OgreRenderOperation.h"
42#include "OgreRenderTarget.h"
43#include "OgreRenderTexture.h"
44#include "OgreFrameListener.h"
45#include "OgreConfigOptionMap.h"
46#include "OgreGpuProgram.h"
47#include "OgrePlane.h"
49#include "OgreHeaderPrefix.h"
50
51namespace Ogre
52{
64
65 class TextureManager;
68 {
79 };
82 {
99 };
100
101
126 {
127 public:
131
134 virtual ~RenderSystem();
135
138 virtual const String& getName(void) const = 0;
139
162
182 virtual void setConfigOption(const String &name, const String &value) = 0;
183
187
191
196 virtual String validateConfigOptions(void) = 0;
197
212 virtual RenderWindow* _initialise(bool autoCreateWindow, const String& windowTitle = "OGRE Render Window");
213
214 /*
215 Returns whether under the current render system buffers marked as TU_STATIC can be locked for update
216 @remarks
217 Needed in the implementation of DirectX9 with DirectX9Ex driver
218 */
219 virtual bool isStaticBufferLockable() const { return true; }
220
223
231 RenderSystemCapabilities* getMutableCapabilities(){ return mCurrentCapabilities; }
232
240
243 virtual void reinitialise(void) = 0;
244
247 virtual void shutdown(void);
248
249
252 virtual void setAmbientLight(float r, float g, float b) = 0;
253
256 virtual void setShadingType(ShadeOptions so) = 0;
257
263 virtual void setLightingEnabled(bool enabled) = 0;
264
272
275 bool getWBufferEnabled(void) const;
276
529 virtual RenderWindow* _createRenderWindow(const String &name, unsigned int width, unsigned int height,
530 bool fullScreen, const NameValuePairList *miscParams = 0) = 0;
531
549
550
556
558 virtual void destroyRenderWindow(const String& name);
560 virtual void destroyRenderTexture(const String& name);
562 virtual void destroyRenderTarget(const String& name);
563
566 virtual void attachRenderTarget( RenderTarget &target );
570 virtual RenderTarget * getRenderTarget( const String &name );
576 virtual RenderTarget * detachRenderTarget( const String &name );
577
580
583 return RenderTargetIterator( mRenderTargets.begin(), mRenderTargets.end() );
584 }
587 virtual String getErrorDescription(long errorNumber) const = 0;
588
606 void setGlobalNumberOfInstances(const size_t val);
607
611
614 bool getFixedPipelineEnabled(void) const;
615
622
623 // ------------------------------------------------------------------------
624 // Internal Rendering Access
625 // All methods below here are normally only called by other OGRE classes
626 // They can be called by library user if required
627 // ------------------------------------------------------------------------
628
629
633 virtual void _useLights(const LightList& lights, unsigned short limit) = 0;
636 virtual bool areFixedFunctionLightsInViewSpace() const { return false; }
638 virtual void _setWorldMatrix(const Matrix4 &m) = 0;
640 virtual void _setWorldMatrices(const Matrix4* m, unsigned short count);
642 virtual void _setViewMatrix(const Matrix4 &m) = 0;
644 virtual void _setProjectionMatrix(const Matrix4 &m) = 0;
652 virtual void _disableTextureUnit(size_t texUnit);
654 virtual void _disableTextureUnitsFrom(size_t texUnit);
691 TrackVertexColourType tracking = TVC_NONE) = 0;
692
698 virtual void _setPointSpritesEnabled(bool enabled) = 0;
699
712
713
726 virtual void _setTexture(size_t unit, bool enabled,
727 const TexturePtr &texPtr) = 0;
741 virtual void _setTexture(size_t unit, bool enabled, const String &texname);
742
752 virtual void _setVertexTexture(size_t unit, const TexturePtr& tex);
753
763 virtual void _setTextureCoordSet(size_t unit, size_t index) = 0;
764
773 const Frustum* frustum = 0) = 0;
774
781 virtual void _setTextureBlendMode(size_t unit, const LayerBlendModeEx& bm) = 0;
782
791
798
803 virtual void _setTextureUnitCompareEnabled(size_t unit, bool compare) = 0;
804
805
811
812
814 virtual void _setTextureLayerAnisotropy(size_t unit, unsigned int maxAnisotropy) = 0;
815
818
820 virtual void _setTextureBorderColour(size_t unit, const ColourValue& colour) = 0;
821
830 virtual void _setTextureMipmapBias(size_t unit, float bias) = 0;
831
836 virtual void _setTextureMatrix(size_t unit, const Matrix4& xform) = 0;
837
849
864
871 virtual void _setAlphaRejectSettings(CompareFunction func, unsigned char value, bool alphaToCoverage) = 0;
872
876 virtual void _setTextureProjectionRelativeTo(bool enabled, const Vector3& pos);
877
886
895
900 virtual void _beginFrame(void) = 0;
901
902 //Dummy structure for render system contexts - implementing RenderSystems can extend
903 //as needed
917 virtual void _resumeFrame(RenderSystemContext* context);
918
922 virtual void _endFrame(void) = 0;
930 virtual void _setViewport(Viewport *vp) = 0;
932 virtual Viewport* _getViewport(void);
933
946
947 virtual CullingMode _getCullingMode(void) const;
948
962 virtual void _setDepthBufferParams(bool depthTest = true, bool depthWrite = true, CompareFunction depthFunction = CMPF_LESS_EQUAL) = 0;
963
968 virtual void _setDepthBufferCheckEnabled(bool enabled = true) = 0;
973 virtual void _setDepthBufferWriteEnabled(bool enabled = true) = 0;
981 virtual void _setDepthBufferFunction(CompareFunction func = CMPF_LESS_EQUAL) = 0;
989 virtual void _setColourBufferWriteEnabled(bool red, bool green, bool blue, bool alpha) = 0;
1012 virtual void _setDepthBias(float constantBias, float slopeScaleBias = 0.0f) = 0;
1024 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;
1025
1026
1028 virtual void _beginGeometryCount(void);
1030 virtual unsigned int _getFaceCount(void) const;
1032 virtual unsigned int _getBatchCount(void) const;
1034 virtual unsigned int _getVertexCount(void) const;
1035
1044 virtual void convertColourValue(const ColourValue& colour, uint32* pDest);
1049
1057 Matrix4& dest, bool forGpuProgram = false) = 0;
1058
1066 Matrix4& dest, bool forGpuProgram = false) = 0;
1067
1074 virtual void _makeProjectionMatrix(Real left, Real right, Real bottom, Real top,
1075 Real nearPlane, Real farPlane, Matrix4& dest, bool forGpuProgram = false) = 0;
1083 Matrix4& dest, bool forGpuProgram = false) = 0;
1084
1101 virtual void _applyObliqueDepthProjection(Matrix4& matrix, const Plane& plane,
1102 bool forGpuProgram) = 0;
1103
1105 virtual void _setPolygonMode(PolygonMode level) = 0;
1106
1113 virtual void setStencilCheckEnabled(bool enabled) = 0;
1129 /*virtual bool hasHardwareStencil(void) = 0;*/
1130
1169 virtual void setStencilBufferParams(CompareFunction func = CMPF_ALWAYS_PASS,
1170 uint32 refValue = 0, uint32 compareMask = 0xFFFFFFFF, uint32 writeMask = 0xFFFFFFFF,
1171 StencilOperation stencilFailOp = SOP_KEEP,
1172 StencilOperation depthFailOp = SOP_KEEP,
1173 StencilOperation passOp = SOP_KEEP,
1174 bool twoSidedOperation = false) = 0;
1175
1176
1177
1182
1193 virtual void setNormaliseNormals(bool normalise) = 0;
1194
1207 virtual void _render(const RenderOperation& op);
1208
1210 const RenderSystemCapabilities* getCapabilities(void) const { return mCurrentCapabilities; }
1211
1212
1215 virtual const DriverVersion& getDriverVersion(void) const { return mDriverVersion; }
1216
1226 virtual const String& _getDefaultViewportMaterialScheme(void) const;
1227
1233
1241
1250
1253
1259 uint16 getNativeShadingLanguageVersion() const { return mNativeShadingLanguageVersion; }
1260
1263 virtual void setClipPlanes(const PlaneList& clipPlanes);
1264
1266 virtual void addClipPlane (const Plane &p);
1268 virtual void addClipPlane (Real A, Real B, Real C, Real D);
1269
1272 virtual void resetClipPlanes();
1273
1275 virtual void _initRenderTargets(void);
1276
1280 virtual void _notifyCameraRemoved(const Camera* cam);
1281
1283 virtual void _updateAllRenderTargets(bool swapBuffers = true);
1287
1290 virtual void setInvertVertexWinding(bool invert);
1291
1295 virtual bool getInvertVertexWinding(void) const;
1296
1308 virtual void setScissorTest(bool enabled, size_t left = 0, size_t top = 0,
1309 size_t right = 800, size_t bottom = 600) = 0;
1310
1318 virtual void clearFrameBuffer(unsigned int buffers,
1319 const ColourValue& colour = ColourValue::Black,
1320 Real depth = 1.0f, unsigned short stencil = 0) = 0;
1340 virtual Real getVerticalTexelOffset(void) = 0;
1341
1365 virtual void setCurrentPassIterationCount(const size_t count) { mCurrentPassIterationCount = count; }
1366
1376 virtual void setDeriveDepthBias(bool derive, float baseValue = 0.0f,
1377 float multiplier = 0.0f, float slopeScale = 0.0f)
1378 {
1379 mDerivedDepthBias = derive;
1380 mDerivedDepthBiasBase = baseValue;
1381 mDerivedDepthBiasMultiplier = multiplier;
1382 mDerivedDepthBiasSlopeScale = slopeScale;
1383 }
1384
1388 virtual void _setRenderTarget(RenderTarget *target) = 0;
1389
1395 {
1396 public:
1398 virtual ~Listener() {}
1399
1405 virtual void eventOccurred(const String& eventName,
1406 const NameValuePairList* parameters = 0) = 0;
1407 };
1421 virtual void addListener(Listener* l);
1424 virtual void removeListener(Listener* l);
1425
1430 virtual const StringVector& getRenderSystemEvents(void) const { return mEventNames; }
1431
1448 virtual void preExtraThreadsStarted() = 0;
1449
1450 /* Tell the rendersystem to perform any tasks it needs to directly
1451 after other threads which might access the rendering API are registered.
1452 @see RenderSystem::preExtraThreadsStarted
1453 */
1454 virtual void postExtraThreadsStarted() = 0;
1455
1468 virtual void registerThread() = 0;
1469
1473 virtual void unregisterThread() = 0;
1474
1479 virtual unsigned int getDisplayMonitorCount() const = 0;
1480
1484 virtual void beginProfileEvent( const String &eventName ) = 0;
1485
1489 virtual void endProfileEvent( void ) = 0;
1490
1495 virtual void markProfileEvent( const String &event ) = 0;
1496
1499 virtual bool hasAnisotropicMipMapFilter() const = 0;
1500
1506 virtual void getCustomAttribute(const String& name, void* pData);
1507
1508 protected:
1509
1512
1519
1527
1528 // Texture manager
1529 // A concrete class of this will be created and
1530 // made available under the TextureManager singleton,
1531 // managed by the RenderSystem
1533
1534 // Active viewport (dest for future rendering operations)
1536
1538
1540
1544
1546 ColourValue mManualBlendColours[OGRE_MAX_TEXTURE_LAYERS][2];
1547
1549
1552
1561
1568
1571
1577
1580
1582 virtual void fireEvent(const String& name, const NameValuePairList* params = 0);
1583
1586
1589
1596
1597 // Recording user clip planes
1599 // Indicator that we need to re-set the clip planes on next render call
1601
1606
1608 virtual void setClipPlanesImpl(const PlaneList& clipPlanes) = 0;
1609
1612
1613
1616
1619
1620
1621
1622 };
1625}
1626
1627#include "OgreHeaderSuffix.h"
1628
1629#endif
#define OGRE_MAX_TEXTURE_LAYERS
Define max number of texture layers allowed per pass on any card.
Definition OgreConfig.h:72
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A viewpoint from which the scene will be rendered.
Definition OgreCamera.h:87
Class representing colour.
An abstract class that contains a depth/stencil buffer.
A frustum represents a pyramid, capped at the near and far end which is used to represent either a vi...
Definition OgreFrustum.h:86
Defines a program which runs on the GPU such as a vertex or fragment program.
This is a abstract class that that provides the interface for the query class for hardware occlusion.
Shared pointer implementation used to share vertex buffers.
Class which manages blending of both colour and alpha components.
Class encapsulating a standard 4x4 homogeneous matrix.
Definition OgreMatrix4.h:79
This class represents a render target that renders to multiple RenderTextures at once.
Defines a plane in 3D space.
Definition OgrePlane.h:62
Wrapper class which indicates a given angle value is in Radians.
Definition OgreMath.h:48
'New' rendering operation using vertex buffers.
singleton class for storing the capabilities of the graphics card.
Defines a listener on the custom events that this render system can raise.
virtual void eventOccurred(const String &eventName, const NameValuePairList *parameters=0)=0
A rendersystem-specific event occurred.
Defines the functionality of a 3D API.
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.
virtual bool areFixedFunctionLightsInViewSpace() const
Are fixed-function lights provided in view space? Affects optimisation.
virtual void _setDepthBufferWriteEnabled(bool enabled=true)=0
Sets whether or not the depth buffer is updated after a pixel write.
virtual MultiRenderTarget * createMultiRenderTarget(const String &name)=0
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once.
void setWBufferEnabled(bool enabled)
Sets whether or not W-buffers are enabled if they are available for this renderer.
virtual void unbindGpuProgram(GpuProgramType gptype)
Unbinds GpuPrograms of a given GpuProgramType.
virtual void _disableTextureUnit(size_t texUnit)
Turns off a texture unit.
virtual RenderWindow * _createRenderWindow(const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0
Creates a new rendering window.
virtual void setInvertVertexWinding(bool invert)
Sets whether or not vertex windings set should be inverted; this can be important for rendering refle...
virtual void _setTextureMatrix(size_t unit, const Matrix4 &xform)=0
Sets the texture coordinate transformation matrix for a texture unit.
virtual bool getInvertVertexWinding(void) const
Indicates whether or not the vertex windings set will be inverted for the current render (e....
virtual RenderTarget * detachRenderTarget(const String &name)
Detaches the render target with the passed name from the render system and returns a pointer to it.
virtual void _setColourBufferWriteEnabled(bool red, bool green, bool blue, bool alpha)=0
Sets whether or not colour buffer writing is enabled, and for which channels.
virtual void _setPolygonMode(PolygonMode level)=0
Sets how to rasterise triangles, as points, wireframe or solid polys.
size_t mCurrentPassIterationCount
number of times to render the current state
virtual Real getVerticalTexelOffset(void)=0
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this r...
virtual Real getMaximumDepthInputValue(void)=0
Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
virtual bool isGpuProgramBound(GpuProgramType gptype)
Returns whether or not a Gpu program of the given type is currently bound.
virtual void endProfileEvent(void)=0
Ends the currently active GPU profiling event.
VertexDeclaration * getGlobalInstanceVertexBufferVertexDeclaration() const
Gets vertex declaration for the global vertex buffer for the global instancing.
virtual void _setTextureUnitFiltering(size_t unit, FilterType ftype, FilterOptions filter)=0
Sets a single filter for a given texture unit.
virtual bool _createRenderWindows(const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
Creates multiple rendering windows.
virtual void setCurrentPassIterationCount(const size_t count)
set the current multi pass count value.
virtual void _setDepthBufferCheckEnabled(bool enabled=true)=0
Sets whether or not the depth buffer check is performed before a pixel write.
virtual RenderSystemContext * _pauseFrame(void)
Pause rendering for a frame.
virtual void setClipPlanes(const PlaneList &clipPlanes)
Sets the user clipping region.
virtual bool hasAnisotropicMipMapFilter() const =0
Determines if the system has anisotropic mip map filter support.
GpuProgramParametersSharedPtr mActiveComputeGpuProgramParameters
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.
bool getFixedPipelineEnabled(void) const
Returns true if fixed pipeline rendering is enabled on the system.
DriverVersion mDriverVersion
GpuProgramParametersSharedPtr mActiveTesselationHullGpuProgramParameters
virtual void _setTexture(size_t unit, bool enabled, const TexturePtr &texPtr)=0
Sets the texture to bind to a given texture unit.
GpuProgramParametersSharedPtr mActiveGeometryGpuProgramParameters
virtual RenderTargetIterator getRenderTargetIterator(void)
Returns a specialised MapIterator over all render targets attached to the RenderSystem.
virtual void addClipPlane(Real A, Real B, Real C, Real D)
Add a user clipping plane.
virtual bool isStaticBufferLockable() const
virtual void reinitialise(void)=0
Restart the renderer (normally following a change in settings).
RenderSystem()
Default Constructor.
virtual void _setTextureBlendMode(size_t unit, const LayerBlendModeEx &bm)=0
Sets the texture blend modes from a TextureUnitState record.
virtual void destroyRenderTexture(const String &name)
Destroys a render texture.
virtual void _beginGeometryCount(void)
The RenderSystem will keep a count of tris rendered, this resets the count.
virtual RenderSystemCapabilities * createRenderSystemCapabilities() const =0
Query the real capabilities of the GPU and driver in the RenderSystem.
RenderTarget * mActiveRenderTarget
The Active render target.
void setGlobalNumberOfInstances(const size_t val)
Sets the global number of instances.
virtual RenderWindow * _initialise(bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
Start up the renderer using the settings selected (Or the defaults if none have been selected).
virtual void destroyRenderTarget(const String &name)
Destroys a render target of any sort.
virtual void postExtraThreadsStarted()=0
virtual void resetClipPlanes()
Clears the user clipping region.
virtual unsigned int _getVertexCount(void) const
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
virtual void _setDepthBufferParams(bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)=0
Sets the mode of operation for depth buffer tests from this point onwards.
virtual void setStencilCheckEnabled(bool enabled)=0
Turns stencil buffer checking on or off.
MapIterator< Ogre::RenderTargetMap > RenderTargetIterator
Iterator over RenderTargets.
void _cleanupDepthBuffers(bool bCleanManualBuffers=true)
Removes all depth buffers.
virtual void _setDepthBias(float constantBias, float slopeScaleBias=0.0f)=0
Sets the depth bias, NB you should use the Material version of this.
virtual void _setDepthBufferFunction(CompareFunction func=CMPF_LESS_EQUAL)=0
Sets the comparison function for the depth buffer check.
virtual void _setTextureUnitCompareFunction(size_t unit, CompareFunction function)=0
Sets the compare function to use for a given texture unit.
virtual void setLightingEnabled(bool enabled)=0
Sets whether or not dynamic lighting is enabled.
virtual Real getMinimumDepthInputValue(void)=0
Gets the minimum (closest) depth value to be used when rendering using identity transforms.
GpuProgramParametersSharedPtr mActiveFragmentGpuProgramParameters
HardwareVertexBufferSharedPtr mGlobalInstanceVertexBuffer
a global vertex buffer for global instancing
RenderTargetMap mRenderTargets
The render targets.
virtual void setShadingType(ShadeOptions so)=0
Sets the type of light shading required (default = Gouraud).
virtual void setVertexBufferBinding(VertexBufferBinding *binding)=0
Sets the current vertex buffer binding state.
virtual void setConfigOption(const String &name, const String &value)=0
Sets an option for this API.
virtual HardwareOcclusionQuery * createHardwareOcclusionQuery(void)=0
Create an object for performing hardware occlusion queries.
bool mEnableFixedPipeline
is fixed pipeline enabled
virtual void useCustomRenderSystemCapabilities(RenderSystemCapabilities *capabilities)
Force the render system to use the special capabilities.
virtual void unregisterThread()=0
Unregister an additional thread which may make calls to rendersystem-related objects.
bool getWBufferEnabled(void) const
Returns true if the renderer will try to use W-buffers when available.
virtual void _render(const RenderOperation &op)
Render something to the active viewport.
virtual void destroyRenderWindow(const String &name)
Destroys a render window.
size_t mGlobalNumberOfInstances
the number of global instances (this number will be multiply by the render op instance number)
virtual void _setTextureAddressingMode(size_t unit, const TextureUnitState::UVWAddressingMode &uvw)=0
Sets the texture addressing mode for a texture unit.
virtual void _disableTextureUnitsFrom(size_t texUnit)
Disables all texture units from the given unit upwards.
virtual void bindGpuProgramParameters(GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 variabilityMask)=0
Bind Gpu program parameters.
RenderTargetPriorityMap mPrioritisedRenderTargets
The render targets, ordered by priority.
virtual void _setAlphaRejectSettings(CompareFunction func, unsigned char value, bool alphaToCoverage)=0
Sets the global alpha rejection approach for future renders.
virtual const String & _getDefaultViewportMaterialScheme(void) const
Returns the default material scheme used by the render system.
virtual void _setPointParameters(Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)=0
Sets the size of points and how they are attenuated with distance.
virtual Real getHorizontalTexelOffset(void)=0
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this...
RenderSystemCapabilities * getMutableCapabilities()
Get a pointer to the current capabilities being used by the RenderSystem.
virtual VertexElementType getColourVertexElementType(void) const =0
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
virtual void fireEvent(const String &name, const NameValuePairList *params=0)
Internal method for firing a rendersystem event.
void setFixedPipelineEnabled(bool enabled)
Sets if fixed pipeline rendering is enabled on the system.
RenderSystemCapabilities * mCurrentCapabilities
virtual void preExtraThreadsStarted()=0
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might...
virtual ~RenderSystem()
Destructor.
HardwareOcclusionQueryList mHwOcclusionQueries
virtual DepthBuffer * _createDepthBufferFor(RenderTarget *renderTarget)=0
Creates a DepthBuffer that can be attached to the specified RenderTarget.
virtual void _setPointSpritesEnabled(bool enabled)=0
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) o...
virtual void _setViewport(Viewport *vp)=0
Sets the provided viewport as the active one for future rendering operations.
virtual void removeListener(Listener *l)
Remove a listener to the custom events that this render system can raise.
virtual void _beginFrame(void)=0
Signifies the beginning of a frame, i.e.
virtual void convertColourValue(const ColourValue &colour, uint32 *pDest)
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSyst...
TextureManager * mTextureManager
virtual void _setCullingMode(CullingMode mode)=0
Sets the culling mode for the render system based on the 'vertex winding'.
virtual void _initRenderTargets(void)
Utility method for initialising all render targets attached to this rendering system.
virtual String getErrorDescription(long errorNumber) const =0
Returns a description of an error code.
virtual void setVertexDeclaration(VertexDeclaration *decl)=0
Sets the current vertex declaration, ie the source of vertex data.
virtual void _applyObliqueDepthProjection(Matrix4 &matrix, const Plane &plane, bool forGpuProgram)=0
Update a perspective projection matrix to use 'oblique depth projection'.
void setGlobalInstanceVertexBuffer(const HardwareVertexBufferSharedPtr &val)
Sets the global instance vertex buffer.
bool updatePassIterationRenderState(void)
updates pass iteration rendering state including bound gpu program parameter pass iteration auto cons...
virtual void _setViewMatrix(const Matrix4 &m)=0
Sets the view transform matrix.
virtual void _updateAllRenderTargets(bool swapBuffers=true)
Internal method for updating all render targets attached to this rendering system.
virtual void _setTextureCoordCalculation(size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)=0
Sets a method for automatically calculating texture coordinates for a stage.
virtual void _setTextureProjectionRelativeTo(bool enabled, const Vector3 &pos)
Notify the rendersystem that it should adjust texture projection to be relative to a different origin...
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 ...
virtual void _setWorldMatrices(const Matrix4 *m, unsigned short count)
Sets multiple world matrices (vertex blending).
virtual void _setProjectionMatrix(const Matrix4 &m)=0
Sets the projection transform matrix.
virtual void _setWorldMatrix(const Matrix4 &m)=0
Sets the world transform matrix.
virtual void getCustomAttribute(const String &name, void *pData)
Gets a custom (maybe platform-specific) attribute.
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.
virtual void shutdown(void)
Shutdown the renderer and cleanup resources.
GpuProgramParametersSharedPtr mActiveTesselationDomainGpuProgramParameters
virtual void _setTextureMipmapBias(size_t unit, float bias)=0
Sets the mipmap bias value for a given texture unit.
size_t mDisabledTexUnitsFrom
Texture units from this upwards are disabled.
uint16 getNativeShadingLanguageVersion() const
Gets the native shading language version for this render system.
virtual void initialiseFromRenderSystemCapabilities(RenderSystemCapabilities *caps, RenderTarget *primary)=0
Initialize the render system from the capabilities.
virtual void _makeOrthoMatrix(const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0
Builds an orthographic projection matrix suitable for this render system.
virtual void _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.
RenderSystemCapabilities * mRealCapabilities
Used to store the capabilities of the graphics card.
virtual void setClipPlanesImpl(const PlaneList &clipPlanes)=0
Internal method used to set the underlying clip planes when needed.
const RenderSystemCapabilities * getCapabilities(void) const
Gets the capabilities of the render system.
virtual void setNormaliseNormals(bool normalise)=0
Sets whether or not normals are to be automatically normalised.
virtual void _setTexture(size_t unit, bool enabled, const String &texname)
Sets the texture to bind to a given texture unit.
virtual void markProfileEvent(const String &event)=0
Marks an instantaneous event for graphics profilers.
virtual unsigned int getDisplayMonitorCount() const =0
Gets the number of display monitors.
virtual void _endFrame(void)=0
Ends rendering of a frame to the current viewport.
virtual void registerThread()=0
Register the an additional thread which may make calls to rendersystem-related objects.
virtual void clearFrameBuffer(unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)=0
Clears one or more frame buffers on the active render target.
virtual void setAmbientLight(float r, float g, float b)=0
Sets the colour & strength of the ambient (global directionless) light in the world.
virtual String validateConfigOptions(void)=0
Validates the options set for the rendering system, returning a message if there are problems.
list< Listener * >::type ListenerList
StringVector mEventNames
List of names of events this rendersystem may raise.
virtual RenderTarget * getRenderTarget(const String &name)
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be ...
void setGlobalInstanceVertexBufferVertexDeclaration(VertexDeclaration *val)
Sets vertex declaration for the global vertex buffer for the global instancing.
virtual void _setTextureLayerAnisotropy(size_t unit, unsigned int maxAnisotropy)=0
Sets the maximal anisotropy for the specified texture unit.
virtual void addClipPlane(const Plane &p)
Add a user clipping plane.
virtual void _resumeFrame(RenderSystemContext *context)
Resume rendering for a frame.
virtual unsigned int _getFaceCount(void) const
Reports the number of tris rendered since the last _beginGeometryCount call.
DepthBufferMap mDepthBufferPool
DepthBuffers to be attached to render targets.
virtual unsigned int _getBatchCount(void) const
Reports the number of batches rendered since the last _beginGeometryCount call.
virtual void destroyHardwareOcclusionQuery(HardwareOcclusionQuery *hq)
Destroy a hardware occlusion query object.
virtual void _setRenderTarget(RenderTarget *target)=0
Set current render target to target, enabling its device context if needed.
virtual const DriverVersion & getDriverVersion(void) const
Returns the driver version.
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 (...
virtual void setDepthBufferFor(RenderTarget *renderTarget)
Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.
VertexDeclaration * mGlobalInstanceVertexBufferVertexDeclaration
a vertex declaration for the global vertex buffer for the global instancing
virtual void _setSurfaceParams(const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking=TVC_NONE)=0
Sets the surface properties to be used for future rendering.
virtual CullingMode _getCullingMode(void) const
virtual Viewport * _getViewport(void)
Get the current active viewport for rendering.
virtual void beginProfileEvent(const String &eventName)=0
This marks the beginning of an event for GPU profiling.
ListenerList mEventListeners
bool mDerivedDepthBias
Whether to update the depth bias per render call.
virtual void _makeProjectionMatrix(const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0
Builds a perspective projection matrix suitable for this render system.
virtual void _setTextureUnitSettings(size_t texUnit, TextureUnitState &tl)
Utility function for setting all the properties of a texture unit at once.
virtual void _setTextureBorderColour(size_t unit, const ColourValue &colour)=0
Sets the texture border colour for a texture unit.
virtual void _setTextureCoordSet(size_t unit, size_t index)=0
Sets the texture coordinate set to use for a texture unit.
virtual void _setTextureUnitCompareEnabled(size_t unit, bool compare)=0
Sets whether the compare func is enabled or not for this texture unit.
virtual void addListener(Listener *l)
Adds a listener to the custom events that this render system can raise.
virtual void _setTextureUnitFiltering(size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
Sets the filtering options for a given texture unit.
virtual void _convertProjectionMatrix(const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)=0
Converts a uniform projection matrix to suitable for this render system.
virtual void 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.
virtual void bindGpuProgramPassIterationParameters(GpuProgramType gptype)=0
Only binds Gpu program parameters used for passes that have more than one iteration rendering.
virtual void attachRenderTarget(RenderTarget &target)
Attaches the passed render target to the render system.
list< HardwareOcclusionQuery * >::type HardwareOcclusionQueryList
HardwareVertexBufferSharedPtr getGlobalInstanceVertexBuffer() const
Returns the global instance vertex buffer.
virtual void bindGpuProgram(GpuProgram *prg)
Binds a given GpuProgram (but not the parameters).
GpuProgramParametersSharedPtr mActiveVertexGpuProgramParameters
The Active GPU programs and gpu program parameters.
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)=0
Determines if this system supports hardware accelerated stencil buffer.
virtual ConfigOptionMap & getConfigOptions(void)=0
Returns the details of this API's configuration options.
virtual const StringVector & getRenderSystemEvents(void) const
Gets a list of the rendersystem specific events that this rendersystem can raise.
virtual void _notifyCameraRemoved(const Camera *cam)
Utility method to notify all render targets that a camera has been removed, in case they were referri...
virtual const String & getName(void) const =0
Returns the name of the rendering system.
virtual void _setVertexTexture(size_t unit, const TexturePtr &tex)
Binds a texture to a vertex sampler.
size_t getGlobalNumberOfInstances() const
Gets the global number of instances.
virtual void _swapAllRenderTargetBuffers()
Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was ca...
A 'canvas' which can receive the results of a rendering operation.
Manages the target rendering window.
Reference-counted shared pointer, used for objects where implicit destruction is required.
Class for loading & managing textures.
Class representing the state of a single texture unit during a Pass of a Technique,...
Standard 3-dimensional vector.
Definition OgreVector3.h:52
Records the state of all the vertex buffer bindings required to provide a vertex declaration with the...
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
An abstraction of a viewport, i.e.
CompareFunction
Comparison functions used for the depth/stencil buffer operations and others.
Definition OgreCommon.h:65
FilterOptions
Filtering options for textures / mipmaps.
Definition OgreCommon.h:101
vector< RenderWindow * >::type RenderWindowList
Render window container.
Definition OgreCommon.h:764
PolygonMode
The polygon mode to use when rasterising.
Definition OgreCommon.h:180
vector< RenderWindowDescription >::type RenderWindowDescriptionList
Render window creation parameters container.
Definition OgreCommon.h:761
ShadeOptions
Light shading modes.
Definition OgreCommon.h:114
FogMode
Fog modes.
Definition OgreCommon.h:122
CullingMode
Hardware culling modes based on vertex winding.
Definition OgreCommon.h:136
FilterType
Definition OgreCommon.h:91
map< String, ConfigOption >::type ConfigOptionMap
SceneBlendFactor
Blending factors for manually blending objects with the scene.
SceneBlendOperation
Blending operations controls how objects are blended into the scene.
VertexElementType
Vertex element type, used to identify the base types of the vertex contents.
map< uint16, DepthBufferVec >::type DepthBufferMap
multimap< uchar, RenderTarget * >::type RenderTargetPriorityMap
map< String, RenderTarget * >::type RenderTargetMap
TexCoordCalcMethod
Enum describing the ways to generate texture coordinates.
vector< DepthBuffer * >::type DepthBufferVec
StencilOperation
Enum describing the various actions which can be taken on the stencil buffer.
@ TEXCALC_ENVIRONMENT_MAP
Environment map based on vertex normals.
@ TEXCALC_ENVIRONMENT_MAP_PLANAR
Environment map based on vertex positions.
@ TEXCALC_NONE
No calculated texture coordinates.
@ TEXCALC_ENVIRONMENT_MAP_NORMAL
@ TEXCALC_PROJECTIVE_TEXTURE
Projective texture.
@ TEXCALC_ENVIRONMENT_MAP_REFLECTION
@ SOP_INVERT
Invert the bits of the stencil buffer.
@ SOP_INCREMENT_WRAP
Increase the stencil value by 1, wrapping back to 0 when incrementing the maximum value.
@ SOP_DECREMENT
Decrease the stencil value by 1, clamping at 0.
@ SOP_ZERO
Set the stencil value to zero.
@ SOP_DECREMENT_WRAP
Decrease the stencil value by 1, wrapping when decrementing 0.
@ SOP_KEEP
Leave the stencil buffer unchanged.
@ SOP_REPLACE
Set the stencil value to the reference value.
@ SOP_INCREMENT
Increase the stencil value by 1, clamping at the maximum value.
GpuProgramType
Enumerates the types of programs which can run on the GPU.
_StringBase String
DriverVersion is used by RenderSystemCapabilities and both GL and D3D9 to store the version of the cu...
Texture addressing mode for each texture coordinate.
std::list< T, A > type
std::multimap< K, V, P, A > type
std::vector< T, A > type

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.