Vulkan.Core10.OtherTypes

Documentation

data MemoryBarrier

VkMemoryBarrier - Structure specifying a global memory barrier

Description

The first access scope is limited to access types in the source access mask specified by srcAccessMask.

The second access scope is limited to access types in the destination access mask specified by dstAccessMask.

Valid Usage (Implicit)

See Also

AccessFlags, StructureType, cmdPipelineBarrier, cmdWaitEvents

Constructors

MemoryBarrier

Fields

• srcAccessMask :: AccessFlags

  srcAccessMask is a bitmask of AccessFlagBits specifying a source access mask.

  srcAccessMask must be a valid combination of AccessFlagBits values

• dstAccessMask :: AccessFlags

  dstAccessMask is a bitmask of AccessFlagBits specifying a destination access mask.

  dstAccessMask must be a valid combination of AccessFlagBits values

Instances

Eq MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

(==) :: MemoryBarrier -> MemoryBarrier -> Bool

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

Show MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> MemoryBarrier -> ShowS

show :: MemoryBarrier -> String

showList :: [MemoryBarrier] -> ShowS

Storable MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

sizeOf :: MemoryBarrier -> Int

alignment :: MemoryBarrier -> Int

peekElemOff :: Ptr MemoryBarrier -> Int -> IO MemoryBarrier

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

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

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

peek :: Ptr MemoryBarrier -> IO MemoryBarrier

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

FromCStruct MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

peekCStruct :: Ptr MemoryBarrier -> IO MemoryBarrier

ToCStruct MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr MemoryBarrier -> MemoryBarrier -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MemoryBarrier -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: MemoryBarrier

data BufferMemoryBarrier

VkBufferMemoryBarrier - Structure specifying a buffer memory barrier

Description

The first access scope is limited to access to memory through the specified buffer range, via access types in the source access mask specified by srcAccessMask. If srcAccessMask includes ACCESS_HOST_WRITE_BIT, memory writes performed by that access type are also made visible, as that access type is not performed through a resource.

The second access scope is limited to access to memory through the specified buffer range, via access types in the destination access mask specified by dstAccessMask. If dstAccessMask includes ACCESS_HOST_WRITE_BIT or ACCESS_HOST_READ_BIT, available memory writes are also made visible to accesses of those types, as those access types are not performed through a resource.

If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, and srcQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family release operation for the specified buffer range, and the second access scope includes no access, as if dstAccessMask was 0.

If dstQueueFamilyIndex is not equal to srcQueueFamilyIndex, and dstQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family acquire operation for the specified buffer range, and the first access scope includes no access, as if srcAccessMask was 0.

Valid Usage

• offset must be less than the size of buffer

• If size is not equal to WHOLE_SIZE, size must be greater than 0
• If size is not equal to WHOLE_SIZE, size must be less than or equal to than the size of buffer minus offset
• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, at least one must not be a special queue family reserved for external memory ownership transfers, as described in ???
• If buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, and one of srcQueueFamilyIndex and dstQueueFamilyIndex is a special queue family values reserved for external memory transfers, the other must be QUEUE_FAMILY_IGNORED
• If buffer was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, srcQueueFamilyIndex and dstQueueFamilyIndex must both be valid queue families, or one of the special queue family values reserved for external memory transfers, as described in ???
• If buffer was created with a sharing mode of SHARING_MODE_CONCURRENT, at least one of srcQueueFamilyIndex and dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER

• pNext must be NULL
• buffer must be a valid Buffer handle

See Also

AccessFlags, Buffer, DeviceSize, StructureType, cmdPipelineBarrier, cmdWaitEvents

Constructors

BufferMemoryBarrier

Fields

• srcAccessMask :: AccessFlags

  srcAccessMask is a bitmask of AccessFlagBits specifying a source access mask.

• dstAccessMask :: AccessFlags

  dstAccessMask is a bitmask of AccessFlagBits specifying a destination access mask.

• srcQueueFamilyIndex :: Word32

  srcQueueFamilyIndex is the source queue family for a queue family ownership transfer.

• dstQueueFamilyIndex :: Word32

  dstQueueFamilyIndex is the destination queue family for a queue family ownership transfer.

