#include <OgreVulkanXcbWindow.h>

Inheritance diagram for Ogre::VulkanXcbWindow:

Public Types
enum	Backend { BackendX11 = 1u << 0u }

enum	SwapchainStatus { SwapchainAcquired , SwapchainUsedInRendering , SwapchainPendingSwap , SwapchainReleased }

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

	~VulkanXcbWindow () override

void	_initialize (TextureGpuManager *textureGpuManager) override

void	_initialize (TextureGpuManager textureGpuManager, const NameValuePairList miscParams) override

void	_setDevice (VulkanDevice *device)

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

void	_setVisible (bool visible) override
	Internal method to notify the window it has been obscured or minimized. More...

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

void	acquireNextSwapchain ()

PixelFormatGpu	chooseSurfaceFormat (bool hwGamma)

void	createSwapchain ()

void	destroy () override

void	destroySwapchain ()

bool	getBorderless () const

void	getCustomAttribute (IdString name, void *pData) override

TextureGpu *	getDepthBuffer () const

uint32	getFrequencyDenominator () const

uint32	getFrequencyNumerator () const

uint32	getHeight () const

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

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

size_t	getNumSwapchains () const

PixelFormatGpu	getPixelFormat () const

uint32	getRequestedHeightPt () const

uint32	getRequestedWidthPt () const

SampleDescription	getSampleDescription () const

TextureGpu *	getStencilBuffer () const

VkImage	getSwapchainImage (size_t idx) const

TextureGpu *	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	isClosed () const override
	Indicates whether the window has been closed by the user. More...

bool	isFocused () const

bool	isFullscreen () const
	Returns true if we are currently in fullscreen mode. More...

bool	isHidden () const override
	Indicates whether the window was set to hidden (not displayed) More...

bool	isMultisample () const

bool	isPrimary () const

bool	isVisible () const override

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

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

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

void	parseSharedParams (const NameValuePairList *miscParams)

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

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

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

virtual void	setTitle (const String &title)

void	setVSync (bool vSync, uint32 vSyncInterval) override
	Turns VSync on/off. 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...

void	switchFullScreen (const bool bFullscreen)

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

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

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

Static Public Member Functions
static const char *	getRequiredExtensionName ()

Public Attributes
bool	mClosed

VulkanDevice *	mDevice

bool	mHwGamma

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

Member Enumeration Documentation

◆ Backend

enum Ogre::VulkanWindow::Backend

inherited

Enumerator
BackendX11

◆ SwapchainStatus

enum Ogre::VulkanWindow::SwapchainStatus

inherited

Enumerator
SwapchainAcquired	We already called VulkanWindow::acquireNextSwapchain. Can only go into this state if we're coming from SwapchainReleased
SwapchainUsedInRendering	We already called VulkanWindow::getImageAcquiredSemaphore. Further calls to getImageAcquiredSemaphore will return null. Ogre is rendering or intends to into this swapchain. Can only go into this state if we're coming from SwapchainAcquired
SwapchainPendingSwap	We've come from SwapchainUsedInRendering and are waiting for VulkanDevice::commitAndNextCommandBuffer to present us.
SwapchainReleased	We don't own a swapchain. Ogre cannot render to this window. This status should not last long unless we're not initialized yet.

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() [1/2]

void Ogre::VulkanWindow::_initialize ( TextureGpuManager * textureGpuManager )

overridevirtualinherited

Implements Ogre::Window.

◆ _initialize() [2/2]

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

overridevirtual

Implements Ogre::VulkanWindow.

◆ _setDevice()

void Ogre::VulkanWindow::_setDevice ( VulkanDevice * device )

inherited

◆ _setPrimary()

void Ogre::Window::_setPrimary ( )

inherited

Indicates that this is the primary window.

Only to be called by Ogre::Root

◆ _setVisible()

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

overridevirtual

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

Implements Ogre::Window.

◆ _swapBuffers()

void Ogre::VulkanWindow::_swapBuffers ( VkSemaphore queueFinishSemaphore )

inherited

Actually performs present.

Called by VulkanDevice::commitAndNextCommandBuffer

Parameters

queueFinishSemaphore Makes our present request wait until the Queue is done executing before we can present

◆ acquireNextSwapchain()

void Ogre::VulkanWindow::acquireNextSwapchain ( )

inherited

◆ chooseSurfaceFormat()

PixelFormatGpu Ogre::VulkanWindow::chooseSurfaceFormat ( bool hwGamma )

inherited

◆ createSwapchain()

void Ogre::VulkanWindow::createSwapchain ( )

inherited

◆ destroy()

void Ogre::VulkanXcbWindow::destroy ( )

overridevirtual

Reimplemented from Ogre::VulkanWindow.

