#include <OgreD3D9RenderWindow.h>

Inheritance diagram for Ogre::D3D9RenderWindow:

Public Types
enum	FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }
enum	StatFlags { SF_NONE = 0, SF_FPS = 1, SF_AVG_FPS = 2, SF_BEST_FPS = 4, SF_WORST_FPS = 8, SF_TRIANGLE_COUNT = 16, SF_ALL = 0xFFFF }
Public Member Functions
	D3D9RenderWindow (HINSTANCE instance)
	Constructor.
	~D3D9RenderWindow ()
void	_beginUpdate ()
virtual void	_detachDepthBuffer ()
	Detaches DepthBuffer without notifying it from the detach.
void	_endUpdate ()
void	_finishSwitchingFullscreen ()
	Indicate that fullscreen / windowed switching has finished.
virtual Impl *	_getImpl ()
	Get rendersystem specific interface for this RenderTarget.
bool	_getSwitchingFullscreen () const
	Are we in the middle of switching between fullscreen and windowed.
virtual void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.
virtual void	_updateAutoUpdatedViewports (bool updateStatistics=true)
	Method for manual management of rendering - renders only viewports that are auto updated.
void	_updateViewport (Viewport *viewport, bool updateStatistics=true)
virtual void	_updateViewport (int zorder, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)
bool	_validateDevice ()
	Validate the device for this window.
virtual void	addListener (RenderTargetListener *listener)
	Add a listener to this RenderTarget which will be called back before & after rendering.
virtual Viewport *	addViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f)
	Adds a viewport to the rendering target.
void	adjustWindow (unsigned int clientWidth, unsigned int clientHeight, unsigned int winWidth, unsigned int winHeight)
virtual bool	attachDepthBuffer (DepthBuffer *depthBuffer)
void	buildPresentParameters (D3DPRESENT_PARAMETERS *presentParams)
	Build the presentation parameters used with this window.
void	copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer)
	Overridden - see RenderTarget.
void	create (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)
	Creates & displays the new window.
void	destroy (void)
	Destroys the window.
virtual void	detachDepthBuffer ()
virtual float	getAverageFPS () const
	Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.
virtual size_t	getBatchCount (void) const
	Gets the number of batches rendered in the last update() call.
virtual float	getBestFPS () const
	Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.
virtual float	getBestFrameTime () const
	Individual stats access - gets the best frame time.
virtual uint32	getColourDepth (void) const
void	getCustomAttribute (const String &name, void *pData)
	Gets a custom (maybe platform-specific) attribute.
IDirect3DDevice9 *	getD3D9Device ()
DepthBuffer *	getDepthBuffer () const
uint16	getDepthBufferPool () const
D3D9Device *	getDevice ()
virtual uint	getFSAA () const
	Indicates whether multisampling is performed on rendering and at what level.
virtual const String &	getFSAAHint () const
	Gets the FSAA hint (.
virtual uint32	getHeight (void) const
virtual float	getLastFPS () const
	Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
virtual void	getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
	Retrieve information about the render target.
virtual void	getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth, int &left, int &top)
	Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.
virtual const String &	getName (void) const
	Retrieve target's name.
virtual unsigned short	getNumViewports (void) const
	Returns the number of viewports attached to this target.
virtual uchar	getPriority () const
	Gets the priority of a render target.
IDirect3DSurface9 *	getRenderSurface ()
	Accessor for render surface.
virtual void	getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const
	Retieves details of current rendering performance.
virtual const FrameStats &	getStatistics (void) const
virtual size_t	getTriangleCount (void) const
	Gets the number of triangles rendered in the last update() call.
virtual Viewport *	getViewport (unsigned short index)
	Retrieves a pointer to the viewport with the given index.
virtual Viewport *	getViewportByZOrder (int ZOrder)
	Retrieves a pointer to the viewport with the given Z-order.
unsigned int	getVSyncInterval () const
	Returns the vertical sync interval.
virtual uint32	getWidth (void) const
HWND	getWindowHandle () const
virtual float	getWorstFPS () const
	Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.
virtual float	getWorstFrameTime () const
	Individual stats access - gets the worst frame time.
virtual bool	hasViewportWithZOrder (int ZOrder)
	Returns true if and only if a viewport exists at the given Z-order.
bool	isActive () const
	Overridden from RenderTarget, flags invisible windows as inactive.
virtual bool	isAutoUpdated (void) const
	Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
