Ogre::D3D9RenderSystem Class Reference

Implementation of DirectX9 as a rendering system. More...

`#include <OgreD3D9RenderSystem.h>`

Inheritance diagram for Ogre::D3D9RenderSystem:
[legend]

List of all members.

## Classes

struct | sD3DTextureStageDesc
| structure holding texture unit settings for every stage More...

## Public Types

enum | MultiheadUseType { mutAuto, mutYes, mutNo }
typedef MapIterator < Ogre::RenderTargetMap > | RenderTargetIterator
| Iterator over RenderTargets.

## Public Member Functions

| D3D9RenderSystem (HINSTANCE hInstance)
| ~D3D9RenderSystem ()
virtual void | initConfigOptions ()
ConfigOptionMap & | getConfigOptions ()
| Returns the details of this API's configuration options.
String | validateConfigOptions ()
| Validates the options set for the rendering system, returning a message if there are problems.
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).
RenderWindow * | _createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
bool | _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
DepthBuffer * | _createDepthBufferFor (RenderTarget *renderTarget)
DepthBuffer * | _addManualDepthBuffer (IDirect3DDevice9 *depthSurfaceDevice, IDirect3DSurface9 *surf)
| This function is meant to add Depth Buffers to the pool that aren't released when the DepthBuffer is deleted.
void | _cleanupDepthBuffers (IDirect3DDevice9 *creator)
void | _cleanupDepthBuffers (IDirect3DSurface9 *manualSurface)
| This function does NOT override RenderSystem::_cleanupDepthBuffers(bool) functionality.
void | _setRenderTarget (RenderTarget *target)
| Set current render target to target, enabling its GL context if needed.
virtual MultiRenderTarget * | createMultiRenderTarget (const String &name)
virtual RenderTarget * | detachRenderTarget (const String &name)
String | getErrorDescription (long errorNumber) const
| Returns a description of an error code.
const String & | getName () const
| Returns the name of the rendering system.
void | setConfigOption (const String &name, const String &value)
| Sets an option for this API.
void | reinitialise ()
| Restart the renderer (normally following a change in settings).
void | shutdown ()
| Shutdown the renderer and cleanup resources.
void | setAmbientLight (float r, float g, float b)
| Sets the colour & strength of the ambient (global directionless) light in the world.
void | setShadingType (ShadeOptions so)
| Sets the type of light shading required (default = Gouraud).
void | setLightingEnabled (bool enabled)
| Sets whether or not dynamic lighting is enabled.
void | destroyRenderTarget (const String &name)
| Destroys a render target of any sort.
VertexElementType | getColourVertexElementType () const
| Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
void | setStencilCheckEnabled (bool enabled)
| Turns stencil buffer checking on or off.
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)
| Determines if this system supports hardware accelerated stencil buffer.
void | setNormaliseNormals (bool normalise)
| Sets whether or not normals are to be automatically normalised.
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)
void | _setWorldMatrix (const Matrix4 &m)
| Sets the world transform matrix.
void | _setViewMatrix (const Matrix4 &m)
| Sets the view transform matrix.
void | _setProjectionMatrix (const Matrix4 &m)
| Sets the projection transform matrix.
void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking)
| Sets the surface properties to be used for future rendering.
void | _setPointSpritesEnabled (bool enabled)
| Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
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.
void | _setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)
| Sets the texture to bind to a given texture unit.
void | _setVertexTexture (size_t unit, const TexturePtr &tex)
| Binds a texture to a vertex sampler.
void | _disableTextureUnit (size_t texUnit)
| Turns off a texture unit.
void | _setTextureCoordSet (size_t unit, size_t index)
| Sets the texture coordinate set to use for a texture unit.
void | _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)
| Sets a method for automatically calculating texture coordinates for a stage.
void | _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
| Sets the texture blend modes from a TextureUnitState record.
void | _setTextureAddressingMode (size_t stage, const TextureUnitState::UVWAddressingMode &uvw)
| Sets the texture addressing mode for a texture unit.
void | _setTextureBorderColour (size_t stage, const ColourValue &colour)
| Sets the texture border colour for a texture unit.
void | _setTextureMipmapBias (size_t unit, float bias)
| Sets the mipmap bias value for a given texture unit.
void | _setTextureMatrix (size_t unit, const Matrix4 &xform)
| Sets the texture coordinate transformation matrix for a texture unit.
void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op)
| Sets the global blending factors for combining subsequent renders with the existing frame contents.
void | _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp)
| Sets the global blending factors for combining subsequent renders with the existing frame contents.
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)
| Sets the global alpha rejection approach for future renders.
void | _setViewport (Viewport *vp)
| Sets the provided viewport as the active one for future rendering operations.
void | _beginFrame ()
| Signifies the beginning of a frame, i.e.
virtual RenderSystemContext * | _pauseFrame (void)
| Pause rendering for a frame.
virtual void | _resumeFrame (RenderSystemContext *context)
| Resume rendering for a frame.
void | _endFrame ()
| Ends rendering of a frame to the current viewport.
void | _setCullingMode (CullingMode mode)
| Sets the culling mode for the render system based on the 'vertex winding'.
void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)
| Sets the mode of operation for depth buffer tests from this point onwards.
void | _setDepthBufferCheckEnabled (bool enabled=true)
| Sets whether or not the depth buffer check is performed before a pixel write.
void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)
| Sets whether or not colour buffer writing is enabled, and for which channels.
void | _setDepthBufferWriteEnabled (bool enabled=true)
| Sets whether or not the depth buffer is updated after a pixel write.
void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)
| Sets the comparison function for the depth buffer check.
void | _setDepthBias (float constantBias, float slopeScaleBias)
| Sets the depth bias, NB you should use the Material version of this.
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.
void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)
| Converts a uniform projection matrix to suitable for this render system.
void | _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds a perspective projection matrix suitable for this render system.
void | _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds a perspective projection matrix for the case when frustum is not centered around camera.
void | _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
| Builds an orthographic projection matrix suitable for this render system.
void | _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)
| Update a perspective projection matrix to use 'oblique depth projection'.
void | _setPolygonMode (PolygonMode level)
| Sets how to rasterise triangles, as points, wireframe or solid polys.
void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
| Sets a single filter for a given texture unit.
void | _setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)
| Sets the maximal anisotropy for the specified texture unit.
void | setVertexDeclaration (VertexDeclaration *decl)
| Sets the current vertex declaration, ie the source of vertex data.
void | setVertexDeclaration (VertexDeclaration *decl, bool useGlobalInstancingVertexBufferIsAvailable)
void | setVertexBufferBinding (VertexBufferBinding *binding)
| Sets the current vertex buffer binding state.
void | setVertexBufferBinding (VertexBufferBinding *binding, size_t numberOfInstances, bool useGlobalInstancingVertexBufferIsAvailable, bool indexesUsed)
void | _render (const RenderOperation &op)
| Render something to the active viewport.
void | bindGpuProgram (GpuProgram *prg)
| See RenderSystem.
void | unbindGpuProgram (GpuProgramType gptype)
| See RenderSystem.
void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 variabilityMask)
| See RenderSystem.
void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)
| Only binds Gpu program parameters used for passes that have more than one iteration rendering.
void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)
| Sets the 'scissor region' ie the region of the target in which rendering can take place.
void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)
| Clears one or more frame buffers on the active render target.
void | setClipPlane (ushort index, Real A, Real B, Real C, Real D)
void | enableClipPlane (ushort index, bool enable)
HardwareOcclusionQuery * | createHardwareOcclusionQuery ()
| Create an object for performing hardware occlusion queries.
Real | getHorizontalTexelOffset ()
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getVerticalTexelOffset ()
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getMinimumDepthInputValue ()
| Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Real | getMaximumDepthInputValue ()
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
void | registerThread ()
| Register the an additional thread which may make calls to rendersystem-related objects.
void | unregisterThread ()
| Unregister an additional thread which may make calls to rendersystem-related objects.
void | preExtraThreadsStarted ()
| Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.
void | postExtraThreadsStarted ()
D3DFORMAT | _getDepthStencilFormatFor (D3DFORMAT fmt)
| Check which depthStencil formats can be used with a certain pixel format, and return the best suited.
bool | _checkTextureFilteringSupported (TextureType ttype, PixelFormat format, int usage)
| Check whether or not filtering is supported for the precise texture format requested with the given usage options.
void | determineFSAASettings (IDirect3DDevice9 *d3d9Device, size_t fsaa, const String &fsaaHint, D3DFORMAT d3dPixelFormat, bool fullScreen, D3DMULTISAMPLE_TYPE *outMultisampleType, DWORD *outMultisampleQuality)
| Take in some requested FSAA settings and output supported D3D settings.
unsigned int | getDisplayMonitorCount () const
virtual void | beginProfileEvent (const String &eventName)
virtual void | endProfileEvent (void)
virtual void | markProfileEvent (const String &eventName)
void | fireDeviceEvent (D3D9Device *device, const String &name)
| fires a device releated event
MultiheadUseType | getMultiheadUse () const
| Returns how multihead should be activated.
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
| Destroy a hardware occlusion query object.
RenderSystemCapabilities * | getMutableCapabilities ()
| Get a pointer to the current capabilities being used by the RenderSystem.
virtual void | useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
| Force the render system to use the special capabilities.
void | setWBufferEnabled (bool enabled)
| Sets whether or not W-buffers are enabled if they are available for this renderer.
bool | getWBufferEnabled (void) const
| Returns true if the renderer will try to use W-buffers when avalible.
virtual void | destroyRenderWindow (const String &name)
| Destroys a render window.
virtual void | destroyRenderTexture (const String &name)
| Destroys a render texture.
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 RenderTargetIterator | getRenderTargetIterator (void)
| Returns a specialised MapIterator over all render targets attached to the RenderSystem.
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.
HardwareVertexBufferSharedPtr | getGlobalInstanceVertexBuffer () const
| Returns the global instance vertex buffer.
void | setGlobalInstanceVertexBuffer (const HardwareVertexBufferSharedPtr val)
| Sets the global instance vertex buffer.
VertexDeclaration * | getGlobalInstanceVertexBufferVertexDeclaration () const
| Gets vertex declaration for the global vertex buffer for the global instancing.
void | setGlobalInstanceVertexBufferVertexDeclaration (VertexDeclaration *val)
| Sets vertex declaration for the global vertex buffer for the global instancing.
size_t | getGlobalNumberOfInstances () const
| Gets the global number of instances.
void | setGlobalNumberOfInstances (const size_t val)
| Sets the global number of instances.
virtual void | setDepthBufferFor (RenderTarget *renderTarget)
| Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.
virtual bool | areFixedFunctionLightsInViewSpace () const
| Are fixed-function lights provided in view space? Affects optimisation.
virtual void | _setWorldMatrices (const Matrix4 *m, unsigned short count)
| Sets multiple world matrices (vertex blending).
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
| Utility function for setting all the properties of a texture unit at once.
virtual void | _disableTextureUnitsFrom (size_t texUnit)
| Disables all texture units from the given unit upwards.
virtual void | _setTexture (size_t unit, bool enabled, const String &texname)
| Sets the texture to bind to a given texture unit.
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
| Sets the filtering options for a given texture unit.
virtual void | _setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos)
| Notify the rendersystem that it should adjust texture projection to be relative to a different origin.
void | _cleanupDepthBuffers (bool bCleanManualBuffers=true)
| Removes all depth buffers.
virtual Viewport * | _getViewport (void)
| Get the current active viewport for rendering.
virtual CullingMode | _getCullingMode (void) const
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.
const RenderSystemCapabilities * | getCapabilities (void) const
| Gets the capabilities of the render system.
virtual const DriverVersion & | getDriverVersion (void) const
| Returns the driver version.
virtual const String & | _getDefaultViewportMaterialScheme (void) const
| Returns the default material scheme used by the render system.
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)
| Sets the user clipping region.
virtual void | addClipPlane (const Plane &p)
| Add a user clipping plane.
virtual void | addClipPlane (Real A, Real B, Real C, Real D)
| Add a user clipping plane.
virtual void | resetClipPlanes ()
| Clears the user 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, in case they were referring to it as their viewer.
virtual void | _updateAllRenderTargets (bool swapBuffers=true)
| Internal method for updating all render targets attached to this rendering system.
virtual void | _swapAllRenderTargetBuffers (bool waitForVsync=true)
| Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter.
virtual void | setInvertVertexWinding (bool invert)
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
virtual bool | getInvertVertexWinding (void) const
| Indicates whether or not the vertex windings set will be inverted for the current render (e.g.
virtual void | setCurrentPassIterationCount (const size_t count)
| set the current multi pass count value.
virtual void | setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f)
| Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount.
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.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)

