# Ogre::D3D9RenderSystem Class Reference

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

`#include <OgreD3D9RenderSystem.h>`

Inheritance diagram for Ogre::D3D9RenderSystem:

List of all members.

## Public Types

typedef MapIterator< Ogre::RenderTargetMap > | RenderTargetIterator
| Iterator over RenderTargets.

## Public Member Functions

| D3D9RenderSystem (HINSTANCE hInstance)
| ~D3D9RenderSystem ()
virtual void | initConfigOptions (void)
ConfigOptionMap & | getConfigOptions (void)
| Returns the details of this API's configuration options.
String | validateConfigOptions (void)
| 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)

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 getRenderWindow.
  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 platorms unless indicated otherwise:

Key: "title" Description: The title of the window that will appear in the title bar Values: string Default: RenderTarget name

Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific]

Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true

Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None)

Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None)

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate

Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0

Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize

Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false

RenderTexture * | createRenderTexture (const String &name, unsigned int width, unsigned int height, TextureType texType=TEX_TYPE_2D, PixelFormat internalFormat=PF_X8R8G8B8, const NameValuePairList *miscParams=0)

Parameters:

  name | The name for the new render texture. Note that names must be unique.
  width | The requested width for the render texture. See Remarks for more info.
  height | The requested width for the render texture. See Remarks for more info.
  texType | The type of texture; defaults to TEX_TYPE_2D
  internalFormat | The internal format of the texture; defaults to PF_X8R8G8B8
  miscParams | A NameValuePairList describing the other parameters for the new rendering window. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platorms unless indicated otherwise:

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "depth" Description: Depth in case of render-to-texture TEX_3D Values: positive integers

Returns:
  On succes, a pointer to a new platform-dependernt, RenderTexture-derived class is returned. On failiure, NULL is returned.

Remarks:
  Because a render texture is basically a wrapper around a texture object, the width and height parameters of this method just hint the preferred size for the texture. Depending on the hardware driver or the underlying API, these values might change when the texture is created. The same applies to the internalFormat parameter.

String | getErrorDescription (long errorNumber) const
| Returns a description of an error code.
const String & | getName (void) 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.
void | convertColourValue (const ColourValue &colour, uint32 *pDest)
| Generates a packed data version of the passed in ColourValue suitable for use as with 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)
| This method allows you to set all the stencil buffer parameters in one call.
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 | _setTexture (size_t unit, bool enabled, const String &texname)
| Sets the status of a single texture stage.
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 unit, TextureUnitState::TextureAddressingMode tam)
| Sets the texture addressing mode for a 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)
| Sets the global blending factors for combining subsequent renders with the existing frame contents.
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value)
| 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 (void)
| Signifies the beginning of a frame, ie the start of rendering on a single viewport.
void | _endFrame (void)
| 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 (ushort bias)
| 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 | _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 | _setRasterisationMode (SceneDetailLevel 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 | setVertexBufferBinding (VertexBufferBinding *binding)
| Sets the current vertex buffer binding state.
void | _render (const RenderOperation &op)
| Render something to the active viewport.
void | bindGpuProgram (GpuProgram *prg)
| Binds a given GpuProgram (but not the parameters).
void | unbindGpuProgram (GpuProgramType gptype)
| Unbinds GpuPrograms of a given GpuProgramType.
void | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params)
| Bind Gpu program parameters.
void | setClipPlanes (const PlaneList &clipPlanes)
| See RenderSystem.
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)
| Set a clipping plane.
void | enableClipPlane (ushort index, bool enable)
| Enable the clipping plane.
HardwareOcclusionQuery * | createHardwareOcclusionQuery (void)
| Create an object for performing hardware occlusion queries.
Real | getHorizontalTexelOffset (void)
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getVerticalTexelOffset (void)
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Real | getMinimumDepthInputValue (void)
| Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Real | getMaximumDepthInputValue (void)
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
void | restoreLostDevice (void)
| D3D specific method to restore a lost device.
bool | isDeviceLost (void)
| D3D specific method to return whether the device has been lost.
void | _notifyDeviceLost (void)
| Notify that a device has been lost.
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
| Destroy a hardware occlusion query object.
void | setWBufferEnabled (bool enabled)
| Sets whether or not W-buffers are enabled if they are avalible for this renderer.
bool | getWBufferEnabled (void) const
| Returns true if the renderer will try to use W-buffers when avalible.
virtual 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 RenderTarget * | detachRenderTarget (const String &name)
| Detaches the render target with the passed name from the render system and returns a pointer to it.
virtual RenderTargetIterator | getRenderTargetIterator (void)
| Returns a specialised MapIterator over all render targets attached to the RenderSystem.
void | setWaitForVerticalBlank (bool enabled)
| Defines whether or now fullscreen render windows wait for the vertical blank before flipping buffers.
bool | getWaitForVerticalBlank (void) const
| Returns true if the system is synchronising frames with the monitor vertical blank.
virtual void | _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 | _disableTextureUnit (size_t texUnit)
| Turns off a texture unit.
virtual void | _disableTextureUnitsFrom (size_t texUnit)
| Disables all texture units from the given unit upwards.
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
| Sets the filtering options for a given texture unit.
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 | _getVertexCount (void) const
| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
const RenderSystemCapabilities * | getCapabilities (void) const
| Gets the capabilities of the render system.
virtual void | _initRenderTargets (void)
| Utility method for initialising all render targets attached to this rendering system.
virtual void | _notifyCameraRemoved (const Camera *cam)
| Utility method to notify all render targets that a camera has been removed, incase they were referring to it as their viewer.
virtual void | _updateAllRenderTargets (void)
| Internal method for updating all render targets attached to this rendering system.
virtual void | setClipPlane (ushort index, const Plane &p)
| Set a clipping plane.
virtual void | setInvertVertexWinding (bool invert)
| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
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.