• buffer :: Buffer

  buffer is a handle to the buffer whose backing memory is affected by the barrier.

• offset :: DeviceSize

  offset is an offset in bytes into the backing memory for buffer; this is relative to the base offset as bound to the buffer (see bindBufferMemory).

• size :: DeviceSize

  size is a size in bytes of the affected area of backing memory for buffer, or WHOLE_SIZE to use the range from offset to the end of the buffer.

Instances

Eq BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

(==) :: BufferMemoryBarrier -> BufferMemoryBarrier -> Bool

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

Show BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> BufferMemoryBarrier -> ShowS

show :: BufferMemoryBarrier -> String

showList :: [BufferMemoryBarrier] -> ShowS

Storable BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

sizeOf :: BufferMemoryBarrier -> Int

alignment :: BufferMemoryBarrier -> Int

peekElemOff :: Ptr BufferMemoryBarrier -> Int -> IO BufferMemoryBarrier

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

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

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

peek :: Ptr BufferMemoryBarrier -> IO BufferMemoryBarrier

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

FromCStruct BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

peekCStruct :: Ptr BufferMemoryBarrier -> IO BufferMemoryBarrier

ToCStruct BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr BufferMemoryBarrier -> BufferMemoryBarrier -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BufferMemoryBarrier -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BufferMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: BufferMemoryBarrier

data ImageMemoryBarrier (es :: [Type])

VkImageMemoryBarrier - Structure specifying the parameters of an image memory barrier

Description

The first access scope is limited to access to memory through the specified image subresource range, via access types in the source access mask specified by srcAccessMask. If srcAccessMask includes ACCESS_HOST_WRITE_BIT, memory writes performed by that access type are also made visible, as that access type is not performed through a resource.

The second access scope is limited to access to memory through the specified image subresource range, via access types in the destination access mask specified by dstAccessMask. If dstAccessMask includes ACCESS_HOST_WRITE_BIT or ACCESS_HOST_READ_BIT, available memory writes are also made visible to accesses of those types, as those access types are not performed through a resource.

If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, and srcQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family release operation for the specified image subresource range, and the second access scope includes no access, as if dstAccessMask was 0.

If dstQueueFamilyIndex is not equal to srcQueueFamilyIndex, and dstQueueFamilyIndex is equal to the current queue family, then the memory barrier defines a queue family acquire operation for the specified image subresource range, and the first access scope includes no access, as if srcAccessMask was 0.

oldLayout and newLayout define an image layout transition for the specified image subresource range.

If image has a multi-planar format and the image is disjoint, then including IMAGE_ASPECT_COLOR_BIT in the aspectMask member of subresourceRange is equivalent to including IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, and (for three-plane formats only) IMAGE_ASPECT_PLANE_2_BIT.

Valid Usage

• subresourceRange.baseMipLevel must be less than the mipLevels specified in ImageCreateInfo when image was created