## Static Public Member Functions

static D3D9ResourceManager * | getResourceManager ()
static D3D9DeviceManager * | getDeviceManager ()
static IDirect3D9 * | getDirect3D9 ()
static UINT | getResourceCreationDeviceCount ()
static IDirect3DDevice9 * | getResourceCreationDevice (UINT index)
static IDirect3DDevice9 * | getActiveD3D9Device ()

## Protected Types

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

## Protected Member Functions

void | setClipPlanesImpl (const PlaneList &clipPlanes)
| Internal method used to set the underlying clip planes when needed.
DWORD | getSamplerId (size_t unit)
| returns the sampler id for a given unit texture number
void | notifyOnDeviceLost (D3D9Device *device)
| Notify when a device has been lost.
void | notifyOnDeviceReset (D3D9Device *device)
| Notify when a device has been reset.
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

DepthBufferMap | mDepthBufferPool
| DepthBuffers to be attached to render targets.
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 | mActiveGeometryGpuProgramParameters
GpuProgramParametersSharedPtr | mActiveFragmentGpuProgramParameters
TextureManager * | mTextureManager
Viewport * | mActiveViewport
CullingMode | mCullingMode
bool | mVSync
unsigned int | mVSyncInterval
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
size_t | mCurrentPassIterationNum
bool | mDerivedDepthBias
| Whether to update the depth bias per render call.
float | mDerivedDepthBiasBase
float | mDerivedDepthBiasMultiplier
float | mDerivedDepthBiasSlopeScale
HardwareVertexBufferSharedPtr | mGlobalInstanceVertexBuffer
| a global vertex buffer for global instancing
VertexDeclaration * | mGlobalInstanceVertexBufferVertexDeclaration
| a vertex declaration for the global vertex buffer for the global instancing
size_t | mGlobalNumberOfInstances
| the number of global instances (this number will be multiply by the render op instance number)
StringVector | mEventNames
| List of names of events this rendersystem may raise.
ListenerList | mEventListeners
HardwareOcclusionQueryList | mHwOcclusionQueries
bool | mVertexProgramBound
bool | mGeometryProgramBound
bool | mFragmentProgramBound
PlaneList | mClipPlanes
bool | mClipPlanesDirty
RenderSystemCapabilities * | mRealCapabilities
| Used to store the capabilities of the graphics card.
RenderSystemCapabilities * | mCurrentCapabilities
bool | mUseCustomCapabilities
DriverVersion | mDriverVersion
bool | mTexProjRelative
Vector3 | mTexProjRelativeOrigin

## Private Types

typedef vector < D3D9RenderWindow * >::type | D3D9RenderWindowList
typedef HashMap< unsigned int, D3DFORMAT > | DepthStencilHash
| Mapping of texture format -> DepthStencil.

## Private Member Functions