## Protected Types

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

## Protected Member Functions

virtual void | fireEvent (const String &name, const NameValuePairList *params=0)
| Internal method for firing a rendersystem event.

## Protected Attributes

RenderTargetMap | mRenderTargets
| The render targets.
RenderTargetPriorityMap | mPrioritisedRenderTargets
| The render targets, ordered by priority.
RenderTarget * | mActiveRenderTarget
| The Active render target.
TextureManager * | mTextureManager
RenderSystemCapabilities * | mCapabilities
| Used to store the capabilities of the graphics card.
Viewport * | mActiveViewport
CullingMode | mCullingMode
bool | mVSync
bool | mWBuffer
size_t | mFaceCount
size_t | mVertexCount
Matrix4 | mWorldMatrices [256]
| Saved set of world matrices.
ColourValue | mManualBlendColours [OGRE_MAX_TEXTURE_LAYERS][2]
| Saved manual colour blends.
bool | mInvertVertexWinding
StringVector | mEventNames
| List of names of events this rendersystem may raise.
ListenerList | mEventListeners
HardwareOcclusionQueryList | mHwOcclusionQueries

## Private Types

typedef std::vector< D3D9RenderWindow * > | SecondaryWindowList

## Private Member Functions

D3D9DriverList * | getDirect3DDrivers (void)
void | refreshD3DSettings (void)
void | freeDevice (void)
bool | compareDecls (D3DVERTEXELEMENT9 *pDecl1, D3DVERTEXELEMENT9 *pDecl2, size_t size)
void | initInputDevices (void)
void | processInputDevices (void)
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
void | _setFSAA (D3DMULTISAMPLE_TYPE type, DWORD qualityLevel)
| set FSAA
void | initCapabilities (void)
| Internal method for populating the capabilities structure.
void | convertVertexShaderCaps (void)
void | convertPixelShaderCaps (void)

## Private Attributes

LPDIRECT3D9 | mpD3D
| Direct3D.
LPDIRECT3DDEVICE9 | mpD3DDevice
| Direct3D rendering device.
ConfigOptionMap | mOptions
D3DMULTISAMPLE_TYPE | mFSAAType
| full-screen multisampling antialiasing type
DWORD | mFSAAQuality
| full-screen multisampling antialiasing level
HINSTANCE | mhInstance
| instance
D3D9DriverList * | mDriverList
| List of D3D drivers installed (video cards).
D3D9Driver * | mActiveD3DDriver
| Currently active driver.
D3DCAPS9 | mCaps
| Device caps.
Ogre::D3D9RenderSystem::sD3DTextureStageDesc | mTexStageDesc [OGRE_MAX_TEXTURE_LAYERS]
| structure holding texture unit settings for every stage
Light * | mLights [MAX_LIGHTS]
D3D9HardwareBufferManager * | mHardwareBufferManager
D3D9GpuProgramManager * | mGpuProgramManager
size_t | mLastVertexSourceCount
unsigned short | mCurrentLights
Matrix4 | mViewMatrix
| Saved last view matrix.
D3D9RenderWindow * | mPrimaryWindow
| Primary window, the one used to create the device.
SecondaryWindowList | mSecondaryWindows
bool | mDeviceLost
bool | mBasicStatesInitialised

## Detailed Description

Implementation of DirectX9 as a rendering system.

Definition at line 50 of file OgreD3D9RenderSystem.h.

## Member Typedef Documentation

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

| Definition at line 1052 of file OgreRenderSystem.h.

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

| Definition at line 1049 of file OgreRenderSystem.h.

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

| Iterator over RenderTargets. Definition at line 403 of file OgreRenderSystem.h. Referenced by Ogre::RenderSystem::getRenderTargetIterator().

typedef std::vector<D3D9RenderWindow*> Ogre::D3D9RenderSystem::SecondaryWindowList `[private]`

| Definition at line 150 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 110 of file OgreD3D9RenderSystem.h. References __SetRenderState(), and Ogre::Real.

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

| Referenced by __SetFloatRenderState().

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

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

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 | ( | void |  | ) | `[virtual]`

| Signifies the beginning of a frame, ie the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist. 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

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

| Turns off a texture unit.

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

| Disables all texture units from the given unit upwards.

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

| Ends rendering of a frame to the current viewport. Implements Ogre::RenderSystem.

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

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

| return anisotropy level

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.

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

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.

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

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

void Ogre::D3D9RenderSystem::_notifyDeviceLost | ( | void |  | ) |

| Notify that a device has been lost.

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.

