#include <GHOST_ContextVK.hh>

Inherits GHOST_Context.

Public Member Functions
	GHOST_ContextVK (const GHOST_ContextParams &context_params, GHOST_TVulkanPlatformType platform, Window window, Display display, wl_surface wayland_surface, wl_display wayland_display, const GHOST_ContextVK_WindowInfo wayland_window_info, int contextMajorVersion, int contextMinorVersion, const GHOST_GPUDevice &preferred_device, const GHOST_WindowHDRInfo *hdr_info_=nullptr)
	~GHOST_ContextVK () override
GHOST_TSuccess	swapBufferAcquire () override
GHOST_TSuccess	swapBufferRelease () override
GHOST_TSuccess	activateDrawingContext () override
GHOST_TSuccess	releaseDrawingContext () override
GHOST_TSuccess	initializeDrawingContext () override
GHOST_TSuccess	releaseNativeHandles () override
GHOST_TSuccess	getVulkanHandles (GHOST_VulkanHandles &r_handles) override
GHOST_TSuccess	getVulkanSwapChainFormat (GHOST_VulkanSwapChainData *r_swap_chain_data) override
GHOST_TSuccess	setVulkanSwapBuffersCallbacks (std::function< void(const GHOST_VulkanSwapChainData )> swap_buffer_draw_callback, std::function< void(void)> swap_buffer_acquired_callback, std::function< void(GHOST_VulkanOpenXRData )> openxr_acquire_framebuffer_image_callback, std::function< void(GHOST_VulkanOpenXRData *)> openxr_release_framebuffer_image_callback) override
GHOST_TSuccess	setSwapInterval (int) override
GHOST_TSuccess	getSwapInterval (int &) override
bool	isUpsideDown () const override
Public Member Functions inherited from GHOST_Context
	GHOST_Context (const GHOST_ContextParams &context_params)
	~GHOST_Context () override
virtual GHOST_TSuccess	updateDrawingContext ()
void *	getUserData ()
void	setUserData (void *user_data)
bool	isStereoVisual () const
virtual GHOST_TVSyncModes	getVSync ()
unsigned int	getDefaultFramebuffer () override
Public Member Functions inherited from GHOST_IContext
virtual	~GHOST_IContext ()=default

Friends
class	GHOST_XrGraphicsBindingVulkan
class	GHOST_XrGraphicsBindingVulkanD3D

Additional Inherited Members
Static Public Member Functions inherited from GHOST_Context
static GHOST_Context *	getActiveDrawingContext ()
Static Public Member Functions inherited from GHOST_IContext
static GHOST_IContext *	getActiveDrawingContext ()
Protected Attributes inherited from GHOST_Context
GHOST_ContextParams	context_params_
void *	user_data_ = nullptr
Static Protected Attributes inherited from GHOST_Context
static GHOST_Context *	active_context_

Detailed Description

Definition at line 96 of file GHOST_ContextVK.hh.

Constructor & Destructor Documentation

◆ GHOST_ContextVK()

GHOST_ContextVK::GHOST_ContextVK	(	const GHOST_ContextParams &	context_params,
		GHOST_TVulkanPlatformType	platform,
		Window	window,
		Display *	display,
		wl_surface *	wayland_surface,
		wl_display *	wayland_display,
		const GHOST_ContextVK_WindowInfo *	wayland_window_info,
		int	contextMajorVersion,
		int	contextMinorVersion,
		const GHOST_GPUDevice &	preferred_device,
		const GHOST_WindowHDRInfo *	hdr_info_ = nullptr )

Constructor.

Definition at line 667 of file GHOST_ContextVK.cc.

References Display, false, GHOST_Context::GHOST_Context(), Window, wl_display, and wl_surface.

◆ ~GHOST_ContextVK()

GHOST_ContextVK::~GHOST_ContextVK ( )

override

Destructor.

Definition at line 714 of file GHOST_ContextVK.cc.

References GHOST_InstanceVK::device, GHOST_DeviceVK::users, GHOST_DeviceVK::vk_device, GHOST_InstanceVK::vk_instance, vulkan_instance, and GHOST_DeviceVK::wait_idle().

Member Function Documentation

◆ activateDrawingContext()

GHOST_TSuccess GHOST_ContextVK::activateDrawingContext ( )

overridevirtual

Activates the drawing context of this window.

Returns: A boolean success indicator.

Implements GHOST_Context.

Definition at line 1023 of file GHOST_ContextVK.cc.

References GHOST_Context::active_context_, and GHOST_kSuccess.

