#include <OgreVulkanXcbWindow.h>

Inheritance diagram for Ogre::VulkanXcbWindow:

Public Member Functions
	VulkanXcbWindow (const String &title, uint32 width, uint32 height, bool fullscreenMode)

	~VulkanXcbWindow () override

void	_initialize (TextureGpuManager textureGpuManager, const NameValuePairList miscParams) 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	isHidden () const override
	Indicates whether the window was set to hidden (not displayed) More...

bool	isVisible () const override

void	reposition (int32 left, int32 top) override

void	requestFullscreenSwitch (bool goFullscreen, bool borderless, uint32 monitorIdx, uint32 width, uint32 height, uint32 frequencyNumerator, uint32 frequencyDenominator) override
	Requests to toggle between fullscreen and windowed mode. More...

void	requestResolution (uint32 width, uint32 height) override
	Requests a change in resolution. More...

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

void	switchFullScreen (const bool bFullscreen)

void	switchMode (uint32 width, uint32 height, uint32 frequencyNum, uint32 frequencyDen)

void	windowMovedOrResized () override
	Notify that the window has been resized. More...

Public Member Functions inherited from Ogre::VulkanWindowSwapChainBased
	VulkanWindowSwapChainBased (const String &title, uint32 width, uint32 height, bool fullscreenMode)

	~VulkanWindowSwapChainBased () override

void	_swapBuffers (VkSemaphore queueFinishSemaphore)
	Actually performs present. More...

void	acquireNextSwapchain ()

bool	canDownloadData () const override
	Returns true if you can download to CPU (i.e. More...

PixelFormatGpu	chooseSurfaceFormat (bool hwGamma)

virtual void	createSwapchain ()

virtual void	destroySurface ()

virtual void	destroySwapchain (bool finalDestruction=false)

VkSemaphore	getImageAcquiredSemaphore ()
	Returns null if getImageAcquiredSemaphore has already been called during this frame. More...

size_t	getNumSwapchains () const

VkImage	getSwapchainImage (size_t idx) const

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

void	notifyDeviceLost () override

void	notifyDeviceRestored (unsigned pass) override

void	parseSharedParams (const NameValuePairList *miscParams)

void	setVSync (bool vSync, uint32 vSyncInterval) override
	Turns VSync on/off. More...

void	setWantsToDownload (bool bWantsToDownload) override
	On Metal you must call this function and set it to true in order to take pictures. More...

void	swapBuffers () override
	Tells our VulkanDevice that the next commitAndNextCommandBuffer call should present us Calling swapBuffers during the command buffer that is rendering to us is key for good performance; otherwise Ogre may split the commands that render to this window and the command that presents this window into two queue submissions. More...

Public Member Functions inherited from Ogre::VulkanWindow
	VulkanWindow (const String &title, uint32 width, uint32 height, bool fullscreenMode)

void	_setDevice (VulkanDevice *device)

Public Member Functions inherited from Ogre::Window
	Window (const String &title, uint32 widthPt, uint32 heightPt, bool fullscreenMode)

virtual	~Window ()

virtual void	_initialize (TextureGpuManager textureGpuManager, const NameValuePairList ogre_nullable miscParams)=0

void	_setPrimary ()
	Indicates that this is the primary window. More...

bool	getBorderless () const

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 String &	getTitle () 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	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)

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

Static Public Member Functions
static const char *	getRequiredExtensionName ()

Additional Inherited Members
Public Types inherited from Ogre::VulkanWindowSwapChainBased
enum	Backend { BackendX11 = 1u << 0u }

enum	SwapchainStatus { SwapchainAcquired , SwapchainUsedInRendering , SwapchainPendingSwap , SwapchainReleased }

Public Attributes inherited from Ogre::VulkanWindowSwapChainBased
bool	mCanDownloadData

bool	mClosed

bool	mEnablePreTransform

bool	mLowestLatencyVSync

bool	mRebuildingSwapchain

bool	mSuboptimal

VkSurfaceKHR	mSurfaceKHR

VkSwapchainKHR	mSwapchain

FastArray< VkImage >	mSwapchainImages

VkSemaphore	mSwapchainSemaphore
	Note: We need a semaphore per frame, not per swapchain. More...

SwapchainStatus	mSwapchainStatus

Constructor & Destructor Documentation

◆ VulkanXcbWindow()

