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

#include <OgreD3D9RenderSystem.h>

Inheritance diagram for Ogre::D3D9RenderSystem:

Public Types
enum	MultiheadUseType { mutAuto, mutYes, mutNo }

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

Public Member Functions
	D3D9RenderSystem (HINSTANCE hInstance)

	~D3D9RenderSystem ()

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

void	_applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)

void	_beginFrame ()
	Signifies the beginning of a frame, i.e. More...

virtual void	_beginGeometryCount (void)
	The RenderSystem will keep a count of tris rendered, this resets the count. More...

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

void	_cleanupDepthBuffers (IDirect3DDevice9 *creator)

void	_cleanupDepthBuffers (IDirect3DSurface9 *manualSurface)
	This function does NOT override RenderSystem::_cleanupDepthBuffers(bool) functionality. More...

void	_cleanupDepthBuffers (bool bCleanManualBuffers=true)
	Removes all depth buffers. More...

void	_convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)
	Converts a uniform projection matrix to suitable for this render system. More...

DepthBuffer *	_createDepthBufferFor (RenderTarget *renderTarget)
	Creates a DepthBuffer that can be attached to the specified RenderTarget. More...

RenderWindow *	_createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
	Creates a new rendering window. More...

bool	_createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
	Creates multiple rendering windows. More...

void	_disableTextureUnit (size_t texUnit)
	Turns off a texture unit. More...

virtual void	_disableTextureUnitsFrom (size_t texUnit)
	Disables all texture units from the given unit upwards. More...

virtual void	_dispatchCompute (const Vector3i &workgroupDim)

void	_endFrame ()
	Ends rendering of a frame to the current viewport. More...

virtual unsigned int	_getBatchCount (void) const
	Reports the number of batches rendered since the last _beginGeometryCount call. More...

virtual CullingMode	_getCullingMode (void) const

const String &	_getDefaultViewportMaterialScheme (void) const
	Returns the default material scheme used by the render system. More...

D3DFORMAT	_getDepthStencilFormatFor (D3DFORMAT fmt)
	Check which depthStencil formats can be used with a certain pixel format, and return the best suited. More...

virtual unsigned int	_getFaceCount (void) const
	Reports the number of tris rendered since the last _beginGeometryCount call. More...

virtual unsigned int	_getVertexCount (void) const
	Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. More...

virtual Viewport *	_getViewport (void)
	Get the current active viewport for rendering. More...

RenderWindow *	_initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
	Start up the renderer using the settings selected (Or the defaults if none have been selected). More...

void	_initRenderTargets (void)
	Utility method for initialising all render targets attached to this rendering system. More...

void	_makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)

void	_makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)

void	_makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)

void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. More...

virtual RenderSystemContext *	_pauseFrame (void)
	Pause rendering for a frame. More...

void	_render (const RenderOperation &op)
	Render something to the active viewport. More...

virtual void	_resumeFrame (RenderSystemContext *context)
	Resume rendering for a frame. More...

void	_setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)
	Sets the global alpha rejection approach for future renders. More...

virtual void	_setBindingType (TextureUnitState::BindingType bindigType)

void	_setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)

void	_setCullingMode (CullingMode mode)
	Sets the culling mode for the render system based on the 'vertex winding'. More...

void	_setDepthBias (float constantBias, float slopeScaleBias)
	Sets the depth bias, NB you should use the Material version of this. More...

void	_setDepthBufferCheckEnabled (bool enabled=true)
	Sets whether or not the depth buffer check is performed before a pixel write. More...

void	_setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)
	Sets the comparison function for the depth buffer check. More...

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

void	_setDepthBufferWriteEnabled (bool enabled=true)
	Sets whether or not the depth buffer is updated after a pixel write. More...

void	_setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=1.0, Real linearStart=0.0, Real linearEnd=1.0)
	Sets the fogging mode for future geometry. More...

virtual void	_setLineWidth (float width)
	Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More...

void	_setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)
	Sets the size of points and how they are attenuated with distance. More...

void	_setPointSpritesEnabled (bool enabled)
	Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More...

void	_setPolygonMode (PolygonMode level)
	Sets how to rasterise triangles, as points, wireframe or solid polys. More...

void	_setProjectionMatrix (const Matrix4 &m)
	Sets the projection transform matrix. More...

void	_setRenderTarget (RenderTarget *target)
	Set current render target to target, enabling its GL context if needed. More...

void	_setSampler (size_t unit, Sampler &sampler)
	set the sampler settings for the given texture unit More...

void	_setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD)

void	_setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp)

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

void	_setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)
	Sets the texture to bind to a given texture unit. More...

void	_setTextureAddressingMode (size_t stage, const Sampler::UVWAddressingMode &uvw)
	Sets the texture addressing mode for a texture unit. More...

void	_setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
	Sets the texture blend modes from a TextureUnitState record. More...

void	_setTextureBorderColour (size_t stage, const ColourValue &colour)
	Sets the texture border colour for a texture unit. More...

void	_setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)
	Sets a method for automatically calculating texture coordinates for a stage. More...

void	_setTextureCoordSet (size_t unit, size_t index)
	Sets the texture coordinate set to use for a texture unit. More...

void	_setTextureLayerAnisotropy (size_t unit, unsigned int maxAnisotropy)
	Sets the maximal anisotropy for the specified texture unit. More...

void	_setTextureMatrix (size_t unit, const Matrix4 &xform)
	Sets the texture coordinate transformation matrix for a texture unit. More...

void	_setTextureMipmapBias (size_t unit, float bias)
	Sets the mipmap bias value for a given texture unit. More...

virtual void	_setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos)
	Notify the rendersystem that it should adjust texture projection to be relative to a different origin. More...

void	_setTextureUnitCompareEnabled (size_t unit, bool compare)
	Sets whether the compare func is enabled or not for this texture unit. More...

void	_setTextureUnitCompareFunction (size_t unit, CompareFunction function)
	Sets the compare function to use for a given texture unit. More...

void	_setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
	Sets a single filter for a given texture unit. More...

virtual void	_setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

virtual void	_setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
	Utility function for setting all the properties of a texture unit at once. More...