◆ getSwapInterval()

GHOST_TSuccess GHOST_ContextVK::getSwapInterval ( int & )

inlineoverridevirtual

Gets the current swap interval for swapBuffers.

Parameters

interval_out Variable to store the swap interval if it can be read.

Returns: Whether the swap interval can be read.

Reimplemented from GHOST_Context.

Definition at line 193 of file GHOST_ContextVK.hh.

References GHOST_kFailure.

◆ getVulkanHandles()

GHOST_TSuccess GHOST_ContextVK::getVulkanHandles ( GHOST_VulkanHandles & r_handles )

override

Gets the Vulkan context related resource handles.

Returns: A boolean success indicator.

Definition at line 981 of file GHOST_ContextVK.cc.

References GHOST_InstanceVK::device, GHOST_DeviceVK::generic_queue, GHOST_DeviceVK::generic_queue_family, GHOST_kSuccess, GHOST_DeviceVK::queue_mutex, GHOST_DeviceVK::vk_device, GHOST_InstanceVK::vk_instance, GHOST_DeviceVK::vk_physical_device, GHOST_DeviceVK::vma_allocator, and vulkan_instance.

◆ getVulkanSwapChainFormat()

GHOST_TSuccess GHOST_ContextVK::getVulkanSwapChainFormat ( GHOST_VulkanSwapChainData * r_swap_chain_data )

override

Definition at line 970 of file GHOST_ContextVK.cc.

References GHOST_kSuccess.

◆ initializeDrawingContext()

GHOST_TSuccess GHOST_ContextVK::initializeDrawingContext ( )

overridevirtual

Call immediately after new to initialize. If this fails then immediately delete the object.

Returns: Indication as to whether initialization has succeeded.

Implements GHOST_Context.

Definition at line 1432 of file GHOST_ContextVK.cc.

References GHOST_Context::active_context_, GHOST_Context::context_params_, GHOST_InstanceVK::create_device(), GHOST_InstanceVK::create_instance(), GHOST_InstanceVK::device, GHOST_ExtensionsVK::enable(), GHOST_InstanceVK::extensions, GHOST_kFailure, GHOST_kSuccess, GHOST_kVulkanPlatformHeadless, GHOST_ExtensionsVK::is_supported(), GHOST_InstanceVK::select_physical_device(), GHOST_DeviceVK::users, VK_CHECK, GHOST_InstanceVK::vk_instance, vulkan_instance, and Window.

◆ isUpsideDown()

bool GHOST_ContextVK::isUpsideDown ( ) const

inlineoverridevirtual

Returns if the context is rendered upside down compared to OpenGL.

Vulkan is always rendered upside down.

Reimplemented from GHOST_Context.

Definition at line 203 of file GHOST_ContextVK.hh.

◆ releaseDrawingContext()

GHOST_TSuccess GHOST_ContextVK::releaseDrawingContext ( )

overridevirtual

Release the drawing context of the calling thread.

Returns: A boolean success indicator.

Implements GHOST_Context.

Definition at line 1029 of file GHOST_ContextVK.cc.

References GHOST_Context::active_context_, and GHOST_kSuccess.

◆ releaseNativeHandles()

GHOST_TSuccess GHOST_ContextVK::releaseNativeHandles ( )

overridevirtual

Removes references to native handles from this context and then returns

Returns: GHOST_kSuccess if it is OK for the parent to release the handles and GHOST_kFailure if releasing the handles will interfere with sharing

Implements GHOST_Context.

Definition at line 1600 of file GHOST_ContextVK.cc.

References GHOST_kSuccess.

◆ setSwapInterval()

GHOST_TSuccess GHOST_ContextVK::setSwapInterval ( int )

inlineoverridevirtual

Sets the swap interval for swapBuffers.

Parameters

interval The swap interval to use.

Returns: A boolean success indicator.

Reimplemented from GHOST_Context.

Definition at line 183 of file GHOST_ContextVK.hh.

References GHOST_kFailure.

◆ setVulkanSwapBuffersCallbacks()

GHOST_TSuccess GHOST_ContextVK::setVulkanSwapBuffersCallbacks	(	std::function< void(const GHOST_VulkanSwapChainData *)>	swap_buffer_draw_callback,
		std::function< void(void)>	swap_buffer_acquired_callback,
		std::function< void(GHOST_VulkanOpenXRData *)>	openxr_acquire_framebuffer_image_callback,
		std::function< void(GHOST_VulkanOpenXRData *)>	openxr_release_framebuffer_image_callback )