vkCreateMacOSSurfaceMVK - Create a VkSurfaceKHR object for a macOS NSView

Parameters

Note

The createMacOSSurfaceMVK function is considered deprecated and has been superseded by createMetalSurfaceEXT from the VK_EXT_metal_surface extension.

Description

• instance is the instance with which to associate the surface.

• pCreateInfo is a pointer to a MacOSSurfaceCreateInfoMVK 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 SurfaceKHR handle in which the created surface object is returned.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid MacOSSurfaceCreateInfoMVK structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSurface must be a valid pointer to a SurfaceKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_NATIVE_WINDOW_IN_USE_KHR

See Also

AllocationCallbacks, Instance, MacOSSurfaceCreateInfoMVK, SurfaceKHR

VkMacOSSurfaceCreateInfoMVK - Structure specifying parameters of a newly created macOS surface object

Valid Usage

• If pView is a CAMetalLayer object, it must be a valid CAMetalLayer.

• If pView is an NSView object, it must be a valid NSView, must be backed by a CALayer object of type CAMetalLayer, and createMacOSSurfaceMVK must be called on the main thread.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK

• pNext must be NULL
• flags must be 0

See Also

MacOSSurfaceCreateFlagsMVK, StructureType, createMacOSSurfaceMVK

VkMacOSSurfaceCreateFlagsMVK - Reserved for future use

Description

MacOSSurfaceCreateFlagsMVK is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

MacOSSurfaceCreateInfoMVK

VkSurfaceKHR - Opaque handle to a surface object

Description

The VK_KHR_surface extension declares the SurfaceKHR object, and provides a function for destroying SurfaceKHR objects. Separate platform-specific extensions each provide a function for creating a SurfaceKHR object for the respective platform. From the application’s perspective this is an opaque handle, just like the handles of other Vulkan objects.

See Also

PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR