Vulkan.Extensions.VK_EXT_metal_objects

vkExportMetalObjectsEXT - Export Metal objects from the corresponding Vulkan objects

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, Device, ExportMetalObjectsInfoEXT

VkExportMetalObjectCreateInfoEXT - Structure that identifies the Metal objects that can be exported from Vulkan objects

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_OBJECT_CREATE_INFO_EXT

• If exportObjectType is not 0, exportObjectType must be a valid ExportMetalObjectTypeFlagBitsEXT value

Structure Chaining

Extends the structures

• BufferViewCreateInfo

• EventCreateInfo

• ImageCreateInfo

• ImageViewCreateInfo

• InstanceCreateInfo

• MemoryAllocateInfo

• SemaphoreCreateInfo

See Also

VK_EXT_metal_objects, ExportMetalObjectTypeFlagBitsEXT, StructureType

VkExportMetalObjectsInfoEXT - Structure whose pNext chain identifies Vulkan objects and corresponding Metal objects

Valid Usage

• If the pNext chain includes a ExportMetalDeviceInfoEXT structure, the Instance must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_DEVICE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the InstanceCreateInfo structure in the createInstance command

• If the pNext chain includes a ExportMetalCommandQueueInfoEXT structure, the Instance must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_COMMAND_QUEUE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the InstanceCreateInfo structure in the createInstance command

• If the pNext chain includes a ExportMetalBufferInfoEXT structure, the DeviceMemory in its memory member must have been allocated with EXPORT_METAL_OBJECT_TYPE_METAL_BUFFER_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the MemoryAllocateInfo structure in the allocateMemory command

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, exactly one of its image, imageView, or bufferView members must not be NULL_HANDLE

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and its image member is not NULL_HANDLE, the Image in its image member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the ImageCreateInfo structure in the createImage command

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and its imageView member is not NULL_HANDLE, the ImageView in its imageView member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the ImageViewCreateInfo structure in the createImageView command

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and its bufferView member is not NULL_HANDLE, the BufferView in its bufferView member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the BufferViewCreateInfo structure in the createBufferView command

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and if either its image or imageView member is not NULL_HANDLE, then plane must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and if the Image in its image member does not have a multi-planar format, then its plane member must be IMAGE_ASPECT_PLANE_0_BIT

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and if the Image in its image member has a multi-planar format with only two planes, then its plane member must not be IMAGE_ASPECT_PLANE_2_BIT

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and if the ImageView in its imageView member does not have a multi-planar format, then its plane member must be IMAGE_ASPECT_PLANE_0_BIT

• If the pNext chain includes a ExportMetalTextureInfoEXT structure, and if the ImageView in its imageView member has a multi-planar format with only two planes, then its plane member must not be IMAGE_ASPECT_PLANE_2_BIT

• If the pNext chain includes a ExportMetalIOSurfaceInfoEXT structure, the Image in its image member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_IOSURFACE_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the ImageCreateInfo structure in the createImage command

• If the pNext chain includes a ExportMetalSharedEventInfoEXT structure, exactly one of its semaphore or event members must not be NULL_HANDLE

• If the pNext chain includes a ExportMetalSharedEventInfoEXT structure, and its semaphore member is not NULL_HANDLE, the Semaphore in its semaphore member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the SemaphoreCreateInfo structure in the createSemaphore command

• If the pNext chain includes a ExportMetalSharedEventInfoEXT structure, and its event member is not NULL_HANDLE, the Event in its event member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT in the exportObjectType member of a ExportMetalObjectCreateInfoEXT structure in the pNext chain of the EventCreateInfo structure in the createEvent command

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_OBJECTS_INFO_EXT

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of ExportMetalBufferInfoEXT, ExportMetalCommandQueueInfoEXT, ExportMetalDeviceInfoEXT, ExportMetalIOSurfaceInfoEXT, ExportMetalSharedEventInfoEXT, or ExportMetalTextureInfoEXT

• The sType value of each structure in the pNext chain must be unique, with the exception of structures of type ExportMetalBufferInfoEXT, ExportMetalCommandQueueInfoEXT, ExportMetalIOSurfaceInfoEXT, ExportMetalSharedEventInfoEXT, or ExportMetalTextureInfoEXT

See Also

VK_EXT_metal_objects, StructureType, exportMetalObjectsEXT

VkExportMetalDeviceInfoEXT - Structure that identifies a VkDevice object and corresponding Metal MTLDevice object

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, StructureType

VkExportMetalCommandQueueInfoEXT - Structure that identifies a VkQueue object and corresponding Metal MTLCommandQueue object

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, Queue, StructureType