void Ogre::D3D9RenderSystem::_setAlphaRejectSettings | ( | CompareFunction | func,
|  | unsigned char | value
| ) | `[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)

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 | ( | ushort | bias | ) | `[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.

Parameters:

  bias | The bias value, should be between 0 and 16.

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::_setFSAA | ( | D3DMULTISAMPLE_TYPE | type,
|  | DWORD | qualityLevel
| ) | `[private]`

| set FSAA

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

| Sets the projection transform matrix. Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setRasterisationMode | ( | SceneDetailLevel | level | ) | `[virtual]`

| Sets how to rasterise triangles, as points, wireframe or solid polys. Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setSceneBlending | ( | SceneBlendFactor | sourceFactor,
|  | SceneBlendFactor | destFactor
| ) | `[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.

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 String & | texname
| ) | `[virtual]`

Sets the status of a single texture stage.

Sets the details of a texture stage, to be used for all primitives rendered afterwards. User processes would not normally call this direct unless rendering primitives themselves - the SubEntity class is designed to manage materials for objects. Note that this method is called by _setMaterial.

Parameters:

  unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::numTextureUnits)
  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.

Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::_setTextureAddressingMode | ( | size_t | unit,
|  | TextureUnitState::TextureAddressingMode | tam
| ) | `[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::_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.

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

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::_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::_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::_updateAllRenderTargets | ( | void |  | ) | `[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::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 void Ogre::RenderSystem::attachRenderTarget | ( | RenderTarget & | target | ) | `[virtual, inherited]`

| Attaches the passed render target to the render system.

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

Binds a given GpuProgram (but not the parameters).

Remarks:
  Only one GpuProgram of each type can be bound at once, binding another one will simply replace the exsiting one.

Implements Ogre::RenderSystem.

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

| Bind Gpu program parameters. Implements Ogre::RenderSystem.

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.

bool Ogre::D3D9RenderSystem::compareDecls | ( | D3DVERTEXELEMENT9 * | pDecl1,
|  | D3DVERTEXELEMENT9 * | pDecl2,
|  | size_t | size
| ) | `[private]`

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

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

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

Parameters:

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

Implements Ogre::RenderSystem.

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

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

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

| Create an object for performing hardware occlusion queries. Implements Ogre::RenderSystem.

RenderTexture* Ogre::D3D9RenderSystem::createRenderTexture | ( | const String & | name,
|  | unsigned int | width,
|  | unsigned int | height,
|  | TextureType | texType = TEX_TYPE_2D,
|  | PixelFormat | internalFormat = PF_X8R8G8B8,
|  | const NameValuePairList * | miscParams = 0
| ) | `[virtual]`

Parameters:

  name | The name for the new render texture. Note that names must be unique.
  width | The requested width for the render texture. See Remarks for more info.
  height | The requested width for the render texture. See Remarks for more info.
  texType | The type of texture; defaults to TEX_TYPE_2D
  internalFormat | The internal format of the texture; defaults to PF_X8R8G8B8
  miscParams | A NameValuePairList describing the other parameters for the new rendering window. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platorms unless indicated otherwise:

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "depth" Description: Depth in case of render-to-texture TEX_3D Values: positive integers

Returns:
  On succes, a pointer to a new platform-dependernt, RenderTexture-derived class is returned. On failiure, NULL is returned.

Remarks:
  Because a render texture is basically a wrapper around a texture object, the width and height parameters of this method just hint the preferred size for the texture. Depending on the hardware driver or the underlying API, these values might change when the texture is created. The same applies to the internalFormat parameter.

Implements Ogre::RenderSystem.

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

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 getRenderWindow.
  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 platorms unless indicated otherwise:

Key: "title" Description: The title of the window that will appear in the title bar Values: string Default: RenderTarget name

Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific]

Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen

Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true

Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None)

Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None)

Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0

Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate

Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0

Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize

Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false

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::RenderSystem::detachRenderTarget | ( | const String & | name | ) | `[virtual, inherited]`

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.

void Ogre::D3D9RenderSystem::enableClipPlane | ( | ushort | index,
|  | bool | enable
| ) | `[virtual]`

| Enable the clipping plane. Implements Ogre::RenderSystem.

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

| Internal method for firing a rendersystem event.

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

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

| Gets the capabilities of the render system. Definition at line 859 of file OgreRenderSystem.h.

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

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

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

| Returns a description of an error code. Implements Ogre::RenderSystem.

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

Real Ogre::D3D9RenderSystem::getMaximumDepthInputValue | ( | void |  | ) | `[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::useIdentityView, Renderable::useIdentityProjection

Implements Ogre::RenderSystem.

Real Ogre::D3D9RenderSystem::getMinimumDepthInputValue | ( | void |  | ) | `[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::useIdentityView, Renderable::useIdentityProjection

Implements Ogre::RenderSystem.

const String& Ogre::D3D9RenderSystem::getName | ( | void |  | ) | 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 1004 of file OgreRenderSystem.h.

References Ogre::StringVector.

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 406 of file OgreRenderSystem.h. References Ogre::RenderSystem::RenderTargetIterator.

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

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

| Internal method for populating the capabilities structure.

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

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

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

bool Ogre::D3D9RenderSystem::isDeviceLost | ( | void |  | ) |

| D3D specific method to return whether the device has been lost.

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

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

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.

void Ogre::D3D9RenderSystem::restoreLostDevice | ( | void |  | ) |

| D3D specific method to restore a lost device.

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.

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

| Set a clipping plane.

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

| Set a clipping plane. Implements Ogre::RenderSystem.

void Ogre::D3D9RenderSystem::setClipPlanes | ( | const PlaneList & | clipPlanes | ) | `[virtual]`

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

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

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]`

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) canbe 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::setVertexDeclaration | ( | VertexDeclaration * | decl | ) | `[virtual]`

| Sets the current vertex declaration, ie the source of vertex data. Implements Ogre::RenderSystem.

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 avalible 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 avalible. 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]`

Unbinds GpuPrograms of a given GpuProgramType.

Remarks:
  This returns the pipeline to fixed-function processing for this type.

Implements Ogre::RenderSystem.

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

## Member Data Documentation

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

| Currently active driver. Definition at line 71 of file OgreD3D9RenderSystem.h.

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

| The Active render target. Definition at line 1013 of file OgreRenderSystem.h.

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

| Definition at line 1025 of file OgreRenderSystem.h.

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

| Definition at line 155 of file OgreD3D9RenderSystem.h.

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

| Used to store the capabilities of the graphics card. Definition at line 1022 of file OgreRenderSystem.h.

D3DCAPS9 Ogre::D3D9RenderSystem::mCaps `[private]`

| Device caps. Definition at line 73 of file OgreD3D9RenderSystem.h.

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

| Definition at line 1027 of file OgreRenderSystem.h.

unsigned short Ogre::D3D9RenderSystem::mCurrentLights `[private]`

| Definition at line 140 of file OgreD3D9RenderSystem.h.

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

| Definition at line 154 of file OgreD3D9RenderSystem.h.

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

| List of D3D drivers installed (video cards). Definition at line 69 of file OgreD3D9RenderSystem.h.

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

| Definition at line 1050 of file OgreRenderSystem.h.

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

| List of names of events this rendersystem may raise. Definition at line 1044 of file OgreRenderSystem.h.

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

| Definition at line 1032 of file OgreRenderSystem.h.

DWORD Ogre::D3D9RenderSystem::mFSAAQuality `[private]`

| full-screen multisampling antialiasing level Definition at line 63 of file OgreD3D9RenderSystem.h.

D3DMULTISAMPLE_TYPE Ogre::D3D9RenderSystem::mFSAAType `[private]`

| full-screen multisampling antialiasing type Definition at line 61 of file OgreD3D9RenderSystem.h.

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

| Definition at line 128 of file OgreD3D9RenderSystem.h.

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

| Definition at line 127 of file OgreD3D9RenderSystem.h.

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

| instance Definition at line 66 of file OgreD3D9RenderSystem.h.

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

| Definition at line 1053 of file OgreRenderSystem.h.

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

| Definition at line 1041 of file OgreRenderSystem.h.

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

| Definition at line 131 of file OgreD3D9RenderSystem.h.

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

| Definition at line 92 of file OgreD3D9RenderSystem.h.

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

| Saved manual colour blends. Definition at line 1039 of file OgreRenderSystem.h.

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

| Definition at line 59 of file OgreD3D9RenderSystem.h.

LPDIRECT3D9 Ogre::D3D9RenderSystem::mpD3D `[private]`

| Direct3D. Definition at line 54 of file OgreD3D9RenderSystem.h.

LPDIRECT3DDEVICE9 Ogre::D3D9RenderSystem::mpD3DDevice `[private]`

| Direct3D rendering device. Definition at line 56 of file OgreD3D9RenderSystem.h.

D3D9RenderWindow* Ogre::D3D9RenderSystem::mPrimaryWindow `[private]`

| Primary window, the one used to create the device. Definition at line 148 of file OgreD3D9RenderSystem.h.

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

| The render targets, ordered by priority. Definition at line 1011 of file OgreRenderSystem.h.

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

| The render targets. Definition at line 1009 of file OgreRenderSystem.h.

SecondaryWindowList Ogre::D3D9RenderSystem::mSecondaryWindows `[private]`

| Definition at line 152 of file OgreD3D9RenderSystem.h.

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

| structure holding texture unit settings for every stage

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

| Definition at line 1019 of file OgreRenderSystem.h.

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

| Definition at line 1033 of file OgreRenderSystem.h.

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

| Saved last view matrix. Definition at line 142 of file OgreD3D9RenderSystem.h.

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

| Definition at line 1029 of file OgreRenderSystem.h.

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

| Definition at line 1030 of file OgreRenderSystem.h.

Matrix4 Ogre::RenderSystem::mWorldMatrices[256]`[protected, inherited]`

| Saved set of world matrices. Definition at line 1036 of file OgreRenderSystem.h.

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

- OgreD3D9RenderSystem.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:09:02 2006