void	_setVertexTexture (size_t unit, const TexturePtr &tex)
	Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler. More...

void	_setViewMatrix (const Matrix4 &m)
	Sets the view transform matrix. More...

void	_setViewport (Viewport *vp)
	Sets the provided viewport as the active one for future rendering operations. More...

void	_setWorldMatrix (const Matrix4 &m)
	Sets the world transform matrix. More...

virtual void	_swapAllRenderTargetBuffers ()
	Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. More...

virtual void	_updateAllRenderTargets (bool swapBuffers=true)
	Internal method for updating all render targets attached to this rendering system. More...

void	_useLights (const LightList &lights, unsigned short limit)
	Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits) More...

void	addClipPlane (const Plane &p)

void	addListener (Listener *l)
	Adds a listener to the custom events that this render system can raise. More...

virtual bool	areFixedFunctionLightsInViewSpace () const
	Are fixed-function lights provided in view space? Affects optimisation. More...

void	attachRenderTarget (RenderTarget &target)
	Attaches the passed render target to the render system. More...

virtual void	beginProfileEvent (const String &eventName)
	This marks the beginning of an event for GPU profiling. More...

void	bindGpuProgram (GpuProgram *prg)
	Binds a given GpuProgram (but not the parameters). More...

void	bindGpuProgramParameters (GpuProgramType gptype, const GpuProgramParametersPtr &params, uint16 variabilityMask)
	Bind Gpu program parameters. More...

void	bindGpuProgramPassIterationParameters (GpuProgramType gptype)
	Only binds Gpu program parameters used for passes that have more than one iteration rendering. More...

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

void	convertColourValue (const ColourValue &colour, uint32 *pDest)
	Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem. More...

HardwareOcclusionQuery *	createHardwareOcclusionQuery ()
	Create an object for performing hardware occlusion queries. More...

virtual MultiRenderTarget *	createMultiRenderTarget (const String &name)
	Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...

void	createStereoDriver (const NameValuePairList *miscParams)
	Creates a bridge to the Direct3D stereo driver implementation. More...

virtual void	destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
	Destroy a hardware occlusion query object. More...

void	destroyRenderTarget (const String &name)
	Destroys a render target of any sort. More...

virtual void	destroyRenderTexture (const String &name)
	Destroys a render texture. More...

virtual void	destroyRenderWindow (const String &name)
	Destroys a render window. More...

virtual RenderTarget *	detachRenderTarget (const String &name)
	Detaches the render target with the passed name from the render system and returns a pointer to it. More...

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

void	enableClipPlane (ushort index, bool enable)

virtual void	endProfileEvent (void)
	Ends the currently active GPU profiling event. More...

void	fireDeviceEvent (D3D9Device *device, const String &name)
	Fires a device related event. More...

const RenderSystemCapabilities *	getCapabilities (void) const
	Gets the capabilities of the render system. More...

VertexElementType	getColourVertexElementType () const
	Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. More...

ConfigOptionMap &	getConfigOptions ()
	Returns the details of this API's configuration options. More...

virtual void	getCustomAttribute (const String &name, void *pData)
	Gets a custom (maybe platform-specific) attribute. More...

unsigned int	getDisplayMonitorCount () const
	Gets the number of display monitors. More...

const DriverVersion &	getDriverVersion (void) const
	Returns the driver version. More...

String	getErrorDescription (long errorNumber) const

HardwareVertexBufferSharedPtr	getGlobalInstanceVertexBuffer () const
	Returns the global instance vertex buffer. More...

VertexDeclaration *	getGlobalInstanceVertexBufferVertexDeclaration () const
	Gets vertex declaration for the global vertex buffer for the global instancing. More...

size_t	getGlobalNumberOfInstances () const
	Gets the global number of instances. More...

Real	getHorizontalTexelOffset ()
	Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

bool	getInvertVertexWinding (void) const
	Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...

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

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

MultiheadUseType	getMultiheadUse () const
	Returns how multihead should be activated. More...

RenderSystemCapabilities *	getMutableCapabilities ()
	Get a pointer to the current capabilities being used by the RenderSystem. More...

const String &	getName () const
	Returns the name of the rendering system. More...

uint16	getNativeShadingLanguageVersion () const
	Gets the native shading language version for this render system. More...

const StringVector &	getRenderSystemEvents (void) const
	Gets a list of the rendersystem specific events that this rendersystem can raise. More...

RenderTarget *	getRenderTarget (const String &name)
	Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found. More...

RenderTargetIterator	getRenderTargetIterator (void)
	Returns a specialised MapIterator over all render targets attached to the RenderSystem. More...

Real	getVerticalTexelOffset ()
	Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

bool	getWBufferEnabled (void) const

virtual bool	hasAnisotropicMipMapFilter () const
	Determines if the system has anisotropic mip map filter support. More...

virtual void	initConfigOptions ()

bool	IsActiveDeviceLost ()

bool	isGpuProgramBound (GpuProgramType gptype)
	Returns whether or not a Gpu program of the given type is currently bound. More...

virtual bool	isStaticBufferLockable () const
	Returns whether under the current render system buffers marked as TU_STATIC can be locked for update. More...

virtual void	markProfileEvent (const String &eventName)
	Marks an instantaneous event for graphics profilers. More...

void	postExtraThreadsStarted ()
	Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered. More...

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

void	registerThread ()
	Register the an additional thread which may make calls to rendersystem-related objects. More...

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

void	removeListener (Listener *l)
	Remove a listener to the custom events that this render system can raise. More...

void	resetClipPlanes ()

void	setAmbientLight (const ColourValue &c)

void	setAmbientLight (float r, float g, float b)
	Sets the colour & strength of the ambient (global directionless) light in the world. More...

void	setClipPlane (ushort index, Real A, Real B, Real C, Real D)

virtual void	setClipPlanes (const PlaneList &clipPlanes)
	Sets the user clipping region. More...

virtual void	setColourBlendState (const ColourBlendState &state)
	Sets the global blending factors for combining subsequent renders with the existing frame contents. More...

void	setConfigOption (const String &name, const String &value)
	Sets an option for this API. More...

virtual void	setCurrentPassIterationCount (const size_t count)
	set the current multi pass count value. More...