D3D9DriverList * | getDirect3DDrivers ()
void | refreshD3DSettings ()
void | refreshFSAAOptions ()
void | setD3D9Light (size_t index, Light *light)
HRESULT | __SetRenderState (D3DRENDERSTATETYPE state, DWORD value)
HRESULT | __SetSamplerState (DWORD sampler, D3DSAMPLERSTATETYPE type, DWORD value)
HRESULT | __SetTextureStageState (DWORD stage, D3DTEXTURESTAGESTATETYPE type, DWORD value)
HRESULT | __SetFloatRenderState (D3DRENDERSTATETYPE state, Real value)
DWORD | _getCurrentAnisotropy (size_t unit)
| return anisotropy level
bool | _checkMultiSampleQuality (D3DMULTISAMPLE_TYPE type, DWORD *outQuality, D3DFORMAT format, UINT adapterNum, D3DDEVTYPE deviceType, BOOL fullScreen)
| check if a FSAA is supported
virtual RenderSystemCapabilities * | createRenderSystemCapabilities () const
| Internal method for populating the capabilities structure.
RenderSystemCapabilities * | updateRenderSystemCapabilities (D3D9RenderWindow *renderWindow)
virtual void | initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary)
| See RenderSystem definition.
void | convertVertexShaderCaps (RenderSystemCapabilities *rsc) const
void | convertPixelShaderCaps (RenderSystemCapabilities *rsc) const
bool | checkVertexTextureFormats (D3D9RenderWindow *renderWindow) const
void | detachRenderTargetImpl (const String &name)

## Private Attributes

IDirect3D9 * | mD3D
| Direct3D.
ConfigOptionMap | mOptions
size_t | mFSAASamples
String | mFSAAHint
HINSTANCE | mhInstance
| instance
D3D9DriverList * | mDriverList
| List of D3D drivers installed (video cards)
D3D9Driver * | mActiveD3DDriver
| Currently active driver.
bool | mUseNVPerfHUD
| NVPerfHUD allowed?
bool | mPerStageConstantSupport
| Per-stage constant support? (not in main caps since D3D specific & minor)
struct Ogre::D3D9RenderSystem::sD3DTextureStageDesc | mTexStageDesc [OGRE_MAX_TEXTURE_LAYERS]
Light * | mLights [MAX_LIGHTS]
D3D9HardwareBufferManager * | mHardwareBufferManager
D3D9GpuProgramManager * | mGpuProgramManager
D3D9HLSLProgramFactory * | mHLSLProgramFactory
D3D9ResourceManager * | mResourceManager
D3D9DeviceManager * | mDeviceManager
size_t | mLastVertexSourceCount
HashMap< IDirect3DDevice9 *, unsigned short > | mCurrentLights
Matrix4 | mViewMatrix
| Saved last view matrix.
D3DXMATRIX | mDxViewMat
D3DXMATRIX | mDxProjMat
D3DXMATRIX | mDxWorldMat
D3D9RenderWindowList | mRenderWindows
DepthStencilHash | mDepthStencilHash
MultiheadUseType | mMultiheadUse

## Static Private Attributes

static D3D9RenderSystem * | msD3D9RenderSystem
| Fast singleton access.

## Friends

class | D3D9Device
class | D3D9DeviceManager

## Detailed Description

Implementation of DirectX9 as a rendering system.

Definition at line 51 of file OgreD3D9RenderSystem.h.

## Member Typedef Documentation

typedef vector<D3D9RenderWindow*>::type Ogre::D3D9RenderSystem::D3D9RenderWindowList`[private]`

Definition at line 157 of file OgreD3D9RenderSystem.h.

typedef HashMap<unsigned int, D3DFORMAT> Ogre::D3D9RenderSystem::DepthStencilHash`[private]`

Mapping of texture format -> DepthStencil.

Used as cache by _getDepthStencilFormatFor

Definition at line 163 of file OgreD3D9RenderSystem.h.

typedef list<HardwareOcclusionQuery*>::type Ogre::RenderSystem::HardwareOcclusionQueryList`[protected, inherited]`

Definition at line 1553 of file OgreRenderSystem.h.

typedef list<Listener*>::type Ogre::RenderSystem::ListenerList`[protected, inherited]`

Definition at line 1550 of file OgreRenderSystem.h.

typedef MapIterator<Ogre::RenderTargetMap> Ogre::RenderSystem::RenderTargetIterator`[inherited]`

Iterator over RenderTargets.

Definition at line 558 of file OgreRenderSystem.h.

## Member Enumeration Documentation

enum Ogre::D3D9RenderSystem::MultiheadUseType

Enumerator:

  mutAuto |
  mutYes |
  mutNo |

Definition at line 54 of file OgreD3D9RenderSystem.h.

## Constructor & Destructor Documentation

Ogre::D3D9RenderSystem::D3D9RenderSystem | ( | HINSTANCE | hInstance | ) |

Ogre::D3D9RenderSystem::~D3D9RenderSystem | ( |  | ) |

## Member Function Documentation

HRESULT Ogre::D3D9RenderSystem::__SetFloatRenderState | ( | D3DRENDERSTATETYPE | state,
|  | Real | value
| ) |  | `[private]`

Definition at line 114 of file OgreD3D9RenderSystem.h.

HRESULT Ogre::D3D9RenderSystem::__SetRenderState | ( | D3DRENDERSTATETYPE | state,
|  | DWORD | value
| ) |  | `[private]`

HRESULT Ogre::D3D9RenderSystem::__SetSamplerState | ( | DWORD | sampler,
|  | D3DSAMPLERSTATETYPE | type,
|  | DWORD | value
| ) |  | `[private]`

HRESULT Ogre::D3D9RenderSystem::__SetTextureStageState | ( | DWORD | stage,
|  | D3DTEXTURESTAGESTATETYPE | type,
|  | DWORD | value
| ) |  | `[private]`

DepthBuffer* Ogre::D3D9RenderSystem::_addManualDepthBuffer | ( | IDirect3DDevice9 * | depthSurfaceDevice,
|  | IDirect3DSurface9 * | surf
| ) |  |

This function is meant to add Depth Buffers to the pool that aren't released when the DepthBuffer is deleted.

This is specially useful to put the Depth Buffer created along with the window's back buffer into the pool. All depth buffers introduced with this method go to POOL_DEFAULT

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

Update a perspective projection matrix to use 'oblique depth projection'.

Remarks:
  This method can be used to change the nature of a perspective transform in order to make the near plane not perpendicular to the camera view direction, but to be at some different orientation. This can be useful for performing arbitrary clipping (e.g. to a reflection plane) which could otherwise only be done using user clip planes, which are more expensive, and not necessarily supported on all cards.