• If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in ImageCreateInfo when image was created
• subresourceRange.baseArrayLayer must be less than the arrayLayers specified in ImageCreateInfo when image was created
• If subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the arrayLayers specified in ImageCreateInfo when image was created
• If image is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then image must have been created with IMAGE_USAGE_COLOR_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image must have been created with IMAGE_USAGE_SAMPLED_BIT or IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then image must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then image must have been created with IMAGE_USAGE_TRANSFER_DST_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, oldLayout must be IMAGE_LAYOUT_UNDEFINED or the current layout of the image subresources affected by the barrier
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, newLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then image must have been created with at least one of IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_SAMPLED_BIT, or IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR then image must have been created with at least one of IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, IMAGE_USAGE_SAMPLED_BIT, or IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR then image must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
• If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, and oldLayout or newLayout is IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR then image must have been created with IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR set
• If image has a single-plane color format or is not disjoint, then the aspectMask member of subresourceRange must be IMAGE_ASPECT_COLOR_BIT
• If image has a multi-planar format and the image is disjoint, then the aspectMask member of subresourceRange must include either at least one of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, and IMAGE_ASPECT_PLANE_2_BIT; or must include IMAGE_ASPECT_COLOR_BIT
• If image has a multi-planar format with only two planes, then the aspectMask member of subresourceRange must not include IMAGE_ASPECT_PLANE_2_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is enabled, then the aspectMask member of subresourceRange must include either or both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If image has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is not enabled, then the aspectMask member of subresourceRange must include both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
• If srcQueueFamilyIndex is not equal to dstQueueFamilyIndex, at least one must not be a special queue family reserved for external memory ownership transfers, as described in ???
• If image was created with a sharing mode of SHARING_MODE_CONCURRENT, srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, and one of srcQueueFamilyIndex and dstQueueFamilyIndex is a special queue family values reserved for external memory transfers, the other must be QUEUE_FAMILY_IGNORED
• If image was created with a sharing mode of SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and dstQueueFamilyIndex are not equal, srcQueueFamilyIndex and dstQueueFamilyIndex must both be valid queue families, or one of the special queue family values reserved for external memory transfers, as described in ???
• If image was created with a sharing mode of SHARING_MODE_CONCURRENT, at least one of srcQueueFamilyIndex and dstQueueFamilyIndex must be QUEUE_FAMILY_IGNORED

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER

• pNext must be NULL or a pointer to a valid instance of SampleLocationsInfoEXT
• The sType value of each struct in the pNext chain must be unique
• oldLayout must be a valid ImageLayout value
• newLayout must be a valid ImageLayout value
• image must be a valid Image handle
• subresourceRange must be a valid ImageSubresourceRange structure

See Also

AccessFlags, Image, ImageLayout, ImageSubresourceRange, StructureType, cmdPipelineBarrier, cmdWaitEvents

Constructors

ImageMemoryBarrier

Fields

• next :: Chain es

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

• srcAccessMask :: AccessFlags

  srcAccessMask is a bitmask of AccessFlagBits specifying a source access mask.

• dstAccessMask :: AccessFlags

  dstAccessMask is a bitmask of AccessFlagBits specifying a destination access mask.

• oldLayout :: ImageLayout

  oldLayout is the old layout in an image layout transition.

• newLayout :: ImageLayout

  newLayout is the new layout in an image layout transition.

• srcQueueFamilyIndex :: Word32

  srcQueueFamilyIndex is the source queue family for a queue family ownership transfer.

• dstQueueFamilyIndex :: Word32

  dstQueueFamilyIndex is the destination queue family for a queue family ownership transfer.

• image :: Image

  image is a handle to the image affected by this barrier.

• subresourceRange :: ImageSubresourceRange

  subresourceRange describes the image subresource range within image that is affected by this barrier.

Instances

Extensible ImageMemoryBarrier

Defined in Vulkan.Core10.OtherTypes

Methods

extensibleType :: StructureType

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

setNext :: forall (ds :: [Type]) (es :: [Type]). ImageMemoryBarrier ds -> Chain es -> ImageMemoryBarrier es

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

Show (Chain es) => Show (ImageMemoryBarrier es)

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> ImageMemoryBarrier es -> ShowS

show :: ImageMemoryBarrier es -> String

showList :: [ImageMemoryBarrier es] -> ShowS

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

Defined in Vulkan.Core10.OtherTypes

Methods

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

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

Defined in Vulkan.Core10.OtherTypes

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: ImageMemoryBarrier es

data DrawIndirectCommand

VkDrawIndirectCommand - Structure specifying a draw indirect command

Description

The members of DrawIndirectCommand have the same meaning as the similarly named parameters of cmdDraw.

Valid Usage

• For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#fxvertex-input

• If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

See Also

cmdDrawIndirect

Constructors

DrawIndirectCommand

Fields

• vertexCount :: Word32

  vertexCount is the number of vertices to draw.

• instanceCount :: Word32

  instanceCount is the number of instances to draw.

• firstVertex :: Word32

  firstVertex is the index of the first vertex to draw.

• firstInstance :: Word32

  firstInstance is the instance ID of the first instance to draw.

Instances

Eq DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

(==) :: DrawIndirectCommand -> DrawIndirectCommand -> Bool

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