void	setDepthBufferFor (RenderTarget *renderTarget)
	Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More...

void	setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f)
	Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. More...

virtual bool	setDrawBuffer (ColourBufferType colourBuffer)
	Sets the colour buffer that the render system will to draw. More...

void	setGlobalInstanceVertexBuffer (const HardwareVertexBufferSharedPtr &val)
	Sets the global instance vertex buffer. More...

void	setGlobalInstanceVertexBufferVertexDeclaration (VertexDeclaration *val)
	Sets vertex declaration for the global vertex buffer for the global instancing. More...

void	setGlobalNumberOfInstances (const size_t val)
	Sets the global number of instances. More...

void	setInvertVertexWinding (bool invert)
	Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. More...

void	setLightingEnabled (bool enabled)
	Sets whether or not dynamic lighting is enabled. More...

void	setNormaliseNormals (bool normalise)
	Sets whether or not normals are to be automatically normalised. More...

void	setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600)
	Sets the 'scissor region' i.e. More...

void	setShadingType (ShadeOptions so)
	Sets the type of light shading required (default = Gouraud). More...

void	setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 compareMask=0xFFFFFFFF, uint32 writeMask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false, bool readBackAsTexture=false)
	This method allows you to set all the stencil buffer parameters in one call. More...

void	setStencilCheckEnabled (bool enabled)
	Turns stencil buffer checking on or off. More...

void	setVertexBufferBinding (VertexBufferBinding *binding)

void	setVertexBufferBinding (VertexBufferBinding *binding, size_t numberOfInstances, bool useGlobalInstancingVertexBufferIsAvailable, bool indexesUsed)

void	setVertexDeclaration (VertexDeclaration *decl)

void	setVertexDeclaration (VertexDeclaration *decl, bool useGlobalInstancingVertexBufferIsAvailable)

void	setWBufferEnabled (bool enabled)

void	shutdown ()
	Shutdown the renderer and cleanup resources. More...

void	unbindGpuProgram (GpuProgramType gptype)
	Unbinds GpuPrograms of a given GpuProgramType. More...

void	unregisterThread ()
	Unregister an additional thread which may make calls to rendersystem-related objects. More...

void	useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
	Force the render system to use the special capabilities. More...

String	validateConfigOptions ()
	Validates the options set for the rendering system, returning a message if there are problems. More...

Static Public Member Functions
static IDirect3DDevice9 *	getActiveD3D9Device ()

static IDirect3DDevice9 *	getActiveD3D9DeviceIfExists ()

static D3D9DeviceManager *	getDeviceManager ()

static IDirect3D9 *	getDirect3D9 ()

static IDirect3DDevice9 *	getResourceCreationDevice (UINT index)

static UINT	getResourceCreationDeviceCount ()

static D3D9ResourceManager *	getResourceManager ()

static Listener *	getSharedListener (void)
	Retrieve a pointer to the current shared render system listener. More...

static bool	isDirectX9Ex ()
	Tells whether the system is initialized with DirectX 9Ex driver Read more in http://msdn.microsoft.com/en-us/library/windows/desktop/ee890072(v=vs.85).aspx. More...

static void	setSharedListener (Listener *listener)
	Sets shared listener. More...

Friends
class	D3D9Device

class	D3D9DeviceManager

Detailed Description

Implementation of DirectX9 as a rendering system.

Member Typedef Documentation

◆ RenderTargetIterator

typedef MapIterator<Ogre::RenderTargetMap> Ogre::RenderSystem::RenderTargetIterator

inherited

Iterator over RenderTargets.

Member Enumeration Documentation

◆ MultiheadUseType

enum Ogre::D3D9RenderSystem::MultiheadUseType

Enumerator
mutAuto
mutYes
mutNo

Constructor & Destructor Documentation

◆ D3D9RenderSystem()

Ogre::D3D9RenderSystem::D3D9RenderSystem ( HINSTANCE hInstance )

◆ ~D3D9RenderSystem()

Ogre::D3D9RenderSystem::~D3D9RenderSystem ( )

Member Function Documentation

◆ initConfigOptions()

virtual void Ogre::D3D9RenderSystem::initConfigOptions ( )

virtual

Reimplemented from Ogre::RenderSystem.

◆ validateConfigOptions()

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.

◆ _initialise()

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.
windowTitle	Sets the app window title

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

Reimplemented from Ogre::RenderSystem.

◆ _createRenderWindow()

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
left	Positive integers	Centred	Screen x coordinate from left
top	Positive integers	Centred	Screen y coordinate from left
border	none, fixed, resize	resize	The type of window border (in windowed mode)
hidden	true, false	false	hide the created window
FSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Full screen antialiasing factor
gamma	true, false	false	Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.
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.
Full Screen	true, false	false	Specify whether to create the window in full screen mode
displayFrequency	Refresh rate in Hertz (e.g. 60, 75, 100)	Desktop vsync rate	Display frequency rate, for fullscreen mode
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
externalWindowHandle	Win32: HWND as integer GLX: poslong:posint:poslong (display:screen:windowHandle) or poslong:posint:poslong:poslong (display:screen:windowHandle:XVisualInfo*) OS X Cocoa: OgreGLView address as an integer. You can pass NSView or NSWindow too, but should perform OgreGLView callbacks into the Ogre manually. OS X Carbon: WindowRef 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
currentGLContext	true, false	false	Use an externally created GL context. (Must be current)	OpenGL Specific
minColourBufferSize	Positive integer (usually 16, 32)	16	Min total colour buffer size. See EGL_BUFFER_SIZE	OpenGL Specific
windowProc	WNDPROC	DefWindowProc	function that processes window messages	Win 32 Specific
colourDepth	16, 32	Desktop depth	Colour depth of the resulting rendering window; only applies if fullScreen	Win32 Specific
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	Win32 Specific
outerDimensions	true, false	false	Whether the width/height is expressed as the size of the outer window, rather than the content area	Win32 Specific
monitorIndex		-1		Win 32 Specific
monitorHandle		0 (none)		Win 32 Specific (OpenGL)
enableDoubleClick	true, false	false	Enable the window to keep track and transmit double click messages.	Win32 Specific
useNVPerfHUD	true, false	false	Enable the use of nVidia NVPerfHUD	DirectX Specific
depthBuffer	true, false	true	Use depth buffer	DirectX9 Specific
NSOpenGLCPSurfaceOrder	-1 or 1	1	NSOpenGLCPSurfaceOrder	Mac OS X Specific
contentScalingFactor	Positive Float greater than 1.0	The default content scaling factor of the screen	On IOS 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 / Android 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
externalSharegroup	EAGLSharegroup pointer as an integer	0	External sharegroup, used to shared GL resources between contexts	iOS Specific
MSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Full screen antialiasing factor	Android Specific
CSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Coverage sampling factor	Android Specific
maxColourBufferSize	Positive integer (usually 16, 32)	32	Max EGL_BUFFER_SIZE	Android Specific
maxStencilBufferSize	Positive integer (usually 0, 8)	0	EGL_STENCIL_SIZE	Android Specific
maxDepthBufferSize	Positive integer (usually 0, 16, 24)	16	EGL_DEPTH_SIZE	Android Specific