Parameters:

  matrix | The existing projection matrix. Note that this must be a perspective transform (not orthographic), and must not have already been altered by this method. The matrix will be altered in-place.
  plane | The plane which is to be used as the clipping plane. This plane must be in CAMERA (view) space.
  forGpuProgram | Is this for use with a Gpu program or fixed-function

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_beginFrame | ( |  | ) | `[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.

Implements Ogre::RenderSystem.

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

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

bool Ogre::D3D9RenderSystem::_checkMultiSampleQuality | ( | D3DMULTISAMPLE_TYPE | type,
|  | DWORD * | outQuality,
|  | D3DFORMAT | format,
|  | UINT | adapterNum,
|  | D3DDEVTYPE | deviceType,
|  | BOOL | fullScreen
| ) |  | `[private]`

check if a FSAA is supported

bool Ogre::D3D9RenderSystem::_checkTextureFilteringSupported | ( | TextureType | ttype,
|  | PixelFormat | format,
|  | int | usage
| ) |  |

Check whether or not filtering is supported for the precise texture format requested with the given usage options.

void Ogre::D3D9RenderSystem::_cleanupDepthBuffers | ( | IDirect3DDevice9 * | creator | ) |

void Ogre::D3D9RenderSystem::_cleanupDepthBuffers | ( | IDirect3DSurface9 * | manualSurface | ) |

This function does NOT override RenderSystem::_cleanupDepthBuffers(bool) functionality.

Manually created surfaces may be released arbitrarely without being pulled out from the pool (specially RenderWindows) this function takes care of that.

Parameters:

  | Depthbuffer surrface to compare against. Shouldn't be null

void Ogre::RenderSystem::_cleanupDepthBuffers | ( | bool | bCleanManualBuffers = `true` | ) | `[inherited]`

Removes all depth buffers.

Should be called on device lost and shutdown

Remarks:
  Advanced users can call this directly with bCleanManualBuffers=false to remove all depth buffers created for RTTs; when they think the pool has grown too big or they've used lots of depth buffers they don't need anymore, freeing GPU RAM.

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

Converts a uniform projection matrix to suitable for this render system.

Remarks:
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

DepthBuffer* Ogre::D3D9RenderSystem::_createDepthBufferFor | ( | RenderTarget * | renderTarget | ) | `[virtual]`

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

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

Implements Ogre::RenderSystem.

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

Creates a new rendering window.

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

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

Parameters:

  name | The name of the window. Used in other methods later like setRenderTarget and 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:

  Key | Type/Values | Default | Description | Notes
  title | Any string | RenderTarget name | The title of the window that will appear in the title bar |
  colourDepth | 16, 32 | Desktop depth | Colour depth of the resulting rendering window; only applies if fullScreen | Win32 Specific
  left | Positive integers | Centred | Screen x coordinate from left |
  top | Positive integers | Centred | Screen y coordinate from left |
  depthBuffer | true, false | true | Use depth buffer | DirectX9 specific
  externalWindowHandle | Win32: HWND as integer GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) OS X: WindowRef for Carbon or NSWindow for Cocoa address as an integer iOS: UIWindow address as an integer | 0 (none) | External window handle, for embedding the OGRE render in an existing window |

  externalGLControl

  true, false

  false

  Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls.

  OpenGL specific

  externalGLContext | Context as Unsigned Long | 0 (create own context) | Use an externally created GL context | OpenGL Specific
  parentWindowHandle | Win32: HWND as integer GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) | 0 (none) | Parent window handle, for embedding the OGRE in a child of an external window |
  macAPI | String: "cocoa" or "carbon" | "carbon" | Specifies the type of rendering window on the Mac Platform. | Mac OS X Specific |

  macAPICocoaUseNSView

  bool "true" or "false"

  "false"

  On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm.

  Mac OS X Specific

  contentScalingFactor

  Positive Float greater than 1.0

  The default content scaling factor of the screen

  Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor.

  iOS Specific

  externalViewHandle | UIView pointer as an integer | 0 | External view handle, for rendering OGRE render in an existing view | iOS Specific |
  externalViewControllerHandle | UIViewController pointer as an integer | 0 | External view controller handle, for embedding OGRE in an existing view controller | iOS Specific |
  FSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Full screen antialiasing factor |
  FSAAHint | Depends on RenderSystem and hardware. Currently supports: "Quality": on systems that have an option to prefer higher AA quality over speed, use it | Blank | Full screen antialiasing hint |
  displayFrequency | Refresh rate in Hertz (e.g. 60, 75, 100) | Desktop vsync rate | Display frequency rate, for fullscreen mode |
  vsync | true, false | false | Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate |
  vsyncInterval | 1, 2, 3, 4 | 1 | If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30. |
  border | none, fixed, resize | resize | The type of window border (in windowed mode) |
  outerDimensions | true, false | false | Whether the width/height is expressed as the size of the outer window, rather than the content area |
  useNVPerfHUD | true, false | false | Enable the use of nVidia NVPerfHUD |
  gamma | true, false | false | Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. |
  enableDoubleClick | true, false | false | Enable the window to keep track and transmit double click messages. | Win32 Specific

Implements Ogre::RenderSystem.

bool Ogre::D3D9RenderSystem::_createRenderWindows | ( | const RenderWindowDescriptionList & | renderWindowDescriptions,
|  | RenderWindowList & | createdWindows
| ) |  | `[virtual]`

Creates multiple rendering windows.

Parameters:

  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.

Returns:
  true on success.

Reimplemented from Ogre::RenderSystem.

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

Turns off a texture unit.

Reimplemented from Ogre::RenderSystem.

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

Disables all texture units from the given unit upwards.

void Ogre::D3D9RenderSystem::_endFrame | ( |  | ) | `[virtual]`

Ends rendering of a frame to the current viewport.

Implements Ogre::RenderSystem.

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

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

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

DWORD Ogre::D3D9RenderSystem::_getCurrentAnisotropy | ( | size_t | unit | ) | `[private]`

return anisotropy level

virtual const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme | ( | void |  | ) | const`[virtual, inherited]`

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, DX11) need to override this function to return the default material scheme of the RTSS ShaderGenerator.

This is currently only used to set the default material scheme for viewports. It is a necessary step on these render systems for render textures to be rendered into properly.

D3DFORMAT Ogre::D3D9RenderSystem::_getDepthStencilFormatFor | ( | D3DFORMAT | fmt | ) |

Check which depthStencil formats can be used with a certain pixel format, and return the best suited.

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

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

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

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

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

Get the current active viewport for rendering.

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

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

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

Parameters:

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

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

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

Reimplemented from Ogre::RenderSystem.

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

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

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

Builds an orthographic projection matrix suitable for this render system.

Remarks:
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

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

Builds a perspective projection matrix suitable for this render system.

Remarks:
  Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

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

Builds a perspective projection matrix for the case when frustum is not centered around camera.

Remarks:
  Viewport coordinates are in camera coordinate frame, i.e. camera is at the origin.

Implements Ogre::RenderSystem.

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

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

virtual RenderSystemContext* Ogre::D3D9RenderSystem::_pauseFrame | ( | void |  | ) | `[virtual]`

Pause rendering for a frame.

This has to be called after _beginFrame and before _endFrame. Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.

Reimplemented from Ogre::RenderSystem.

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

Render something to the active viewport.

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

Parameters:

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

Reimplemented from Ogre::RenderSystem.

virtual void Ogre::D3D9RenderSystem::_resumeFrame | ( | RenderSystemContext * | context | ) | `[virtual]`

Resume rendering for a frame.

This has to be called after a _pauseFrame call Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.

Parameters:

  context | the render system context, as returned by _pauseFrame

Reimplemented from Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setAlphaRejectSettings | ( | CompareFunction | func,
|  | unsigned char | value,
|  | bool | alphaToCoverage
| ) |  | `[virtual]`

Sets the global alpha rejection approach for future renders.

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

Parameters:

  func | The comparison function which must pass for a pixel to be written.
  val | The value to compare each pixels alpha value to (0-255)
  alphaToCoverage | Whether to enable alpha to coverage, if supported

Implements Ogre::RenderSystem.

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

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

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

Parameters:

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setCullingMode | ( | CullingMode | mode | ) | `[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.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setDepthBias | ( | float | constantBias,
|  | float | slopeScaleBias
| ) |  | `[virtual]`

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

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

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

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

Parameters:

  constantBias | The constant bias value, expressed as a value in 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.

Implements Ogre::RenderSystem.

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

Sets the comparison function for the depth buffer check.

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

Parameters:

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

Implements Ogre::RenderSystem.

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

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

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

Parameters:

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setFog | ( | FogMode | mode = `FOG_NONE`,
|  | const ColourValue & | colour = `ColourValue::White`,
|  | Real | expDensity = `1.0`,
|  | Real | linearStart = `0.0`,
|  | Real | linearEnd = `1.0`
| ) |  | `[virtual]`

Sets the fogging mode for future geometry.

Parameters:

  mode | Set up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off.
  colour | The colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox.
  expDensity | The density of the fog in FOG_EXP or FOG_EXP2 mode, as a value between 0 and 1. The default is 1. i.e. completely opaque, lower values can mean that fog never completely obscures the scene.
  linearStart | Distance at which linear fog starts to encroach. The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR.
  linearEnd | Distance at which linear fog becomes completely opaque.The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR.

Implements Ogre::RenderSystem.

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

Sets the size of points and how they are attenuated with distance.

Remarks:
  When performing point rendering or point sprite rendering, point size can be attenuated with distance. The equation for doing this is attenuation = 1 / (constant + linear * dist + quadratic * d^2) .

  For example, to disable distance attenuation (constant screensize) you would set constant to 1, and linear and quadratic to 0. A standard perspective attenuation would be 0, 1, 0 respectively.

Implements Ogre::RenderSystem.

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

Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.

Parameters:

  enabled | True enables point sprites, false returns to normal point rendering.

Implements Ogre::RenderSystem.

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

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

Implements Ogre::RenderSystem.

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

Sets the projection transform matrix.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setRenderTarget | ( | RenderTarget * | target | ) | `[virtual]`

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setSceneBlending | ( | SceneBlendFactor | sourceFactor,
|  | SceneBlendFactor | destFactor,
|  | SceneBlendOperation | op
| ) |  | `[virtual]`

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

The result of the blending operation is:

final = (texture * sourceFactor) + (pixel * destFactor) Each of the factors is specified as one of a number of options, as specified in the SceneBlendFactor enumerated type. By changing the operation you can change addition between the source and destination pixels to a different operator.

Parameters:

  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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setSeparateSceneBlending | ( | SceneBlendFactor | sourceFactor,
|  | SceneBlendFactor | destFactor,
|  | SceneBlendFactor | sourceFactorAlpha,
|  | SceneBlendFactor | destFactorAlpha,
|  | SceneBlendOperation | op,
|  | SceneBlendOperation | alphaOp
| ) |  | `[virtual]`

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

The result of the blending operation is:

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

Parameters:

  sourceFactor | The source factor in the above calculation, i.e. multiplied by the texture colour components.
  destFactor | The destination factor in the above calculation, i.e. multiplied by the pixel colour components.
  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

Implements Ogre::RenderSystem.

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

Sets the surface properties to be used for future rendering.

This method sets the the properties of the surfaces of objects to be rendered after it. In this context these surface properties are the amount of each type of light the object reflects (determining it's colour under different types of light), whether it emits light itself, and how shiny it is. Textures are not dealt with here, see the _setTetxure method for details. This method is used by _setMaterial so does not need to be called direct if that method is being used.

Parameters:

  ambient | The amount of ambient (sourceless and directionless) light an object reflects. Affected by the colour/amount of ambient light in the scene.
  diffuse | The amount of light from directed sources that is reflected (affected by colour/amount of point, directed and spot light sources)
  specular | The amount of specular light reflected. This is also affected by directed light sources but represents the colour at the highlights of the object.
  emissive | The colour of light emitted from the object. Note that this will make an object seem brighter and not dependent on lights in the scene, but it will not act as a light, so will not illuminate other objects. Use a light attached to the same SceneNode as the object for this purpose.
  shininess | A value which only has an effect on specular highlights (so specular must be non-black). The higher this value, the smaller and crisper the specular highlights will be, imitating a more highly polished surface. This value is not constrained to 0.0-1.0, in fact it is likely to be more (10.0 gives a modest sheen to an object).

  tracking

  A bit field that describes which of the ambient, diffuse, specular and emissive colours follow the vertex colour of the primitive. When a bit in this field is set its ColourValue is ignored. This is a combination of TVC_AMBIENT, TVC_DIFFUSE, TVC_SPECULAR(note that the shininess value is still taken from shininess) and TVC_EMISSIVE. TVC_NONE means that there will be no material property tracking the vertex colours.

Implements Ogre::RenderSystem.

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

Sets the texture to bind to a given texture unit.

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

Parameters:

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

Implements Ogre::RenderSystem.

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

Sets the texture to bind to a given texture unit.

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

Parameters:

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

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

Sets the texture addressing mode for a texture unit.

Implements Ogre::RenderSystem.

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

Sets the texture blend modes from a TextureUnitState record.

Meant for use internally only - apps should use the Material and TextureUnitState classes.

Parameters:

  unit | Texture unit as above
  bm | Details of the blending mode

Implements Ogre::RenderSystem.

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

Sets the texture border colour for a texture unit.

Implements Ogre::RenderSystem.

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

Sets a method for automatically calculating texture coordinates for a stage.

Should not be used by apps - for use by Ogre only.

Parameters:

  unit | Texture unit as above
  m | Calculation method to use
  frustum | Optional Frustum param, only used for projective effects

Implements Ogre::RenderSystem.

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

Sets the texture coordinate set to use for a texture unit.

Meant for use internally - not generally used directly by apps - the Material and TextureUnitState classes let you manage textures far more easily.

Parameters:

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

Implements Ogre::RenderSystem.

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

Sets the maximal anisotropy for the specified texture unit.

Implements Ogre::RenderSystem.

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

Sets the texture coordinate transformation matrix for a texture unit.

Parameters:

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

Implements Ogre::RenderSystem.

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

Sets the mipmap bias value for a given texture unit.

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

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

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_setTextureProjectionRelativeTo | ( | bool | enabled,
|  | const Vector3 & | pos
| ) |  | `[virtual, inherited]`

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

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

Sets a single filter for a given texture unit.

Parameters:

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

Implements Ogre::RenderSystem.

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

Sets the filtering options for a given texture unit.

Parameters:

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

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

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.

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

Binds a texture to a vertex sampler.

Remarks:
  Not all rendersystems support separate vertex samplers. For those that do, you can set a texture for them, separate to the regular texture samplers, using this method. For those that don't, you should use the regular texture samplers which are shared between the vertex and fragment units; calling this method will throw an exception.

See also:
  RenderSystemCapabilites::getVertexTextureUnitsShared

Reimplemented from Ogre::RenderSystem.

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

Sets the view transform matrix.

Implements Ogre::RenderSystem.

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

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

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

Parameters:

  target | Pointer to the appropriate viewport.

Implements Ogre::RenderSystem.

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

Sets multiple world matrices (vertex blending).

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

Sets the world transform matrix.

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::_swapAllRenderTargetBuffers | ( | bool | waitForVsync = `true` | ) | `[virtual, inherited]`

Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter.

virtual void Ogre::RenderSystem::_updateAllRenderTargets | ( | bool | swapBuffers = `true` | ) | `[virtual, inherited]`

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

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

Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits)

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::addClipPlane | ( | const Plane & | p | ) | `[virtual, inherited]`

Add a user clipping plane.

virtual void Ogre::RenderSystem::addClipPlane | ( | Real | A,
|  | Real | B,
|  | Real | C,
|  | Real | D
| ) |  | `[virtual, inherited]`

Add a user clipping plane.

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

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

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

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

See also:
  RenderSystem::getRenderSystemEvents

virtual bool Ogre::RenderSystem::areFixedFunctionLightsInViewSpace | ( |  | ) | const`[virtual, inherited]`

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

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

Definition at line 636 of file OgreRenderSystem.h.

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

Attaches the passed render target to the render system.

virtual void Ogre::D3D9RenderSystem::beginProfileEvent | ( | const String & | eventName | ) | `[virtual]`

This marks the beginning of an event for GPU profiling.

Implements Ogre::RenderSystem.

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

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::bindGpuProgramParameters | ( | GpuProgramType | gptype,
|  | GpuProgramParametersSharedPtr | params,
|  | uint16 | variabilityMask
| ) |  | `[virtual]`

See RenderSystem.

Implements Ogre::RenderSystem.

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

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

Implements Ogre::RenderSystem.

bool Ogre::D3D9RenderSystem::checkVertexTextureFormats | ( | D3D9RenderWindow * | renderWindow | ) | const`[private]`

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.

Remarks:
  Since different render systems have different colour data formats (eg RGBA for GL, ARGB for D3D) this method allows you to use 1 method for all.

Parameters:

  colour | The colour to convert
  pDest | Pointer to location to put the result.

void Ogre::D3D9RenderSystem::convertPixelShaderCaps | ( | RenderSystemCapabilities * | rsc | ) | const`[private]`

void Ogre::D3D9RenderSystem::convertVertexShaderCaps | ( | RenderSystemCapabilities * | rsc | ) | const`[private]`

HardwareOcclusionQuery* Ogre::D3D9RenderSystem::createHardwareOcclusionQuery | ( |  | ) | `[virtual]`

Create an object for performing hardware occlusion queries.

Implements Ogre::RenderSystem.

virtual MultiRenderTarget* Ogre::D3D9RenderSystem::createMultiRenderTarget | ( | const String & | name | ) | `[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.

Implements Ogre::RenderSystem.

virtual RenderSystemCapabilities* Ogre::D3D9RenderSystem::createRenderSystemCapabilities | ( |  | ) | const`[private, virtual]`

Internal method for populating the capabilities structure.

Implements Ogre::RenderSystem.

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

Destroy a hardware occlusion query object.

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

Destroys a render target of any sort.

Reimplemented from Ogre::RenderSystem.

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

Destroys a render texture.

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

Destroys a render window.

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

Detaches the render target with the passed name from the render system and returns a pointer to it.

Note:
  If the render target cannot be found, NULL is returned.

Reimplemented from Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::detachRenderTargetImpl | ( | const String & | name | ) | `[private]`

void Ogre::D3D9RenderSystem::determineFSAASettings | ( | IDirect3DDevice9 * | d3d9Device,
|  | size_t | fsaa,
|  | const String & | fsaaHint,
|  | D3DFORMAT | d3dPixelFormat,
|  | bool | fullScreen,
|  | D3DMULTISAMPLE_TYPE * | outMultisampleType,
|  | DWORD * | outMultisampleQuality
| ) |  |

Take in some requested FSAA settings and output supported D3D settings.

void Ogre::D3D9RenderSystem::enableClipPlane | ( | ushort | index,
|  | bool | enable
| ) |  |

virtual void Ogre::D3D9RenderSystem::endProfileEvent | ( | void |  | ) | `[virtual]`

Ends the currently active GPU profiling event.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::fireDeviceEvent | ( | D3D9Device * | device,
|  | const String & | name
| ) |  |

fires a device releated event

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

Internal method for firing a rendersystem event.

static IDirect3DDevice9* Ogre::D3D9RenderSystem::getActiveD3D9Device | ( |  | ) | `[static]`

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities | ( | void |  | ) | const`[inherited]`

Gets the capabilities of the render system.

Definition at line 1193 of file OgreRenderSystem.h.

VertexElementType Ogre::D3D9RenderSystem::getColourVertexElementType | ( |  | ) | const`[virtual]`

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

Implements Ogre::RenderSystem.

ConfigOptionMap& Ogre::D3D9RenderSystem::getConfigOptions | ( |  | ) | `[virtual]`

Returns the details of this API's configuration options.

Remarks:
  Each render system must be able to inform the world of what options must/can be specified for it's operation.

  These are passed as strings for portability, but grouped into a structure (_ConfigOption) which includes both options and current value.

  Note that the settings returned from this call are affected by the options that have been set so far, since some options are interdependent.

  This routine is called automatically by the default configuration dialogue produced by Root::showConfigDialog or may be used by the caller for custom settings dialogs

Returns:
  A 'map' of options, i.e. a list of options which is also indexed by option name.

Implements Ogre::RenderSystem.

static D3D9DeviceManager* Ogre::D3D9RenderSystem::getDeviceManager | ( |  | ) | `[static]`

static IDirect3D9* Ogre::D3D9RenderSystem::getDirect3D9 | ( |  | ) | `[static]`

D3D9DriverList* Ogre::D3D9RenderSystem::getDirect3DDrivers | ( |  | ) | `[private]`

unsigned int Ogre::D3D9RenderSystem::getDisplayMonitorCount | ( |  | ) | const`[virtual]`

Gets the number of display monitors.

See also:
  Root::getDisplayMonitorCount

Implements Ogre::RenderSystem.

virtual const DriverVersion& Ogre::RenderSystem::getDriverVersion | ( | void |  | ) | const`[virtual, inherited]`

Returns the driver version.

Definition at line 1198 of file OgreRenderSystem.h.

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

Returns a description of an error code.

Implements Ogre::RenderSystem.

HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer | ( |  | ) | const`[inherited]`

Returns the global instance vertex buffer.

VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration | ( |  | ) | const`[inherited]`

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

size_t Ogre::RenderSystem::getGlobalNumberOfInstances | ( |  | ) | const`[inherited]`

Gets the global number of instances.

Real Ogre::D3D9RenderSystem::getHorizontalTexelOffset | ( |  | ) | `[virtual]`

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

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

Implements Ogre::RenderSystem.

virtual bool Ogre::RenderSystem::getInvertVertexWinding | ( | void |  | ) | const`[virtual, inherited]`

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

reflections)

See also:
  RenderSystem::setInvertVertexWinding

Real Ogre::D3D9RenderSystem::getMaximumDepthInputValue | ( |  | ) | `[virtual]`

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

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

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

Implements Ogre::RenderSystem.

Real Ogre::D3D9RenderSystem::getMinimumDepthInputValue | ( |  | ) | `[virtual]`

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

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

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

Implements Ogre::RenderSystem.

MultiheadUseType Ogre::D3D9RenderSystem::getMultiheadUse | ( |  | ) | const

Returns how multihead should be activated.

Definition at line 374 of file OgreD3D9RenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::getMutableCapabilities | ( |  | ) | `[inherited]`

Get a pointer to the current capabilities being used by the RenderSystem.

Remarks:
  The capabilities may be modified using this pointer, this will only have an effect before the RenderSystem has been initialised. It's intended use is to allow a listener of the RenderSystemCapabilitiesCreated event to customise the capabilities on the fly before the RenderSystem is initialised.

Definition at line 226 of file OgreRenderSystem.h.

const String& Ogre::D3D9RenderSystem::getName | ( |  | ) | const`[virtual]`

Returns the name of the rendering system.

Implements Ogre::RenderSystem.

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

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

See also:
  RenderSystem::addListener

Definition at line 1406 of file OgreRenderSystem.h.

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

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

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

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

Definition at line 561 of file OgreRenderSystem.h.

static IDirect3DDevice9* Ogre::D3D9RenderSystem::getResourceCreationDevice | ( | UINT | index | ) | `[static]`

static UINT Ogre::D3D9RenderSystem::getResourceCreationDeviceCount | ( |  | ) | `[static]`

static D3D9ResourceManager* Ogre::D3D9RenderSystem::getResourceManager | ( |  | ) | `[static]`

DWORD Ogre::D3D9RenderSystem::getSamplerId | ( | size_t | unit | ) | `[protected]`

returns the sampler id for a given unit texture number

Real Ogre::D3D9RenderSystem::getVerticalTexelOffset | ( |  | ) | `[virtual]`

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

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

Implements Ogre::RenderSystem.

bool Ogre::RenderSystem::getWaitForVerticalBlank | ( | void |  | ) | const`[inherited]`

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

bool Ogre::RenderSystem::getWBufferEnabled | ( | void |  | ) | const`[inherited]`

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

virtual void Ogre::D3D9RenderSystem::initConfigOptions | ( |  | ) | `[virtual]`

virtual void Ogre::D3D9RenderSystem::initialiseFromRenderSystemCapabilities | ( | RenderSystemCapabilities * | caps,
|  | RenderTarget * | primary
| ) |  | `[private, virtual]`

See RenderSystem definition.

Implements Ogre::RenderSystem.

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

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

virtual void Ogre::D3D9RenderSystem::markProfileEvent | ( | const String & | eventName | ) | `[virtual]`

Marks an instantaneous event for graphics profilers.

This is equivalent to calling

See also:
  beginProfileEvent and
  endProfileEvent back to back.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::notifyOnDeviceLost | ( | D3D9Device * | device | ) | `[protected]`

Notify when a device has been lost.

void Ogre::D3D9RenderSystem::notifyOnDeviceReset | ( | D3D9Device * | device | ) | `[protected]`

Notify when a device has been reset.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::D3D9RenderSystem::postExtraThreadsStarted | ( |  | ) | `[virtual]`

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::preExtraThreadsStarted | ( |  | ) | `[virtual]`

Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.

Remarks:
  Call this from your main thread before starting your other threads (which themselves should call registerThread()). Note that if you start your own threads, there is a specific startup sequence which must be respected and requires synchronisation between the threads:
  1. [Main thread]Call preExtraThreadsStarted
  2. [Main thread]Start other thread, wait
  3. [Other thread]Call registerThread, notify main thread & continue
  4. [Main thread]Wake up & call postExtraThreadsStarted
  Once this init sequence is completed the threads are independent but this startup sequence must be respected.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::refreshD3DSettings | ( |  | ) | `[private]`

void Ogre::D3D9RenderSystem::refreshFSAAOptions | ( |  | ) | `[private]`

void Ogre::D3D9RenderSystem::registerThread | ( |  | ) | `[virtual]`

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

Remarks:
  This method should only be called by additional threads during their initialisation. If they intend to use hardware rendering system resources they should call this method before doing anything related to the render system. Some rendering APIs require a per-thread setup and this method will sort that out. It is also necessary to call unregisterThread before the thread shuts down.

Note:
  This method takes no parameters - it must be called from the thread being registered and that context is enough.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::reinitialise | ( |  | ) | `[virtual]`

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

Implements Ogre::RenderSystem.

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

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

virtual void Ogre::RenderSystem::resetClipPlanes | ( |  | ) | `[virtual, inherited]`

Clears the user clipping region.

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

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::setClipPlane | ( | ushort | index,
|  | Real | A,
|  | Real | B,
|  | Real | C,
|  | Real | D
| ) |  |

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

Sets the user clipping region.

void Ogre::D3D9RenderSystem::setClipPlanesImpl | ( | const PlaneList & | clipPlanes | ) | `[protected, virtual]`

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

Implements Ogre::RenderSystem.

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

Sets an option for this API.

Remarks:
  Used to confirm the settings (normally chosen by the user) in order to make the renderer able to initialise with the settings as required. This may be video mode, D3D driver, full screen / windowed etc. Called automatically by the default configuration dialog, and by the restoration of saved settings. These settings are stored and only activated when RenderSystem::initialise or RenderSystem::reinitialise are called.

  If using a custom configuration dialog, it is advised that the caller calls RenderSystem::getConfigOptions again, since some options can alter resulting from a selection.

Parameters:

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

Implements Ogre::RenderSystem.

virtual void Ogre::RenderSystem::setCurrentPassIterationCount | ( | const size_t | count | ) | `[virtual, inherited]`

set the current multi pass count value.

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

Parameters:

  count | Number of times to render the current state.

Definition at line 1341 of file OgreRenderSystem.h.

void Ogre::D3D9RenderSystem::setD3D9Light | ( | size_t | index,
|  | Light * | light
| ) |  | `[private]`

virtual void Ogre::RenderSystem::setDepthBufferFor | ( | RenderTarget * | renderTarget | ) | `[virtual, inherited]`

Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.

Remarks:
  RenderTarget's pool ID is respected.

See also:
  RenderTarget::setDepthBufferPool()

virtual void Ogre::RenderSystem::setDeriveDepthBias | ( | bool | derive,
|  | float | baseValue = `0.0f`,
|  | float | multiplier = `0.0f`,
|  | float | slopeScale = `0.0f`
| ) |  | `[virtual, inherited]`

Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount.

The depth bias set will be baseValue + iteration * multiplier

Parameters:

  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

Definition at line 1352 of file OgreRenderSystem.h.

void Ogre::RenderSystem::setGlobalInstanceVertexBuffer | ( | const HardwareVertexBufferSharedPtr | val | ) | `[inherited]`

Sets the global instance vertex buffer.

void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration | ( | VertexDeclaration * | val | ) | `[inherited]`

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

void Ogre::RenderSystem::setGlobalNumberOfInstances | ( | const size_t | val | ) | `[inherited]`

Sets the global number of instances.

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

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

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

Sets whether or not dynamic lighting is enabled.

Parameters:

  enabled | If true, dynamic lighting is performed on geometry with normals supplied, geometry without normals will not be displayed. If false, no lighting is applied and all geometry will be full brightness.

Implements Ogre::RenderSystem.

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

Sets whether or not normals are to be automatically normalised.

Remarks:
  This is useful when, for example, you are scaling SceneNodes such that normals may not be unit-length anymore. Note though that this has an overhead so should not be turn on unless you really need it.

  You should not normally call this direct unless you are rendering world geometry; set it on the Renderable because otherwise it will be overridden by material settings.

Implements Ogre::RenderSystem.

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

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

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::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`
| ) |  | `[virtual]`

