OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::D3D11Window Class Reference

#include <OgreD3D11Window.h>

+ Inheritance diagram for Ogre::D3D11Window:

Public Member Functions

 D3D11Window (const String &title, uint32 width, uint32 height, bool fullscreenMode, PixelFormatGpu depthStencilFormat, const NameValuePairList *miscParams, D3D11Device &device, D3D11RenderSystem *renderSystem)
 
 ~D3D11Window () override
 
void _setVisible (bool visible) override
 Internal method to notify the window it has been obscured or minimized. More...
 
void destroy () override
 
void getCustomAttribute (IdString name, void *pData) override
 
bool isClosed () const override
 Indicates whether the window has been closed by the user. More...
 
bool isHidden () const override
 Indicates whether the window was set to hidden (not displayed) More...
 
void reposition (int leftPt, int topPt) override
 
void setHidden (bool hidden) override
 Hide (or show) the window. More...
 
- Public Member Functions inherited from Ogre::Window
 Window (const String &title, uint32 widthPt, uint32 heightPt, bool fullscreenMode)
 
virtual ~Window ()
 
virtual void _initialize (TextureGpuManager *textureGpuManager)=0
 
void _setPrimary ()
 Indicates that this is the primary window. More...
 
virtual bool canDownloadData () const
 Returns true if you can download to CPU (i.e. More...
 
bool getBorderless () const
 
TextureGpugetDepthBuffer () const
 
uint32 getFrequencyDenominator () const
 
uint32 getFrequencyNumerator () const
 
uint32 getHeight () const
 
virtual void getMetrics (uint32 &width, uint32 &height, int32 &left, int32 &top) const
 Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More...
 
PixelFormatGpu getPixelFormat () const
 
uint32 getRequestedHeightPt () const
 
uint32 getRequestedWidthPt () const
 
SampleDescription getSampleDescription () const
 
TextureGpugetStencilBuffer () const
 
TextureGpugetTexture () const
 WARNING: Attempting to change the TextureGpu (e.g. More...
 
const StringgetTitle () const
 
virtual float getViewPointToPixelScale () const
 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...
 
bool getVSync () const
 
uint32 getVSyncInterval () const
 
uint32 getWidth () const
 
bool isFocused () const
 
bool isFullscreen () const
 Returns true if we are currently in fullscreen mode. More...
 
virtual bool isManualSwapRelease () const
 Returns the value set by setManualSwapRelease when supported. More...
 
bool isMultisample () const
 
bool isPrimary () const
 
virtual bool isVisible () const =0
 
virtual void performManualRelease ()
 See Window::setManualSwapRelease. More...
 
virtual void reposition (int32 leftPt, int32 topPt)=0
 
virtual void requestFullscreenSwitch (bool goFullscreen, bool borderless, uint32 monitorIdx, uint32 widthPt, uint32 heightPt, uint32 frequencyNumerator, uint32 frequencyDenominator)
 Requests to toggle between fullscreen and windowed mode. More...
 
virtual void requestResolution (uint32 widthPt, uint32 heightPt)
 Requests a change in resolution. More...
 
virtual void setBorderless (bool borderless)
 
virtual void setFocused (bool focused)
 
virtual void setFsaa (const String &fsaa)
 Set the FSAA mode to be used if hardware support it. More...
 
virtual void setManualSwapRelease (bool bManualRelease)
 Metal doesn't want us to hold on to a drawable after presenting. More...
 
virtual void setTitle (const String &title)
 
virtual void setVSync (bool vSync, uint32 vSyncInterval)
 Turns VSync on/off. More...
 
virtual void setWantsToDownload (bool bWantsToDownload)
 On Metal you must call this function and set it to true in order to take pictures. More...
 
virtual void swapBuffers ()=0
 
bool wantsToGoFullscreen () const
 Returns true if we are in windowed mode right now, but want to go fullscreen. More...
 
bool wantsToGoWindowed () const
 Returns true if we are in fullscreen mode right now, but want to go windowed mode. More...
 
virtual void windowMovedOrResized ()
 Notify that the window has been resized. More...
 

Constructor & Destructor Documentation

◆ D3D11Window()

Ogre::D3D11Window::D3D11Window ( const String title,
uint32  width,
uint32  height,
bool  fullscreenMode,
PixelFormatGpu  depthStencilFormat,
const NameValuePairList miscParams,
D3D11Device device,
D3D11RenderSystem renderSystem 
)

◆ ~D3D11Window()

Ogre::D3D11Window::~D3D11Window ( )
override

Member Function Documentation

◆ _setVisible()

void Ogre::D3D11Window::_setVisible ( bool  visible)
inlineoverridevirtual

Internal method to notify the window it has been obscured or minimized.

Implements Ogre::Window.

◆ destroy()

void Ogre::D3D11Window::destroy ( )
overridevirtual

Implements Ogre::Window.

Reimplemented in Ogre::D3D11WindowSwapChainBased.

◆ getCustomAttribute()

void Ogre::D3D11Window::getCustomAttribute ( IdString  name,
void *  pData 
)
overridevirtual

Reimplemented from Ogre::Window.

◆ isClosed()

bool Ogre::D3D11Window::isClosed ( ) const
inlineoverridevirtual

Indicates whether the window has been closed by the user.

Implements Ogre::Window.

◆ isHidden()

bool Ogre::D3D11Window::isHidden ( ) const
inlineoverridevirtual

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

Implements Ogre::Window.

◆ reposition()

void Ogre::D3D11Window::reposition ( int  leftPt,
int  topPt 
)
inlineoverride

◆ setHidden()

void Ogre::D3D11Window::setHidden ( bool  hidden)
inlineoverridevirtual

Hide (or show) the window.

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

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

Implements Ogre::Window.


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