Implements Ogre::RenderSystem.

◆ _createRenderWindows()

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.

◆ _createDepthBufferFor()

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.

◆ _addManualDepthBuffer()

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

◆ _cleanupDepthBuffers() [1/3]

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

◆ _cleanupDepthBuffers() [2/3]

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

manualSurface Depth buffer surface to compare against. Shouldn't be null

◆ _setRenderTarget()

void Ogre::D3D9RenderSystem::_setRenderTarget ( RenderTarget * target )

virtual

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

Implements Ogre::RenderSystem.

◆ createMultiRenderTarget()

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.

◆ detachRenderTarget()

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.

◆ getErrorDescription()

String Ogre::D3D9RenderSystem::getErrorDescription ( long errorNumber ) const

◆ getName()

const String& Ogre::D3D9RenderSystem::getName ( ) const

virtual

Returns the name of the rendering system.

Implements Ogre::RenderSystem.

◆ setConfigOption()

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.

◆ reinitialise()

void Ogre::D3D9RenderSystem::reinitialise ( )

virtual

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

Implements Ogre::RenderSystem.

◆ shutdown()

void Ogre::D3D9RenderSystem::shutdown ( )

virtual

Shutdown the renderer and cleanup resources.

Reimplemented from Ogre::RenderSystem.

◆ setAmbientLight() [1/2]

void Ogre::D3D9RenderSystem::setAmbientLight	(	float	r,
		float	g,
		float	b
	)

virtual

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

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ setShadingType()

void Ogre::D3D9RenderSystem::setShadingType ( ShadeOptions so )

virtual

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

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ setLightingEnabled()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ destroyRenderTarget()

void Ogre::D3D9RenderSystem::destroyRenderTarget ( const String & name )

virtual

Destroys a render target of any sort.

Reimplemented from Ogre::RenderSystem.

◆ getColourVertexElementType()

VertexElementType Ogre::D3D9RenderSystem::getColourVertexElementType ( ) const

virtual

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

Implements Ogre::RenderSystem.

◆ setStencilCheckEnabled()

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.

◆ setStencilBufferParams()

void Ogre::D3D9RenderSystem::setStencilBufferParams	(	CompareFunction	func = `CMPF_ALWAYS_PASS`,
		uint32	refValue = `0`,
		uint32	compareMask = `0xFFFFFFFF`,
		uint32	writeMask = `0xFFFFFFFF`,
		StencilOperation	stencilFailOp = `SOP_KEEP`,
		StencilOperation	depthFailOp = `SOP_KEEP`,
		StencilOperation	passOp = `SOP_KEEP`,
		bool	twoSidedOperation = `false`,
		bool	readBackAsTexture = `false`
	)

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
compareMask	The bitmask applied to both the stencil value and the reference value before comparison
writeMask	The bitmask the controls which bits from refValue will be written to stencil buffer (valid for operations such as SOP_REPLACE). the stencil
stencilFailOp	The action to perform when the stencil check fails
depthFailOp	The action to perform when the stencil check passes, but the depth buffer check still fails
passOp	The action to take when both the stencil and depth check pass.
twoSidedOperation	If set to true, then if you render both back and front faces (you'll have to turn off culling) then these parameters will apply for front faces, and the inverse of them will happen for back faces (keep remains the same).
readBackAsTexture	D3D11 specific

Implements Ogre::RenderSystem.

◆ setNormaliseNormals()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _useLights()

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)

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setWorldMatrix()

void Ogre::D3D9RenderSystem::_setWorldMatrix ( const Matrix4 & m )

virtual

Sets the world transform matrix.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setViewMatrix()

void Ogre::D3D9RenderSystem::_setViewMatrix ( const Matrix4 & m )

virtual

Sets the view transform matrix.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setProjectionMatrix()

void Ogre::D3D9RenderSystem::_setProjectionMatrix ( const Matrix4 & m )

virtual

Sets the projection transform matrix.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setSurfaceParams()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setPointSpritesEnabled()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setPointParameters()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setTexture()

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.

◆ _setSampler()

void Ogre::D3D9RenderSystem::_setSampler	(	size_t	texUnit,
		Sampler &	s
	)

virtual

set the sampler settings for the given texture unit

Implements Ogre::RenderSystem.

◆ _setVertexTexture()

void Ogre::D3D9RenderSystem::_setVertexTexture	(	size_t	unit,
		const TexturePtr &	tex
	)

virtual

Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain 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.

Deprecated:: only needed for D3D9

Reimplemented from Ogre::RenderSystem.

◆ _disableTextureUnit()

void Ogre::D3D9RenderSystem::_disableTextureUnit ( size_t texUnit )

virtual

Turns off a texture unit.

Reimplemented from Ogre::RenderSystem.

◆ _setTextureCoordSet()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setTextureCoordCalculation()

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

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setTextureBlendMode()

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

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setTextureAddressingMode()

void Ogre::D3D9RenderSystem::_setTextureAddressingMode	(	size_t	unit,
		const Sampler::UVWAddressingMode &	uvw
	)

virtual

Sets the texture addressing mode for a texture unit.

