Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- data MemoryBarrier = MemoryBarrier {}
- data BufferMemoryBarrier (es :: [Type]) = BufferMemoryBarrier {}
- data ImageMemoryBarrier (es :: [Type]) = ImageMemoryBarrier {}
- data PipelineCacheHeaderVersionOne = PipelineCacheHeaderVersionOne {}
- data DrawIndirectCommand = DrawIndirectCommand {}
- data DrawIndexedIndirectCommand = DrawIndexedIndirectCommand {}
- data DispatchIndirectCommand = DispatchIndirectCommand {}
- data BaseOutStructure = BaseOutStructure {}
- data BaseInStructure = BaseInStructure {}
- newtype ObjectType where
- ObjectType Int32
- 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_SHADER_EXT :: ObjectType
- pattern OBJECT_TYPE_OPTICAL_FLOW_SESSION_NV :: ObjectType
- pattern OBJECT_TYPE_MICROMAP_EXT :: ObjectType
- pattern OBJECT_TYPE_BUFFER_COLLECTION_FUCHSIA :: ObjectType
- pattern OBJECT_TYPE_CUDA_FUNCTION_NV :: ObjectType
- pattern OBJECT_TYPE_CUDA_MODULE_NV :: 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_CU_FUNCTION_NVX :: ObjectType
- pattern OBJECT_TYPE_CU_MODULE_NVX :: 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_PRIVATE_DATA_SLOT :: ObjectType
- pattern OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE :: ObjectType
- pattern OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION :: ObjectType
- newtype VendorId where
- VendorId Int32
- 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
- pattern VENDOR_ID_MOBILEYE :: VendorId
Documentation
data MemoryBarrier Source #
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
VK_VERSION_1_0,
AccessFlags
,
StructureType
,
cmdPipelineBarrier
,
cmdWaitEvents
MemoryBarrier | |
|
Instances
data BufferMemoryBarrier (es :: [Type]) Source #
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
, a
memory domain operation
is performed where available memory in the host domain is also made
available to the device domain.
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
, a
memory domain operation
is performed where available memory in the device domain is also made
available to the host domain.
Note
When
MEMORY_PROPERTY_HOST_COHERENT_BIT
is used, available memory in host domain is automatically made visible
to host domain, and any host write is automatically made available to
host domain.
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
- If
size
is not equal toWHOLE_SIZE
,size
must be greater than0
- If
size
is not equal toWHOLE_SIZE
,size
must be less than or equal to than the size ofbuffer
minusoffset
- If
buffer
is non-sparse then it must be bound completely and contiguously to a singleDeviceMemory
object - If
buffer
was created with a sharing mode ofSHARING_MODE_EXCLUSIVE
, andsrcQueueFamilyIndex
anddstQueueFamilyIndex
are not equal,srcQueueFamilyIndex
must beQUEUE_FAMILY_EXTERNAL
,QUEUE_FAMILY_FOREIGN_EXT
, or a valid queue family - If
buffer
was created with a sharing mode ofSHARING_MODE_EXCLUSIVE
, andsrcQueueFamilyIndex
anddstQueueFamilyIndex
are not equal,dstQueueFamilyIndex
must beQUEUE_FAMILY_EXTERNAL
,QUEUE_FAMILY_FOREIGN_EXT
, or a valid queue family - If
srcQueueFamilyIndex
is not equal todstQueueFamilyIndex
, at least one ofsrcQueueFamilyIndex
ordstQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
orQUEUE_FAMILY_FOREIGN_EXT
- If the
VK_KHR_external_memory
extension is not enabled, and the value of
ApplicationInfo
::apiVersion
used to create theInstance
is not greater than or equal to Version 1.1,srcQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
- If the
VK_KHR_external_memory
extension is not enabled, and the value of
ApplicationInfo
::apiVersion
used to create theInstance
is not greater than or equal to Version 1.1,dstQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
- If the
VK_EXT_queue_family_foreign
extension is not enabled
srcQueueFamilyIndex
must not beQUEUE_FAMILY_FOREIGN_EXT
- If the
VK_EXT_queue_family_foreign
extension is not enabled
dstQueueFamilyIndex
must not beQUEUE_FAMILY_FOREIGN_EXT
- If the
synchronization2
feature is not enabled, and
buffer
was created with a sharing mode ofSHARING_MODE_CONCURRENT
, at least one ofsrcQueueFamilyIndex
anddstQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
- If the
synchronization2
feature is not enabled, and
buffer
was created with a sharing mode ofSHARING_MODE_CONCURRENT
,srcQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
orQUEUE_FAMILY_EXTERNAL
- If the
synchronization2
feature is not enabled, and
buffer
was created with a sharing mode ofSHARING_MODE_CONCURRENT
,dstQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
orQUEUE_FAMILY_EXTERNAL
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
-
pNext
must beNULL
or a pointer to a valid instance ofExternalMemoryAcquireUnmodifiedEXT
- The
sType
value of each struct in thepNext
chain must be unique -
buffer
must be a validBuffer
handle
See Also
VK_VERSION_1_0,
AccessFlags
,
Buffer
,
DeviceSize
,
StructureType
,
cmdPipelineBarrier
,
cmdWaitEvents
BufferMemoryBarrier | |
|
Instances
data ImageMemoryBarrier (es :: [Type]) Source #
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
.
If the
synchronization2
feature is not enabled or oldLayout
is not equal to newLayout
,
oldLayout
and newLayout
define an
image layout transition
for the specified image subresource range.
Note
If the synchronization2 feature is enabled, when the old and new layout are equal, the layout values are ignored - data is preserved no matter what values are specified, or what layout the image is currently in.
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
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_COLOR_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_SAMPLED_BIT
orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_TRANSFER_SRC_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_TRANSFER_DST_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition,oldLayout
must beIMAGE_LAYOUT_UNDEFINED
or the current layout of the image subresources affected by the barrier - If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition,newLayout
must not beIMAGE_LAYOUT_UNDEFINED
orIMAGE_LAYOUT_PREINITIALIZED
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
thenimage
must have been created with at least one ofIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
,IMAGE_USAGE_SAMPLED_BIT
, orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
set - If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
thenimage
must have been created with at least one ofIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
,IMAGE_USAGE_SAMPLED_BIT
, orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL
thenimage
must have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
set - If the
synchronization2
feature is not enabled,
oldLayout
must not beIMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR
orIMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
- If the
synchronization2
feature is not enabled,
newLayout
must not beIMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR
orIMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_ATTACHMENT_OPTIMAL
,image
must have been created withIMAGE_USAGE_COLOR_ATTACHMENT_BIT
orIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_READ_ONLY_OPTIMAL
,image
must have been created with at least one ofIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
,IMAGE_USAGE_SAMPLED_BIT
, orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
thenimage
must have been created withIMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
set - If
image
was created with a sharing mode ofSHARING_MODE_EXCLUSIVE
, andsrcQueueFamilyIndex
anddstQueueFamilyIndex
are not equal,srcQueueFamilyIndex
must beQUEUE_FAMILY_EXTERNAL
,QUEUE_FAMILY_FOREIGN_EXT
, or a valid queue family - If
image
was created with a sharing mode ofSHARING_MODE_EXCLUSIVE
, andsrcQueueFamilyIndex
anddstQueueFamilyIndex
are not equal,dstQueueFamilyIndex
must beQUEUE_FAMILY_EXTERNAL
,QUEUE_FAMILY_FOREIGN_EXT
, or a valid queue family - If
srcQueueFamilyIndex
is not equal todstQueueFamilyIndex
, at least one ofsrcQueueFamilyIndex
ordstQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
orQUEUE_FAMILY_FOREIGN_EXT
- If the
VK_KHR_external_memory
extension is not enabled, and the value of
ApplicationInfo
::apiVersion
used to create theInstance
is not greater than or equal to Version 1.1,srcQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
- If the
VK_KHR_external_memory
extension is not enabled, and the value of
ApplicationInfo
::apiVersion
used to create theInstance
is not greater than or equal to Version 1.1,dstQueueFamilyIndex
must not beQUEUE_FAMILY_EXTERNAL
- If the
VK_EXT_queue_family_foreign
extension is not enabled
srcQueueFamilyIndex
must not beQUEUE_FAMILY_FOREIGN_EXT
- If the
VK_EXT_queue_family_foreign
extension is not enabled
dstQueueFamilyIndex
must not beQUEUE_FAMILY_FOREIGN_EXT
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isVK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR
thenimage
must have been created withVK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR
- If
srcQueueFamilyIndex
anddstQueueFamilyIndex
define a queue family ownership transfer oroldLayout
andnewLayout
define an image layout transition, andoldLayout
ornewLayout
isIMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
thenimage
must have been created with either theIMAGE_USAGE_COLOR_ATTACHMENT_BIT
orIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
usage bits, and theIMAGE_USAGE_INPUT_ATTACHMENT_BIT
orIMAGE_USAGE_SAMPLED_BIT
usage bits, and theIMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT
usage bit - If
the
attachmentFeedbackLoopLayout
feature is not enabled,
newLayout
must not beIMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
-
subresourceRange.baseMipLevel
must be less than themipLevels
specified inImageCreateInfo
whenimage
was created - If
subresourceRange.levelCount
is notREMAINING_MIP_LEVELS
,subresourceRange.baseMipLevel
+subresourceRange.levelCount
must be less than or equal to themipLevels
specified inImageCreateInfo
whenimage
was created -
subresourceRange.baseArrayLayer
must be less than thearrayLayers
specified inImageCreateInfo
whenimage
was created - If
subresourceRange.layerCount
is notREMAINING_ARRAY_LAYERS
,subresourceRange.baseArrayLayer
+subresourceRange.layerCount
must be less than or equal to thearrayLayers
specified inImageCreateInfo
whenimage
was created - If
image
is non-sparse then it must be bound completely and contiguously to a singleDeviceMemory
object - If
image
has a color format that is single-plane, then theaspectMask
member ofsubresourceRange
must beIMAGE_ASPECT_COLOR_BIT
- If
image
has a color format and is not disjoint, then theaspectMask
member ofsubresourceRange
must beIMAGE_ASPECT_COLOR_BIT
- If
image
has a multi-planar format and the image is disjoint, then theaspectMask
member ofsubresourceRange
must include at least one multi-planar aspect mask bit orIMAGE_ASPECT_COLOR_BIT
- If
image
has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is enabled, then theaspectMask
member ofsubresourceRange
must include either or bothIMAGE_ASPECT_DEPTH_BIT
andIMAGE_ASPECT_STENCIL_BIT
- If
image
has a depth/stencil format with both depth and stencil and the separateDepthStencilLayouts feature is not enabled, then theaspectMask
member ofsubresourceRange
must include bothIMAGE_ASPECT_DEPTH_BIT
andIMAGE_ASPECT_STENCIL_BIT
- If the
aspectMask
member ofsubresourceRange
includesIMAGE_ASPECT_DEPTH_BIT
,oldLayout
andnewLayout
must not be one ofIMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL
orIMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
- If the
aspectMask
member ofsubresourceRange
includesIMAGE_ASPECT_STENCIL_BIT
,oldLayout
andnewLayout
must not be one ofIMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL
orIMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
- If the
synchronization2
feature is not enabled, and
image
was created with a sharing mode ofSHARING_MODE_CONCURRENT
, at least one ofsrcQueueFamilyIndex
anddstQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
- If the
synchronization2
feature is not enabled, and
image
was created with a sharing mode ofSHARING_MODE_CONCURRENT
,srcQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
orQUEUE_FAMILY_EXTERNAL
- If the
synchronization2
feature is not enabled, and
image
was created with a sharing mode ofSHARING_MODE_CONCURRENT
,dstQueueFamilyIndex
must beQUEUE_FAMILY_IGNORED
orQUEUE_FAMILY_EXTERNAL
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofExternalMemoryAcquireUnmodifiedEXT
orSampleLocationsInfoEXT
- The
sType
value of each struct in thepNext
chain must be unique -
oldLayout
must be a validImageLayout
value -
newLayout
must be a validImageLayout
value -
image
must be a validImage
handle -
subresourceRange
must be a validImageSubresourceRange
structure
See Also
VK_VERSION_1_0,
AccessFlags
,
Image
,
ImageLayout
,
ImageSubresourceRange
,
StructureType
,
cmdPipelineBarrier
,
cmdWaitEvents
ImageMemoryBarrier | |
|
Instances
data PipelineCacheHeaderVersionOne Source #
VkPipelineCacheHeaderVersionOne - Structure describing the layout of the pipeline cache header
Description
Unlike most structures declared by the Vulkan API, all fields of this structure are written with the least significant byte first, regardless of host byte-order.
The C language specification does not define the packing of structure members. This layout assumes tight structure member packing, with members laid out in the order listed in the structure, and the intended size of the structure is 32 bytes. If a compiler produces code that diverges from that pattern, applications must employ another method to set values at the correct offsets.
Valid Usage (Implicit)
See Also
PipelineCacheHeaderVersionOne | |
|
Instances
data DrawIndirectCommand Source #
VkDrawIndirectCommand - Structure specifying a indirect drawing 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://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fxvertex-input
- If the
drawIndirectFirstInstance
feature is not enabled,
firstInstance
must be0
See Also
DrawIndirectCommand | |
|
Instances
data DrawIndexedIndirectCommand Source #
VkDrawIndexedIndirectCommand - Structure specifying a indexed indirect drawing command
Description
The members of DrawIndexedIndirectCommand
have the same meaning as the
similarly named parameters of
cmdDrawIndexed
.
Valid Usage
- If
robustBufferAccess2
is not enabled, (
indexSize
× (firstIndex
+indexCount
) +offset
) must be less than or equal to the size of the bound index buffer, withindexSize
being based on the type specified byindexType
, where the index buffer,indexType
, andoffset
are specified viacmdBindIndexBuffer
orcmdBindIndexBuffer2KHR
. IfcmdBindIndexBuffer2KHR
is used to bind the index buffer, the size of the bound index buffer iscmdBindIndexBuffer2KHR
::size
- For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fxvertex-input
- If the
drawIndirectFirstInstance
feature is not enabled,
firstInstance
must be0
See Also
DrawIndexedIndirectCommand | |
|
Instances
data DispatchIndirectCommand Source #
VkDispatchIndirectCommand - Structure specifying a indirect dispatching command
Description
The members of DispatchIndirectCommand
have the same meaning as the
corresponding parameters of
cmdDispatch
.
Valid Usage
See Also
DispatchIndirectCommand | |
|
Instances
data BaseOutStructure Source #
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
VK_VERSION_1_0,
BaseOutStructure
, StructureType
,
getPipelinePropertiesEXT
BaseOutStructure | |
|
Instances
data BaseInStructure Source #
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 | |
|
Instances
newtype ObjectType Source #
VkObjectType - Specify an enumeration to track object handle types
Description
'
ObjectType
and Vulkan Handle Relationship
See Also
VK_VERSION_1_0,
DebugUtilsObjectNameInfoEXT
,
DebugUtilsObjectTagInfoEXT
,
DeviceMemoryReportCallbackDataEXT
,
getPrivateData
,
getPrivateDataEXT
,
setPrivateData
,
setPrivateDataEXT
Instances
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
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 | |
pattern VENDOR_ID_MOBILEYE :: VendorId |
Instances
Storable VendorId Source # | |
Defined in Vulkan.Core10.Enums.VendorId | |
Read VendorId Source # | |
Show VendorId Source # | |
Eq VendorId Source # | |
Ord VendorId Source # | |
Defined in Vulkan.Core10.Enums.VendorId | |
Zero VendorId Source # | |
Defined in Vulkan.Core10.Enums.VendorId |