Show / Hide Table of Contents

Interface IVulkanComponent

Interface for interacting with Vulkan in a more convenient way.

Inherited Members
IPalComponent.Name
IPalComponent.Provides
IPalComponent.Logger
IPalComponent.Initialize(ToolkitOptions)
IPalComponent.Uninitialize()
Namespace: OpenTK.Platform
Assembly: OpenTK.Platform.dll
Syntax
public interface IVulkanComponent : IPalComponent

Methods

CreateWindowSurface(VkInstance, WindowHandle, VkAllocationCallbacks*, out VkSurfaceKHR)

Creates a Vulkan surface for the specified window.

Declaration
VkResult CreateWindowSurface(VkInstance instance, WindowHandle window, VkAllocationCallbacks* allocator, out VkSurfaceKHR surface)
Parameters
Type Name Description
VkInstance instance

The instance to create the surface with.

WindowHandle window

The window to create the surface in.

VkAllocationCallbacks* allocator

The allocator to use or null to use the default allocator.

VkSurfaceKHR surface

The created surface.

Returns
Type Description
VkResult

The Vulkan result code of this operation.

See Also
GetRequiredInstanceExtensions()

GetPhysicalDevicePresentationSupport(VkInstance, VkPhysicalDevice, uint)

Returns true if the given queue family supports presentation to a surface created with CreateWindowSurface(VkInstance, WindowHandle, VkAllocationCallbacks*, out VkSurfaceKHR).

Declaration
bool GetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint queueFamily)
Parameters
Type Name Description
VkInstance instance

The VkInstance to physical device belongs to.

VkPhysicalDevice device

The VkPhysicalDevice that the queueFamily belongs to.

uint queueFamily

The index of the queue family to query for presentation support.

Returns
Type Description
bool

If this queue family supports presentation.

See Also
GetRequiredInstanceExtensions()

GetRequiredInstanceExtensions()

Returns a list of required instance extensions required for GetPhysicalDevicePresentationSupport(VkInstance, VkPhysicalDevice, uint) and CreateWindowSurface(VkInstance, WindowHandle, VkAllocationCallbacks*, out VkSurfaceKHR) to work. Include these extensions when creating VkInstance.

Declaration
ReadOnlySpan<string> GetRequiredInstanceExtensions()
Returns
Type Description
ReadOnlySpan<string>

A list of required extensions for IVulkanComponent functions to work.

See Also
GetPhysicalDevicePresentationSupport(VkInstance, VkPhysicalDevice, uint)
CreateWindowSurface(VkInstance, WindowHandle, VkAllocationCallbacks*, out VkSurfaceKHR)

See Also

Vulkan
VulkanGraphicsApiHints
In this article
Back to top Generated by DocFX