Implements Ogre::RenderSystem.

◆ _setTextureBorderColour()

void Ogre::D3D9RenderSystem::_setTextureBorderColour	(	size_t	unit,
		const ColourValue &	colour
	)

virtual

Sets the texture border colour for a texture unit.

Implements Ogre::RenderSystem.

◆ _setTextureMipmapBias()

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.

◆ _setTextureMatrix()

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

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _setSeparateSceneBlending()

void Ogre::D3D9RenderSystem::_setSeparateSceneBlending	(	SceneBlendFactor	sourceFactor,
		SceneBlendFactor	destFactor,
		SceneBlendFactor	sourceFactorAlpha,
		SceneBlendFactor	destFactorAlpha,
		SceneBlendOperation	op,
		SceneBlendOperation	alphaOp
	)

virtual

Deprecated:: use setColourBlendState

Implements Ogre::RenderSystem.

◆ _setAlphaRejectSettings()

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.
value	The value to compare each pixels alpha value to (0-255)
alphaToCoverage	Whether to enable alpha to coverage, if supported

Implements Ogre::RenderSystem.

◆ _setViewport()

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

vp	Pointer to the appropriate viewport.

Implements Ogre::RenderSystem.

◆ _beginFrame()

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.

◆ _pauseFrame()

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.

◆ _resumeFrame()

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.

◆ _endFrame()

void Ogre::D3D9RenderSystem::_endFrame ( )

virtual

Ends rendering of a frame to the current viewport.

Implements Ogre::RenderSystem.

◆ _setCullingMode()

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.

◆ _setDepthBufferParams()

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.

◆ _setDepthBufferCheckEnabled()

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.

◆ _setColourBufferWriteEnabled()

void Ogre::D3D9RenderSystem::_setColourBufferWriteEnabled	(	bool	red,
		bool	green,
		bool	blue,
		bool	alpha
	)

virtual

Deprecated:: use setColourBlendState

Implements Ogre::RenderSystem.

◆ _setDepthBufferWriteEnabled()

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.

◆ _setDepthBufferFunction()

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.

◆ _setDepthBias()

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.

◆ _setFog()

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.

Deprecated:: only needed for fixed function APIs

Reimplemented from Ogre::RenderSystem.

◆ _convertProjectionMatrix()

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.

◆ _makeProjectionMatrix() [1/2]

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

virtual

Deprecated:: use Frustum::getProjectionMatrixRS

Implements Ogre::RenderSystem.

◆ _makeProjectionMatrix() [2/2]

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

virtual

Deprecated:: use Frustum::getProjectionMatrixRS

Implements Ogre::RenderSystem.

◆ _makeOrthoMatrix()

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

virtual

Deprecated:: use Frustum::getProjectionMatrixRS

Implements Ogre::RenderSystem.

◆ _applyObliqueDepthProjection()

void Ogre::D3D9RenderSystem::_applyObliqueDepthProjection	(	Matrix4 &	matrix,
		const Plane &	plane,
		bool	forGpuProgram
	)

virtual

Deprecated:: use Frustum::getProjectionMatrixRS

Implements Ogre::RenderSystem.

◆ _setPolygonMode()

void Ogre::D3D9RenderSystem::_setPolygonMode ( PolygonMode level )

virtual

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

Implements Ogre::RenderSystem.

◆ _setTextureUnitFiltering() [1/2]

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.

◆ _setTextureUnitCompareFunction()

void Ogre::D3D9RenderSystem::_setTextureUnitCompareFunction	(	size_t	unit,
		CompareFunction	function
	)

virtual

Sets the compare function to use for a given texture unit.

Parameters

unit	The texture unit to set the filtering options for
function	The comparison function

Implements Ogre::RenderSystem.

◆ _setTextureUnitCompareEnabled()

void Ogre::D3D9RenderSystem::_setTextureUnitCompareEnabled	(	size_t	unit,
		bool	compare
	)

virtual

Sets whether the compare func is enabled or not for this texture unit.

Parameters

unit	The texture unit to set the filtering options for
compare	The state (enabled/disabled)

Implements Ogre::RenderSystem.

◆ _setTextureLayerAnisotropy()

void Ogre::D3D9RenderSystem::_setTextureLayerAnisotropy	(	size_t	unit,
		unsigned int	maxAnisotropy
	)

virtual

Sets the maximal anisotropy for the specified texture unit.

Implements Ogre::RenderSystem.

◆ setVertexDeclaration() [1/2]

void Ogre::D3D9RenderSystem::setVertexDeclaration ( VertexDeclaration * decl )

◆ setVertexDeclaration() [2/2]

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

◆ setVertexBufferBinding() [1/2]

void Ogre::D3D9RenderSystem::setVertexBufferBinding ( VertexBufferBinding * binding )

◆ setVertexBufferBinding() [2/2]

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

◆ _render()

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.

◆ bindGpuProgram()

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 existing one.

Reimplemented from Ogre::RenderSystem.

◆ unbindGpuProgram()

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.

Reimplemented from Ogre::RenderSystem.

◆ bindGpuProgramParameters()

void Ogre::D3D9RenderSystem::bindGpuProgramParameters	(	GpuProgramType	gptype,
		const GpuProgramParametersPtr &	params,
		uint16	variabilityMask
	)

virtual

Bind Gpu program parameters.

Parameters

gptype	The type of program to bind the parameters to
params	The parameters to bind
variabilityMask	A mask of GpuParamVariability identifying which params need binding

Implements Ogre::RenderSystem.

◆ bindGpuProgramPassIterationParameters()

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.

◆ setScissorTest()

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' i.e.

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.

◆ clearFrameBuffer()

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.

◆ setClipPlane()

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

◆ enableClipPlane()

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

◆ createHardwareOcclusionQuery()

HardwareOcclusionQuery* Ogre::D3D9RenderSystem::createHardwareOcclusionQuery ( )

virtual

Create an object for performing hardware occlusion queries.

Implements Ogre::RenderSystem.

◆ getHorizontalTexelOffset()

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.

◆ getVerticalTexelOffset()

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.

◆ getMinimumDepthInputValue()

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.

◆ getMaximumDepthInputValue()

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.