Show DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> DrawIndirectCommand -> ShowS

show :: DrawIndirectCommand -> String

showList :: [DrawIndirectCommand] -> ShowS

Storable DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

sizeOf :: DrawIndirectCommand -> Int

alignment :: DrawIndirectCommand -> Int

peekElemOff :: Ptr DrawIndirectCommand -> Int -> IO DrawIndirectCommand

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

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

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

peek :: Ptr DrawIndirectCommand -> IO DrawIndirectCommand

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

FromCStruct DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

peekCStruct :: Ptr DrawIndirectCommand -> IO DrawIndirectCommand

ToCStruct DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr DrawIndirectCommand -> DrawIndirectCommand -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DrawIndirectCommand -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DrawIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: DrawIndirectCommand

data DrawIndexedIndirectCommand

VkDrawIndexedIndirectCommand - Structure specifying a draw indexed indirect command

Description

The members of DrawIndexedIndirectCommand have the same meaning as the similarly named parameters of cmdDrawIndexed.

Valid Usage

• For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#fxvertex-input

• (indexSize × (firstIndex + indexCount) + offset) must be less than or equal to the size of the bound index buffer, with indexSize being based on the type specified by indexType, where the index buffer, indexType, and offset are specified via cmdBindIndexBuffer
• If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

See Also

cmdDrawIndexedIndirect

Constructors

DrawIndexedIndirectCommand

Fields

• indexCount :: Word32

  indexCount is the number of vertices to draw.

• instanceCount :: Word32

  instanceCount is the number of instances to draw.

• firstIndex :: Word32

  firstIndex is the base index within the index buffer.

• vertexOffset :: Int32

  vertexOffset is the value added to the vertex index before indexing into the vertex buffer.

• firstInstance :: Word32

  firstInstance is the instance ID of the first instance to draw.

Instances

Eq DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

(==) :: DrawIndexedIndirectCommand -> DrawIndexedIndirectCommand -> Bool

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

Show DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> DrawIndexedIndirectCommand -> ShowS

show :: DrawIndexedIndirectCommand -> String

showList :: [DrawIndexedIndirectCommand] -> ShowS

Storable DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

sizeOf :: DrawIndexedIndirectCommand -> Int

alignment :: DrawIndexedIndirectCommand -> Int

peekElemOff :: Ptr DrawIndexedIndirectCommand -> Int -> IO DrawIndexedIndirectCommand

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

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

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

peek :: Ptr DrawIndexedIndirectCommand -> IO DrawIndexedIndirectCommand

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

FromCStruct DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

peekCStruct :: Ptr DrawIndexedIndirectCommand -> IO DrawIndexedIndirectCommand

ToCStruct DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr DrawIndexedIndirectCommand -> DrawIndexedIndirectCommand -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DrawIndexedIndirectCommand -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DrawIndexedIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: DrawIndexedIndirectCommand

data DispatchIndirectCommand

VkDispatchIndirectCommand - Structure specifying a dispatch indirect command

Description

The members of DispatchIndirectCommand have the same meaning as the corresponding parameters of cmdDispatch.

Valid Usage

See Also

cmdDispatchIndirect

Constructors

DispatchIndirectCommand

Fields

• x :: Word32

  x is the number of local workgroups to dispatch in the X dimension.

  x must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0]

• y :: Word32

  y is the number of local workgroups to dispatch in the Y dimension.

  y must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1]

• z :: Word32

  z is the number of local workgroups to dispatch in the Z dimension.

  z must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

Instances

Eq DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

(==) :: DispatchIndirectCommand -> DispatchIndirectCommand -> Bool

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

Show DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

showsPrec :: Int -> DispatchIndirectCommand -> ShowS

show :: DispatchIndirectCommand -> String

showList :: [DispatchIndirectCommand] -> ShowS

Storable DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

sizeOf :: DispatchIndirectCommand -> Int

alignment :: DispatchIndirectCommand -> Int

peekElemOff :: Ptr DispatchIndirectCommand -> Int -> IO DispatchIndirectCommand

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

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

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

peek :: Ptr DispatchIndirectCommand -> IO DispatchIndirectCommand

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

