![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
#include <OgreD3D9RenderWindow.h>
Public Member Functions | |
D3D9RenderWindow (HINSTANCE instance) | |
Constructor. | |
~D3D9RenderWindow () | |
void | _beginUpdate () |
Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. | |
void | _endUpdate () |
Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. | |
void | _finishSwitchingFullscreen () |
Indicate that fullscreen / windowed switching has finished. | |
bool | _getSwitchingFullscreen () const |
Are we in the middle of switching between fullscreen and windowed. | |
void | _updateViewport (Viewport *viewport, 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. | |
void | _validateStereo () |
Validate the type of stereo that is enabled for this window. | |
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. | |
void | copyContentsToMemory (const Box &src, 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. | |
void | getCustomAttribute (const String &name, void *pData) |
Retrieve a platform or API-specific piece of information. | |
IDirect3DDevice9 * | getD3D9Device () |
D3D9Device * | getDevice () |
IDirect3DSurface9 * | getRenderSurface () |
Accessor for render surface. | |
unsigned int | getVSyncInterval () const |
Returns the vertical sync interval. | |
HWND | getWindowHandle () const |
bool | isAA () const |
bool | isActive () const |
Overridden from RenderTarget, flags invisible windows as inactive. | |
bool | isClosed () const |
Indicates whether the window has been closed by the user. | |
bool | isDepthBuffered () const |
Returns true if this window use depth buffer. | |
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. | |
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 | reposition (int left, int top) |
Reposition the window. | |
bool | requiresTextureFlipping () const |
void | resize (unsigned int width, unsigned int height) |
Alter the size of the window. | |
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. | |
void | setVSyncEnabled (bool vsync) |
Enable or disable vertical sync for the RenderWindow. | |
void | setVSyncInterval (unsigned int interval) |
Set the vertical sync interval. | |
void | swapBuffers () |
Swaps the frame buffers to display the next frame. | |
void | windowMovedOrResized () |
Notify that the window has been resized. | |
![]() | |
RenderWindow () | |
Default constructor. | |
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) const |
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. | |
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. | |
bool | isDeactivatedOnFocusChange () const |
Returns true if the window will automatically de-activate itself when it loses focus. | |
virtual bool | isFullScreen (void) const |
Returns true if window is running in fullscreen mode. | |
virtual bool | isPrimary (void) const |
Indicates whether the window is the primary window. | |
void | setDeactivateOnFocusChange (bool deactivate) |
Indicates whether the window will automatically deactivate itself when it loses focus. | |
virtual void | setVisible (bool visible) |
Set the visibility state. | |
PixelFormat | suggestPixelFormat () const |
Override since windows don't usually have alpha. | |
![]() | |
RenderTarget () | |
virtual | ~RenderTarget () |
virtual void | _detachDepthBuffer () |
Detaches DepthBuffer without notifying it from the detach. | |
virtual Impl * | _getImpl () |
Get rendersystem specific interface for this RenderTarget. | |
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. | |
virtual void | _updateViewport (int zorder, bool updateStatistics=true) |
Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) | |
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. | |
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. | |
virtual void | detachDepthBuffer () |
virtual uint32 | getColourDepth (void) const |
uint | getCustomAttribute (const String &name) |
simplified API for bindings | |
DepthBuffer * | getDepthBuffer () const |
uint16 | getDepthBufferPool () const |
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 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. | |
const FrameStats & | getStatistics (void) const |
Retieves details of current rendering performance. | |
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. | |
virtual uint32 | getWidth (void) const |
virtual bool | hasViewportWithZOrder (int ZOrder) |
Returns true if and only if a viewport exists at the given Z-order. | |
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 | |
virtual bool | isAutoUpdated (void) const |
Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. | |
virtual bool | isHardwareGammaEnabled () const |
Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. | |
virtual bool | isStereoEnabled (void) const |
Indicates whether stereo is currently enabled for this target. | |
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 | resetStatistics (void) |
Resets saved frame-rate statistices. | |
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 | setDepthBufferPool (uint16 poolId) |
Sets the pool ID this RenderTarget should query from. | |
virtual void | setFSAA (uint fsaa, const String &fsaaHint) |
Set the level of multisample AA to be used if hardware support it. | |
virtual void | setPriority (uchar priority) |
Sets the priority of this render target in relation to the others. | |
virtual void | update (bool swapBuffers=true) |
Tells the target to update it's contents. | |
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. | |
Additional Inherited Members | |
![]() | |
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 } |
Ogre::D3D9RenderWindow::D3D9RenderWindow | ( | HINSTANCE | instance | ) |
Constructor.
instance | The application instance |
Ogre::D3D9RenderWindow::~D3D9RenderWindow | ( | ) |
|
virtual |
Creates & displays the new window.
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.
|
virtual |
Alter fullscreen mode options.
fullScreen | Whether to use fullscreen mode or not. |
widthPt | The new width to use |
heightPt | The new height to use |
Reimplemented from Ogre::RenderWindow.
Destroys the window.
Implements Ogre::RenderWindow.
Overridden from RenderTarget, flags invisible windows as inactive.
Reimplemented from Ogre::RenderWindow.
Indicates whether the window is visible (not minimized or obscured)
Reimplemented from Ogre::RenderWindow.
|
inlinevirtual |
Indicates whether the window has been closed by the user.
Implements Ogre::RenderWindow.
|
inline |
|
inline |
Indicates whether the window was set to hidden (not displayed)
Reimplemented from Ogre::RenderWindow.
Hide (or show) the window.
If called with hidden=true, this will make the window completely invisible to the user.
Reimplemented from Ogre::RenderWindow.
Enable or disable vertical sync for the RenderWindow.
Reimplemented from Ogre::RenderWindow.
|
virtual |
Indicates whether vertical sync is activated for the window.
Reimplemented from Ogre::RenderWindow.
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.
Returns the vertical sync interval.
Reimplemented from Ogre::RenderWindow.
Reposition the window.
Implements Ogre::RenderWindow.
Alter the size of the window.
Implements Ogre::RenderWindow.
Swaps the frame buffers to display the next frame.
Reimplemented from Ogre::RenderTarget.
|
inline |
IDirect3DDevice9 * Ogre::D3D9RenderWindow::getD3D9Device | ( | ) |
D3D9Device * Ogre::D3D9RenderWindow::getDevice | ( | ) |
void Ogre::D3D9RenderWindow::setDevice | ( | D3D9Device * | device | ) |
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. |
DISPLAYNAME | The X Server name for the connected display. |
ATOM | The X Atom used in client delete events. |
VIEW | Cocoa NSView* |
NSOPENGLCONTEXT | Cocoa NSOpenGLContext* |
NSOPENGLPIXELFORMAT | Cocoa NSOpenGLPixelFormat* |
name | The name of the attribute. |
pData | Pointer to memory of the right kind of structure to receive the info. |
Reimplemented from Ogre::RenderTarget.
|
virtual |
Overridden - see RenderTarget.
Implements Ogre::RenderTarget.
Implements Ogre::RenderTarget.
Notify that the window has been resized.
Reimplemented from Ogre::RenderWindow.
void Ogre::D3D9RenderWindow::buildPresentParameters | ( | D3DPRESENT_PARAMETERS * | presentParams | ) |
Build the presentation parameters used with this window.
|
virtual |
Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc.
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 |
Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)
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 |
Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.
Reimplemented from Ogre::RenderTarget.
IDirect3DSurface9 * Ogre::D3D9RenderWindow::getRenderSurface | ( | ) |
Accessor for render surface.
bool Ogre::D3D9RenderWindow::_getSwitchingFullscreen | ( | ) | const |
Are we in the middle of switching between fullscreen and windowed.
void Ogre::D3D9RenderWindow::_finishSwitchingFullscreen | ( | ) |
Indicate that fullscreen / windowed switching has finished.
bool Ogre::D3D9RenderWindow::isDepthBuffered | ( | ) | const |
Returns true if this window use depth buffer.
bool Ogre::D3D9RenderWindow::isNvPerfHUDEnable | ( | ) | const |
Returns true if this window should use NV Perf HUD adapter.
bool Ogre::D3D9RenderWindow::_validateDevice | ( | ) |
Validate the device for this window.
void Ogre::D3D9RenderWindow::adjustWindow | ( | unsigned int | clientWidth, |
unsigned int | clientHeight, | ||
unsigned int * | winWidth, | ||
unsigned int * | winHeight | ||
) |
void Ogre::D3D9RenderWindow::_validateStereo | ( | ) |
Validate the type of stereo that is enabled for this window.