vkCreateMacOSSurfaceMVK(3)

Name

vkCreateMacOSSurfaceMVK - Create a VkSurfaceKHR object for a macOS NSView

C Specification

To create aVkSurfaceKHR object for a macOSNSView orCAMetalLayer, call:

// Provided by VK_MVK_macos_surfaceVkResult vkCreateMacOSSurfaceMVK(    VkInstance                                  instance,    const VkMacOSSurfaceCreateInfoMVK*          pCreateInfo,    const VkAllocationCallbacks*                pAllocator,    VkSurfaceKHR*                               pSurface);

Parameters

instance is the instance with which to associate the surface.
pCreateInfo is a pointer to aVkMacOSSurfaceCreateInfoMVKstructure containing parameters affecting the creation of the surfaceobject.
pAllocator is the allocator used for host memory allocated for thesurface object when there is no more specific allocator available (seeMemory Allocation).
pSurface is a pointer to aVkSurfaceKHR handle in which thecreated surface object is returned.

Description

ThevkCreateMacOSSurfaceMVK function is considered legacy and has beensuperseded byvkCreateMetalSurfaceEXT from theVK_EXT_metal_surface extension.

Valid Usage (Implicit)

VUID-vkCreateMacOSSurfaceMVK-instance-parameter
instancemust be a validVkInstance handle
VUID-vkCreateMacOSSurfaceMVK-pCreateInfo-parameter
pCreateInfomust be a valid pointer to a validVkMacOSSurfaceCreateInfoMVK structure
VUID-vkCreateMacOSSurfaceMVK-pAllocator-parameter
IfpAllocator is notNULL,pAllocatormust be a valid pointer to a validVkAllocationCallbacks structure
VUID-vkCreateMacOSSurfaceMVK-pSurface-parameter
pSurfacemust be a valid pointer to aVkSurfaceKHR handle

Return Codes

Success

VK_SUCCESS

Failure

Document Notes

For more information, see theVulkan Specification.

This page is extracted from the Vulkan Specification.Fixes and changes should be made to the Specification, not directly.

Movatterモバイル変換