FromCStruct DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

peekCStruct :: Ptr DispatchIndirectCommand -> IO DispatchIndirectCommand

ToCStruct DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr DispatchIndirectCommand -> DispatchIndirectCommand -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DispatchIndirectCommand -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DispatchIndirectCommand

Defined in Vulkan.Core10.OtherTypes

Methods

zero :: DispatchIndirectCommand

data BaseOutStructure

VkBaseOutStructure - Base structure for a read-only pointer chain

Description

BaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

BaseOutStructure, StructureType

Constructors

BaseOutStructure

Fields

• sType :: StructureType

  sType is the structure type of the structure being iterated through.

• next :: Ptr BaseOutStructure

  pNext is NULL or a pointer to the next structure in a structure chain.

Instances

Eq BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

(==) :: BaseOutStructure -> BaseOutStructure -> Bool

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

Show BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

showsPrec :: Int -> BaseOutStructure -> ShowS

show :: BaseOutStructure -> String

showList :: [BaseOutStructure] -> ShowS

Storable BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

sizeOf :: BaseOutStructure -> Int

alignment :: BaseOutStructure -> Int

peekElemOff :: Ptr BaseOutStructure -> Int -> IO BaseOutStructure

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

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

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

peek :: Ptr BaseOutStructure -> IO BaseOutStructure

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

FromCStruct BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

peekCStruct :: Ptr BaseOutStructure -> IO BaseOutStructure

ToCStruct BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

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

pokeCStruct :: Ptr BaseOutStructure -> BaseOutStructure -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BaseOutStructure -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BaseOutStructure

Defined in Vulkan.CStruct.Extends

Methods

zero :: BaseOutStructure

data BaseInStructure

VkBaseInStructure - Base structure for a read-only pointer chain

Description

BaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

BaseInStructure, StructureType

Constructors

BaseInStructure

Fields

• sType :: StructureType

  sType is the structure type of the structure being iterated through.

• next :: Ptr BaseInStructure

  pNext is NULL or a pointer to the next structure in a structure chain.

Instances

Eq BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

(==) :: BaseInStructure -> BaseInStructure -> Bool

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

Show BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

showsPrec :: Int -> BaseInStructure -> ShowS

show :: BaseInStructure -> String

showList :: [BaseInStructure] -> ShowS

Storable BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

sizeOf :: BaseInStructure -> Int

alignment :: BaseInStructure -> Int

peekElemOff :: Ptr BaseInStructure -> Int -> IO BaseInStructure

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

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

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

peek :: Ptr BaseInStructure -> IO BaseInStructure

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

FromCStruct BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

peekCStruct :: Ptr BaseInStructure -> IO BaseInStructure

ToCStruct BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

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

pokeCStruct :: Ptr BaseInStructure -> BaseInStructure -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BaseInStructure -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BaseInStructure

Defined in Vulkan.CStruct.Extends

Methods

zero :: BaseInStructure

newtype ObjectType

VkObjectType - Specify an enumeration to track object handle types

Description

'