◆ registerThread()

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.

◆ unregisterThread()

void Ogre::D3D9RenderSystem::unregisterThread ( )

virtual

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

See also: RenderSystem::registerThread

Implements Ogre::RenderSystem.

◆ preExtraThreadsStarted()

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.

Note

If you start your own threads, there is a specific startup sequence which must be respected and requires synchronisation between the threads:

[Main thread] Call preExtraThreadsStarted()
[Main thread] Start other thread, wait
[Other thread] Call registerThread(), notify main thread & continue
[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.

◆ postExtraThreadsStarted()

void Ogre::D3D9RenderSystem::postExtraThreadsStarted ( )

virtual

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

See also: RenderSystem::preExtraThreadsStarted

Implements Ogre::RenderSystem.

◆ isStaticBufferLockable()

virtual bool Ogre::D3D9RenderSystem::isStaticBufferLockable ( ) const

inlinevirtual

Returns whether under the current render system buffers marked as TU_STATIC can be locked for update.

Remarks: Needed in the implementation of DirectX9 with DirectX9Ex driver

Reimplemented from Ogre::RenderSystem.

◆ IsActiveDeviceLost()

bool Ogre::D3D9RenderSystem::IsActiveDeviceLost ( )

◆ isDirectX9Ex()

static bool Ogre::D3D9RenderSystem::isDirectX9Ex ( )

inlinestatic

Tells whether the system is initialized with DirectX 9Ex driver Read more in http://msdn.microsoft.com/en-us/library/windows/desktop/ee890072(v=vs.85).aspx.

◆ getResourceManager()

static D3D9ResourceManager* Ogre::D3D9RenderSystem::getResourceManager ( )

static

◆ getDeviceManager()

static D3D9DeviceManager* Ogre::D3D9RenderSystem::getDeviceManager ( )

static

◆ getDirect3D9()

static IDirect3D9* Ogre::D3D9RenderSystem::getDirect3D9 ( )

static

◆ getResourceCreationDeviceCount()

static UINT Ogre::D3D9RenderSystem::getResourceCreationDeviceCount ( )

static

◆ getResourceCreationDevice()

static IDirect3DDevice9* Ogre::D3D9RenderSystem::getResourceCreationDevice ( UINT index )

static

◆ getActiveD3D9Device()

static IDirect3DDevice9* Ogre::D3D9RenderSystem::getActiveD3D9Device ( )

static

◆ getActiveD3D9DeviceIfExists()

static IDirect3DDevice9* Ogre::D3D9RenderSystem::getActiveD3D9DeviceIfExists ( )

static

◆ _getDepthStencilFormatFor()

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

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

◆ _checkTextureFilteringSupported()

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.

◆ determineFSAASettings()

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.

◆ getDisplayMonitorCount()

unsigned int Ogre::D3D9RenderSystem::getDisplayMonitorCount ( ) const

virtual

Gets the number of display monitors.

See also: Root::getDisplayMonitorCount

Implements Ogre::RenderSystem.

◆ hasAnisotropicMipMapFilter()

virtual bool Ogre::D3D9RenderSystem::hasAnisotropicMipMapFilter ( ) const

inlinevirtual

Determines if the system has anisotropic mip map filter support.

Implements Ogre::RenderSystem.

◆ beginProfileEvent()

virtual void Ogre::D3D9RenderSystem::beginProfileEvent ( const String & eventName )

virtual

This marks the beginning of an event for GPU profiling.

Implements Ogre::RenderSystem.

◆ endProfileEvent()

virtual void Ogre::D3D9RenderSystem::endProfileEvent ( void )

virtual

Ends the currently active GPU profiling event.

Implements Ogre::RenderSystem.

◆ markProfileEvent()

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.

◆ fireDeviceEvent()

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

Fires a device related event.

◆ getMultiheadUse()

MultiheadUseType Ogre::D3D9RenderSystem::getMultiheadUse ( ) const

inline

Returns how multihead should be activated.

◆ setDrawBuffer()

virtual bool Ogre::D3D9RenderSystem::setDrawBuffer ( ColourBufferType colourBuffer )

virtual

Sets the colour buffer that the render system will to draw.

If the render system implementation or configuration does not support a particular value, then false will be returned and the current colour buffer value will not be modified.

Parameters

colourBuffer Specifies the colour buffer that will be drawn into.

Reimplemented from Ogre::RenderSystem.

◆ createStereoDriver()

void Ogre::D3D9RenderSystem::createStereoDriver ( const NameValuePairList * miscParams )

Creates a bridge to the Direct3D stereo driver implementation.

◆ getConfigOptions()

ConfigOptionMap& Ogre::RenderSystem::getConfigOptions ( )

inlineinherited

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.

◆ destroyHardwareOcclusionQuery()

virtual void Ogre::RenderSystem::destroyHardwareOcclusionQuery ( HardwareOcclusionQuery * hq )

virtualinherited

Destroy a hardware occlusion query object.

◆ getMutableCapabilities()

RenderSystemCapabilities* Ogre::RenderSystem::getMutableCapabilities ( )

inlineinherited

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.

◆ useCustomRenderSystemCapabilities()

void Ogre::RenderSystem::useCustomRenderSystemCapabilities ( RenderSystemCapabilities * capabilities )

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.

◆ setAmbientLight() [2/2]

void Ogre::RenderSystem::setAmbientLight ( const ColourValue & c )

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::ColourValue::r, and Ogre::RenderSystem::setAmbientLight().

Referenced by Ogre::RenderSystem::setAmbientLight().

◆ setWBufferEnabled()

void Ogre::RenderSystem::setWBufferEnabled ( bool enabled )

inherited

Deprecated:: use RSC_WBUFFER

◆ getWBufferEnabled()

bool Ogre::RenderSystem::getWBufferEnabled ( void ) const

inherited

Deprecated:: use RSC_WBUFFER

◆ destroyRenderWindow()

virtual void Ogre::RenderSystem::destroyRenderWindow ( const String & name )

virtualinherited

Destroys a render window.

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

◆ destroyRenderTexture()

virtual void Ogre::RenderSystem::destroyRenderTexture ( const String & name )

virtualinherited

Destroys a render texture.

◆ attachRenderTarget()

void Ogre::RenderSystem::attachRenderTarget ( RenderTarget & target )

inherited

Attaches the passed render target to the render system.

◆ getRenderTarget()

RenderTarget* Ogre::RenderSystem::getRenderTarget ( const String & name )

inherited

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

◆ getRenderTargetIterator()

RenderTargetIterator Ogre::RenderSystem::getRenderTargetIterator ( void )

inlineinherited

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

◆ getGlobalInstanceVertexBuffer()

HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer ( ) const

inherited

Returns the global instance vertex buffer.

◆ setGlobalInstanceVertexBuffer()

void Ogre::RenderSystem::setGlobalInstanceVertexBuffer ( const HardwareVertexBufferSharedPtr & val )

inherited

Sets the global instance vertex buffer.

◆ getGlobalInstanceVertexBufferVertexDeclaration()

VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration ( ) const

inherited

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

◆ setGlobalInstanceVertexBufferVertexDeclaration()

void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration ( VertexDeclaration * val )

inherited

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

◆ getGlobalNumberOfInstances()

size_t Ogre::RenderSystem::getGlobalNumberOfInstances ( ) const

inherited

Gets the global number of instances.

◆ setGlobalNumberOfInstances()

void Ogre::RenderSystem::setGlobalNumberOfInstances ( const size_t val )

inherited

Sets the global number of instances.

◆ setDepthBufferFor()

void Ogre::RenderSystem::setDepthBufferFor ( RenderTarget * renderTarget )

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

◆ areFixedFunctionLightsInViewSpace()

virtual bool Ogre::RenderSystem::areFixedFunctionLightsInViewSpace ( ) const

inlinevirtualinherited

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

Reimplemented in Ogre::GLRenderSystem.

◆ _setTextureUnitSettings()

virtual void Ogre::RenderSystem::_setTextureUnitSettings	(	size_t	texUnit,
		TextureUnitState &	tl
	)

virtualinherited

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.

◆ _setBindingType()

virtual void Ogre::RenderSystem::_setBindingType ( TextureUnitState::BindingType bindigType )

inlinevirtualinherited

◆ _disableTextureUnitsFrom()

virtual void Ogre::RenderSystem::_disableTextureUnitsFrom ( size_t texUnit )

virtualinherited

Disables all texture units from the given unit upwards.

◆ _setLineWidth()

virtual void Ogre::RenderSystem::_setLineWidth ( float width )

inlinevirtualinherited

Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP.

Parameters

width only value of 1.0 might be supported. Check for RSC_WIDE_LINES.

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

◆ _setTextureUnitFiltering() [2/2]

virtual void Ogre::RenderSystem::_setTextureUnitFiltering	(	size_t	unit,
		FilterOptions	minFilter,
		FilterOptions	magFilter,
		FilterOptions	mipFilter
	)

virtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

Reimplemented in Ogre::GLES2RenderSystem.

◆ setColourBlendState()

virtual void Ogre::RenderSystem::setColourBlendState ( const ColourBlendState & state )

inlinevirtualinherited

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

References Ogre::ColourBlendState::alphaOperation, Ogre::ColourBlendState::destFactor, Ogre::ColourBlendState::destFactorAlpha, Ogre::ColourBlendState::operation, Ogre::ColourBlendState::sourceFactor, Ogre::ColourBlendState::sourceFactorAlpha, Ogre::ColourBlendState::writeA, Ogre::ColourBlendState::writeB, Ogre::ColourBlendState::writeG, and Ogre::ColourBlendState::writeR.

◆ _setSceneBlending()

void Ogre::RenderSystem::_setSceneBlending	(	SceneBlendFactor	sourceFactor,
		SceneBlendFactor	destFactor,
		SceneBlendOperation	op = `SBO_ADD`
	)

inlineinherited

Deprecated:: use setColourBlendState

References Ogre::SBO_ADD.

◆ _setTextureProjectionRelativeTo()

virtual void Ogre::RenderSystem::_setTextureProjectionRelativeTo	(	bool	enabled,
		const Vector3 &	pos
	)

virtualinherited

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

◆ _cleanupDepthBuffers() [3/3]

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.

◆ _getViewport()

virtual Viewport* Ogre::RenderSystem::_getViewport ( void )

virtualinherited

Get the current active viewport for rendering.

◆ _getCullingMode()

virtual CullingMode Ogre::RenderSystem::_getCullingMode ( void ) const

virtualinherited

◆ _beginGeometryCount()

virtual void Ogre::RenderSystem::_beginGeometryCount ( void )

virtualinherited

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

◆ _getFaceCount()

virtual unsigned int Ogre::RenderSystem::_getFaceCount ( void ) const

virtualinherited

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

◆ _getBatchCount()

virtual unsigned int Ogre::RenderSystem::_getBatchCount ( void ) const

virtualinherited

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

◆ _getVertexCount()

virtual unsigned int Ogre::RenderSystem::_getVertexCount ( void ) const

virtualinherited

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

◆ convertColourValue()

void Ogre::RenderSystem::convertColourValue	(	const ColourValue &	colour,
		uint32 *	pDest
	)

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.

◆ _dispatchCompute()

virtual void Ogre::RenderSystem::_dispatchCompute ( const Vector3i & workgroupDim )

inlinevirtualinherited

Reimplemented in Ogre::D3D11RenderSystem, and Ogre::GL3PlusRenderSystem.

◆ getCapabilities()

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities ( void ) const

inlineinherited

Gets the capabilities of the render system.

◆ getDriverVersion()

const DriverVersion& Ogre::RenderSystem::getDriverVersion ( void ) const

inlineinherited

Returns the driver version.

◆ _getDefaultViewportMaterialScheme()

const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme ( void ) const

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

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

◆ isGpuProgramBound()

bool Ogre::RenderSystem::isGpuProgramBound ( GpuProgramType gptype )

inherited

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

◆ getNativeShadingLanguageVersion()

uint16 Ogre::RenderSystem::getNativeShadingLanguageVersion ( ) const

inlineinherited

Gets the native shading language version for this render system.

Formatted so that it can be used within a shading program. For example, OpenGL 3.2 would return 150, while 3.3 would return 330

References Ogre::ColourValue::Black.

◆ setClipPlanes()

virtual void Ogre::RenderSystem::setClipPlanes ( const PlaneList & clipPlanes )

virtualinherited

Sets the user clipping region.

Deprecated:: only needed for fixed function APIs

◆ addClipPlane()

void Ogre::RenderSystem::addClipPlane ( const Plane & p )

inherited

Deprecated:: use setClipPlanes

◆ resetClipPlanes()

void Ogre::RenderSystem::resetClipPlanes ( )

inherited

Deprecated:: use setClipPlanes

◆ _initRenderTargets()

void Ogre::RenderSystem::_initRenderTargets ( void )

inherited

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

◆ _notifyCameraRemoved()

void Ogre::RenderSystem::_notifyCameraRemoved ( const Camera * cam )

inherited

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

◆ _updateAllRenderTargets()

virtual void Ogre::RenderSystem::_updateAllRenderTargets ( bool swapBuffers = true )

virtualinherited

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

Reimplemented in Ogre::D3D11RenderSystem.

◆ _swapAllRenderTargetBuffers()

virtual void Ogre::RenderSystem::_swapAllRenderTargetBuffers ( )

virtualinherited

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

Reimplemented in Ogre::D3D11RenderSystem.

◆ setInvertVertexWinding()

void Ogre::RenderSystem::setInvertVertexWinding ( bool invert )

inherited

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

◆ getInvertVertexWinding()

bool Ogre::RenderSystem::getInvertVertexWinding ( void ) const

inherited

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

reflections)