◆ destroySwapchain()

void Ogre::VulkanWindow::destroySwapchain ( )

inherited

◆ getBorderless()

bool Ogre::Window::getBorderless ( ) const

inherited

◆ getCustomAttribute()

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

overridevirtual

Reimplemented from Ogre::VulkanWindow.

◆ getDepthBuffer()

TextureGpu* Ogre::Window::getDepthBuffer ( ) const

inherited

◆ getFrequencyDenominator()

uint32 Ogre::Window::getFrequencyDenominator ( ) const

inherited

◆ getFrequencyNumerator()

uint32 Ogre::Window::getFrequencyNumerator ( ) const

inherited

◆ getHeight()

uint32 Ogre::Window::getHeight ( ) const

inherited

◆ getImageAcquiredSemaphore()

VkSemaphore Ogre::VulkanWindow::getImageAcquiredSemaphore ( )

inherited

Returns null if getImageAcquiredSemaphore has already been called during this frame.

◆ getMetrics()

virtual void Ogre::Window::getMetrics	(	uint32 &	width,
		uint32 &	height,
		int32 &	left,
		int32 &	top
	)		const

virtualinherited

Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

Result is in pixels.

◆ getNumSwapchains()

size_t Ogre::VulkanWindow::getNumSwapchains ( ) const

inlineinherited

References Ogre::VulkanWindow::mSwapchainImages, and Ogre::FastArray< T >::size().

◆ getPixelFormat()

PixelFormatGpu Ogre::Window::getPixelFormat ( ) const

inherited

◆ getRequestedHeightPt()

uint32 Ogre::Window::getRequestedHeightPt ( ) const

inherited

◆ getRequestedWidthPt()

uint32 Ogre::Window::getRequestedWidthPt ( ) const

inherited

◆ getRequiredExtensionName()

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

static

◆ getSampleDescription()

SampleDescription Ogre::Window::getSampleDescription ( ) const

inherited

◆ getStencilBuffer()

TextureGpu* Ogre::Window::getStencilBuffer ( ) const

inherited

◆ getSwapchainImage()

VkImage Ogre::VulkanWindow::getSwapchainImage ( size_t idx ) const

inlineinherited

References Ogre::VulkanWindow::mSwapchainImages.

◆ getTexture()

TextureGpu* Ogre::Window::getTexture ( ) const

inherited

WARNING: Attempting to change the TextureGpu (e.g.

setResolution, setPixelFormat) is undefined behavior

◆ getTitle()

const String& Ogre::Window::getTitle ( ) const

inherited

◆ getViewPointToPixelScale()

virtual float Ogre::Window::getViewPointToPixelScale ( ) const

inlinevirtualinherited

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, and Ogre::MetalWindow.

◆ getVSync()

bool Ogre::Window::getVSync ( ) const

inherited

◆ getVSyncInterval()

uint32 Ogre::Window::getVSyncInterval ( ) const

inherited

◆ getWidth()

uint32 Ogre::Window::getWidth ( ) const

inherited

◆ isClosed()

bool Ogre::VulkanWindow::isClosed ( ) const

overridevirtualinherited

Indicates whether the window has been closed by the user.

Implements Ogre::Window.

◆ isFocused()

bool Ogre::Window::isFocused ( ) const

inherited

◆ isFullscreen()

bool Ogre::Window::isFullscreen ( ) const

inherited

Returns true if we are currently in fullscreen mode.

◆ isHidden()

bool Ogre::VulkanXcbWindow::isHidden ( ) const

overridevirtual

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

Implements Ogre::Window.

◆ isMultisample()

bool Ogre::Window::isMultisample ( ) const

inherited

◆ isPrimary()

bool Ogre::Window::isPrimary ( ) const

inherited

◆ isVisible()

bool Ogre::VulkanXcbWindow::isVisible ( ) const

overridevirtual

Implements Ogre::Window.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ parseSharedParams()

void Ogre::VulkanWindow::parseSharedParams ( const NameValuePairList * miscParams )

inherited

◆ 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
width	New width. Leave 0 if you don't care.
height	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.

◆ setBorderless()

virtual void Ogre::Window::setBorderless ( bool borderless )

virtualinherited

◆ setFocused()

virtual void Ogre::Window::setFocused ( bool focused )

virtualinherited

Reimplemented in Ogre::VulkanWin32Window, and Ogre::Win32Window.

◆ setFsaa()

virtual void Ogre::Window::setFsaa ( const String & fsaa )

inlinevirtualinherited

Set the FSAA mode 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.

Parameters

fsaa	Requesed FSAA mode (

See also: Root::createRenderWindow)

Reimplemented in Ogre::D3D11WindowSwapChainBased.

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

◆ setTitle()