bool	isClosed () const
	Indicates whether the window has been closed by the user.
bool	isDeactivatedOnFocusChange () const
	Returns true if the window will automatically de-activate itself when it loses focus.
bool	isDepthBuffered () const
	Returns true if this window use depth buffer.
virtual bool	isFullScreen (void) const
	Returns true if window is running in fullscreen mode.
virtual bool	isHardwareGammaEnabled () const
	Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space.
bool	isHidden () const
	Indicates whether the window was set to hidden (not displayed)
bool	isNvPerfHUDEnable () const
	Returns true if this window should use NV Perf HUD adapter.
virtual bool	isPrimary (void) const
	Indicates whether the window is the primary window.
bool	isVisible () const
	Indicates whether the window is visible (not minimized or obscured)
bool	isVSync () const
bool	isVSyncEnabled () const
	Indicates whether vertical sync is activated for the window.
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	removeAllListeners (void)
	Removes all listeners from this instance.
virtual void	removeAllViewports (void)
	Removes all viewports on this target.
virtual void	removeListener (RenderTargetListener *listener)
	Removes a RenderTargetListener previously registered using addListener.
virtual void	removeViewport (int ZOrder)
	Removes a viewport at a given Z-order.
void	reposition (int left, int top)
	Reposition the window.
bool	requiresTextureFlipping () const
virtual void	resetStatistics (void)
	Resets saved frame-rate statistices.
void	resize (unsigned int width, unsigned int height)
	Alter the size of the window.
virtual void	setActive (bool state)
	Used to set the active state of the render target.
virtual void	setAutoUpdated (bool autoupdate)
	Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
void	setDeactivateOnFocusChange (bool deactivate)
	Indicates whether the window will automatically deactivate itself when it loses focus.
void	setDepthBufferPool (uint16 poolId)
	Sets the pool ID this RenderTarget should query from.
void	setDevice (D3D9Device *device)
void	setFullscreen (bool fullScreen, unsigned int width, unsigned int height)
	Alter fullscreen mode options.
void	setHidden (bool hidden)
	Hide (or show) the window.
virtual void	setPriority (uchar priority)
	Sets the priority of this render target in relation to the others.
virtual void	setVisible (bool visible)
	Set the visibility state.
void	setVSyncEnabled (bool vsync)
	Enable or disable vertical sync for the RenderWindow.
void	setVSyncInterval (unsigned int interval)
	Set the vertical sync interval.
PixelFormat	suggestPixelFormat () const
	Override since windows don't usually have alpha.
void	swapBuffers ()
	Swaps the frame buffers to display the next frame.
virtual void	update (bool swapBuffers=true)
	Tells the target to update it's contents.
void	windowMovedOrResized ()
	Notify that the window has been resized.
void	writeContentsToFile (const String &filename)
	Writes the current contents of the render target to the named file.
virtual String	writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
	Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.
Protected Types
typedef vector < RenderTargetListener * > ::type	RenderTargetListenerList
typedef map< int, Viewport * > ::type	ViewportList
Protected Member Functions
void	_setPrimary ()
	Indicates that this is the primary window.
virtual void	firePostUpdate (void)
	internal method for firing events
virtual void	firePreUpdate (void)
	internal method for firing events
virtual void	fireViewportAdded (Viewport *vp)
	internal method for firing events
virtual void	fireViewportPostUpdate (Viewport *vp)
	internal method for firing events
virtual void	fireViewportPreUpdate (Viewport *vp)
	internal method for firing events
virtual void	fireViewportRemoved (Viewport *vp)
	internal method for firing events
DWORD	getWindowStyle (bool fullScreen) const
	Return the target window style depending on the fullscreen parameter.
virtual void	updateImpl ()
	Internal implementation of update()
void	updateStats (void)
void	updateWindowRect ()
	Update the window rect.
Protected Attributes
bool	mActive
bool	mAutoDeactivatedOnFocusChange
bool	mAutoUpdate
bool	mClosed
uint32	mColourDepth
DepthBuffer *	mDepthBuffer
uint16	mDepthBufferPoolId
unsigned int	mDesiredHeight
unsigned int	mDesiredWidth
D3D9Device *	mDevice
bool	mDeviceValid
UINT	mDisplayFrequency
size_t	mFrameCount
uint	mFSAA
String	mFSAAHint
DWORD	mFSAAQuality
D3DMULTISAMPLE_TYPE	mFSAAType
DWORD	mFullscreenWinStyle
uint32	mHeight
bool	mHidden
bool	mHwGamma
HWND	mHWnd
HINSTANCE	mInstance
bool	mIsExternal
bool	mIsFullScreen
bool	mIsPrimary
unsigned long	mLastSecond
unsigned long	mLastTime
int	mLeft
RenderTargetListenerList	mListeners
String	mName
	The name of this target.
uchar	mPriority
	The priority of the render target.
FrameStats	mStats
bool	mSwitchingFullscreen
Timer *	mTimer
int	mTop
bool	mUseNVPerfHUD
ViewportList	mViewportList
	List of viewports, map on Z-order.
bool	mVSync
unsigned int	mVSyncInterval
uint32	mWidth
DWORD	mWindowedWinStyle
Friends
class	Root

Detailed Description

Definition at line 37 of file OgreD3D9RenderWindow.h.

Member Typedef Documentation

typedef vector<RenderTargetListener*>::type Ogre::RenderTarget::RenderTargetListenerList [protected, inherited]

Definition at line 497 of file OgreRenderTarget.h.

typedef map<int, Viewport*>::type Ogre::RenderTarget::ViewportList [protected, inherited]

Definition at line 493 of file OgreRenderTarget.h.

Member Enumeration Documentation

enum Ogre::RenderTarget::FrameBuffer [inherited]

Enumerator:

FB_FRONT
FB_BACK
FB_AUTO

Definition at line 91 of file OgreRenderTarget.h.

enum Ogre::RenderTarget::StatFlags [inherited]

Enumerator:

SF_NONE
SF_FPS
SF_AVG_FPS
SF_BEST_FPS
SF_WORST_FPS
SF_TRIANGLE_COUNT
SF_ALL

Definition at line 68 of file OgreRenderTarget.h.

Constructor & Destructor Documentation

Ogre::D3D9RenderWindow::D3D9RenderWindow ( HINSTANCE instance )

Constructor.

Parameters:

instance The application instance

Ogre::D3D9RenderWindow::~D3D9RenderWindow ( )

Member Function Documentation

void Ogre::D3D9RenderWindow::_beginUpdate ( ) [virtual]

Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc.

Remarks:

_beginUpdate resets statistics and fires 'preRenderTargetUpdate'.
_updateViewport renders the given viewport (even if it is not autoupdated), fires preViewportUpdate and postViewportUpdate and manages statistics.
_updateAutoUpdatedViewports renders only viewports that are auto updated, fires preViewportUpdate and postViewportUpdate and manages statistics.
_endUpdate() ends statistics calculation and fires postRenderTargetUpdate.

you can use it like this for example :

			renderTarget->_beginUpdate();
			renderTarget->_updateViewport(1); // which is not auto updated
			renderTarget->_updateViewport(2); // which is not auto updated
			renderTarget->_updateAutoUpdatedViewports();
			renderTarget->_endUpdate();
			renderTarget->swapBuffers();

Please note that in that case, the zorder may not work as you expect, since you are responsible for calling _updateViewport in the correct order.

Reimplemented from Ogre::RenderTarget.

virtual void Ogre::RenderTarget::_detachDepthBuffer ( ) [virtual, inherited]

Detaches DepthBuffer without notifying it from the detach.

Useful when called from the DepthBuffer while it iterates through attached RenderTargets (

See also:: DepthBuffer::_setPoolId())

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLESFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

void Ogre::D3D9RenderWindow::_endUpdate ( ) [virtual]

Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.

Remarks:: You should call it after a _beginUpdate

See also:: _beginUpdate for more details.

Reimplemented from Ogre::RenderTarget.

void Ogre::D3D9RenderWindow::_finishSwitchingFullscreen ( )

Indicate that fullscreen / windowed switching has finished.

virtual Impl* Ogre::RenderTarget::_getImpl ( ) [virtual, inherited]

Get rendersystem specific interface for this RenderTarget.

This is used by the RenderSystem to (un)bind this target, and to get specific information like surfaces and framebuffer objects.

bool Ogre::D3D9RenderWindow::_getSwitchingFullscreen ( ) const

Are we in the middle of switching between fullscreen and windowed.

virtual void Ogre::RenderTarget::_notifyCameraRemoved ( const Camera * cam ) [virtual, inherited]

Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.

void Ogre::RenderWindow::_setPrimary ( ) [protected, inherited]

