#include <OgreD3D9RenderWindow.h>

Inheritance diagram for Ogre::D3D9RenderWindow:

Public Member Functions
	D3D9RenderWindow (HINSTANCE instance)
	Constructor. More...

	~D3D9RenderWindow ()

void	_beginUpdate ()
	Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More...

void	_endUpdate ()
	Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More...

void	_finishSwitchingFullscreen ()
	Indicate that fullscreen / windowed switching has finished. More...

bool	_getSwitchingFullscreen () const
	Are we in the middle of switching between fullscreen and windowed. More...

void	_updateViewport (Viewport *viewport, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...

bool	_validateDevice ()
	Validate the device for this window. More...

void	_validateStereo ()
	Validate the type of stereo that is enabled for this window. More...

void	adjustWindow (unsigned int clientWidth, unsigned int clientHeight, unsigned int winWidth, unsigned int winHeight)

void	buildPresentParameters (D3DPRESENT_PARAMETERS *presentParams)
	Build the presentation parameters used with this window. More...

void	copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer)
	Copies the current contents of the render target to a pixelbox. More...

void	create (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)
	Creates & displays the new window. More...

void	destroy (void)
	Destroys the window. More...

void	getCustomAttribute (const String &name, void *pData)
	Retrieve a platform or API-specific piece of information. More...

IDirect3DDevice9 *	getD3D9Device ()

D3D9Device *	getDevice ()

IDirect3DSurface9 *	getRenderSurface ()
	Accessor for render surface. More...

HWND	getWindowHandle () const

bool	isAA () const

bool	isActive () const
	Overridden from RenderTarget, flags invisible windows as inactive. More...

bool	isDepthBuffered () const
	Returns true if this window use depth buffer. More...

bool	isHidden () const
	Indicates whether the window was set to hidden (not displayed) More...

bool	isNvPerfHUDEnable () const
	Returns true if this window should use NV Perf HUD adapter. More...

bool	isVisible () const
	Indicates whether the window is visible (not minimized or obscured) More...

bool	isVSync () const

bool	isVSyncEnabled () const
	Indicates whether vertical sync is activated for the window. More...

void	reposition (int left, int top)
	Reposition the window. More...

bool	requiresTextureFlipping () const

void	resize (unsigned int width, unsigned int height)
	Alter the size of the window. More...

void	setDevice (D3D9Device *device)

void	setFullscreen (bool fullScreen, unsigned int width, unsigned int height)
	Alter fullscreen mode options. More...

void	setHidden (bool hidden)
	Hide (or show) the window. More...

void	setVSyncEnabled (bool vsync)
	Enable or disable vertical sync for the RenderWindow. More...

void	setVSyncInterval (unsigned int interval)
	Set the vertical sync interval. More...

PixelFormat	suggestPixelFormat () const override
	Overridden - see RenderTarget. More...

void	swapBuffers ()
	Swaps the frame buffers to display the next frame. More...

void	windowMovedOrResized ()
	Query the current size and position from an external window handle. More...

Public Member Functions inherited from Ogre::RenderWindow
	RenderWindow ()
	Default constructor. More...

void	getMetrics (unsigned int &width, unsigned int &height, int &left, int &top) const
	Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More...

virtual float	getViewPointToPixelScale ()
	Many windowing systems that support HiDPI displays use special points to specify size of the windows and controls, so that windows and controls with hardcoded sizes does not become too small on HiDPI displays. More...

unsigned int	getVSyncInterval () const
	Returns the vertical sync interval. More...

virtual bool	isClosed (void) const
	Indicates whether the window has been closed by the user. More...

bool	isDeactivatedOnFocusChange () const
	Returns true if the window will automatically de-activate itself when it loses focus. More...

virtual bool	isFullScreen (void) const
	Returns true if window is running in fullscreen mode. More...

bool	isPrimary (void) const override
	Indicates whether the window is the primary window. More...

void	setDeactivateOnFocusChange (bool deactivate)
	Indicates whether the window will automatically deactivate itself when it loses focus. More...

virtual void	setVisible (bool visible)
	Set the visibility state. More...

Public Member Functions inherited from Ogre::RenderTarget
	RenderTarget ()

virtual	~RenderTarget ()

virtual void	_detachDepthBuffer ()
	Detaches DepthBuffer without notifying it from the detach. More...

virtual void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify a render target that a camera has been removed, in case it was referring to it as a viewer. More...

