VkIOSSurfaceCreateInfoMVK(3)

Name

VkIOSSurfaceCreateInfoMVK - Structure specifying parameters of a newly created iOS surface object

C Specification

The VkIOSSurfaceCreateInfoMVK structure is defined as:

// Provided by VK_MVK_ios_surface
typedef struct VkIOSSurfaceCreateInfoMVK {
    VkStructureType               sType;
    const void*                   pNext;
    VkIOSSurfaceCreateFlagsMVK    flags;
    const void*                   pView;
} VkIOSSurfaceCreateInfoMVK;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • flags is reserved for future use.

  • pView is a reference to either a CAMetalLayer object or a UIView object.

Description

Valid Usage

  • VUID-VkIOSSurfaceCreateInfoMVK-pView-04143
    If pView is a CAMetalLayer object, it must be a valid CAMetalLayer

  • VUID-VkIOSSurfaceCreateInfoMVK-pView-01316
    If pView is a UIView object, it must be a valid UIView, must be backed by a CALayer object of type CAMetalLayer, and vkCreateIOSSurfaceMVK must be called on the main thread

Valid Usage (Implicit)

  • VUID-VkIOSSurfaceCreateInfoMVK-sType-sType
    sType must be VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK

  • VUID-VkIOSSurfaceCreateInfoMVK-pNext-pNext
    pNext must be NULL

  • VUID-VkIOSSurfaceCreateInfoMVK-flags-zerobitmask
    flags must be 0

See Also

VK_MVK_ios_surface, VkIOSSurfaceCreateFlagsMVK, VkStructureType, vkCreateIOSSurfaceMVK

Document Notes

For more information, see the Vulkan Specification.

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