ObjectType	Vulkan Handle Type
OBJECT_TYPE_UNKNOWN	Unknown/Undefined Handle
OBJECT_TYPE_INSTANCE	Instance
OBJECT_TYPE_PHYSICAL_DEVICE	PhysicalDevice
OBJECT_TYPE_DEVICE	Device
OBJECT_TYPE_QUEUE	Queue
OBJECT_TYPE_SEMAPHORE	Semaphore
OBJECT_TYPE_COMMAND_BUFFER	CommandBuffer
OBJECT_TYPE_FENCE	Fence
OBJECT_TYPE_DEVICE_MEMORY	DeviceMemory
OBJECT_TYPE_BUFFER	Buffer
OBJECT_TYPE_IMAGE	Image
OBJECT_TYPE_EVENT	Event
OBJECT_TYPE_QUERY_POOL	QueryPool
OBJECT_TYPE_BUFFER_VIEW	BufferView
OBJECT_TYPE_IMAGE_VIEW	ImageView
OBJECT_TYPE_SHADER_MODULE	ShaderModule
OBJECT_TYPE_PIPELINE_CACHE	PipelineCache
OBJECT_TYPE_PIPELINE_LAYOUT	PipelineLayout
OBJECT_TYPE_RENDER_PASS	RenderPass
OBJECT_TYPE_PIPELINE	Pipeline
OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT	DescriptorSetLayout
OBJECT_TYPE_SAMPLER	Sampler
OBJECT_TYPE_DESCRIPTOR_POOL	DescriptorPool
OBJECT_TYPE_DESCRIPTOR_SET	DescriptorSet
OBJECT_TYPE_FRAMEBUFFER	Framebuffer
OBJECT_TYPE_COMMAND_POOL	CommandPool
OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION	SamplerYcbcrConversion
OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE	DescriptorUpdateTemplate
OBJECT_TYPE_SURFACE_KHR	SurfaceKHR
OBJECT_TYPE_SWAPCHAIN_KHR	SwapchainKHR
OBJECT_TYPE_DISPLAY_KHR	DisplayKHR
OBJECT_TYPE_DISPLAY_MODE_KHR	DisplayModeKHR
OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT	DebugReportCallbackEXT
OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NV	IndirectCommandsLayoutNV
OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT	DebugUtilsMessengerEXT
OBJECT_TYPE_VALIDATION_CACHE_EXT	ValidationCacheEXT
OBJECT_TYPE_ACCELERATION_STRUCTURE_NV	AccelerationStructureNV
OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR	AccelerationStructureKHR
OBJECT_TYPE_PERFORMANCE_CONFIGURATION_INTEL	PerformanceConfigurationINTEL
OBJECT_TYPE_DEFERRED_OPERATION_KHR	DeferredOperationKHR
OBJECT_TYPE_PRIVATE_DATA_SLOT_EXT	PrivateDataSlotEXT

ObjectType and Vulkan Handle Relationship

See Also

DebugUtilsObjectNameInfoEXT, DebugUtilsObjectTagInfoEXT, DeviceMemoryReportCallbackDataEXT, getPrivateDataEXT, setPrivateDataEXT

Constructors

ObjectType Int32

Bundled Patterns

pattern OBJECT_TYPE_UNKNOWN :: ObjectType

pattern OBJECT_TYPE_INSTANCE :: ObjectType

pattern OBJECT_TYPE_PHYSICAL_DEVICE :: ObjectType

pattern OBJECT_TYPE_DEVICE :: ObjectType

pattern OBJECT_TYPE_QUEUE :: ObjectType

pattern OBJECT_TYPE_SEMAPHORE :: ObjectType

pattern OBJECT_TYPE_COMMAND_BUFFER :: ObjectType

pattern OBJECT_TYPE_FENCE :: ObjectType

pattern OBJECT_TYPE_DEVICE_MEMORY :: ObjectType

pattern OBJECT_TYPE_BUFFER :: ObjectType

pattern OBJECT_TYPE_IMAGE :: ObjectType

pattern OBJECT_TYPE_EVENT :: ObjectType

pattern OBJECT_TYPE_QUERY_POOL :: ObjectType

pattern OBJECT_TYPE_BUFFER_VIEW :: ObjectType

pattern OBJECT_TYPE_IMAGE_VIEW :: ObjectType

pattern OBJECT_TYPE_SHADER_MODULE :: ObjectType

pattern OBJECT_TYPE_PIPELINE_CACHE :: ObjectType

pattern OBJECT_TYPE_PIPELINE_LAYOUT :: ObjectType

pattern OBJECT_TYPE_RENDER_PASS :: ObjectType

pattern OBJECT_TYPE_PIPELINE :: ObjectType

pattern OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT :: ObjectType

pattern OBJECT_TYPE_SAMPLER :: ObjectType

pattern OBJECT_TYPE_DESCRIPTOR_POOL :: ObjectType

pattern OBJECT_TYPE_DESCRIPTOR_SET :: ObjectType

pattern OBJECT_TYPE_FRAMEBUFFER :: ObjectType

pattern OBJECT_TYPE_COMMAND_POOL :: ObjectType

pattern OBJECT_TYPE_PRIVATE_DATA_SLOT_EXT :: ObjectType