virtual void	_updateAutoUpdatedViewports (bool updateStatistics=true)
	Method for manual management of rendering - renders only viewports that are auto updated. More...

virtual void	_updateViewport (int zorder, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...

virtual void	addListener (RenderTargetListener *listener)
	Add a listener to this RenderTarget which will be called back before & after rendering. More...

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

virtual bool	attachDepthBuffer (DepthBuffer *depthBuffer)

void	copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
	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	detachDepthBuffer ()

uint	getCustomAttribute (const String &name)
	simplified API for bindings More...

DepthBuffer *	getDepthBuffer () const

uint16	getDepthBufferPool () const

virtual uint	getFSAA () const
	Indicates whether multisampling is performed on rendering and at what level. More...

virtual const String &	getFSAAHint () const
	RenderSystem specific FSAA option. See RenderSystem::_createRenderWindow for details. More...

virtual uint32	getHeight (void) const

void	getMetrics (unsigned int &width, unsigned int &height)
	Retrieve information about the render target. More...

virtual const String &	getName (void) const
	Retrieve target's name. More...

virtual unsigned short	getNumViewports (void) const
	Returns the number of viewports attached to this target. More...

virtual uchar	getPriority () const
	Gets the priority of a render target. More...

const FrameStats &	getStatistics (void) const
	Retrieves details of current rendering performance. More...

virtual Viewport *	getViewport (unsigned short index)
	Retrieves a pointer to the viewport with the given index. More...

virtual Viewport *	getViewportByZOrder (int ZOrder)
	Retrieves a pointer to the viewport with the given Z-order. More...

virtual uint32	getWidth (void) const

virtual bool	hasViewportWithZOrder (int ZOrder)
	Returns true if and only if a viewport exists at the given Z-order. More...

virtual void	insertListener (RenderTargetListener *listener, const unsigned int pos=0)
	same as addListener, but force the position in the vector, so we can control the call order More...

virtual bool	isAutoUpdated (void) const
	Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...

virtual bool	isHardwareGammaEnabled () const
	Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...

virtual bool	isStereoEnabled (void) const
	Indicates whether stereo is currently enabled for this target. More...

virtual void	removeAllListeners (void)
	Removes all listeners from this instance. More...

virtual void	removeAllViewports (void)
	Removes all viewports on this target. More...

virtual void	removeListener (RenderTargetListener *listener)
	Removes a RenderTargetListener previously registered using addListener. More...

virtual void	removeViewport (int ZOrder)
	Removes a viewport at a given Z-order. More...

void	resetStatistics (void)
	Resets saved frame-rate statistices. More...

virtual void	setActive (bool state)
	Used to set the active state of the render target. More...

virtual void	setAutoUpdated (bool autoupdate)
	Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...

void	setDepthBufferPool (uint16 poolId)
	Sets the pool ID this RenderTarget should query from. More...

virtual void	setFSAA (uint fsaa, const String &fsaaHint)
	Set the level of multisample AA to be used if hardware support it. More...

virtual void	setPriority (uchar priority)
	Sets the priority of this render target in relation to the others. More...

virtual void	update (bool swapBuffers=true)
	Tells the target to update it's contents. More...

void	writeContentsToFile (const String &filename)
	Writes the current contents of the render target to the named file. More...

virtual String	writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
	Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More...

Additional Inherited Members
Public Types inherited from Ogre::RenderTarget
enum	FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }

Constructor & Destructor Documentation

◆ D3D9RenderWindow()

Ogre::D3D9RenderWindow::D3D9RenderWindow ( HINSTANCE instance )

Constructor.

Parameters

instance The application instance

◆ ~D3D9RenderWindow()

Ogre::D3D9RenderWindow::~D3D9RenderWindow ( )

Member Function Documentation

◆ create()

void Ogre::D3D9RenderWindow::create	(	const String &	name,
		unsigned int	widthPt,
		unsigned int	heightPt,
		bool	fullScreen,
		const NameValuePairList *	miscParams
	)

virtual

Creates & displays the new window.

Parameters

name	the internal window name. Not necessarily the title.
widthPt	The width of the window in view points.
heightPt	The height of the window in view points.
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.

◆ setFullscreen()

void Ogre::D3D9RenderWindow::setFullscreen	(	bool	fullScreen,
		unsigned int	widthPt,
		unsigned int	heightPt
	)