VkExportMetalBufferInfoEXT - Structure that identifies a VkDeviceMemory object and corresponding Metal MTLBuffer object

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, DeviceMemory, StructureType

VkImportMetalBufferInfoEXT - Structure that identifies a Metal MTLBuffer object to use when creating a VkDeviceMemory object.

Description

The application must ensure that the configuration of the id<MTLBuffer> object is compatible with the configuration of the DeviceMemory. Failure to do so results in undefined behavior.

Structure Chaining

Extends the structure

• MemoryAllocateInfo

See Also

VK_EXT_metal_objects, StructureType

VkExportMetalTextureInfoEXT - Structure that identifies a VkImage, VkImageView, or VkBufferView object and corresponding Metal MTLTexture object

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_TEXTURE_INFO_EXT

• If image is not NULL_HANDLE, image must be a valid Image handle

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle

• If bufferView is not NULL_HANDLE, bufferView must be a valid BufferView handle

• plane must be a valid ImageAspectFlagBits value

• Each of bufferView, image, and imageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, BufferView, Image, ImageAspectFlagBits, ImageView, StructureType

VkImportMetalTextureInfoEXT - Structure that identifies Metal MTLTexture objects to use when creating a VkImage.

Description

The pNext chain must include one ImportMetalTextureInfoEXT structure for each plane in the Image. The application must ensure that the configuration of the Metal id<MTLTexture> objects are compatible with the configuration of the Image. Failure to do so results in undefined behavior.

Due to id<MTLTexture> already being backed by memory, images created with ImportMetalTextureInfoEXT in the pNext of the ImageCreateInfo will be treated as bound to a VkDeviceMemory.

Structure Chaining

Extends the structure

• ImageCreateInfo

See Also

VK_EXT_metal_objects, ImageAspectFlagBits, StructureType

VkExportMetalIOSurfaceInfoEXT - Structure that identifies a VkImage object and corresponding Metal IOSurfaceRef object

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, Image, StructureType

VkImportMetalIOSurfaceInfoEXT - Structure that identifies a VkImage object and corresponding Metal IOSurfaceRef object to use.

Description

If ioSurface is not NULL_HANDLE, it will be used to underlie the Image. If ioSurface is NULL_HANDLE, the implementation will create a new IOSurface to underlie the Image.

If provided, the application must ensure that the configuration of the IOSurfaceRef object is compatible with the configuration of the Image. Failure to do so results in undefined behavior.

Structure Chaining

Extends the structure

• ImageCreateInfo

See Also

VK_EXT_metal_objects, StructureType

VkExportMetalSharedEventInfoEXT - Structure that identifies a VkSemaphore or VkEvent object and corresponding Metal MTLSharedEvent object

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT

• If semaphore is not NULL_HANDLE, semaphore must be a valid Semaphore handle

• If event is not NULL_HANDLE, event must be a valid Event handle

• Both of event, and semaphore that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Structure Chaining

Extends the structure

• ExportMetalObjectsInfoEXT

See Also

VK_EXT_metal_objects, Event, Semaphore, StructureType

VkImportMetalSharedEventInfoEXT - Structure that identifies a VkSemaphore or VkEvent object and corresponding Metal Shared Event object to use.

Description

If the pNext chain of the SemaphoreCreateInfo structure includes both ImportMetalSharedEventInfoEXT and SemaphoreTypeCreateInfo, the signaledValue property of the imported id<MTLSharedEvent> object will be set to SemaphoreTypeCreateInfo::initialValue.

Structure Chaining

Extends the structures

• EventCreateInfo

• SemaphoreCreateInfo

See Also

VK_EXT_metal_objects, StructureType

VkExportMetalObjectTypeFlagBitsEXT - Bitmask specifying Metal object types that can be exported from a Vulkan object

Description

• EXPORT_METAL_OBJECT_TYPE_METAL_DEVICE_BIT_EXT specifies that a Metal MTLDevice may be exported.

• EXPORT_METAL_OBJECT_TYPE_METAL_COMMAND_QUEUE_BIT_EXT specifies that a Metal MTLCommandQueue may be exported.

• EXPORT_METAL_OBJECT_TYPE_METAL_BUFFER_BIT_EXT specifies that a Metal MTLBuffer may be exported.

• EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT specifies that a Metal MTLTexture may be exported.

• EXPORT_METAL_OBJECT_TYPE_METAL_IOSURFACE_BIT_EXT specifies that a Metal IOSurface may be exported.

• EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT specifies that a Metal MTLSharedEvent may be exported.

See Also

VK_EXT_metal_objects, ExportMetalObjectCreateInfoEXT, ExportMetalObjectTypeFlagsEXT