Indicates that this is the primary window.

Only to be called by Ogre::Root

Definition at line 206 of file OgreRenderWindow.h.

virtual void Ogre::RenderTarget::_updateAutoUpdatedViewports ( bool updateStatistics = true ) [virtual, inherited]

Method for manual management of rendering - renders only viewports that are auto updated.

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate(). See _beginUpdate for more details.

Parameters:

updateStatistics Whether you want to update statistics or not.

See also:: _beginUpdate()

void Ogre::D3D9RenderWindow::_updateViewport	(	Viewport *	viewport,
		bool	updateStatistics = `true`
	)		`[virtual]`

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics if needed. You should call it between _beginUpdate() and _endUpdate().

See also:: _beginUpdate for more details.

Parameters:

viewport	The viewport you want to update, it must be bound to the rendertarget.
updateStatistics	Whether you want to update statistics or not.

Reimplemented from Ogre::RenderTarget.

virtual void Ogre::RenderTarget::_updateViewport	(	int	zorder,
		bool	updateStatistics = `true`
	)		`[virtual, inherited]`

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate().

See also:: _beginUpdate for more details.

Parameters:

zorder	The zorder of the viewport to update.
updateStatistics	Whether you want to update statistics or not.

bool Ogre::D3D9RenderWindow::_validateDevice ( )

Validate the device for this window.

virtual void Ogre::RenderTarget::addListener ( RenderTargetListener * listener ) [virtual, inherited]

Add a listener to this RenderTarget which will be called back before & after rendering.

Remarks:: If you want notifications before and after a target is updated by the system, use this method to register your own custom RenderTargetListener class. This is useful for potentially adding your own manual rendering commands before and after the 'normal' system rendering.

NB this should not be used for frame-based scene updates, use Root::addFrameListener for that.

virtual Viewport* Ogre::RenderTarget::addViewport	(	Camera *	cam,
		int	ZOrder = `0`,
		float	left = `0.0f`,
		float	top = `0.0f`,
		float	width = `1.0f`,
		float	height = `1.0f`
	)		`[virtual, inherited]`

Adds a viewport to the rendering target.

Remarks:: A viewport is the rectangle into which rendering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.

Parameters:

cam	The camera from which the viewport contents will be rendered (mandatory)
ZOrder	The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher Z-orders are on top of lower ones. The actual number is irrelevant, only the relative Z-order matters (you can leave gaps in the numbering)
left	The relative position of the left of the viewport on the target, as a value between 0 and 1.
top	The relative position of the top of the viewport on the target, as a value between 0 and 1.
width	The relative width of the viewport on the target, as a value between 0 and 1.
height	The relative height of the viewport on the target, as a value between 0 and 1.

void Ogre::D3D9RenderWindow::adjustWindow	(	unsigned int	clientWidth,
		unsigned int	clientHeight,
		unsigned int *	winWidth,
		unsigned int *	winHeight
	)

virtual bool Ogre::RenderTarget::attachDepthBuffer ( DepthBuffer * depthBuffer ) [virtual, inherited]

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLESFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

void Ogre::D3D9RenderWindow::buildPresentParameters ( D3DPRESENT_PARAMETERS * presentParams )

Build the presentation parameters used with this window.

void Ogre::D3D9RenderWindow::copyContentsToMemory	(	const PixelBox &	dst,
		FrameBuffer	buffer
	)		`[virtual]`

Overridden - see RenderTarget.

Implements Ogre::RenderTarget.

void Ogre::D3D9RenderWindow::create	(	const String &	name,
		unsigned int	width,
		unsigned int	height,
		bool	fullScreen,
		const NameValuePairList *	miscParams
	)		`[virtual]`

Creates & displays the new window.

Parameters:

width	The width of the window in pixels.
height	The height of the window in pixels.
fullScreen	If true, the window fills the screen, with no title bar or border.
miscParams	A variable number of pointers to platform-specific arguments. The actual requirements must be defined by the implementing subclasses.

Implements Ogre::RenderWindow.

void Ogre::D3D9RenderWindow::destroy ( void ) [virtual]

Destroys the window.

Implements Ogre::RenderWindow.

virtual void Ogre::RenderTarget::detachDepthBuffer ( ) [virtual, inherited]

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLESFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

virtual void Ogre::RenderTarget::firePostUpdate ( void ) [protected, virtual, inherited]