virtual

Alter fullscreen mode options.

Nothing will happen unless the settings here are different from the current settings.

Note: Only implemented by few RenderSystems. Prefer native windowing API.

Parameters

fullScreen	Whether to use fullscreen mode or not.
widthPt	The new width to use
heightPt	The new height to use

Reimplemented from Ogre::RenderWindow.

◆ destroy()

void Ogre::D3D9RenderWindow::destroy ( void )

virtual

Destroys the window.

Implements Ogre::RenderWindow.

◆ isActive()

bool Ogre::D3D9RenderWindow::isActive ( void ) const

virtual

Overridden from RenderTarget, flags invisible windows as inactive.

Reimplemented from Ogre::RenderWindow.

◆ isVisible()

bool Ogre::D3D9RenderWindow::isVisible ( void ) const

virtual

Indicates whether the window is visible (not minimized or obscured)

Reimplemented from Ogre::RenderWindow.

◆ isVSync()

bool Ogre::D3D9RenderWindow::isVSync ( ) const

inline

◆ isAA()

bool Ogre::D3D9RenderWindow::isAA ( ) const

inline

◆ isHidden()

bool Ogre::D3D9RenderWindow::isHidden ( void ) const

inlinevirtual

Indicates whether the window was set to hidden (not displayed)

Reimplemented from Ogre::RenderWindow.

◆ setHidden()

void Ogre::D3D9RenderWindow::setHidden ( bool hidden )

virtual

Hide (or show) the window.

If called with hidden=true, this will make the window completely invisible to the user.

Setting a window to hidden is useful to create a dummy primary RenderWindow hidden from the user so that you can create and recreate your actual RenderWindows without having to recreate all your resources.

Reimplemented from Ogre::RenderWindow.

◆ setVSyncEnabled()

void Ogre::D3D9RenderWindow::setVSyncEnabled ( bool vsync )

virtual

Enable or disable vertical sync for the RenderWindow.

Reimplemented from Ogre::RenderWindow.

◆ isVSyncEnabled()

bool Ogre::D3D9RenderWindow::isVSyncEnabled ( ) const

virtual

Indicates whether vertical sync is activated for the window.

Reimplemented from Ogre::RenderWindow.

◆ setVSyncInterval()

void Ogre::D3D9RenderWindow::setVSyncInterval ( unsigned int interval )

virtual

Set the vertical sync interval.

This indicates the number of vertical retraces to wait for before swapping buffers. A value of 1 is the default.

Reimplemented from Ogre::RenderWindow.

◆ reposition()

void Ogre::D3D9RenderWindow::reposition	(	int	leftPt,
		int	topPt
	)

virtual

Reposition the window.

Note: Only implemented by few RenderSystems. Prefer native windowing API.

Reimplemented from Ogre::RenderWindow.

◆ resize()

void Ogre::D3D9RenderWindow::resize	(	unsigned int	widthPt,
		unsigned int	heightPt
	)

virtual

Alter the size of the window.

Implements Ogre::RenderWindow.

◆ swapBuffers()

void Ogre::D3D9RenderWindow::swapBuffers ( void )

virtual

Swaps the frame buffers to display the next frame.

For targets that are double-buffered so that no 'in-progress' versions of the scene are displayed during rendering. Once rendering has completed (to an off-screen version of the window) the buffers are swapped to display the new frame.

Reimplemented from Ogre::RenderTarget.

◆ getWindowHandle()

HWND Ogre::D3D9RenderWindow::getWindowHandle ( ) const

inline

◆ getD3D9Device()

IDirect3DDevice9* Ogre::D3D9RenderWindow::getD3D9Device ( )

◆ getDevice()

D3D9Device* Ogre::D3D9RenderWindow::getDevice ( )

◆ setDevice()

void Ogre::D3D9RenderWindow::setDevice ( D3D9Device * device )

◆ getCustomAttribute()

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

virtual

Retrieve a platform or API-specific piece of information.

This method of retrieving information should only be used if you know what you're doing.

