Vulkan.Extensions.VK_EXT_metal_objects

Name

VK_EXT_metal_objects - device extension

VK_EXT_metal_objects

Name String

VK_EXT_metal_objects

Extension Type

Device extension

Registered Extension Number

312

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Contact

• Bill Hollings @billhollings%0A*Here describe the issue or question you have about the VK_EXT_metal_objects extension*

Extension Proposal

VK_EXT_metal_objects

Other Extension Metadata

Last Modified Date

2022-05-28

IP Status

No known IP claims.

Contributors

• Bill Hollings, The Brenwill Workshop Ltd.
• Dzmitry Malyshau, Mozilla Corp.

Description

In a Vulkan implementation that is layered on top of Metal on Apple device platforms, this extension provides the ability to import and export the underlying Metal objects associated with specific Vulkan objects.

As detailed in the extension proposal document, this extension adds one new Vulkan command, exportMetalObjectsEXT, to export underlying Metal objects from Vulkan objects, and supports importing the appropriate existing Metal objects when creating Vulkan objects of types DeviceMemory, Image, Semaphore, and Event,

The intent is that this extension will be advertised and supported only on implementations that are layered on top of Metal on Apple device platforms.

New Base Types

• IOSurfaceRef

• MTLBuffer_id
• MTLCommandQueue_id
• MTLDevice_id
• MTLSharedEvent_id
• MTLTexture_id

New Commands

• exportMetalObjectsEXT

New Structures

• ExportMetalObjectsInfoEXT

• Extending ExportMetalObjectsInfoEXT:

  • ExportMetalBufferInfoEXT
  • ExportMetalCommandQueueInfoEXT
  • ExportMetalDeviceInfoEXT
  • ExportMetalIOSurfaceInfoEXT
  • ExportMetalSharedEventInfoEXT
  • ExportMetalTextureInfoEXT

• Extending ImageCreateInfo:

  • ImportMetalIOSurfaceInfoEXT
  • ImportMetalTextureInfoEXT

• Extending InstanceCreateInfo, MemoryAllocateInfo, ImageCreateInfo, ImageViewCreateInfo, BufferViewCreateInfo, SemaphoreCreateInfo, EventCreateInfo:

  • ExportMetalObjectCreateInfoEXT

• Extending MemoryAllocateInfo:

  • ImportMetalBufferInfoEXT

• Extending SemaphoreCreateInfo, EventCreateInfo:

  • ImportMetalSharedEventInfoEXT

New Enums

• ExportMetalObjectTypeFlagBitsEXT

New Bitmasks

• ExportMetalObjectTypeFlagsEXT

New Enum Constants

• EXT_METAL_OBJECTS_EXTENSION_NAME

• EXT_METAL_OBJECTS_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_EXPORT_METAL_BUFFER_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_DEVICE_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_IO_SURFACE_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_OBJECTS_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_OBJECT_CREATE_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT
  • STRUCTURE_TYPE_EXPORT_METAL_TEXTURE_INFO_EXT
  • STRUCTURE_TYPE_IMPORT_METAL_BUFFER_INFO_EXT
  • STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_INFO_EXT
  • STRUCTURE_TYPE_IMPORT_METAL_SHARED_EVENT_INFO_EXT
  • STRUCTURE_TYPE_IMPORT_METAL_TEXTURE_INFO_EXT

Issues

None.

Version History

• Revision 1, 2022-05-28 (Bill Hollings)

  • Initial draft.
  • Incorporated feedback from review by the Vulkan Working Group. Renamed many structures, moved import/export of MTLBuffer to VkDeviceMemory, added export of MTLSharedEvent, added import of MTLSharedEvent for VkSemaphore and VkEvent, and changed used bit mask fields to individual bit fields to simplify Valid Usage rules.

See Also

IOSurfaceRef, MTLBuffer_id, MTLCommandQueue_id, MTLDevice_id, MTLSharedEvent_id, MTLTexture_id, ExportMetalBufferInfoEXT, ExportMetalCommandQueueInfoEXT, ExportMetalDeviceInfoEXT, ExportMetalIOSurfaceInfoEXT, ExportMetalObjectCreateInfoEXT, ExportMetalObjectTypeFlagBitsEXT, ExportMetalObjectTypeFlagsEXT, ExportMetalObjectsInfoEXT, ExportMetalSharedEventInfoEXT, ExportMetalTextureInfoEXT, ImportMetalBufferInfoEXT, ImportMetalIOSurfaceInfoEXT, ImportMetalSharedEventInfoEXT, ImportMetalTextureInfoEXT, exportMetalObjectsEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