virtual void Ogre::Window::setTitle ( const String & title )

virtualinherited

◆ setVSync()

void Ogre::VulkanWindow::setVSync	(	bool	vSync,
		uint32	vSyncInterval
	)

overridevirtualinherited

Turns VSync on/off.

Parameters

vSync
vSyncInterval	When true, specifies how often the screen should be updated. e.g. at 60hz: vSyncInterval = 1 then update at 60hz vSyncInterval = 2 then update at 30hz vSyncInterval = 3 then update at 15hz vSyncInterval = 4 then update at 7.5hz

If the 31st bit is set, i.e. 0x80000000, then lowest latency mode, aka mailbox, will be used (which doesn't limit the framerate)

Reimplemented from Ogre::Window.

◆ swapBuffers()

void Ogre::VulkanWindow::swapBuffers ( )

overridevirtualinherited

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.

Implements Ogre::Window.

◆ switchFullScreen()

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

◆ switchMode()

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

◆ wantsToGoFullscreen()

bool Ogre::Window::wantsToGoFullscreen ( ) const

inherited

Returns true if we are in windowed mode right now, but want to go fullscreen.

◆ wantsToGoWindowed()

bool Ogre::Window::wantsToGoWindowed ( ) const

inherited

Returns true if we are in fullscreen mode right now, but want to go windowed mode.

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

Member Data Documentation

◆ mClosed

bool Ogre::VulkanWindow::mClosed

inherited

◆ mDevice

VulkanDevice* Ogre::VulkanWindow::mDevice

inherited

◆ mHwGamma

bool Ogre::VulkanWindow::mHwGamma

inherited

◆ mLowestLatencyVSync

bool Ogre::VulkanWindow::mLowestLatencyVSync

inherited

◆ mRebuildingSwapchain

bool Ogre::VulkanWindow::mRebuildingSwapchain

inherited

◆ mSuboptimal

bool Ogre::VulkanWindow::mSuboptimal

inherited

◆ mSurfaceKHR

VkSurfaceKHR Ogre::VulkanWindow::mSurfaceKHR

inherited

◆ mSwapchain

VkSwapchainKHR Ogre::VulkanWindow::mSwapchain

inherited

◆ mSwapchainImages

FastArray<VkImage> Ogre::VulkanWindow::mSwapchainImages

inherited

Referenced by Ogre::VulkanWindow::getNumSwapchains(), and Ogre::VulkanWindow::getSwapchainImage().

◆ mSwapchainSemaphore

VkSemaphore Ogre::VulkanWindow::mSwapchainSemaphore

inherited

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

Makes Queue execution wait until the acquired image is done presenting

◆ mSwapchainStatus

SwapchainStatus Ogre::VulkanWindow::mSwapchainStatus

inherited

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

OgreVulkanXcbWindow.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Enumeration Documentation

◆ Backend

◆ SwapchainStatus

Constructor & Destructor Documentation

◆ VulkanXcbWindow()

◆ ~VulkanXcbWindow()

Member Function Documentation

◆ _initialize() [1/2]

◆ _initialize() [2/2]

◆ _setDevice()

◆ _setPrimary()

◆ _setVisible()

◆ _swapBuffers()

◆ acquireNextSwapchain()

◆ chooseSurfaceFormat()

◆ createSwapchain()

◆ destroy()

◆ destroySwapchain()

◆ getBorderless()

◆ getCustomAttribute()

◆ getDepthBuffer()

◆ getFrequencyDenominator()

◆ getFrequencyNumerator()

◆ getHeight()

◆ getImageAcquiredSemaphore()

◆ getMetrics()

◆ getNumSwapchains()

◆ getPixelFormat()

◆ getRequestedHeightPt()

◆ getRequestedWidthPt()

◆ getRequiredExtensionName()

◆ getSampleDescription()

◆ getStencilBuffer()

◆ getSwapchainImage()

◆ getTexture()

◆ getTitle()

◆ getViewPointToPixelScale()

◆ getVSync()

◆ getVSyncInterval()

◆ getWidth()

◆ isClosed()

◆ isFocused()

◆ isFullscreen()

◆ isHidden()

◆ isMultisample()

◆ isPrimary()

◆ isVisible()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ parseSharedParams()

◆ reposition()

◆ requestFullscreenSwitch()

◆ requestResolution()

◆ setBorderless()

◆ setFocused()

◆ setFsaa()

◆ setHidden()

◆ setTitle()

◆ setVSync()

◆ swapBuffers()

◆ switchFullScreen()

◆ switchMode()

◆ wantsToGoFullscreen()

◆ wantsToGoWindowed()

◆ windowMovedOrResized()

Member Data Documentation

◆ mClosed

◆ mDevice