Ogre::VulkanXcbWindow::VulkanXcbWindow	(	const String &	title,
		uint32	width,
		uint32	height,
		bool	fullscreenMode
	)

◆ ~VulkanXcbWindow()

Ogre::VulkanXcbWindow::~VulkanXcbWindow ( )

override

Member Function Documentation

◆ _initialize()

void Ogre::VulkanXcbWindow::_initialize	(	TextureGpuManager *	textureGpuManager,
		const NameValuePairList *	miscParams
	)

override

◆ _setVisible()

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

overridevirtual

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

Implements Ogre::Window.

◆ destroy()

void Ogre::VulkanXcbWindow::destroy ( )

overridevirtual

Reimplemented from Ogre::VulkanWindowSwapChainBased.

◆ getCustomAttribute()

void Ogre::VulkanXcbWindow::getCustomAttribute	(	IdString	name,
		void *	pData
	)

overridevirtual

Reimplemented from Ogre::VulkanWindowSwapChainBased.

◆ getRequiredExtensionName()

static const char* Ogre::VulkanXcbWindow::getRequiredExtensionName ( )

static

◆ isHidden()

bool Ogre::VulkanXcbWindow::isHidden ( ) const

overridevirtual

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

Implements Ogre::Window.

◆ isVisible()

bool Ogre::VulkanXcbWindow::isVisible ( ) const

overridevirtual

Implements Ogre::Window.

◆ reposition()

void Ogre::VulkanXcbWindow::reposition	(	int32	left,
		int32	top
	)

overridevirtual

Implements Ogre::Window.

◆ requestFullscreenSwitch()

void Ogre::VulkanXcbWindow::requestFullscreenSwitch	(	bool	goFullscreen,
		bool	borderless,
		uint32	monitorIdx,
		uint32	widthPt,
		uint32	heightPt,
		uint32	frequencyNumerator,
		uint32	frequencyDenominator
	)

overridevirtual

Requests to toggle between fullscreen and windowed mode.

Remarks: Use wantsToGoFullscreen & wantsToGoWindowed to know what you've requested. Same remarks as requestResolution apply: If we request to go fullscreen, wantsToGoFullscreen will return true. But if get word from OS saying we stay in windowed mode, wantsToGoFullscreen will start returning false.

Parameters

goFullscreen	True to go fullscreen, false to go windowed mode.
borderless	Whether to be borderless. Only useful if goFullscreen == false;
monitorIdx
widthPt	New width. Leave 0 if you don't care.
heightPt	New height. Leave 0 if you don't care.
frequencyNumerator	New frequency (fullscreen only). Leave 0 if you don't care.
frequencyDenominator	New frequency (fullscreen only). Leave 0 if you don't care.

Reimplemented from Ogre::Window.

◆ requestResolution()

void Ogre::VulkanXcbWindow::requestResolution	(	uint32	widthPt,
		uint32	heightPt
	)

overridevirtual

Requests a change in resolution.

Change is not immediate. Use getRequestedWidthPt & getRequestedHeightPt if you need to know what you've requested, but beware you may not get that resolution, and once we get word from the OS, getRequested{Width/Height}Pt will change again so that getWidth == getRequestedWidthPt * getViewPointToPixelScale.

Reimplemented from Ogre::Window.

◆ setHidden()

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

overridevirtual

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.

◆ switchFullScreen()

void Ogre::VulkanXcbWindow::switchFullScreen ( const bool bFullscreen )

◆ switchMode()

void Ogre::VulkanXcbWindow::switchMode	(	uint32	width,
		uint32	height,
		uint32	frequencyNum,
		uint32	frequencyDen
	)

◆ windowMovedOrResized()

void Ogre::VulkanXcbWindow::windowMovedOrResized ( )

overridevirtual

Notify that the window has been resized.

Remarks: You don't need to call this unless you created the window externally.

Reimplemented from Ogre::Window.

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

OgreVulkanXcbWindow.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ VulkanXcbWindow()

◆ ~VulkanXcbWindow()

Member Function Documentation

◆ _initialize()

◆ _setVisible()

◆ destroy()

◆ getCustomAttribute()

◆ getRequiredExtensionName()

◆ isHidden()

◆ isVisible()

◆ reposition()

◆ requestFullscreenSwitch()

◆ requestResolution()

◆ setHidden()

◆ switchFullScreen()

◆ switchMode()

◆ windowMovedOrResized()