OGRE-Next  4.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::VulkanWindowNull Class Reference

#include <OgreVulkanWindow.h>

+ Inheritance diagram for Ogre::VulkanWindowNull:

Public Member Functions

 VulkanWindowNull (const String &title, uint32 width, uint32 height, bool fullscreenMode)
 ~VulkanWindowNull () override
void _initialize (TextureGpuManager *textureGpuManager, const NameValuePairList *ogre_nullable miscParams) override
void _setVisible (bool visible) override
 Internal method to notify the window it has been obscured or minimized. More...
void destroy () 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...
bool isVisible () const override
void reposition (int32 leftPt, int32 topPt) override
void setHidden (bool hidden) override
 Hide (or show) the window. More...
void swapBuffers () override
- Public Member Functions inherited from Ogre::VulkanWindow
 VulkanWindow (const String &title, uint32 width, uint32 height, bool fullscreenMode)
void _initialize (TextureGpuManager *textureGpuManager) override
void _setDevice (VulkanDevice *device)
- Public Member Functions inherited from Ogre::Window
 Window (const String &title, uint32 widthPt, uint32 heightPt, bool fullscreenMode)
virtual ~Window ()
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
virtual void getCustomAttribute (IdString name, void *pData)
TextureGpu *ogre_nullable getDepthBuffer () 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
TextureGpu *ogre_nullable getStencilBuffer () const
TextureGpu *ogre_nullable getTexture () 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 void performManualRelease ()
 See Window::setManualSwapRelease. More...
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...
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

◆ VulkanWindowNull()

Ogre::VulkanWindowNull::VulkanWindowNull ( const String title,
uint32  width,
uint32  height,
bool  fullscreenMode 

◆ ~VulkanWindowNull()

Ogre::VulkanWindowNull::~VulkanWindowNull ( )

Member Function Documentation

◆ _initialize()

void Ogre::VulkanWindowNull::_initialize ( TextureGpuManager textureGpuManager,
const NameValuePairList *ogre_nullable  miscParams 

Implements Ogre::VulkanWindow.

◆ _setVisible()

void Ogre::VulkanWindowNull::_setVisible ( bool  visible)

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

Implements Ogre::Window.

◆ destroy()

void Ogre::VulkanWindowNull::destroy ( )

Implements Ogre::Window.

◆ isClosed()

bool Ogre::VulkanWindowNull::isClosed ( ) const

Indicates whether the window has been closed by the user.

Implements Ogre::Window.

◆ isHidden()

bool Ogre::VulkanWindowNull::isHidden ( ) const

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

Implements Ogre::Window.

◆ isVisible()

bool Ogre::VulkanWindowNull::isVisible ( ) const

Implements Ogre::Window.

◆ reposition()

void Ogre::VulkanWindowNull::reposition ( int32  leftPt,
int32  topPt 

Implements Ogre::Window.

◆ setHidden()

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

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.

Implements Ogre::Window.

◆ swapBuffers()

void Ogre::VulkanWindowNull::swapBuffers ( )

Implements Ogre::Window.

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