pattern OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NV :: ObjectType

pattern OBJECT_TYPE_DEFERRED_OPERATION_KHR :: ObjectType

pattern OBJECT_TYPE_PERFORMANCE_CONFIGURATION_INTEL :: ObjectType

pattern OBJECT_TYPE_ACCELERATION_STRUCTURE_NV :: ObjectType

pattern OBJECT_TYPE_VALIDATION_CACHE_EXT :: ObjectType

pattern OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR :: ObjectType

pattern OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT :: ObjectType

pattern OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT :: ObjectType

pattern OBJECT_TYPE_DISPLAY_MODE_KHR :: ObjectType

pattern OBJECT_TYPE_DISPLAY_KHR :: ObjectType

pattern OBJECT_TYPE_SWAPCHAIN_KHR :: ObjectType

pattern OBJECT_TYPE_SURFACE_KHR :: ObjectType

pattern OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE :: ObjectType

pattern OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION :: ObjectType

Instances

Eq ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

(==) :: ObjectType -> ObjectType -> Bool

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

Ord ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

compare :: ObjectType -> ObjectType -> Ordering

(<) :: ObjectType -> ObjectType -> Bool

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

(>) :: ObjectType -> ObjectType -> Bool

(>=) :: ObjectType -> ObjectType -> Bool

max :: ObjectType -> ObjectType -> ObjectType

min :: ObjectType -> ObjectType -> ObjectType

Read ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

readsPrec :: Int -> ReadS ObjectType

readList :: ReadS [ObjectType]

readPrec :: ReadPrec ObjectType

readListPrec :: ReadPrec [ObjectType]

Show ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

showsPrec :: Int -> ObjectType -> ShowS

show :: ObjectType -> String

showList :: [ObjectType] -> ShowS

Storable ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

sizeOf :: ObjectType -> Int

alignment :: ObjectType -> Int

peekElemOff :: Ptr ObjectType -> Int -> IO ObjectType

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

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

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

peek :: Ptr ObjectType -> IO ObjectType

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

Zero ObjectType

Defined in Vulkan.Core10.Enums.ObjectType

Methods

zero :: ObjectType

newtype VendorId

VkVendorId - Khronos vendor IDs

Description

Note

Khronos vendor IDs may be allocated by vendors at any time. Only the latest canonical versions of this Specification, of the corresponding vk.xml API Registry, and of the corresponding vulkan_core.h header file must contain all reserved Khronos vendor IDs.

Only Khronos vendor IDs are given symbolic names at present. PCI vendor IDs returned by the implementation can be looked up in the PCI-SIG database.

See Also

No cross-references are available

Constructors

VendorId Int32

Bundled Patterns

pattern VENDOR_ID_VIV :: VendorId

pattern VENDOR_ID_VSI :: VendorId

pattern VENDOR_ID_KAZAN :: VendorId

pattern VENDOR_ID_CODEPLAY :: VendorId

pattern VENDOR_ID_MESA :: VendorId

pattern VENDOR_ID_POCL :: VendorId

Instances

Eq VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

(==) :: VendorId -> VendorId -> Bool

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

Ord VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

compare :: VendorId -> VendorId -> Ordering

(<) :: VendorId -> VendorId -> Bool

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

(>) :: VendorId -> VendorId -> Bool

(>=) :: VendorId -> VendorId -> Bool

max :: VendorId -> VendorId -> VendorId

min :: VendorId -> VendorId -> VendorId

Read VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

readsPrec :: Int -> ReadS VendorId

readList :: ReadS [VendorId]

readPrec :: ReadPrec VendorId

readListPrec :: ReadPrec [VendorId]

Show VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

showsPrec :: Int -> VendorId -> ShowS

show :: VendorId -> String

showList :: [VendorId] -> ShowS

Storable VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

sizeOf :: VendorId -> Int

alignment :: VendorId -> Int

peekElemOff :: Ptr VendorId -> Int -> IO VendorId

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

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

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

peek :: Ptr VendorId -> IO VendorId

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

Zero VendorId

Defined in Vulkan.Core10.Enums.VendorId

Methods

zero :: VendorId