See also: RenderSystem::setInvertVertexWinding

◆ setCurrentPassIterationCount()

virtual void Ogre::RenderSystem::setCurrentPassIterationCount ( const size_t count )

inlinevirtualinherited

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.

◆ setDeriveDepthBias()

void Ogre::RenderSystem::setDeriveDepthBias	(	bool	derive,
		float	baseValue = `0.0f`,
		float	multiplier = `0.0f`,
		float	slopeScale = `0.0f`
	)

inlineinherited

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

◆ setSharedListener()

static void Ogre::RenderSystem::setSharedListener ( Listener * listener )

staticinherited

Sets shared listener.

Remarks: Shared listener could be set even if no render system is selected yet. This listener will receive "RenderSystemChanged" event on each Root::setRenderSystem call.

◆ getSharedListener()

static Listener* Ogre::RenderSystem::getSharedListener ( void )

staticinherited

Retrieve a pointer to the current shared render system listener.

◆ addListener()

void Ogre::RenderSystem::addListener ( Listener * l )

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

◆ removeListener()

void Ogre::RenderSystem::removeListener ( Listener * l )

inherited

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

◆ getRenderSystemEvents()

const StringVector& Ogre::RenderSystem::getRenderSystemEvents ( void ) const

inlineinherited

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

See also: RenderSystem::addListener