exportMetalObjectsEXT

Arguments

:: forall a io. (Extendss ExportMetalObjectsInfoEXT a, PokeChain a, PeekChain a, MonadIO io)

=> Device

device is the device that created the Vulkan objects.

device must be a valid Device handle

-> io (ExportMetalObjectsInfoEXT a)

vkExportMetalObjectsEXT - Export Metal objects from the corresponding Vulkan objects

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, Device, ExportMetalObjectsInfoEXT

data ExportMetalObjectCreateInfoEXT

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

See Also

VK_EXT_metal_objects, ExportMetalObjectTypeFlagBitsEXT, StructureType

Constructors

ExportMetalObjectCreateInfoEXT

Fields

• exportObjectType :: ExportMetalObjectTypeFlagBitsEXT

  exportObjectType is a ExportMetalObjectTypeFlagBitsEXT indicating the type of Metal object that the application may request to be exported from the Vulkan object.

Instances

Storable ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalObjectCreateInfoEXT -> Int

alignment :: ExportMetalObjectCreateInfoEXT -> Int

peekElemOff :: Ptr ExportMetalObjectCreateInfoEXT -> Int -> IO ExportMetalObjectCreateInfoEXT

pokeElemOff :: Ptr ExportMetalObjectCreateInfoEXT -> Int -> ExportMetalObjectCreateInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalObjectCreateInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalObjectCreateInfoEXT -> IO ()

peek :: Ptr ExportMetalObjectCreateInfoEXT -> IO ExportMetalObjectCreateInfoEXT

poke :: Ptr ExportMetalObjectCreateInfoEXT -> ExportMetalObjectCreateInfoEXT -> IO ()

Show ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalObjectCreateInfoEXT -> ShowS

show :: ExportMetalObjectCreateInfoEXT -> String

showList :: [ExportMetalObjectCreateInfoEXT] -> ShowS

Eq ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalObjectCreateInfoEXT -> ExportMetalObjectCreateInfoEXT -> Bool

(/=) :: ExportMetalObjectCreateInfoEXT -> ExportMetalObjectCreateInfoEXT -> Bool

FromCStruct ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalObjectCreateInfoEXT -> IO ExportMetalObjectCreateInfoEXT

ToCStruct ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalObjectCreateInfoEXT -> (Ptr ExportMetalObjectCreateInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalObjectCreateInfoEXT -> ExportMetalObjectCreateInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalObjectCreateInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalObjectCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalObjectCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalObjectCreateInfoEXT

data ExportMetalObjectsInfoEXT (es :: [Type])

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 struct 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

Constructors

ExportMetalObjectsInfoEXT

Fields

• next :: Chain es

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

Instances

Extensible ExportMetalObjectsInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). ExportMetalObjectsInfoEXT es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). ExportMetalObjectsInfoEXT ds -> Chain es -> ExportMetalObjectsInfoEXT es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends ExportMetalObjectsInfoEXT e => b) -> Maybe b

Show (Chain es) => Show (ExportMetalObjectsInfoEXT es)

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalObjectsInfoEXT es -> ShowS

show :: ExportMetalObjectsInfoEXT es -> String

showList :: [ExportMetalObjectsInfoEXT es] -> ShowS

(Extendss ExportMetalObjectsInfoEXT es, PeekChain es) => FromCStruct (ExportMetalObjectsInfoEXT es)

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr (ExportMetalObjectsInfoEXT es) -> IO (ExportMetalObjectsInfoEXT es)

(Extendss ExportMetalObjectsInfoEXT es, PokeChain es) => ToCStruct (ExportMetalObjectsInfoEXT es)

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalObjectsInfoEXT es -> (Ptr (ExportMetalObjectsInfoEXT es) -> IO b) -> IO b

pokeCStruct :: Ptr (ExportMetalObjectsInfoEXT es) -> ExportMetalObjectsInfoEXT es -> IO b -> IO b