Determines if this system supports hardware accelerated stencil buffer.

Remarks:
  Note that the lack of this function doesn't mean you can't do stencilling, but the stencilling operations will be provided in software, which will NOT be fast.

  Generally hardware stencils are only supported in 32-bit colour modes, because the stencil buffer shares the memory of the z-buffer, and in most cards the z-buffer has to be the same depth as the colour buffer. This means that in 32-bit mode, 24 bits of the z-buffer are depth and 8 bits are stencil. In 16-bit mode there is no room for a stencil (although some cards support a 15:1 depth:stencil option, this isn't useful for very much) so 8 bits of stencil are provided in software. This can mean that if you use stencilling, your applications may be faster in 32-but colour than in 16-bit, which may seem odd to some people. This method allows you to set all the stencil buffer parameters in one call.

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

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

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

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

Turns stencil buffer checking on or off.

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

Implements Ogre::RenderSystem.

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

Sets the current vertex buffer binding state.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::setVertexBufferBinding | ( | VertexBufferBinding * | binding,
|  | size_t | numberOfInstances,
|  | bool | useGlobalInstancingVertexBufferIsAvailable,
|  | bool | indexesUsed
| ) |  |

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

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

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::setVertexDeclaration | ( | VertexDeclaration * | decl,
|  | bool | useGlobalInstancingVertexBufferIsAvailable
| ) |  |

void Ogre::RenderSystem::setWaitForVerticalBlank | ( | bool | enabled | ) | `[inherited]`

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

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

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

Parameters:

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

void Ogre::RenderSystem::setWBufferEnabled | ( | bool | enabled | ) | `[inherited]`

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

Parameters:

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

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

Shutdown the renderer and cleanup resources.

Reimplemented from Ogre::RenderSystem.

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

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::unregisterThread | ( |  | ) | `[virtual]`

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

See also:
  RenderSystem::registerThread

Implements Ogre::RenderSystem.

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

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

Returns:
  True if more iterations are required

RenderSystemCapabilities* Ogre::D3D9RenderSystem::updateRenderSystemCapabilities | ( | D3D9RenderWindow * | renderWindow | ) | `[private]`

virtual void Ogre::RenderSystem::useCustomRenderSystemCapabilities | ( | RenderSystemCapabilities * | capabilities | ) | `[virtual, inherited]`

Force the render system to use the special capabilities.

Can only be called before the render system has been fully initializer (before createWindow is called)

Parameters:

  capabilities | has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities.

String Ogre::D3D9RenderSystem::validateConfigOptions | ( |  | ) | `[virtual]`

Validates the options set for the rendering system, returning a message if there are problems.

Note:
  If the returned string is empty, there are no problems.

Implements Ogre::RenderSystem.

## Friends And Related Function Documentation

friend class D3D9Device`[friend]`

Definition at line 386 of file OgreD3D9RenderSystem.h.

friend class D3D9DeviceManager`[friend]`

Definition at line 387 of file OgreD3D9RenderSystem.h.

## Member Data Documentation

D3D9Driver* Ogre::D3D9RenderSystem::mActiveD3DDriver`[private]`

Currently active driver.

Definition at line 75 of file OgreD3D9RenderSystem.h.

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

Definition at line 1488 of file OgreRenderSystem.h.

GpuProgramParametersSharedPtr Ogre::RenderSystem::mActiveGeometryGpuProgramParameters`[protected, inherited]`

Definition at line 1487 of file OgreRenderSystem.h.

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

The Active render target.

Definition at line 1483 of file OgreRenderSystem.h.

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

The Active GPU programs and gpu program parameters.

Definition at line 1486 of file OgreRenderSystem.h.

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

Definition at line 1497 of file OgreRenderSystem.h.

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

Definition at line 1505 of file OgreRenderSystem.h.

PlaneList Ogre::RenderSystem::mClipPlanes`[protected, inherited]`

Definition at line 1561 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mClipPlanesDirty`[protected, inherited]`

Definition at line 1563 of file OgreRenderSystem.h.

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

Definition at line 1499 of file OgreRenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::mCurrentCapabilities`[protected, inherited]`

Definition at line 1567 of file OgreRenderSystem.h.

HashMap<IDirect3DDevice9*, unsigned short> Ogre::D3D9RenderSystem::mCurrentLights`[private]`

Definition at line 151 of file OgreD3D9RenderSystem.h.

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

number of times to render the current state

Definition at line 1518 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mCurrentPassIterationNum`[protected, inherited]`

Definition at line 1519 of file OgreRenderSystem.h.

IDirect3D9* Ogre::D3D9RenderSystem::mD3D`[private]`

Direct3D.

Definition at line 63 of file OgreD3D9RenderSystem.h.

DepthBufferMap Ogre::RenderSystem::mDepthBufferPool`[protected, inherited]`

DepthBuffers to be attached to render targets.

Definition at line 1476 of file OgreRenderSystem.h.

DepthStencilHash Ogre::D3D9RenderSystem::mDepthStencilHash`[private]`

Definition at line 164 of file OgreD3D9RenderSystem.h.

bool Ogre::RenderSystem::mDerivedDepthBias`[protected, inherited]`

Whether to update the depth bias per render call.

Definition at line 1521 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasBase`[protected, inherited]`

Definition at line 1522 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasMultiplier`[protected, inherited]`

Definition at line 1523 of file OgreRenderSystem.h.

float Ogre::RenderSystem::mDerivedDepthBiasSlopeScale`[protected, inherited]`

Definition at line 1524 of file OgreRenderSystem.h.

D3D9DeviceManager* Ogre::D3D9RenderSystem::mDeviceManager`[private]`

Definition at line 133 of file OgreD3D9RenderSystem.h.

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

Texture units from this upwards are disabled.

Definition at line 1515 of file OgreRenderSystem.h.

D3D9DriverList* Ogre::D3D9RenderSystem::mDriverList`[private]`

List of D3D drivers installed (video cards)

Definition at line 73 of file OgreD3D9RenderSystem.h.

DriverVersion Ogre::RenderSystem::mDriverVersion`[protected, inherited]`

Definition at line 1577 of file OgreRenderSystem.h.

D3DXMATRIX Ogre::D3D9RenderSystem::mDxProjMat`[private]`

Definition at line 155 of file OgreD3D9RenderSystem.h.

D3DXMATRIX Ogre::D3D9RenderSystem::mDxViewMat`[private]`

Definition at line 155 of file OgreD3D9RenderSystem.h.

D3DXMATRIX Ogre::D3D9RenderSystem::mDxWorldMat`[private]`

Definition at line 155 of file OgreD3D9RenderSystem.h.

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

Definition at line 1551 of file OgreRenderSystem.h.

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

List of names of events this rendersystem may raise.

Definition at line 1545 of file OgreRenderSystem.h.

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

Definition at line 1506 of file OgreRenderSystem.h.

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

Definition at line 1558 of file OgreRenderSystem.h.

String Ogre::D3D9RenderSystem::mFSAAHint`[private]`

Definition at line 67 of file OgreD3D9RenderSystem.h.

size_t Ogre::D3D9RenderSystem::mFSAASamples`[private]`

Definition at line 66 of file OgreD3D9RenderSystem.h.

bool Ogre::RenderSystem::mGeometryProgramBound`[protected, inherited]`

Definition at line 1557 of file OgreRenderSystem.h.

HardwareVertexBufferSharedPtr Ogre::RenderSystem::mGlobalInstanceVertexBuffer`[protected, inherited]`

a global vertex buffer for global instancing

Definition at line 1527 of file OgreRenderSystem.h.

VertexDeclaration* Ogre::RenderSystem::mGlobalInstanceVertexBufferVertexDeclaration`[protected, inherited]`

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

Definition at line 1529 of file OgreRenderSystem.h.

size_t Ogre::RenderSystem::mGlobalNumberOfInstances`[protected, inherited]`

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

Definition at line 1531 of file OgreRenderSystem.h.

D3D9GpuProgramManager* Ogre::D3D9RenderSystem::mGpuProgramManager`[private]`

Definition at line 130 of file OgreD3D9RenderSystem.h.

D3D9HardwareBufferManager* Ogre::D3D9RenderSystem::mHardwareBufferManager`[private]`

Definition at line 129 of file OgreD3D9RenderSystem.h.

HINSTANCE Ogre::D3D9RenderSystem::mhInstance`[private]`

instance

Definition at line 70 of file OgreD3D9RenderSystem.h.

D3D9HLSLProgramFactory* Ogre::D3D9RenderSystem::mHLSLProgramFactory`[private]`

Definition at line 131 of file OgreD3D9RenderSystem.h.

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

Definition at line 1554 of file OgreRenderSystem.h.

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

Definition at line 1512 of file OgreRenderSystem.h.

size_t Ogre::D3D9RenderSystem::mLastVertexSourceCount`[private]`

Definition at line 135 of file OgreD3D9RenderSystem.h.

Light* Ogre::D3D9RenderSystem::mLights[MAX_LIGHTS]`[private]`

Definition at line 102 of file OgreD3D9RenderSystem.h.

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

Saved manual colour blends.

Definition at line 1510 of file OgreRenderSystem.h.

MultiheadUseType Ogre::D3D9RenderSystem::mMultiheadUse`[private]`

Definition at line 166 of file OgreD3D9RenderSystem.h.

ConfigOptionMap Ogre::D3D9RenderSystem::mOptions`[private]`

Definition at line 65 of file OgreD3D9RenderSystem.h.

bool Ogre::D3D9RenderSystem::mPerStageConstantSupport`[private]`

Per-stage constant support? (not in main caps since D3D specific & minor)

Definition at line 79 of file OgreD3D9RenderSystem.h.

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

The render targets, ordered by priority.

Definition at line 1481 of file OgreRenderSystem.h.

RenderSystemCapabilities* Ogre::RenderSystem::mRealCapabilities`[protected, inherited]`

Used to store the capabilities of the graphics card.

Definition at line 1566 of file OgreRenderSystem.h.

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

The render targets.

Definition at line 1479 of file OgreRenderSystem.h.

D3D9RenderWindowList Ogre::D3D9RenderSystem::mRenderWindows`[private]`

Definition at line 159 of file OgreD3D9RenderSystem.h.

D3D9ResourceManager* Ogre::D3D9RenderSystem::mResourceManager`[private]`

Definition at line 132 of file OgreD3D9RenderSystem.h.

D3D9RenderSystem* Ogre::D3D9RenderSystem::msD3D9RenderSystem`[static, private]`

Fast singleton access.

Definition at line 81 of file OgreD3D9RenderSystem.h.

bool Ogre::RenderSystem::mTexProjRelative`[protected, inherited]`

Definition at line 1579 of file OgreRenderSystem.h.

Vector3 Ogre::RenderSystem::mTexProjRelativeOrigin`[protected, inherited]`

Definition at line 1580 of file OgreRenderSystem.h.

struct Ogre::D3D9RenderSystem::sD3DTextureStageDesc Ogre::D3D9RenderSystem::mTexStageDesc[OGRE_MAX_TEXTURE_LAYERS]`[private]`

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

Definition at line 1494 of file OgreRenderSystem.h.

bool Ogre::RenderSystem::mUseCustomCapabilities`[protected, inherited]`

Definition at line 1568 of file OgreRenderSystem.h.

bool Ogre::D3D9RenderSystem::mUseNVPerfHUD`[private]`

NVPerfHUD allowed?

Definition at line 77 of file OgreD3D9RenderSystem.h.

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

Definition at line 1507 of file OgreRenderSystem.h.

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

Definition at line 1556 of file OgreRenderSystem.h.

Matrix4 Ogre::D3D9RenderSystem::mViewMatrix`[private]`

Saved last view matrix.

Definition at line 153 of file OgreD3D9RenderSystem.h.

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

Definition at line 1501 of file OgreRenderSystem.h.

unsigned int Ogre::RenderSystem::mVSyncInterval`[protected, inherited]`

Definition at line 1502 of file OgreRenderSystem.h.

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

Definition at line 1503 of file OgreRenderSystem.h.

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

- OgreD3D9RenderSystem.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:49