◆ getCustomAttribute()

virtual void Ogre::RenderSystem::getCustomAttribute	(	const String &	name,
		void *	pData
	)

virtualinherited

Gets a custom (maybe platform-specific) attribute.

Remarks: This is a nasty way of satisfying any API's need to see platform-specific details.

Parameters

name	The name of the attribute.
pData	Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D11RenderSystem.

Friends And Related Function Documentation

◆ D3D9Device

friend class D3D9Device

friend

◆ D3D9DeviceManager

friend class D3D9DeviceManager

friend

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

OgreD3D9RenderSystem.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ RenderTargetIterator

Member Enumeration Documentation

◆ MultiheadUseType

Constructor & Destructor Documentation

◆ D3D9RenderSystem()

◆ ~D3D9RenderSystem()

Member Function Documentation

◆ initConfigOptions()

◆ validateConfigOptions()

◆ _initialise()

◆ _createRenderWindow()

◆ _createRenderWindows()

◆ _createDepthBufferFor()

◆ _addManualDepthBuffer()

◆ _cleanupDepthBuffers() [1/3]

◆ _cleanupDepthBuffers() [2/3]

◆ _setRenderTarget()

◆ createMultiRenderTarget()

◆ detachRenderTarget()

◆ getErrorDescription()

◆ getName()

◆ setConfigOption()

◆ reinitialise()

◆ shutdown()

◆ setAmbientLight() [1/2]

◆ setShadingType()

◆ setLightingEnabled()

◆ destroyRenderTarget()

◆ getColourVertexElementType()

◆ setStencilCheckEnabled()

◆ setStencilBufferParams()

◆ setNormaliseNormals()

◆ _useLights()

◆ _setWorldMatrix()

◆ _setViewMatrix()

◆ _setProjectionMatrix()

◆ _setSurfaceParams()

◆ _setPointSpritesEnabled()

◆ _setPointParameters()

◆ _setTexture()

◆ _setSampler()

◆ _setVertexTexture()

◆ _disableTextureUnit()

◆ _setTextureCoordSet()

◆ _setTextureCoordCalculation()

◆ _setTextureBlendMode()

◆ _setTextureAddressingMode()

◆ _setTextureBorderColour()

◆ _setTextureMipmapBias()

◆ _setTextureMatrix()

◆ _setSeparateSceneBlending()

◆ _setAlphaRejectSettings()

◆ _setViewport()

◆ _beginFrame()

◆ _pauseFrame()

◆ _resumeFrame()

◆ _endFrame()

◆ _setCullingMode()

◆ _setDepthBufferParams()

◆ _setDepthBufferCheckEnabled()

◆ _setColourBufferWriteEnabled()

◆ _setDepthBufferWriteEnabled()

◆ _setDepthBufferFunction()

◆ _setDepthBias()

◆ _setFog()

◆ _convertProjectionMatrix()

◆ _makeProjectionMatrix() [1/2]

◆ _makeProjectionMatrix() [2/2]

◆ _makeOrthoMatrix()

◆ _applyObliqueDepthProjection()

◆ _setPolygonMode()

◆ _setTextureUnitFiltering() [1/2]

◆ _setTextureUnitCompareFunction()

◆ _setTextureUnitCompareEnabled()