Function Prototype
vkCreateWaylandSurfaceKHR
Create a slink:VkSurfaceKHR object for a Wayland window
To create a VkSurfaceKHR
object for a Wayland surface, call:
VkResult vkCreateWaylandSurfaceKHR(
VkInstance instance,
const VkWaylandSurfaceCreateInfoKHR* pCreateInfo,
const VkAllocationCallbacks* pAllocator,
VkSurfaceKHR* pSurface);
instance
is the instance to associate the surface with.pCreateInfo
is a pointer to a VkWaylandSurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.pAllocator
is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).pSurface
is a pointer to a VkSurfaceKHR handle in which the created surface object is returned.
Valid Usage (Implicit)
VUID-vkCreateWaylandSurfaceKHR-instance-parameter
instance
must be a valid VkInstance handle
VUID-vkCreateWaylandSurfaceKHR-pCreateInfo-parameter
pCreateInfo
must be a valid pointer to a valid VkWaylandSurfaceCreateInfoKHR structure
VUID-vkCreateWaylandSurfaceKHR-pAllocator-parameter
If pAllocator
is not NULL
, pAllocator
must be a valid pointer to a valid VkAllocationCallbacks structure
VUID-vkCreateWaylandSurfaceKHR-pSurface-parameter
pSurface
must be a valid pointer to a VkSurfaceKHR handle