![]() |
OGRE 2.1
Object-Oriented Graphics Rendering Engine
|
#include <OgreWin32Window.h>
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 | |
Win32Window (Win32GLSupport &glsupport) | |
~Win32Window () | |
virtual void | _beginUpdate () |
Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. | |
virtual void | _detachDepthBuffer () |
Detaches DepthBuffer without notifying it from the detach. | |
virtual void | _endUpdate () |
Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. | |
virtual Impl * | _getImpl () |
Get rendersystem specific interface for this RenderTarget. | |
void | _setMipmapsUpdated (void) |
void | _updateViewportCullPhase01 (Viewport *viewport, Camera *camera, const Camera *lodCamera, uint8 firstRq, uint8 lastRq) |
virtual void | _updateViewportRenderPhase02 (Viewport *viewport, Camera *camera, const Camera *lodCamera, uint8 firstRq, uint8 lastRq, bool updateStatistics) |
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 (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, bool exactFormatMatch) |
Returns false if couldn't attach. | |
virtual void | copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer) |
Overridden - see RenderTarget. | |
OGRE_DEPRECATED 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. | |
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 size_t | getBatchCount (void) const |
Gets the number of batches rendered in the last update() call. | |
void | getCustomAttribute (const String &name, void *pData) |
Gets a custom (maybe platform-specific) attribute. | |
DepthBuffer * | getDepthBuffer () const |
uint16 | getDepthBufferPool () const |
Returns the pool ID this RenderTarget should query from. | |
PixelFormat | getDesiredDepthBufferFormat (void) const |
virtual bool | getForceDisableColourWrites (void) const |
Used by depth texture views which need to disable colour writes when rendering to it PF_NULL targets can be identified because they set this value to true and have no depth buffers attached. | |
PixelFormat | getFormat (void) const |
virtual void | getFormatsForPso (PixelFormat outFormats[OGRE_MAX_MULTIPLE_RENDER_TARGETS], bool outHwGamma[OGRE_MAX_MULTIPLE_RENDER_TARGETS]) 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 (. | |
HDC | getHDC () const |
virtual uint32 | getHeight (void) const |
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 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. | |
virtual const FrameStats & | getStatistics (void) const |
virtual size_t | getTriangleCount (void) const |
Gets the number of triangles rendered in the last update() call. | |
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. | |
virtual Viewport * | getViewport (unsigned short index) |
Retrieves a pointer to the viewport with the given index. | |
unsigned int | getVSyncInterval () const |
Returns the vertical sync interval. | |
virtual uint32 | getWidth (void) const |
HWND | getWindowHandle () const |
bool | isActive (void) const |
Overridden from RenderTarget, flags invisible windows as inactive. | |
bool | isClosed (void) 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 | isFsaaResolveDirty (void) const |
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 | isMipmapsDirty (void) const |
virtual bool | isPrimary (void) const |
Indicates whether the window is the primary window. | |
virtual bool | isRenderWindow (void) const |
Whether our derived class is RenderWindow. | |
virtual bool | isStereoEnabled (void) const |
Indicates whether stereo is currently enabled for this target. | |
bool | isVisible () const |
Indicates whether the window is visible (not minimized or obscured) | |
bool | isVSyncEnabled () const |
Indicates whether vertical sync is activated for the window. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
bool | prefersDepthTexture () const |
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 (Viewport *vp) |
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. | |
void | setDeactivateOnFocusChange (bool deactivate) |
Indicates whether the window will automatically deactivate itself when it loses focus. | |
virtual void | setDepthBufferPool (uint16 poolId) |
Sets the pool ID this RenderTarget should query from. | |
void | setDesiredDepthBufferFormat (PixelFormat desiredDepthBufferFormat) |
Set the desired depth buffer format. | |
virtual void | setFSAA (uint fsaa, const String &fsaaHint) |
Set the level of multisample AA to be used if hardware support it. | |
virtual void | setFsaaResolved () |
virtual void | setFsaaResolveDirty (void) |
void | setFullscreen (bool fullScreen, unsigned int width, unsigned int height) |
Alter fullscreen mode options. | |
void | setHidden (bool hidden) |
Hide (or show) the window. | |
void | setPreferDepthTexture (bool preferDepthTexture) |
Whether this RT should be attached to a depth texture, or a regular depth buffer. | |
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 | windowMovedOrResized (void) |
Notify that the window has been resized. | |
void | writeContentsToFile (const String &filename, PixelFormat format=PF_UNKNOWN) |
Writes the current contents of the render target to the named file. | |
virtual String | writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix, PixelFormat format=PF_UNKNOWN) |
Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. | |
|
inherited |
|
inherited |
Ogre::Win32Window::Win32Window | ( | Win32GLSupport & | glsupport | ) |
Ogre::Win32Window::~Win32Window | ( | ) |
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 in Ogre::D3D9RenderWindow.
Detaches DepthBuffer without notifying it from the detach.
Useful when called from the DepthBuffer while it iterates through attached RenderTargets (
Reimplemented in Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GL3PlusFBORenderTexture, and Ogre::GLES2FBOMultiRenderTarget.
Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.
Reimplemented in Ogre::D3D9RenderWindow.
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.
|
inherited |
|
virtualinherited |
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 in Ogre::D3D9RenderWindow.
|
virtualinherited |
Add a listener to this RenderTarget which will be called back before & after rendering.
|
virtualinherited |
Adds a viewport to the rendering target.
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::Win32Window::adjustWindow | ( | unsigned int | clientWidth, |
unsigned int | clientHeight, | ||
unsigned int * | winWidth, | ||
unsigned int * | winHeight | ||
) |
|
virtualinherited |
Returns false if couldn't attach.
Reimplemented in Ogre::D3D11DepthTextureTarget, Ogre::D3D11NullTextureTarget, Ogre::GL3PlusDepthTextureTarget, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GL3PlusFBORenderTexture, Ogre::GL3PlusNullTextureTarget, Ogre::GLES2DepthTextureTarget, Ogre::GLES2FBOMultiRenderTarget, Ogre::GLES2NullTextureTarget, Ogre::MetalDepthTextureTarget, and Ogre::MetalNullTextureTarget.
|
virtual |
Overridden - see RenderTarget.
Implements Ogre::RenderTarget.
|
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::RenderTarget::copyContentsToMemory().
Referenced by Ogre::RenderTarget::copyContentsToMemory().
|
virtual |
Creates & displays the new window.
width | The width of the window in view points. |
height | 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.
Destroys the window.
Implements Ogre::RenderWindow.
Gets the number of batches rendered in the last update() call.
Gets a custom (maybe platform-specific) attribute.
name | The name of the attribute. |
pData | Pointer to memory of the right kind of structure to receive the info. |
Reimplemented from Ogre::RenderTarget.
|
inherited |
|
inherited |
Returns the pool ID this RenderTarget should query from.
|
inherited |
Used by depth texture views which need to disable colour writes when rendering to it PF_NULL targets can be identified because they set this value to true and have no depth buffers attached.
Reimplemented in Ogre::D3D11DepthTextureTarget, Ogre::D3D11NullTextureTarget, Ogre::GL3PlusDepthTextureTarget, Ogre::GL3PlusNullTextureTarget, Ogre::GLES2DepthTextureTarget, Ogre::GLES2NullTextureTarget, Ogre::MetalDepthTextureTarget, and Ogre::MetalNullTextureTarget.
|
inherited |
|
virtualinherited |
Indicates whether multisampling is performed on rendering and at what level.
Gets the FSAA hint (.
|
inline |
Reimplemented in Ogre::CocoaWindow.
|
virtualinherited |
Retrieve information about the render target.
|
virtualinherited |
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.
Result is in pixels.
Retrieve target's name.
Returns the number of viewports attached to this target.
Gets the priority of a render target.
|
virtualinherited |
Gets the number of triangles rendered in the last update() call.
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.
Such points have constant density ~ 100 points per inch (probably 96 on Windows and 72 on Mac), that is independent of pixel density of real display, and are used through the all windowing system.
Sometimes, such view points are choosen bigger for output devices that are viewed from larger distances, like 30" TV comparing to 30" monitor, therefore maintaining constant points angular density rather than constant linear density.
In any case, all such windowing system provides the way to convert such view points to pixels, be it DisplayProperties::LogicalDpi on WinRT or backingScaleFactor on MacOSX. We use pixels consistently through the Ogre, but window/view management functions takes view points for convenience, as does the rest of windowing system. Such parameters are named using xxxxPt pattern, and should not be mixed with pixels without being converted using getViewPointToPixelScale() function.
Sometimes such scale factor can change on-the-fly, for example if window is dragged to monitor with different DPI. In such situation, window size in view points is usually preserved by windowing system, and Ogre should adjust pixel size of RenderWindow.
Reimplemented in Ogre::CocoaWindow.
Retrieves a pointer to the viewport with the given index.
Returns the vertical sync interval.
Reimplemented from Ogre::RenderWindow.
Reimplemented in Ogre::CocoaWindow.
|
inline |
Overridden from RenderTarget, flags invisible windows as inactive.
Reimplemented from Ogre::RenderWindow.
Indicates whether the window has been closed by the user.
Implements Ogre::RenderWindow.
|
inherited |
Returns true if the window will automatically de-activate itself when it loses focus.
Returns true if window is running in fullscreen mode.
Reimplemented in Ogre::SDLWindow.
Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space.
This is the exact opposite conversion of what is indicated by Texture::isHardwareGammaEnabled, and can only be enabled on creation of the render target. For render windows, it's enabled through the 'gamma' creation misc parameter. For textures, it is enabled through the hwGamma parameter to the create call.
Indicates whether the window was set to hidden (not displayed)
Reimplemented from Ogre::RenderWindow.
Indicates whether the window is the primary window.
The primary window is special in that it is destroyed when ogre is shut down, and cannot be destroyed directly. This is the case because it holds the context for vertex, index buffers and textures.
Reimplemented from Ogre::RenderTarget.
Whether our derived class is RenderWindow.
Reimplemented from Ogre::RenderTarget.
Indicates whether stereo is currently enabled for this target.
Default is false.
Indicates whether the window is visible (not minimized or obscured)
Reimplemented from Ogre::RenderWindow.
|
virtual |
Indicates whether vertical sync is activated for the window.
Reimplemented from Ogre::RenderWindow.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
inherited |
Removes all listeners from this instance.
Removes all viewports on this target.
|
virtualinherited |
Removes a RenderTargetListener previously registered using addListener.
Removes a viewport at a given Z-order.
Reposition the window.
Implements Ogre::RenderWindow.
Implements Ogre::RenderTarget.
Resets saved frame-rate statistices.
Alter the size of the window.
Implements Ogre::RenderWindow.
Used to set the active state of the render target.
Reimplemented from Ogre::RenderTarget.
Indicates whether the window will automatically deactivate itself when it loses focus.
deactivate | a value of 'true' will cause the window to deactivate itself when it loses focus. 'false' will allow it to continue to render even when window focus is lost. |
Sets the pool ID this RenderTarget should query from.
Default value is POOL_DEFAULT. Set to POOL_NO_DEPTH to avoid using a DepthBuffer (or manually controlling it)
Reimplemented in Ogre::D3D11DepthTextureTarget, Ogre::GL3PlusDepthTextureTarget, Ogre::GLES2DepthTextureTarget, and Ogre::MetalDepthTextureTarget.
|
inherited |
Set the desired depth buffer format.
desiredDepthBufferFormat | Must be one of the following: PF_D24_UNORM_S8_UINT PF_D24_UNORM_X8 PF_D16_UNORM PF_D32_FLOAT PF_D32_FLOAT_X24_S8_UINT |
|
inlinevirtualinherited |
Set the level of multisample AA to be used if hardware support it.
This option will be ignored if the hardware does not support it or setting can not be changed on the fly on per-target level.
fsaa | The number of samples |
fsaaHint | Any hinting text ( |
Reimplemented in Ogre::D3D11RenderWindowBase, and Ogre::D3D11RenderWindowSwapChainBased.
|
virtual |
Alter fullscreen mode options.
fullScreen | Whether to use fullscreen mode or not. |
width | The new width to use |
height | The new height to use |
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.
Whether this RT should be attached to a depth texture, or a regular depth buffer.
preferDepthTexture | True to use depth textures. False otherwise (default). |
Sets the priority of this render target in relation to the others.
Set the visibility state.
Reimplemented in Ogre::GLXWindow, and Ogre::EGLWindow.
Enable or disable vertical sync for the RenderWindow.
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.
|
inlinevirtualinherited |
Override since windows don't usually have alpha.
Reimplemented from Ogre::RenderTarget.
References Ogre::PF_BYTE_RGB.
Swaps the frame buffers to display the next frame.
Reimplemented from Ogre::RenderTarget.
Notify that the window has been resized.
Reimplemented from Ogre::RenderWindow.
|
inherited |
Writes the current contents of the render target to the named file.
If format is unspecified (PF_UNKNOWN), the most suitable one is automatically chosen.
|
virtualinherited |
Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.