withZeroCStruct :: (Ptr (ExportMetalObjectsInfoEXT es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (ExportMetalObjectsInfoEXT es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (ExportMetalObjectsInfoEXT es)

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalObjectsInfoEXT es

data ExportMetalDeviceInfoEXT

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

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, StructureType

Constructors

ExportMetalDeviceInfoEXT

Fields

• mtlDevice :: MTLDevice_id

  mtlDevice is the Metal id<MTLDevice> object underlying the PhysicalDevice associated with the Device object identified in the call. The implementation will return the MTLDevice in this member, or it will return NULL if no MTLDevice could be found underlying the PhysicalDevice object.

Instances

Storable ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalDeviceInfoEXT -> Int

alignment :: ExportMetalDeviceInfoEXT -> Int

peekElemOff :: Ptr ExportMetalDeviceInfoEXT -> Int -> IO ExportMetalDeviceInfoEXT

pokeElemOff :: Ptr ExportMetalDeviceInfoEXT -> Int -> ExportMetalDeviceInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalDeviceInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalDeviceInfoEXT -> IO ()

peek :: Ptr ExportMetalDeviceInfoEXT -> IO ExportMetalDeviceInfoEXT

poke :: Ptr ExportMetalDeviceInfoEXT -> ExportMetalDeviceInfoEXT -> IO ()

Show ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalDeviceInfoEXT -> ShowS

show :: ExportMetalDeviceInfoEXT -> String

showList :: [ExportMetalDeviceInfoEXT] -> ShowS

Eq ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalDeviceInfoEXT -> ExportMetalDeviceInfoEXT -> Bool

(/=) :: ExportMetalDeviceInfoEXT -> ExportMetalDeviceInfoEXT -> Bool

FromCStruct ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalDeviceInfoEXT -> IO ExportMetalDeviceInfoEXT

ToCStruct ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalDeviceInfoEXT -> (Ptr ExportMetalDeviceInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalDeviceInfoEXT -> ExportMetalDeviceInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalDeviceInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalDeviceInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalDeviceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalDeviceInfoEXT

data ExportMetalCommandQueueInfoEXT

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

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, Queue, StructureType

Constructors

ExportMetalCommandQueueInfoEXT

Fields

• queue :: Ptr Queue_T

  queue is a Queue.

  queue must be a valid Queue handle

• mtlCommandQueue :: MTLCommandQueue_id

  mtlCommandQueue is the Metal id<MTLCommandQueue> object underlying the Queue object in queue. The implementation will return the MTLCommandQueue in this member, or it will return NULL if no MTLCommandQueue could be found underlying the Queue object.

Instances

Storable ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalCommandQueueInfoEXT -> Int

alignment :: ExportMetalCommandQueueInfoEXT -> Int

peekElemOff :: Ptr ExportMetalCommandQueueInfoEXT -> Int -> IO ExportMetalCommandQueueInfoEXT

pokeElemOff :: Ptr ExportMetalCommandQueueInfoEXT -> Int -> ExportMetalCommandQueueInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalCommandQueueInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalCommandQueueInfoEXT -> IO ()

peek :: Ptr ExportMetalCommandQueueInfoEXT -> IO ExportMetalCommandQueueInfoEXT

poke :: Ptr ExportMetalCommandQueueInfoEXT -> ExportMetalCommandQueueInfoEXT -> IO ()

Show ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalCommandQueueInfoEXT -> ShowS

show :: ExportMetalCommandQueueInfoEXT -> String

showList :: [ExportMetalCommandQueueInfoEXT] -> ShowS

Eq ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalCommandQueueInfoEXT -> ExportMetalCommandQueueInfoEXT -> Bool

(/=) :: ExportMetalCommandQueueInfoEXT -> ExportMetalCommandQueueInfoEXT -> Bool

FromCStruct ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalCommandQueueInfoEXT -> IO ExportMetalCommandQueueInfoEXT

ToCStruct ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalCommandQueueInfoEXT -> (Ptr ExportMetalCommandQueueInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalCommandQueueInfoEXT -> ExportMetalCommandQueueInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalCommandQueueInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalCommandQueueInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalCommandQueueInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalCommandQueueInfoEXT

data ExportMetalBufferInfoEXT

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

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, DeviceMemory, StructureType

Constructors

ExportMetalBufferInfoEXT

Fields

• memory :: DeviceMemory

  memory is a DeviceMemory.

  memory must be a valid DeviceMemory handle

• mtlBuffer :: MTLBuffer_id

  mtlBuffer is the Metal id<MTLBuffer> object underlying the DeviceMemory object in memory. The implementation will return the MTLBuffer in this member, or it will return NULL if no MTLBuffer could be found underlying the DeviceMemory object.

Instances

Storable ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalBufferInfoEXT -> Int

alignment :: ExportMetalBufferInfoEXT -> Int

peekElemOff :: Ptr ExportMetalBufferInfoEXT -> Int -> IO ExportMetalBufferInfoEXT

pokeElemOff :: Ptr ExportMetalBufferInfoEXT -> Int -> ExportMetalBufferInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalBufferInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalBufferInfoEXT -> IO ()

peek :: Ptr ExportMetalBufferInfoEXT -> IO ExportMetalBufferInfoEXT

poke :: Ptr ExportMetalBufferInfoEXT -> ExportMetalBufferInfoEXT -> IO ()

Show ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalBufferInfoEXT -> ShowS

show :: ExportMetalBufferInfoEXT -> String

showList :: [ExportMetalBufferInfoEXT] -> ShowS

Eq ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalBufferInfoEXT -> ExportMetalBufferInfoEXT -> Bool

(/=) :: ExportMetalBufferInfoEXT -> ExportMetalBufferInfoEXT -> Bool

FromCStruct ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalBufferInfoEXT -> IO ExportMetalBufferInfoEXT

ToCStruct ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalBufferInfoEXT -> (Ptr ExportMetalBufferInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalBufferInfoEXT -> ExportMetalBufferInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalBufferInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalBufferInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalBufferInfoEXT

data ImportMetalBufferInfoEXT

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

Description

The app 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.

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, StructureType

Constructors

ImportMetalBufferInfoEXT

Fields

• mtlBuffer :: MTLBuffer_id

  mtlBuffer is the Metal id<MTLBuffer> object that is to underlie the DeviceMemory.

Instances

Storable ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ImportMetalBufferInfoEXT -> Int

alignment :: ImportMetalBufferInfoEXT -> Int

peekElemOff :: Ptr ImportMetalBufferInfoEXT -> Int -> IO ImportMetalBufferInfoEXT

pokeElemOff :: Ptr ImportMetalBufferInfoEXT -> Int -> ImportMetalBufferInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportMetalBufferInfoEXT

pokeByteOff :: Ptr b -> Int -> ImportMetalBufferInfoEXT -> IO ()

peek :: Ptr ImportMetalBufferInfoEXT -> IO ImportMetalBufferInfoEXT

poke :: Ptr ImportMetalBufferInfoEXT -> ImportMetalBufferInfoEXT -> IO ()

Show ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ImportMetalBufferInfoEXT -> ShowS

show :: ImportMetalBufferInfoEXT -> String

showList :: [ImportMetalBufferInfoEXT] -> ShowS

Eq ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ImportMetalBufferInfoEXT -> ImportMetalBufferInfoEXT -> Bool

(/=) :: ImportMetalBufferInfoEXT -> ImportMetalBufferInfoEXT -> Bool

FromCStruct ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ImportMetalBufferInfoEXT -> IO ImportMetalBufferInfoEXT

ToCStruct ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ImportMetalBufferInfoEXT -> (Ptr ImportMetalBufferInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImportMetalBufferInfoEXT -> ImportMetalBufferInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImportMetalBufferInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportMetalBufferInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMetalBufferInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ImportMetalBufferInfoEXT

data ExportMetalTextureInfoEXT

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

See Also

VK_EXT_metal_objects, BufferView, Image, ImageAspectFlagBits, ImageView, StructureType

Constructors

ExportMetalTextureInfoEXT

Fields

• image :: Image

  image is NULL_HANDLE or a Image.

• imageView :: ImageView

  imageView is NULL_HANDLE or a ImageView.

• bufferView :: BufferView

  bufferView is NULL_HANDLE or a BufferView.

• plane :: ImageAspectFlagBits

  plane indicates the plane of a multi-planar Image or ImageView.

• mtlTexture :: MTLTexture_id

  mtlTexture is the Metal id<MTLTexture> object underlying the Image, ImageView, or BufferView object in image, imageView, or bufferView, respectively, at the plane indicated in aspectMask. The implementation will return the MTLTexture in this member, or it will return NULL if no MTLTexture could be found underlying the Image, ImageView, or BufferView object, at the plane indicated in aspectMask.

Instances

Storable ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalTextureInfoEXT -> Int

alignment :: ExportMetalTextureInfoEXT -> Int

peekElemOff :: Ptr ExportMetalTextureInfoEXT -> Int -> IO ExportMetalTextureInfoEXT

pokeElemOff :: Ptr ExportMetalTextureInfoEXT -> Int -> ExportMetalTextureInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalTextureInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalTextureInfoEXT -> IO ()

peek :: Ptr ExportMetalTextureInfoEXT -> IO ExportMetalTextureInfoEXT

poke :: Ptr ExportMetalTextureInfoEXT -> ExportMetalTextureInfoEXT -> IO ()

Show ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalTextureInfoEXT -> ShowS

show :: ExportMetalTextureInfoEXT -> String

showList :: [ExportMetalTextureInfoEXT] -> ShowS

Eq ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalTextureInfoEXT -> ExportMetalTextureInfoEXT -> Bool

(/=) :: ExportMetalTextureInfoEXT -> ExportMetalTextureInfoEXT -> Bool

FromCStruct ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalTextureInfoEXT -> IO ExportMetalTextureInfoEXT

ToCStruct ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalTextureInfoEXT -> (Ptr ExportMetalTextureInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalTextureInfoEXT -> ExportMetalTextureInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalTextureInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalTextureInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalTextureInfoEXT

data ImportMetalTextureInfoEXT

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 app 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.

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, ImageAspectFlagBits, StructureType

Constructors

ImportMetalTextureInfoEXT

Fields

• plane :: ImageAspectFlagBits

  plane indicates the plane of the Image that the id<MTLTexture> object should be attached to.

  plane must be a valid ImageAspectFlagBits value

• mtlTexture :: MTLTexture_id

  mtlTexture is a the Metal id<MTLTexture> object that is to underlie the Image plane.

Instances

Storable ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ImportMetalTextureInfoEXT -> Int

alignment :: ImportMetalTextureInfoEXT -> Int

peekElemOff :: Ptr ImportMetalTextureInfoEXT -> Int -> IO ImportMetalTextureInfoEXT

pokeElemOff :: Ptr ImportMetalTextureInfoEXT -> Int -> ImportMetalTextureInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportMetalTextureInfoEXT

pokeByteOff :: Ptr b -> Int -> ImportMetalTextureInfoEXT -> IO ()

peek :: Ptr ImportMetalTextureInfoEXT -> IO ImportMetalTextureInfoEXT

poke :: Ptr ImportMetalTextureInfoEXT -> ImportMetalTextureInfoEXT -> IO ()

Show ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ImportMetalTextureInfoEXT -> ShowS

show :: ImportMetalTextureInfoEXT -> String

showList :: [ImportMetalTextureInfoEXT] -> ShowS

Eq ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ImportMetalTextureInfoEXT -> ImportMetalTextureInfoEXT -> Bool

(/=) :: ImportMetalTextureInfoEXT -> ImportMetalTextureInfoEXT -> Bool

FromCStruct ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ImportMetalTextureInfoEXT -> IO ImportMetalTextureInfoEXT

ToCStruct ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ImportMetalTextureInfoEXT -> (Ptr ImportMetalTextureInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImportMetalTextureInfoEXT -> ImportMetalTextureInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImportMetalTextureInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportMetalTextureInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMetalTextureInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ImportMetalTextureInfoEXT

data ExportMetalIOSurfaceInfoEXT

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

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, Image, StructureType

Constructors

ExportMetalIOSurfaceInfoEXT

Fields

• image :: Image

  image is a Image.

  image must be a valid Image handle

• ioSurface :: IOSurfaceRef

  ioSurface is the Metal IOSurfaceRef object underlying the Image object in image. The implementation will return the IOSurfaceRef in this member, or it will return NULL if no IOSurfaceRef could be found underlying the Image object.

Instances

Storable ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalIOSurfaceInfoEXT -> Int

alignment :: ExportMetalIOSurfaceInfoEXT -> Int

peekElemOff :: Ptr ExportMetalIOSurfaceInfoEXT -> Int -> IO ExportMetalIOSurfaceInfoEXT

pokeElemOff :: Ptr ExportMetalIOSurfaceInfoEXT -> Int -> ExportMetalIOSurfaceInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalIOSurfaceInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalIOSurfaceInfoEXT -> IO ()

peek :: Ptr ExportMetalIOSurfaceInfoEXT -> IO ExportMetalIOSurfaceInfoEXT

poke :: Ptr ExportMetalIOSurfaceInfoEXT -> ExportMetalIOSurfaceInfoEXT -> IO ()

Show ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalIOSurfaceInfoEXT -> ShowS

show :: ExportMetalIOSurfaceInfoEXT -> String

showList :: [ExportMetalIOSurfaceInfoEXT] -> ShowS

Eq ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalIOSurfaceInfoEXT -> ExportMetalIOSurfaceInfoEXT -> Bool

(/=) :: ExportMetalIOSurfaceInfoEXT -> ExportMetalIOSurfaceInfoEXT -> Bool

FromCStruct ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalIOSurfaceInfoEXT -> IO ExportMetalIOSurfaceInfoEXT

ToCStruct ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalIOSurfaceInfoEXT -> (Ptr ExportMetalIOSurfaceInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalIOSurfaceInfoEXT -> ExportMetalIOSurfaceInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalIOSurfaceInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalIOSurfaceInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalIOSurfaceInfoEXT

data ImportMetalIOSurfaceInfoEXT

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 app 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.

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, StructureType

Constructors

ImportMetalIOSurfaceInfoEXT

Fields

• ioSurface :: IOSurfaceRef

  ioSurface is NULL_HANDLE or the Metal IOSurfaceRef object that is to underlie the Image.

Instances

Storable ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ImportMetalIOSurfaceInfoEXT -> Int

alignment :: ImportMetalIOSurfaceInfoEXT -> Int

peekElemOff :: Ptr ImportMetalIOSurfaceInfoEXT -> Int -> IO ImportMetalIOSurfaceInfoEXT

pokeElemOff :: Ptr ImportMetalIOSurfaceInfoEXT -> Int -> ImportMetalIOSurfaceInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportMetalIOSurfaceInfoEXT

pokeByteOff :: Ptr b -> Int -> ImportMetalIOSurfaceInfoEXT -> IO ()

peek :: Ptr ImportMetalIOSurfaceInfoEXT -> IO ImportMetalIOSurfaceInfoEXT

poke :: Ptr ImportMetalIOSurfaceInfoEXT -> ImportMetalIOSurfaceInfoEXT -> IO ()

Show ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ImportMetalIOSurfaceInfoEXT -> ShowS

show :: ImportMetalIOSurfaceInfoEXT -> String

showList :: [ImportMetalIOSurfaceInfoEXT] -> ShowS

Eq ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ImportMetalIOSurfaceInfoEXT -> ImportMetalIOSurfaceInfoEXT -> Bool

(/=) :: ImportMetalIOSurfaceInfoEXT -> ImportMetalIOSurfaceInfoEXT -> Bool

FromCStruct ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ImportMetalIOSurfaceInfoEXT -> IO ImportMetalIOSurfaceInfoEXT

ToCStruct ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ImportMetalIOSurfaceInfoEXT -> (Ptr ImportMetalIOSurfaceInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImportMetalIOSurfaceInfoEXT -> ImportMetalIOSurfaceInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImportMetalIOSurfaceInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportMetalIOSurfaceInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMetalIOSurfaceInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ImportMetalIOSurfaceInfoEXT

data ExportMetalSharedEventInfoEXT

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

See Also

VK_EXT_metal_objects, Event, Semaphore, StructureType

Constructors

ExportMetalSharedEventInfoEXT

Fields

• semaphore :: Semaphore

  semaphore is NULL_HANDLE or a Semaphore.

• event :: Event

  event is NULL_HANDLE or a Event.

• mtlSharedEvent :: MTLSharedEvent_id

  mtlSharedEvent is the Metal id<MTLSharedEvent> object underlying the Semaphore or Event object in semaphore or event, respectively. The implementation will return the MTLSharedEvent in this member, or it will return NULL if no MTLSharedEvent could be found underlying the Semaphore or Event object.

Instances

Storable ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalSharedEventInfoEXT -> Int

alignment :: ExportMetalSharedEventInfoEXT -> Int

peekElemOff :: Ptr ExportMetalSharedEventInfoEXT -> Int -> IO ExportMetalSharedEventInfoEXT

pokeElemOff :: Ptr ExportMetalSharedEventInfoEXT -> Int -> ExportMetalSharedEventInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalSharedEventInfoEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalSharedEventInfoEXT -> IO ()

peek :: Ptr ExportMetalSharedEventInfoEXT -> IO ExportMetalSharedEventInfoEXT

poke :: Ptr ExportMetalSharedEventInfoEXT -> ExportMetalSharedEventInfoEXT -> IO ()

Show ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalSharedEventInfoEXT -> ShowS

show :: ExportMetalSharedEventInfoEXT -> String

showList :: [ExportMetalSharedEventInfoEXT] -> ShowS

Eq ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalSharedEventInfoEXT -> ExportMetalSharedEventInfoEXT -> Bool

(/=) :: ExportMetalSharedEventInfoEXT -> ExportMetalSharedEventInfoEXT -> Bool

FromCStruct ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ExportMetalSharedEventInfoEXT -> IO ExportMetalSharedEventInfoEXT

ToCStruct ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ExportMetalSharedEventInfoEXT -> (Ptr ExportMetalSharedEventInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ExportMetalSharedEventInfoEXT -> ExportMetalSharedEventInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMetalSharedEventInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMetalSharedEventInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalSharedEventInfoEXT

data ImportMetalSharedEventInfoEXT

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 initialValue of SemaphoreTypeCreateInfo.

Valid Usage (Implicit)

See Also

VK_EXT_metal_objects, StructureType

Constructors

ImportMetalSharedEventInfoEXT

Fields

• mtlSharedEvent :: MTLSharedEvent_id

  mtlSharedEvent is the Metal id<MTLSharedEvent> object that is to underlie the Semaphore or Event.

Instances

Storable ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ImportMetalSharedEventInfoEXT -> Int

alignment :: ImportMetalSharedEventInfoEXT -> Int

peekElemOff :: Ptr ImportMetalSharedEventInfoEXT -> Int -> IO ImportMetalSharedEventInfoEXT

pokeElemOff :: Ptr ImportMetalSharedEventInfoEXT -> Int -> ImportMetalSharedEventInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportMetalSharedEventInfoEXT

pokeByteOff :: Ptr b -> Int -> ImportMetalSharedEventInfoEXT -> IO ()

peek :: Ptr ImportMetalSharedEventInfoEXT -> IO ImportMetalSharedEventInfoEXT

poke :: Ptr ImportMetalSharedEventInfoEXT -> ImportMetalSharedEventInfoEXT -> IO ()

Show ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ImportMetalSharedEventInfoEXT -> ShowS

show :: ImportMetalSharedEventInfoEXT -> String

showList :: [ImportMetalSharedEventInfoEXT] -> ShowS

Eq ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ImportMetalSharedEventInfoEXT -> ImportMetalSharedEventInfoEXT -> Bool

(/=) :: ImportMetalSharedEventInfoEXT -> ImportMetalSharedEventInfoEXT -> Bool

FromCStruct ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

peekCStruct :: Ptr ImportMetalSharedEventInfoEXT -> IO ImportMetalSharedEventInfoEXT

ToCStruct ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

withCStruct :: ImportMetalSharedEventInfoEXT -> (Ptr ImportMetalSharedEventInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr ImportMetalSharedEventInfoEXT -> ImportMetalSharedEventInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr ImportMetalSharedEventInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportMetalSharedEventInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMetalSharedEventInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ImportMetalSharedEventInfoEXT

type ExportMetalObjectTypeFlagsEXT = ExportMetalObjectTypeFlagBitsEXT

newtype ExportMetalObjectTypeFlagBitsEXT

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

See Also

VK_EXT_metal_objects, ExportMetalObjectCreateInfoEXT, ExportMetalObjectTypeFlagsEXT

Constructors

ExportMetalObjectTypeFlagBitsEXT Flags

Bundled Patterns

pattern EXPORT_METAL_OBJECT_TYPE_METAL_DEVICE_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_DEVICE_BIT_EXT indicates a Metal MTLDevice may be exported.

pattern EXPORT_METAL_OBJECT_TYPE_METAL_COMMAND_QUEUE_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_COMMAND_QUEUE_BIT_EXT indicates a Metal MTLCommandQueue may be exported.

pattern EXPORT_METAL_OBJECT_TYPE_METAL_BUFFER_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_BUFFER_BIT_EXT indicates a Metal MTLBuffer may be exported.

pattern EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT indicates a Metal MTLTexture may be exported.

pattern EXPORT_METAL_OBJECT_TYPE_METAL_IOSURFACE_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_IOSURFACE_BIT_EXT indicates a Metal IOSurface may be exported.

pattern EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT :: ExportMetalObjectTypeFlagBitsEXT

EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT indicates a Metal MTLSharedEvent may be exported.

Instances

Storable ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

sizeOf :: ExportMetalObjectTypeFlagBitsEXT -> Int

alignment :: ExportMetalObjectTypeFlagBitsEXT -> Int

peekElemOff :: Ptr ExportMetalObjectTypeFlagBitsEXT -> Int -> IO ExportMetalObjectTypeFlagBitsEXT

pokeElemOff :: Ptr ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMetalObjectTypeFlagBitsEXT

pokeByteOff :: Ptr b -> Int -> ExportMetalObjectTypeFlagBitsEXT -> IO ()

peek :: Ptr ExportMetalObjectTypeFlagBitsEXT -> IO ExportMetalObjectTypeFlagBitsEXT

poke :: Ptr ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> IO ()

Bits ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(.&.) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

(.|.) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

xor :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

complement :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

shift :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

rotate :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

zeroBits :: ExportMetalObjectTypeFlagBitsEXT

bit :: Int -> ExportMetalObjectTypeFlagBitsEXT

setBit :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

clearBit :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

complementBit :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

testBit :: ExportMetalObjectTypeFlagBitsEXT -> Int -> Bool

bitSizeMaybe :: ExportMetalObjectTypeFlagBitsEXT -> Maybe Int

bitSize :: ExportMetalObjectTypeFlagBitsEXT -> Int

isSigned :: ExportMetalObjectTypeFlagBitsEXT -> Bool

shiftL :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

unsafeShiftL :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

shiftR :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

unsafeShiftR :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

rotateL :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

rotateR :: ExportMetalObjectTypeFlagBitsEXT -> Int -> ExportMetalObjectTypeFlagBitsEXT

popCount :: ExportMetalObjectTypeFlagBitsEXT -> Int

FiniteBits ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

finiteBitSize :: ExportMetalObjectTypeFlagBitsEXT -> Int

countLeadingZeros :: ExportMetalObjectTypeFlagBitsEXT -> Int

countTrailingZeros :: ExportMetalObjectTypeFlagBitsEXT -> Int

Read ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

readsPrec :: Int -> ReadS ExportMetalObjectTypeFlagBitsEXT

readList :: ReadS [ExportMetalObjectTypeFlagBitsEXT]

readPrec :: ReadPrec ExportMetalObjectTypeFlagBitsEXT

readListPrec :: ReadPrec [ExportMetalObjectTypeFlagBitsEXT]

Show ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

showsPrec :: Int -> ExportMetalObjectTypeFlagBitsEXT -> ShowS

show :: ExportMetalObjectTypeFlagBitsEXT -> String

showList :: [ExportMetalObjectTypeFlagBitsEXT] -> ShowS

Eq ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

(==) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

(/=) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

Ord ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

compare :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Ordering

(<) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

(<=) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

(>) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

(>=) :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> Bool

max :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

min :: ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT -> ExportMetalObjectTypeFlagBitsEXT

Zero ExportMetalObjectTypeFlagBitsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_objects

Methods

zero :: ExportMetalObjectTypeFlagBitsEXT

type EXT_METAL_OBJECTS_SPEC_VERSION = 1

pattern EXT_METAL_OBJECTS_SPEC_VERSION :: forall a. Integral a => a

type EXT_METAL_OBJECTS_EXTENSION_NAME = "VK_EXT_metal_objects"

pattern EXT_METAL_OBJECTS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type MTLDevice_id = Ptr ()

type MTLCommandQueue_id = Ptr ()

type MTLBuffer_id = Ptr ()

type MTLTexture_id = Ptr ()

type IOSurfaceRef = Ptr ()

type MTLSharedEvent_id = Ptr ()