Name	Description
WINDOW	The native window handle. (X11 Window XID/ HWND / NSWindow*)
HWND	deprecated (same as WINDOW)
GL_FBOID	the id of the OpenGL framebuffer object
GL_MULTISAMPLEFBOID	the id of the OpenGL framebuffer object used for multisampling
GLFBO	id of the screen OpenGL framebuffer object on iOS
GLCONTEXT	deprecated, do not use
FBO	deprecated, do not use
TARGET	deprecated, do not use
XDISPLAY	The X Display connection behind that context.
ATOM	The X Atom used in client delete events.
VIEW	Cocoa NSView*
NSOPENGLCONTEXT	Cocoa NSOpenGLContext*
NSOPENGLPIXELFORMAT	Cocoa NSOpenGLPixelFormat*

Parameters

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

Reimplemented from Ogre::RenderTarget.

◆ suggestPixelFormat()

PixelFormat Ogre::D3D9RenderWindow::suggestPixelFormat ( ) const

overridevirtual

Overridden - see RenderTarget.

Reimplemented from Ogre::RenderWindow.

◆ copyContentsToMemory()

void Ogre::D3D9RenderWindow::copyContentsToMemory	(	const Box &	src,
		const PixelBox &	dst,
		FrameBuffer	buffer
	)

virtual

Copies the current contents of the render target to a pixelbox.

Remarks: See suggestPixelFormat for a tip as to the best pixel format to extract into, although you can use whatever format you like and the results will be converted.

Implements Ogre::RenderTarget.

◆ requiresTextureFlipping()

bool Ogre::D3D9RenderWindow::requiresTextureFlipping ( ) const

inlinevirtual

Implements Ogre::RenderTarget.

◆ windowMovedOrResized()

void Ogre::D3D9RenderWindow::windowMovedOrResized ( void )

virtual

Query the current size and position from an external window handle.

Note: most of the time you already know the size and should call resize instead.

Reimplemented from Ogre::RenderWindow.

◆ buildPresentParameters()

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

Build the presentation parameters used with this window.

◆ _beginUpdate()

void Ogre::D3D9RenderWindow::_beginUpdate ( )

virtual

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

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

◆ _updateViewport()

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)

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.

◆ _endUpdate()

void Ogre::D3D9RenderWindow::_endUpdate ( )

virtual

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

You should call it after a _beginUpdate

See also: _beginUpdate for more details.

Reimplemented from Ogre::RenderTarget.

◆ getRenderSurface()

IDirect3DSurface9* Ogre::D3D9RenderWindow::getRenderSurface ( )

Accessor for render surface.

◆ _getSwitchingFullscreen()

bool Ogre::D3D9RenderWindow::_getSwitchingFullscreen ( ) const

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

◆ _finishSwitchingFullscreen()

void Ogre::D3D9RenderWindow::_finishSwitchingFullscreen ( )

Indicate that fullscreen / windowed switching has finished.

◆ isDepthBuffered()

bool Ogre::D3D9RenderWindow::isDepthBuffered ( ) const

Returns true if this window use depth buffer.

◆ isNvPerfHUDEnable()

bool Ogre::D3D9RenderWindow::isNvPerfHUDEnable ( ) const

Returns true if this window should use NV Perf HUD adapter.

◆ _validateDevice()

bool Ogre::D3D9RenderWindow::_validateDevice ( )

Validate the device for this window.

◆ adjustWindow()

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

◆ _validateStereo()

void Ogre::D3D9RenderWindow::_validateStereo ( )

Validate the type of stereo that is enabled for this window.

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

OgreD3D9RenderWindow.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ D3D9RenderWindow()

◆ ~D3D9RenderWindow()

Member Function Documentation

◆ create()

◆ setFullscreen()

◆ destroy()

◆ isActive()

◆ isVisible()

◆ isVSync()

◆ isAA()

◆ isHidden()

◆ setHidden()

◆ setVSyncEnabled()

◆ isVSyncEnabled()

◆ setVSyncInterval()

◆ reposition()

◆ resize()

◆ swapBuffers()

◆ getWindowHandle()

◆ getD3D9Device()

◆ getDevice()

◆ setDevice()

◆ getCustomAttribute()

◆ suggestPixelFormat()

◆ copyContentsToMemory()

◆ requiresTextureFlipping()

◆ windowMovedOrResized()

◆ buildPresentParameters()

◆ _beginUpdate()

◆ _updateViewport()

◆ _endUpdate()

◆ getRenderSurface()

◆ _getSwitchingFullscreen()

◆ _finishSwitchingFullscreen()

◆ isDepthBuffered()

◆ isNvPerfHUDEnable()

◆ _validateDevice()

◆ adjustWindow()

◆ _validateStereo()