#include <OgreRenderSystem.h>
Public Types | |
typedef MapIterator< Ogre::RenderTargetMap > | RenderTargetIterator |
Iterator over RenderTargets. | |
Public Member Functions | |
RenderSystem () | |
Default Constructor. | |
virtual | ~RenderSystem () |
Destructor. | |
virtual const String & | getName (void) const =0 |
Returns the name of the rendering system. | |
virtual ConfigOptionMap & | getConfigOptions (void)=0 |
Returns the details of this API's configuration options. | |
virtual void | setConfigOption (const String &name, const String &value)=0 |
Sets an option for this API. | |
virtual HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)=0 |
Create an object for performing hardware occlusion queries. | |
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq) |
Destroy a hardware occlusion query object. | |
virtual String | validateConfigOptions (void)=0 |
Validates the options set for the rendering system, returning a message if there are problems. | |
virtual RenderWindow * | initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window") |
Start up the renderer using the settings selected (Or the defaults if none have been selected). | |
virtual void | reinitialise (void)=0 |
Restart the renderer (normally following a change in settings). | |
virtual void | shutdown (void) |
Shutdown the renderer and cleanup resources. | |
virtual void | setAmbientLight (float r, float g, float b)=0 |
Sets the colour & strength of the ambient (global directionless) light in the world. | |
virtual void | setShadingType (ShadeOptions so)=0 |
Sets the type of light shading required (default = Gouraud). | |
virtual void | setLightingEnabled (bool enabled)=0 |
Sets whether or not dynamic lighting is enabled. | |
void | setWBufferEnabled (bool enabled) |
Sets whether or not W-buffers are enabled if they are avalible for this renderer. | |
bool | getWBufferEnabled (void) const |
Returns true if the renderer will try to use W-buffers when avalible. | |
virtual RenderWindow * | createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)=0 |
Creates a new rendering window. | |
RenderTexture * | createRenderTexture (const String &name, unsigned int width, unsigned int height, TextureType texType=TEX_TYPE_2D, PixelFormat internalFormat=PF_X8R8G8B8, const NameValuePairList *miscParams=0) |
Creates and registers a render texture object. | |
virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)=0 |
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. | |
virtual void | destroyRenderWindow (const String &name) |
Destroys a render window. | |
virtual void | destroyRenderTexture (const String &name) |
Destroys a render texture. | |
virtual void | destroyRenderTarget (const String &name) |
Destroys a render target of any sort. | |
virtual void | attachRenderTarget (RenderTarget &target) |
Attaches the passed render target to the render system. | |
virtual RenderTarget * | getRenderTarget (const String &name) |
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found. | |
virtual RenderTarget * | detachRenderTarget (const String &name) |
Detaches the render target with the passed name from the render system and returns a pointer to it. | |
virtual RenderTargetIterator | getRenderTargetIterator (void) |
Returns a specialised MapIterator over all render targets attached to the RenderSystem. | |
virtual String | getErrorDescription (long errorNumber) const =0 |
Returns a description of an error code. | |
void | setWaitForVerticalBlank (bool enabled) |
Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers. | |
bool | getWaitForVerticalBlank (void) const |
Returns true if the system is synchronising frames with the monitor vertical blank. | |
virtual void | _useLights (const LightList &lights, unsigned short limit)=0 |
Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits). | |
virtual void | _setWorldMatrix (const Matrix4 &m)=0 |
Sets the world transform matrix. | |
virtual void | _setWorldMatrices (const Matrix4 *m, unsigned short count) |
Sets multiple world matrices (vertex blending). | |
virtual void | _setViewMatrix (const Matrix4 &m)=0 |
Sets the view transform matrix. | |
virtual void | _setProjectionMatrix (const Matrix4 &m)=0 |
Sets the projection transform matrix. | |
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl) |
Utility function for setting all the properties of a texture unit at once. | |
virtual void | _disableTextureUnit (size_t texUnit) |
Turns off a texture unit. | |
virtual void | _disableTextureUnitsFrom (size_t texUnit) |
Disables all texture units from the given unit upwards. | |
virtual void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking=TVC_NONE)=0 |
Sets the surface properties to be used for future rendering. | |
virtual void | _setPointSpritesEnabled (bool enabled)=0 |
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. | |
virtual void | _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)=0 |
Sets the size of points and how they are attenuated with distance. | |
virtual void | _setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)=0 |
Sets the texture to bind to a given texture unit. | |
virtual void | _setTexture (size_t unit, bool enabled, const String &texname) |
Sets the texture to bind to a given texture unit. | |
virtual void | _setVertexTexture (size_t unit, const TexturePtr &tex) |
Binds a texture to a vertex sampler. | |
virtual void | _setTextureCoordSet (size_t unit, size_t index)=0 |
Sets the texture coordinate set to use for a texture unit. | |
virtual void | _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)=0 |
Sets a method for automatically calculating texture coordinates for a stage. | |
virtual void | _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)=0 |
Sets the texture blend modes from a TextureUnitState record. | |
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter) |
Sets the filtering options for a given texture unit. | |
virtual void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)=0 |
Sets a single filter for a given texture unit. | |
virtual void | _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)=0 |
Sets the maximal anisotropy for the specified texture unit. | |
virtual void | _setTextureAddressingMode (size_t unit, const TextureUnitState::UVWAddressingMode &uvw)=0 |
Sets the texture addressing mode for a texture unit. | |
virtual void | _setTextureBorderColour (size_t unit, const ColourValue &colour)=0 |
Sets the texture border colour for a texture unit. | |
virtual void | _setTextureMipmapBias (size_t unit, float bias)=0 |
Sets the mipmap bias value for a given texture unit. | |
virtual void | _setTextureMatrix (size_t unit, const Matrix4 &xform)=0 |
Sets the texture coordinate transformation matrix for a texture unit. | |
virtual void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor)=0 |
Sets the global blending factors for combining subsequent renders with the existing frame contents. | |
virtual void | _setAlphaRejectSettings (CompareFunction func, unsigned char value)=0 |
Sets the global alpha rejection approach for future renders. | |
virtual void | _beginFrame (void)=0 |
Signifies the beginning of a frame, ie the start of rendering on a single viewport. | |
virtual void | _endFrame (void)=0 |
Ends rendering of a frame to the current viewport. | |
virtual void | _setViewport (Viewport *vp)=0 |
Sets the provided viewport as the active one for future rendering operations. | |
virtual Viewport * | _getViewport (void) |
Get the current active viewport for rendering. | |
virtual void | _setCullingMode (CullingMode mode)=0 |
Sets the culling mode for the render system based on the 'vertex winding'. | |
virtual CullingMode | _getCullingMode (void) const |
virtual void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)=0 |
Sets the mode of operation for depth buffer tests from this point onwards. | |
virtual void | _setDepthBufferCheckEnabled (bool enabled=true)=0 |
Sets whether or not the depth buffer check is performed before a pixel write. | |
virtual void | _setDepthBufferWriteEnabled (bool enabled=true)=0 |
Sets whether or not the depth buffer is updated after a pixel write. | |
virtual void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)=0 |
Sets the comparison function for the depth buffer check. | |
virtual void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)=0 |
Sets whether or not colour buffer writing is enabled, and for which channels. | |
virtual void | _setDepthBias (float constantBias, float slopeScaleBias=0.0f)=0 |
Sets the depth bias, NB you should use the Material version of this. | |
virtual void | _setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=1.0, Real linearStart=0.0, Real linearEnd=1.0)=0 |
Sets the fogging mode for future geometry. | |
virtual void | _beginGeometryCount (void) |
The RenderSystem will keep a count of tris rendered, this resets the count. | |
virtual unsigned int | _getFaceCount (void) const |
Reports the number of tris rendered since the last _beginGeometryCount call. | |
virtual unsigned int | _getBatchCount (void) const |
Reports the number of batches rendered since the last _beginGeometryCount call. | |
virtual unsigned int | _getVertexCount (void) const |
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. | |
virtual void | convertColourValue (const ColourValue &colour, uint32 *pDest) |
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem. | |
virtual VertexElementType | getColourVertexElementType (void) const =0 |
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. | |
virtual void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)=0 |
Converts a uniform projection matrix to suitable for this render system. | |
virtual void | _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0 |
Builds a perspective projection matrix suitable for this render system. | |
virtual void | _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0 |
Builds a perspective projection matrix for the case when frustum is not centered around camera. | |
virtual void | _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)=0 |
Builds an orthographic projection matrix suitable for this render system. | |
virtual void | _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)=0 |
Update a perspective projection matrix to use 'oblique depth projection'. | |
virtual void | _setPolygonMode (PolygonMode level)=0 |
Sets how to rasterise triangles, as points, wireframe or solid polys. | |
virtual void | setStencilCheckEnabled (bool enabled)=0 |
Turns stencil buffer checking on or off. | |
virtual void | setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 mask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false)=0 |
This method allows you to set all the stencil buffer parameters in one call. | |
virtual void | setVertexDeclaration (VertexDeclaration *decl)=0 |
Sets the current vertex declaration, ie the source of vertex data. | |
virtual void | setVertexBufferBinding (VertexBufferBinding *binding)=0 |
Sets the current vertex buffer binding state. | |
virtual void | setNormaliseNormals (bool normalise)=0 |
Sets whether or not normals are to be automatically normalised. | |
virtual void | _render (const RenderOperation &op) |
Render something to the active viewport. | |
const RenderSystemCapabilities * | getCapabilities (void) const |
Gets the capabilities of the render system. | |
virtual void | bindGpuProgram (GpuProgram *prg) |
Binds a given GpuProgram (but not the parameters). | |
virtual void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params)=0 |
Bind Gpu program parameters. | |
virtual void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)=0 |
Only binds Gpu program parameters used for passes that have more than one iteration rendering. | |
virtual void | unbindGpuProgram (GpuProgramType gptype) |
Unbinds GpuPrograms of a given GpuProgramType. | |
virtual bool | isGpuProgramBound (GpuProgramType gptype) |
Returns whether or not a Gpu program of the given type is currently bound. | |
virtual void | setClipPlanes (const PlaneList &clipPlanes)=0 |
sets the clipping region. | |
virtual void | _initRenderTargets (void) |
Utility method for initialising all render targets attached to this rendering system. | |
virtual void | _notifyCameraRemoved (const Camera *cam) |
Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer. | |
virtual void | _updateAllRenderTargets (void) |
Internal method for updating all render targets attached to this rendering system. | |
virtual void | setClipPlane (ushort index, const Plane &p) |
Set a clipping plane. | |
virtual void | setClipPlane (ushort index, Real A, Real B, Real C, Real D)=0 |
Set a clipping plane. | |
virtual void | enableClipPlane (ushort index, bool enable)=0 |
Enable the clipping plane. | |
virtual void | setInvertVertexWinding (bool invert) |
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. | |
virtual void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)=0 |
Sets the 'scissor region' ie the region of the target in which rendering can take place. | |
virtual void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)=0 |
Clears one or more frame buffers on the active render target. | |
virtual Real | getHorizontalTexelOffset (void)=0 |
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. | |
virtual Real | getVerticalTexelOffset (void)=0 |
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. | |
virtual Real | getMinimumDepthInputValue (void)=0 |
Gets the minimum (closest) depth value to be used when rendering using identity transforms. | |
virtual Real | getMaximumDepthInputValue (void)=0 |
Gets the maximum (farthest) depth value to be used when rendering using identity transforms. | |
void | setCurrentPassIterationCount (const size_t count) |
set the current multi pass count value. | |
virtual void | addListener (Listener *l) |
Adds a listener to the custom events that this render system can raise. | |
virtual void | removeListener (Listener *l) |
Remove a listener to the custom events that this render system can raise. | |
virtual const StringVector & | getRenderSystemEvents (void) const |
Gets a list of the rendersystem specific events that this rendersystem can raise. | |
virtual void | preExtraThreadsStarted ()=0 |
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered. | |
virtual void | postExtraThreadsStarted ()=0 |
virtual void * | registerThread ()=0 |
Register the an additional thread which may make calls to rendersystem-related objects. | |
virtual void | unregisterThread (void *opaque=NULL)=0 |
Unregister an additional thread which may make calls to rendersystem-related objects. | |
Protected Types | |
typedef std::list< Listener * > | ListenerList |
typedef std::list< HardwareOcclusionQuery * > | HardwareOcclusionQueryList |
Protected Member Functions | |
bool | updatePassIterationRenderState (void) |
updates pass iteration rendering state including bound gpu program parameter pass iteration auto constant entry | |
virtual void | fireEvent (const String &name, const NameValuePairList *params=0) |
Internal method for firing a rendersystem event. | |
Protected Attributes | |
RenderTargetMap | mRenderTargets |
The render targets. | |
RenderTargetPriorityMap | mPrioritisedRenderTargets |
The render targets, ordered by priority. | |
RenderTarget * | mActiveRenderTarget |
The Active render target. | |
GpuProgramParametersSharedPtr | mActiveVertexGpuProgramParameters |
The Active GPU programs and gpu program parameters. | |
GpuProgramParametersSharedPtr | mActiveFragmentGpuProgramParameters |
TextureManager * | mTextureManager |
RenderSystemCapabilities * | mCapabilities |
Used to store the capabilities of the graphics card. | |
Viewport * | mActiveViewport |
CullingMode | mCullingMode |
bool | mVSync |
bool | mWBuffer |
size_t | mBatchCount |
size_t | mFaceCount |
size_t | mVertexCount |
ColourValue | mManualBlendColours [OGRE_MAX_TEXTURE_LAYERS][2] |
Saved manual colour blends. | |
bool | mInvertVertexWinding |
size_t | mDisabledTexUnitsFrom |
Texture units from this upwards are disabled. | |
size_t | mCurrentPassIterationCount |
number of times to render the current state | |
StringVector | mEventNames |
List of names of events this rendersystem may raise. | |
ListenerList | mEventListeners |
HardwareOcclusionQueryList | mHwOcclusionQueries |
bool | mVertexProgramBound |
bool | mFragmentProgramBound |
Classes | |
class | Listener |
Defines a listener on the custom events that this render system can raise. More... |
Definition at line 114 of file OgreRenderSystem.h.
|
Definition at line 1244 of file OgreRenderSystem.h. |
|
Definition at line 1241 of file OgreRenderSystem.h. |
|
Iterator over RenderTargets.
Definition at line 427 of file OgreRenderSystem.h. |
|
Default Constructor.
|
|
Destructor.
|
|
Update a perspective projection matrix to use 'oblique depth projection'.
|
|
Signifies the beginning of a frame, ie the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist. |
|
The RenderSystem will keep a count of tris rendered, this resets the count.
|
|
Converts a uniform projection matrix to suitable for this render system.
|
|
Turns off a texture unit.
|
|
Disables all texture units from the given unit upwards.
|
|
Ends rendering of a frame to the current viewport.
|
|
Reports the number of batches rendered since the last _beginGeometryCount call.
|
|
|
|
Reports the number of tris rendered since the last _beginGeometryCount call.
|
|
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
|
|
Get the current active viewport for rendering.
|
|
Utility method for initialising all render targets attached to this rendering system.
|
|
Builds an orthographic projection matrix suitable for this render system.
|
|
Builds a perspective projection matrix for the case when frustum is not centered around camera.
|
|
Builds a perspective projection matrix suitable for this render system.
|
|
Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer.
|
|
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
|
|
Sets the global alpha rejection approach for future renders. By default images are rendered regardless of texture alpha. This method lets you change that.
|
|
Sets whether or not colour buffer writing is enabled, and for which channels.
|
|
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. |
|
Sets the depth bias, NB you should use the Material version of this.
|
|
Sets whether or not the depth buffer check is performed before a pixel write.
|
|
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)
|
|
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.
|
|
Sets whether or not the depth buffer is updated after a pixel write.
|
|
Sets the fogging mode for future geometry.
|
|
Sets the size of points and how they are attenuated with distance.
|
|
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
|
|
Sets how to rasterise triangles, as points, wireframe or solid polys.
|
|
Sets the projection transform matrix.
|
|
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.
|
|
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.
|
|
Sets the texture to bind to a given texture unit. User processes would not normally call this direct unless rendering primitives themselves.
|
|
Sets the texture to bind to a given texture unit. User processes would not normally call this direct unless rendering primitives themselves.
|
|
Sets the texture addressing mode for a texture unit.
|
|
Sets the texture blend modes from a TextureUnitState record. Meant for use internally only - apps should use the Material and TextureUnitState classes.
|
|
Sets the texture border colour for a texture unit.
|
|
Sets a method for automatically calculating texture coordinates for a stage. Should not be used by apps - for use by Ogre only. |
|
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.
|
|
Sets the maximal anisotropy for the specified texture unit.
|
|
Sets the texture coordinate transformation matrix for a texture unit.
|
|
Sets the mipmap bias value for a given texture unit.
|
|
Sets a single filter for a given texture unit.
|
|
Sets the filtering options for a given texture unit.
|
|
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. |
|
Binds a texture to a vertex sampler.
|
|
Sets the view transform matrix.
|
|
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.
|
|
Sets multiple world matrices (vertex blending).
|
|
Sets the world transform matrix.
|
|
Internal method for updating all render targets attached to this rendering system.
|
|
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).
|
|
Adds a listener to the custom events that this render system can raise.
|
|
Attaches the passed render target to the render system.
|
|
Binds a given GpuProgram (but not the parameters).
|
|
Bind Gpu program parameters.
|
|
Only binds Gpu program parameters used for passes that have more than one iteration rendering.
|
|
Clears one or more frame buffers on the active render target.
|
|
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
|
|
Create an object for performing hardware occlusion queries.
|
|
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. Surfaces can be bound and unbound at will. This fails if mCapabilities->numMultiRenderTargets() is smaller than 2. |
|
Creates and registers a render texture object.
|
|
Creates a new rendering window.
Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific] Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:poslong (Display*:Window) for GLX Default: 0 (None) Key: "externalGLControl" [Win32 OpenGL specific] Description: Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. The Ogre OpenGL context can be retrieved after Ogre initialisation by calling wglGetCurrentDC() and wglGetCurrentContext(). It is only used when the externalWindowHandle parameter is used. Values: true, false Default: false Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:poslong for GLX (Display*:Window) Default: 0 (None) Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0 Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0 Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false Key: "fbconfigid" [GLX specific] Description: Specify a custom GLXFBConfig (pixel format) if needed Values: poslong (GLXFBConfig) Default: Choose the "best" one Key: "glxcontext" [GLX specific] Description: Specify a custom GLXContext to use; the context will not be auto-deleted at shutdown; you also may specify a drawable (a GLXWindow or a GLXPBuffer or whatever) if pre-created. Values: poslong (GLXContext) or poslong:poslong (GLXContext:GLXDrawable) Default: Both auto-created by the RenderSystem |
|
Destroy a hardware occlusion query object.
|
|
Destroys a render target of any sort.
|
|
Destroys a render texture.
|
|
Destroys a render window.
|
|
Detaches the render target with the passed name from the render system and returns a pointer to it.
|
|
Enable the clipping plane.
|
|
Internal method for firing a rendersystem event.
|
|
Gets the capabilities of the render system.
Definition at line 965 of file OgreRenderSystem.h. |
|
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
|
|
Returns the details of this API's configuration options.
|
|
Returns a description of an error code.
|
|
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
|
|
Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
|
|
Gets the minimum (closest) depth value to be used when rendering using identity transforms.
|
|
Returns the name of the rendering system.
|
|
Gets a list of the rendersystem specific events that this rendersystem can raise.
Definition at line 1123 of file OgreRenderSystem.h. |
|
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.
|
|
Returns a specialised MapIterator over all render targets attached to the RenderSystem.
Definition at line 430 of file OgreRenderSystem.h. |
|
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
|
|
Returns true if the system is synchronising frames with the monitor vertical blank.
|
|
Returns true if the renderer will try to use W-buffers when avalible.
|
|
Start up the renderer using the settings selected (Or the defaults if none have been selected).
|
|
Returns whether or not a Gpu program of the given type is currently bound.
|
|
|
|
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.
|
|
Register the an additional thread which may make calls to rendersystem-related objects.
|
|
Restart the renderer (normally following a change in settings).
|
|
Remove a listener to the custom events that this render system can raise.
|
|
Sets the colour & strength of the ambient (global directionless) light in the world.
|
|
Set a clipping plane.
|
|
Set a clipping plane.
|
|
sets the clipping region.
|
|
Sets an option for this API.
|
|
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.
Definition at line 1081 of file OgreRenderSystem.h. |
|
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
|
|
Sets whether or not dynamic lighting is enabled.
|
|
Sets whether or not normals are to be automatically normalised.
|
|
Sets the 'scissor region' ie the region of the target in which rendering can take place.
|
|
Sets the type of light shading required (default = Gouraud).
|
|
This method allows you to set all the stencil buffer parameters in one call.
|
|
Turns stencil buffer checking on or off.
|
|
Sets the current vertex buffer binding state.
|
|
Sets the current vertex declaration, ie the source of vertex data.
|
|
Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers.
|
|
Sets whether or not W-buffers are enabled if they are avalible for this renderer.
|
|
Shutdown the renderer and cleanup resources.
|
|
Unbinds GpuPrograms of a given GpuProgramType.
|
|
Unregister an additional thread which may make calls to rendersystem-related objects.
|
|
updates pass iteration rendering state including bound gpu program parameter pass iteration auto constant entry
|
|
Validates the options set for the rendering system, returning a message if there are problems.
|
|
Definition at line 1195 of file OgreRenderSystem.h. |
|
The Active render target.
Definition at line 1192 of file OgreRenderSystem.h. |
|
The Active GPU programs and gpu program parameters.
Definition at line 1194 of file OgreRenderSystem.h. |
|
Definition at line 1207 of file OgreRenderSystem.h. |
|
Definition at line 1214 of file OgreRenderSystem.h. |
|
Used to store the capabilities of the graphics card.
Definition at line 1204 of file OgreRenderSystem.h. |
|
Definition at line 1209 of file OgreRenderSystem.h. |
|
number of times to render the current state
Definition at line 1227 of file OgreRenderSystem.h. |
|
Texture units from this upwards are disabled.
Definition at line 1224 of file OgreRenderSystem.h. |
|
Definition at line 1242 of file OgreRenderSystem.h. |
|
List of names of events this rendersystem may raise.
Definition at line 1236 of file OgreRenderSystem.h. |
|
Definition at line 1215 of file OgreRenderSystem.h. |
|
Definition at line 1248 of file OgreRenderSystem.h. |
|
Definition at line 1245 of file OgreRenderSystem.h. |
|
Definition at line 1221 of file OgreRenderSystem.h. |
|
Saved manual colour blends.
Definition at line 1219 of file OgreRenderSystem.h. |
|
The render targets, ordered by priority.
Definition at line 1190 of file OgreRenderSystem.h. |
|
The render targets.
Definition at line 1188 of file OgreRenderSystem.h. |
|
Definition at line 1201 of file OgreRenderSystem.h. |
|
Definition at line 1216 of file OgreRenderSystem.h. |
|
Definition at line 1247 of file OgreRenderSystem.h. |
|
Definition at line 1211 of file OgreRenderSystem.h. |
|
Definition at line 1212 of file OgreRenderSystem.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 25 13:06:51 2007