-- --

If viewFormatCount is not 0, all of the formats -- in the pViewFormats array must be compatible with the -- format specified in the format field of -- VkImageCreateInfo, as described in the compatibility -- table.

-- --

If VkImageCreateInfo::flags does not contain -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, viewFormatCount -- must be 0 or 1.
If viewFormatCount is not 0, -- VkImageCreateInfo::format must be in -- pViewFormats.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO_KHR

-- --

If viewFormatCount is not 0, -- pViewFormats must be a valid pointer to an array of -- viewFormatCount valid VkFormat values

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_MODULATION_STATE_CREATE_INFO_NV

-- --

flags must be 0
coverageModulationMode must be a valid -- VkCoverageModulationModeNV value
coverageModulationTableCount must be greater than -- 0

-- --

Description

-- --

VK_SYSTEM_ALLOCATION_SCOPE_COMMAND specifies that the -- allocation is scoped to the duration of the Vulkan command.

-- --

VK_SYSTEM_ALLOCATION_SCOPE_OBJECT specifies that the -- allocation is scoped to the lifetime of the Vulkan object that is -- being created or used.
VK_SYSTEM_ALLOCATION_SCOPE_CACHE specifies that the -- allocation is scoped to the lifetime of a VkPipelineCache or -- VkValidationCacheEXT object.
VK_SYSTEM_ALLOCATION_SCOPE_DEVICE specifies that the -- allocation is scoped to the lifetime of the Vulkan device.
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE specifies that the -- allocation is scoped to the lifetime of the Vulkan instance.

-- -- Most Vulkan commands operate on a single object, or there is a sole -- object that is being created or manipulated. When an allocation uses -- an allocation scope of VK_SYSTEM_ALLOCATION_SCOPE_OBJECT or -- VK_SYSTEM_ALLOCATION_SCOPE_CACHE, the allocation is scoped to -- the object being created or manipulated. -- -- When an implementation requires host memory, it will make callbacks to -- the application using the most specific allocator and allocation scope -- available: -- --

If an allocation is scoped to the duration of a command, the -- allocator will use the VK_SYSTEM_ALLOCATION_SCOPE_COMMAND -- allocation scope. The most specific allocator available is used: if -- the object being created or manipulated has an allocator, that -- object’s allocator will be used, else if the parent VkDevice -- has an allocator it will be used, else if the parent -- VkInstance has an allocator it will be used. Else,
If an allocation is associated with an object of type -- VkValidationCacheEXT or VkPipelineCache, the -- allocator will use the VK_SYSTEM_ALLOCATION_SCOPE_CACHE -- allocation scope. The most specific allocator available is used -- (cache, else device, else instance). Else,
If an allocation is scoped to the lifetime of an object, that -- object is being created or manipulated by the command, and that -- object’s type is not VkDevice or VkInstance, the -- allocator will use an allocation scope of -- VK_SYSTEM_ALLOCATION_SCOPE_OBJECT. The most specific -- allocator available is used (object, else device, else instance). -- Else,
If an allocation is scoped to the lifetime of a device, the -- allocator will use an allocation scope of -- VK_SYSTEM_ALLOCATION_SCOPE_DEVICE. The most specific -- allocator available is used (device, else instance). Else,
If the allocation is scoped to the lifetime of an instance and the -- instance has an allocator, its allocator will be used with an -- allocation scope of VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE.
Otherwise an implementation will allocate memory through an -- alternative mechanism that is unspecified.

-- --

Description

-- -- VkInstanceCreateFlags is a bitmask type for setting a mask, -- but is currently reserved for future use. -- --

Description

-- --

VK_QUEUE_GRAPHICS_BIT specifies that queues in this queue -- family support graphics operations.

-- --

VK_QUEUE_COMPUTE_BIT specifies that queues in this queue -- family support compute operations.
VK_QUEUE_TRANSFER_BIT specifies that queues in this queue -- family support transfer operations.
VK_QUEUE_SPARSE_BINDING_BIT specifies that queues in this -- queue family support sparse memory management operations (see -- Sparse Resources). If any of the sparse resource features are -- enabled, then at least one queue family must support this -- bit.

-- -- If an implementation exposes any queue family that supports graphics -- operations, at least one queue family of at least one physical device -- exposed by the implementation must support both graphics and -- compute operations. -- -- Note -- -- All commands that are allowed on a queue that supports transfer -- operations are also allowed on a queue that supports either graphics -- or compute operations. Thus, if the capabilities of a queue family -- include VK_QUEUE_GRAPHICS_BIT or -- VK_QUEUE_COMPUTE_BIT, then reporting the -- VK_QUEUE_TRANSFER_BIT capability separately for that queue -- family is optional. -- -- For further details see Queues. -- --

Description

-- --

VK_IMAGE_CREATE_SPARSE_BINDING_BIT specifies that the -- image will be backed using sparse memory binding.

-- --

VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT specifies that the -- image can be partially backed using sparse memory binding. -- Images created with this flag must also be created with the -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT flag.
VK_IMAGE_CREATE_SPARSE_ALIASED_BIT specifies that the -- image will be backed using sparse memory binding with memory ranges -- that might also simultaneously be backing another image (or another -- portion of the same image). Images created with this flag must -- also be created with the VK_IMAGE_CREATE_SPARSE_BINDING_BIT -- flag
VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that the -- image can be used to create a VkImageView with a -- different format from the image. For multi-planar formats, -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that a -- VkImageView can be created of a plane of the -- image.
VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT specifies that the -- image can be used to create a VkImageView of type -- VK_IMAGE_VIEW_TYPE_CUBE or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY.
VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT specifies that -- the image can be used to create a VkImageView of type -- VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY.
VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT specifies -- that the image can be used with a non-zero value of the -- splitInstanceBindRegionCount member of a -- VkBindImageMemoryDeviceGroupInfo structure passed into -- vkBindImageMemory2. This flag also has the effect of making the -- image use the standard sparse image block dimensions.
VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT specifies -- that the image having a compressed format can be used to create -- a VkImageView with an uncompressed format where each texel in -- the image view corresponds to a compressed texel block of the -- image.
VK_IMAGE_CREATE_EXTENDED_USAGE_BIT specifies that the -- image can be created with usage flags that are not supported -- for the format the image is created with but are supported for at -- least one format a VkImageView created from the image -- can have.
VK_IMAGE_CREATE_DISJOINT_BIT specifies that an image with -- a multi-planar format must have each plane separately -- bound to memory, rather than having a single memory binding for the -- whole image; the presence of this bit distinguishes a disjoint -- image from an image without this bit set.
VK_IMAGE_CREATE_ALIAS_BIT specifies that two images -- created with the same creation parameters and aliased to the same -- memory can interpret the contents of the memory consistently -- with each other, subject to the rules described in the Memory -- Aliasing section. This flag further specifies that each plane of a -- disjoint image can share an in-memory non-linear -- representation with single-plane images, and that a single-plane image -- can share an in-memory non-linear representation with a plane -- of a multi-planar disjoint image, according to the rules in -- {html_spec_relative}#features-formats-compatible-planes. If the -- pNext chain includes a VkExternalMemoryImageCreateInfo -- or VkExternalMemoryImageCreateInfoNV structure whose -- handleTypes member is not 0, it is as if -- VK_IMAGE_CREATE_ALIAS_BIT is set.
VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- specifies that an image with a depth or depth/stencil format -- can be used with custom sample locations when used as a -- depth/stencil attachment.

-- -- See Sparse Resource Features and Sparse Physical Device -- Features for more details. -- --

Description

-- -- The following bits may be set in linearTilingFeatures -- and optimalTilingFeatures, specifying that the features are -- supported by images or image views created with the -- queried vkGetPhysicalDeviceFormatProperties::format: -- --

VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT specifies that an -- image view can be sampled from.
VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT specifies that an -- image view can be used as a storage images.
VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT specifies that -- an image view can be used as storage image that supports atomic -- operations.
VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT specifies that an -- image view can be used as a framebuffer color attachment and as -- an input attachment.
VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT specifies -- that an image view can be used as a framebuffer color -- attachment that supports blending and as an input attachment.
VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT specifies -- that an image view can be used as a framebuffer depth/stencil -- attachment and as an input attachment.
VK_FORMAT_FEATURE_BLIT_SRC_BIT specifies that an image -- can be used as srcImage for the -- vkCmdBlitImage command.
VK_FORMAT_FEATURE_BLIT_DST_BIT specifies that an image -- can be used as dstImage for the -- vkCmdBlitImage command.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT -- specifies that if VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT is also -- set, an image view can be used with a sampler that has either -- of magFilter or minFilter set to -- VK_FILTER_LINEAR, or mipmapMode set to -- VK_SAMPLER_MIPMAP_MODE_LINEAR. If -- VK_FORMAT_FEATURE_BLIT_SRC_BIT is also set, an image can be -- used as the srcImage to vkCmdBlitImage with a -- filter of VK_FILTER_LINEAR. This bit must -- only be exposed for formats that also support the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT or -- VK_FORMAT_FEATURE_BLIT_SRC_BIT.If the format being queried is -- a depth/stencil format, this bit only specifies that the depth aspect -- (not the stencil aspect) of an image of this format supports linear -- filtering, and that linear filtering of the depth aspect is supported -- whether depth compare is enabled in the sampler or not. If this bit is -- not present, linear filtering with depth compare disabled is -- unsupported and linear filtering with depth compare enabled is -- supported, but may compute the filtered value in an -- implementation-dependent manner which differs from the normal rules of -- linear filtering. The resulting value must be in the range -- [0,1] and should be proportional to, or a weighted average of, -- the number of comparison passes or failures.
VK_FORMAT_FEATURE_TRANSFER_SRC_BIT specifies that an -- image can be used as a source image for copy -- commands.
VK_FORMAT_FEATURE_TRANSFER_DST_BIT specifies that an -- image can be used as a destination image for copy -- commands and clear commands.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT_EXT -- specifies VkImage can be used as a sampled image with -- a min or max VkSamplerReductionModeEXT. This bit must -- only be exposed for formats that also support the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG -- specifies that VkImage can be used with a sampler that -- has either of magFilter or minFilter set to -- VK_FILTER_CUBIC_IMG, or be the source image for a blit with -- filter set to VK_FILTER_CUBIC_IMG. This bit -- must only be exposed for formats that also support the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT. If the format being -- queried is a depth/stencil format, this only specifies that the depth -- aspect is cubic filterable.
VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT specifies -- that an application can define a sampler Y’CBCR -- conversion using this format as a source, and that an image of -- this format can be used with a -- VkSamplerYcbcrConversionCreateInfo xChromaOffset -- and/or yChromaOffset of VK_CHROMA_LOCATION_MIDPOINT. -- Otherwise both xChromaOffset and yChromaOffset -- must be VK_CHROMA_LOCATION_COSITED_EVEN. If a format -- does not incorporate chroma downsampling (it is not a “422” or “420” -- format) but the implementation supports sampler Y’CBCR conversion for -- this format, the implementation must set -- VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT.
VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT specifies -- that an application can define a sampler Y’CBCR -- conversion using this format as a source, and that an image of -- this format can be used with a -- VkSamplerYcbcrConversionCreateInfo xChromaOffset -- and/or yChromaOffset of -- VK_CHROMA_LOCATION_COSITED_EVEN. Otherwise both -- xChromaOffset and yChromaOffset must be -- VK_CHROMA_LOCATION_MIDPOINT. If neither -- VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT nor -- VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT is set, the -- application must not define a sampler Y’CBCR conversion -- using this format as a source.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT -- specifies that the format can do linear sampler filtering -- (min/magFilter) whilst sampler Y’CBCR conversion is enabled.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT -- specifies that the format can have different chroma, min, and mag -- filters.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- specifies that reconstruction is explicit, as described in -- {html_spec_relative}#textures-chroma-reconstruction. If this -- bit is not present, reconstruction is implicit by default.
VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT -- specifies that reconstruction can be forcibly made explicit by -- setting -- VkSamplerYcbcrConversionCreateInfo::forceExplicitReconstruction -- to VK_TRUE.
VK_FORMAT_FEATURE_DISJOINT_BIT specifies that a -- multi-planar image can have the -- VK_IMAGE_CREATE_DISJOINT_BIT set during image creation. An -- implementation must not set -- VK_FORMAT_FEATURE_DISJOINT_BIT for single-plane -- formats.

-- -- The following bits may be set in bufferFeatures, -- specifying that the features are supported by buffers or -- buffer views created with the queried -- vkGetPhysicalDeviceProperties::format: -- --

VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT specifies that -- the format can be used to create a buffer view that can -- be bound to a VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER -- descriptor.
VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT specifies that -- the format can be used to create a buffer view that can -- be bound to a VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER -- descriptor.
VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT -- specifies that atomic operations are supported on -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER with this -- format.
VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT specifies that the -- format can be used as a vertex attribute format -- (VkVertexInputAttributeDescription::format).

-- --

Parameters

-- --

pUserData is the value specified for -- VkAllocationCallbacks::pUserData in the allocator -- specified by the application.

-- --

size is the requested size of an allocation.
allocationType is a VkInternalAllocationType value -- specifying the requested type of an allocation.
allocationScope is a VkSystemAllocationScope value -- specifying the allocation scope of the lifetime of the allocation, as -- described here.

-- --

Description

-- -- This is a purely informational callback. -- --

Parameters

-- --

pUserData is the value specified for -- VkAllocationCallbacks::pUserData in the allocator -- specified by the application.

-- --

size is the requested size of an allocation.
allocationType is a VkInternalAllocationType value -- specifying the requested type of an allocation.
allocationScope is a VkSystemAllocationScope value -- specifying the allocation scope of the lifetime of the allocation, as -- described here.

-- --

Description

-- --

Parameters

-- --

pUserData is the value specified for -- VkAllocationCallbacks::pUserData in the allocator -- specified by the application.

-- --

pOriginal must be either NULL or a -- pointer previously returned by pfnReallocation or -- pfnAllocation of the same allocator.
size is the size in bytes of the requested -- allocation.
alignment is the requested alignment of the allocation in -- bytes and must be a power of two.
allocationScope is a VkSystemAllocationScope value -- specifying the allocation scope of the lifetime of the allocation, as -- described here.

-- --

Description

-- -- pfnReallocation must return an allocation with enough -- space for size bytes, and the contents of the original -- allocation from bytes zero to min(original size, new size) - 1 -- must be preserved in the returned allocation. If size -- is larger than the old size, the contents of the additional space are -- undefined. If satisfying these requirements involves creating a new -- allocation, then the old allocation should be freed. -- -- If pOriginal is NULL, then pfnReallocation -- must behave equivalently to a call to -- PFN_vkAllocationFunction with the same parameter values -- (without pOriginal). -- -- If size is zero, then pfnReallocation must -- behave equivalently to a call to PFN_vkFreeFunction with the -- same pUserData parameter value, and pMemory equal to -- pOriginal. -- -- If pOriginal is non-NULL, the implementation -- must ensure that alignment is equal to the -- alignment used to originally allocate pOriginal. -- -- If this function fails and pOriginal is non-NULL the -- application must not free the old allocation. -- -- pfnReallocation must follow the same rules for -- return values as PFN_vkAllocationFunction. -- --

Parameters

-- --

pUserData is the value specified for -- VkAllocationCallbacks::pUserData in the allocator -- specified by the application.

-- --

size is the size in bytes of the requested -- allocation.
alignment is the requested alignment of the allocation in -- bytes and must be a power of two.
allocationScope is a VkSystemAllocationScope value -- specifying the allocation scope of the lifetime of the allocation, as -- described here.

-- --

Description

-- -- If pfnAllocation is unable to allocate the requested memory, -- it must return NULL. If the allocation was successful, -- it must return a valid pointer to memory allocation containing -- at least size bytes, and with the pointer value being a -- multiple of alignment. -- -- Note -- -- Correct Vulkan operation cannot be assumed if the application -- does not follow these rules. -- -- For example, pfnAllocation (or pfnReallocation) -- could cause termination of running Vulkan instance(s) on a failed -- allocation for debugging purposes, either directly or indirectly. In -- these circumstances, it cannot be assumed that any part of any -- affected VkInstance objects are going to operate correctly -- (even vkDestroyInstance), and the application must -- ensure it cleans up properly via other means (e.g. process -- termination). -- -- If pfnAllocation returns NULL, and if the -- implementation is unable to continue correct processing of the current -- command without the requested allocation, it must treat this as -- a run-time error, and generate VK_ERROR_OUT_OF_HOST_MEMORY at -- the appropriate time for the command in which the condition was -- detected, as described in Return Codes. -- -- If the implementation is able to continue correct processing of the -- current command without the requested allocation, then it may -- do so, and must not generate -- VK_ERROR_OUT_OF_HOST_MEMORY as a result of this failed -- allocation. -- --

Parameters

-- --

pUserData is the value specified for -- VkAllocationCallbacks::pUserData in the allocator -- specified by the application.

-- --

pMemory is the allocation to be freed.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INITIALIZATION_FAILED
```
```
VK_ERROR_LAYER_NOT_PRESENT
```
```
VK_ERROR_EXTENSION_NOT_PRESENT
```
```
VK_ERROR_INCOMPATIBLE_DRIVER
```

-- --

Parameters

-- --

instance is the handle of the instance to destroy.

-- --

pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All child objects created using instance must have -- been destroyed prior to destroying instance

-- --

If VkAllocationCallbacks were provided when -- instance was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- instance was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

If instance is not NULL, instance -- must be a valid VkInstance handle

-- --

If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure

-- --

Host Synchronization

-- --

Host access to instance must be externally -- synchronized

-- --

Parameters

-- --

instance is a handle to a Vulkan instance previously -- created with vkCreateInstance.

-- --

pPhysicalDeviceCount is a pointer to an integer related -- to the number of physical devices available or queried, as described -- below.
pPhysicalDevices is either NULL or a pointer to -- an array of VkPhysicalDevice handles.

-- --

Description

-- -- If pPhysicalDevices is NULL, then the number of -- physical devices available is returned in -- pPhysicalDeviceCount. Otherwise, -- pPhysicalDeviceCount must point to a variable set by -- the user to the number of elements in the pPhysicalDevices -- array, and on return the variable is overwritten with the number of -- handles actually written to pPhysicalDevices. If -- pPhysicalDeviceCount is less than the number of physical -- devices available, at most pPhysicalDeviceCount structures -- will be written. If pPhysicalDeviceCount is smaller than the -- number of physical devices available, VK_INCOMPLETE will be -- returned instead of VK_SUCCESS, to indicate that not all the -- available physical devices were returned. -- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

pPhysicalDeviceCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPhysicalDeviceCount is not -- 0, and pPhysicalDevices is not NULL, -- pPhysicalDevices must be a valid pointer to an array -- of pPhysicalDeviceCount VkPhysicalDevice -- handles

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INITIALIZATION_FAILED
```

-- --

Parameters

-- -- The table below defines the various use cases for -- vkGetDeviceProcAddr and expected return value for each case. -- --

Description

-- -- The returned function pointer is of type PFN_vkVoidFunction, -- and must be cast to the type of the command being queried. The -- function pointer must only be called with a dispatchable object -- (the first parameter) that is device or a child of -- device. -- --

--   +-----------------------+-----------------------+-----------------------+
--   | @device@              | @pName@               | return value          |
--   +=======================+=======================+=======================+
--   | @NULL@                | *                     | undefined             |
--   +-----------------------+-----------------------+-----------------------+
--   | invalid device        | *                     | undefined             |
--   +-----------------------+-----------------------+-----------------------+
--   | device                | @NULL@                | undefined             |
--   +-----------------------+-----------------------+-----------------------+
--   | device                | core device-level     | fp                    |
--   |                       | Vulkan command        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | device                | enabled device        | fp                    |
--   |                       | extension commands    |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | device                | * (any @pName@ not    | @NULL@                |
--   |                       | covered above)        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   
--   vkGetDeviceProcAddr behavior
--

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pName must be a null-terminated UTF-8 string

-- --

Parameters

-- --

instance is the instance that the function pointer will -- be compatible with, or NULL for commands not dependent on any -- instance.

-- --

pName is the name of the command to obtain.

-- --

Description

-- -- vkGetInstanceProcAddr itself is obtained in a platform- and -- loader- specific manner. Typically, the loader library will export -- this command as a function symbol, so applications can link -- against the loader library, or load it dynamically and look up the -- symbol using platform-specific APIs. -- -- The table below defines the various use cases for -- vkGetInstanceProcAddr and expected return value (“fp” is -- “function pointer”) for each case. -- -- The returned function pointer is of type PFN_vkVoidFunction, -- and must be cast to the type of the command being queried. -- --

--   +-----------------------+-----------------------+-----------------------+
--   | @instance@            | @pName@               | return value          |
--   +=======================+=======================+=======================+
--   | *                     | @NULL@                | undefined             |
--   +-----------------------+-----------------------+-----------------------+
--   | invalid instance      | *                     | undefined             |
--   +-----------------------+-----------------------+-----------------------+
--   | @NULL@                | 'Graphics.Vulkan.Core | fp                    |
--   |                       | 10.ExtensionDiscovery |                       |
--   |                       | .vkEnumerateInstanceE |                       |
--   |                       | xtensionProperties'   |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | @NULL@                | 'Graphics.Vulkan.Core | fp                    |
--   |                       | 10.LayerDiscovery.vkE |                       |
--   |                       | numerateInstanceLayer |                       |
--   |                       | Properties'           |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | @NULL@                | 'vkCreateInstance'    | fp                    |
--   +-----------------------+-----------------------+-----------------------+
--   | @NULL@                | * (any @pName@ not    | @NULL@                |
--   |                       | covered above)        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | instance              | core Vulkan command   | fp1                   |
--   +-----------------------+-----------------------+-----------------------+
--   | instance              | enabled instance      | fp1                   |
--   |                       | extension commands    |                       |
--   |                       | for @instance@        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | instance              | available device      | fp1                   |
--   |                       | extension2 commands   |                       |
--   |                       | for @instance@        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | instance              | * (any @pName@ not    | @NULL@                |
--   |                       | covered above)        |                       |
--   +-----------------------+-----------------------+-----------------------+
--   
--   vkGetInstanceProcAddr behavior
--

-- --

1 The returned function pointer must only be called -- with a dispatchable object (the first parameter) that is -- instance or a child of instance, e.g. -- VkInstance, VkPhysicalDevice, VkDevice, -- VkQueue, or VkCommandBuffer.
2 An “available device extension” is a device extension -- supported by any physical device enumerated by instance.

-- --

Valid Usage (Implicit)

-- --

If instance is not NULL, instance -- must be a valid VkInstance handle

-- --

pName must be a null-terminated UTF-8 string

-- --

Parameters

-- --

physicalDevice is the handle to the physical device whose -- properties will be queried.

-- --

pProperties points to an instance of the -- VkPhysicalDeviceProperties structure, that will be filled with -- returned information.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pProperties must be a valid pointer to a -- VkPhysicalDeviceProperties structure

-- --

Parameters

-- --

physicalDevice is the handle to the physical device whose -- properties will be queried.

-- --

pQueueFamilyPropertyCount is a pointer to an integer -- related to the number of queue families available or queried, as -- described below.
pQueueFamilyProperties is either NULL or a -- pointer to an array of VkQueueFamilyProperties structures.

-- --

Description

-- -- If pQueueFamilyProperties is NULL, then the number -- of queue families available is returned in -- pQueueFamilyPropertyCount. Otherwise, -- pQueueFamilyPropertyCount must point to a variable set -- by the user to the number of elements in the -- pQueueFamilyProperties array, and on return the variable is -- overwritten with the number of structures actually written to -- pQueueFamilyProperties. If pQueueFamilyPropertyCount -- is less than the number of queue families available, at most -- pQueueFamilyPropertyCount structures will be written. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pQueueFamilyPropertyCount must be a valid pointer -- to a uint32_t value
If the value referenced by pQueueFamilyPropertyCount is -- not 0, and pQueueFamilyProperties is not -- NULL, pQueueFamilyProperties must be a valid -- pointer to an array of pQueueFamilyPropertyCount -- VkQueueFamilyProperties structures

-- --

Parameters

-- --

physicalDevice is the handle to the device to query.

-- --

pMemoryProperties points to an instance of -- VkPhysicalDeviceMemoryProperties structure in which the -- properties are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pMemoryProperties must be a valid pointer to a -- VkPhysicalDeviceMemoryProperties structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the supported features.

-- --

pFeatures is a pointer to a -- VkPhysicalDeviceFeatures structure in which the physical device -- features are returned. For each feature, a value of VK_TRUE -- specifies that the feature is supported on this physical device, and -- VK_FALSE specifies that the feature is not supported.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pFeatures must be a valid pointer to a -- VkPhysicalDeviceFeatures structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the format properties.

-- --

format is the format whose properties are queried.
pFormatProperties is a pointer to a -- VkFormatProperties structure in which physical device -- properties for format are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

format must be a valid VkFormat value
pFormatProperties must be a valid pointer to a -- VkFormatProperties structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the image capabilities.

-- --

format is a VkFormat value specifying the image -- format, corresponding to -- VkImageCreateInfo::format.
type is a VkImageType value specifying the image -- type, corresponding to -- VkImageCreateInfo::imageType.
tiling is a VkImageTiling value specifying the -- image tiling, corresponding to -- VkImageCreateInfo::tiling.
usage is a bitmask of VkImageUsageFlagBits -- specifying the intended usage of the image, corresponding to -- VkImageCreateInfo::usage.
flags is a bitmask of VkImageCreateFlagBits -- specifying additional parameters of the image, corresponding to -- VkImageCreateInfo::flags.
pImageFormatProperties points to an instance of the -- VkImageFormatProperties structure in which capabilities are -- returned.

-- --

Description

-- -- The format, type, tiling, usage, -- and flags parameters correspond to parameters that would be -- consumed by vkCreateImage (as members of -- VkImageCreateInfo). -- -- If format is not a supported image format, or if the -- combination of format, type, tiling, -- usage, and flags is not supported for images, then -- vkGetPhysicalDeviceImageFormatProperties returns -- VK_ERROR_FORMAT_NOT_SUPPORTED. -- -- The limitations on an image format that are reported by -- vkGetPhysicalDeviceImageFormatProperties have the following -- property: if usage1 and usage2 of type -- VkImageUsageFlags are such that the bits set in usage1 -- are a subset of the bits set in usage2, and flags1 -- and flags2 of type VkImageCreateFlags are such that -- the bits set in flags1 are a subset of the bits set in -- flags2, then the limitations for usage1 and -- flags1 must be no more strict than the limitations for -- usage2 and flags2, for all values of -- format, type, and tiling. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

format must be a valid VkFormat value
type must be a valid VkImageType value
tiling must be a valid VkImageTiling -- value
usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0
flags must be a valid combination of -- VkImageCreateFlagBits values
pImageFormatProperties must be a valid pointer to -- a VkImageFormatProperties structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_FORMAT_NOT_SUPPORTED
```

-- --

Description

-- -- The VkPhysicalDeviceMemoryProperties structure describes a -- number of memory heaps as well as a number of memory -- types that can be used to access memory allocated in those -- heaps. Each heap describes a memory resource of a particular size, and -- each memory type describes a set of memory properties (e.g. host -- cached vs uncached) that can be used with a given memory heap. -- Allocations using a particular memory type will consume resources from -- the heap indicated by that memory type’s heap index. More than one -- memory type may share each heap, and the heaps and memory types -- provide a mechanism to advertise an accurate size of the physical -- memory resources while allowing the memory to be used with a variety -- of different properties. -- -- The number of memory heaps is given by memoryHeapCount and is -- less than or equal to VK_MAX_MEMORY_HEAPS. Each heap is -- described by an element of the memoryHeaps array as a -- VkMemoryHeap structure. The number of memory types available -- across all memory heaps is given by memoryTypeCount and is -- less than or equal to VK_MAX_MEMORY_TYPES. Each memory type -- is described by an element of the memoryTypes array as a -- VkMemoryType structure. -- -- At least one heap must include -- VK_MEMORY_HEAP_DEVICE_LOCAL_BIT in -- VkMemoryHeap::flags. If there are multiple heaps that -- all have similar performance characteristics, they may all -- include VK_MEMORY_HEAP_DEVICE_LOCAL_BIT. In a unified memory -- architecture (UMA) system there is often only a single memory heap -- which is considered to be equally “local” to the host and to the -- device, and such an implementation must advertise the heap as -- device-local. -- -- Each memory type returned by -- vkGetPhysicalDeviceMemoryProperties must have its -- propertyFlags set to one of the following values: -- --

0
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_CACHED_BIT
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_CACHED_BIT | -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT
```
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT
```
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_CACHED_BIT
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_CACHED_BIT | -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT

-- -- There must be at least one memory type with both the -- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT and -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT bits set in its -- propertyFlags. There must be at least one memory type -- with the VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT bit set in its -- propertyFlags. -- -- For each pair of elements X and Y returned in -- memoryTypes, X must be placed at a lower index -- position than Y if: -- --

either the set of bit flags returned in the propertyFlags -- member of X is a strict subset of the set of bit flags returned -- in the propertyFlags member of Y.
or the propertyFlags members of X and Y are -- equal, and X belongs to a memory heap with greater performance -- (as determined in an implementation-specific manner).

-- -- Note -- -- There is no ordering requirement between X and Y -- elements for the case their propertyFlags members are not in -- a subset relation. That potentially allows more than one possible way -- to order the same set of memory types. Notice that the list of all -- allowed memory property flag combinations is written in the -- required order. But if instead -- VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT was before -- VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT, the list would still be -- in the required order. -- -- This ordering requirement enables applications to use a simple search -- loop to select the desired memory type along the lines of: -- --

--   // Find a memory in `memoryTypeBitsRequirement` that includes all of `requiredProperties`
--   int32_t findProperties(const VkPhysicalDeviceMemoryProperties* pMemoryProperties,
--                          uint32_t memoryTypeBitsRequirement,
--                          VkMemoryPropertyFlags requiredProperties) {
--       const uint32_t memoryCount = pMemoryProperties->memoryTypeCount;
--       for (uint32_t memoryIndex = 0; memoryIndex < memoryCount; ++memoryIndex) {
--           const uint32_t memoryTypeBits = (1 << memoryIndex);
--           const bool isRequiredMemoryType = memoryTypeBitsRequirement & memoryTypeBits;
--   
--           const VkMemoryPropertyFlags properties =
--               pMemoryProperties->memoryTypes[memoryIndex].propertyFlags;
--           const bool hasRequiredProperties =
--               (properties & requiredProperties) == requiredProperties;
--   
--           if (isRequiredMemoryType && hasRequiredProperties)
--               return static_cast<int32_t>(memoryIndex);
--       }
--   
--       // failed to find memory type
--       return -1;
--   }
--   
--   // Try to find an optimal memory type, or if it does not exist try fallback memory type
--   // `device` is the VkDevice
--   // `image` is the VkImage that requires memory to be bound
--   // `memoryProperties` properties as returned by vkGetPhysicalDeviceMemoryProperties
--   // `requiredProperties` are the property flags that must be present
--   // `optimalProperties` are the property flags that are preferred by the application
--   VkMemoryRequirements memoryRequirements;
--   vkGetImageMemoryRequirements(device, image, &memoryRequirements);
--   int32_t memoryType =
--       findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, optimalProperties);
--   if (memoryType == -1) // not found; try fallback properties
--       memoryType =
--           findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, requiredProperties);
--

-- --

Description

-- --

robustBufferAccess specifies that accesses to buffers are -- bounds-checked against the range of the buffer descriptor (as -- determined by VkDescriptorBufferInfo::range, -- VkBufferViewCreateInfo::range, or the size of the -- buffer). Out of bounds accesses must not cause application -- termination, and the effects of shader loads, stores, and atomics -- must conform to an implementation-dependent behavior as -- described below.
- A buffer access is considered to be out of -- bounds if any of the following are true:
  - The pointer was formed -- by OpImageTexelPointer and the coordinate is less than zero -- or greater than or equal to the number of whole elements in the bound -- range.
  - The pointer was not formed by -- OpImageTexelPointer and the object pointed to is not wholly -- contained within the bound range. This includes accesses performed via -- /variable pointers/ where the buffer descriptor being accessed cannot -- be statically determined. Uninitialized pointers and pointers equal to -- OpConstantNull are treated as pointing to a zero-sized -- object, so all accesses through such pointers are considered to be out -- of bounds.NoteIf a SPIR-V OpLoad instruction loads a -- structure and the tail end of the structure is out of bounds, then all -- members of the structure are considered out of bounds even if the -- members at the end are not statically used.
  - If any buffer -- access in a given SPIR-V block is determined to be out of bounds, then -- any other access of the same type (load, store, or atomic) in the same -- SPIR-V block that accesses an address less than 16 bytes away from the -- out of bounds address may also be considered out of -- bounds.
- Out-of-bounds buffer loads will return any -- of the following values:
  - Values from anywhere within the memory -- range(s) bound to the buffer (possibly including bytes of memory past -- the end of the buffer, up to the end of the bound range).
  - Zero -- values, or (0,0,0,x) vectors for vector reads where x is a valid value -- represented in the type of the vector components and may be any -- of:
    - 0, 1, or the maximum representable positive integer value, -- for signed or unsigned integer components
    - 0.0 or 1.0, for -- floating-point components
- Out-of-bounds -- writes may modify values within the memory range(s) bound to -- the buffer, but must not modify any other -- memory.
- Out-of-bounds atomics may modify values within -- the memory range(s) bound to the buffer, but must not modify -- any other memory, and return an undefined value.
- Vertex input -- attributes are considered out of bounds if the offset of the attribute -- in the bound vertex buffer range plus the size of the attribute is -- greater than either:
  - vertexBufferRangeSize, if -- bindingStride == 0; -- or
  - (vertexBufferRangeSize - -- (vertexBufferRangeSize % -- bindingStride))
  where vertexBufferRangeSize -- is the byte size of the memory range bound to the vertex buffer -- binding and bindingStride is the byte stride of the -- corresponding vertex input binding. Further, if any vertex input -- attribute using a specific vertex input binding is out of bounds, then -- all vertex input attributes using that vertex input binding for that -- vertex shader invocation are considered out of bounds.
  - If a -- vertex input attribute is out of bounds, it will be assigned one of -- the following values:
    - Values from anywhere within the memory -- range(s) bound to the buffer, converted according to the format of the -- attribute.
    - Zero values, format converted according to the -- format of the attribute.
    - Zero values, or (0,0,0,x) vectors, as -- described above.
- If -- robustBufferAccess is not enabled, out of bounds accesses -- may corrupt any memory within the process and cause undefined -- behavior up to and including application termination.

-- --

fullDrawIndexUint32 specifies the full 32-bit range of -- indices is supported for indexed draw calls when using a -- VkIndexType of VK_INDEX_TYPE_UINT32. -- maxDrawIndexedIndexValue is the maximum index value that -- may be used (aside from the primitive restart index, which is -- always 232-1 when the VkIndexType is -- VK_INDEX_TYPE_UINT32). If this feature is supported, -- maxDrawIndexedIndexValue must be 232-1; otherwise it -- must be no smaller than 224-1. See -- maxDrawIndexedIndexValue.
imageCubeArray specifies whether image views with a -- VkImageViewType of VK_IMAGE_VIEW_TYPE_CUBE_ARRAY -- can be created, and that the corresponding -- SampledCubeArray and ImageCubeArray SPIR-V -- capabilities can be used in shader code.
independentBlend specifies whether the -- VkPipelineColorBlendAttachmentState settings are controlled -- independently per-attachment. If this feature is not enabled, the -- VkPipelineColorBlendAttachmentState settings for all color -- attachments must be identical. Otherwise, a different -- VkPipelineColorBlendAttachmentState can be provided -- for each bound color attachment.
geometryShader specifies whether geometry shaders are -- supported. If this feature is not enabled, the -- VK_SHADER_STAGE_GEOMETRY_BIT and -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT enum values must -- not be used. This also specifies whether shader modules can -- declare the Geometry capability.
tessellationShader specifies whether tessellation control -- and evaluation shaders are supported. If this feature is not enabled, -- the VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT, -- VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT, -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, and -- VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO -- enum values must not be used. This also specifies whether -- shader modules can declare the Tessellation -- capability.
sampleRateShading specifies whether Sample Shading -- and multisample interpolation are supported. If this feature is not -- enabled, the sampleShadingEnable member of the -- VkPipelineMultisampleStateCreateInfo structure must be -- set to VK_FALSE and the minSampleShading member is -- ignored. This also specifies whether shader modules can declare -- the SampleRateShading capability.
dualSrcBlend specifies whether blend operations which -- take two sources are supported. If this feature is not enabled, the -- VK_BLEND_FACTOR_SRC1_COLOR, -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, -- VK_BLEND_FACTOR_SRC1_ALPHA, and -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA enum values must -- not be used as source or destination blending factors. See -- {html_spec_relative}#framebuffer-dsb.
logicOp specifies whether logic operations are supported. -- If this feature is not enabled, the logicOpEnable member of -- the VkPipelineColorBlendStateCreateInfo structure must -- be set to VK_FALSE, and the logicOp member is -- ignored.
multiDrawIndirect specifies whether multiple draw -- indirect is supported. If this feature is not enabled, the -- drawCount parameter to the vkCmdDrawIndirect and -- vkCmdDrawIndexedIndirect commands must be 0 or 1. The -- maxDrawIndirectCount member of the -- VkPhysicalDeviceLimits structure must also be 1 if -- this feature is not supported. See maxDrawIndirectCount.
drawIndirectFirstInstance specifies whether indirect draw -- calls support the firstInstance parameter. If this feature is -- not enabled, the firstInstance member of all -- VkDrawIndirectCommand and -- VkDrawIndexedIndirectCommand structures that are provided to -- the vkCmdDrawIndirect and vkCmdDrawIndexedIndirect -- commands must be 0.
depthClamp specifies whether depth clamping is supported. -- If this feature is not enabled, the depthClampEnable member -- of the VkPipelineRasterizationStateCreateInfo structure -- must be set to VK_FALSE. Otherwise, setting -- depthClampEnable to VK_TRUE will enable depth -- clamping.
depthBiasClamp specifies whether depth bias clamping is -- supported. If this feature is not enabled, the depthBiasClamp -- member of the VkPipelineRasterizationStateCreateInfo -- structure must be set to 0.0 unless the -- VK_DYNAMIC_STATE_DEPTH_BIAS dynamic state is enabled, and the -- depthBiasClamp parameter to vkCmdSetDepthBias -- must be set to 0.0.
fillModeNonSolid specifies whether point and wireframe -- fill modes are supported. If this feature is not enabled, the -- VK_POLYGON_MODE_POINT and VK_POLYGON_MODE_LINE enum -- values must not be used.
depthBounds specifies whether depth bounds tests are -- supported. If this feature is not enabled, the -- depthBoundsTestEnable member of the -- VkPipelineDepthStencilStateCreateInfo structure must -- be set to VK_FALSE. When depthBoundsTestEnable is -- set to VK_FALSE, the minDepthBounds and -- maxDepthBounds members of the -- VkPipelineDepthStencilStateCreateInfo structure are -- ignored.
wideLines specifies whether lines with width other than -- 1.0 are supported. If this feature is not enabled, the -- lineWidth member of the -- VkPipelineRasterizationStateCreateInfo structure must -- be set to 1.0 unless the VK_DYNAMIC_STATE_LINE_WIDTH dynamic -- state is enabled, and the lineWidth parameter to -- vkCmdSetLineWidth must be set to 1.0. When this -- feature is supported, the range and granularity of supported line -- widths are indicated by the lineWidthRange and -- lineWidthGranularity members of the -- VkPhysicalDeviceLimits structure, respectively.
largePoints specifies whether points with size greater -- than 1.0 are supported. If this feature is not enabled, only a point -- size of 1.0 written by a shader is supported. The range and -- granularity of supported point sizes are indicated by the -- pointSizeRange and pointSizeGranularity members of -- the VkPhysicalDeviceLimits structure, respectively.
alphaToOne specifies whether the implementation is able -- to replace the alpha value of the color fragment output from the -- fragment shader with the maximum representable alpha value for -- fixed-point colors or 1.0 for floating-point colors. If this feature -- is not enabled, then the alphaToOneEnable member of the -- VkPipelineMultisampleStateCreateInfo structure must be -- set to VK_FALSE. Otherwise setting alphaToOneEnable -- to VK_TRUE will enable alpha-to-one behavior.
multiViewport specifies whether more than one viewport is -- supported. If this feature is not enabled, the viewportCount -- and scissorCount members of the -- VkPipelineViewportStateCreateInfo structure must be -- set to 1. Similarly, the viewportCount parameter to the -- vkCmdSetViewport command and the scissorCount -- parameter to the vkCmdSetScissor command must be 1, -- and the firstViewport parameter to the -- vkCmdSetViewport command and the firstScissor -- parameter to the vkCmdSetScissor command must be -- 0.
samplerAnisotropy specifies whether anisotropic filtering -- is supported. If this feature is not enabled, the -- anisotropyEnable member of the VkSamplerCreateInfo -- structure must be VK_FALSE.
textureCompressionETC2 specifies whether all of the ETC2 -- and EAC compressed texture formats are supported. If this feature is -- enabled, then the VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, -- VK_FORMAT_FEATURE_BLIT_SRC_BIT and -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT features -- must be supported in optimalTilingFeatures for the -- following -- formats:
- ```
VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK
```
- ```
VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK
```
- ```
VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK
```
- ```
VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK
```
- ```
VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK
```
- ```
VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK
```
- ```
VK_FORMAT_EAC_R11_UNORM_BLOCK
```
- ```
VK_FORMAT_EAC_R11_SNORM_BLOCK
```
- ```
VK_FORMAT_EAC_R11G11_UNORM_BLOCK
```
- ```
VK_FORMAT_EAC_R11G11_SNORM_BLOCK
```
vkGetPhysicalDeviceFormatProperties -- and vkGetPhysicalDeviceImageFormatProperties can be used -- to check for additional supported properties of individual -- formats.

textureCompressionASTC_LDR specifies whether all of the -- ASTC LDR compressed texture formats are supported. If this feature is -- enabled, then the VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, -- VK_FORMAT_FEATURE_BLIT_SRC_BIT and -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT features -- must be supported in optimalTilingFeatures for the -- following -- formats:

```
VK_FORMAT_ASTC_4x4_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_4x4_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_5x4_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_5x4_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_5x5_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_5x5_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_6x5_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_6x5_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_6x6_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_6x6_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_8x5_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_8x5_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_8x6_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_8x6_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_8x8_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_8x8_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_10x5_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_10x5_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_10x6_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_10x6_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_10x8_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_10x8_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_10x10_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_10x10_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_12x10_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_12x10_SRGB_BLOCK
```
```
VK_FORMAT_ASTC_12x12_UNORM_BLOCK
```
```
VK_FORMAT_ASTC_12x12_SRGB_BLOCK
```

vkGetPhysicalDeviceFormatProperties -- and vkGetPhysicalDeviceImageFormatProperties can be used -- to check for additional supported properties of individual -- formats.

textureCompressionBC specifies whether all of the BC -- compressed texture formats are supported. If this feature is enabled, -- then the VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, -- VK_FORMAT_FEATURE_BLIT_SRC_BIT and -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT features -- must be supported in optimalTilingFeatures for the -- following -- formats:
- ```
VK_FORMAT_BC1_RGB_UNORM_BLOCK
```
- ```
VK_FORMAT_BC1_RGB_SRGB_BLOCK
```
- ```
VK_FORMAT_BC1_RGBA_UNORM_BLOCK
```
- ```
VK_FORMAT_BC1_RGBA_SRGB_BLOCK
```
- ```
VK_FORMAT_BC2_UNORM_BLOCK
```
- ```
VK_FORMAT_BC2_SRGB_BLOCK
```
- ```
VK_FORMAT_BC3_UNORM_BLOCK
```
- ```
VK_FORMAT_BC3_SRGB_BLOCK
```
- ```
VK_FORMAT_BC4_UNORM_BLOCK
```
- ```
VK_FORMAT_BC4_SNORM_BLOCK
```
- ```
VK_FORMAT_BC5_UNORM_BLOCK
```
- ```
VK_FORMAT_BC5_SNORM_BLOCK
```
- ```
VK_FORMAT_BC6H_UFLOAT_BLOCK
```
- ```
VK_FORMAT_BC6H_SFLOAT_BLOCK
```
- ```
VK_FORMAT_BC7_UNORM_BLOCK
```
- ```
VK_FORMAT_BC7_SRGB_BLOCK
```
vkGetPhysicalDeviceFormatProperties -- and vkGetPhysicalDeviceImageFormatProperties can be used -- to check for additional supported properties of individual -- formats.
occlusionQueryPrecise specifies whether occlusion queries -- returning actual sample counts are supported. Occlusion queries are -- created in a VkQueryPool by specifying the queryType -- of VK_QUERY_TYPE_OCCLUSION in the -- VkQueryPoolCreateInfo structure which is passed to -- vkCreateQueryPool. If this feature is enabled, queries of -- this type can enable VK_QUERY_CONTROL_PRECISE_BIT in -- the flags parameter to vkCmdBeginQuery. If this -- feature is not supported, the implementation supports only boolean -- occlusion queries. When any samples are passed, boolean queries will -- return a non-zero result value, otherwise a result value of zero is -- returned. When this feature is enabled and -- VK_QUERY_CONTROL_PRECISE_BIT is set, occlusion queries will -- report the actual number of samples passed.
pipelineStatisticsQuery specifies whether the pipeline -- statistics queries are supported. If this feature is not enabled, -- queries of type VK_QUERY_TYPE_PIPELINE_STATISTICS -- cannot be created, and none of the -- VkQueryPipelineStatisticFlagBits bits can be set in the -- pipelineStatistics member of the -- VkQueryPoolCreateInfo structure.
vertexPipelineStoresAndAtomics specifies whether storage -- buffers and images support stores and atomic operations in the vertex, -- tessellation, and geometry shader stages. If this feature is not -- enabled, all storage image, storage texel buffers, and storage buffer -- variables used by these stages in shader modules must be -- decorated with the NonWriteable decoration (or the -- readonly memory qualifier in GLSL).
fragmentStoresAndAtomics specifies whether storage -- buffers and images support stores and atomic operations in the -- fragment shader stage. If this feature is not enabled, all storage -- image, storage texel buffers, and storage buffer variables used by the -- fragment stage in shader modules must be decorated with the -- NonWriteable decoration (or the readonly memory -- qualifier in GLSL).
shaderTessellationAndGeometryPointSize specifies whether -- the PointSize built-in decoration is available in the -- tessellation control, tessellation evaluation, and geometry shader -- stages. If this feature is not enabled, members decorated with the -- PointSize built-in decoration must not be read from or -- written to and all points written from a tessellation or geometry -- shader will have a size of 1.0. This also specifies whether shader -- modules can declare the TessellationPointSize -- capability for tessellation control and evaluation shaders, or if the -- shader modules can declare the GeometryPointSize -- capability for geometry shaders. An implementation supporting this -- feature must also support one or both of the -- tessellationShader or geometryShader features.
shaderImageGatherExtended specifies whether the extended -- set of image gather instructions are available in shader code. If this -- feature is not enabled, the OpImage*Gather -- instructions do not support the Offset and -- ConstOffsets operands. This also specifies whether shader -- modules can declare the ImageGatherExtended -- capability.
shaderStorageImageExtendedFormats specifies whether the -- extended storage image formats are available in shader code. If this -- feature is not enabled, the formats requiring the -- StorageImageExtendedFormats capability are not supported for -- storage images. This also specifies whether shader modules can -- declare the StorageImageExtendedFormats capability.
shaderStorageImageMultisample specifies whether -- multisampled storage images are supported. If this feature is not -- enabled, images that are created with a usage that includes -- VK_IMAGE_USAGE_STORAGE_BIT must be created with -- samples equal to VK_SAMPLE_COUNT_1_BIT. This also -- specifies whether shader modules can declare the -- StorageImageMultisample capability.
shaderStorageImageReadWithoutFormat specifies whether -- storage images require a format qualifier to be specified when reading -- from storage images. If this feature is not enabled, the -- OpImageRead instruction must not have an -- OpTypeImage of Unknown. This also specifies whether -- shader modules can declare the -- StorageImageReadWithoutFormat capability.
shaderStorageImageWriteWithoutFormat specifies whether -- storage images require a format qualifier to be specified when writing -- to storage images. If this feature is not enabled, the -- OpImageWrite instruction must not have an -- OpTypeImage of Unknown. This also specifies whether -- shader modules can declare the -- StorageImageWriteWithoutFormat capability.
shaderUniformBufferArrayDynamicIndexing specifies whether -- arrays of uniform buffers can be indexed by dynamically -- uniform integer expressions in shader code. If this feature is not -- enabled, resources with a descriptor type of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC must be -- indexed only by constant integral expressions when aggregated into -- arrays in shader code. This also specifies whether shader modules -- can declare the UniformBufferArrayDynamicIndexing -- capability.
shaderSampledImageArrayDynamicIndexing specifies whether -- arrays of samplers or sampled images can be indexed by -- dynamically uniform integer expressions in shader code. If this -- feature is not enabled, resources with a descriptor type of -- VK_DESCRIPTOR_TYPE_SAMPLER, -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, or -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE must be indexed only -- by constant integral expressions when aggregated into arrays in shader -- code. This also specifies whether shader modules can declare -- the SampledImageArrayDynamicIndexing capability.
shaderStorageBufferArrayDynamicIndexing specifies whether -- arrays of storage buffers can be indexed by dynamically uniform -- integer expressions in shader code. If this feature is not enabled, -- resources with a descriptor type of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC must be -- indexed only by constant integral expressions when aggregated into -- arrays in shader code. This also specifies whether shader modules -- can declare the StorageBufferArrayDynamicIndexing -- capability.
shaderStorageImageArrayDynamicIndexing specifies whether -- arrays of storage images can be indexed by dynamically uniform -- integer expressions in shader code. If this feature is not enabled, -- resources with a descriptor type of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE must be indexed only -- by constant integral expressions when aggregated into arrays in shader -- code. This also specifies whether shader modules can declare -- the StorageImageArrayDynamicIndexing capability.
shaderClipDistance specifies whether clip distances are -- supported in shader code. If this feature is not enabled, any members -- decorated with the ClipDistance built-in decoration -- must not be read from or written to in shader modules. This -- also specifies whether shader modules can declare the -- ClipDistance capability.
shaderCullDistance specifies whether cull distances are -- supported in shader code. If this feature is not enabled, any members -- decorated with the CullDistance built-in decoration -- must not be read from or written to in shader modules. This -- also specifies whether shader modules can declare the -- CullDistance capability.
shaderFloat64 specifies whether 64-bit floats (doubles) -- are supported in shader code. If this feature is not enabled, 64-bit -- floating-point types must not be used in shader code. This also -- specifies whether shader modules can declare the -- Float64 capability.
shaderInt64 specifies whether 64-bit integers (signed and -- unsigned) are supported in shader code. If this feature is not -- enabled, 64-bit integer types must not be used in shader code. -- This also specifies whether shader modules can declare the -- Int64 capability.
shaderInt16 specifies whether 16-bit integers (signed and -- unsigned) are supported in shader code. If this feature is not -- enabled, 16-bit integer types must not be used in shader code. -- This also specifies whether shader modules can declare the -- Int16 capability.
shaderResourceResidency specifies whether image -- operations that return resource residency information are supported in -- shader code. If this feature is not enabled, the -- OpImageSparse* instructions must not be used in shader -- code. This also specifies whether shader modules can declare -- the SparseResidency capability. The feature requires at least -- one of the sparseResidency* features to be supported.
shaderResourceMinLod specifies whether image operations -- that specify the minimum resource LOD are supported in shader code. If -- this feature is not enabled, the MinLod image operand -- must not be used in shader code. This also specifies whether -- shader modules can declare the MinLod capability.
sparseBinding specifies whether resource memory -- can be managed at opaque sparse block level instead of at the -- object level. If this feature is not enabled, resource memory -- must be bound only on a per-object basis using the -- vkBindBufferMemory and vkBindImageMemory commands. -- In this case, buffers and images must not be created with -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT and -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT set in the flags -- member of the VkBufferCreateInfo and -- VkImageCreateInfo structures, respectively. Otherwise -- resource memory can be managed as described in Sparse -- Resource Features.
sparseResidencyBuffer specifies whether the device -- can access partially resident buffers. If this feature is not -- enabled, buffers must not be created with -- VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkBufferCreateInfo -- structure.
sparseResidencyImage2D specifies whether the device -- can access partially resident 2D images with 1 sample per -- pixel. If this feature is not enabled, images with an -- imageType of VK_IMAGE_TYPE_2D and samples -- set to VK_SAMPLE_COUNT_1_BIT must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidencyImage3D specifies whether the device -- can access partially resident 3D images. If this feature is not -- enabled, images with an imageType of -- VK_IMAGE_TYPE_3D must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidency2Samples specifies whether the physical -- device can access partially resident 2D images with 2 samples -- per pixel. If this feature is not enabled, images with an -- imageType of VK_IMAGE_TYPE_2D and samples -- set to VK_SAMPLE_COUNT_2_BIT must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidency4Samples specifies whether the physical -- device can access partially resident 2D images with 4 samples -- per pixel. If this feature is not enabled, images with an -- imageType of VK_IMAGE_TYPE_2D and samples -- set to VK_SAMPLE_COUNT_4_BIT must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidency8Samples specifies whether the physical -- device can access partially resident 2D images with 8 samples -- per pixel. If this feature is not enabled, images with an -- imageType of VK_IMAGE_TYPE_2D and samples -- set to VK_SAMPLE_COUNT_8_BIT must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidency16Samples specifies whether the physical -- device can access partially resident 2D images with 16 samples -- per pixel. If this feature is not enabled, images with an -- imageType of VK_IMAGE_TYPE_2D and samples -- set to VK_SAMPLE_COUNT_16_BIT must not be created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT set in the -- flags member of the VkImageCreateInfo -- structure.
sparseResidencyAliased specifies whether the physical -- device can correctly access data aliased into multiple -- locations. If this feature is not enabled, the -- VK_BUFFER_CREATE_SPARSE_ALIASED_BIT and -- VK_IMAGE_CREATE_SPARSE_ALIASED_BIT enum values must -- not be used in flags members of the -- VkBufferCreateInfo and VkImageCreateInfo structures, -- respectively.
variableMultisampleRate specifies whether all pipelines -- that will be bound to a command buffer during a subpass with no -- attachments must have the same value for -- VkPipelineMultisampleStateCreateInfo::rasterizationSamples. -- If set to VK_TRUE, the implementation supports variable -- multisample rates in a subpass with no attachments. If set to -- VK_FALSE, then all pipelines bound in such a subpass -- must have the same multisample rate. This has no effect in -- situations where a subpass uses any attachments.
inheritedQueries specifies whether a secondary command -- buffer may be executed while a query is active.

-- --

Description

-- --

Members

-- --

maxImageDimension1D is the maximum dimension -- (width) supported for all images created with an -- imageType of VK_IMAGE_TYPE_1D.

-- --

maxImageDimension2D is the maximum dimension -- (width or height) supported for all images created -- with an imageType of VK_IMAGE_TYPE_2D and without -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT set in -- flags.
maxImageDimension3D is the maximum dimension -- (width, height, or depth) supported for all -- images created with an imageType of -- VK_IMAGE_TYPE_3D.
maxImageDimensionCube is the maximum dimension -- (width or height) supported for all images created -- with an imageType of VK_IMAGE_TYPE_2D and with -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT set in -- flags.
maxImageArrayLayers is the maximum number of layers -- (arrayLayers) for an image.
maxTexelBufferElements is the maximum number of -- addressable texels for a buffer view created on a buffer which was -- created with the VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT set in the -- usage member of the VkBufferCreateInfo -- structure.
maxUniformBufferRange is the maximum value that -- can be specified in the range member of any -- VkDescriptorBufferInfo structures passed to a call to -- vkUpdateDescriptorSets for descriptors of type -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC.
maxStorageBufferRange is the maximum value that -- can be specified in the range member of any -- VkDescriptorBufferInfo structures passed to a call to -- vkUpdateDescriptorSets for descriptors of type -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC.
maxPushConstantsSize is the maximum size, in bytes, of -- the pool of push constant memory. For each of the push constant ranges -- indicated by the pPushConstantRanges member of the -- VkPipelineLayoutCreateInfo structure, (offset + -- size) must be less than or equal to this limit.
maxMemoryAllocationCount is the maximum number of device -- memory allocations, as created by vkAllocateMemory, which -- can simultaneously exist.
maxSamplerAllocationCount is the maximum number of -- sampler objects, as created by vkCreateSampler, which -- can simultaneously exist on a device.
bufferImageGranularity is the granularity, in bytes, at -- which buffer or linear image resources, and optimal image resources -- can be bound to adjacent offsets in the same -- VkDeviceMemory object without aliasing. See Buffer-Image -- Granularity for more details.
sparseAddressSpaceSize is the total amount of address -- space available, in bytes, for sparse memory resources. This is an -- upper bound on the sum of the size of all sparse resources, regardless -- of whether any memory is bound to them.
maxBoundDescriptorSets is the maximum number of -- descriptor sets that can be simultaneously used by a pipeline. -- All DescriptorSet decorations in shader modules must -- have a value less than maxBoundDescriptorSets. See -- {html_spec_relative}#descriptorsets-sets.
maxPerStageDescriptorSamplers is the maximum number of -- samplers that can be accessible to a single shader stage in a -- pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_SAMPLER or -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. See -- {html_spec_relative}#descriptorsets-sampler and -- {html_spec_relative}#descriptorsets-combinedimagesampler.
maxPerStageDescriptorUniformBuffers is the maximum number -- of uniform buffers that can be accessible to a single shader -- stage in a pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. See -- {html_spec_relative}#descriptorsets-uniformbuffer and -- {html_spec_relative}#descriptorsets-uniformbufferdynamic.
maxPerStageDescriptorStorageBuffers is the maximum number -- of storage buffers that can be accessible to a single shader -- stage in a pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- pipeline shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. See -- {html_spec_relative}#descriptorsets-storagebuffer and -- {html_spec_relative}#descriptorsets-storagebufferdynamic.
maxPerStageDescriptorSampledImages is the maximum number -- of sampled images that can be accessible to a single shader -- stage in a pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, or -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- pipeline shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. See -- {html_spec_relative}#descriptorsets-combinedimagesampler, -- {html_spec_relative}#descriptorsets-sampledimage, and -- {html_spec_relative}#descriptorsets-uniformtexelbuffer.
maxPerStageDescriptorStorageImages is the maximum number -- of storage images that can be accessible to a single shader -- stage in a pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- pipeline shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. See -- {html_spec_relative}#descriptorsets-storageimage, and -- {html_spec_relative}#descriptorsets-storagetexelbuffer.
maxPerStageDescriptorInputAttachments is the maximum -- number of input attachments that can be accessible to a single -- shader stage in a pipeline layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT count against this limit. -- Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. A descriptor is accessible to a -- pipeline shader stage when the stageFlags member of the -- VkDescriptorSetLayoutBinding structure has the bit for that -- shader stage set. These are only supported for the fragment stage. See -- {html_spec_relative}#descriptorsets-inputattachment.
maxPerStageResources is the maximum number of resources -- that can be accessible to a single shader stage in a pipeline -- layout. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER, -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, or -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT count against this limit. -- Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. For the fragment shader stage the -- framebuffer color attachments also count against this limit.
maxDescriptorSetSamplers is the maximum number of -- samplers that can be included in descriptor bindings in a -- pipeline layout across all pipeline shader stages and descriptor set -- numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_SAMPLER or -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-sampler and -- {html_spec_relative}#descriptorsets-combinedimagesampler.
maxDescriptorSetUniformBuffers is the maximum number of -- uniform buffers that can be included in descriptor bindings in -- a pipeline layout across all pipeline shader stages and descriptor set -- numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-uniformbuffer and -- {html_spec_relative}#descriptorsets-uniformbufferdynamic.
maxDescriptorSetUniformBuffersDynamic is the maximum -- number of dynamic uniform buffers that can be included in -- descriptor bindings in a pipeline layout across all pipeline shader -- stages and descriptor set numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-uniformbufferdynamic.
maxDescriptorSetStorageBuffers is the maximum number of -- storage buffers that can be included in descriptor bindings in -- a pipeline layout across all pipeline shader stages and descriptor set -- numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-storagebuffer and -- {html_spec_relative}#descriptorsets-storagebufferdynamic.
maxDescriptorSetStorageBuffersDynamic is the maximum -- number of dynamic storage buffers that can be included in -- descriptor bindings in a pipeline layout across all pipeline shader -- stages and descriptor set numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-storagebufferdynamic.
maxDescriptorSetSampledImages is the maximum number of -- sampled images that can be included in descriptor bindings in a -- pipeline layout across all pipeline shader stages and descriptor set -- numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, or -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-combinedimagesampler, -- {html_spec_relative}#descriptorsets-sampledimage, and -- {html_spec_relative}#descriptorsets-uniformtexelbuffer.
maxDescriptorSetStorageImages is the maximum number of -- storage images that can be included in descriptor bindings in a -- pipeline layout across all pipeline shader stages and descriptor set -- numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER count against this -- limit. Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-storageimage, and -- {html_spec_relative}#descriptorsets-storagetexelbuffer.
maxDescriptorSetInputAttachments is the maximum number of -- input attachments that can be included in descriptor bindings -- in a pipeline layout across all pipeline shader stages and descriptor -- set numbers. Descriptors with a type of -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT count against this limit. -- Only descriptors in descriptor set layouts created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set count against this limit. See -- {html_spec_relative}#descriptorsets-inputattachment.
maxVertexInputAttributes is the maximum number of vertex -- input attributes that can be specified for a graphics pipeline. -- These are described in the array of -- VkVertexInputAttributeDescription structures that are -- provided at graphics pipeline creation time via the -- pVertexAttributeDescriptions member of the -- VkPipelineVertexInputStateCreateInfo structure. See -- {html_spec_relative}#fxvertex-attrib and -- {html_spec_relative}#fxvertex-input.
maxVertexInputBindings is the maximum number of vertex -- buffers that can be specified for providing vertex attributes -- to a graphics pipeline. These are described in the array of -- VkVertexInputBindingDescription structures that are provided -- at graphics pipeline creation time via the -- pVertexBindingDescriptions member of the -- VkPipelineVertexInputStateCreateInfo structure. The -- binding member of VkVertexInputBindingDescription -- must be less than this limit. See -- {html_spec_relative}#fxvertex-input.
maxVertexInputAttributeOffset is the maximum vertex input -- attribute offset that can be added to the vertex input binding -- stride. The offset member of the -- VkVertexInputAttributeDescription structure must be -- less than or equal to this limit. See -- {html_spec_relative}#fxvertex-input.
maxVertexInputBindingStride is the maximum vertex input -- binding stride that can be specified in a vertex input binding. -- The stride member of the -- VkVertexInputBindingDescription structure must be less -- than or equal to this limit. See -- {html_spec_relative}#fxvertex-input.
maxVertexOutputComponents is the maximum number of -- components of output variables which can be output by a vertex -- shader. See {html_spec_relative}#shaders-vertex.
maxTessellationGenerationLevel is the maximum -- tessellation generation level supported by the fixed-function -- tessellation primitive generator. See -- {html_spec_relative}#tessellation.
maxTessellationPatchSize is the maximum patch size, in -- vertices, of patches that can be processed by the tessellation -- control shader and tessellation primitive generator. The -- patchControlPoints member of the -- VkPipelineTessellationStateCreateInfo structure specified at -- pipeline creation time and the value provided in the -- OutputVertices execution mode of shader modules must -- be less than or equal to this limit. See -- {html_spec_relative}#tessellation.
maxTessellationControlPerVertexInputComponents is the -- maximum number of components of input variables which can be -- provided as per-vertex inputs to the tessellation control shader -- stage.
maxTessellationControlPerVertexOutputComponents is the -- maximum number of components of per-vertex output variables which -- can be output from the tessellation control shader stage.
maxTessellationControlPerPatchOutputComponents is the -- maximum number of components of per-patch output variables which -- can be output from the tessellation control shader stage.
maxTessellationControlTotalOutputComponents is the -- maximum total number of components of per-vertex and per-patch output -- variables which can be output from the tessellation control -- shader stage.
maxTessellationEvaluationInputComponents is the maximum -- number of components of input variables which can be provided -- as per-vertex inputs to the tessellation evaluation shader stage.
maxTessellationEvaluationOutputComponents is the maximum -- number of components of per-vertex output variables which can -- be output from the tessellation evaluation shader stage.
maxGeometryShaderInvocations is the maximum invocation -- count supported for instanced geometry shaders. The value provided in -- the Invocations execution mode of shader modules must -- be less than or equal to this limit. See -- {html_spec_relative}#geometry.
maxGeometryInputComponents is the maximum number of -- components of input variables which can be provided as inputs -- to the geometry shader stage.
maxGeometryOutputComponents is the maximum number of -- components of output variables which can be output from the -- geometry shader stage.
maxGeometryOutputVertices is the maximum number of -- vertices which can be emitted by any geometry shader.
maxGeometryTotalOutputComponents is the maximum total -- number of components of output, across all emitted vertices, which -- can be output from the geometry shader stage.
maxFragmentInputComponents is the maximum number of -- components of input variables which can be provided as inputs -- to the fragment shader stage.
maxFragmentOutputAttachments is the maximum number of -- output attachments which can be written to by the fragment -- shader stage.
maxFragmentDualSrcAttachments is the maximum number of -- output attachments which can be written to by the fragment -- shader stage when blending is enabled and one of the dual source blend -- modes is in use. See {html_spec_relative}#framebuffer-dsb and -- dualSrcBlend.
maxFragmentCombinedOutputResources is the total number of -- storage buffers, storage images, and output buffers which can -- be used in the fragment shader stage.
maxComputeSharedMemorySize is the maximum total storage -- size, in bytes, of all variables declared with the -- WorkgroupLocal storage class in shader modules (or with the -- shared storage qualifier in GLSL) in the compute shader -- stage.
maxComputeWorkGroupCount[3] is the maximum number of -- local workgroups that can be dispatched by a single dispatch -- command. These three values represent the maximum number of local -- workgroups for the X, Y, and Z dimensions, respectively. The workgroup -- count parameters to the dispatch commands must be less than or -- equal to the corresponding limit. See -- {html_spec_relative}#dispatch.
maxComputeWorkGroupInvocations is the maximum total -- number of compute shader invocations in a single local workgroup. The -- product of the X, Y, and Z sizes as specified by the -- LocalSize execution mode in shader modules and by the object -- decorated by the WorkgroupSize decoration must be less -- than or equal to this limit.
maxComputeWorkGroupSize[3] is the maximum size of a local -- compute workgroup, per dimension. These three values represent the -- maximum local workgroup size in the X, Y, and Z dimensions, -- respectively. The x, y, and z sizes -- specified by the LocalSize execution mode and by the object -- decorated by the WorkgroupSize decoration in shader modules -- must be less than or equal to the corresponding limit.
subPixelPrecisionBits is the number of bits of subpixel -- precision in framebuffer coordinates xf and yf. See -- {html_spec_relative}#primsrast.
subTexelPrecisionBits is the number of bits of precision -- in the division along an axis of an image used for minification and -- magnification filters. 2subTexelPrecisionBits is the actual -- number of divisions along each axis of the image represented. -- Sub-texel values calculated during image sampling will snap to these -- locations when generating the filtered results.
mipmapPrecisionBits is the number of bits of division -- that the LOD calculation for mipmap fetching get snapped to when -- determining the contribution from each mip level to the mip filtered -- results. 2mipmapPrecisionBits is the actual number of -- divisions.NoteFor example, if this value is 2 bits then when -- linearly filtering between two levels, each level could: contribute: -- 0%, 33%, 66%, or 100% (this is just an example and the amount of -- contribution should be covered by different equations in the -- spec).
maxDrawIndexedIndexValue is the maximum index value that -- can be used for indexed draw calls when using 32-bit indices. -- This excludes the primitive restart index value of 0xFFFFFFFF. See -- fullDrawIndexUint32.
maxDrawIndirectCount is the maximum draw count that is -- supported for indirect draw calls. See multiDrawIndirect.
maxSamplerLodBias is the maximum absolute sampler LOD -- bias. The sum of the mipLodBias member of the -- VkSamplerCreateInfo structure and the Bias operand -- of image sampling operations in shader modules (or 0 if no -- Bias operand is provided to an image sampling operation) are -- clamped to the range -- [-maxSamplerLodBias,+maxSamplerLodBias]. See -- {html_spec_relative}#samplers-mipLodBias.
maxSamplerAnisotropy is the maximum degree of sampler -- anisotropy. The maximum degree of anisotropic filtering used for an -- image sampling operation is the minimum of the maxAnisotropy -- member of the VkSamplerCreateInfo structure and this limit. -- See {html_spec_relative}#samplers-maxAnisotropy.
maxViewports is the maximum number of active viewports. -- The viewportCount member of the -- VkPipelineViewportStateCreateInfo structure that is provided -- at pipeline creation must be less than or equal to this -- limit.
maxViewportDimensions[2] are the maximum viewport -- dimensions in the X (width) and Y (height) dimensions, respectively. -- The maximum viewport dimensions must be greater than or equal -- to the largest image which can be created and used as a -- framebuffer attachment. See Controlling the Viewport.
viewportBoundsRange[2] is the [minimum, maximum] range -- that the corners of a viewport must be contained in. This range -- must be at least [-2 × size, 2 × size - 1], -- where size = max(maxViewportDimensions[0], -- maxViewportDimensions[1]). See Controlling the -- Viewport.NoteThe intent of the viewportBoundsRange -- limit is to allow a maximum sized viewport to be arbitrarily shifted -- relative to the output target as long as at least some portion -- intersects. This would give a bounds limit of [-size + 1, 2 × -- size - 1] which would allow all possible non-empty-set -- intersections of the output target and the viewport. Since these -- numbers are typically powers of two, picking the signed number range -- using the smallest possible number of bits ends up with the specified -- range.
viewportSubPixelBits is the number of bits of subpixel -- precision for viewport bounds. The subpixel precision that -- floating-point viewport bounds are interpreted at is given by this -- limit.
minMemoryMapAlignment is the minimum required -- alignment, in bytes, of host visible memory allocations within the -- host address space. When mapping a memory allocation with -- vkMapMemory, subtracting offset bytes from the -- returned pointer will always produce an integer multiple of this -- limit. See {html_spec_relative}#memory-device-hostaccess.
minTexelBufferOffsetAlignment is the minimum -- required alignment, in bytes, for the offset member of -- the VkBufferViewCreateInfo structure for texel buffers. When -- a buffer view is created for a buffer which was created with -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT set in the -- usage member of the VkBufferCreateInfo structure, -- the offset must be an integer multiple of this -- limit.
minUniformBufferOffsetAlignment is the minimum -- required alignment, in bytes, for the offset member of -- the VkDescriptorBufferInfo structure for uniform buffers. -- When a descriptor of type VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER -- or VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC is updated, the -- offset must be an integer multiple of this limit. -- Similarly, dynamic offsets for uniform buffers must be -- multiples of this limit.
minStorageBufferOffsetAlignment is the minimum -- required alignment, in bytes, for the offset member of -- the VkDescriptorBufferInfo structure for storage buffers. -- When a descriptor of type VK_DESCRIPTOR_TYPE_STORAGE_BUFFER -- or VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC is updated, the -- offset must be an integer multiple of this limit. -- Similarly, dynamic offsets for storage buffers must be -- multiples of this limit.
minTexelOffset is the minimum offset value for the -- ConstOffset image operand of any of the -- OpImageSample* or OpImageFetch* image -- instructions.
maxTexelOffset is the maximum offset value for the -- ConstOffset image operand of any of the -- OpImageSample* or OpImageFetch* image -- instructions.
minTexelGatherOffset is the minimum offset value for the -- Offset or ConstOffsets image operands of any of the -- OpImage*Gather image instructions.
maxTexelGatherOffset is the maximum offset value for the -- Offset or ConstOffsets image operands of any of the -- OpImage*Gather image instructions.
minInterpolationOffset is the minimum negative offset -- value for the offset operand of the -- InterpolateAtOffset extended instruction.
maxInterpolationOffset is the maximum positive offset -- value for the offset operand of the -- InterpolateAtOffset extended instruction.
subPixelInterpolationOffsetBits is the number of subpixel -- fractional bits that the x and y offsets to the -- InterpolateAtOffset extended instruction may be -- rounded to as fixed-point values.
maxFramebufferWidth is the maximum width for a -- framebuffer. The width member of the -- VkFramebufferCreateInfo structure must be less than or -- equal to this limit.
maxFramebufferHeight is the maximum height for a -- framebuffer. The height member of the -- VkFramebufferCreateInfo structure must be less than or -- equal to this limit.
maxFramebufferLayers is the maximum layer count for a -- layered framebuffer. The layers member of the -- VkFramebufferCreateInfo structure must be less than or -- equal to this limit.
framebufferColorSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the color sample counts that -- are supported for all framebuffer color attachments with floating- or -- fixed-point formats. There is no limit that specifies the color sample -- counts that are supported for all color attachments with integer -- formats.
framebufferDepthSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the supported depth sample -- counts for all framebuffer depth/stencil attachments, when the format -- includes a depth component.
framebufferStencilSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the supported stencil sample -- counts for all framebuffer depth/stencil attachments, when the format -- includes a stencil component.
framebufferNoAttachmentsSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the supported sample counts -- for a framebuffer with no attachments.
maxColorAttachments is the maximum number of color -- attachments that can be used by a subpass in a render pass. The -- colorAttachmentCount member of the -- VkSubpassDescription structure must be less than or -- equal to this limit.
sampledImageColorSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the sample counts supported -- for all 2D images created with VK_IMAGE_TILING_OPTIMAL, -- usage containing VK_IMAGE_USAGE_SAMPLED_BIT, and a -- non-integer color format.
sampledImageIntegerSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the sample counts supported -- for all 2D images created with VK_IMAGE_TILING_OPTIMAL, -- usage containing VK_IMAGE_USAGE_SAMPLED_BIT, and an -- integer color format.
sampledImageDepthSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the sample counts supported -- for all 2D images created with VK_IMAGE_TILING_OPTIMAL, -- usage containing VK_IMAGE_USAGE_SAMPLED_BIT, and a -- depth format.
sampledImageStencilSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the sample supported for all -- 2D images created with VK_IMAGE_TILING_OPTIMAL, -- usage containing VK_IMAGE_USAGE_SAMPLED_BIT, and a -- stencil format.
storageImageSampleCounts is a bitmask1 of -- VkSampleCountFlagBits indicating the sample counts supported -- for all 2D images created with VK_IMAGE_TILING_OPTIMAL, and -- usage containing VK_IMAGE_USAGE_STORAGE_BIT.
maxSampleMaskWords is the maximum number of array -- elements of a variable decorated with the SampleMask built-in -- decoration.
timestampComputeAndGraphics specifies support for -- timestamps on all graphics and compute queues. If this limit is set to -- VK_TRUE, all queues that advertise the -- VK_QUEUE_GRAPHICS_BIT or VK_QUEUE_COMPUTE_BIT in the -- VkQueueFamilyProperties::queueFlags support -- VkQueueFamilyProperties::timestampValidBits of at -- least 36. See Timestamp Queries.
timestampPeriod is the number of nanoseconds -- required for a timestamp query to be incremented by 1. See -- Timestamp Queries.
maxClipDistances is the maximum number of clip distances -- that can be used in a single shader stage. The size of any -- array declared with the ClipDistance built-in decoration in a -- shader module must be less than or equal to this limit.
maxCullDistances is the maximum number of cull distances -- that can be used in a single shader stage. The size of any -- array declared with the CullDistance built-in decoration in a -- shader module must be less than or equal to this limit.
maxCombinedClipAndCullDistances is the maximum combined -- number of clip and cull distances that can be used in a single -- shader stage. The sum of the sizes of any pair of arrays declared with -- the ClipDistance and CullDistance built-in -- decoration used by a single shader stage in a shader module -- must be less than or equal to this limit.
discreteQueuePriorities is the number of discrete -- priorities that can be assigned to a queue based on the value -- of each member of -- VkDeviceQueueCreateInfo::pQueuePriorities. This -- must be at least 2, and levels must be spread evenly -- over the range, with at least one level at 1.0, and another at 0.0. -- See {html_spec_relative}#devsandqueues-priority.
pointSizeRange[2] is the range -- [minimum,maximum] of supported sizes for points. -- Values written to variables decorated with the PointSize -- built-in decoration are clamped to this range.
lineWidthRange[2] is the range -- [minimum,maximum] of supported widths for lines. -- Values specified by the lineWidth member of the -- VkPipelineRasterizationStateCreateInfo or the -- lineWidth parameter to vkCmdSetLineWidth are clamped -- to this range.
pointSizeGranularity is the granularity of supported -- point sizes. Not all point sizes in the range defined by -- pointSizeRange are supported. This limit specifies the -- granularity (or increment) between successive supported point -- sizes.
lineWidthGranularity is the granularity of supported line -- widths. Not all line widths in the range defined by -- lineWidthRange are supported. This limit specifies the -- granularity (or increment) between successive supported line -- widths.
strictLines specifies whether lines are rasterized -- according to the preferred method of rasterization. If set to -- VK_FALSE, lines may be rasterized under a relaxed set -- of rules. If set to VK_TRUE, lines are rasterized as per the -- strict definition. See Basic Line Segment Rasterization.
standardSampleLocations specifies whether rasterization -- uses the standard sample locations as documented in -- Multisampling. If set to VK_TRUE, the implementation -- uses the documented sample locations. If set to VK_FALSE, the -- implementation may use different sample locations.
optimalBufferCopyOffsetAlignment is the optimal buffer -- offset alignment in bytes for vkCmdCopyBufferToImage and -- vkCmdCopyImageToBuffer. The per texel alignment requirements -- are enforced, but applications should use the optimal alignment -- for optimal performance and power use.
optimalBufferCopyRowPitchAlignment is the optimal buffer -- row pitch alignment in bytes for vkCmdCopyBufferToImage and -- vkCmdCopyImageToBuffer. Row pitch is the number of bytes -- between texels with the same X coordinate in adjacent rows (Y -- coordinates differ by one). The per texel alignment requirements are -- enforced, but applications should use the optimal alignment for -- optimal performance and power use.
nonCoherentAtomSize is the size and alignment in bytes -- that bounds concurrent access to host-mapped device -- memory.
VkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles -- is the maximum number of active discard rectangles. This limit can be -- queried by setting the pNext pointer from a -- VkPhysicalDeviceProperties2 object to an instance of -- VkPhysicalDeviceDiscardRectanglePropertiesEXT and using -- vkGetPhysicalDeviceProperties2 to fill out the members.
VkPhysicalDevicePointClippingProperties::pointClippingBehavior -- defines the clipping behavior of points. This limit can be queried by -- setting the pNext pointer from a -- VkPhysicalDeviceProperties2 object to an instance of -- VkPhysicalDevicePointClippingProperties and using -- vkGetPhysicalDeviceProperties2 to fill out the members.
VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor -- is the maximum value of the number of instances that will repeat the -- value of vertex attribute data when instanced rendering is enabled. -- This limit can be queried by setting the pNext pointer from a -- VkPhysicalDeviceProperties2 object to an instance of -- VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT and using -- vkGetPhysicalDeviceProperties2 to fill out the members.

-- --

Description

-- --

1 For all bitmasks of VkSampleCountFlagBits, the -- sample count limits defined above represent the minimum supported -- sample counts for each image type. Individual images may -- support additional sample counts, which are queried using -- vkGetPhysicalDeviceImageFormatProperties as described in -- Supported Sample Counts.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_FORMAT_NOT_SUPPORTED
```

-- --

filterMinmaxImageComponentMapping is a boolean value -- indicating whether the implementation supports non-identity component -- mapping of the image when doing min/max filtering.

-- -- If the VkPhysicalDeviceSamplerFilterMinmaxPropertiesEXT -- structure is included in the pNext chain of -- VkPhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- -- If filterMinmaxSingleComponentFormats is VK_TRUE, -- the following formats must support the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT_EXT feature -- with VK_IMAGE_TILING_OPTIMAL, if they support -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT. -- --

```
VK_FORMAT_R8_UNORM
```
```
VK_FORMAT_R8_SNORM
```
```
VK_FORMAT_R16_UNORM
```
```
VK_FORMAT_R16_SNORM
```
```
VK_FORMAT_R16_SFLOAT
```
```
VK_FORMAT_R32_SFLOAT
```
```
VK_FORMAT_D16_UNORM
```
```
VK_FORMAT_X8_D24_UNORM_PACK32
```
```
VK_FORMAT_D32_SFLOAT
```
```
VK_FORMAT_D16_UNORM_S8_UINT
```
```
VK_FORMAT_D24_UNORM_S8_UINT
```
```
VK_FORMAT_D32_SFLOAT_S8_UINT
```

-- -- If the format is a depth/stencil format, this bit only specifies that -- the depth aspect (not the stencil aspect) of an image of this format -- supports min/max filtering, and that min/max filtering of the depth -- aspect is supported when depth compare is disabled in the sampler. -- -- If filterMinmaxImageComponentMapping is VK_FALSE the -- component mapping of the image view used with min/max filtering -- must have been created with the r component set to -- VK_COMPONENT_SWIZZLE_IDENTITY. Only the r component -- of the sampled image value is defined and the other component values -- are undefined. If filterMinmaxImageComponentMapping is -- VK_TRUE this restriction does not apply and image component -- mapping works as normal. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SAMPLER_FILTER_MINMAX_PROPERTIES_EXT

-- --

Description

-- -- If this structure is not present, reductionMode is considered -- to be VK_SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_EXT. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO_EXT

-- --

reductionMode must be a valid -- VkSamplerReductionModeEXT value

-- --

Description

-- --

--   +------------------------------------------+---------------------------+
--   | 'VkDebugReportObjectTypeEXT'             | Vulkan Handle Type        |
--   +==========================================+===========================+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT | Unknown\/Undefined Handle |
--   | @                                        |                           |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EX | 'Graphics.Vulkan.Core10.D |
--   | T@                                       | eviceInitialization.VkIns |
--   |                                          | tance'                    |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DE | 'Graphics.Vulkan.Core10.D |
--   | VICE_EXT@                                | eviceInitialization.VkPhy |
--   |                                          | sicalDevice'              |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT@ | 'Graphics.Vulkan.Core10.D |
--   |                                          | eviceInitialization.VkDev |
--   |                                          | ice'                      |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT@  | 'Graphics.Vulkan.Core10.Q |
--   |                                          | ueue.VkQueue'             |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_E | 'Graphics.Vulkan.Core10.Q |
--   | XT@                                      | ueue.VkSemaphore'         |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUF | 'Graphics.Vulkan.Core10.Q |
--   | FER_EXT@                                 | ueue.VkCommandBuffer'     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_FENCE_EXT@  | 'Graphics.Vulkan.Core10.Q |
--   |                                          | ueue.VkFence'             |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMO | 'Graphics.Vulkan.Core10.M |
--   | RY_EXT@                                  | emory.VkDeviceMemory'     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT@ | 'Graphics.Vulkan.Core10.M |
--   |                                          | emoryManagement.VkBuffer' |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT@  | 'Graphics.Vulkan.Core10.M |
--   |                                          | emoryManagement.VkImage'  |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT@  | 'Graphics.Vulkan.Core10.E |
--   |                                          | vent.VkEvent'             |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_QUERY_POOL_ | 'Graphics.Vulkan.Core10.Q |
--   | EXT@                                     | uery.VkQueryPool'         |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW | 'Graphics.Vulkan.Core10.B |
--   | _EXT@                                    | ufferView.VkBufferView'   |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_ | 'Graphics.Vulkan.Core10.I |
--   | EXT@                                     | mageView.VkImageView'     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODU | 'Graphics.Vulkan.Core10.S |
--   | LE_EXT@                                  | hader.VkShaderModule'     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CA | 'Graphics.Vulkan.Core10.P |
--   | CHE_EXT@                                 | ipelineCache.VkPipelineCa |
--   |                                          | che'                      |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LA | 'Graphics.Vulkan.Core10.P |
--   | YOUT_EXT@                                | ipeline.VkPipelineLayout' |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS | 'Graphics.Vulkan.Core10.P |
--   | _EXT@                                    | ipeline.VkRenderPass'     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EX | 'Graphics.Vulkan.Core10.P |
--   | T@                                       | ipeline.VkPipeline'       |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_ | 'Graphics.Vulkan.Core10.P |
--   | SET_LAYOUT_EXT@                          | ipelineLayout.VkDescripto |
--   |                                          | rSetLayout'               |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXT | 'Graphics.Vulkan.Core10.S |
--   | @                                        | ampler.VkSampler'         |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_ | 'Graphics.Vulkan.Core10.D |
--   | POOL_EXT@                                | escriptorSet.VkDescriptor |
--   |                                          | Pool'                     |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_ | 'Graphics.Vulkan.Core10.D |
--   | SET_EXT@                                 | escriptorSet.VkDescriptor |
--   |                                          | Set'                      |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER | 'Graphics.Vulkan.Core10.P |
--   | _EXT@                                    | ass.VkFramebuffer'        |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_POO | 'Graphics.Vulkan.Core10.C |
--   | L_EXT@                                   | ommandPool.VkCommandPool' |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_SURFACE_KHR | 'Graphics.Vulkan.Extensio |
--   | _EXT@                                    | ns.VK_KHR_surface.VkSurfa |
--   |                                          | ceKHR'                    |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_SWAPCHAIN_K | 'Graphics.Vulkan.Extensio |
--   | HR_EXT@                                  | ns.VK_KHR_swapchain.VkSwa |
--   |                                          | pchainKHR'                |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DEBUG_REPOR | 'VkDebugReportCallbackEXT |
--   | T_CALLBACK_EXT_EXT@                      | '                         |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DISPLAY_KHR | 'Graphics.Vulkan.Extensio |
--   | _EXT@                                    | ns.VK_KHR_display.VkDispl |
--   |                                          | ayKHR'                    |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DISPLAY_MOD | 'Graphics.Vulkan.Extensio |
--   | E_KHR_EXT@                               | ns.VK_KHR_display.VkDispl |
--   |                                          | ayModeKHR'                |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_OBJECT_TABL | 'Graphics.Vulkan.Extensio |
--   | E_NVX_EXT@                               | ns.VK_NVX_device_generate |
--   |                                          | d_commands.VkObjectTableN |
--   |                                          | VX'                       |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_INDIRECT_CO | 'Graphics.Vulkan.Extensio |
--   | MMANDS_LAYOUT_NVX_EXT@                   | ns.VK_NVX_device_generate |
--   |                                          | d_commands.VkIndirectComm |
--   |                                          | andsLayoutNVX'            |
--   +------------------------------------------+---------------------------+
--   | @VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_ | 'Graphics.Vulkan.Core11.P |
--   | UPDATE_TEMPLATE_KHR_EXT@                 | romoted_from_VK_KHR_descr |
--   |                                          | iptor_update_template.VkD |
--   |                                          | escriptorUpdateTemplate'  |
--   +------------------------------------------+---------------------------+
--   
--   VkDebugReportObjectTypeEXT and Vulkan Handle Relationship
--

-- -- Note -- -- The primary expected use of VK_ERROR_VALIDATION_FAILED_EXT is -- for validation layer testing. It is not expected that an application -- would see this error code during normal use of the validation layers. -- --

Parameters

-- --

flags specifies the VkDebugReportFlagBitsEXT that -- triggered this callback.

-- --

objectType is a VkDebugReportObjectTypeEXT value -- specifying the type of object being used or created at the time the -- event was triggered.
object is the object where the issue was detected. If -- objectType is -- VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, object is -- undefined.
location is a component (layer, driver, loader) defined -- value that specifies the location of the trigger. This is an -- optional value.
messageCode is a layer-defined value indicating what test -- triggered this callback.
pLayerPrefix is a null-terminated string that is an -- abbreviation of the name of the component making the callback. -- pLayerPrefix is only valid for the duration of the -- callback.
pMessage is a null-terminated string detailing the -- trigger conditions. pMessage is only valid for the duration -- of the callback.
pUserData is the user data given when the -- VkDebugReportCallbackEXT was created.

-- --

Success - VK_SUCCESS

-- --

Failure - VK_ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

instance the instance where the callback was -- created.

-- --

callback the VkDebugReportCallbackEXT object to -- destroy. callback is an externally synchronized object and -- must not be used on more than one thread at a time. This means -- that vkDestroyDebugReportCallbackEXT must not be -- called when a callback is active.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- callback was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- callback was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

callback must be a valid -- VkDebugReportCallbackEXT handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
callback must have been created, allocated, or -- retrieved from instance

-- --

Host Synchronization

-- --

Host access to callback must be externally -- synchronized

-- --

Parameters

-- --

instance is the debug stream’s VkInstance.

-- --

flags specifies the VkDebugReportFlagBitsEXT -- classification of this event/message.
objectType is a VkDebugReportObjectTypeEXT -- specifying the type of object being used or created at the time the -- event was triggered.
object this is the object where the issue was detected. -- object can be VK_NULL_HANDLE if there is no -- object associated with the event.
location is an application defined value.
messageCode is an application defined value.
pLayerPrefix is the abbreviation of the component making -- this event/message.
pMessage is a null-terminated string detailing the -- trigger conditions.

-- --

Description

-- -- The call will propagate through the layers and generate callback(s) as -- indicated by the message’s flags. The parameters are passed on to the -- callback in addition to the pUserData value that was defined -- at the time the callback was registered. -- --

Valid Usage

-- --

object must be a Vulkan object or -- VK_NULL_HANDLE

-- --

If objectType is not -- VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object -- is not VK_NULL_HANDLE, object must be a -- Vulkan object of the corresponding type associated with -- objectType as defined in -- {html_spec_relative}#debug-report-object-types.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

flags must be a valid combination of -- VkDebugReportFlagBitsEXT values
flags must not be 0
objectType must be a valid -- VkDebugReportObjectTypeEXT value
pLayerPrefix must be a null-terminated UTF-8 -- string
pMessage must be a null-terminated UTF-8 -- string

-- --

Description

-- -- For each VkDebugReportCallbackEXT that is created the -- VkDebugReportCallbackCreateInfoEXT::flags determine -- when that -- VkDebugReportCallbackCreateInfoEXT::pfnCallback is -- called. When an event happens, the implementation will do a bitwise -- AND of the event’s VkDebugReportFlagBitsEXT flags to each -- VkDebugReportCallbackEXT object’s flags. For each non-zero -- result the corresponding callback will be called. The callback will -- come directly from the component that detected the event, unless some -- other layer intercepts the calls for its own purposes (filter them in -- a different way, log to a system error log, etc.). -- -- An application may receive multiple callbacks if multiple -- VkDebugReportCallbackEXT objects were created. A callback -- will always be executed in the same thread as the originating Vulkan -- call. -- -- A callback may be called from multiple threads simultaneously (if the -- application is making Vulkan calls from multiple threads). -- --

Valid Usage

-- --

pfnCallback must be a valid -- PFN_vkDebugReportCallbackEXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_REPORT_CALLBACK_CREATE_INFO_EXT

-- --

flags must be a valid combination of -- VkDebugReportFlagBitsEXT values

-- --

Description

-- --

Success - VK_SUCCESS

-- --

Failure - VK_ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device that destroys the validation -- cache object.

-- --

validationCache is the handle of the validation cache to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- validationCache was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- validationCache was created, pAllocator must -- be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If validationCache is not VK_NULL_HANDLE, -- validationCache must be a valid -- VkValidationCacheEXT handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If validationCache is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to validationCache must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the validation -- cache.

-- --

validationCache is the validation cache to retrieve data -- from.
pDataSize is a pointer to a value related to the amount -- of data in the validation cache, as described below.
pData is either NULL or a pointer to a -- buffer.

-- --

Description

-- -- If pData is NULL, then the maximum size of the data -- that can be retrieved from the validation cache, in bytes, is -- returned in pDataSize. Otherwise, pDataSize -- must point to a variable set by the user to the size of the -- buffer, in bytes, pointed to by pData, and on return the -- variable is overwritten with the amount of data actually written to -- pData. -- -- If pDataSize is less than the maximum size that can be -- retrieved by the validation cache, at most pDataSize bytes -- will be written to pData, and -- vkGetValidationCacheDataEXT will return -- VK_INCOMPLETE. Any data written to pData is valid -- and can be provided as the pInitialData member of the -- VkValidationCacheCreateInfoEXT structure passed to -- vkCreateValidationCacheEXT. -- -- Two calls to vkGetValidationCacheDataEXT with the same -- parameters must retrieve the same data unless a command that -- modifies the contents of the cache is called between them. -- -- Applications can store the data retrieved from the validation -- cache, and use these data, possibly in a future run of the -- application, to populate new validation cache objects. The results of -- validation, however, may depend on the vendor ID, device ID, -- driver version, and other details of the device. To enable -- applications to detect when previously retrieved data is incompatible -- with the device, the initial bytes written to pData -- must be a header consisting of the following members: -- --

--   +----+--------------+--------------------------------------------------+
--   | Of | Size         | Meaning                                          |
--   | fs |              |                                                  |
--   | et |              |                                                  |
--   +====+==============+==================================================+
--   | 0  | 4            | length in bytes of the entire validation cache   |
--   |    |              | header written as a stream of bytes, with the    |
--   |    |              | least significant byte first                     |
--   +----+--------------+--------------------------------------------------+
--   | 4  | 4            | a 'VkValidationCacheHeaderVersionEXT' value      |
--   |    |              | written as a stream of bytes, with the least     |
--   |    |              | significant byte first                           |
--   +----+--------------+--------------------------------------------------+
--   | 8  | @VK_UUID_SIZ | a layer commit ID expressed as a UUID, which     |
--   |    | E@           | uniquely identifies the version of the           |
--   |    |              | validation layers used to generate these         |
--   |    |              | validation results                               |
--   +----+--------------+--------------------------------------------------+
--   
--   Layout for validation cache header version
--   @VK_VALIDATION_CACHE_HEADER_VERSION_ONE_EXT@
--

-- -- The first four bytes encode the length of the entire validation cache -- header, in bytes. This value includes all fields in the header -- including the validation cache version field and the size of the -- length field. -- -- The next four bytes encode the validation cache version, as described -- for VkValidationCacheHeaderVersionEXT. A consumer of the -- validation cache should use the cache version to interpret the -- remainder of the cache header. -- -- If pDataSize is less than what is necessary to store this -- header, nothing will be written to pData and zero will be -- written to pDataSize. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

validationCache must be a valid -- VkValidationCacheEXT handle
pDataSize must be a valid pointer to a -- size_t value
If the value referenced by pDataSize is not 0, -- and pData is not NULL, pData must be -- a valid pointer to an array of pDataSize bytes
validationCache must have been created, allocated, -- or retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the validation -- cache objects.

-- --

dstCache is the handle of the validation cache to merge -- results into.
srcCacheCount is the length of the pSrcCaches -- array.
pSrcCaches is an array of validation cache handles, which -- will be merged into dstCache. The previous contents of -- dstCache are included after the merge.

-- --

Description

-- -- Note -- -- The details of the merge operation are implementation dependent, but -- implementations should merge the contents of the specified -- validation caches and prune duplicate entries. -- --

Valid Usage

-- --

dstCache must not appear in the list of source -- caches

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

dstCache must be a valid -- VkValidationCacheEXT handle
pSrcCaches must be a valid pointer to an array of -- srcCacheCount valid VkValidationCacheEXT -- handles
srcCacheCount must be greater than 0
dstCache must have been created, allocated, or -- retrieved from device
Each element of pSrcCaches must have been created, -- allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to dstCache must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage

-- --

If initialDataSize is not 0, it must be -- equal to the size of pInitialData, as returned by -- vkGetValidationCacheDataEXT when pInitialData was -- originally retrieved

-- --

If initialDataSize is not 0, -- pInitialData must have been retrieved from a previous -- call to vkGetValidationCacheDataEXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT

-- --

pNext must be NULL
flags must be 0
If initialDataSize is not 0, -- pInitialData must be a valid pointer to an array of -- initialDataSize bytes

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SHADER_MODULE_VALIDATION_CACHE_CREATE_INFO_EXT

-- --

validationCache must be a valid -- VkValidationCacheEXT handle

-- --

Description

-- --

VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT specifies -- a POSIX file descriptor handle that has only limited valid usage -- outside of Vulkan and other compatible APIs. It must be -- compatible with the POSIX system calls dup, dup2, -- close, and the non-standard system call dup3. -- Additionally, it must be transportable over a socket using an -- SCM_RIGHTS control message. It owns a reference to the -- underlying synchronization primitive represented by its Vulkan -- semaphore object.

-- --

VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT -- specifies an NT handle that has only limited valid usage outside of -- Vulkan and other compatible APIs. It must be compatible with -- the functions DuplicateHandle, CloseHandle, -- CompareObjectHandles, GetHandleInformation, and -- SetHandleInformation. It owns a reference to the underlying -- synchronization primitive represented by its Vulkan semaphore -- object.
VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT -- specifies a global share handle that has only limited valid usage -- outside of Vulkan and other compatible APIs. It is not compatible with -- any native APIs. It does not own a reference to the underlying -- synchronization primitive represented its Vulkan semaphore object, and -- will therefore become invalid when all Vulkan semaphore objects -- associated with it are destroyed.
VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT -- specifies an NT handle returned by -- ID3D12Device::CreateSharedHandle referring to a -- Direct3D 12 fence. It owns a reference to the underlying -- synchronization primitive associated with the Direct3D fence.
VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT specifies a -- POSIX file descriptor handle to a Linux Sync File or Android Fence -- object. It can be used with any native API accepting a valid sync file -- or fence as input. It owns a reference to the underlying -- synchronization primitive associated with the file descriptor. -- Implementations which support importing this handle type must -- accept any type of sync or fence FD supported by the native system -- they are running on.

-- -- Note -- -- Handles of type VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT -- generated by the implementation may represent either Linux Sync Files -- or Android Fences at the implementation’s discretion. Applications -- should only use operations defined for both types of file -- descriptors, unless they know via means external to Vulkan the type of -- the file descriptor, or are prepared to deal with the system-defined -- operation failures resulting from using the wrong type. -- -- Some external semaphore handle types can only be shared within the -- same underlying physical device and/or the same driver version, as -- defined in the following table: -- --

--   +----------------------+----------------------+-----------------------+
--   | Handle type          | @VkPhysicalDeviceIDP | @VkPhysicalDeviceIDPr |
--   |                      | roperties@::@driverU | operties@::@deviceUUI |
--   |                      | UID@                 | D@                    |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHO | Must match           | Must match            |
--   | RE_HANDLE_TYPE_OPAQU |                      |                       |
--   | E_FD_BIT@            |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHO | Must match           | Must match            |
--   | RE_HANDLE_TYPE_OPAQU |                      |                       |
--   | E_WIN32_BIT@         |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHO | Must match           | Must match            |
--   | RE_HANDLE_TYPE_OPAQU |                      |                       |
--   | E_WIN32_KMT_BIT@     |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHO | Must match           | Must match            |
--   | RE_HANDLE_TYPE_D3D12 |                      |                       |
--   | _FENCE_BIT@          |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHO | No restriction       | No restriction        |
--   | RE_HANDLE_TYPE_SYNC_ |                      |                       |
--   | FD_BIT@              |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   
--   External semaphore handle types compatibility
--

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the semaphore capabilities.

-- --

pExternalSemaphoreInfo points to an instance of the -- VkPhysicalDeviceExternalSemaphoreInfo structure, describing the -- parameters that would be consumed by vkCreateSemaphore.
pExternalSemaphoreProperties points to an instance of the -- VkExternalSemaphoreProperties structure in which capabilities -- are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pExternalSemaphoreInfo must be a valid pointer to -- a valid VkPhysicalDeviceExternalSemaphoreInfo structure
pExternalSemaphoreProperties must be a valid -- pointer to a VkExternalSemaphoreProperties structure

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_SEMAPHORE_INFO

-- --

pNext must be NULL
handleType must be a valid -- VkExternalSemaphoreHandleTypeFlagBits value

-- --

Description

-- -- If handleType is not supported by the implementation, then -- VkExternalSemaphoreProperties::externalSemaphoreFeatures -- will be set to zero. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_EXTERNAL_SEMAPHORE_PROPERTIES

-- --

pNext must be NULL

-- --

sType must be -- VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO

-- --

handleTypes must be a valid combination of -- VkExternalSemaphoreHandleTypeFlagBits values

-- --

Description

-- -- VkSemaphoreImportFlags is a bitmask type for setting a mask -- of zero or more VkSemaphoreImportFlagBits. -- --

Description

-- --

VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT specifies a -- POSIX file descriptor handle that has only limited valid usage outside -- of Vulkan and other compatible APIs. It must be compatible with -- the POSIX system calls dup, dup2, close, -- and the non-standard system call dup3. Additionally, it -- must be transportable over a socket using an -- SCM_RIGHTS control message. It owns a reference to the -- underlying synchronization primitive represented by its Vulkan fence -- object.

-- --

VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT specifies -- an NT handle that has only limited valid usage outside of Vulkan and -- other compatible APIs. It must be compatible with the functions -- DuplicateHandle, CloseHandle, -- CompareObjectHandles, GetHandleInformation, and -- SetHandleInformation. It owns a reference to the underlying -- synchronization primitive represented by its Vulkan fence object.
VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT -- specifies a global share handle that has only limited valid usage -- outside of Vulkan and other compatible APIs. It is not compatible with -- any native APIs. It does not own a reference to the underlying -- synchronization primitive represented by its Vulkan fence object, and -- will therefore become invalid when all Vulkan fence objects associated -- with it are destroyed.
VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT specifies a -- POSIX file descriptor handle to a Linux Sync File or Android Fence. It -- can be used with any native API accepting a valid sync file or fence -- as input. It owns a reference to the underlying synchronization -- primitive associated with the file descriptor. Implementations which -- support importing this handle type must accept any type of sync -- or fence FD supported by the native system they are running on.

-- -- Some external fence handle types can only be shared within the same -- underlying physical device and/or the same driver version, as defined -- in the following table: -- --

--   +----------------------+----------------------+-----------------------+
--   | Handle type          | @VkPhysicalDeviceIDP | @VkPhysicalDeviceIDPr |
--   |                      | roperties@::@driverU | operties@::@deviceUUI |
--   |                      | UID@                 | D@                    |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_FENCE_H | Must match           | Must match            |
--   | ANDLE_TYPE_OPAQUE_FD |                      |                       |
--   | _BIT@                |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_FENCE_H | Must match           | Must match            |
--   | ANDLE_TYPE_OPAQUE_WI |                      |                       |
--   | N32_BIT@             |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_FENCE_H | Must match           | Must match            |
--   | ANDLE_TYPE_OPAQUE_WI |                      |                       |
--   | N32_KMT_BIT@         |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_FENCE_H | No restriction       | No restriction        |
--   | ANDLE_TYPE_SYNC_FD_B |                      |                       |
--   | IT@                  |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   
--   External fence handle types compatibility
--

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the fence capabilities.

-- --

pExternalFenceInfo points to an instance of the -- VkPhysicalDeviceExternalFenceInfo structure, describing the -- parameters that would be consumed by vkCreateFence.
pExternalFenceProperties points to an instance of the -- VkExternalFenceProperties structure in which capabilities are -- returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pExternalFenceInfo must be a valid pointer to a -- valid VkPhysicalDeviceExternalFenceInfo structure
pExternalFenceProperties must be a valid pointer -- to a VkExternalFenceProperties structure

-- --

Description

-- -- Note -- -- Handles of type VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT -- generated by the implementation may represent either Linux Sync Files -- or Android Fences at the implementation’s discretion. Applications -- should only use operations defined for both types of file -- descriptors, unless they know via means external to Vulkan the type of -- the file descriptor, or are prepared to deal with the system-defined -- operation failures resulting from using the wrong type. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO

-- --

pNext must be NULL
handleType must be a valid -- VkExternalFenceHandleTypeFlagBits value

-- --

Description

-- -- If handleType is not supported by the implementation, then -- VkExternalFenceProperties::externalFenceFeatures will -- be set to zero. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES

-- --

pNext must be NULL

-- --

sType must be -- VK_STRUCTURE_TYPE_EXPORT_FENCE_CREATE_INFO

-- --

handleTypes must be a valid combination of -- VkExternalFenceHandleTypeFlagBits values

-- --

Description

-- -- VkFenceImportFlags is a bitmask type for setting a mask of -- zero or more VkFenceImportFlagBits. -- --

Parameters

-- --

instance is a handle to a Vulkan instance previously -- created with vkCreateInstance.

-- --

pPhysicalDeviceGroupCount is a pointer to an integer -- related to the number of device groups available or queried, as -- described below.
pPhysicalDeviceGroupProperties is either NULL or -- a pointer to an array of VkPhysicalDeviceGroupProperties -- structures.

-- --

Description

-- -- If pPhysicalDeviceGroupProperties is NULL, then the -- number of device groups available is returned in -- pPhysicalDeviceGroupCount. Otherwise, -- pPhysicalDeviceGroupCount must point to a variable set -- by the user to the number of elements in the -- pPhysicalDeviceGroupProperties array, and on return the -- variable is overwritten with the number of structures actually written -- to pPhysicalDeviceGroupProperties. If -- pPhysicalDeviceGroupCount is less than the number of device -- groups available, at most pPhysicalDeviceGroupCount -- structures will be written. If pPhysicalDeviceGroupCount is -- smaller than the number of device groups available, -- VK_INCOMPLETE will be returned instead of -- VK_SUCCESS, to indicate that not all the available device -- groups were returned. -- -- Every physical device must be in exactly one device group. -- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

pPhysicalDeviceGroupCount must be a valid pointer -- to a uint32_t value
If the value referenced by pPhysicalDeviceGroupCount is -- not 0, and pPhysicalDeviceGroupProperties is not -- NULL, pPhysicalDeviceGroupProperties must be -- a valid pointer to an array of pPhysicalDeviceGroupCount -- VkPhysicalDeviceGroupProperties structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INITIALIZATION_FAILED
```

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFO

-- --

If physicalDeviceCount is not 0, -- pPhysicalDevices must be a valid pointer to an array -- of physicalDeviceCount valid VkPhysicalDevice -- handles

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INVALID_SHADER_NV
```

-- --

Parameters

-- --

device is the logical device that destroys the shader -- module.

-- --

shaderModule is the handle of the shader module to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- -- A shader module can be destroyed while pipelines created using -- its shaders are still in use. -- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- shaderModule was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- shaderModule was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If shaderModule is not VK_NULL_HANDLE, -- shaderModule must be a valid VkShaderModule -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If shaderModule is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to shaderModule must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

codeSize must be greater than 0

-- --

If pCode points to SPIR-V code, codeSize -- must be a multiple of 4
pCode must point to either valid SPIR-V code, -- formatted and packed as described by the Khronos SPIR-V -- Specification or valid GLSL code which must be written to -- the GL_KHR_vulkan_glsl extension specification
If pCode points to SPIR-V code, that code must -- adhere to the validation rules described by the Validation Rules -- within a Module section of the SPIR-V Environment -- appendix
If pCode points to GLSL code, it must be valid -- GLSL code written to the GL_KHR_vulkan_glsl GLSL extension -- specification
pCode must declare the Shader capability -- for SPIR-V code
pCode must not declare any capability that is not -- supported by the API, as described by the Capabilities section -- of the SPIR-V Environment appendix
If pCode declares any of the capabilities listed as -- optional in the SPIR-V Environment appendix, the -- corresponding feature(s) must be enabled.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkShaderModuleValidationCacheCreateInfoEXT
flags must be 0
pCode must be a valid pointer to an array of -- <math> uint32_t values

-- --

Description

-- --

VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT specifies the stage of -- the pipeline where any commands are initially received by the -- queue.

-- --

VK_PIPELINE_STAGE_COMMAND_PROCESS_BIT_NVX specifies the -- stage of the pipeline where device-side generation of commands via -- vkCmdProcessCommandsNVX is handled.
VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT specifies the stage -- of the pipeline where Draw/DispatchIndirect data structures are -- consumed. This stage also includes reading commands written by -- vkCmdProcessCommandsNVX.
VK_PIPELINE_STAGE_VERTEX_INPUT_BIT specifies the stage of -- the pipeline where vertex and index buffers are consumed.
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT specifies the vertex -- shader stage.
VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT -- specifies the tessellation control shader stage.
VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT -- specifies the tessellation evaluation shader stage.
VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT specifies the -- geometry shader stage.
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT specifies the -- fragment shader stage.
VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT specifies the -- stage of the pipeline where early fragment tests (depth and stencil -- tests before fragment shading) are performed. This stage also includes -- subpass load operations for framebuffer attachments with a -- depth/stencil format.
VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT specifies the -- stage of the pipeline where late fragment tests (depth and stencil -- tests after fragment shading) are performed. This stage also includes -- subpass store operations for framebuffer attachments with a -- depth/stencil format.
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT specifies -- the stage of the pipeline after blending where the final color values -- are output from the pipeline. This stage also includes subpass load -- and store operations and multisample resolve operations for -- framebuffer attachments with a color format.
VK_PIPELINE_STAGE_TRANSFER_BIT specifies the execution of -- copy commands. This includes the operations resulting from all copy -- commands, clear commands (with the exception of -- vkCmdClearAttachments), and -- vkCmdCopyQueryPoolResults.
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT specifies the -- execution of a compute shader.
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT specifies the final -- stage in the pipeline where operations generated by all commands -- complete execution.
VK_PIPELINE_STAGE_HOST_BIT specifies a pseudo-stage -- indicating execution on the host of reads/writes of device memory. -- This stage is not invoked by any commands recorded in a command -- buffer.

VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT specifies the -- execution of all graphics pipeline stages, and is equivalent to the -- logical OR -- of:

```
VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT
```
```
VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT
```
```
VK_PIPELINE_STAGE_VERTEX_INPUT_BIT
```
```
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT
```

VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT

VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT

```
VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
```
```
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT
```

VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT

VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT

VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT

```
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT
```

VK_PIPELINE_STAGE_ALL_COMMANDS_BIT is equivalent to the -- logical OR of every other pipeline stage flag that is supported on the -- queue it is used with.

-- --

device must be a valid VkDevice -- handle

-- --

pQueue must be a valid pointer to a -- VkQueue handle

-- --

Parameters

-- --

queue is the queue that the command buffers will be -- submitted to.

-- --

submitCount is the number of elements in the -- pSubmits array.
pSubmits is a pointer to an array of VkSubmitInfo -- structures, each specifying a command buffer submission batch.
fence is an optional handle to a fence to be -- signaled once all submitted command buffers have completed execution. -- If fence is not VK_NULL_HANDLE, it defines a fence -- signal operation.

-- --

Description

-- -- Note -- -- Submission can be a high overhead operation, and applications -- should attempt to batch work together into as few calls to -- vkQueueSubmit as possible. -- -- vkQueueSubmit is a queue submission command, with each -- batch defined by an element of pSubmits as an instance of the -- VkSubmitInfo structure. Batches begin execution in the order -- they appear in pSubmits, but may complete out of -- order. -- -- Fence and semaphore operations submitted with vkQueueSubmit -- have additional ordering constraints compared to other submission -- commands, with dependencies involving previous and subsequent queue -- operations. Information about these additional constraints can be -- found in the semaphore and fence sections of the -- synchronization chapter. -- -- Details on the interaction of pWaitDstStageMask with -- synchronization are described in the semaphore wait operation -- section of the synchronization chapter. -- -- The order that batches appear in pSubmits is used to -- determine submission order, and thus all the implicit -- ordering guarantees that respect it. Other than these implicit -- ordering guarantees and any explicit synchronization -- primitives, these batches may overlap or otherwise execute -- out of order. -- -- If any command buffer submitted to this queue is in the executable -- state, it is moved to the pending state. Once execution of -- all submissions of a command buffer complete, it moves from the -- pending state, back to the executable state. If a -- command buffer was recorded with the -- VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag, it instead -- moves back to the invalid state. -- -- If vkQueueSubmit fails, it may return -- VK_ERROR_OUT_OF_HOST_MEMORY or -- VK_ERROR_OUT_OF_DEVICE_MEMORY. If it does, the implementation -- must ensure that the state and contents of any resources or -- synchronization primitives referenced by the submitted command buffers -- and any semaphores referenced by pSubmits is unaffected by -- the call or its failure. If vkQueueSubmit fails in such a way -- that the implementation is unable to make that guarantee, the -- implementation must return VK_ERROR_DEVICE_LOST. See -- Lost Device. -- --

Valid Usage

-- --

If fence is not VK_NULL_HANDLE, fence -- must be unsignaled

-- --

If fence is not VK_NULL_HANDLE, fence -- must not be associated with any other queue command that has -- not yet completed execution on that queue
Any calls to vkCmdSetEvent, vkCmdResetEvent or -- vkCmdWaitEvents that have been recorded into any of the command -- buffer elements of the pCommandBuffers member of any element -- of pSubmits, must not reference any VkEvent -- that is referenced by any of those commands in a command buffer that -- has been submitted to another queue and is still in the pending -- state.
Any stage flag included in any element of the -- pWaitDstStageMask member of any element of pSubmits -- must be a pipeline stage supported by one of the capabilities -- of queue, as specified in the table of supported pipeline -- stages.
Each element of the pSignalSemaphores member of any -- element of pSubmits must be unsignaled when the -- semaphore signal operation it defines is executed on the device
When a semaphore unsignal operation defined by any element of the -- pWaitSemaphores member of any element of pSubmits -- executes on queue, no other queue must be waiting on -- the same semaphore.
All elements of the pWaitSemaphores member of all -- elements of pSubmits must be semaphores that are -- signaled, or have semaphore signal operations previously -- submitted for execution.
Each element of the pCommandBuffers member of each -- element of pSubmits must be in the pending or -- executable state.
If any element of the pCommandBuffers member of any -- element of pSubmits was not recorded with the -- VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must -- not be in the pending state.
Any secondary command buffers recorded into any element of -- the pCommandBuffers member of any element of -- pSubmits must be in the pending or executable -- state.
If any secondary command buffers recorded into any element -- of the pCommandBuffers member of any element of -- pSubmits was not recorded with the -- VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must -- not be in the pending state.
Each element of the pCommandBuffers member of each -- element of pSubmits must have been allocated from a -- VkCommandPool that was created for the same queue family -- queue belongs to.

-- --

Valid Usage (Implicit)

-- --

queue must be a valid VkQueue handle

-- --

If submitCount is not 0, pSubmits -- must be a valid pointer to an array of submitCount -- valid VkSubmitInfo structures
If fence is not VK_NULL_HANDLE, fence -- must be a valid VkFence handle
Both of fence, and queue that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to queue must be externally -- synchronized

-- --

Host access to pSubmits[].pWaitSemaphores[] must -- be externally synchronized
Host access to pSubmits[].pSignalSemaphores[] must -- be externally synchronized
Host access to fence must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | -               | -               | Any             | -               |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Parameters

-- --

queue is the queue on which to wait.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Parameters

-- --

device is the logical device to idle.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Description

-- -- The order that command buffers appear in pCommandBuffers is -- used to determine submission order, and thus all the -- implicit ordering guarantees that respect it. Other than these -- implicit ordering guarantees and any explicit synchronization -- primitives, these command buffers may overlap or otherwise -- execute out of order. -- --

Valid Usage

-- --

Each element of pCommandBuffers must not have been -- allocated with VK_COMMAND_BUFFER_LEVEL_SECONDARY

-- --

If the geometry shaders feature is not enabled, each -- element of pWaitDstStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, each -- element of pWaitDstStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
Each element of pWaitDstStageMask must not include -- VK_PIPELINE_STAGE_HOST_BIT.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SUBMIT_INFO

-- --

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 VkD3D12FenceSubmitInfoKHR, -- VkDeviceGroupSubmitInfo, VkProtectedSubmitInfo, -- VkWin32KeyedMutexAcquireReleaseInfoKHR, or -- VkWin32KeyedMutexAcquireReleaseInfoNV
Each sType member in the pNext chain must -- be unique
If waitSemaphoreCount is not 0, -- pWaitSemaphores must be a valid pointer to an array of -- waitSemaphoreCount valid VkSemaphore handles
If waitSemaphoreCount is not 0, -- pWaitDstStageMask must be a valid pointer to an array -- of waitSemaphoreCount valid combinations of -- VkPipelineStageFlagBits values
Each element of pWaitDstStageMask must not be -- 0
If commandBufferCount is not 0, -- pCommandBuffers must be a valid pointer to an array of -- commandBufferCount valid VkCommandBuffer -- handles
If signalSemaphoreCount is not 0, -- pSignalSemaphores must be a valid pointer to an array -- of signalSemaphoreCount valid VkSemaphore -- handles
Each of the elements of pCommandBuffers, the elements of -- pSignalSemaphores, and the elements of -- pWaitSemaphores that are valid handles must have been -- created, allocated, or retrieved from the same VkDevice

-- --

Description

-- -- VkPipelineStageFlags is a bitmask type for setting a mask of -- zero or more VkPipelineStageFlagBits. -- --

Parameters

-- --

device is the logical device that created the semaphore -- being exported.

-- --

pGetFdInfo is a pointer to an instance of the -- VkSemaphoreGetFdInfoKHR structure containing parameters of the -- export operation.
pFd will return the file descriptor representing the -- semaphore payload.

-- --

Description

-- -- Each call to vkGetSemaphoreFdKHR must create a new -- file descriptor and transfer ownership of it to the application. To -- avoid leaking resources, the application must release ownership -- of the file descriptor when it is no longer needed. -- -- Note -- -- Ownership can be released in many ways. For example, the application -- can call close() on the file descriptor, or transfer -- ownership back to Vulkan by using the file descriptor to import a -- semaphore payload. -- -- Where supported by the operating system, the implementation -- must set the file descriptor to be closed automatically when an -- execve system call is made. -- -- Exporting a file descriptor from a semaphore may have side -- effects depending on the transference of the specified handle type, as -- described in Importing Semaphore State. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pGetFdInfo must be a valid pointer to a valid -- VkSemaphoreGetFdInfoKHR structure
pFd must be a valid pointer to a int -- value

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_TOO_MANY_OBJECTS
- ```
VK_ERROR_OUT_OF_HOST_MEMORY
```

-- --

Parameters

-- --

device is the logical device that created the -- semaphore.

-- --

pImportSemaphoreFdInfo points to a -- VkImportSemaphoreFdInfoKHR structure specifying the semaphore -- and import parameters.

-- --

Description

-- -- Importing a semaphore payload from a file descriptor transfers -- ownership of the file descriptor from the application to the Vulkan -- implementation. The application must not perform any operations -- on the file descriptor after a successful import. -- -- Applications can import the same semaphore payload into -- multiple instances of Vulkan, into the same instance from which it was -- exported, and multiple times into a given Vulkan instance. -- --

Valid Usage

-- --

semaphore must not be associated with any queue -- command that has not yet completed execution on that queue

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pImportSemaphoreFdInfo must be a valid pointer to -- a valid VkImportSemaphoreFdInfoKHR structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_INVALID_EXTERNAL_HANDLE
```

-- --

Description

-- -- The handle types supported by handleType are: -- --

--   +-----------------------+-----------------------+-----------------------+
--   | Handle Type           | Transference          | Permanence Supported  |
--   +=======================+=======================+=======================+
--   | @VK_EXTERNAL_SEMAPHOR | Reference             | Temporary,Permanent   |
--   | E_HANDLE_TYPE_OPAQUE_ |                       |                       |
--   | FD_BIT@               |                       |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | @VK_EXTERNAL_SEMAPHOR | Copy                  | Temporary             |
--   | E_HANDLE_TYPE_SYNC_FD |                       |                       |
--   | _BIT@                 |                       |                       |
--   +-----------------------+-----------------------+-----------------------+
--   
--   Handle Types Supported by VkImportSemaphoreFdInfoKHR
--

-- --

Valid Usage

-- --

handleType must be a value included in the -- Handle Types Supported by VkImportSemaphoreFdInfoKHR -- table.

-- --

fd must obey any requirements listed for -- handleType in external semaphore handle types -- compatibility.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid VkSemaphore -- handle
flags must be a valid combination of -- VkSemaphoreImportFlagBits values
handleType must be a valid -- VkExternalSemaphoreHandleTypeFlagBits value

-- --

Host Synchronization

-- --

Host access to semaphore must be externally -- synchronized

-- --

Description

-- -- The properties of the file descriptor returned depend on the value of -- handleType. See VkExternalSemaphoreHandleTypeFlagBits -- for a description of the properties of the defined external semaphore -- handle types. -- --

Valid Usage

-- --

handleType must have been included in -- VkExportSemaphoreCreateInfo::handleTypes when -- semaphore’s current payload was created.

-- --

semaphore must not currently have its payload -- replaced by an imported payload as described below in Importing -- Semaphore Payloads unless that imported payload’s handle type was -- included in -- VkExternalSemaphoreProperties::exportFromImportedHandleTypes -- for handleType.
If handleType refers to a handle type with copy payload -- transference semantics, as defined below in Importing Semaphore -- Payloads, there must be no queue waiting on -- semaphore.
If handleType refers to a handle type with copy payload -- transference semantics, semaphore must be signaled, or -- have an associated semaphore signal operation pending -- execution.
handleType must be defined as a POSIX file -- descriptor handle.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid VkSemaphore -- handle
handleType must be a valid -- VkExternalSemaphoreHandleTypeFlagBits value

-- --

Parameters

-- --

device is the logical device that created the fence being -- exported.

-- --

pGetFdInfo is a pointer to an instance of the -- VkFenceGetFdInfoKHR structure containing parameters of the -- export operation.
pFd will return the file descriptor representing the -- fence payload.

-- --

Description

-- -- Each call to vkGetFenceFdKHR must create a new file -- descriptor and transfer ownership of it to the application. To avoid -- leaking resources, the application must release ownership of -- the file descriptor when it is no longer needed. -- -- Note -- -- Ownership can be released in many ways. For example, the application -- can call close() on the file descriptor, or transfer -- ownership back to Vulkan by using the file descriptor to import a -- fence payload. -- -- If pGetFdInfo::handleType is -- VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT and the fence is -- signaled at the time vkGetFenceFdKHR is called, pFd -- may return the value -1 instead of a valid file -- descriptor. -- -- Where supported by the operating system, the implementation -- must set the file descriptor to be closed automatically when an -- execve system call is made. -- -- Exporting a file descriptor from a fence may have side effects -- depending on the transference of the specified handle type, as -- described in Importing Fence State. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pGetFdInfo must be a valid pointer to a valid -- VkFenceGetFdInfoKHR structure
pFd must be a valid pointer to a int -- value

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_TOO_MANY_OBJECTS
- ```
VK_ERROR_OUT_OF_HOST_MEMORY
```

-- --

Parameters

-- --

device is the logical device that created the fence.

-- --

pImportFenceFdInfo points to a -- VkImportFenceFdInfoKHR structure specifying the fence and -- import parameters.

-- --

Description

-- -- Importing a fence payload from a file descriptor transfers ownership -- of the file descriptor from the application to the Vulkan -- implementation. The application must not perform any operations -- on the file descriptor after a successful import. -- -- Applications can import the same fence payload into multiple -- instances of Vulkan, into the same instance from which it was -- exported, and multiple times into a given Vulkan instance. -- --

Valid Usage

-- --

fence must not be associated with any queue -- command that has not yet completed execution on that queue

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pImportFenceFdInfo must be a valid pointer to a -- valid VkImportFenceFdInfoKHR structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_INVALID_EXTERNAL_HANDLE
```

-- --

Description

-- -- The handle types supported by handleType are: -- --

--   +-----------------------+-----------------------+-----------------------+
--   | Handle Type           | Transference          | Permanence Supported  |
--   +=======================+=======================+=======================+
--   | @VK_EXTERNAL_FENCE_HA | Reference             | Temporary,Permanent   |
--   | NDLE_TYPE_OPAQUE_FD_B |                       |                       |
--   | IT@                   |                       |                       |
--   +-----------------------+-----------------------+-----------------------+
--   | @VK_EXTERNAL_FENCE_HA | Copy                  | Temporary             |
--   | NDLE_TYPE_SYNC_FD_BIT |                       |                       |
--   | @                     |                       |                       |
--   +-----------------------+-----------------------+-----------------------+
--   
--   Handle Types Supported by VkImportFenceFdInfoKHR
--

-- --

Valid Usage

-- --

handleType must be a value included in the -- Handle Types Supported by VkImportFenceFdInfoKHR table.

-- --

fd must obey any requirements listed for -- handleType in external fence handle types -- compatibility.

-- -- If handleType is -- VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT, the special value -- -1 for fd is treated like a valid sync file -- descriptor referring to an object that has already signaled. The -- import operation will succeed and the VkFence will have a -- temporarily imported payload as if a valid file descriptor had been -- provided. -- -- Note -- -- This special behavior for importing an invalid sync file descriptor -- allows easier interoperability with other system APIs which use the -- convention that an invalid sync file descriptor represents work that -- has already completed and doesn’t need to be waited for. It is -- consistent with the option for implementations to return a -1 -- file descriptor when exporting a -- VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT from a -- VkFence which is signaled. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR

-- --

pNext must be NULL
fence must be a valid VkFence handle
flags must be a valid combination of -- VkFenceImportFlagBits values
handleType must be a valid -- VkExternalFenceHandleTypeFlagBits value

-- --

Host Synchronization

-- --

Host access to fence must be externally -- synchronized

-- --

Description

-- -- The properties of the file descriptor returned depend on the value of -- handleType. See VkExternalFenceHandleTypeFlagBits for -- a description of the properties of the defined external fence handle -- types. -- --

Valid Usage

-- --

handleType must have been included in -- VkExportFenceCreateInfo::handleTypes when -- fence’s current payload was created.

-- --

If handleType refers to a handle type with copy payload -- transference semantics, fence must be signaled, or -- have an associated fence signal operation pending -- execution.
fence must not currently have its payload replaced -- by an imported payload as described below in Importing Fence -- Payloads unless that imported payload’s handle type was included -- in -- VkExternalFenceProperties::exportFromImportedHandleTypes -- for handleType.
handleType must be defined as a POSIX file -- descriptor handle.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

-- --

pNext must be NULL
fence must be a valid VkFence handle
handleType must be a valid -- VkExternalFenceHandleTypeFlagBits value

-- --

Parameters

-- --

messageSeverity specifies the -- VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this -- callback.

-- --

messageTypes specifies the -- VkDebugUtilsMessageTypeFlagBitsEXT that triggered this -- callback.
pCallbackData contains all the callback related data in -- the VkDebugUtilsMessengerCallbackDataEXT structure.
pUserData is the user data provided when the -- VkDebugUtilsMessengerEXT was created.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the device that created the object.

-- --

pTagInfo is a pointer to an instance of the -- VkDebugUtilsObjectTagInfoEXT structure specifying the -- parameters of the tag to attach to the object.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pTagInfo must be a valid pointer to a valid -- VkDebugUtilsObjectTagInfoEXT structure

-- --

Host Synchronization

-- --

Host access to pTagInfo.objectHandle must be -- externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

queue is the queue in which to start a debug label -- region.

-- --

pLabelInfo is a pointer to an instance of the -- VkDebugUtilsLabelEXT structure specifying the parameters of the -- label region to open.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

queue must be a valid VkQueue handle

-- --

pLabelInfo must be a valid pointer to a valid -- VkDebugUtilsLabelEXT structure

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | -               | -               | Any             | -               |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

queue is the queue in which a debug label region should -- be closed.

-- --

queue is the queue into which a debug label will be -- inserted.

-- --

pLabelInfo is a pointer to an instance of the -- VkDebugUtilsLabelEXT structure specifying the parameters of the -- label to insert.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

queue must be a valid VkQueue handle

-- --

pLabelInfo must be a valid pointer to a valid -- VkDebugUtilsLabelEXT structure

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | -               | -               | Any             | -               |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

pLabelInfo is a pointer to an instance of the -- VkDebugUtilsLabelEXT structure specifying the parameters of the -- label region to open.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pLabelInfo must be a valid pointer to a valid -- VkDebugUtilsLabelEXT structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

Description

-- -- An application may open a debug label region in one command -- buffer and close it in another, or otherwise split debug label regions -- across multiple command buffers or multiple queue submissions. When -- viewed from the linear series of submissions to a single queue, the -- calls to vkCmdBeginDebugUtilsLabelEXT and -- vkCmdEndDebugUtilsLabelEXT must be matched and balanced. -- --

Valid Usage

-- --

There must be an outstanding -- vkCmdBeginDebugUtilsLabelEXT command prior to the -- vkCmdEndDebugUtilsLabelEXT on the queue that -- commandBuffer is submitted to

-- --

If commandBuffer is a secondary command buffer, there -- must be an outstanding vkCmdBeginDebugUtilsLabelEXT -- command recorded to commandBuffer that has not previously -- been ended by a call to vkCmdEndDebugUtilsLabelEXT.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

pInfo is a pointer to an instance of the -- VkDebugUtilsLabelEXT structure specifying the parameters of the -- label to insert.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pLabelInfo must be a valid pointer to a valid -- VkDebugUtilsLabelEXT structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

instance the instance the messenger will be used -- with.

-- --

pCreateInfo points to a -- VkDebugUtilsMessengerCreateInfoEXT structure which contains the -- callback pointer as well as defines the conditions under which this -- messenger will trigger the callback.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pMessenger is a pointer to record the -- VkDebugUtilsMessengerEXT object created.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkDebugUtilsMessengerCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pMessenger must be a valid pointer to a -- VkDebugUtilsMessengerEXT handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - VK_ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

instance the instance where the callback was -- created.

-- --

messenger the VkDebugUtilsMessengerEXT object to -- destroy. messenger is an externally synchronized object and -- must not be used on more than one thread at a time. This means -- that vkDestroyDebugUtilsMessengerEXT must not be -- called when a callback is active.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- messenger was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- messenger was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

messenger must be a valid -- VkDebugUtilsMessengerEXT handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
messenger must have been created, allocated, or -- retrieved from instance

-- --

Host Synchronization

-- --

Host access to messenger must be externally -- synchronized

-- --

Parameters

-- --

instance is the debug stream’s VkInstance.

-- --

messageSeverity is the -- VkDebugUtilsMessageSeverityFlagBitsEXT severity of this -- event/message.
messageTypes is a bitmask of -- VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of -- event(s) to identify with this message.
pCallbackData contains all the callback related data in -- the VkDebugUtilsMessengerCallbackDataEXT structure.

-- --

Description

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

messageSeverity must be a valid -- VkDebugUtilsMessageSeverityFlagBitsEXT value
messageTypes must be a valid combination of -- VkDebugUtilsMessageTypeFlagBitsEXT values
messageTypes must not be 0
pCallbackData must be a valid pointer to a valid -- VkDebugUtilsMessengerCallbackDataEXT structure

-- --

Description

-- -- Applications may change the name associated with an object -- simply by calling vkSetDebugUtilsObjectNameEXT again with a -- new string. If pObjectName is an empty string, then any -- previously set name is removed. -- --

Valid Usage

-- --

objectType must not be -- VK_OBJECT_TYPE_UNKNOWN

-- --

objectHandle must not be -- VK_NULL_HANDLE
objectHandle must be a Vulkan object of the type -- associated with objectType as defined in -- {html_spec_relative}#debugging-object-types.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT

-- --

pNext must be NULL
objectType must be a valid VkObjectType -- value
If pObjectName is not NULL, pObjectName -- must be a null-terminated UTF-8 string

-- --

Description

-- -- The tagName parameter gives a name or identifier to the type -- of data being tagged. This can be used by debugging layers to easily -- filter for only data that can be used by that implementation. -- --

Valid Usage

-- --

objectType must not be -- VK_OBJECT_TYPE_UNKNOWN

-- --

objectHandle must not be -- VK_NULL_HANDLE
objectHandle must be a Vulkan object of the type -- associated with objectType as defined in -- {html_spec_relative}#debugging-object-types.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXT

-- --

pNext must be NULL
objectType must be a valid VkObjectType -- value
pTag must be a valid pointer to an array of -- tagSize bytes
tagSize must be greater than 0

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT

-- --

pNext must be NULL
pLabelName must be a null-terminated UTF-8 -- string

-- --

Description

-- -- For each VkDebugUtilsMessengerEXT that is created the -- VkDebugUtilsMessengerCreateInfoEXT::messageSeverity -- and VkDebugUtilsMessengerCreateInfoEXT::messageTypes -- determine when that -- VkDebugUtilsMessengerCreateInfoEXT::pfnUserCallback -- is called. The process to determine if the user’s pfnUserCallback is -- triggered when an event occurs is as follows: -- --

The implementation will perform a bitwise AND of the event’s -- VkDebugUtilsMessageSeverityFlagBitsEXT with the -- messageSeverity provided during creation of the -- VkDebugUtilsMessengerEXT object.
1. If the value is 0, the -- message is skipped.
The implementation will perform bitwise AND of the event’s -- VkDebugUtilsMessageTypeFlagBitsEXT with the -- messageType provided during the creation of the -- VkDebugUtilsMessengerEXT object.
1. If the value is 0, the -- message is skipped.
The callback will trigger a debug message for the current -- event

-- -- The callback will come directly from the component that detected the -- event, unless some other layer intercepts the calls for its own -- purposes (filter them in a different way, log to a system error log, -- etc.). -- -- An application can receive multiple callbacks if multiple -- VkDebugUtilsMessengerEXT objects are created. A callback will -- always be executed in the same thread as the originating Vulkan call. -- -- A callback can be called from multiple threads simultaneously -- (if the application is making Vulkan calls from multiple threads). -- --

Valid Usage

-- --

pfnUserCallback must be a valid -- PFN_vkDebugUtilsMessengerCallbackEXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT

-- --

flags must be 0
messageSeverity must be a valid combination of -- VkDebugUtilsMessageSeverityFlagBitsEXT values
messageSeverity must not be 0
messageType must be a valid combination of -- VkDebugUtilsMessageTypeFlagBitsEXT values
messageType must not be 0

-- --

Description

-- -- Note -- -- This structure should only be considered valid during the lifetime of -- the triggered callback. -- -- Since adding queue and command buffer labels behaves like pushing and -- popping onto a stack, the order of both pQueueLabels and -- pCmdBufLabels is based on the order the labels were defined. -- The result is that the first label in either pQueueLabels or -- pCmdBufLabels will be the first defined (and therefore the -- oldest) while the last label in each list will be the most recent. -- -- Note -- -- pQueueLabels will only be non-NULL if one of the objects in -- pObjects can be related directly to a defined -- VkQueue which has had one or more labels associated with it. -- -- Likewise, pCmdBufLabels will only be non-NULL if one of the -- objects in pObjects can be related directly to a defined -- VkCommandBuffer which has had one or more labels associated -- with it. Additionally, while command buffer labels allow for beginning -- and ending across different command buffers, the debug messaging -- framework cannot guarantee that labels in -- pCmdBufLables will contain those defined outside of the -- associated command buffer. This is partially due to the fact that the -- association of one command buffer with another may not have been -- defined at the time the debug message is triggered. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT

-- --

pNext must be NULL
flags must be 0
If pMessageIdName is not NULL, -- pMessageIdName must be a null-terminated UTF-8 -- string
pMessage must be a null-terminated UTF-8 -- string
objectCount must be greater than 0

-- --

Parameters

-- --

device is the device that created the object.

-- --

pNameInfo is a pointer to an instance of the -- VkDebugMarkerObjectNameInfoEXT structure specifying the -- parameters of the name to set on the object.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pNameInfo must be a valid pointer to a valid -- VkDebugMarkerObjectNameInfoEXT structure

-- --

Host Synchronization

-- --

Host access to pNameInfo.object must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the device that created the object.

-- --

pTagInfo is a pointer to an instance of the -- VkDebugMarkerObjectTagInfoEXT structure specifying the -- parameters of the tag to attach to the object.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pTagInfo must be a valid pointer to a valid -- VkDebugMarkerObjectTagInfoEXT structure

-- --

Host Synchronization

-- --

Host access to pTagInfo.object must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

pMarkerInfo is a pointer to an instance of the -- VkDebugMarkerMarkerInfoEXT structure specifying the parameters -- of the marker region to open.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pMarkerInfo must be a valid pointer to a valid -- VkDebugMarkerMarkerInfoEXT structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

Description

-- -- An application may open a marker region in one command buffer -- and close it in another, or otherwise split marker regions across -- multiple command buffers or multiple queue submissions. When viewed -- from the linear series of submissions to a single queue, the calls to -- vkCmdDebugMarkerBeginEXT and vkCmdDebugMarkerEndEXT -- must be matched and balanced. -- --

Valid Usage

-- --

There must be an outstanding -- vkCmdDebugMarkerBeginEXT command prior to the -- vkCmdDebugMarkerEndEXT on the queue that -- commandBuffer is submitted to

-- --

If commandBuffer is a secondary command buffer, there -- must be an outstanding vkCmdDebugMarkerBeginEXT command -- recorded to commandBuffer that has not previously been ended -- by a call to vkCmdDebugMarkerEndEXT.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

pMarkerInfo is a pointer to an instance of the -- VkDebugMarkerMarkerInfoEXT structure specifying the parameters -- of the marker to insert.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pMarkerInfo must be a valid pointer to a valid -- VkDebugMarkerMarkerInfoEXT structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Description

-- -- Applications may change the name associated with an object -- simply by calling vkDebugMarkerSetObjectNameEXT again with a -- new string. To remove a previously set name, pObjectName -- should be set to an empty string. -- --

Valid Usage

-- --

objectType must not be -- VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT

-- --

object must not be VK_NULL_HANDLE
object must be a Vulkan object of the type -- associated with objectType as defined in -- {html_spec_relative}#debug-report-object-types.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT

-- --

pNext must be NULL
objectType must be a valid -- VkDebugReportObjectTypeEXT value
pObjectName must be a null-terminated UTF-8 -- string

-- --

Description

Valid Usage

-- --

objectType must not be -- VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT

-- --

object must not be VK_NULL_HANDLE
object must be a Vulkan object of the type -- associated with objectType as defined in -- {html_spec_relative}#debug-report-object-types.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT

-- --

pNext must be NULL
objectType must be a valid -- VkDebugReportObjectTypeEXT value
pTag must be a valid pointer to an array of -- tagSize bytes
tagSize must be greater than 0

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT

-- --

pNext must be NULL
pMarkerName must be a null-terminated UTF-8 -- string

-- --

Description

-- -- VkSemaphoreCreateFlags is a bitmask type for setting a mask, -- but is currently reserved for future use. -- --

Parameters

-- --

device is the logical device that creates the -- semaphore.

-- --

pCreateInfo is a pointer to an instance of the -- VkSemaphoreCreateInfo structure which contains information -- about how the semaphore is to be created.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pSemaphore points to a handle in which the resulting -- semaphore object is returned.

-- --

Description

-- -- When created, the semaphore is in the unsignaled state. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkSemaphoreCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pSemaphore must be a valid pointer to a -- VkSemaphore handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- semaphore.

-- --

semaphore is the handle of the semaphore to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted batches that refer to semaphore must -- have completed execution

-- --

If VkAllocationCallbacks were provided when -- semaphore was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- semaphore was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If semaphore is not VK_NULL_HANDLE, -- semaphore must be a valid VkSemaphore -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If semaphore is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to semaphore must be externally -- synchronized

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO

-- --

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 VkExportSemaphoreCreateInfo or -- VkExportSemaphoreWin32HandleInfoKHR
Each sType member in the pNext chain must -- be unique
flags must be 0

-- --

Description

-- -- VkQueryPoolCreateFlags is a bitmask type for setting a mask, -- but is currently reserved for future use. -- --

Description

-- --

VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT -- specifies that queries managed by the pool will count the number of -- vertices processed by the input assembly stage. Vertices -- corresponding to incomplete primitives may contribute to the -- count.

-- --

VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT -- specifies that queries managed by the pool will count the number of -- primitives processed by the input assembly stage. If primitive -- restart is enabled, restarting the primitive topology has no effect on -- the count. Incomplete primitives may be counted.
VK_QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- vertex shader invocations. This counter’s value is incremented each -- time a vertex shader is invoked.
VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- geometry shader invocations. This counter’s value is incremented each -- time a geometry shader is invoked. In the case of instanced -- geometry shaders, the geometry shader invocations count is -- incremented for each separate instanced invocation.
VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT -- specifies that queries managed by the pool will count the number of -- primitives generated by geometry shader invocations. The counter’s -- value is incremented each time the geometry shader emits a primitive. -- Restarting primitive topology using the SPIR-V instructions -- OpEndPrimitive or OpEndStreamPrimitive has no effect -- on the geometry shader output primitives count.
VK_QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- primitives processed by the Primitive Clipping stage of the -- pipeline. The counter’s value is incremented each time a primitive -- reaches the primitive clipping stage.
VK_QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT -- specifies that queries managed by the pool will count the number of -- primitives output by the Primitive Clipping stage of the -- pipeline. The counter’s value is incremented each time a primitive -- passes the primitive clipping stage. The actual number of primitives -- output by the primitive clipping stage for a particular input -- primitive is implementation-dependent but must satisfy the -- following conditions:
- If at least one vertex of the input -- primitive lies inside the clipping volume, the counter is incremented -- by one or more.
- Otherwise, the counter is incremented by zero -- or more.
VK_QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- fragment shader invocations. The counter’s value is incremented each -- time the fragment shader is invoked.
VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT -- specifies that queries managed by the pool will count the number of -- patches processed by the tessellation control shader. The counter’s -- value is incremented once for each patch for which a tessellation -- control shader is invoked.
VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- invocations of the tessellation evaluation shader. The counter’s value -- is incremented each time the tessellation evaluation shader is -- invoked.
VK_QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT -- specifies that queries managed by the pool will count the number of -- compute shader invocations. The counter’s value is incremented every -- time the compute shader is invoked. Implementations may skip -- the execution of certain compute shader invocations or execute -- additional compute shader invocations for implementation-dependent -- reasons as long as the results of rendering otherwise remain -- unchanged.

-- -- These values are intended to measure relative statistics on one -- implementation. Various device architectures will count these values -- differently. Any or all counters may be affected by the issues -- described in Query Operation. -- -- Note -- -- For example, tile-based rendering devices may need to replay -- the scene multiple times, affecting some of the counts. -- -- If a pipeline has rasterizerDiscardEnable enabled, -- implementations may discard primitives after the final vertex -- processing stage. As a result, if rasterizerDiscardEnable is -- enabled, the clipping input and output primitives counters may -- not be incremented. -- -- When a pipeline statistics query finishes, the result for that query -- is marked as available. The application can copy the result to -- a buffer (via vkCmdCopyQueryPoolResults), or request it be -- put into host memory (via vkGetQueryPoolResults). -- --

Description

-- --

Parameters

-- --

device is the logical device that creates the query -- pool.

-- --

pCreateInfo is a pointer to an instance of the -- VkQueryPoolCreateInfo structure containing the number and -- type of queries to be managed by the pool.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pQueryPool is a pointer to a VkQueryPool handle -- in which the resulting query pool object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkQueryPoolCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pQueryPool must be a valid pointer to a -- VkQueryPool handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the query -- pool.

-- --

queryPool is the query pool to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to queryPool -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- queryPool was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- queryPool was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If queryPool is not VK_NULL_HANDLE, -- queryPool must be a valid VkQueryPool -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If queryPool is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to queryPool must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the query -- pool.

-- --

queryPool is the query pool managing the queries -- containing the desired results.
firstQuery is the initial query index.
queryCount is the number of queries. firstQuery -- and queryCount together define a range of queries. For -- pipeline statistics queries, each query index in the pool contains one -- integer value for each bit that is enabled in -- VkQueryPoolCreateInfo::pipelineStatistics when the -- pool is created.
dataSize is the size in bytes of the buffer pointed to by -- pData.
pData is a pointer to a user-allocated buffer where the -- results will be written
stride is the stride in bytes between results for -- individual queries within pData.
flags is a bitmask of VkQueryResultFlagBits -- specifying how and when results are returned.

-- --

Description

-- -- If no bits are set in flags, and all requested queries are in -- the available state, results are written as an array of 32-bit -- unsigned integer values. The behavior when not all queries are -- available, is described below. -- -- If VK_QUERY_RESULT_64_BIT is not set and the result overflows -- a 32-bit value, the value may either wrap or saturate. -- Similarly, if VK_QUERY_RESULT_64_BIT is set and the result -- overflows a 64-bit value, the value may either wrap or -- saturate. -- -- If VK_QUERY_RESULT_WAIT_BIT is set, Vulkan will wait for each -- query to be in the available state before retrieving the numerical -- results for that query. In this case, vkGetQueryPoolResults -- is guaranteed to succeed and return VK_SUCCESS if the queries -- become available in a finite time (i.e. if they have been issued and -- not reset). If queries will never finish (e.g. due to being reset but -- not issued), then vkGetQueryPoolResults may not return -- in finite time. -- -- If VK_QUERY_RESULT_WAIT_BIT and -- VK_QUERY_RESULT_PARTIAL_BIT are both not set then no result -- values are written to pData for queries that are in the -- unavailable state at the time of the call, and -- vkGetQueryPoolResults returns VK_NOT_READY. However, -- availability state is still written to pData for those -- queries if VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is set. -- -- Note -- -- Applications must take care to ensure that use of the -- VK_QUERY_RESULT_WAIT_BIT bit has the desired effect. -- -- For example, if a query has been used previously and a command buffer -- records the commands vkCmdResetQueryPool, -- vkCmdBeginQuery, and vkCmdEndQuery for that query, -- then the query will remain in the available state until the -- vkCmdResetQueryPool command executes on a queue. Applications -- can use fences or events to ensure that a query has already -- been reset before checking for its results or availability status. -- Otherwise, a stale value could be returned from a previous use of the -- query. -- -- The above also applies when VK_QUERY_RESULT_WAIT_BIT is used -- in combination with VK_QUERY_RESULT_WITH_AVAILABILITY_BIT. In -- this case, the returned availability status may reflect the -- result of a previous use of the query unless the -- vkCmdResetQueryPool command has been executed since the last -- use of the query. -- -- Note -- -- Applications can double-buffer query pool usage, with a pool -- per frame, and reset queries at the end of the frame in which they are -- read. -- -- If VK_QUERY_RESULT_PARTIAL_BIT is set, -- VK_QUERY_RESULT_WAIT_BIT is not set, and the query’s status -- is unavailable, an intermediate result value between zero and the -- final result value is written to pData for that query. -- -- VK_QUERY_RESULT_PARTIAL_BIT must not be used if the -- pool’s queryType is VK_QUERY_TYPE_TIMESTAMP. -- -- If VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is set, the final -- integer value written for each query is non-zero if the query’s status -- was available or zero if the status was unavailable. When -- VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is used, -- implementations must guarantee that if they return a non-zero -- availability value then the numerical results must be valid, -- assuming the results are not reset by a subsequent command. -- -- Note -- -- Satisfying this guarantee may require careful ordering by the -- application, e.g. to read the availability status before reading the -- results. -- --

Valid Usage

-- --

firstQuery must be less than the number of queries -- in queryPool

-- --

If VK_QUERY_RESULT_64_BIT is not set in flags -- then pData and stride must be multiples of -- 4
If VK_QUERY_RESULT_64_BIT is set in flags then -- pData and stride must be multiples of -- 8
The sum of firstQuery and queryCount must -- be less than or equal to the number of queries in -- queryPool
dataSize must be large enough to contain the -- result of each query, as described here
If the queryType used to create queryPool was -- VK_QUERY_TYPE_TIMESTAMP, flags must not -- contain VK_QUERY_RESULT_PARTIAL_BIT

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

queryPool must be a valid VkQueryPool -- handle
pData must be a valid pointer to an array of -- dataSize bytes
flags must be a valid combination of -- VkQueryResultFlagBits values
dataSize must be greater than 0
queryPool must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_NOT_READY
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Description

-- -- pipelineStatistics is ignored if queryType is not -- VK_QUERY_TYPE_PIPELINE_STATISTICS. -- --

Valid Usage

-- --

If the pipeline statistics queries feature is not enabled, -- queryType must not be -- VK_QUERY_TYPE_PIPELINE_STATISTICS

-- --

If queryType is -- VK_QUERY_TYPE_PIPELINE_STATISTICS, -- pipelineStatistics must be a valid combination of -- VkQueryPipelineStatisticFlagBits values

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
queryType must be a valid VkQueryType -- value

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the pipeline -- cache object.

-- --

pipelineCache is the handle of the pipeline cache to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- pipelineCache was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- pipelineCache was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If pipelineCache is not VK_NULL_HANDLE, -- pipelineCache must be a valid VkPipelineCache -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If pipelineCache is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to pipelineCache must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the pipeline -- cache.

-- --

pipelineCache is the pipeline cache to retrieve data -- from.
pDataSize is a pointer to a value related to the amount -- of data in the pipeline cache, as described below.
pData is either NULL or a pointer to a -- buffer.

-- --

Description

-- -- If pData is NULL, then the maximum size of the data -- that can be retrieved from the pipeline cache, in bytes, is -- returned in pDataSize. Otherwise, pDataSize -- must point to a variable set by the user to the size of the -- buffer, in bytes, pointed to by pData, and on return the -- variable is overwritten with the amount of data actually written to -- pData. -- -- If pDataSize is less than the maximum size that can be -- retrieved by the pipeline cache, at most pDataSize bytes will -- be written to pData, and vkGetPipelineCacheData will -- return VK_INCOMPLETE. Any data written to pData is -- valid and can be provided as the pInitialData member -- of the VkPipelineCacheCreateInfo structure passed to -- vkCreatePipelineCache. -- -- Two calls to vkGetPipelineCacheData with the same parameters -- must retrieve the same data unless a command that modifies the -- contents of the cache is called between them. -- -- Applications can store the data retrieved from the pipeline -- cache, and use these data, possibly in a future run of the -- application, to populate new pipeline cache objects. The results of -- pipeline compiles, however, may depend on the vendor ID, device -- ID, driver version, and other details of the device. To enable -- applications to detect when previously retrieved data is incompatible -- with the device, the initial bytes written to pData -- must be a header consisting of the following members: -- --

--   +----+--------------+--------------------------------------------------+
--   | Of | Size         | Meaning                                          |
--   | fs |              |                                                  |
--   | et |              |                                                  |
--   +====+==============+==================================================+
--   | 0  | 4            | length in bytes of the entire pipeline cache     |
--   |    |              | header written as a stream of bytes, with the    |
--   |    |              | least significant byte first                     |
--   +----+--------------+--------------------------------------------------+
--   | 4  | 4            | a                                                |
--   |    |              | 'Graphics.Vulkan.Core10.Constants.VkPipelineCach |
--   |    |              | eHeaderVersion'                                  |
--   |    |              | value written as a stream of bytes, with the     |
--   |    |              | least significant byte first                     |
--   +----+--------------+--------------------------------------------------+
--   | 8  | 4            | a vendor ID equal to                             |
--   |    |              | @VkPhysicalDeviceProperties@::@vendorID@ written |
--   |    |              | as a stream of bytes, with the least significant |
--   |    |              | byte first                                       |
--   +----+--------------+--------------------------------------------------+
--   | 12 | 4            | a device ID equal to                             |
--   |    |              | @VkPhysicalDeviceProperties@::@deviceID@ written |
--   |    |              | as a stream of bytes, with the least significant |
--   |    |              | byte first                                       |
--   +----+--------------+--------------------------------------------------+
--   | 16 | @VK_UUID_SIZ | a pipeline cache ID equal to                     |
--   |    | E@           | @VkPhysicalDeviceProperties@::@pipelineCacheUUID |
--   |    |              | @                                                |
--   +----+--------------+--------------------------------------------------+
--   
--   Layout for pipeline cache header version
--   @VK_PIPELINE_CACHE_HEADER_VERSION_ONE@
--

-- -- The first four bytes encode the length of the entire pipeline cache -- header, in bytes. This value includes all fields in the header -- including the pipeline cache version field and the size of the length -- field. -- -- The next four bytes encode the pipeline cache version, as described -- for VkPipelineCacheHeaderVersion. A consumer of the pipeline -- cache should use the cache version to interpret the remainder -- of the cache header. -- -- If pDataSize is less than what is necessary to store this -- header, nothing will be written to pData and zero will be -- written to pDataSize. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pipelineCache must be a valid -- VkPipelineCache handle
pDataSize must be a valid pointer to a -- size_t value
If the value referenced by pDataSize is not 0, -- and pData is not NULL, pData must be -- a valid pointer to an array of pDataSize bytes
pipelineCache must have been created, allocated, -- or retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the pipeline cache -- objects.

-- --

dstCache is the handle of the pipeline cache to merge -- results into.
srcCacheCount is the length of the pSrcCaches -- array.
pSrcCaches is an array of pipeline cache handles, which -- will be merged into dstCache. The previous contents of -- dstCache are included after the merge.

-- --

Description

-- -- Note -- -- The details of the merge operation are implementation dependent, but -- implementations should merge the contents of the specified -- pipelines and prune duplicate entries. -- --

Valid Usage

-- --

dstCache must not appear in the list of source -- caches

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

dstCache must be a valid VkPipelineCache -- handle
pSrcCaches must be a valid pointer to an array of -- srcCacheCount valid VkPipelineCache handles
srcCacheCount must be greater than 0
dstCache must have been created, allocated, or -- retrieved from device
Each element of pSrcCaches must have been created, -- allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to dstCache must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage

-- --

If initialDataSize is not 0, it must be -- equal to the size of pInitialData, as returned by -- vkGetPipelineCacheData when pInitialData was -- originally retrieved

-- --

If initialDataSize is not 0, -- pInitialData must have been retrieved from a previous -- call to vkGetPipelineCacheData

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
If initialDataSize is not 0, -- pInitialData must be a valid pointer to an array of -- initialDataSize bytes

-- --

Description

-- -- The semantics of each enum value is described in the table below: -- --

--   +-----------------------------------------+-------------------+--------+
--   | VkBlendFactor                           | RGB Blend Factors | Alpha  |
--   |                                         | (Sr,Sg,Sb) or     | Blend  |
--   |                                         | (Dr,Dg,Db)        | Factor |
--   |                                         |                   | (Sa or |
--   |                                         |                   | Da)    |
--   +=========================================+===================+========+
--   | @VK_BLEND_FACTOR_ZERO@                  | (0,0,0)           | 0      |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE@                   | (1,1,1)           | 1      |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_SRC_COLOR@             | (Rs0,Gs0,Bs0)     | As0    |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_SRC_COLOR@   | (1-Rs0,1-Gs0,1-Bs | 1-As0  |
--   |                                         | 0)                |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_DST_COLOR@             | (Rd,Gd,Bd)        | Ad     |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_DST_COLOR@   | (1-Rd,1-Gd,1-Bd)  | 1-Ad   |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_SRC_ALPHA@             | (As0,As0,As0)     | As0    |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA@   | (1-As0,1-As0,1-As | 1-As0  |
--   |                                         | 0)                |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_DST_ALPHA@             | (Ad,Ad,Ad)        | Ad     |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_DST_ALPHA@   | (1-Ad,1-Ad,1-Ad)  | 1-Ad   |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_CONSTANT_COLOR@        | (Rc,Gc,Bc)        | Ac     |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_COL | (1-Rc,1-Gc,1-Bc)  | 1-Ac   |
--   | OR@                                     |                   |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_CONSTANT_ALPHA@        | (Ac,Ac,Ac)        | Ac     |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALP | (1-Ac,1-Ac,1-Ac)  | 1-Ac   |
--   | HA@                                     |                   |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_SRC_ALPHA_SATURATE@    | (f,f,f); f =      | 1      |
--   |                                         | min(As0,1-Ad)     |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_SRC1_COLOR@            | (Rs1,Gs1,Bs1)     | As1    |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR@  | (1-Rs1,1-Gs1,1-Bs | 1-As1  |
--   |                                         | 1)                |        |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_SRC1_ALPHA@            | (As1,As1,As1)     | As1    |
--   +-----------------------------------------+-------------------+--------+
--   | @VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA@  | (1-As1,1-As1,1-As | 1-As1  |
--   |                                         | 1)                |        |
--   +-----------------------------------------+-------------------+--------+
--   
--   Blend Factors
--

-- -- In this table, the following conventions are used: -- --

Rs0,Gs0,Bs0 and As0 represent the first source color R, G, B, and -- A components, respectively, for the fragment output location -- corresponding to the color attachment being blended.
Rs1,Gs1,Bs1 and As1 represent the second source color R, G, B, and -- A components, respectively, used in dual source blending modes, for -- the fragment output location corresponding to the color attachment -- being blended.
Rd,Gd,Bd and Ad represent the R, G, B, and A components of the -- destination color. That is, the color currently in the corresponding -- color attachment for this fragment/sample.
Rc,Gc,Bc and Ac represent the blend constant R, G, B, and A -- components, respectively.

-- --

Description

-- -- The semantics of each basic blend operations is described in the table -- below: -- --

--   +-------------------------------+--------------------+----------------+
--   | VkBlendOp                     | RGB Components     | Alpha          |
--   |                               |                    | Component      |
--   +===============================+====================+================+
--   | @VK_BLEND_OP_ADD@             | R = Rs0 × Sr + Rd  | A = As0 × Sa + |
--   |                               | × Dr               | Ad × Da        |
--   |                               | G = Gs0 × Sg + Gd  |                |
--   |                               | × Dg               |                |
--   |                               | B = Bs0 × Sb + Bd  |                |
--   |                               | × Db               |                |
--   +-------------------------------+--------------------+----------------+
--   | @VK_BLEND_OP_SUBTRACT@        | R = Rs0 × Sr - Rd  | A = As0 × Sa - |
--   |                               | × Dr               | Ad × Da        |
--   |                               | G = Gs0 × Sg - Gd  |                |
--   |                               | × Dg               |                |
--   |                               | B = Bs0 × Sb - Bd  |                |
--   |                               | × Db               |                |
--   +-------------------------------+--------------------+----------------+
--   | @VK_BLEND_OP_REVERSE_SUBTRACT | R = Rd × Dr - Rs0  | A = Ad × Da -  |
--   | @                             | × Sr               | As0 × Sa       |
--   |                               | G = Gd × Dg - Gs0  |                |
--   |                               | × Sg               |                |
--   |                               | B = Bd × Db - Bs0  |                |
--   |                               | × Sb               |                |
--   +-------------------------------+--------------------+----------------+
--   | @VK_BLEND_OP_MIN@             | R = min(Rs0,Rd)    | A =            |
--   |                               | G = min(Gs0,Gd)    | min(As0,Ad)    |
--   |                               | B = min(Bs0,Bd)    |                |
--   +-------------------------------+--------------------+----------------+
--   | @VK_BLEND_OP_MAX@             | R = max(Rs0,Rd)    | A =            |
--   |                               | G = max(Gs0,Gd)    | max(As0,Ad)    |
--   |                               | B = max(Bs0,Bd)    |                |
--   +-------------------------------+--------------------+----------------+
--   
--   Basic Blend Operations
--

-- -- In this table, the following conventions are used: -- --

Rs0, Gs0, Bs0 and As0 represent the first source color R, G, B, -- and A components, respectively.
Rd, Gd, Bd and Ad represent the R, G, B, and A components of the -- destination color. That is, the color currently in the corresponding -- color attachment for this fragment/sample.
Sr, Sg, Sb and Sa represent the source blend factor R, G, B, and A -- components, respectively.
Dr, Dg, Db and Da represent the destination blend factor R, G, B, -- and A components, respectively.

-- -- The blending operation produces a new set of values R, G, B and A, -- which are written to the framebuffer attachment. If blending is not -- enabled for this attachment, then R, G, B and A are assigned Rs0, Gs0, -- Bs0 and As0, respectively. -- -- If the color attachment is fixed-point, the components of the source -- and destination values and blend factors are each clamped to [0,1] or -- [-1,1] respectively for an unsigned normalized or signed normalized -- color attachment prior to evaluating the blend operations. If the -- color attachment is floating-point, no clamping occurs. -- --

Description

-- --

VK_POLYGON_MODE_POINT specifies that polygon vertices are -- drawn as points.

-- --

VK_POLYGON_MODE_LINE specifies that polygon edges are -- drawn as line segments.
VK_POLYGON_MODE_FILL specifies that polygons are rendered -- using the polygon rasterization rules in this section.
VK_POLYGON_MODE_FILL_RECTANGLE_NV specifies that polygons -- are rendered using polygon rasterization rules, modified to consider a -- sample within the primitive if the sample location is inside the -- axis-aligned bounding box of the triangle after projection. Note that -- the barycentric weights used in attribute interpolation can -- extend outside the range [0,1] when these primitives are shaded. -- Special treatment is given to a sample position on the boundary edge -- of the bounding box. In such a case, if two rectangles lie on either -- side of a common edge (with identical endpoints) on which a sample -- position lies, then exactly one of the triangles must produce a -- fragment that covers that sample during rasterization.Polygons -- rendered in VK_POLYGON_MODE_FILL_RECTANGLE_NV mode may -- be clipped by the frustum or by user clip planes. If clipping is -- applied, the triangle is culled rather than clipped.Area calculation -- and facingness are determined for -- VK_POLYGON_MODE_FILL_RECTANGLE_NV mode using the triangle’s -- vertices.

-- -- These modes affect only the final rasterization of polygons: in -- particular, a polygon’s vertices are shaded and the polygon is clipped -- and possibly culled before these modes are applied. -- --

Description

-- --

VK_FRONT_FACE_COUNTER_CLOCKWISE specifies that a triangle -- with positive area is considered front-facing.

-- --

VK_FRONT_FACE_CLOCKWISE specifies that a triangle with -- negative area is considered front-facing.

-- -- Any triangle which is not front-facing is back-facing, including -- zero-area triangles. -- --

Description

-- -- The logical operations supported by Vulkan are summarized in the -- following table in which -- --

¬ is bitwise invert,
∧ is bitwise and,
∨ is bitwise or,
⊕ is bitwise exclusive or,
s is the fragment’s Rs0, Gs0, Bs0 or As0 component value for the -- fragment output corresponding to the color attachment being updated, -- and
d is the color attachment’s R, G, B or A component value:

-- --

--   +-----------------------------------+-----------------------------------+
--   | Mode                              | Operation                         |
--   +===================================+===================================+
--   | @VK_LOGIC_OP_CLEAR@               | 0                                 |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_AND@                 | s ∧ d                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_AND_REVERSE@         | s ∧ ¬ d                           |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_COPY@                | s                                 |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_AND_INVERTED@        | ¬ s ∧ d                           |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_NO_OP@               | d                                 |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_XOR@                 | s ⊕ d                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_OR@                  | s ∨ d                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_NOR@                 | ¬ (s ∨ d)                         |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_EQUIVALENT@          | ¬ (s ⊕ d)                         |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_INVERT@              | ¬ d                               |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_OR_REVERSE@          | s ∨ ¬ d                           |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_COPY_INVERTED@       | ¬ s                               |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_OR_INVERTED@         | ¬ s ∨ d                           |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_NAND@                | ¬ (s ∧ d)                         |
--   +-----------------------------------+-----------------------------------+
--   | @VK_LOGIC_OP_SET@                 | all 1s                            |
--   +-----------------------------------+-----------------------------------+
--   
--   Logical Operations
--

-- -- The result of the logical operation is then written to the color -- attachment as controlled by the component write mask, described in -- Blend Operations. -- --

Description

-- --

Description

-- --

VK_STENCIL_OP_KEEP keeps the current value.

-- --

VK_STENCIL_OP_ZERO sets the value to 0.
VK_STENCIL_OP_REPLACE sets the value to -- reference.
VK_STENCIL_OP_INCREMENT_AND_CLAMP increments the current -- value and clamps to the maximum representable unsigned value.
VK_STENCIL_OP_DECREMENT_AND_CLAMP decrements the current -- value and clamps to 0.
VK_STENCIL_OP_INVERT bitwise-inverts the current -- value.
VK_STENCIL_OP_INCREMENT_AND_WRAP increments the current -- value and wraps to 0 when the maximum value would have been -- exceeded.
VK_STENCIL_OP_DECREMENT_AND_WRAP decrements the current -- value and wraps to the maximum possible value when the value would go -- below 0.

-- --

VK_COLOR_COMPONENT_R_BIT specifies that the R value is -- written to the color attachment for the appropriate sample. Otherwise, -- the value in memory is unmodified.

-- --

VK_COLOR_COMPONENT_G_BIT specifies that the G value is -- written to the color attachment for the appropriate sample. Otherwise, -- the value in memory is unmodified.
VK_COLOR_COMPONENT_B_BIT specifies that the B value is -- written to the color attachment for the appropriate sample. Otherwise, -- the value in memory is unmodified.
VK_COLOR_COMPONENT_A_BIT specifies that the A value is -- written to the color attachment for the appropriate sample. Otherwise, -- the value in memory is unmodified.

-- -- The color write mask operation is applied regardless of whether -- blending is enabled. -- --

Description

-- --

VK_CULL_MODE_NONE specifies that no triangles are -- discarded

-- --

VK_CULL_MODE_FRONT_BIT specifies that front-facing -- triangles are discarded
VK_CULL_MODE_BACK_BIT specifies that back-facing -- triangles are discarded
VK_CULL_MODE_FRONT_AND_BACK specifies that all triangles -- are discarded.

-- -- Following culling, fragments are produced for any triangles which have -- not been discarded. -- --

Description

-- --

device must be a valid VkDevice -- handle

-- --

If pipelineCache is not VK_NULL_HANDLE, -- pipelineCache must be a valid VkPipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid -- VkGraphicsPipelineCreateInfo structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pPipelines must be a valid pointer to an array of -- createInfoCount VkPipeline handles
createInfoCount must be greater than -- 0
If pipelineCache is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INVALID_SHADER_NV
```

-- --

Parameters

-- --

device is the logical device that creates the compute -- pipelines.

-- --

pipelineCache is either VK_NULL_HANDLE, indicating -- that pipeline caching is disabled; or the handle of a valid -- pipeline cache object, in which case use of that cache is -- enabled for the duration of the command.
createInfoCount is the length of the -- pCreateInfos and pPipelines arrays.
pCreateInfos is an array of -- VkComputePipelineCreateInfo structures.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelines is a pointer to an array in which the -- resulting compute pipeline objects are returned.

-- --

Description

-- --

Valid Usage

-- --

If the flags member of any element of -- pCreateInfos contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and the -- basePipelineIndex member of that same element is not -- -1, basePipelineIndex must be less than the -- index into pCreateInfos that corresponds to that element

-- --

If the flags member of any element of -- pCreateInfos contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline -- must have been created with the -- VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If pipelineCache is not VK_NULL_HANDLE, -- pipelineCache must be a valid VkPipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid VkComputePipelineCreateInfo -- structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pPipelines must be a valid pointer to an array of -- createInfoCount VkPipeline handles
createInfoCount must be greater than -- 0
If pipelineCache is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INVALID_SHADER_NV
```

-- --

Parameters

-- --

device is the logical device that destroys the -- pipeline.

-- --

pipeline is the handle of the pipeline to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to pipeline must -- have completed execution

-- --

If VkAllocationCallbacks were provided when -- pipeline was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- pipeline was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If pipeline is not VK_NULL_HANDLE, -- pipeline must be a valid VkPipeline -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If pipeline is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to pipeline must be externally -- synchronized

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
stage must be a valid VkShaderStageFlagBits -- value
module must be a valid VkShaderModule -- handle
pName must be a null-terminated UTF-8 string
If pSpecializationInfo is not NULL, -- pSpecializationInfo must be a valid pointer to a valid -- VkSpecializationInfo structure

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- -- stage points to a structure of type -- VkPipelineShaderStageCreateInfo. -- --

Valid Usage

-- --

If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is -1, basePipelineHandle -- must be a valid handle to a compute VkPipeline

-- --

If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is VK_NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, basePipelineHandle -- must be VK_NULL_HANDLE
If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not VK_NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of stage must be -- VK_SHADER_STAGE_COMPUTE_BIT
The shader code for the entry point identified by stage -- and the rest of the state identified by this structure must -- adhere to the pipeline linking rules described in the Shader -- Interfaces chapter
layout must be consistent with the layout -- of the compute shader specified in stage
The number of resources in layout accessible to the -- compute shader stage must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageResources

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO

-- --

pNext must be NULL
flags must be a valid combination of -- VkPipelineCreateFlagBits values
stage must be a valid -- VkPipelineShaderStageCreateInfo structure
layout must be a valid VkPipelineLayout -- handle
Both of basePipelineHandle, and layout that are -- valid handles must have been created, allocated, or retrieved -- from the same VkDevice

-- --

Description

-- --

Valid Usage

-- --

binding must be less than -- VkPhysicalDeviceLimits::maxVertexInputBindings

-- --

stride must be less than or equal to -- VkPhysicalDeviceLimits::maxVertexInputBindingStride

-- --

Valid Usage (Implicit)

-- --

inputRate must be a valid VkVertexInputRate -- value

-- --

Description

-- --

Valid Usage

-- --

location must be less than -- VkPhysicalDeviceLimits::maxVertexInputAttributes

-- --

binding must be less than -- VkPhysicalDeviceLimits::maxVertexInputBindings
offset must be less than or equal to -- VkPhysicalDeviceLimits::maxVertexInputAttributeOffset
format must be allowed as a vertex buffer format, -- as specified by the VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT flag -- in VkFormatProperties::bufferFeatures returned by -- vkGetPhysicalDeviceFormatProperties

-- --

Valid Usage (Implicit)

-- --

format must be a valid VkFormat value

-- --

Description

-- --

Valid Usage

-- --

vertexBindingDescriptionCount must be less than or -- equal to -- VkPhysicalDeviceLimits::maxVertexInputBindings

-- --

vertexAttributeDescriptionCount must be less than -- or equal to -- VkPhysicalDeviceLimits::maxVertexInputAttributes
For every binding specified by each element of -- pVertexAttributeDescriptions, a -- VkVertexInputBindingDescription must exist in -- pVertexBindingDescriptions with the same value of -- binding
All elements of pVertexBindingDescriptions must -- describe distinct binding numbers
All elements of pVertexAttributeDescriptions must -- describe distinct attribute locations

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkPipelineVertexInputDivisorStateCreateInfoEXT
flags must be 0
If vertexBindingDescriptionCount is not 0, -- pVertexBindingDescriptions must be a valid pointer to -- an array of vertexBindingDescriptionCount valid -- VkVertexInputBindingDescription structures
If vertexAttributeDescriptionCount is not 0, -- pVertexAttributeDescriptions must be a valid pointer -- to an array of vertexAttributeDescriptionCount valid -- VkVertexInputAttributeDescription structures

-- --

Description

-- -- Restarting the assembly of primitives discards the most recent index -- values if those elements formed an incomplete primitive, and restarts -- the primitive assembly using the subsequent indices, but only -- assembling the immediately following element through the end of the -- originally specified elements. The primitive restart index value -- comparison is performed before adding the vertexOffset value -- to the index value. -- --

Valid Usage

-- --

If topology is VK_PRIMITIVE_TOPOLOGY_POINT_LIST, -- VK_PRIMITIVE_TOPOLOGY_LINE_LIST, -- VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, -- VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, -- VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY or -- VK_PRIMITIVE_TOPOLOGY_PATCH_LIST, -- primitiveRestartEnable must be VK_FALSE

-- --

If the geometry shaders feature is not enabled, -- topology must not be any of -- VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, -- VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY, -- VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY or -- VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY
If the tessellation shaders feature is not enabled, -- topology must not be -- VK_PRIMITIVE_TOPOLOGY_PATCH_LIST

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
topology must be a valid -- VkPrimitiveTopology value

-- --

Description

-- --

Valid Usage

-- --

patchControlPoints must be greater than zero and -- less than or equal to -- VkPhysicalDeviceLimits::maxTessellationPatchSize

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkPipelineTessellationDomainOriginStateCreateInfo
flags must be 0

-- --

Description

-- --

Valid Usage

-- --

If the multiple viewports feature is not enabled, -- viewportCount must be 1

-- --

If the multiple viewports feature is not enabled, -- scissorCount must be 1
viewportCount must be between 1 and -- VkPhysicalDeviceLimits::maxViewports, inclusive
scissorCount must be between 1 and -- VkPhysicalDeviceLimits::maxViewports, inclusive
scissorCount and viewportCount must be -- identical
If the viewportWScalingEnable member of a -- VkPipelineViewportWScalingStateCreateInfoNV structure chained -- to the pNext chain is VK_TRUE, the -- viewportCount member of the -- VkPipelineViewportWScalingStateCreateInfoNV structure -- must be equal to viewportCount

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO

-- --

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 -- VkPipelineViewportSwizzleStateCreateInfoNV or -- VkPipelineViewportWScalingStateCreateInfoNV
Each sType member in the pNext chain must -- be unique
flags must be 0
viewportCount must be greater than 0
scissorCount must be greater than 0

-- --

Description

-- -- The application can also add a -- VkPipelineRasterizationStateRasterizationOrderAMD structure -- to the pNext chain of a -- VkPipelineRasterizationStateCreateInfo structure. This -- structure enables selecting the rasterization order to use when -- rendering with the corresponding graphics pipeline as described in -- Rasterization Order. -- --

Valid Usage

-- --

If the depth clamping feature is not enabled, -- depthClampEnable must be VK_FALSE

-- --

If the non-solid fill modes feature is not enabled, -- polygonMode must be VK_POLYGON_MODE_FILL or -- VK_POLYGON_MODE_FILL_RECTANGLE_NV
If the {html_spec_relative}#VK_NV_fill_rectangle -- extension is not enabled, polygonMode must not be -- VK_POLYGON_MODE_FILL_RECTANGLE_NV

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO

-- --

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 -- VkPipelineRasterizationConservativeStateCreateInfoEXT or -- VkPipelineRasterizationStateRasterizationOrderAMD
Each sType member in the pNext chain must -- be unique
flags must be 0
polygonMode must be a valid VkPolygonMode -- value
cullMode must be a valid combination of -- VkCullModeFlagBits values
frontFace must be a valid VkFrontFace -- value

-- --

Description

-- --

Valid Usage

-- --

If the sample rate shading feature is not enabled, -- sampleShadingEnable must be VK_FALSE

-- --

If the alpha to one feature is not enabled, -- alphaToOneEnable must be VK_FALSE
minSampleShading must be in the range [0,1]
If the subpass has any color attachments and -- rasterizationSamples is greater than the number of color -- samples, then sampleShadingEnable must be -- VK_FALSE

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO

-- --

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 -- VkPipelineCoverageModulationStateCreateInfoNV, -- VkPipelineCoverageToColorStateCreateInfoNV, or -- VkPipelineSampleLocationsStateCreateInfoEXT
Each sType member in the pNext chain must -- be unique
flags must be 0
rasterizationSamples must be a valid -- VkSampleCountFlagBits value
If pSampleMask is not NULL, pSampleMask -- must be a valid pointer to an array of <math> -- VkSampleMask values

-- --

Description

-- --

Valid Usage

-- --

If the dual source blending feature is not enabled, -- srcColorBlendFactor must not be -- VK_BLEND_FACTOR_SRC1_COLOR, -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, -- VK_BLEND_FACTOR_SRC1_ALPHA, or -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

-- --

If the dual source blending feature is not enabled, -- dstColorBlendFactor must not be -- VK_BLEND_FACTOR_SRC1_COLOR, -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, -- VK_BLEND_FACTOR_SRC1_ALPHA, or -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If the dual source blending feature is not enabled, -- srcAlphaBlendFactor must not be -- VK_BLEND_FACTOR_SRC1_COLOR, -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, -- VK_BLEND_FACTOR_SRC1_ALPHA, or -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If the dual source blending feature is not enabled, -- dstAlphaBlendFactor must not be -- VK_BLEND_FACTOR_SRC1_COLOR, -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, -- VK_BLEND_FACTOR_SRC1_ALPHA, or -- VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If either of colorBlendOp or alphaBlendOp is an -- advanced blend operation, then colorBlendOp -- must equal alphaBlendOp
If -- VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendIndependentBlend -- is VK_FALSE and colorBlendOp is an advanced blend -- operation, then colorBlendOp must be the same for -- all attachments.
If -- VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendIndependentBlend -- is VK_FALSE and alphaBlendOp is an advanced blend -- operation, then alphaBlendOp must be the same for -- all attachments.
If -- VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendAllOperations -- is VK_FALSE, then colorBlendOp must not be -- VK_BLEND_OP_ZERO_EXT, VK_BLEND_OP_SRC_EXT, -- VK_BLEND_OP_DST_EXT, VK_BLEND_OP_SRC_OVER_EXT, -- VK_BLEND_OP_DST_OVER_EXT, VK_BLEND_OP_SRC_IN_EXT, -- VK_BLEND_OP_DST_IN_EXT, VK_BLEND_OP_SRC_OUT_EXT, -- VK_BLEND_OP_DST_OUT_EXT, VK_BLEND_OP_SRC_ATOP_EXT, -- VK_BLEND_OP_DST_ATOP_EXT, VK_BLEND_OP_XOR_EXT, -- VK_BLEND_OP_INVERT_EXT, VK_BLEND_OP_INVERT_RGB_EXT, -- VK_BLEND_OP_LINEARDODGE_EXT, -- VK_BLEND_OP_LINEARBURN_EXT, -- VK_BLEND_OP_VIVIDLIGHT_EXT, -- VK_BLEND_OP_LINEARLIGHT_EXT, -- VK_BLEND_OP_PINLIGHT_EXT, VK_BLEND_OP_HARDMIX_EXT, -- VK_BLEND_OP_PLUS_EXT, VK_BLEND_OP_PLUS_CLAMPED_EXT, -- VK_BLEND_OP_PLUS_CLAMPED_ALPHA_EXT, -- VK_BLEND_OP_PLUS_DARKER_EXT, VK_BLEND_OP_MINUS_EXT, -- VK_BLEND_OP_MINUS_CLAMPED_EXT, -- VK_BLEND_OP_CONTRAST_EXT, -- VK_BLEND_OP_INVERT_OVG_EXT, VK_BLEND_OP_RED_EXT, -- VK_BLEND_OP_GREEN_EXT, or VK_BLEND_OP_BLUE_EXT
If colorBlendOp or alphaBlendOp is an -- advanced blend operation, then -- VkSubpassDescription::colorAttachmentCount of the -- subpass this pipeline is compiled against must be less than or -- equal to -- VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendMaxColorAttachments

-- --

Valid Usage (Implicit)

-- --

srcColorBlendFactor must be a valid -- VkBlendFactor value

-- --

dstColorBlendFactor must be a valid -- VkBlendFactor value
colorBlendOp must be a valid VkBlendOp -- value
srcAlphaBlendFactor must be a valid -- VkBlendFactor value
dstAlphaBlendFactor must be a valid -- VkBlendFactor value
alphaBlendOp must be a valid VkBlendOp -- value
colorWriteMask must be a valid combination of -- VkColorComponentFlagBits values

-- --

Description

-- -- Each element of the pAttachments array is a -- VkPipelineColorBlendAttachmentState structure specifying -- per-target blending state for each individual color attachment. If the -- independent blending feature is not enabled on the device, all -- VkPipelineColorBlendAttachmentState elements in the -- pAttachments array must be identical. -- --

Valid Usage

-- --

If the independent blending feature is not enabled, all -- elements of pAttachments must be identical

-- --

If the logic operations feature is not enabled, -- logicOpEnable must be VK_FALSE
If logicOpEnable is VK_TRUE, logicOp -- must be a valid VkLogicOp value

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkPipelineColorBlendAdvancedStateCreateInfoEXT
flags must be 0
If attachmentCount is not 0, -- pAttachments must be a valid pointer to an array of -- attachmentCount valid -- VkPipelineColorBlendAttachmentState structures

-- --

Description

-- --

Valid Usage

-- --

Each element of pDynamicStates must be unique

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
pDynamicStates must be a valid pointer to an array -- of dynamicStateCount valid VkDynamicState values
dynamicStateCount must be greater than -- 0

-- --

Description

-- --

Valid Usage (Implicit)

-- --

failOp must be a valid VkStencilOp -- value

-- --

passOp must be a valid VkStencilOp -- value
depthFailOp must be a valid VkStencilOp -- value
compareOp must be a valid VkCompareOp -- value

-- --

Description

-- --

Valid Usage

-- --

If the depth bounds testing feature is not enabled, -- depthBoundsTestEnable must be VK_FALSE

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
depthCompareOp must be a valid VkCompareOp -- value
front must be a valid VkStencilOpState -- structure
back must be a valid VkStencilOpState -- structure

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- -- pStages points to an array of -- VkPipelineShaderStageCreateInfo structures, which were -- previously described in Compute Pipelines. -- -- pDynamicState points to a structure of type -- VkPipelineDynamicStateCreateInfo. -- -- If any shader stage fails to compile, the compile log will be reported -- back to the application, and VK_ERROR_INVALID_SHADER_NV will -- be generated. -- --

Valid Usage

-- --

If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is -1, basePipelineHandle -- must be a valid handle to a graphics VkPipeline

-- --

If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is VK_NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, basePipelineHandle -- must be VK_NULL_HANDLE
If flags contains the -- VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not VK_NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of each element of pStages -- must be unique
The stage member of one element of pStages -- must be VK_SHADER_STAGE_VERTEX_BIT
The stage member of each element of pStages -- must not be VK_SHADER_STAGE_COMPUTE_BIT
If pStages includes a tessellation control shader stage, -- it must include a tessellation evaluation shader stage
If pStages includes a tessellation evaluation shader -- stage, it must include a tessellation control shader stage
If pStages includes a tessellation control shader stage -- and a tessellation evaluation shader stage, -- pTessellationState must be a valid pointer to a valid -- VkPipelineTessellationStateCreateInfo structure
If pStages includes tessellation shader stages, the -- shader code of at least one stage must contain an -- OpExecutionMode instruction that specifies the type of -- subdivision in the pipeline
If pStages includes tessellation shader stages, and the -- shader code of both stages contain an OpExecutionMode -- instruction that specifies the type of subdivision in the pipeline, -- they must both specify the same subdivision mode
If pStages includes tessellation shader stages, the -- shader code of at least one stage must contain an -- OpExecutionMode instruction that specifies the output patch -- size in the pipeline
If pStages includes tessellation shader stages, and the -- shader code of both contain an OpExecutionMode instruction -- that specifies the out patch size in the pipeline, they must -- both specify the same patch size
If pStages includes tessellation shader stages, the -- topology member of pInputAssembly must be -- VK_PRIMITIVE_TOPOLOGY_PATCH_LIST
If the topology member of pInputAssembly is -- VK_PRIMITIVE_TOPOLOGY_PATCH_LIST, pStages -- must include tessellation shader stages
If pStages includes a geometry shader stage, and does not -- include any tessellation shader stages, its shader code must -- contain an OpExecutionMode instruction that specifies an -- input primitive type that is compatible with the primitive -- topology specified in pInputAssembly
If pStages includes a geometry shader stage, and also -- includes tessellation shader stages, its shader code must -- contain an OpExecutionMode instruction that specifies an -- input primitive type that is compatible with the primitive -- topology that is output by the tessellation stages
If pStages includes a fragment shader stage and a -- geometry shader stage, and the fragment shader code reads from an -- input variable that is decorated with PrimitiveID, then the -- geometry shader code must write to a matching output variable, -- decorated with PrimitiveID, in all execution paths
If pStages includes a fragment shader stage, its shader -- code must not read from any input attachment that is defined as -- VK_ATTACHMENT_UNUSED in subpass
The shader code for the entry points identified by -- pStages, and the rest of the state identified by this -- structure must adhere to the pipeline linking rules described -- in the Shader Interfaces chapter
If rasterization is not disabled and subpass uses a -- depth/stencil attachment in renderPass that has a layout of -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL or -- VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL in -- the VkAttachmentReference defined by subpass, the -- depthWriteEnable member of pDepthStencilState -- must be VK_FALSE
If rasterization is not disabled and subpass uses a -- depth/stencil attachment in renderPass that has a layout of -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL or -- VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL in -- the VkAttachmentReference defined by subpass, the -- failOp, passOp and depthFailOp members of -- each of the front and back members of -- pDepthStencilState must be -- VK_STENCIL_OP_KEEP
If rasterization is not disabled and the subpass uses color -- attachments, then for each color attachment in the subpass the -- blendEnable member of the corresponding element of the -- pAttachment member of pColorBlendState must -- be VK_FALSE if the format of the attachment does not -- support color blend operations, as specified by the -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT flag in -- VkFormatProperties::linearTilingFeatures or -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties
If rasterization is not disabled and the subpass uses color -- attachments, the attachmentCount member of -- pColorBlendState must be equal to the -- colorAttachmentCount used to create subpass
If no element of the pDynamicStates member of -- pDynamicState is VK_DYNAMIC_STATE_VIEWPORT, the -- pViewports member of pViewportState must be a -- valid pointer to an array of -- pViewportState::viewportCount VkViewport -- structures
If no element of the pDynamicStates member of -- pDynamicState is VK_DYNAMIC_STATE_SCISSOR, the -- pScissors member of pViewportState must be a -- valid pointer to an array of -- pViewportState::scissorCount VkRect2D -- structures
If the wide lines feature is not enabled, and no element of the -- pDynamicStates member of pDynamicState is -- VK_DYNAMIC_STATE_LINE_WIDTH, the lineWidth member of -- pRasterizationState must be 1.0
If the rasterizerDiscardEnable member of -- pRasterizationState is VK_FALSE, -- pViewportState must be a valid pointer to a valid -- VkPipelineViewportStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is VK_FALSE, -- pMultisampleState must be a valid pointer to a valid -- VkPipelineMultisampleStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is VK_FALSE, and -- subpass uses a depth/stencil attachment, -- pDepthStencilState must be a valid pointer to a valid -- VkPipelineDepthStencilStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is VK_FALSE, and -- subpass uses color attachments, pColorBlendState -- must be a valid pointer to a valid -- VkPipelineColorBlendStateCreateInfo structure
If the depth bias clamping feature is not enabled, no element of -- the pDynamicStates member of pDynamicState is -- VK_DYNAMIC_STATE_DEPTH_BIAS, and the depthBiasEnable -- member of pRasterizationState is VK_TRUE, the -- depthBiasClamp member of pRasterizationState -- must be 0.0
If the -- {html_spec_relative}#VK_EXT_depth_range_unrestricted -- extension is not enabled and no element of the pDynamicStates -- member of pDynamicState is -- VK_DYNAMIC_STATE_DEPTH_BOUNDS, and the -- depthBoundsTestEnable member of pDepthStencilState -- is VK_TRUE, the minDepthBounds and -- maxDepthBounds members of pDepthStencilState -- must be between 0.0 and 1.0, inclusive
If no element of the pDynamicStates member of -- pDynamicState is -- VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, and the -- sampleLocationsEnable member of a -- VkPipelineSampleLocationsStateCreateInfoEXT structure chained -- to the pNext chain of pMultisampleState is -- VK_TRUE, -- sampleLocationsInfo.sampleLocationGridSize.width must -- evenly divide -- VkMultisamplePropertiesEXT::sampleLocationGridSize.width -- as returned by vkGetPhysicalDeviceMultisamplePropertiesEXT with -- a samples parameter equaling -- rasterizationSamples
If no element of the pDynamicStates member of -- pDynamicState is -- VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, and the -- sampleLocationsEnable member of a -- VkPipelineSampleLocationsStateCreateInfoEXT structure chained -- to the pNext chain of pMultisampleState is -- VK_TRUE, -- sampleLocationsInfo.sampleLocationGridSize.height must -- evenly divide -- VkMultisamplePropertiesEXT::sampleLocationGridSize.height -- as returned by vkGetPhysicalDeviceMultisamplePropertiesEXT with -- a samples parameter equaling -- rasterizationSamples
If no element of the pDynamicStates member of -- pDynamicState is -- VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, and the -- sampleLocationsEnable member of a -- VkPipelineSampleLocationsStateCreateInfoEXT structure chained -- to the pNext chain of pMultisampleState is -- VK_TRUE, sampleLocationsInfo.sampleLocationsPerPixel -- must equal rasterizationSamples
If the sampleLocationsEnable member of a -- VkPipelineSampleLocationsStateCreateInfoEXT structure chained -- to the pNext chain of pMultisampleState is -- VK_TRUE, the fragment shader code must not statically -- use the extended instruction InterpolateAtSample
layout must be consistent with all shaders -- specified in pStages
If subpass uses color and/or depth/stencil attachments, -- then the rasterizationSamples member of -- pMultisampleState must equal the maximum of the sample -- counts of those subpass attachments
If subpass has a depth/stencil attachment and depth test, -- stencil test, or depth bounds test are enabled, then the -- rasterizationSamples member of pMultisampleState -- must be the same as the sample count of the depth/stencil -- attachment
If subpass has any color attachments, then the -- rasterizationSamples member of pMultisampleState -- must be greater than or equal to the sample count for those -- subpass attachments
If subpass does not use any color and/or depth/stencil -- attachments, then the rasterizationSamples member of -- pMultisampleState must follow the rules for a -- zero-attachment subpass
subpass must be a valid subpass within -- renderPass
If the renderPass has multiview enabled and -- subpass has more than one bit set in the view mask and -- multiviewTessellationShader is not enabled, then -- pStages must not include tessellation shaders.
If the renderPass has multiview enabled and -- subpass has more than one bit set in the view mask and -- multiviewGeometryShader is not enabled, then pStages -- must not include a geometry shader.
If the renderPass has multiview enabled and -- subpass has more than one bit set in the view mask, shaders -- in the pipeline must not write to the Layer built-in -- output
If the renderPass has multiview enabled, then all shaders -- must not include variables decorated with the Layer -- built-in decoration in their interfaces.
flags must not contain the -- VK_PIPELINE_CREATE_DISPATCH_BASE flag.
If pStages includes a fragment shader stage and an input -- attachment was referenced by the -- VkRenderPassInputAttachmentAspectCreateInfo at -- renderPass create time, its shader code must not read -- from any aspect that was not specified in the aspectMask of -- the corresponding VkInputAttachmentAspectReference -- structure.
The number of resources in layout accessible to each -- shader stage that is used by the pipeline must be less than or -- equal to -- VkPhysicalDeviceLimits::maxPerStageResources
If no element of the pDynamicStates member of -- pDynamicState is -- VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV, and the -- viewportWScalingEnable member of a -- VkPipelineViewportWScalingStateCreateInfoNV structure, chained -- to the pNext chain of pViewportState, is -- VK_TRUE, the pViewportWScalings member of the -- VkPipelineViewportWScalingStateCreateInfoNV must be a -- pointer to an array of -- VkPipelineViewportWScalingStateCreateInfoNV::viewportCount -- valid VkViewportWScalingNV structures

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkPipelineDiscardRectangleStateCreateInfoEXT
flags must be a valid combination of -- VkPipelineCreateFlagBits values
pStages must be a valid pointer to an array of -- stageCount valid VkPipelineShaderStageCreateInfo -- structures
pVertexInputState must be a valid pointer to a -- valid VkPipelineVertexInputStateCreateInfo structure
pInputAssemblyState must be a valid pointer to a -- valid VkPipelineInputAssemblyStateCreateInfo structure
pRasterizationState must be a valid pointer to a -- valid VkPipelineRasterizationStateCreateInfo structure
If pDynamicState is not NULL, -- pDynamicState must be a valid pointer to a valid -- VkPipelineDynamicStateCreateInfo structure
layout must be a valid VkPipelineLayout -- handle
renderPass must be a valid VkRenderPass -- handle
stageCount must be greater than 0
Each of basePipelineHandle, layout, and -- renderPass that are valid handles must have been -- created, allocated, or retrieved from the same VkDevice

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pViewportWScalings must be a valid pointer to an -- array of viewportCount VkViewportWScalingNV -- structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
viewportCount must be greater than 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

VK_COLOR_SPACE_SRGB_NONLINEAR_KHR specifies support for -- the sRGB color space.

-- --

VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT specifies support -- for the Display-P3 color space and applies an sRGB-like transfer -- function (defined below).
VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT specifies support -- for the extended sRGB color space and applies a linear transfer -- function.
VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT specifies -- support for the extended sRGB color space and applies an sRGB transfer -- function.
VK_COLOR_SPACE_DCI_P3_LINEAR_EXT specifies support for -- the DCI-P3 color space and applies a linear OETF.
VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT specifies support for -- the DCI-P3 color space and applies the Gamma 2.6 OETF.
VK_COLOR_SPACE_BT709_LINEAR_EXT specifies support for the -- BT709 color space and applies a linear OETF.
VK_COLOR_SPACE_BT709_NONLINEAR_EXT specifies support for -- the BT709 color space and applies the SMPTE 170M OETF.
VK_COLOR_SPACE_BT2020_LINEAR_EXT specifies support for -- the BT2020 color space and applies a linear OETF.
VK_COLOR_SPACE_HDR10_ST2084_EXT specifies support for the -- HDR10 (BT2020 color) space and applies the SMPTE ST2084 Perceptual -- Quantizer (PQ) OETF.
VK_COLOR_SPACE_DOLBYVISION_EXT specifies support for the -- Dolby Vision (BT2020 color space), proprietary encoding, and applies -- the SMPTE ST2084 OETF.
VK_COLOR_SPACE_HDR10_HLG_EXT specifies support for the -- HDR10 (BT2020 color space) and applies the Hybrid Log Gamma (HLG) -- OETF.
VK_COLOR_SPACE_ADOBERGB_LINEAR_EXT specifies support for -- the AdobeRGB color space and applies a linear OETF.
VK_COLOR_SPACE_ADOBERGB_NONLINEAR_EXT specifies support -- for the AdobeRGB color space and applies the Gamma 2.2 OETF.
VK_COLOR_SPACE_PASS_THROUGH_EXT specifies that color -- components are used “as is”. This is intended to allow applications to -- supply data for color spaces not described here.

-- -- The color components of Non-linear color space swap chain images have -- had the appropriate transfer function applied. Vulkan requires that -- all implementations support the sRGB transfer function when using an -- SRGB pixel format. Other transfer functions, such as SMPTE 170M or -- SMPTE2084, must not be performed by the implementation, but -- can be performed by the application shader. This extension -- defines enums for VkColorSpaceKHR that correspond to the -- following color spaces: -- --

--   +----------+----------+----------+----------+----------+-----------+
--   | Name     | Red      | Green    | Blue     | White-po | Transfer  |
--   |          | Primary  | Primary  | Primary  | int      | function  |
--   +==========+==========+==========+==========+==========+===========+
--   | DCI-P3   | 0.680,   | 0.265,   | 0.150,   | 0.3127,  | Gamma 2.6 |
--   |          | 0.320    | 0.690    | 0.060    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | Display- | 0.680,   | 0.265,   | 0.150,   | 0.3127,  | Display-P |
--   | P3       | 0.320    | 0.690    | 0.060    | 0.3290   | 3         |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | BT709    | 0.640,   | 0.300,   | 0.150,   | 0.3127,  | SMPTE     |
--   |          | 0.330    | 0.600    | 0.060    | 0.3290   | 170M      |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | sRGB     | 0.640,   | 0.300,   | 0.150,   | 0.3127,  | sRGB      |
--   |          | 0.330    | 0.600    | 0.060    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | extended | 0.640,   | 0.300,   | 0.150,   | 0.3127,  | extended  |
--   | sRGB     | 0.330    | 0.600    | 0.060    | 0.3290   | sRGB      |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | HDR10_ST | 0.708,   | 0.170,   | 0.131,   | 0.3127,  | ST2084    |
--   | 2084     | 0.292    | 0.797    | 0.046    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | DOLBYVIS | 0.708,   | 0.170,   | 0.131,   | 0.3127,  | ST2084    |
--   | ION      | 0.292    | 0.797    | 0.046    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | HDR10_HL | 0.708,   | 0.170,   | 0.131,   | 0.3127,  | HLG       |
--   | G        | 0.292    | 0.797    | 0.046    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   | AdobeRGB | 0.640,   | 0.210,   | 0.150,   | 0.3127,  | AdobeRGB  |
--   |          | 0.330    | 0.710    | 0.060    | 0.3290   |           |
--   |          |          |          |          | (D65)    |           |
--   +----------+----------+----------+----------+----------+-----------+
--   
--   Color Spaces and Attributes
--

-- -- For Opto-Electrical Transfer Function (OETF), unless otherwise -- specified, the values of L and E are defined as: -- -- L - linear luminance of image <math> for conventional -- colorimetry -- -- E - corresponding electrical signal (value stored in memory) -- --

Description

-- --

VK_PRESENT_MODE_IMMEDIATE_KHR specifies that the -- presentation engine does not wait for a vertical blanking period to -- update the current image, meaning this mode may result in -- visible tearing. No internal queuing of presentation requests is -- needed, as the requests are applied immediately.

-- --

VK_PRESENT_MODE_MAILBOX_KHR specifies that the -- presentation engine waits for the next vertical blanking period to -- update the current image. Tearing cannot be observed. An -- internal single-entry queue is used to hold pending presentation -- requests. If the queue is full when a new presentation request is -- received, the new request replaces the existing entry, and any images -- associated with the prior entry become available for re-use by the -- application. One request is removed from the queue and processed -- during each vertical blanking period in which the queue is -- non-empty.
VK_PRESENT_MODE_FIFO_KHR specifies that the presentation -- engine waits for the next vertical blanking period to update the -- current image. Tearing cannot be observed. An internal queue is -- used to hold pending presentation requests. New requests are appended -- to the end of the queue, and one request is removed from the beginning -- of the queue and processed during each vertical blanking period in -- which the queue is non-empty. This is the only value of -- presentMode that is required to be supported.
VK_PRESENT_MODE_FIFO_RELAXED_KHR specifies that the -- presentation engine generally waits for the next vertical blanking -- period to update the current image. If a vertical blanking period has -- already passed since the last update of the current image then the -- presentation engine does not wait for another vertical blanking period -- for the update, meaning this mode may result in visible tearing -- in this case. This mode is useful for reducing visual stutter with an -- application that will mostly present a new image before the next -- vertical blanking period, but may occasionally be late, and present a -- new image just after the next vertical blanking period. An internal -- queue is used to hold pending presentation requests. New requests are -- appended to the end of the queue, and one request is removed from the -- beginning of the queue and processed during or after each vertical -- blanking period in which the queue is non-empty.
VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR specifies that -- the presentation engine and application have concurrent access to a -- single image, which is referred to as a shared presentable -- image. The presentation engine is only required to update the -- current image after a new presentation request is received. Therefore -- the application must make a presentation request whenever an -- update is required. However, the presentation engine may update -- the current image at any point, meaning this mode may result in -- visible tearing.
VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR specifies -- that the presentation engine and application have concurrent access to -- a single image, which is referred to as a shared presentable -- image. The presentation engine periodically updates the current -- image on its regular refresh cycle. The application is only required -- to make one initial presentation request, after which the presentation -- engine must update the current image without any need for -- further presentation requests. The application can indicate the -- image contents have been updated by making a presentation request, but -- this does not guarantee the timing of when it will be updated. This -- mode may result in visible tearing if rendering to the image is -- not timed correctly.

-- -- The supported VkImageUsageFlagBits of the presentable images of -- a swapchain created for a surface may differ depending on the -- presentation mode, and can be determined as per the table below: -- --

--   +-----------------------------------+-----------------------------------+
--   | Presentation mode                 | Image usage flags                 |
--   +===================================+===================================+
--   | @VK_PRESENT_MODE_IMMEDIATE_KHR@   | 'VkSurfaceCapabilitiesKHR'::@supp |
--   |                                   | ortedUsageFlags@                  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_PRESENT_MODE_MAILBOX_KHR@     | 'VkSurfaceCapabilitiesKHR'::@supp |
--   |                                   | ortedUsageFlags@                  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_PRESENT_MODE_FIFO_KHR@        | 'VkSurfaceCapabilitiesKHR'::@supp |
--   |                                   | ortedUsageFlags@                  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_PRESENT_MODE_FIFO_RELAXED_KHR | 'VkSurfaceCapabilitiesKHR'::@supp |
--   | @                                 | ortedUsageFlags@                  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_PRESENT_MODE_SHARED_DEMAND_RE | 'Graphics.Vulkan.Extensions.VK_KH |
--   | FRESH_KHR@                        | R_shared_presentable_image.VkShar |
--   |                                   | edPresentSurfaceCapabilitiesKHR': |
--   |                                   | :@sharedPresentSupportedUsageFlag |
--   |                                   | s@                                |
--   +-----------------------------------+-----------------------------------+
--   | @VK_PRESENT_MODE_SHARED_CONTINUOU | 'Graphics.Vulkan.Extensions.VK_KH |
--   | S_REFRESH_KHR@                    | R_shared_presentable_image.VkShar |
--   |                                   | edPresentSurfaceCapabilitiesKHR': |
--   |                                   | :@sharedPresentSupportedUsageFlag |
--   |                                   | s@                                |
--   +-----------------------------------+-----------------------------------+
--   
--   Presentable image usage queries
--

-- -- Note -- -- For reference, the mode indicated by VK_PRESENT_MODE_FIFO_KHR -- is equivalent to the behavior of {wgl|glX|egl}SwapBuffers with a swap -- interval of 1, while the mode indicated by -- VK_PRESENT_MODE_FIFO_RELAXED_KHR is equivalent to the -- behavior of {wgl|glX}SwapBuffers with a swap interval of -1 (from the -- {WGL|GLX}_EXT_swap_control_tear extensions). -- --

Description

-- -- These values are described as follows: -- --

VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR: The alpha channel, if -- it exists, of the images is ignored in the compositing process. -- Instead, the image is treated as if it has a constant alpha of -- 1.0.
VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR: The alpha -- channel, if it exists, of the images is respected in the compositing -- process. The non-alpha channels of the image are expected to already -- be multiplied by the alpha channel by the application.
VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR: The alpha -- channel, if it exists, of the images is respected in the compositing -- process. The non-alpha channels of the image are not expected to -- already be multiplied by the alpha channel by the application; -- instead, the compositor will multiply the non-alpha channels of the -- image by the alpha channel during compositing.
VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR: The way in which the -- presentation engine treats the alpha channel in the images is unknown -- to the Vulkan API. Instead, the application is responsible for setting -- the composite alpha blending mode using native window system commands. -- If the application does not set the blending mode using native window -- system commands, then a platform-specific default will be used.

-- --

Description

-- -- The VK_KHR_surface extension declares the -- VkSurfaceKHR object, and provides a function for destroying -- VkSurfaceKHR objects. Separate platform-specific extensions -- each provide a function for creating a VkSurfaceKHR object -- for the respective platform. From the application’s perspective this -- is an opaque handle, just like the handles of other Vulkan objects. -- --

Parameters

-- --

instance is the instance used to create the surface.

-- --

surface is the surface to destroy.
pAllocator is the allocator used for host memory -- allocated for the surface object when there is no more specific -- allocator available (see Memory Allocation).

-- --

Description

-- -- Destroying a VkSurfaceKHR merely severs the connection -- between Vulkan and the native surface, and does not imply destroying -- the native surface, closing a window, or similar behavior. -- --

Valid Usage

-- --

All VkSwapchainKHR objects created for surface -- must have been destroyed prior to destroying -- surface

-- --

If VkAllocationCallbacks were provided when -- surface was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- surface was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

If surface is not VK_NULL_HANDLE, surface -- must be a valid VkSurfaceKHR handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If surface is a valid handle, it must have been -- created, allocated, or retrieved from instance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

queueFamilyIndex is the queue family.
surface is the surface.
pSupported is a pointer to a VkBool32, which is -- set to VK_TRUE to indicate support, and VK_FALSE -- otherwise.

-- --

Description

-- --

Valid Usage

-- --

queueFamilyIndex must be less than -- pQueueFamilyPropertyCount returned by -- vkGetPhysicalDeviceQueueFamilyProperties for the given -- physicalDevice

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pSupported must be a valid pointer to a -- VkBool32 value
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- associated with the swapchain to be created, as described for -- vkCreateSwapchainKHR.

-- --

surface is the surface that will be associated with the -- swapchain.
pSurfaceCapabilities is a pointer to an instance of the -- VkSurfaceCapabilitiesKHR structure in which the capabilities -- are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pSurfaceCapabilities must be a valid pointer to a -- VkSurfaceCapabilitiesKHR structure
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- associated with the swapchain to be created, as described for -- vkCreateSwapchainKHR.

-- --

surface is the surface that will be associated with the -- swapchain.
pSurfaceFormatCount is a pointer to an integer related to -- the number of format pairs available or queried, as described -- below.
pSurfaceFormats is either NULL or a pointer to -- an array of VkSurfaceFormatKHR structures.

-- --

Description

-- -- If pSurfaceFormats is NULL, then the number of -- format pairs supported for the given surface is returned in -- pSurfaceFormatCount. The number of format pairs supported -- will be greater than or equal to 1. Otherwise, -- pSurfaceFormatCount must point to a variable set by -- the user to the number of elements in the pSurfaceFormats -- array, and on return the variable is overwritten with the number of -- structures actually written to pSurfaceFormats. If the value -- of pSurfaceFormatCount is less than the number of format -- pairs supported, at most pSurfaceFormatCount structures will -- be written. If pSurfaceFormatCount is smaller than the number -- of format pairs supported for the given surface, -- VK_INCOMPLETE will be returned instead of VK_SUCCESS -- to indicate that not all the available values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pSurfaceFormatCount must be a valid pointer to a -- uint32_t value
If the value referenced by pSurfaceFormatCount is not -- 0, and pSurfaceFormats is not NULL, -- pSurfaceFormats must be a valid pointer to an array of -- pSurfaceFormatCount VkSurfaceFormatKHR -- structures
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- associated with the swapchain to be created, as described for -- vkCreateSwapchainKHR.

-- --

surface is the surface that will be associated with the -- swapchain.
pPresentModeCount is a pointer to an integer related to -- the number of presentation modes available or queried, as described -- below.
pPresentModes is either NULL or a pointer to an -- array of VkPresentModeKHR values, indicating the supported -- presentation modes.

-- --

Description

-- -- If pPresentModes is NULL, then the number of -- presentation modes supported for the given surface is -- returned in pPresentModeCount. Otherwise, -- pPresentModeCount must point to a variable set by the -- user to the number of elements in the pPresentModes array, -- and on return the variable is overwritten with the number of values -- actually written to pPresentModes. If the value of -- pPresentModeCount is less than the number of presentation -- modes supported, at most pPresentModeCount values will be -- written. If pPresentModeCount is smaller than the number of -- presentation modes supported for the given surface, -- VK_INCOMPLETE will be returned instead of VK_SUCCESS -- to indicate that not all the available values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pPresentModeCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPresentModeCount is not -- 0, and pPresentModes is not NULL, -- pPresentModes must be a valid pointer to an array of -- pPresentModeCount VkPresentModeKHR values
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- associated with the swapchain to be created, as described for -- vkCreateSwapchainKHR.

-- --

pSurfaceInfo points to an instance of the -- VkPhysicalDeviceSurfaceInfo2KHR structure, describing the -- surface and other fixed parameters that would be consumed by -- vkCreateSwapchainKHR.
pSurfaceFormatCount is a pointer to an integer related to -- the number of format tuples available or queried, as described -- below.
pSurfaceFormats is either NULL or a pointer to -- an array of VkSurfaceFormat2KHR structures.

-- --

Description

-- -- If pSurfaceFormats is NULL, then the number of -- format tuples supported for the given surface is returned in -- pSurfaceFormatCount. The number of format tuples supported -- will be greater than or equal to 1. Otherwise, -- pSurfaceFormatCount must point to a variable set by -- the user to the number of elements in the pSurfaceFormats -- array, and on return the variable is overwritten with the number of -- structures actually written to pSurfaceFormats. If the value -- of pSurfaceFormatCount is less than the number of format -- tuples supported, at most pSurfaceFormatCount structures will -- be written. If pSurfaceFormatCount is smaller than the number -- of format tuples supported for the surface parameters described in -- pSurfaceInfo, VK_INCOMPLETE will be returned instead -- of VK_SUCCESS to indicate that not all the available values -- were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pSurfaceInfo must be a valid pointer to a valid -- VkPhysicalDeviceSurfaceInfo2KHR structure
pSurfaceFormatCount must be a valid pointer to a -- uint32_t value
If the value referenced by pSurfaceFormatCount is not -- 0, and pSurfaceFormats is not NULL, -- pSurfaceFormats must be a valid pointer to an array of -- pSurfaceFormatCount VkSurfaceFormat2KHR -- structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Description

-- -- The members of VkPhysicalDeviceSurfaceInfo2KHR correspond to -- the arguments to vkGetPhysicalDeviceSurfaceCapabilitiesKHR, -- with sType and pNext added for extensibility. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR

-- --

pNext must be NULL
surface must be a valid VkSurfaceKHR -- handle

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR

-- --

pNext must be NULL or a pointer to a -- valid instance of VkSharedPresentSurfaceCapabilitiesKHR

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage

-- --

swapchainCount must be the same value as -- VkPresentInfoKHR::swapchainCount, where -- VkPresentInfoKHR is in the pNext-chain of this -- VkPresentRegionsKHR structure.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR

-- --

If pRegions is not NULL, pRegions -- must be a valid pointer to an array of swapchainCount -- valid VkPresentRegionKHR structures
swapchainCount must be greater than -- 0

-- --

physicalDevice is a physical device.

-- --

pPropertyCount is a pointer to an integer related to the -- number of display devices available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of VkDisplayPropertiesKHR structures.

-- --

Description

-- -- If pProperties is NULL, then the number of display -- devices available for physicalDevice is returned in -- pPropertyCount. Otherwise, pPropertyCount -- must point to a variable set by the user to the number of -- elements in the pProperties array, and on return the variable -- is overwritten with the number of structures actually written to -- pProperties. If the value of pPropertyCount is less -- than the number of display devices for physicalDevice, at -- most pPropertyCount structures will be written. If -- pPropertyCount is smaller than the number of display devices -- available for physicalDevice, VK_INCOMPLETE will be -- returned instead of VK_SUCCESS to indicate that not all the -- available values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkDisplayPropertiesKHR -- structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

physicalDevice is a physical device.

-- --

pPropertyCount is a pointer to an integer related to the -- number of display planes available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of VkDisplayPlanePropertiesKHR structures.

-- --

Description

-- -- If pProperties is NULL, then the number of display -- planes available for physicalDevice is returned in -- pPropertyCount. Otherwise, pPropertyCount -- must point to a variable set by the user to the number of -- elements in the pProperties array, and on return the variable -- is overwritten with the number of structures actually written to -- pProperties. If the value of pPropertyCount is less -- than the number of display planes for physicalDevice, at most -- pPropertyCount structures will be written. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkDisplayPlanePropertiesKHR -- structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

physicalDevice is a physical device.

-- --

planeIndex is the plane which the application wishes to -- use, and must be in the range [0, physical device plane count - -- 1].
pDisplayCount is a pointer to an integer related to the -- number of displays available or queried, as described below.
pDisplays is either NULL or a pointer to an -- array of VkDisplayKHR handles.

-- --

Description

-- -- If pDisplays is NULL, then the number of displays -- usable with the specified planeIndex for -- physicalDevice is returned in pDisplayCount. -- Otherwise, pDisplayCount must point to a variable set -- by the user to the number of elements in the pDisplays array, -- and on return the variable is overwritten with the number of handles -- actually written to pDisplays. If the value of -- pDisplayCount is less than the number of display planes for -- physicalDevice, at most pDisplayCount handles will -- be written. If pDisplayCount is smaller than the number of -- displays usable with the specified planeIndex for -- physicalDevice, VK_INCOMPLETE will be returned -- instead of VK_SUCCESS to indicate that not all the available -- values were returned. -- --

Valid Usage

-- --

planeIndex must be less than the number of display -- planes supported by the device as determined by calling -- vkGetPhysicalDeviceDisplayPlanePropertiesKHR

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pDisplayCount must be a valid pointer to a -- uint32_t value
If the value referenced by pDisplayCount is not -- 0, and pDisplays is not NULL, -- pDisplays must be a valid pointer to an array of -- pDisplayCount VkDisplayKHR handles

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

physicalDevice is the physical device associated with -- display.

-- --

display is the display to query.
pPropertyCount is a pointer to an integer related to the -- number of display modes available or queried, as described below.
pProperties is either NULL or a pointer to an -- array of VkDisplayModePropertiesKHR structures.

-- --

Description

-- -- If pProperties is NULL, then the number of display -- modes available on the specified display for -- physicalDevice is returned in pPropertyCount. -- Otherwise, pPropertyCount must point to a variable set -- by the user to the number of elements in the pProperties -- array, and on return the variable is overwritten with the number of -- structures actually written to pProperties. If the value of -- pPropertyCount is less than the number of display modes for -- physicalDevice, at most pPropertyCount structures -- will be written. If pPropertyCount is smaller than the number -- of display modes available on the specified display for -- physicalDevice, VK_INCOMPLETE will be returned -- instead of VK_SUCCESS to indicate that not all the available -- values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

display must be a valid VkDisplayKHR -- handle
pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkDisplayModePropertiesKHR -- structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

physicalDevice is the physical device associated with -- display.

-- --

display is the display to create an additional mode -- for.
pCreateInfo is a VkDisplayModeCreateInfoKHR -- structure describing the new mode to create.
pAllocator is the allocator used for host memory -- allocated for the display mode object when there is no more specific -- allocator available (see Memory Allocation).
pMode returns the handle of the mode created.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

display must be a valid VkDisplayKHR -- handle
pCreateInfo must be a valid pointer to a valid -- VkDisplayModeCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pMode must be a valid pointer to a -- VkDisplayModeKHR handle

-- --

Host Synchronization

-- --

Host access to display must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INITIALIZATION_FAILED
```

-- --

Parameters

-- --

physicalDevice is the physical device associated with -- display

-- --

mode is the display mode the application intends to -- program when using the specified plane. Note this parameter also -- implicitly specifies a display.
planeIndex is the plane which the application intends to -- use with the display, and is less than the number of display planes -- supported by the device.
pCapabilities is a pointer to a -- VkDisplayPlaneCapabilitiesKHR structure in which the -- capabilities are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

mode must be a valid VkDisplayModeKHR -- handle
pCapabilities must be a valid pointer to a -- VkDisplayPlaneCapabilitiesKHR structure

-- --

Host Synchronization

-- --

Host access to mode must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

instance is the instance corresponding to the physical -- device the targeted display is on.

-- --

pCreateInfo is a pointer to an instance of the -- VkDisplaySurfaceCreateInfoKHR structure specifying which mode, -- plane, and other parameters to use, as described below.
pAllocator is the allocator used for host memory -- allocated for the surface object when there is no more specific -- allocator available (see Memory Allocation).
pSurface points to a VkSurfaceKHR handle in -- which the created surface is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

instance must be a valid VkInstance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkDisplaySurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pSurface must be a valid pointer to a -- VkSurfaceKHR handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- -- Note -- -- For devices which have no natural value to return here, -- implementations should return the maximum resolution supported. -- --

supportedTransforms tells which transforms are supported -- by this display. This will contain one or more of the bits from -- VkSurfaceTransformFlagsKHR.
planeReorderPossible tells whether the planes on this -- display can have their z order changed. If this is -- VK_TRUE, the application can re-arrange the planes on -- this display in any order relative to each other.
persistentContent tells whether the display supports -- self-refresh/internal buffering. If this is true, the application -- can submit persistent present operations on swapchains created -- against this display.

-- --

sType must be -- VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR

-- --

pNext must be NULL
flags must be 0

-- --

sType must be -- VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

-- --

pNext must be NULL
flags must be 0
displayMode must be a valid -- VkDisplayModeKHR handle
transform must be a valid -- VkSurfaceTransformFlagBitsKHR value
alphaMode must be a valid -- VkDisplayPlaneAlphaFlagBitsKHR value

-- --

Description

-- -- VkDisplayPlaneAlphaFlagsKHR is a bitmask type for setting a -- mask of zero or more VkDisplayPlaneAlphaFlagBitsKHR. -- --

Parameters

-- --

physicalDevice The physical device the display is -- on.

-- --

display The display to release control of.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

display must be a valid VkDisplayKHR -- handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

pSampleLocationsInfo is the sample locations state to -- set.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT dynamic state -- enabled

-- --

The sampleLocationsPerPixel member of -- pSampleLocationsInfo must equal the -- rasterizationSamples member of the -- VkPipelineMultisampleStateCreateInfo structure the bound -- graphics pipeline has been created with
If -- VkPhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations -- is VK_FALSE then the current render pass must have -- been begun by specifying a -- VkRenderPassSampleLocationsBeginInfoEXT structure whose -- pPostSubpassSampleLocations member contains an element with a -- subpassIndex matching the current subpass index and the -- sampleLocationsInfo member of that element must match -- the sample locations state pointed to by -- pSampleLocationsInfo

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pSampleLocationsInfo must be a valid pointer to a -- valid VkSampleLocationsInfoEXT structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the additional multisampling capabilities.

-- --

samples is the sample count to query the capabilities -- for.
pMultisampleProperties is a pointer to a structure of -- type VkMultisamplePropertiesEXT, in which information about the -- additional multisampling capabilities specific to the sample count is -- returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

samples must be a valid -- VkSampleCountFlagBits value
pMultisampleProperties must be a valid pointer to -- a VkMultisamplePropertiesEXT structure

-- --

sType must be -- VK_STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT

-- --

sampleLocationsPerPixel must be a valid -- VkSampleCountFlagBits value
pSampleLocations must be a valid pointer to an -- array of sampleLocationsCount VkSampleLocationEXT -- structures
sampleLocationsCount must be greater than -- 0

-- --

sType must be -- VK_STRUCTURE_TYPE_RENDER_PASS_SAMPLE_LOCATIONS_BEGIN_INFO_EXT

-- --

If attachmentInitialSampleLocationsCount is not -- 0, pAttachmentInitialSampleLocations must be -- a valid pointer to an array of -- attachmentInitialSampleLocationsCount valid -- VkAttachmentSampleLocationsEXT structures
If postSubpassSampleLocationsCount is not 0, -- pPostSubpassSampleLocations must be a valid pointer to -- an array of postSubpassSampleLocationsCount valid -- VkSubpassSampleLocationsEXT structures

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_SAMPLE_LOCATIONS_STATE_CREATE_INFO_EXT

-- --

sampleLocationsInfo must be a valid -- VkSampleLocationsInfoEXT structure

-- --

Members

-- -- The members of the -- VkPhysicalDeviceSampleLocationsPropertiesEXT structure -- describe the following implementation-dependent limits: -- --

Description

-- --

sampleLocationSampleCounts is a bitmask of -- VkSampleCountFlagBits indicating the sample counts supporting -- custom sample locations.

-- --

maxSampleLocationGridSize is the maximum size of the -- pixel grid in which sample locations can vary that is supported -- for all sample counts in sampleLocationSampleCounts.
sampleLocationCoordinateRange[2] is the range of -- supported sample location coordinates.
sampleLocationSubPixelBits is the number of bits of -- subpixel precision for sample locations.
variableSampleLocations specifies whether the sample -- locations used by all pipelines that will be bound to a command buffer -- during a subpass must match. If set to VK_TRUE, the -- implementation supports variable sample locations in a subpass. If set -- to VK_FALSE, then the sample locations must stay -- constant in each subpass.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SAMPLE_LOCATIONS_PROPERTIES_EXT

-- -- If the VkPhysicalDeviceSampleLocationsPropertiesEXT structure -- is included in the pNext chain of -- VkPhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MULTISAMPLE_PROPERTIES_EXT

-- --

pNext must be NULL

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- associated with the swapchain to be created, as described for -- vkCreateSwapchainKHR.

-- --

surface is the surface that will be associated with the -- swapchain.
pSurfaceCapabilities is a pointer to an instance of the -- VkSurfaceCapabilities2EXT structure in which the capabilities -- are returned.

-- --

Description

-- -- vkGetPhysicalDeviceSurfaceCapabilities2EXT behaves similarly -- to vkGetPhysicalDeviceSurfaceCapabilitiesKHR, with the ability -- to return extended information by adding extension structures to the -- pNext chain of its pSurfaceCapabilities parameter. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pSurfaceCapabilities must be a valid pointer to a -- VkSurfaceCapabilities2EXT structure
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Members

-- -- All members of VkSurfaceCapabilities2EXT are identical to the -- corresponding members of VkSurfaceCapabilitiesKHR where one -- exists. The remaining members are: -- --

Description

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
supportedSurfaceCounters is a bitmask of -- VkSurfaceCounterFlagBitsEXT indicating the supported surface -- counter types.

-- --

Valid Usage

-- --

supportedSurfaceCounters must not include -- VK_SURFACE_COUNTER_VBLANK_EXT unless the surface queried is a -- display surface.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT

-- --

pNext must be NULL

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pDiscardRectangles must be a valid pointer to an -- array of discardRectangleCount VkRect2D -- structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
discardRectangleCount must be greater than -- 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO

-- --

If deviceIndexCount is not 0, -- pDeviceIndices must be a valid pointer to an array of -- deviceIndexCount uint32_t values

-- --

Members

-- -- If the pNext list of VkBindImageMemoryInfo includes a -- VkBindImageMemoryDeviceGroupInfo structure, then that -- structure determines how memory is bound to images across multiple -- devices in a device group. -- --

Description

-- -- The VkBindImageMemoryDeviceGroupInfo structure is defined as: -- --

sType is the type of this structure.
pNext is NULL or a pointer to an -- extension-specific structure.
deviceIndexCount is the number of elements in -- pDeviceIndices.
pDeviceIndices is a pointer to an array of device -- indices.
splitInstanceBindRegionCount is the number of elements in -- pSplitInstanceBindRegions.
pSplitInstanceBindRegions is a pointer to an array of -- rectangles describing which regions of the image are attached to each -- instance of memory.

-- -- If deviceIndexCount is greater than zero, then on device -- index i image is attached to the instance of the memory on -- the physical device with device index pDeviceIndices[i]. -- -- Let N be the number of physical devices in the logical device. If -- splitInstanceBindRegionCount is greater than zero, then -- pSplitInstanceBindRegions is an array of N2 rectangles, where -- the image region specified by the rectangle at element i*N+j in -- resource instance i is bound to the memory instance j. The blocks of -- the memory that are bound to each sparse image block region use an -- offset in memory, relative to memoryOffset, computed as if -- the whole image were being bound to a contiguous range of memory. In -- other words, horizontally adjacent image blocks use consecutive blocks -- of memory, vertically adjacent image blocks are separated by the -- number of bytes per block multiplied by the width in blocks of -- image, and the block at (0,0) corresponds to memory starting -- at memoryOffset. -- -- If splitInstanceBindRegionCount and deviceIndexCount -- are zero and the memory comes from a memory heap with the -- VK_MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if -- pDeviceIndices contains consecutive indices from zero to the -- number of physical devices in the logical device, minus one. In other -- words, by default each physical device attaches to its own instance of -- the memory. -- -- If splitInstanceBindRegionCount and deviceIndexCount -- are zero and the memory comes from a memory heap without the -- VK_MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if -- pDeviceIndices contains an array of zeros. In other words, by -- default each physical device attaches to instance zero. -- --

Valid Usage

-- --

At least one of deviceIndexCount and -- splitInstanceBindRegionCount must be zero.

-- --

deviceIndexCount must either be zero or equal to -- the number of physical devices in the logical device
All elements of pDeviceIndices must be valid -- device indices.
splitInstanceBindRegionCount must either be zero -- or equal to the number of physical devices in the logical device -- squared
Elements of pSplitInstanceBindRegions that correspond to -- the same instance of an image must not overlap.
The offset.x member of any element of -- pSplitInstanceBindRegions must be a multiple of the -- sparse image block width -- (VkSparseImageFormatProperties::imageGranularity.width) -- of all non-metadata aspects of the image
The offset.y member of any element of -- pSplitInstanceBindRegions must be a multiple of the -- sparse image block height -- (VkSparseImageFormatProperties::imageGranularity.height) -- of all non-metadata aspects of the image
The extent.width member of any element of -- pSplitInstanceBindRegions must either be a multiple of -- the sparse image block width of all non-metadata aspects of the image, -- or else extent.width + offset.x must equal -- the width of the image subresource
The extent.height member of any element of -- pSplitInstanceBindRegions must either be a multiple of -- the sparse image block height of all non-metadata aspects of the -- image, or else extent.height offset.y must -- equal the width of the image subresource

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO

-- --

If deviceIndexCount is not 0, -- pDeviceIndices must be a valid pointer to an array of -- deviceIndexCount uint32_t values
If splitInstanceBindRegionCount is not 0, -- pSplitInstanceBindRegions must be a valid pointer to -- an array of splitInstanceBindRegionCount VkRect2D -- structures

-- --

Description

-- --

VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK specifies a -- transparent, floating-point format, black color.

-- --

VK_BORDER_COLOR_INT_TRANSPARENT_BLACK specifies a -- transparent, integer format, black color.
VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK specifies an opaque, -- floating-point format, black color.
VK_BORDER_COLOR_INT_OPAQUE_BLACK specifies an opaque, -- integer format, black color.
VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE specifies an opaque, -- floating-point format, white color.
VK_BORDER_COLOR_INT_OPAQUE_WHITE specifies an opaque, -- integer format, white color.

-- -- These colors are described in detail in Texel Replacement. -- --

Description

-- --

VK_FILTER_NEAREST specifies nearest filtering.

-- --

VK_FILTER_LINEAR specifies linear filtering.
VK_FILTER_CUBIC_IMG specifies cubic filtering.

-- -- These filters are described in detail in Texel Filtering. -- --

Description

-- --

VK_SAMPLER_MIPMAP_MODE_NEAREST specifies nearest -- filtering.

-- --

VK_SAMPLER_MIPMAP_MODE_LINEAR specifies linear -- filtering.

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_TOO_MANY_OBJECTS
```

-- --

Parameters

-- --

device is the logical device that destroys the -- sampler.

-- --

sampler is the sampler to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to sampler must -- have completed execution

-- --

If VkAllocationCallbacks were provided when -- sampler was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- sampler was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If sampler is not VK_NULL_HANDLE, sampler -- must be a valid VkSampler handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If sampler is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to sampler must be externally -- synchronized

-- --

Members

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
flags is reserved for future use.
magFilter is a VkFilter value specifying the -- magnification filter to apply to lookups.
minFilter is a VkFilter value specifying the -- minification filter to apply to lookups.
mipmapMode is a VkSamplerMipmapMode value -- specifying the mipmap filter to apply to lookups.
addressModeU is a VkSamplerAddressMode value -- specifying the addressing mode for outside [0..1] range for U -- coordinate.
addressModeV is a VkSamplerAddressMode value -- specifying the addressing mode for outside [0..1] range for V -- coordinate.
addressModeW is a VkSamplerAddressMode value -- specifying the addressing mode for outside [0..1] range for W -- coordinate.
mipLodBias is the bias to be added to mipmap LOD -- (level-of-detail) calculation and bias provided by image sampling -- functions in SPIR-V, as described in the Level-of-Detail -- Operation section.
anisotropyEnable is VK_TRUE to enable -- anisotropic filtering, as described in the Texel Anisotropic -- Filtering section, or VK_FALSE otherwise.
maxAnisotropy is the anisotropy value clamp used by the -- sampler when anisotropyEnable is VK_TRUE. If -- anisotropyEnable is VK_FALSE, maxAnisotropy -- is ignored.
compareEnable is VK_TRUE to enable comparison -- against a reference value during lookups, or VK_FALSE -- otherwise.
- Note: Some implementations will default to shader -- state if this member does not match.
compareOp is a VkCompareOp value specifying the -- comparison function to apply to fetched data before filtering as -- described in the Depth Compare Operation section.
minLod and maxLod are the values used to clamp -- the computed LOD value, as described in the Level-of-Detail -- Operation section. maxLod must be greater than or -- equal to minLod.
borderColor is a VkBorderColor value specifying -- the predefined border color to use.
unnormalizedCoordinates controls whether to use -- unnormalized or normalized texel coordinates to address texels of the -- image. When set to VK_TRUE, the range of the image -- coordinates used to lookup the texel is in the range of zero to the -- image dimensions for x, y and z. When set to VK_FALSE the -- range of image coordinates is zero to one. When -- unnormalizedCoordinates is VK_TRUE, samplers have -- the following requirements:
- minFilter and -- magFilter must be equal.
- mipmapMode -- must be -- VK_SAMPLER_MIPMAP_MODE_NEAREST.
- minLod and -- maxLod must be zero.
- addressModeU and -- addressModeV must each be either -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER.
- anisotropyEnable -- must be VK_FALSE.
- compareEnable -- must be VK_FALSE.
- The sampler must not -- enable sampler Y’CBCR conversion.
When unnormalizedCoordinates is VK_TRUE, images -- the sampler is used with in the shader have the following -- requirements:
- The viewType must be either -- VK_IMAGE_VIEW_TYPE_1D or -- VK_IMAGE_VIEW_TYPE_2D.
- The image view must -- have a single layer and a single mip level.
When unnormalizedCoordinates is VK_TRUE, image -- built-in functions in the shader that use the sampler have the -- following requirements:
- The functions must not use -- projection.
- The functions must not use -- offsets.

-- --

Description

-- -- Note -- -- magFilter values of VK_FILTER_NEAREST and -- VK_FILTER_LINEAR directly correspond to GL_NEAREST -- and GL_LINEAR magnification filters. minFilter and -- mipmapMode combine to correspond to the similarly named -- OpenGL minification filter of GL_minFilter_MIPMAP_mipmapMode -- (e.g. minFilter of VK_FILTER_LINEAR and -- mipmapMode of VK_SAMPLER_MIPMAP_MODE_NEAREST -- correspond to GL_LINEAR_MIPMAP_NEAREST). -- -- There are no Vulkan filter modes that directly correspond to OpenGL -- minification filters of GL_LINEAR or GL_NEAREST, but -- they can be emulated using -- VK_SAMPLER_MIPMAP_MODE_NEAREST, minLod = 0, and -- maxLod = 0.25, and using minFilter = -- VK_FILTER_LINEAR or minFilter = -- VK_FILTER_NEAREST, respectively. -- -- Note that using a maxLod of zero would cause -- magnification to always be performed, and the -- magFilter to always be used. This is valid, just not an exact -- match for OpenGL behavior. Clamping the maximum LOD to 0.25 allows the -- λ value to be non-zero and minification to be performed, while still -- always rounding down to the base level. If the minFilter and -- magFilter are equal, then using a maxLod of zero -- also works. -- -- The maximum number of sampler objects which can be -- simultaneously created on a device is implementation-dependent and -- specified by the maxSamplerAllocationCount member of the -- VkPhysicalDeviceLimits structure. If -- maxSamplerAllocationCount is exceeded, -- vkCreateSampler will return -- VK_ERROR_TOO_MANY_OBJECTS. -- -- Since VkSampler is a non-dispatchable handle type, -- implementations may return the same handle for sampler state -- vectors that are identical. In such cases, all such objects would only -- count once against the maxSamplerAllocationCount limit. -- --

Valid Usage

-- --

The absolute value of mipLodBias must be less than -- or equal to -- VkPhysicalDeviceLimits::maxSamplerLodBias

-- --

If the anisotropic sampling feature is not enabled, -- anisotropyEnable must be VK_FALSE
If anisotropyEnable is VK_TRUE, -- maxAnisotropy must be between 1.0 and -- VkPhysicalDeviceLimits::maxSamplerAnisotropy, -- inclusive
If sampler Y’CBCR conversion is enabled and -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT -- is not set for the format, minFilter and magFilter -- must be equal to the sampler Y’CBCR conversion’s -- chromaFilter
If unnormalizedCoordinates is VK_TRUE, -- minFilter and magFilter must be equal
If unnormalizedCoordinates is VK_TRUE, -- mipmapMode must be -- VK_SAMPLER_MIPMAP_MODE_NEAREST
If unnormalizedCoordinates is VK_TRUE, -- minLod and maxLod must be zero
If unnormalizedCoordinates is VK_TRUE, -- addressModeU and addressModeV must each be -- either VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
If unnormalizedCoordinates is VK_TRUE, -- anisotropyEnable must be VK_FALSE
If unnormalizedCoordinates is VK_TRUE, -- compareEnable must be VK_FALSE
If any of addressModeU, addressModeV or -- addressModeW are -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, borderColor -- must be a valid VkBorderColor value
If sampler Y’CBCR conversion is enabled, -- addressModeU, addressModeV, and -- addressModeW must be -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, -- anisotropyEnable must be VK_FALSE, and -- unnormalizedCoordinates must be VK_FALSE
The sampler reduction mode must be set to -- VK_SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_EXT if sampler -- Y’CBCR conversion is enabled
If the -- {html_spec_relative}#VK_KHR_sampler_mirror_clamp_to_edge -- extension is not enabled, addressModeU, addressModeV -- and addressModeW must not be -- VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE
If compareEnable is VK_TRUE, compareOp -- must be a valid VkCompareOp value
If either magFilter or minFilter is -- VK_FILTER_CUBIC_IMG, anisotropyEnable must be -- VK_FALSE
If either magFilter or minFilter is -- VK_FILTER_CUBIC_IMG, the reductionMode member of -- VkSamplerReductionModeCreateInfoEXT must be -- VK_SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_EXT
If compareEnable is VK_TRUE, the -- reductionMode member of -- VkSamplerReductionModeCreateInfoEXT must be -- VK_SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_EXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO

-- --

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 -- VkSamplerReductionModeCreateInfoEXT or -- VkSamplerYcbcrConversionInfo
Each sType member in the pNext chain must -- be unique
flags must be 0
magFilter must be a valid VkFilter -- value
minFilter must be a valid VkFilter -- value
mipmapMode must be a valid -- VkSamplerMipmapMode value
addressModeU must be a valid -- VkSamplerAddressMode value
addressModeV must be a valid -- VkSamplerAddressMode value
addressModeW must be a valid -- VkSamplerAddressMode value

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the pipeline -- layout.

-- --

pipelineLayout is the pipeline layout to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- pipelineLayout was created, a compatible set of callbacks -- must be provided here

-- --

If no VkAllocationCallbacks were provided when -- pipelineLayout was created, pAllocator must -- be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If pipelineLayout is not VK_NULL_HANDLE, -- pipelineLayout must be a valid -- VkPipelineLayout handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If pipelineLayout is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to pipelineLayout must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

offset must be less than -- VkPhysicalDeviceLimits::maxPushConstantsSize

-- --

offset must be a multiple of 4
size must be greater than 0
size must be a multiple of 4
size must be less than or equal to -- VkPhysicalDeviceLimits::maxPushConstantsSize minus -- offset

-- --

Valid Usage (Implicit)

-- --

stageFlags must be a valid combination of -- VkShaderStageFlagBits values

-- --

stageFlags must not be 0

-- --

Members

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
flags is reserved for future use.
setLayoutCount is the number of descriptor sets included -- in the pipeline layout.
pSetLayouts is a pointer to an array of -- VkDescriptorSetLayout objects.
pushConstantRangeCount is the number of push constant -- ranges included in the pipeline layout.
pPushConstantRanges is a pointer to an array of -- VkPushConstantRange structures defining a set of push -- constant ranges for use in a single pipeline layout. In addition to -- descriptor set layouts, a pipeline layout also describes how many push -- constants can be accessed by each stage of the -- pipeline.NotePush constants represent a high speed path to -- modify constant data in pipelines that is expected to outperform -- memory-backed resource updates.

-- --

Description

-- --

Valid Usage

-- --

setLayoutCount must be less than or equal to -- VkPhysicalDeviceLimits::maxBoundDescriptorSets

-- --

The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_SAMPLER and -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorSamplers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER and -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorUniformBuffers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER and -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorStorageBuffers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, and -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorSampledImages
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, and -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorStorageImages
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT accessible to any given -- shader stage across all elements of pSetLayouts must -- be less than or equal to -- VkPhysicalDeviceLimits::maxPerStageDescriptorInputAttachments
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_SAMPLER and -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindSamplers
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER and -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindUniformBuffers
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER and -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindStorageBuffers
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, and -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindSampledImages
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, and -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER accessible to any -- given shader stage across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindStorageImages
The total number of descriptors with a descriptorType of -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT accessible to any given -- shader stage across all elements of pSetLayouts must -- be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxPerStageDescriptorUpdateAfterBindInputAttachments
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_SAMPLER and -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetSamplers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER accessible across all -- shader stagess and and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetUniformBuffers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetUniformBuffersDynamic
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetStorageBuffers
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetStorageBuffersDynamic
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, and -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetSampledImages
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, and -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetStorageImages
The total number of descriptors in descriptor set layouts created -- without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- bit set with a descriptorType of -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceLimits::maxDescriptorSetInputAttachments
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_SAMPLER and -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindSamplers
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER accessible across all -- shader stagess and and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindUniformBuffers
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindUniformBuffersDynamic
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindStorageBuffers
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC accessible across -- all shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindStorageBuffersDynamic
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, and -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindSampledImages
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, and -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindStorageImages
The total number of descriptors of the type -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT accessible across all -- shader stages and across all elements of pSetLayouts -- must be less than or equal to -- VkPhysicalDeviceDescriptorIndexingPropertiesEXT::maxDescriptorSetUpdateAfterBindInputAttachments
Any two elements of pPushConstantRanges must not -- include the same stage in stageFlags
pSetLayouts must not contain more than one -- descriptor set layout that was created with -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR -- set

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
If setLayoutCount is not 0, pSetLayouts -- must be a valid pointer to an array of setLayoutCount -- valid VkDescriptorSetLayout handles
If pushConstantRangeCount is not 0, -- pPushConstantRanges must be a valid pointer to an -- array of pushConstantRangeCount valid -- VkPushConstantRange structures

-- --

Description

-- -- VkShaderStageFlags is a bitmask type for setting a mask of -- zero or more VkShaderStageFlagBits. -- --

Parameters

-- --

device is the device that created pipeline.

-- --

pipeline is the target of the query.
shaderStage identifies the particular shader within the -- pipeline about which information is being queried.
infoType describes what kind of information is being -- queried.
pInfoSize is a pointer to a value related to the amount -- of data the query returns, as described below.
pInfo is either NULL or a pointer to a buffer.

-- --

Description

-- -- If pInfo is NULL, then the maximum size of the -- information that can be retrieved about the shader, in bytes, -- is returned in pInfoSize. Otherwise, pInfoSize -- must point to a variable set by the user to the size of the -- buffer, in bytes, pointed to by pInfo, and on return the -- variable is overwritten with the amount of data actually written to -- pInfo. -- -- If pInfoSize is less than the maximum size that can be -- retrieved by the pipeline cache, then at most pInfoSize bytes -- will be written to pInfo, and vkGetShaderInfoAMD -- will return VK_INCOMPLETE. -- -- Not all information is available for every shader and implementations -- may not support all kinds of information for any shader. When a -- certain type of information is unavailable, the function returns -- VK_ERROR_FEATURE_NOT_PRESENT. -- -- If information is successfully and fully queried, the function will -- return VK_SUCCESS. -- -- For VK_SHADER_INFO_TYPE_STATISTICS_AMD, an instance of -- VkShaderStatisticsInfoAMD will be written to the buffer -- pointed to by pInfo. This structure will be populated with -- statistics regarding the physical device resources used by that shader -- along with other miscellaneous information and is described in further -- detail below. -- -- For VK_SHADER_INFO_TYPE_DISASSEMBLY_AMD, pInfo -- points to a UTF-8 null-terminated string containing human-readable -- disassembly. The exact formatting and contents of the disassembly -- string are vendor-specific. -- -- The formatting and contents of all other types of information, -- including VK_SHADER_INFO_TYPE_BINARY_AMD, are left to the -- vendor and are not further specified by this extension. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pipeline must be a valid VkPipeline -- handle
shaderStage must be a valid -- VkShaderStageFlagBits value
infoType must be a valid -- VkShaderInfoTypeAMD value
pInfoSize must be a valid pointer to a -- size_t value
If the value referenced by pInfoSize is not 0, -- and pInfo is not NULL, pInfo must be -- a valid pointer to an array of pInfoSize bytes
pipeline must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_FEATURE_NOT_PRESENT
- ```
VK_ERROR_OUT_OF_HOST_MEMORY
```

-- --

Description

-- --

device must be a valid VkDevice -- handle

-- --

pAllocateInfo must be a valid pointer to a valid -- VkMemoryAllocateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pMemory must be a valid pointer to a -- VkDeviceMemory handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_TOO_MANY_OBJECTS
```
```
VK_ERROR_INVALID_EXTERNAL_HANDLE
```

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the VkDeviceMemory object to be -- freed.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- -- Before freeing a memory object, an application must ensure the -- memory object is no longer in use by the device—for example by -- command buffers in the pending state. The memory can -- remain bound to images or buffers at the time the memory object is -- freed, but any further use of them (on host or device) for anything -- other than destroying those objects will result in undefined behavior. -- If there are still any bound images or buffers, the memory may -- not be immediately released by the implementation, but must be -- released by the time all bound images and buffers have been destroyed. -- Once memory is released, it is returned to the heap from which it was -- allocated. -- -- How memory objects are bound to Images and Buffers is described in -- detail in the Resource Memory Association section. -- -- If a memory object is mapped at the time it is freed, it is implicitly -- unmapped. -- -- Note -- -- As described below, host writes are not implicitly flushed when -- the memory object is unmapped, but the implementation must -- guarantee that writes that have not been flushed do not affect any -- other memory. -- --

Valid Usage

-- --

All submitted commands that refer to memory (via images -- or buffers) must have completed execution

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If memory is not VK_NULL_HANDLE, memory -- must be a valid VkDeviceMemory handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If memory is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to memory must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the VkDeviceMemory object to be -- mapped.
offset is a zero-based byte offset from the beginning of -- the memory object.
size is the size of the memory range to map, or -- VK_WHOLE_SIZE to map from offset to the end of the -- allocation.
flags is reserved for future use.
ppData points to a pointer in which is returned a -- host-accessible pointer to the beginning of the mapped range. This -- pointer minus offset must be aligned to at least -- VkPhysicalDeviceLimits::minMemoryMapAlignment.

-- --

Description

-- -- It is an application error to call vkMapMemory on a memory -- object that is already mapped. -- -- Note -- -- vkMapMemory will fail if the implementation is unable to -- allocate an appropriately sized contiguous virtual address range, e.g. -- due to virtual address space fragmentation or platform limits. In such -- cases, vkMapMemory must return -- VK_ERROR_MEMORY_MAP_FAILED. The application can -- improve the likelihood of success by reducing the size of the mapped -- range and/or removing unneeded mappings using VkUnmapMemory. -- -- vkMapMemory does not check whether the device memory is -- currently in use before returning the host-accessible pointer. The -- application must guarantee that any previously submitted -- command that writes to this range has completed before the host reads -- from or writes to that range, and that any previously submitted -- command that reads from that range has completed before the host -- writes to that region (see here for details on fulfilling such -- a guarantee). If the device memory was allocated without the -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT set, these guarantees -- must be made for an extended range: the application must -- round down the start of the range to the nearest multiple of -- VkPhysicalDeviceLimits::nonCoherentAtomSize, and round -- the end of the range up to the nearest multiple of -- VkPhysicalDeviceLimits::nonCoherentAtomSize. -- -- While a range of device memory is mapped for host access, the -- application is responsible for synchronizing both device and host -- access to that memory range. -- -- Note -- -- It is important for the application developer to become meticulously -- familiar with all of the mechanisms described in the chapter on -- Synchronization and Cache Control as they are crucial to -- maintaining memory access ordering. -- --

Valid Usage

-- --

memory must not be currently mapped

-- --

offset must be less than the size of -- memory
If size is not equal to VK_WHOLE_SIZE, -- size must be greater than 0
If size is not equal to VK_WHOLE_SIZE, -- size must be less than or equal to the size of the -- memory minus offset
memory must have been created with a memory type -- that reports VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
memory must not have been allocated with multiple -- instances.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

memory must be a valid VkDeviceMemory -- handle
flags must be 0
ppData must be a valid pointer to a pointer -- value
memory must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to memory must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_MEMORY_MAP_FAILED
```

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the memory object to be unmapped.

-- --

Description

-- --

Valid Usage

-- --

memory must be currently mapped

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

memory must be a valid VkDeviceMemory -- handle
memory must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to memory must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the memory -- ranges.

-- --

memoryRangeCount is the length of the -- pMemoryRanges array.
pMemoryRanges is a pointer to an array of -- VkMappedMemoryRange structures describing the memory ranges to -- flush.

-- --

Description

-- -- vkFlushMappedMemoryRanges guarantees that host writes to the -- memory ranges described by pMemoryRanges can be made -- available to device access, via availability operations from -- the VK_ACCESS_HOST_WRITE_BIT access type. -- -- Within each range described by pMemoryRanges, each set of -- nonCoherentAtomSize bytes in that range is flushed if any -- byte in that set has been written by the host since it was first -- mapped, or the last time it was flushed. If pMemoryRanges -- includes sets of nonCoherentAtomSize bytes where no bytes -- have been written by the host, those bytes must not be flushed. -- -- Unmapping non-coherent memory does not implicitly flush the mapped -- memory, and host writes that have not been flushed may not ever -- be visible to the device. However, implementations must ensure -- that writes that have not been flushed do not become visible to any -- other memory. -- -- Note -- -- The above guarantee avoids a potential memory corruption in scenarios -- where host writes to a mapped memory object have not been flushed -- before the memory is unmapped (or freed), and the virtual address -- range is subsequently reused for a different mapping (or memory -- allocation). -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pMemoryRanges must be a valid pointer to an array -- of memoryRangeCount valid VkMappedMemoryRange -- structures
memoryRangeCount must be greater than -- 0

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the memory -- ranges.

-- --

memoryRangeCount is the length of the -- pMemoryRanges array.
pMemoryRanges is a pointer to an array of -- VkMappedMemoryRange structures describing the memory ranges to -- invalidate.

-- --

Description

-- -- vkInvalidateMappedMemoryRanges guarantees that device writes -- to the memory ranges described by pMemoryRanges, which have -- been made visible to the VK_ACCESS_HOST_WRITE_BIT and -- VK_ACCESS_HOST_READ_BIT access types, are made visible -- to the host. If a range of non-coherent memory is written by the host -- and then invalidated without first being flushed, its contents are -- undefined. -- -- Within each range described by pMemoryRanges, each set of -- nonCoherentAtomSize bytes in that range is invalidated if any -- byte in that set has been written by the device since it was first -- mapped, or the last time it was invalidated. -- -- Note -- -- Mapping non-coherent memory does not implicitly invalidate the mapped -- memory, and device writes that have not been invalidated must -- be made visible before the host reads or overwrites them. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pMemoryRanges must be a valid pointer to an array -- of memoryRangeCount valid VkMappedMemoryRange -- structures
memoryRangeCount must be greater than -- 0

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the memory object being queried.
pCommittedMemoryInBytes is a pointer to a -- VkDeviceSize value in which the number of bytes currently -- committed is returned, on success.

-- --

Description

-- -- The implementation may update the commitment at any time, and -- the value returned by this query may be out of date. -- -- The implementation guarantees to allocate any committed memory from -- the heapIndex indicated by the memory type that the memory object was -- created with. -- --

Valid Usage

-- --

memory must have been created with a memory type -- that reports VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

memory must be a valid VkDeviceMemory -- handle
pCommittedMemoryInBytes must be a valid pointer to -- a VkDeviceSize value
memory must have been created, allocated, or -- retrieved from device

-- --

Description

-- -- An instance of the VkMemoryAllocateInfo structure defines a -- memory import operation if the pNext chain contains an -- instance of one of the following structures: * -- VkImportMemoryWin32HandleInfoKHR with non-zero -- handleType value * VkImportMemoryFdInfoKHR with a -- non-zero handleType value * -- VkImportMemoryHostPointerInfoEXT with a non-zero -- handleType value * -- VkImportAndroidHardwareBufferInfoANDROID with a -- non-NULL buffer value -- -- Importing memory must not modify the content of the memory. -- Implementations must ensure that importing memory does not -- enable the importing Vulkan instance to access any memory or resources -- in other Vulkan instances other than that corresponding to the memory -- object imported. Implementations must also ensure accessing -- imported memory which has not been initialized does not allow the -- importing Vulkan instance to obtain data from the exporting Vulkan -- instance or vice-versa. -- -- Note -- -- How exported and imported memory is isolated is left to the -- implementation, but applications should be aware that such isolation -- may prevent implementations from placing multiple exportable -- memory objects in the same physical or virtual page. Hence, -- applications should avoid creating many small external memory -- objects whenever possible. -- -- When performing a memory import operation, it is the responsibility of -- the application to ensure the external handles meet all valid usage -- requirements. However, implementations must perform sufficient -- validation of external handles to ensure that the operation results in -- a valid memory object which will not cause program termination, device -- loss, queue stalls, or corruption of other resources when used as -- allowed according to its allocation parameters. If the external handle -- provided does not meet these requirements, the implementation -- must fail the memory import operation with the error code -- VK_ERROR_INVALID_EXTERNAL_HANDLE. -- --

Valid Usage

-- --

If the pNext chain contains an instance of -- VkExportMemoryAllocateInfo, and any of the handle types -- specified in VkExportMemoryAllocateInfo::handleTypes -- require a dedicated allocation, as reported by -- vkGetPhysicalDeviceImageFormatProperties2 in -- VkExternalImageFormatProperties::externalMemoryProperties::externalMemoryFeatures -- or -- VkExternalBufferProperties::externalMemoryProperties::externalMemoryFeatures, -- the pNext chain must contain an instance of -- VkMemoryDedicatedAllocateInfo or -- VkDedicatedAllocationMemoryAllocateInfoNV with either its -- image or buffer field set to a value other than -- VK_NULL_HANDLE.

-- --

If the pNext chain contains an instance of -- VkExportMemoryAllocateInfo, it must not contain an -- instance of VkExportMemoryAllocateInfoNV or -- VkExportMemoryWin32HandleInfoNV.
If the pNext chain contains an instance of -- VkImportMemoryWin32HandleInfoKHR, it must not contain an -- instance of VkImportMemoryWin32HandleInfoNV.
If the parameters define an import operation, the external handle -- specified was created by the Vulkan API, and the external handle type -- is VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR, then the -- values of allocationSize and memoryTypeIndex -- must match those specified when the memory object being -- imported was created.
If the parameters define an import operation and the external -- handle specified was created by the Vulkan API, the device mask -- specified by VkMemoryAllocateFlagsInfo must match that -- specified when the memory object being imported was allocated.
If the parameters define an import operation and the external -- handle specified was created by the Vulkan API, the list of physical -- devices that comprise the logical device passed to -- vkAllocateMemory must match the list of physical devices -- that comprise the logical device on which the memory was originally -- allocated.
If the parameters define an import operation and the external -- handle is an NT handle or a global share handle created outside of the -- Vulkan API, the value of memoryTypeIndex must be one -- of those returned by vkGetMemoryWin32HandlePropertiesKHR.
If the parameters define an import operation, the external handle -- was created by the Vulkan API, and the external handle type is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR, then -- the values of allocationSize and memoryTypeIndex -- must match those specified when the memory object being -- imported was created.
If the parameters define an import operation and the external -- handle type is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, -- allocationSize must match the size reported in the -- memory requirements of the image or buffer member of -- the instance of VkDedicatedAllocationMemoryAllocateInfoNV -- included in the pNext chain.
If the parameters define an import operation and the external -- handle type is VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, -- allocationSize must match the size specified when -- creating the Direct3D 12 heap from which the external handle was -- extracted.
If the parameters define an import operation and the external -- handle is a POSIX file descriptor created outside of the Vulkan API, -- the value of memoryTypeIndex must be one of those -- returned by vkGetMemoryFdPropertiesKHR.
If the parameters define an import operation and the external -- handle is a host pointer, the value of memoryTypeIndex -- must be one of those returned by -- vkGetMemoryHostPointerPropertiesEXT
If the parameters define an import operation and the external -- handle is a host pointer, allocationSize must be an -- integer multiple of -- VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If the parameters define an import operation and the external -- handle type is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BIT_ANDROID:
- allocationSize -- must be the size returned by -- vkGetAndroidHardwareBufferPropertiesANDROID for the Android -- hardware buffer
- If the pNext chain doesn’t contain an -- instance of VkMemoryDedicatedAllocateInfo or -- VkMemoryDedicatedAllocateInfo::image is -- VK_NULL_HANDLE, the Android hardware buffer must have a -- format of AHARDWAREBUFFER_FORMAT_BLOB and a usage that -- includes -- AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER
- memoryTypeIndex -- must be one of those returned by -- vkGetAndroidHardwareBufferPropertiesANDROID for the Android -- hardware buffer
If the parameters do not define an import operation, and the -- pNext chain contains an instance of -- VkExportMemoryAllocateInfo with -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- included in its handleTypes member, and the pNext -- contains an instance of VkMemoryDedicatedAllocateInfo with -- image not equal to VK_NULL_HANDLE, then -- allocationSize must be 0, otherwise -- allocationSize must be greater than 0.
If the parameters define an import operation, the external handle -- is an Android hardware buffer, and the pNext chain includes -- an instance of VkMemoryDedicatedAllocateInfo with -- image that is not VK_NULL_HANDLE:
- The Android -- hardware buffer’s usage must include at least one of -- AHARDWAREBUFFER_USAGE_GPU_COLOR_OUTPUT or -- AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
- The -- image’s format must be VK_FORMAT_UNDEFINED or -- the format returned by -- vkGetAndroidHardwareBufferPropertiesANDROID in -- VkAndroidHardwareBufferFormatPropertiesANDROID::format -- for the Android hardware buffer.
- The image’s and Android -- hardware buffer’s width, height, and array layer dimensions -- must be the same
- If the Android hardware buffer’s usage -- includes AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE, the image -- must have ⌊log2(max(width, height))⌋ + 1 mip levels, -- otherwise it must have exactly 1 mip level.
- Each bit -- set in the image’s usage must be listed in AHardwareBuffer -- Usage Equivalence, and if there is a corresponding -- AHARDWAREBUFFER_USAGE bit listed that bit must be -- included in the Android hardware buffer’s usage

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO

-- --

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 -- VkDedicatedAllocationMemoryAllocateInfoNV, -- VkExportMemoryAllocateInfo, -- VkExportMemoryAllocateInfoNV, -- VkExportMemoryWin32HandleInfoKHR, -- VkExportMemoryWin32HandleInfoNV, -- VkImportAndroidHardwareBufferInfoANDROID, -- VkImportMemoryFdInfoKHR, -- VkImportMemoryHostPointerInfoEXT, -- VkImportMemoryWin32HandleInfoKHR, -- VkImportMemoryWin32HandleInfoNV, -- VkMemoryAllocateFlagsInfo, or -- VkMemoryDedicatedAllocateInfo
Each sType member in the pNext chain must -- be unique

-- --

Description

-- --

Valid Usage

-- --

memory must be currently mapped

-- --

If size is not equal to VK_WHOLE_SIZE, -- offset and size must specify a range -- contained within the currently mapped range of memory
If size is equal to VK_WHOLE_SIZE, -- offset must be within the currently mapped range of -- memory
If size is equal to VK_WHOLE_SIZE, the end of -- the current mapping of memory must be a multiple of -- VkPhysicalDeviceLimits::nonCoherentAtomSize bytes from -- the beginning of the memory object.
offset must be a multiple of -- VkPhysicalDeviceLimits::nonCoherentAtomSize
If size is not equal to VK_WHOLE_SIZE, -- size must either be a multiple of -- VkPhysicalDeviceLimits::nonCoherentAtomSize, or -- offset plus size must equal the size of -- memory.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE

-- --

pNext must be NULL
memory must be a valid VkDeviceMemory -- handle

-- --

device is the logical device that owns the buffer and -- memory.

-- --

buffer is the buffer to be attached to memory.
memory is a VkDeviceMemory object describing the -- device memory to attach.
memoryOffset is the start offset of the region of -- memory which is to be bound to the buffer. The number of -- bytes returned in the VkMemoryRequirements::size -- member in memory, starting from memoryOffset bytes, -- will be bound to the specified buffer.

-- --

Description

-- -- vkBindBufferMemory is equivalent to passing the same -- parameters through VkBindBufferMemoryInfo to -- vkBindBufferMemory2. -- --

Valid Usage

-- --

buffer must not already be backed by a memory -- object

-- --

buffer must not have been created with any sparse -- memory binding flags
memoryOffset must be less than the size of -- memory
If buffer was created with the -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, -- memoryOffset must be a multiple of -- VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
If buffer was created with the -- VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, memoryOffset -- must be a multiple of -- VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment
If buffer was created with the -- VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, memoryOffset -- must be a multiple of -- VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment
memory must have been allocated using one of the -- memory types allowed in the memoryTypeBits member of the -- VkMemoryRequirements structure returned from a call to -- vkGetBufferMemoryRequirements with buffer
memoryOffset must be an integer multiple of the -- alignment member of the VkMemoryRequirements -- structure returned from a call to -- vkGetBufferMemoryRequirements with buffer
The size member of the VkMemoryRequirements -- structure returned from a call to -- vkGetBufferMemoryRequirements with buffer -- must be less than or equal to the size of memory minus -- memoryOffset
If buffer requires a dedicated allocation(as reported by -- vkGetBufferMemoryRequirements2 in -- VkMemoryDedicatedRequirements::requiresDedicatedAllocation for -- buffer), memory must have been created with -- VkMemoryDedicatedAllocateInfo::buffer equal to -- buffer
If the VkMemoryAllocateInfo provided when memory -- was allocated included an instance of -- VkMemoryDedicatedAllocateInfo in its pNext chain, and -- VkMemoryDedicatedAllocateInfo::buffer was not -- VK_NULL_HANDLE, then buffer must equal -- VkMemoryDedicatedAllocateInfo::buffer, and -- memoryOffset must be zero.
If buffer was created with -- VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation -- equal to VK_TRUE, memory must have been -- created with -- VkDedicatedAllocationMemoryAllocateInfoNV::buffer -- equal to a buffer handle created with identical creation parameters to -- buffer and memoryOffset must be zero

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

buffer must be a valid VkBuffer -- handle
memory must be a valid VkDeviceMemory -- handle
buffer must have been created, allocated, or -- retrieved from device
memory must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to buffer must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

image is the image to query.
pMemoryRequirements points to an instance of the -- VkMemoryRequirements structure in which the memory requirements -- of the image object are returned.

-- --

Description

-- --

Valid Usage

-- --

image must not have been created with the -- VK_IMAGE_CREATE_DISJOINT_BIT flag set

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

image must be a valid VkImage handle
pMemoryRequirements must be a valid pointer to a -- VkMemoryRequirements structure
image must have been created, allocated, or -- retrieved from device

-- --

Parameters

-- --

device is the logical device that owns the image and -- memory.

-- --

image is the image.
memory is the VkDeviceMemory object describing -- the device memory to attach.
memoryOffset is the start offset of the region of -- memory which is to be bound to the image. The number of bytes -- returned in the VkMemoryRequirements::size member in -- memory, starting from memoryOffset bytes, will be -- bound to the specified image.

-- --

Description

-- -- vkBindImageMemory is equivalent to passing the same -- parameters through VkBindImageMemoryInfo to -- vkBindImageMemory2. -- --

Valid Usage

-- --

image must not have been created with the -- VK_IMAGE_CREATE_DISJOINT_BIT set.

-- --

image must not already be backed by a memory -- object
image must not have been created with any sparse -- memory binding flags
memoryOffset must be less than the size of -- memory
memory must have been allocated using one of the -- memory types allowed in the memoryTypeBits member of the -- VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements with image
memoryOffset must be an integer multiple of the -- alignment member of the VkMemoryRequirements -- structure returned from a call to -- vkGetImageMemoryRequirements with image
The size member of the VkMemoryRequirements -- structure returned from a call to -- vkGetImageMemoryRequirements with image must -- be less than or equal to the size of memory minus -- memoryOffset
If image requires a dedicated allocation (as reported by -- vkGetImageMemoryRequirements2 in -- VkMemoryDedicatedRequirements::requiresDedicatedAllocation for -- image), memory must have been created with -- VkMemoryDedicatedAllocateInfo::image equal to -- image
If the VkMemoryAllocateInfo provided when memory -- was allocated included an instance of -- VkMemoryDedicatedAllocateInfo in its pNext chain, and -- VkMemoryDedicatedAllocateInfo::image was not -- VK_NULL_HANDLE, then image must equal -- VkMemoryDedicatedAllocateInfo::image and -- memoryOffset must be zero.
If image was created with -- VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation -- equal to VK_TRUE, memory must have been -- created with -- VkDedicatedAllocationMemoryAllocateInfoNV::image equal -- to an image handle created with identical creation parameters to -- image and memoryOffset must be zero

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

image must be a valid VkImage handle
memory must be a valid VkDeviceMemory -- handle
image must have been created, allocated, or -- retrieved from device
memory must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to image must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

sType must be -- VK_STRUCTURE_TYPE_DEDICATED_ALLOCATION_MEMORY_ALLOCATE_INFO_NV

-- --

If image is not VK_NULL_HANDLE, image -- must be a valid VkImage handle
If buffer is not VK_NULL_HANDLE, buffer -- must be a valid VkBuffer handle
Both of buffer, and image that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

buffer is the buffer containing draw parameters.
offset is the byte offset into buffer where -- parameters begin.
countBuffer is the buffer containing the draw count.
countBufferOffset is the byte offset into -- countBuffer where the draw count begins.
maxDrawCount specifies the maximum number of draws that -- will be executed. The actual number of executed draw calls is the -- minimum of the count specified in countBuffer and -- maxDrawCount.
stride is the byte stride between successive sets of draw -- parameters.

-- --

Description

-- -- vkCmdDrawIndirectCountAMD behaves similarly to -- vkCmdDrawIndirect except that the draw count is read by the -- device from a buffer during execution. The command will read an -- unsigned 32-bit integer from countBuffer located at -- countBufferOffset and use this as the draw count. -- --

Valid Usage

-- --

If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

buffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
If countBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
countBuffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
countBufferOffset must be a multiple of -- 4
stride must be a multiple of 4 and -- must be greater than or equal to -- sizeof(VkDrawIndirectCommand)
If maxDrawCount is greater than or equal to 1, -- (stride × (maxDrawCount - 1) + offset + -- sizeof(VkDrawIndirectCommand)) must be less -- than or equal to the size of buffer
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- VkDrawIndirectCommand structures accessed by this command -- must be 0
The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
If the count stored in countBuffer is equal to -- 1, (offset + -- sizeof(VkDrawIndirectCommand)) must be less -- than or equal to the size of buffer
If the count stored in countBuffer is greater than -- 1, (stride × (drawCount - 1) + -- offset + sizeof(VkDrawIndirectCommand)) -- must be less than or equal to the size of buffer
The count stored in countBuffer must be less than -- or equal to -- VkPhysicalDeviceLimits::maxDrawIndirectCount
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
countBuffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
Each of buffer, commandBuffer, and -- countBuffer must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

buffer is the buffer containing draw parameters.
offset is the byte offset into buffer where -- parameters begin.
countBuffer is the buffer containing the draw count.
countBufferOffset is the byte offset into -- countBuffer where the draw count begins.
maxDrawCount specifies the maximum number of draws that -- will be executed. The actual number of executed draw calls is the -- minimum of the count specified in countBuffer and -- maxDrawCount.
stride is the byte stride between successive sets of draw -- parameters.

-- --

Description

-- -- vkCmdDrawIndexedIndirectCountAMD behaves similarly to -- vkCmdDrawIndexedIndirect except that the draw count is read by -- the device from a buffer during execution. The command will read an -- unsigned 32-bit integer from countBuffer located at -- countBufferOffset and use this as the draw count. -- --

Valid Usage

-- --

If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

buffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
If countBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
countBuffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
countBufferOffset must be a multiple of -- 4
stride must be a multiple of 4 and -- must be greater than or equal to -- sizeof(VkDrawIndirectCommand)
If maxDrawCount is greater than or equal to 1, -- (stride × (maxDrawCount - 1) + offset + -- sizeof(VkDrawIndirectCommand)) must be less -- than or equal to the size of buffer
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- VkDrawIndexedIndirectCommand structures accessed by this -- command must be 0
The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
If count stored in countBuffer is equal to 1, -- (offset + -- sizeof(VkDrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
If count stored in countBuffer is greater than -- 1, (stride × (drawCount - 1) + -- offset + -- sizeof(VkDrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
drawCount must be less than or equal to -- VkPhysicalDeviceLimits::maxDrawIndirectCount
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
countBuffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
Each of buffer, commandBuffer, and -- countBuffer must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

pipelineStage is one of the -- VkPipelineStageFlagBits values, specifying the pipeline stage -- whose completion triggers the marker write.
dstBuffer is the buffer where the marker will be written -- to.
dstOffset is the byte offset into the buffer where the -- marker will be written to.
marker is the 32-bit value of the marker.

-- --

Description

-- -- The command will write the 32-bit marker value into the buffer only -- after all preceding commands have finished executing up to at least -- the specified pipeline stage. This includes the completion of other -- preceding vkCmdWriteBufferMarkerAMD commands so long as their -- specified pipeline stages occur either at the same time or earlier -- than this command’s specified pipelineStage. -- -- While consecutive buffer marker writes with the same -- pipelineStage parameter are implicitly complete in submission -- order, memory and execution dependencies between buffer marker writes -- and other operations must still be explicitly ordered using -- synchronization commands. The access scope for buffer marker writes -- falls under the VK_ACCESS_TRANSFER_WRITE_BIT, and the -- pipeline stages for identifying the synchronization scope must -- include both pipelineStage and -- VK_PIPELINE_STAGE_TRANSFER_BIT. -- -- Note -- -- Similar to vkCmdWriteTimestamp, if an implementation is -- unable to write a marker at any specific pipeline stage, it may -- instead do so at any logically later stage. -- -- Note -- -- Implementations may only support a limited number of pipelined -- marker write operations in flight at a given time, thus excessive -- number of marker write operations may degrade command execution -- performance. -- --

Valid Usage

-- --

dstOffset must be less than or equal to the size -- of dstBuffer minus 4.

-- --

dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstOffset must be a multiple of 4

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pipelineStage must be a valid -- VkPipelineStageFlagBits value
dstBuffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
Both of commandBuffer, and dstBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Description

-- -- If the VkMemoryDedicatedRequirements structure is included in -- the pNext chain of the VkMemoryRequirements2 structure -- passed as the pMemoryRequirements parameter of a -- vkGetBufferMemoryRequirements2 call, -- requiresDedicatedAllocation may be VK_TRUE -- under one of the following conditions: -- --

The pNext chain of VkBufferCreateInfo for the -- call to vkCreateBuffer used to create the buffer being -- queried contained an instance of -- VkExternalMemoryBufferCreateInfo, and any of the handle types -- specified in -- VkExternalMemoryBufferCreateInfo::handleTypes -- requires dedicated allocation, as reported by -- vkGetPhysicalDeviceExternalBufferProperties in -- VkExternalBufferProperties::externalMemoryProperties::externalMemoryFeatures, -- the requiresDedicatedAllocation field will be set to -- VK_TRUE.

-- -- In all other cases, requiresDedicatedAllocation must -- be set to VK_FALSE by the implementation whenever a -- VkMemoryDedicatedRequirements structure is included in the -- pNext chain of the VkMemoryRequirements2 structure -- passed to a call to vkGetBufferMemoryRequirements2. -- -- If the VkMemoryDedicatedRequirements structure is included in -- the pNext chain of the VkMemoryRequirements2 -- structure passed as the pMemoryRequirements parameter of a -- vkGetBufferMemoryRequirements2 call and -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT was set in -- VkBufferCreateInfo::flags when buffer was -- created then the implementation must set both -- prefersDedicatedAllocation and -- requiresDedicatedAllocation to VK_FALSE. -- -- If the VkMemoryDedicatedRequirements structure is included in -- the pNext chain of the VkMemoryRequirements2 -- structure passed as the pMemoryRequirements parameter of a -- vkGetImageMemoryRequirements2 call, -- requiresDedicatedAllocation may be VK_TRUE -- under one of the following conditions: -- --

The pNext chain of VkImageCreateInfo for the -- call to vkCreateImage used to create the image being queried -- contained an instance of VkExternalMemoryImageCreateInfo, and -- any of the handle types specified in -- VkExternalMemoryImageCreateInfo::handleTypes -- requires dedicated allocation, as reported by -- vkGetPhysicalDeviceImageFormatProperties2 in -- VkExternalImageFormatProperties::externalMemoryProperties::externalMemoryFeatures, -- the requiresDedicatedAllocation field will be set to -- VK_TRUE.

-- -- In all other cases, requiresDedicatedAllocation must -- be set to VK_FALSE by the implementation whenever a -- VkMemoryDedicatedRequirements structure is included in the -- pNext chain of the VkMemoryRequirements2 structure -- passed to a call to vkGetImageMemoryRequirements2. -- -- If the VkMemoryDedicatedRequirements structure is included in -- the pNext chain of the VkMemoryRequirements2 -- structure passed as the pMemoryRequirements parameter of a -- vkGetImageMemoryRequirements2 call and -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT was set in -- VkImageCreateInfo::flags when image was -- created then the implementation must set both -- prefersDedicatedAllocation and -- requiresDedicatedAllocation to VK_FALSE. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

-- --

Description

-- --

Valid Usage

-- --

At least one of image and buffer must be -- VK_NULL_HANDLE

-- --

If image is not VK_NULL_HANDLE, -- VkMemoryAllocateInfo::allocationSize must -- equal the VkMemoryRequirements::size of the -- image
If image is not VK_NULL_HANDLE, image -- must have been created without -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT set in -- VkImageCreateInfo::flags
If buffer is not VK_NULL_HANDLE, -- VkMemoryAllocateInfo::allocationSize must -- equal the VkMemoryRequirements::size of the -- buffer
If buffer is not VK_NULL_HANDLE, buffer -- must have been created without -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT set in -- VkBufferCreateInfo::flags
If image is not VK_NULL_HANDLE and -- VkMemoryAllocateInfo defines a memory import operation with -- handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the -- external handle was created by the Vulkan API, then the memory being -- imported must also be a dedicated image allocation and -- image must be identical to the image associated with the -- imported memory.
If buffer is not VK_NULL_HANDLE and -- VkMemoryAllocateInfo defines a memory import operation with -- handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT, -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, and the -- external handle was created by the Vulkan API, then the memory being -- imported must also be a dedicated buffer allocation and -- buffer must be identical to the buffer associated with the -- imported memory.
If image is not VK_NULL_HANDLE and -- VkMemoryAllocateInfo defines a memory import operation with -- handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the -- memory being imported must also be a dedicated image allocation -- and image must be identical to the image associated with the -- imported memory.
If buffer is not VK_NULL_HANDLE and -- VkMemoryAllocateInfo defines a memory import operation with -- handle type VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT, the -- memory being imported must also be a dedicated buffer -- allocation and buffer must be identical to the buffer -- associated with the imported memory.
If image is not VK_NULL_HANDLE, image -- must not have been created with -- VK_IMAGE_CREATE_DISJOINT_BIT set in -- VkImageCreateInfo::flags

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO

-- --

If image is not VK_NULL_HANDLE, image -- must be a valid VkImage handle
If buffer is not VK_NULL_HANDLE, buffer -- must be a valid VkBuffer handle
Both of buffer, and image that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Parameters

-- --

device is the logical device that owns the buffers and -- memory.

-- --

bindInfoCount is the number of elements in -- pBindInfos.
pBindInfos is a pointer to an array of structures of type -- VkBindBufferMemoryInfo, describing buffers and memory to -- bind.

-- --

Description

-- -- On some implementations, it may be more efficient to batch -- memory bindings into a single command. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pBindInfos must be a valid pointer to an array of -- bindInfoCount valid VkBindBufferMemoryInfo -- structures
bindInfoCount must be greater than 0

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the images and -- memory.

-- --

bindInfoCount is the number of elements in -- pBindInfos.
pBindInfos is a pointer to an array of structures of type -- VkBindImageMemoryInfo, describing images and memory to -- bind.

-- --

Description

-- -- On some implementations, it may be more efficient to batch -- memory bindings into a single command. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pBindInfos must be a valid pointer to an array of -- bindInfoCount valid VkBindImageMemoryInfo -- structures
bindInfoCount must be greater than 0

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage

-- --

buffer must not already be backed by a memory -- object

-- --

buffer must not have been created with any sparse -- memory binding flags
memoryOffset must be less than the size of -- memory
If buffer was created with the -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, -- memoryOffset must be a multiple of -- VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
If buffer was created with the -- VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, memoryOffset -- must be a multiple of -- VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment
If buffer was created with the -- VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, memoryOffset -- must be a multiple of -- VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment
memory must have been allocated using one of the -- memory types allowed in the memoryTypeBits member of the -- VkMemoryRequirements structure returned from a call to -- vkGetBufferMemoryRequirements with buffer
memoryOffset must be an integer multiple of the -- alignment member of the VkMemoryRequirements -- structure returned from a call to -- vkGetBufferMemoryRequirements with buffer
The size member of the VkMemoryRequirements -- structure returned from a call to -- vkGetBufferMemoryRequirements with buffer -- must be less than or equal to the size of memory minus -- memoryOffset
If buffer requires a dedicated allocation(as reported by -- vkGetBufferMemoryRequirements2 in -- VkMemoryDedicatedRequirements::requiresDedicatedAllocation for -- buffer), memory must have been created with -- VkMemoryDedicatedAllocateInfo::buffer equal to -- buffer and memoryOffset must be zero
If the VkMemoryAllocateInfo provided when memory -- was allocated included an instance of -- VkMemoryDedicatedAllocateInfo in its pNext chain, and -- VkMemoryDedicatedAllocateInfo::buffer was not -- VK_NULL_HANDLE, then buffer must equal -- VkMemoryDedicatedAllocateInfo::buffer and -- memoryOffset must be zero.
If buffer was created with -- VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation -- equal to VK_TRUE, memory must have been -- created with -- VkDedicatedAllocationMemoryAllocateInfoNV::buffer -- equal to buffer and memoryOffset must be -- zero
If the pNext chain includes -- VkBindBufferMemoryDeviceGroupInfo, all instances of -- memory specified by -- VkBindBufferMemoryDeviceGroupInfo::pDeviceIndices -- must have been allocated

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of VkBindBufferMemoryDeviceGroupInfo
buffer must be a valid VkBuffer -- handle
memory must be a valid VkDeviceMemory -- handle
Both of buffer, and memory must have been -- created, allocated, or retrieved from the same VkDevice

-- --

Description

-- --

Valid Usage

-- --

image must not already be backed by a memory -- object

-- --

image must not have been created with any sparse -- memory binding flags
memoryOffset must be less than the size of -- memory
If the pNext chain does not include an instance of the -- VkBindImagePlaneMemoryInfo structure, memory -- must have been allocated using one of the memory types allowed -- in the memoryTypeBits member of the -- VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with image
If the pNext chain does not include an instance of the -- VkBindImagePlaneMemoryInfo structure, memoryOffset -- must be an integer multiple of the alignment member of -- the VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with image
If the pNext chain does not include an instance of the -- VkBindImagePlaneMemoryInfo structure, the difference of the -- size of memory and memoryOffset must be -- greater than or equal to the size member of the -- VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with the same image
If the pNext chain includes an instance of the -- VkBindImagePlaneMemoryInfo structure, image -- must have been created with the -- VK_IMAGE_CREATE_DISJOINT_BIT bit set.
If the pNext chain includes an instance of the -- VkBindImagePlaneMemoryInfo structure, memory -- must have been allocated using one of the memory types allowed -- in the memoryTypeBits member of the -- VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with image and the -- correct planeAspect for this plane in the -- VkImagePlaneMemoryRequirementsInfo structure attached to the -- VkImageMemoryRequirementsInfo2’s pNext chain
If the pNext chain includes an instance of the -- VkBindImagePlaneMemoryInfo structure, memoryOffset -- must be an integer multiple of the alignment member of -- the VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with image and the -- correct planeAspect for this plane in the -- VkImagePlaneMemoryRequirementsInfo structure attached to the -- VkImageMemoryRequirementsInfo2’s pNext chain
If the pNext chain includes an instance of the -- VkBindImagePlaneMemoryInfo structure, the difference of the -- size of memory and memoryOffset must be -- greater than or equal to the size member of the -- VkMemoryRequirements structure returned from a call to -- vkGetImageMemoryRequirements2 with the same image and -- the correct planeAspect for this plane in the -- VkImagePlaneMemoryRequirementsInfo structure attached to the -- VkImageMemoryRequirementsInfo2’s pNext chain
If image requires a dedicated allocation (as reported by -- vkGetImageMemoryRequirements2 in -- VkMemoryDedicatedRequirements::requiresDedicatedAllocation for -- image), memory must have been created with -- VkMemoryDedicatedAllocateInfo::image equal to -- image and memoryOffset must be zero
If the VkMemoryAllocateInfo provided when memory -- was allocated included an instance of -- VkMemoryDedicatedAllocateInfo in its pNext chain, and -- VkMemoryDedicatedAllocateInfo::image was not -- VK_NULL_HANDLE, then image must equal -- VkMemoryDedicatedAllocateInfo::image and -- memoryOffset must be zero.
If image was created with -- VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation -- equal to VK_TRUE, memory must have been -- created with -- VkDedicatedAllocationMemoryAllocateInfoNV::image equal -- to image and memoryOffset must be zero
If the pNext chain includes -- VkBindImageMemoryDeviceGroupInfo, all instances of -- memory specified by -- VkBindImageMemoryDeviceGroupInfo::pDeviceIndices -- must have been allocated
If the pNext chain includes -- VkBindImageMemoryDeviceGroupInfo, and -- VkBindImageMemoryDeviceGroupInfo::splitInstanceBindRegionCount -- is not zero, then image must have been created with -- the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit -- set
If the pNext chain includes -- VkBindImageMemoryDeviceGroupInfo, all elements of -- VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions -- must be valid rectangles contained within the dimensions of -- image
If the pNext chain includes -- VkBindImageMemoryDeviceGroupInfo, the union of the areas of all -- elements of -- VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions -- that correspond to the same instance of image must -- cover the entire image.
If image was created with a valid swapchain handle in -- VkImageSwapchainCreateInfoKHR::swapchain, then the -- pNext chain must include a valid instance of -- VkBindImageMemorySwapchainInfoKHR
If the pNext chain includes an instance of -- VkBindImageMemorySwapchainInfoKHR, memory must -- be VK_NULL_HANDLE
If the pNext chain does not include an instance of -- VkBindImageMemorySwapchainInfoKHR, memory must -- be a valid VkDeviceMemory handle

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO

-- --

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 -- VkBindImageMemoryDeviceGroupInfo, -- VkBindImageMemorySwapchainInfoKHR, or -- VkBindImagePlaneMemoryInfo
Each sType member in the pNext chain must -- be unique
image must be a valid VkImage handle
Both of image, and memory that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

image is the VkImage object to get the memory -- requirements for.
pSparseMemoryRequirementCount is a pointer to an integer -- related to the number of sparse memory requirements available or -- queried, as described below.
pSparseMemoryRequirements is either NULL or a -- pointer to an array of VkSparseImageMemoryRequirements -- structures.

-- --

Description

-- -- If pSparseMemoryRequirements is NULL, then the -- number of sparse memory requirements available is returned in -- pSparseMemoryRequirementCount. Otherwise, -- pSparseMemoryRequirementCount must point to a variable -- set by the user to the number of elements in the -- pSparseMemoryRequirements array, and on return the variable -- is overwritten with the number of structures actually written to -- pSparseMemoryRequirements. If -- pSparseMemoryRequirementCount is less than the number of -- sparse memory requirements available, at most -- pSparseMemoryRequirementCount structures will be written. -- -- If the image was not created with -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT then -- pSparseMemoryRequirementCount will be set to zero and -- pSparseMemoryRequirements will not be written to. -- -- Note -- -- It is legal for an implementation to report a larger value in -- VkMemoryRequirements::size than would be obtained by -- adding together memory sizes for all -- VkSparseImageMemoryRequirements returned by -- vkGetImageSparseMemoryRequirements. This may occur -- when the implementation requires unused padding in the address range -- describing the resource. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

image must be a valid VkImage handle
pSparseMemoryRequirementCount must be a valid -- pointer to a uint32_t value
If the value referenced by pSparseMemoryRequirementCount -- is not 0, and pSparseMemoryRequirements is not -- NULL, pSparseMemoryRequirements must be a -- valid pointer to an array of pSparseMemoryRequirementCount -- VkSparseImageMemoryRequirements structures
image must have been created, allocated, or -- retrieved from device

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the sparse image capabilities.

-- --

format is the image format.
type is the dimensionality of image.
samples is the number of samples per texel as defined in -- VkSampleCountFlagBits.
usage is a bitmask describing the intended usage of the -- image.
tiling is the tiling arrangement of the data elements in -- memory.
pPropertyCount is a pointer to an integer related to the -- number of sparse format properties available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of VkSparseImageFormatProperties structures.

-- --

Description

-- -- If pProperties is NULL, then the number of sparse -- format properties available is returned in pPropertyCount. -- Otherwise, pPropertyCount must point to a variable set -- by the user to the number of elements in the pProperties -- array, and on return the variable is overwritten with the number of -- structures actually written to pProperties. If -- pPropertyCount is less than the number of sparse format -- properties available, at most pPropertyCount structures will -- be written. -- -- If VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT is not supported for -- the given arguments, pPropertyCount will be set to zero upon -- return, and no data will be written to pProperties. -- -- Multiple aspects are returned for depth/stencil images that are -- implemented as separate planes by the implementation. The depth and -- stencil data planes each have unique -- VkSparseImageFormatProperties data. -- -- Depth/stencil images with depth and stencil data interleaved into a -- single plane will return a single -- VkSparseImageFormatProperties structure with the -- aspectMask set to VK_IMAGE_ASPECT_DEPTH_BIT | -- VK_IMAGE_ASPECT_STENCIL_BIT. -- --

Valid Usage

-- --

samples must be a bit value that is set in -- VkImageFormatProperties::sampleCounts returned by -- vkGetPhysicalDeviceImageFormatProperties with -- format, type, tiling, and usage -- equal to those in this command and flags equal to the value -- that is set in VkImageCreateInfo::flags when the -- image is created

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

format must be a valid VkFormat value
type must be a valid VkImageType value
samples must be a valid -- VkSampleCountFlagBits value
usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0
tiling must be a valid VkImageTiling -- value
pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkSparseImageFormatProperties -- structures

-- --

Parameters

-- --

queue is the queue that the sparse binding operations -- will be submitted to.

-- --

bindInfoCount is the number of elements in the -- pBindInfo array.
pBindInfo is an array of VkBindSparseInfo -- structures, each specifying a sparse binding submission batch.
fence is an optional handle to a fence to be -- signaled. If fence is not VK_NULL_HANDLE, it defines a -- fence signal operation.

-- --

Description

-- -- vkQueueBindSparse is a queue submission command, with -- each batch defined by an element of pBindInfo as an instance -- of the VkBindSparseInfo structure. Batches begin execution in -- the order they appear in pBindInfo, but may complete -- out of order. -- -- Within a batch, a given range of a resource must not be bound -- more than once. Across batches, if a range is to be bound to one -- allocation and offset and then to another allocation and offset, then -- the application must guarantee (usually using semaphores) that -- the binding operations are executed in the correct order, as well as -- to order binding operations against the execution of command buffer -- submissions. -- -- As no operation to vkQueueBindSparse causes any pipeline stage -- to access memory, synchronization primitives used in this command -- effectively only define execution dependencies. -- -- Additional information about fence and semaphore operation is -- described in the synchronization chapter. -- --

Valid Usage

-- --

If fence is not VK_NULL_HANDLE, fence -- must be unsignaled

-- --

If fence is not VK_NULL_HANDLE, fence -- must not be associated with any other queue command that has -- not yet completed execution on that queue
Each element of the pSignalSemaphores member of each -- element of pBindInfo must be unsignaled when the -- semaphore signal operation it defines is executed on the device
When a semaphore unsignal operation defined by any element of the -- pWaitSemaphores member of any element of pBindInfo -- executes on queue, no other queue must be waiting on -- the same semaphore.
All elements of the pWaitSemaphores member of all -- elements of pBindInfo must be semaphores that are -- signaled, or have semaphore signal operations previously -- submitted for execution.

-- --

Valid Usage (Implicit)

-- --

queue must be a valid VkQueue handle

-- --

If bindInfoCount is not 0, pBindInfo -- must be a valid pointer to an array of bindInfoCount -- valid VkBindSparseInfo structures
If fence is not VK_NULL_HANDLE, fence -- must be a valid VkFence handle
The queue must support sparse binding -- operations
Both of fence, and queue that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to queue must be externally -- synchronized

-- --

Host access to pBindInfo[].pWaitSemaphores[] must -- be externally synchronized
Host access to pBindInfo[].pSignalSemaphores[] -- must be externally synchronized
Host access to pBindInfo[].pBufferBinds[].buffer -- must be externally synchronized
Host access to pBindInfo[].pImageOpaqueBinds[].image -- must be externally synchronized
Host access to pBindInfo[].pImageBinds[].image -- must be externally synchronized
Host access to fence must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | -               | -               | SPARSE_BINDING  | -               |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

aspectMask must be a valid combination of -- VkImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

Description

-- -- The binding range [resourceOffset, -- resourceOffset + size) has different constraints -- based on flags. If flags contains -- VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding range -- must be within the mip tail region of the metadata aspect. This -- metadata region is defined by: -- --

metadataRegion = [base, base + imageMipTailSize)
base = imageMipTailOffset + imageMipTailStride × -- n

-- -- and imageMipTailOffset, imageMipTailSize, and -- imageMipTailStride values are from the -- VkSparseImageMemoryRequirements corresponding to the metadata -- aspect of the image, and n is a valid array layer index for the image, -- -- imageMipTailStride is considered to be zero for aspects where -- VkSparseImageMemoryRequirements::formatProperties.flags -- contains VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT. -- -- If flags does not contain -- VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding range -- must be within the range -- [0,VkMemoryRequirements::size). -- --

Valid Usage

-- --

If memory is not VK_NULL_HANDLE, memory -- and memoryOffset must match the memory requirements of -- the resource, as described in section -- {html_spec_relative}#resources-association

-- --

If memory is not VK_NULL_HANDLE, memory -- must not have been created with a memory type that reports -- VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit set
size must be greater than 0
resourceOffset must be less than the size of the -- resource
size must be less than or equal to the size of the -- resource minus resourceOffset
memoryOffset must be less than the size of -- memory
size must be less than or equal to the size of -- memory minus memoryOffset

-- --

Valid Usage (Implicit)

-- --

If memory is not VK_NULL_HANDLE, memory -- must be a valid VkDeviceMemory handle

-- --

flags must be a valid combination of -- VkSparseMemoryBindFlagBits values

-- --

Description

-- --

Valid Usage

-- --

If the sparse aliased residency feature is not enabled, and -- if any other resources are bound to ranges of memory, the -- range of memory being bound must not overlap with -- those bound ranges

-- --

memory and memoryOffset must match the -- memory requirements of the calling command’s image, as -- described in section -- {html_spec_relative}#resources-association
subresource must be a valid image subresource for -- image (see -- {html_spec_relative}#resources-image-views)
offset.x must be a multiple of the sparse image -- block width -- (VkSparseImageFormatProperties::imageGranularity.width) -- of the image
extent.width must either be a multiple of the -- sparse image block width of the image, or else (extent.width -- + offset.x) must equal the width of the image -- subresource
offset.y must be a multiple of the sparse image -- block height -- (VkSparseImageFormatProperties::imageGranularity.height) -- of the image
extent.height must either be a multiple of the -- sparse image block height of the image, or else -- (extent.height + offset.y) must equal the -- height of the image subresource
offset.z must be a multiple of the sparse image -- block depth -- (VkSparseImageFormatProperties::imageGranularity.depth) -- of the image
extent.depth must either be a multiple of the -- sparse image block depth of the image, or else (extent.depth -- + offset.z) must equal the depth of the image -- subresource

-- --

Valid Usage (Implicit)

-- --

subresource must be a valid -- VkImageSubresource structure

-- --

If memory is not VK_NULL_HANDLE, memory -- must be a valid VkDeviceMemory handle
flags must be a valid combination of -- VkSparseMemoryBindFlagBits values

-- --

Description

-- --

Valid Usage (Implicit)

-- --

buffer must be a valid VkBuffer -- handle

-- --

pBinds must be a valid pointer to an array of -- bindCount valid VkSparseMemoryBind structures
bindCount must be greater than 0

-- --

Description

-- --

Valid Usage

-- --

If the flags member of any element of pBinds -- contains VK_SPARSE_MEMORY_BIND_METADATA_BIT, the binding -- range defined must be within the mip tail region of the -- metadata aspect of image

-- --

Valid Usage (Implicit)

-- --

image must be a valid VkImage handle

-- --

pBinds must be a valid pointer to an array of -- bindCount valid VkSparseMemoryBind structures
bindCount must be greater than 0

-- --

Description

-- --

Valid Usage

-- --

The subresource.mipLevel member of each element of -- pBinds must be less than the mipLevels -- specified in VkImageCreateInfo when image was -- created

-- --

The subresource.arrayLayer member of each element of -- pBinds must be less than the arrayLayers -- specified in VkImageCreateInfo when image was -- created

-- --

Valid Usage (Implicit)

-- --

image must be a valid VkImage handle

-- --

pBinds must be a valid pointer to an array of -- bindCount valid VkSparseImageMemoryBind -- structures
bindCount must be greater than 0

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_SPARSE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of VkDeviceGroupBindSparseInfo
If waitSemaphoreCount is not 0, -- pWaitSemaphores must be a valid pointer to an array of -- waitSemaphoreCount valid VkSemaphore handles
If bufferBindCount is not 0, -- pBufferBinds must be a valid pointer to an array of -- bufferBindCount valid VkSparseBufferMemoryBindInfo -- structures
If imageOpaqueBindCount is not 0, -- pImageOpaqueBinds must be a valid pointer to an array -- of imageOpaqueBindCount valid -- VkSparseImageOpaqueMemoryBindInfo structures
If imageBindCount is not 0, pImageBinds -- must be a valid pointer to an array of imageBindCount -- valid VkSparseImageMemoryBindInfo structures
If signalSemaphoreCount is not 0, -- pSignalSemaphores must be a valid pointer to an array -- of signalSemaphoreCount valid VkSemaphore -- handles
Both of the elements of pSignalSemaphores, and the -- elements of pWaitSemaphores that are valid handles -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Description

-- --

physicalDevice is the handle to the physical device whose -- properties will be queried.

-- --

pProperties points to an instance of the -- VkPhysicalDeviceProperties2 structure, that will be filled with -- returned information.

-- --

Description

-- -- Each structure in pProperties and its pNext chain -- contain members corresponding to properties or -- implementation-dependent limits. -- vkGetPhysicalDeviceProperties2 writes each member to a value -- indicating the value of that property or limit. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pProperties must be a valid pointer to a -- VkPhysicalDeviceProperties2 structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the format properties.

-- --

format is the format whose properties are queried.
pFormatProperties is a pointer to a -- VkFormatProperties2 structure in which physical device -- properties for format are returned.

-- --

Description

-- -- vkGetPhysicalDeviceFormatProperties2 behaves similarly to -- vkGetPhysicalDeviceFormatProperties, with the ability to return -- extended information in a pNext chain of output structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

format must be a valid VkFormat value
pFormatProperties must be a valid pointer to a -- VkFormatProperties2 structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the image capabilities.

-- --

pImageFormatInfo points to an instance of the -- VkPhysicalDeviceImageFormatInfo2 structure, describing the -- parameters that would be consumed by vkCreateImage.
pImageFormatProperties points to an instance of the -- VkImageFormatProperties2 structure in which capabilities are -- returned.

-- --

Description

-- -- vkGetPhysicalDeviceImageFormatProperties2 behaves similarly -- to vkGetPhysicalDeviceImageFormatProperties, with the ability -- to return extended information in a pNext chain of output -- structures. -- --

Valid Usage

-- --

If the pNext chain of pImageFormatProperties -- contains an instance of VkAndroidHardwareBufferUsageANDROID, -- the pNext chain of pImageFormatInfo must -- contain an instance of VkPhysicalDeviceExternalImageFormatInfo -- with handleType set to -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pImageFormatInfo must be a valid pointer to a -- valid VkPhysicalDeviceImageFormatInfo2 structure
pImageFormatProperties must be a valid pointer to -- a VkImageFormatProperties2 structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_FORMAT_NOT_SUPPORTED
```

-- --

Parameters

-- --

physicalDevice is the handle to the physical device whose -- properties will be queried.

-- --

pQueueFamilyPropertyCount is a pointer to an integer -- related to the number of queue families available or queried, as -- described in vkGetPhysicalDeviceQueueFamilyProperties.
pQueueFamilyProperties is either NULL or a -- pointer to an array of VkQueueFamilyProperties2 -- structures.

-- --

Description

-- -- vkGetPhysicalDeviceQueueFamilyProperties2 behaves similarly -- to vkGetPhysicalDeviceQueueFamilyProperties, with the ability -- to return extended information in a pNext chain of output -- structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pQueueFamilyPropertyCount must be a valid pointer -- to a uint32_t value
If the value referenced by pQueueFamilyPropertyCount is -- not 0, and pQueueFamilyProperties is not -- NULL, pQueueFamilyProperties must be a valid -- pointer to an array of pQueueFamilyPropertyCount -- VkQueueFamilyProperties2 structures

-- --

Parameters

-- --

physicalDevice is the handle to the device to query.

-- --

pMemoryProperties points to an instance of -- VkPhysicalDeviceMemoryProperties2 structure in which the -- properties are returned.

-- --

Description

-- -- vkGetPhysicalDeviceMemoryProperties2 behaves similarly to -- vkGetPhysicalDeviceMemoryProperties, with the ability to return -- extended information in a pNext chain of output structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pMemoryProperties must be a valid pointer to a -- VkPhysicalDeviceMemoryProperties2 structure

-- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the sparse image capabilities.

-- --

pFormatInfo is a pointer to a structure of type -- VkPhysicalDeviceSparseImageFormatInfo2 containing input -- parameters to the command.
pPropertyCount is a pointer to an integer related to the -- number of sparse format properties available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of VkSparseImageFormatProperties2 structures.

-- --

Description

-- -- vkGetPhysicalDeviceSparseImageFormatProperties2 behaves -- identically to vkGetPhysicalDeviceSparseImageFormatProperties, -- with the ability to return extended information by adding extension -- structures to the pNext chain of its pProperties -- parameter. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pFormatInfo must be a valid pointer to a valid -- VkPhysicalDeviceSparseImageFormatInfo2 structure
pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkSparseImageFormatProperties2 -- structures

-- --

Members

-- -- The VkPhysicalDeviceFeatures2 structure is defined as: -- --

Description

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
features is a structure of type -- VkPhysicalDeviceFeatures describing the fine-grained features -- of the Vulkan 1.0 API.

-- -- The pNext chain of this structure is used to extend the -- structure with features defined by extensions. This structure -- can be used in vkGetPhysicalDeviceFeatures2 or -- can be in the pNext chain of a -- VkDeviceCreateInfo structure, in which case it controls which -- features are enabled in the device in lieu of -- pEnabledFeatures. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2

-- --

Description

-- -- The pNext chain of this structure is used to extend the -- structure with properties defined by extensions. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2

-- --

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 -- VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT, -- VkPhysicalDeviceConservativeRasterizationPropertiesEXT, -- VkPhysicalDeviceDiscardRectanglePropertiesEXT, -- VkPhysicalDeviceExternalMemoryHostPropertiesEXT, -- VkPhysicalDeviceIDProperties, -- VkPhysicalDeviceMaintenance3Properties, -- VkPhysicalDeviceMultiviewPerViewAttributesPropertiesNVX, -- VkPhysicalDeviceMultiviewProperties, -- VkPhysicalDevicePointClippingProperties, -- VkPhysicalDeviceProtectedMemoryProperties, -- VkPhysicalDevicePushDescriptorPropertiesKHR, -- VkPhysicalDeviceSampleLocationsPropertiesEXT, -- VkPhysicalDeviceSamplerFilterMinmaxPropertiesEXT, -- VkPhysicalDeviceShaderCorePropertiesAMD, -- VkPhysicalDeviceSubgroupProperties, or -- VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT
Each sType member in the pNext chain must -- be unique

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2

-- --

pNext must be NULL

-- --

Description

-- -- If the combination of parameters to -- vkGetPhysicalDeviceImageFormatProperties2 is not supported by -- the implementation for use in vkCreateImage, then all members -- of imageFormatProperties will be filled with zero. -- -- Note -- -- Filling imageFormatProperties with zero for unsupported -- formats is an exception to the usual rule that output structures have -- undefined contents on error. This exception was unintentional, but is -- preserved for backwards compatibility. This exeption only applies to -- imageFormatProperties, not sType, pNext, or -- any structures chained from pNext. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2

-- --

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 -- VkAndroidHardwareBufferUsageANDROID, -- VkExternalImageFormatProperties, -- VkSamplerYcbcrConversionImageFormatProperties, or -- VkTextureLODGatherFormatPropertiesAMD
Each sType member in the pNext chain must -- be unique

-- --

Description

-- -- The members of VkPhysicalDeviceImageFormatInfo2 correspond to -- the arguments to vkGetPhysicalDeviceImageFormatProperties, with -- sType and pNext added for extensibility. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2

-- --

pNext must be NULL or a pointer to a -- valid instance of VkPhysicalDeviceExternalImageFormatInfo
format must be a valid VkFormat value
type must be a valid VkImageType value
tiling must be a valid VkImageTiling -- value
usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0
flags must be a valid combination of -- VkImageCreateFlagBits values

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_QUEUE_FAMILY_PROPERTIES_2

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_PROPERTIES_2

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage

-- --

samples must be a bit value that is set in -- VkImageFormatProperties::sampleCounts returned by -- vkGetPhysicalDeviceImageFormatProperties with -- format, type, tiling, and usage -- equal to those in this command and flags equal to the value -- that is set in VkImageCreateInfo::flags when the -- image is created

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2

-- --

pNext must be NULL
format must be a valid VkFormat value
type must be a valid VkImageType value
samples must be a valid -- VkSampleCountFlagBits value
usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0
tiling must be a valid VkImageTiling -- value

-- --

Parameters

-- --

device is the logical device that owns the buffer.

-- --

pInfo is a pointer to an instance of the -- VkBufferMemoryRequirementsInfo2 structure containing -- parameters required for the memory requirements query.
pMemoryRequirements points to an instance of the -- VkMemoryRequirements2 structure in which the memory -- requirements of the buffer object are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pInfo must be a valid pointer to a valid -- VkBufferMemoryRequirementsInfo2 structure
pMemoryRequirements must be a valid pointer to a -- VkMemoryRequirements2 structure

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

pInfo is a pointer to an instance of the -- VkImageMemoryRequirementsInfo2 structure containing -- parameters required for the memory requirements query.
pMemoryRequirements points to an instance of the -- VkMemoryRequirements2 structure in which the memory -- requirements of the image object are returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pInfo must be a valid pointer to a valid -- VkImageMemoryRequirementsInfo2 structure
pMemoryRequirements must be a valid pointer to a -- VkMemoryRequirements2 structure

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

pInfo is a pointer to an instance of the -- VkImageSparseMemoryRequirementsInfo2 structure containing -- parameters required for the memory requirements query.
pSparseMemoryRequirementCount is a pointer to an integer -- related to the number of sparse memory requirements available or -- queried, as described below.
pSparseMemoryRequirements is either NULL or a -- pointer to an array of VkSparseImageMemoryRequirements2 -- structures.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pInfo must be a valid pointer to a valid -- VkImageSparseMemoryRequirementsInfo2 structure
pSparseMemoryRequirementCount must be a valid -- pointer to a uint32_t value
If the value referenced by pSparseMemoryRequirementCount -- is not 0, and pSparseMemoryRequirements is not -- NULL, pSparseMemoryRequirements must be a -- valid pointer to an array of pSparseMemoryRequirementCount -- VkSparseImageMemoryRequirements2 structures

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BUFFER_MEMORY_REQUIREMENTS_INFO_2

-- --

pNext must be NULL
buffer must be a valid VkBuffer -- handle

-- --

Description

-- --

Valid Usage

-- --

If image was created with a multi-planar format -- and the VK_IMAGE_CREATE_DISJOINT_BIT flag, there must -- be a VkImagePlaneMemoryRequirementsInfo in the pNext -- chain of the VkImageMemoryRequirementsInfo2 structure

-- --

If image was not created with the -- VK_IMAGE_CREATE_DISJOINT_BIT flag, there must not be a -- VkImagePlaneMemoryRequirementsInfo in the pNext chain -- of the VkImageMemoryRequirementsInfo2 structure
If image was created with a single-plane format, there -- must not be a VkImagePlaneMemoryRequirementsInfo in the -- pNext chain of the VkImageMemoryRequirementsInfo2 -- structure
If image was created with the -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- external memory handle type, then image must be bound -- to memory.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_MEMORY_REQUIREMENTS_INFO_2

-- --

pNext must be NULL or a pointer to a -- valid instance of VkImagePlaneMemoryRequirementsInfo
image must be a valid VkImage handle

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_SPARSE_MEMORY_REQUIREMENTS_INFO_2

-- --

pNext must be NULL
image must be a valid VkImage handle

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2

-- --

pNext must be NULL or a pointer to a -- valid instance of VkMemoryDedicatedRequirements

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SPARSE_IMAGE_MEMORY_REQUIREMENTS_2

-- --

pNext must be NULL

-- --

Description

-- --

VK_COMPONENT_SWIZZLE_IDENTITY specifies that the -- component is set to the identity swizzle.

-- --

VK_COMPONENT_SWIZZLE_ZERO specifies that the component is -- set to zero.
VK_COMPONENT_SWIZZLE_ONE specifies that the component is -- set to either 1 or 1.0, depending on whether the type of the image -- view format is integer or floating-point respectively, as determined -- by the Format Definition section for each VkFormat.
VK_COMPONENT_SWIZZLE_R specifies that the component is -- set to the value of the R component of the image.
VK_COMPONENT_SWIZZLE_G specifies that the component is -- set to the value of the G component of the image.
VK_COMPONENT_SWIZZLE_B specifies that the component is -- set to the value of the B component of the image.
VK_COMPONENT_SWIZZLE_A specifies that the component is -- set to the value of the A component of the image.

-- -- Setting the identity swizzle on a component is equivalent to setting -- the identity mapping on that component. That is: -- --

--   +-----------------------------------+-----------------------------------+
--   | Component                         | Identity Mapping                  |
--   +===================================+===================================+
--   | @components.r@                    | @VK_COMPONENT_SWIZZLE_R@          |
--   +-----------------------------------+-----------------------------------+
--   | @components.g@                    | @VK_COMPONENT_SWIZZLE_G@          |
--   +-----------------------------------+-----------------------------------+
--   | @components.b@                    | @VK_COMPONENT_SWIZZLE_B@          |
--   +-----------------------------------+-----------------------------------+
--   | @components.a@                    | @VK_COMPONENT_SWIZZLE_A@          |
--   +-----------------------------------+-----------------------------------+
--   
--   Component Mappings Equivalent To @VK_COMPONENT_SWIZZLE_IDENTITY@
--

-- --

Description

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the image -- view.

-- --

imageView is the image view to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to imageView -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- imageView was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- imageView was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If imageView is not VK_NULL_HANDLE, -- imageView must be a valid VkImageView -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If imageView is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to imageView must be externally -- synchronized

-- --

Description

-- --

Valid Usage (Implicit)

-- --

r must be a valid VkComponentSwizzle -- value

-- --

g must be a valid VkComponentSwizzle -- value
b must be a valid VkComponentSwizzle -- value
a must be a valid VkComponentSwizzle -- value

-- --

Description

-- -- The number of mipmap levels and array layers must be a subset -- of the image subresources in the image. If an application wants to use -- all mip levels or layers in an image after the baseMipLevel -- or baseArrayLayer, it can set levelCount and -- layerCount to the special values -- VK_REMAINING_MIP_LEVELS and -- VK_REMAINING_ARRAY_LAYERS without knowing the exact number of -- mip levels or layers. -- -- For cube and cube array image views, the layers of the image view -- starting at baseArrayLayer correspond to faces in the order -- +X, -X, +Y, -Y, +Z, -Z. For cube arrays, each set of six sequential -- layers is a single cube, so the number of cube maps in a cube map -- array view is layerCount / 6, and image array layer -- (baseArrayLayer + i) is face index (i mod 6) of cube i / -- 6. If the number of layers in the view, whether set explicitly in -- layerCount or implied by VK_REMAINING_ARRAY_LAYERS, -- is not a multiple of 6, behavior when indexing the last cube is -- undefined. -- -- aspectMask must be only -- VK_IMAGE_ASPECT_COLOR_BIT, VK_IMAGE_ASPECT_DEPTH_BIT -- or VK_IMAGE_ASPECT_STENCIL_BIT if format is a color, -- depth-only or stencil-only format, respectively, except if -- format is a multi-planar format. If using a -- depth/stencil format with both depth and stencil components, -- aspectMask must include at least one of -- VK_IMAGE_ASPECT_DEPTH_BIT and -- VK_IMAGE_ASPECT_STENCIL_BIT, and can include both. -- -- When the VkImageSubresourceRange structure is used to select -- a subset of the slices of a 3D image’s mip level in order to create a -- 2D or 2D array image view of a 3D image created with -- VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, -- baseArrayLayer and layerCount specify the first -- slice index and the number of slices to include in the created image -- view. Such an image view can be used as a framebuffer -- attachment that refers only to the specified range of slices of the -- selected mip level. However, any layout transitions performed on such -- an attachment view during a render pass instance still apply to the -- entire subresource referenced which includes all the slices of the -- selected mip level. -- -- When using an imageView of a depth/stencil image to populate a -- descriptor set (e.g. for sampling in the shader, or for use as an -- input attachment), the aspectMask must only include -- one bit and selects whether the imageView is used for depth reads -- (i.e. using a floating-point sampler or input attachment in the -- shader) or stencil reads (i.e. using an unsigned integer sampler or -- input attachment in the shader). When an imageView of a depth/stencil -- image is used as a depth/stencil framebuffer attachment, the -- aspectMask is ignored and both depth and stencil image -- subresources are used. -- -- The components member is of type VkComponentMapping, -- and describes a remapping from components of the image to components -- of the vector returned by shader image instructions. This remapping -- must be identity for storage image descriptors, input -- attachment descriptors, framebuffer attachments, and any -- VkImageView used with a combined image sampler that enables -- sampler Y’CBCR conversion. -- -- When creating a VkImageView, if sampler Y’CBCR -- conversion is enabled in the sampler, the aspectMask of a -- subresourceRange used by the VkImageView must -- be VK_IMAGE_ASPECT_COLOR_BIT. -- -- When creating a VkImageView, if sampler Y’CBCR conversion is -- not enabled in the sampler and the image format is -- multi-planar, the image must have been created with -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the -- aspectMask of the VkImageView’s -- subresourceRange must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT or -- VK_IMAGE_ASPECT_PLANE_2_BIT. -- --

Valid Usage

-- --

If levelCount is not VK_REMAINING_MIP_LEVELS, it -- must be greater than 0

-- --

If layerCount is not VK_REMAINING_ARRAY_LAYERS, -- it must be greater than 0
If aspectMask includes -- VK_IMAGE_ASPECT_COLOR_BIT, then it must not include -- any of VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT

-- --

Valid Usage (Implicit)

-- --

aspectMask must be a valid combination of -- VkImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

Description

-- -- If image was created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, and if the -- format of the image is not multi-planar, -- format can be different from the image’s format, but -- if image was created without the -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag and they -- are not equal they must be compatible. Image format -- compatibility is defined in the Format Compatibility Classes -- section. Views of compatible formats will have the same mapping -- between texel coordinates and memory locations irrespective of the -- format, with only the interpretation of the bit pattern -- changing. -- -- Note -- -- Values intended to be used with one view format may not be -- exactly preserved when written or read through a different format. For -- example, an integer value that happens to have the bit pattern of a -- floating point denorm or NaN may be flushed or canonicalized -- when written or read through a view with a floating point format. -- Similarly, a value written through a signed normalized format that has -- a bit pattern exactly equal to -2b may be changed to -2b + 1 as -- described in Conversion from Normalized Fixed-Point to -- Floating-Point. -- -- If image was created with the -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, -- format must be compatible with the image’s -- format as described above, or must be an uncompressed format in -- which case it must be size-compatible with the image’s -- format, as defined for copying data between images In this case -- the resulting image view’s texel dimensions equal the dimensions of -- the selected mip level divided by the compressed texel block size and -- rounded up. -- -- If the image view is to be used with a sampler which supports -- sampler Y’CBCR conversion, an identically defined object -- of type VkSamplerYcbcrConversion to that used to create the -- sampler must be passed to vkCreateImageView in a -- VkSamplerYcbcrConversionInfo added to the pNext chain -- of VkImageViewCreateInfo. -- -- If the image has a multi-planar format and -- subresourceRange.aspectMask is -- VK_IMAGE_ASPECT_COLOR_BIT, format must be -- identical to the image format, and the sampler to be used -- with the image view must enable sampler Y’CBCR -- conversion. -- -- If image was created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and the image has a -- multi-planar format, and if -- subresourceRange.aspectMask is -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT, format must be -- compatible with the corresponding plane of the image, and the -- sampler to be used with the image view must not enable -- sampler Y’CBCR conversion. The width and -- height of the single-plane image view must be derived -- from the multi-planar image’s dimensions in the manner listed for -- plane compatibility for the plane. -- -- Any view of an image plane will have the same mapping between texel -- coordinates and memory locations as used by the channels of the color -- aspect, subject to the formulae relating texel coordinates to -- lower-resolution planes as described in Chroma Reconstruction. -- That is, if an R or B plane has a reduced resolution relative to the G -- plane of the multi-planar image, the image view operates using the -- (uplane, vplane) unnormalized coordinates of the -- reduced-resolution plane, and these coordinates access the same memory -- locations as the (ucolor, vcolor) unnormalized -- coordinates of the color aspect for which chroma reconstruction -- operations operate on the same (uplane, vplane) or -- (iplane, jplane) coordinates. -- --

--   +---------+------------------------+-----------------------------------+
--   | Dim,    | Image parameters       | View parameters                   |
--   | Arrayed |                        |                                   |
--   | ,       |                        |                                   |
--   | MS      |                        |                                   |
--   +=========+========================+===================================+
--   |         | @imageType@ =          | @baseArrayLayer@, @layerCount@,   |
--   |         | ci.@imageType@         | and @levelCount@ are members of   |
--   |         | @width@ =              | the @subresourceRange@ member.    |
--   |         | ci.@extent.width@      |                                   |
--   |         | @height@ =             |                                   |
--   |         | ci.@extent.height@     |                                   |
--   |         | @depth@ =              |                                   |
--   |         | ci.@extent.depth@      |                                   |
--   |         | @arrayLayers@ =        |                                   |
--   |         | ci.@arrayLayers@       |                                   |
--   |         | @samples@ =            |                                   |
--   |         | ci.@samples@           |                                   |
--   |         | @flags@ = ci.@flags@   |                                   |
--   |         | where ci is the        |                                   |
--   |         | 'Graphics.Vulkan.Core1 |                                   |
--   |         | 0.Image.VkImageCreateI |                                   |
--   |         | nfo'                   |                                   |
--   |         | used to create         |                                   |
--   |         | @image@.               |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __1D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_1D@     | @VK_IMAGE_VIEW_TYPE_1D@           |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ = 1           | @layerCount@ = 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __1D,   | @imageType@ =          | @viewType@ =                      |
--   | 1, 0__  | @VK_IMAGE_TYPE_1D@     | @VK_IMAGE_VIEW_TYPE_1D_ARRAY@     |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ = 1           | @layerCount@ ≥ 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __2D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_2D@           |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ ≥ 1           | @layerCount@ = 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __2D,   | @imageType@ =          | @viewType@ =                      |
--   | 1, 0__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_2D_ARRAY@     |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ ≥ 1           | @layerCount@ ≥ 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __2D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 1__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_2D@           |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ ≥ 1           | @layerCount@ = 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ > 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __2D,   | @imageType@ =          | @viewType@ =                      |
--   | 1, 1__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_2D_ARRAY@     |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ ≥ 1           | @layerCount@ ≥ 1                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 1      |                                   |
--   |         | @samples@ > 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __CUBE, | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_CUBE@         |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ = @width@     | @layerCount@ = 6                  |
--   |         | @depth@ = 1            |                                   |
--   |         | @arrayLayers@ ≥ 6      |                                   |
--   |         | @samples@ = 1          |                                   |
--   |         | @flags@ includes       |                                   |
--   |         | @VK_IMAGE_CREATE_CUBE_ |                                   |
--   |         | COMPATIBLE_BIT@        |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __CUBE, | @imageType@ =          | @viewType@ =                      |
--   | 1, 0__  | @VK_IMAGE_TYPE_2D@     | @VK_IMAGE_VIEW_TYPE_CUBE_ARRAY@   |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ ≥ 0              |
--   |         | @height@ = width       | @layerCount@ = 6 × /N/, /N/ ≥ 1   |
--   |         | @depth@ = 1            |                                   |
--   |         | /N/ ≥ 1                |                                   |
--   |         | @arrayLayers@ ≥ 6 ×    |                                   |
--   |         | /N/                    |                                   |
--   |         | @samples@ = 1          |                                   |
--   |         | @flags@ includes       |                                   |
--   |         | @VK_IMAGE_CREATE_CUBE_ |                                   |
--   |         | COMPATIBLE_BIT@        |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __3D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_3D@     | @VK_IMAGE_VIEW_TYPE_3D@           |
--   |         | @width@ ≥ 1            | @baseArrayLayer@ = 0              |
--   |         | @height@ ≥ 1           | @layerCount@ = 1                  |
--   |         | @depth@ ≥ 1            |                                   |
--   |         | @arrayLayers@ = 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __3D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_3D@     | @VK_IMAGE_VIEW_TYPE_2D@           |
--   |         | @width@ ≥ 1            | @levelCount@ = 1                  |
--   |         | @height@ ≥ 1           | @baseArrayLayer@ ≥ 0              |
--   |         | @depth@ ≥ 1            | @layerCount@ = 1                  |
--   |         | @arrayLayers@ = 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   |         | @flags@ includes       |                                   |
--   |         | @VK_IMAGE_CREATE_2D_AR |                                   |
--   |         | RAY_COMPATIBLE_BIT@    |                                   |
--   |         | @flags@ does not       |                                   |
--   |         | include                |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_BINDING_BIT@,        |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_RESIDENCY_BIT@,      |                                   |
--   |         | and                    |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_ALIASED_BIT@         |                                   |
--   +---------+------------------------+-----------------------------------+
--   | __3D,   | @imageType@ =          | @viewType@ =                      |
--   | 0, 0__  | @VK_IMAGE_TYPE_3D@     | @VK_IMAGE_VIEW_TYPE_2D_ARRAY@     |
--   |         | @width@ ≥ 1            | @levelCount@ = 1                  |
--   |         | @height@ ≥ 1           | @baseArrayLayer@ ≥ 0              |
--   |         | @depth@ ≥ 1            | @layerCount@ ≥ 1                  |
--   |         | @arrayLayers@ = 1      |                                   |
--   |         | @samples@ = 1          |                                   |
--   |         | @flags@ includes       |                                   |
--   |         | @VK_IMAGE_CREATE_2D_AR |                                   |
--   |         | RAY_COMPATIBLE_BIT@    |                                   |
--   |         | @flags@ does not       |                                   |
--   |         | include                |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_BINDING_BIT@,        |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_RESIDENCY_BIT@,      |                                   |
--   |         | and                    |                                   |
--   |         | @VK_IMAGE_CREATE_SPARS |                                   |
--   |         | E_ALIASED_BIT@         |                                   |
--   +---------+------------------------+-----------------------------------+
--   
--   Image and image view parameter compatibility requirements
--

-- --

Valid Usage

-- --

If image was not created with -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT then viewType -- must not be VK_IMAGE_VIEW_TYPE_CUBE or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY

-- --

If the image cubemap arrays feature is not enabled, -- viewType must not be -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
If image was created with VK_IMAGE_TYPE_3D but -- without VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set then -- viewType must not be VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY
If image was created with -- VK_IMAGE_TILING_LINEAR, format must be format -- that has at least one supported feature bit present in the value of -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
image must have been created with a usage -- value containing at least one of VK_IMAGE_USAGE_SAMPLED_BIT, -- VK_IMAGE_USAGE_STORAGE_BIT, -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
If image was created with VK_IMAGE_TILING_LINEAR -- and usage contains VK_IMAGE_USAGE_SAMPLED_BIT, -- format must be supported for sampled images, as -- specified by the VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT flag in -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with VK_IMAGE_TILING_LINEAR -- and usage contains VK_IMAGE_USAGE_STORAGE_BIT, -- format must be supported for storage images, as -- specified by the VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT flag in -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with VK_IMAGE_TILING_LINEAR -- and usage contains -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, format -- must be supported for color attachments, as specified by the -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with VK_IMAGE_TILING_LINEAR -- and usage contains -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, format -- must be supported for depth/stencil attachments, as specified -- by the VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT flag in -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with -- VK_IMAGE_TILING_OPTIMAL, format must be -- format that has at least one supported feature bit present in the -- value of VkFormatProperties::optimalTilingFeatures -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format
If image was created with -- VK_IMAGE_TILING_OPTIMAL and usage contains -- VK_IMAGE_USAGE_SAMPLED_BIT, format must be -- supported for sampled images, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT flag in -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with -- VK_IMAGE_TILING_OPTIMAL and usage contains -- VK_IMAGE_USAGE_STORAGE_BIT, format must be -- supported for storage images, as specified by the -- VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT flag in -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with -- VK_IMAGE_TILING_OPTIMAL and usage contains -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, format -- must be supported for color attachments, as specified by the -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties with the same value of -- format
If image was created with -- VK_IMAGE_TILING_OPTIMAL and usage contains -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, format -- must be supported for depth/stencil attachments, as specified -- by the VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT flag in -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties with the same value of -- format
subresourceRange.baseMipLevel must be less than -- the mipLevels specified in VkImageCreateInfo when -- image was created
If subresourceRange.levelCount is not -- VK_REMAINING_MIP_LEVELS, -- subresourceRange.baseMipLevel + -- subresourceRange.levelCount must be less than or equal -- to the mipLevels specified in VkImageCreateInfo when -- image was created
If image is not a 3D image created with -- VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or -- viewType is not VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange::baseArrayLayer must be less -- than the arrayLayers specified in VkImageCreateInfo -- when image was created
If subresourceRange::layerCount is not -- VK_REMAINING_ARRAY_LAYERS, image is not a 3D image -- created with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or -- viewType is not VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange::layerCount must be non-zero -- and subresourceRange::baseArrayLayer + -- subresourceRange::layerCount must be less -- than or equal to the arrayLayers specified in -- VkImageCreateInfo when image was created
If image is a 3D image created with -- VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and -- viewType is VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange::baseArrayLayer must be less -- than the extent.depth specified in VkImageCreateInfo -- when image was created
If subresourceRange::layerCount is not -- VK_REMAINING_ARRAY_LAYERS, image is a 3D image -- created with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and -- viewType is VK_IMAGE_VIEW_TYPE_2D or -- VK_IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange::layerCount must be non-zero -- and subresourceRange::baseArrayLayer + -- subresourceRange::layerCount must be less -- than or equal to the extent.depth specified in -- VkImageCreateInfo when image was created
If image was created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, format -- must be compatible with the format used to create -- image, as defined in Format Compatibility Classes
If image was created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, but without the -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, and if -- the format of the image is not a multi-planar -- format, format must be compatible with the -- format used to create image, as defined in Format -- Compatibility Classes
If image was created with the -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, -- format must be compatible with, or must be an -- uncompressed format that is size-compatible with, the format -- used to create image.
If image was created with the -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, the -- levelCount and layerCount members of -- subresourceRange must both be 1.
If a VkImageFormatListCreateInfoKHR structure was -- included in the pNext chain of the VkImageCreateInfo -- struct used when creating image and the -- viewFormatCount field of -- VkImageFormatListCreateInfoKHR is not zero then -- format must be one of the formats in -- VkImageFormatListCreateInfoKHR::pViewFormats.
If image was created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, if the -- format of the image is a multi-planar format, -- and if subresourceRange.aspectMask is one of -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT, then format must -- be compatible with the VkFormat for the plane of the -- image format indicated by -- subresourceRange.aspectMask, as defined in -- {html_spec_relative}#features-formats-compatible-planes
If image was not created with the -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, or if the -- format of the image is a multi-planar format -- and if subresourceRange.aspectMask is -- VK_IMAGE_ASPECT_COLOR_BIT, format must be -- identical to the format used to create image
If image is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
subresourceRange and viewType must be -- compatible with the image, as described in the compatibility -- table
If image has an external -- format:
- format must be -- VK_FORMAT_UNDEFINED
- The pNext chain must -- contain an instance of VkSamplerYcbcrConversionInfo with a -- conversion object created with the same external format as -- image
- All members of components must be -- VK_COMPONENT_SWIZZLE_IDENTITY

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO

-- --

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 VkImageViewUsageCreateInfo or -- VkSamplerYcbcrConversionInfo
Each sType member in the pNext chain must -- be unique
flags must be 0
image must be a valid VkImage handle
viewType must be a valid VkImageViewType -- value
format must be a valid VkFormat value
components must be a valid -- VkComponentMapping structure
subresourceRange must be a valid -- VkImageSubresourceRange structure

-- --

Description

-- --

VK_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY specifies -- that the input values to the conversion are unmodified.

-- --

VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_IDENTITY -- specifies no model conversion but the inputs are range expanded as for -- Y’CBCR.
VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_709 specifies the -- color model conversion from Y’CBCR to R’G’B' defined in BT.709 and -- described in the “BT.709 Y’CBCR conversion” section of the Khronos -- Data Format Specification.
VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_601 specifies the -- color model conversion from Y’CBCR to R’G’B' defined in BT.601 and -- described in the “BT.601 Y’CBCR conversion” section of the Khronos -- Data Format Specification.
VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_2020 specifies -- the color model conversion from Y’CBCR to R’G’B' defined in BT.2020 -- and described in the “BT.2020 Y’CBCR conversion” section of the -- Khronos Data Format Specification.

-- -- In the VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_* color -- models, for the input to the sampler Y’CBCR range expansion and model -- conversion: -- --

the Y (Y' luma) channel corresponds to the G channel of an RGB -- image.
the CB (CB or “U” blue color difference) channel corresponds to -- the B channel of an RGB image.
the CR (CR or “V” red color difference) channel corresponds to the -- R channel of an RGB image.
the alpha channel, if present, is not modified by color model -- conversion.

-- -- These rules reflect the mapping of channels after the channel swizzle -- operation (controlled by -- VkSamplerYcbcrConversionCreateInfo::components). -- -- Note -- -- For example, an “YUVA” 32-bit format comprising four 8-bit channels -- can be implemented as VK_FORMAT_R8G8B8A8_UNORM with a -- component mapping: -- --

components.a = -- VK_COMPONENT_SWIZZLE_IDENTITY
components.r = VK_COMPONENT_SWIZZLE_B
components.g = VK_COMPONENT_SWIZZLE_R
components.b = VK_COMPONENT_SWIZZLE_G

-- --

Description

-- --

VK_SAMPLER_YCBCR_RANGE_ITU_FULL specifies that the full -- range of the encoded values are valid and interpreted according to the -- ITU “full range” quantization rules.

-- --

VK_SAMPLER_YCBCR_RANGE_ITU_NARROW specifies that headroom -- and foot room are reserved in the numerical range of encoded values, -- and the remaining values are expanded according to the ITU “narrow -- range” quantization rules.

-- -- The formulae for these conversions is described in the Sampler -- Y’CBCR Range Expansion section of the Image Operations -- chapter. -- -- No range modification takes place if ycbcrModel is -- VK_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY; the -- ycbcrRange field of -- VkSamplerYcbcrConversionCreateInfo is ignored in this case. -- --

Description

-- --

Parameters

-- --

device is the logical device that creates the sampler -- Y’CBCR conversion.

-- --

pCreateInfo is a pointer to an instance of the -- VkSamplerYcbcrConversionCreateInfo specifying the requested -- sampler Y’CBCR conversion.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pYcbcrConversion points to a -- VkSamplerYcbcrConversion handle in which the resulting sampler -- Y’CBCR conversion is returned.

-- --

Description

-- -- The interpretation of the configured sampler Y’CBCR conversion is -- described in more detail in the description of sampler Y’CBCR -- conversion in the Image Operations chapter. -- --

Valid Usage

-- --

The sampler Y’CBCR conversion feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkSamplerYcbcrConversionCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pYcbcrConversion must be a valid pointer to a -- VkSamplerYcbcrConversion handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the Y’CBCR -- conversion.

-- --

ycbcrConversion is the conversion to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If ycbcrConversion is not VK_NULL_HANDLE, -- ycbcrConversion must be a valid -- VkSamplerYcbcrConversion handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If ycbcrConversion is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to ycbcrConversion must be externally -- synchronized

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_INFO

-- --

conversion must be a valid -- VkSamplerYcbcrConversion handle

-- --

Description

-- -- Note -- -- Setting forceExplicitReconstruction to VK_TRUE -- may have a performance penalty on implementations where -- explicit reconstruction is not the default mode of operation. -- -- If the pNext chain has an instance of -- VkExternalFormatANDROID with non-zero externalFormat -- member, the sampler Y’CBCR conversion object represents an external -- format conversion, and format must be -- VK_FORMAT_UNDEFINED. Such conversions must only be -- used to sample image views with a matching external format. -- When creating an external format conversion, the value of -- components is ignored. -- --

Valid Usage

-- --

If an external format conversion is being created, format -- must be VK_FORMAT_UNDEFINED, otherwise it must -- not be VK_FORMAT_UNDEFINED.

-- --

format must support -- VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or -- VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT
If the format does not support -- VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT, -- xChromaOffset and yChromaOffset must not be -- VK_CHROMA_LOCATION_COSITED_EVEN
If the format does not support -- VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT, -- xChromaOffset and yChromaOffset must not be -- VK_CHROMA_LOCATION_MIDPOINT
format must represent unsigned normalized values -- (i.e. the format must be a UNORM format)
If the format has a _422 or _420 -- suffix:
- components.g must be -- VK_COMPONENT_SWIZZLE_IDENTITY
- components.a -- must be VK_COMPONENT_SWIZZLE_IDENTITY, -- VK_COMPONENT_SWIZZLE_ONE, or -- VK_COMPONENT_SWIZZLE_ZERO
- components.r -- must be VK_COMPONENT_SWIZZLE_IDENTITY or -- VK_COMPONENT_SWIZZLE_B
- components.b -- must be VK_COMPONENT_SWIZZLE_IDENTITY or -- VK_COMPONENT_SWIZZLE_R
- If either -- components.r or components.b is -- VK_COMPONENT_SWIZZLE_IDENTITY, both values must be -- VK_COMPONENT_SWIZZLE_IDENTITY
If ycbcrModel is not -- VK_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY, then -- components.r, components.g, and -- components.b must correspond to channels of the -- format; that is, components.r, -- components.g, and components.b must not be -- VK_COMPONENT_SWIZZLE_ZERO or -- VK_COMPONENT_SWIZZLE_ONE, and must not correspond to a -- channel which contains zero or one as a consequence of conversion -- to RGBA
If the format does not support -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT, -- forceExplicitReconstruction must be FALSE
If the format does not support -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT, -- chromaFilter must be VK_FILTER_NEAREST

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of VkExternalFormatANDROID
format must be a valid VkFormat value
ycbcrModel must be a valid -- VkSamplerYcbcrModelConversion value
ycbcrRange must be a valid -- VkSamplerYcbcrRange value
components must be a valid -- VkComponentMapping structure
xChromaOffset must be a valid -- VkChromaLocation value
yChromaOffset must be a valid -- VkChromaLocation value
chromaFilter must be a valid VkFilter -- value

-- -- If chromaFilter is VK_FILTER_NEAREST, chroma samples -- are reconstructed to luma channel resolution using nearest-neighbour -- sampling. Otherwise, chroma samples are reconstructed using -- interpolation. More details can be found in the description of -- sampler Y’CBCR conversion in the Image Operations chapter. -- --

Description

-- --

Valid Usage

-- --

planeAspect must be a single valid plane aspect -- for the image format (that is, planeAspect must be -- VK_IMAGE_ASPECT_PLANE_0_BIT or -- VK_IMAGE_ASPECT_PLANE_1_BIT for “_2PLANE” formats -- and planeAspect must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT for “_3PLANE” -- formats)

-- --

A single call to vkBindImageMemory2 must bind all or -- none of the planes of an image (i.e. bindings to all planes of an -- image must be made in a single vkBindImageMemory2 call), -- as separate bindings

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO

-- --

planeAspect must be a valid -- VkImageAspectFlagBits value

-- --

Description

-- --

Valid Usage

-- --

planeAspect must be an aspect that exists in the -- format; that is, for a two-plane image planeAspect -- must be VK_IMAGE_ASPECT_PLANE_0_BIT or -- VK_IMAGE_ASPECT_PLANE_1_BIT, and for a three-plane image -- planeAspect must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT or -- VK_IMAGE_ASPECT_PLANE_2_BIT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFO

-- --

planeAspect must be a valid -- VkImageAspectFlagBits value

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- fence.

-- --

fence is the handle of the fence to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All queue submission commands that refer to fence -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- fence was created, a compatible set of callbacks must -- be provided here
If no VkAllocationCallbacks were provided when -- fence was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If fence is not VK_NULL_HANDLE, fence -- must be a valid VkFence handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If fence is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to fence must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the fences.

-- --

fenceCount is the number of fences to reset.
pFences is a pointer to an array of fence handles to -- reset.

-- --

Description

-- -- If any member of pFences currently has its payload -- imported with temporary permanence, that fence’s prior permanent -- payload is first restored. The remaining operations described -- therefore operate on the restored payload. -- -- When vkResetFences is executed on the host, it defines a /fence -- unsignal operation/ for each fence, which resets the fence to the -- unsignaled state. -- -- If any member of pFences is already in the unsignaled state -- when vkResetFences is executed, then vkResetFences has -- no effect on that fence. -- --

Valid Usage

-- --

Each element of pFences must not be currently -- associated with any queue command that has not yet completed execution -- on that queue

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pFences must be a valid pointer to an array of -- fenceCount valid VkFence handles
fenceCount must be greater than 0
Each element of pFences must have been created, -- allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to each member of pFences must be -- externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the fence.

-- --

fence is the handle of the fence to query.

-- --

Description

-- -- Upon success, vkGetFenceStatus returns the status of the -- fence object, with the following return codes: -- --

--   +-----------------------------------+-----------------------------------+
--   | Status                            | Meaning                           |
--   +===================================+===================================+
--   | @VK_SUCCESS@                      | The fence specified by @fence@ is |
--   |                                   | signaled.                         |
--   +-----------------------------------+-----------------------------------+
--   | @VK_NOT_READY@                    | The fence specified by @fence@ is |
--   |                                   | unsignaled.                       |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ERROR_DEVICE_LOST@            | The device has been lost. See     |
--   |                                   | <{html_spec_relative}#devsandqueu |
--   |                                   | es-lost-device Lost Device>.      |
--   +-----------------------------------+-----------------------------------+
--   
--   Fence Object Status Codes
--

-- -- If a queue submission command is pending execution, then the -- value returned by this command may immediately be out of date. -- -- If the device has been lost (see Lost Device), -- vkGetFenceStatus may return any of the above status -- codes. If the device has been lost and vkGetFenceStatus is -- called repeatedly, it will eventually return either -- VK_SUCCESS or VK_ERROR_DEVICE_LOST. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

fence must be a valid VkFence handle
fence must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_NOT_READY
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Parameters

-- --

device is the logical device that owns the fences.

-- --

fenceCount is the number of fences to wait on.
pFences is a pointer to an array of fenceCount -- fence handles.
waitAll is the condition that must be satisfied to -- successfully unblock the wait. If waitAll is -- VK_TRUE, then the condition is that all fences in -- pFences are signaled. Otherwise, the condition is that at -- least one fence in pFences is signaled.
timeout is the timeout period in units of nanoseconds. -- timeout is adjusted to the closest value allowed by the -- implementation-dependent timeout accuracy, which may be -- substantially longer than one nanosecond, and may be longer -- than the requested period.

-- --

Description

-- -- If the condition is satisfied when vkWaitForFences is called, -- then vkWaitForFences returns immediately. If the condition is -- not satisfied at the time vkWaitForFences is called, then -- vkWaitForFences will block and wait up to timeout -- nanoseconds for the condition to become satisfied. -- -- If timeout is zero, then vkWaitForFences does not -- wait, but simply returns the current state of the fences. -- VK_TIMEOUT will be returned in this case if the condition is -- not satisfied, even though no actual wait was performed. -- -- If the specified timeout period expires before the condition is -- satisfied, vkWaitForFences returns VK_TIMEOUT. If -- the condition is satisfied before timeout nanoseconds has -- expired, vkWaitForFences returns VK_SUCCESS. -- -- If device loss occurs (see Lost Device) before the timeout has -- expired, vkWaitForFences must return in finite time -- with either VK_SUCCESS or VK_ERROR_DEVICE_LOST. -- -- Note -- -- While we guarantee that vkWaitForFences must return in -- finite time, no guarantees are made that it returns immediately upon -- device loss. However, the client can reasonably expect that the delay -- will be on the order of seconds and that calling -- vkWaitForFences will not result in a permanently (or -- seemingly permanently) dead process. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pFences must be a valid pointer to an array of -- fenceCount valid VkFence handles
fenceCount must be greater than 0
Each element of pFences must have been created, -- allocated, or retrieved from device

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_TIMEOUT
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_FENCE_CREATE_INFO

-- --

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 VkExportFenceCreateInfo or -- VkExportFenceWin32HandleInfoKHR
Each sType member in the pNext chain must -- be unique
flags must be a valid combination of -- VkFenceCreateFlagBits values

-- --

Description

-- -- VkFenceCreateFlags is a bitmask type for setting a mask of -- zero or more VkFenceCreateFlagBits. -- --

Parameters

-- --

pLayerName is either NULL or a pointer to a -- null-terminated UTF-8 string naming the layer to retrieve extensions -- from.

-- --

pPropertyCount is a pointer to an integer related to the -- number of extension properties available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of VkExtensionProperties structures.

-- --

Description

-- -- When pLayerName parameter is NULL, only extensions -- provided by the Vulkan implementation or by implicitly enabled layers -- are returned. When pLayerName is the name of a layer, the -- instance extensions provided by that layer are returned. -- -- If pProperties is NULL, then the number of -- extensions properties available is returned in -- pPropertyCount. Otherwise, pPropertyCount -- must point to a variable set by the user to the number of -- elements in the pProperties array, and on return the variable -- is overwritten with the number of structures actually written to -- pProperties. If pPropertyCount is less than the -- number of extension properties available, at most -- pPropertyCount structures will be written. If -- pPropertyCount is smaller than the number of extensions -- available, VK_INCOMPLETE will be returned instead of -- VK_SUCCESS, to indicate that not all the available properties -- were returned. -- -- Because the list of available layers may change externally between -- calls to vkEnumerateInstanceExtensionProperties, two calls -- may retrieve different results if a pLayerName is available -- in one call but not in another. The extensions supported by a layer -- may also change between two calls, e.g. if the layer implementation is -- replaced by a different version between those calls. -- --

Valid Usage (Implicit)

-- --

If pLayerName is not NULL, pLayerName -- must be a null-terminated UTF-8 string

-- --

pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkExtensionProperties structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_LAYER_NOT_PRESENT
```

-- --

Parameters

-- --

physicalDevice is the physical device that will be -- queried.

-- --

pLayerName is either NULL or a pointer to a -- null-terminated UTF-8 string naming the layer to retrieve extensions -- from.
pPropertyCount is a pointer to an integer related to the -- number of extension properties available or queried, and is treated in -- the same fashion as the -- vkEnumerateInstanceExtensionProperties::pPropertyCount -- parameter.
pProperties is either NULL or a pointer to an -- array of VkExtensionProperties structures.

-- --

Description

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

If pLayerName is not NULL, pLayerName -- must be a null-terminated UTF-8 string
pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkExtensionProperties structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_LAYER_NOT_PRESENT
```

-- --

Description

-- --

Parameters

-- --

pPropertyCount is a pointer to an integer related to the -- number of layer properties available or queried, as described -- below.

-- --

pProperties is either NULL or a pointer to an -- array of VkLayerProperties structures.

-- --

Description

-- -- If pProperties is NULL, then the number of layer -- properties available is returned in pPropertyCount. -- Otherwise, pPropertyCount must point to a variable set -- by the user to the number of elements in the pProperties -- array, and on return the variable is overwritten with the number of -- structures actually written to pProperties. If -- pPropertyCount is less than the number of layer properties -- available, at most pPropertyCount structures will be written. -- If pPropertyCount is smaller than the number of layers -- available, VK_INCOMPLETE will be returned instead of -- VK_SUCCESS, to indicate that not all the available layer -- properties were returned. -- -- The list of available layers may change at any time due to actions -- outside of the Vulkan implementation, so two calls to -- vkEnumerateInstanceLayerProperties with the same parameters -- may return different results, or retrieve different -- pPropertyCount values or pProperties contents. Once -- an instance has been created, the layers enabled for that instance -- will continue to be enabled and valid for the lifetime of that -- instance, even if some of them become unavailable for future -- instances. -- --

Valid Usage (Implicit)

-- --

pPropertyCount must be a valid pointer to a -- uint32_t value

-- --

If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkLayerProperties structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

pPropertyCount is a pointer to an integer related to the -- number of layer properties available or queried.

-- --

pProperties is either NULL or a pointer to an -- array of VkLayerProperties structures.

-- --

Description

-- -- If pProperties is NULL, then the number of layer -- properties available is returned in pPropertyCount. -- Otherwise, pPropertyCount must point to a variable set -- by the user to the number of elements in the pProperties -- array, and on return the variable is overwritten with the number of -- structures actually written to pProperties. If -- pPropertyCount is less than the number of layer properties -- available, at most pPropertyCount structures will be written. -- If pPropertyCount is smaller than the number of layers -- available, VK_INCOMPLETE will be returned instead of -- VK_SUCCESS, to indicate that not all the available layer -- properties were returned. -- -- The list of layers enumerated by -- vkEnumerateDeviceLayerProperties must be exactly the -- sequence of layers enabled for the instance. The members of -- VkLayerProperties for each enumerated layer must be -- the same as the properties when the layer was enumerated by -- vkEnumerateInstanceLayerProperties. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pPropertyCount must be a valid pointer to a -- uint32_t value
If the value referenced by pPropertyCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pPropertyCount VkLayerProperties structures

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- event.

-- --

event is the handle of the event to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to event must -- have completed execution

-- --

If VkAllocationCallbacks were provided when -- event was created, a compatible set of callbacks must -- be provided here
If no VkAllocationCallbacks were provided when -- event was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If event is not VK_NULL_HANDLE, event -- must be a valid VkEvent handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If event is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to event must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the event.

-- --

event is the handle of the event to query.

-- --

Description

-- -- Upon success, vkGetEventStatus returns the state of the event -- object with the following return codes: -- --

--   +-----------------------------------+-----------------------------------+
--   | Status                            | Meaning                           |
--   +===================================+===================================+
--   | @VK_EVENT_SET@                    | The event specified by @event@ is |
--   |                                   | signaled.                         |
--   +-----------------------------------+-----------------------------------+
--   | @VK_EVENT_RESET@                  | The event specified by @event@ is |
--   |                                   | unsignaled.                       |
--   +-----------------------------------+-----------------------------------+
--   
--   Event Object Status Codes
--

-- -- If a vkCmdSetEvent or vkCmdResetEvent command is in -- a command buffer that is in the pending state, then the value -- returned by this command may immediately be out of date. -- -- The state of an event can be updated by the host. The state of -- the event is immediately changed, and subsequent calls to -- vkGetEventStatus will return the new state. If an event is -- already in the requested state, then updating it to the same state has -- no effect. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

event must be a valid VkEvent handle
event must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success - -- VK_EVENT_SET
- ```
VK_EVENT_RESET
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Parameters

-- --

device is the logical device that owns the event.

-- --

event is the event to set.

-- --

Description

-- -- When vkSetEvent is executed on the host, it defines an /event -- signal operation/ which sets the event to the signaled state. -- -- If event is already in the signaled state when -- vkSetEvent is executed, then vkSetEvent has no effect, -- and no event signal operation occurs. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

event must be a valid VkEvent handle
event must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to event must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the event.

-- --

event is the event to reset.

-- --

Description

-- -- When vkResetEvent is executed on the host, it defines an /event -- unsignal operation/ which resets the event to the unsignaled state. -- -- If event is already in the unsignaled state when -- vkResetEvent is executed, then vkResetEvent has no -- effect, and no event unsignal operation occurs. -- --

Valid Usage

-- --

event must not be waited on by a -- vkCmdWaitEvents command that is currently executing

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

event must be a valid VkEvent handle
event must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to event must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_EVENT_CREATE_INFO

-- --

pNext must be NULL
flags must be 0

-- --

Description

-- -- VkDeviceCreateFlags is a bitmask type for setting a mask, but -- is currently reserved for future use. -- --

Parameters

-- --

physicalDevice must be one of the device handles -- returned from a call to vkEnumeratePhysicalDevices (see -- Physical Device Enumeration).

-- --

pCreateInfo is a pointer to a VkDeviceCreateInfo -- structure containing information about how to create the device.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDevice points to a handle in which the created -- VkDevice is returned.

-- --

Description

-- -- vkCreateDevice verifies that extensions and features -- requested in the ppEnabledExtensionNames and -- pEnabledFeatures members of pCreateInfo, -- respectively, are supported by the implementation. If any requested -- extension is not supported, vkCreateDevice must return -- VK_ERROR_EXTENSION_NOT_PRESENT. If any requested feature is -- not supported, vkCreateDevice must return -- VK_ERROR_FEATURE_NOT_PRESENT. Support for extensions -- can be checked before creating a device by querying -- vkEnumerateDeviceExtensionProperties. Support for features -- can similarly be checked by querying -- vkGetPhysicalDeviceFeatures. -- -- After verifying and enabling the extensions the VkDevice -- object is created and returned to the application. If a requested -- extension is only supported by a layer, both the layer and the -- extension need to be specified at vkCreateInstance time for -- the creation to succeed. -- -- Multiple logical devices can be created from the same physical -- device. Logical device creation may fail due to lack of -- device-specific resources (in addition to the other errors). If that -- occurs, vkCreateDevice will return -- VK_ERROR_TOO_MANY_OBJECTS. -- --

Valid Usage

-- --

All required extensions for each extension in the -- VkDeviceCreateInfo::ppEnabledExtensionNames list -- must also be present in that list.

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkDeviceCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pDevice must be a valid pointer to a -- VkDevice handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INITIALIZATION_FAILED
```
```
VK_ERROR_EXTENSION_NOT_PRESENT
```
```
VK_ERROR_FEATURE_NOT_PRESENT
```
```
VK_ERROR_TOO_MANY_OBJECTS
```
```
VK_ERROR_DEVICE_LOST
```

-- --

Parameters

-- --

device is the logical device to destroy.

-- --

pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- -- To ensure that no work is active on the device, -- vkDeviceWaitIdle can be used to gate the destruction of -- the device. Prior to destroying a device, an application is -- responsible for destroying/freeing any Vulkan objects that were -- created using that device as the first parameter of the corresponding -- vkCreate* or vkAllocate* command. -- -- Note -- -- The lifetime of each of these objects is bound by the lifetime of the -- VkDevice object. Therefore, to avoid resource leaks, it is -- critical that an application explicitly free all of these resources -- prior to calling vkDestroyDevice. -- --

Valid Usage

-- --

All child objects created on device must have been -- destroyed prior to destroying device

-- --

If VkAllocationCallbacks were provided when -- device was created, a compatible set of callbacks must -- be provided here
If no VkAllocationCallbacks were provided when -- device was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

If device is not NULL, device -- must be a valid VkDevice handle

-- --

If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure

-- --

Host Synchronization

-- --

Host access to device must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

queueFamilyIndex must be less than -- pQueueFamilyPropertyCount returned by -- vkGetPhysicalDeviceQueueFamilyProperties

-- --

queueCount must be less than or equal to the -- queueCount member of the VkQueueFamilyProperties -- structure, as returned by -- vkGetPhysicalDeviceQueueFamilyProperties in the -- pQueueFamilyProperties[queueFamilyIndex]
Each element of pQueuePriorities must be between -- 0.0 and 1.0 inclusive

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of VkDeviceQueueGlobalPriorityCreateInfoEXT
flags must be a valid combination of -- VkDeviceQueueCreateFlagBits values
pQueuePriorities must be a valid pointer to an -- array of queueCount float values
queueCount must be greater than 0

-- --

Description

-- --

Valid Usage

-- --

The queueFamilyIndex member of each element of -- pQueueCreateInfos must be unique within -- pQueueCreateInfos

-- --

If the pNext chain includes a -- VkPhysicalDeviceFeatures2 structure, then -- pEnabledFeatures must be NULL
ppEnabledExtensionNames must not contain both -- {html_spec_relative}#VK_KHR_maintenance1 and -- {html_spec_relative}#VK_AMD_negative_viewport_height

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO

-- --

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 VkDeviceGroupDeviceCreateInfo, -- VkPhysicalDevice16BitStorageFeatures, -- VkPhysicalDeviceDescriptorIndexingFeaturesEXT, -- VkPhysicalDeviceFeatures2, -- VkPhysicalDeviceMultiviewFeatures, -- VkPhysicalDeviceProtectedMemoryFeatures, -- VkPhysicalDeviceSamplerYcbcrConversionFeatures, or -- VkPhysicalDeviceVariablePointerFeatures
Each sType member in the pNext chain must -- be unique
flags must be 0
pQueueCreateInfos must be a valid pointer to an -- array of queueCreateInfoCount valid -- VkDeviceQueueCreateInfo structures
If enabledLayerCount is not 0, -- ppEnabledLayerNames must be a valid pointer to an -- array of enabledLayerCount null-terminated UTF-8 strings
If enabledExtensionCount is not 0, -- ppEnabledExtensionNames must be a valid pointer to an -- array of enabledExtensionCount null-terminated UTF-8 -- strings
If pEnabledFeatures is not NULL, -- pEnabledFeatures must be a valid pointer to a valid -- VkPhysicalDeviceFeatures structure
queueCreateInfoCount must be greater than -- 0

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the command -- pool.

-- --

commandPool is the handle of the command pool to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- -- When a pool is destroyed, all command buffers allocated from the pool -- are freed. -- -- Any primary command buffer allocated from another VkCommandPool -- that is in the recording or executable state and has a -- secondary command buffer allocated from commandPool recorded -- into it, becomes invalid. -- --

Valid Usage

-- --

All VkCommandBuffer objects allocated from -- commandPool must not be in the pending -- state.

-- --

If VkAllocationCallbacks were provided when -- commandPool was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- commandPool was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If commandPool is not VK_NULL_HANDLE, -- commandPool must be a valid VkCommandPool -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If commandPool is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to commandPool must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the command -- pool.

-- --

commandPool is the command pool to reset.
flags is a bitmask of VkCommandPoolResetFlagBits -- controlling the reset operation.

-- --

Description

-- -- Resetting a command pool recycles all of the resources from all of the -- command buffers allocated from the command pool back to the command -- pool. All command buffers that have been allocated from the command -- pool are put in the initial state. -- -- Any primary command buffer allocated from another VkCommandPool -- that is in the recording or executable state and has a -- secondary command buffer allocated from commandPool recorded -- into it, becomes invalid. -- --

Valid Usage

-- --

All VkCommandBuffer objects allocated from -- commandPool must not be in the pending -- state

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

commandPool must be a valid VkCommandPool -- handle
flags must be a valid combination of -- VkCommandPoolResetFlagBits values
commandPool must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to commandPool must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage

-- --

queueFamilyIndex must be the index of a queue -- family available in the calling command’s device -- parameter

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO

-- --

pNext must be NULL
flags must be a valid combination of -- VkCommandPoolCreateFlagBits values

-- --

Description

-- --

device is the logical device that creates the buffer -- view.

-- --

pCreateInfo is a pointer to an instance of the -- VkBufferViewCreateInfo structure containing parameters to be -- used to create the buffer.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pView points to a VkBufferView handle in which -- the resulting buffer view object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkBufferViewCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pView must be a valid pointer to a -- VkBufferView handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the buffer -- view.

-- --

bufferView is the buffer view to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to bufferView -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- bufferView was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- bufferView was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If bufferView is not VK_NULL_HANDLE, -- bufferView must be a valid VkBufferView -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If bufferView is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to bufferView must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

offset must be less than the size of -- buffer

-- --

offset must be a multiple of -- VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
If range is not equal to VK_WHOLE_SIZE, -- range must be greater than 0
If range is not equal to VK_WHOLE_SIZE, -- range must be a multiple of the element size of -- format
If range is not equal to VK_WHOLE_SIZE, -- range divided by the element size of format -- must be less than or equal to -- VkPhysicalDeviceLimits::maxTexelBufferElements
If range is not equal to VK_WHOLE_SIZE, the sum -- of offset and range must be less than or -- equal to the size of buffer
buffer must have been created with a -- usage value containing at least one of -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT
If buffer was created with usage containing -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format -- must be supported for uniform texel buffers, as specified by -- the VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT flag in -- VkFormatProperties::bufferFeatures returned by -- vkGetPhysicalDeviceFormatProperties
If buffer was created with usage containing -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format -- must be supported for storage texel buffers, as specified by -- the VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT flag in -- VkFormatProperties::bufferFeatures returned by -- vkGetPhysicalDeviceFormatProperties
If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
buffer must be a valid VkBuffer -- handle
format must be a valid VkFormat value

-- --

Description

-- --

VK_SHARING_MODE_EXCLUSIVE specifies that access to any -- range or image subresource of the object will be exclusive to a single -- queue family at a time.

-- --

VK_SHARING_MODE_CONCURRENT specifies that concurrent -- access to any range or image subresource of the object from multiple -- queue families is supported.

-- -- Note -- -- VK_SHARING_MODE_CONCURRENT may result in lower -- performance access to the buffer or image than -- VK_SHARING_MODE_EXCLUSIVE. -- -- Ranges of buffers and image subresources of image objects created -- using VK_SHARING_MODE_EXCLUSIVE must only be accessed -- by queues in the queue family that has ownership of the -- resource. Upon creation, such resources are not owned by any queue -- family; ownership is implicitly acquired upon first use within a -- queue. Once a resource using VK_SHARING_MODE_EXCLUSIVE is -- owned by some queue family, the application must perform a -- queue family ownership transfer to make the memory contents of -- a range or image subresource accessible to a different queue family. -- -- Note -- -- Images still require a layout transition from -- VK_IMAGE_LAYOUT_UNDEFINED or -- VK_IMAGE_LAYOUT_PREINITIALIZED before being used on the first -- queue. -- -- A queue family can take ownership of an image subresource or -- buffer range of a resource created with -- VK_SHARING_MODE_EXCLUSIVE, without an ownership transfer, in -- the same way as for a resource that was just created; however, taking -- ownership in this way has the effect that the contents of the image -- subresource or buffer range are undefined. -- -- Ranges of buffers and image subresources of image objects created -- using VK_SHARING_MODE_CONCURRENT must only be accessed -- by queues from the queue families specified through the -- queueFamilyIndexCount and pQueueFamilyIndices -- members of the corresponding create info structures. -- --

Description

-- --

VK_BUFFER_CREATE_SPARSE_BINDING_BIT specifies that the -- buffer will be backed using sparse memory binding.

-- --

VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT specifies that the -- buffer can be partially backed using sparse memory binding. -- Buffers created with this flag must also be created with the -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT flag.
VK_BUFFER_CREATE_SPARSE_ALIASED_BIT specifies that the -- buffer will be backed using sparse memory binding with memory ranges -- that might also simultaneously be backing another buffer (or another -- portion of the same buffer). Buffers created with this flag -- must also be created with the -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT flag.

-- -- See Sparse Resource Features and Physical Device -- Features for details of the sparse memory features supported on a -- device. -- --

Parameters

-- --

device is the logical device that creates the buffer -- object.

-- --

pCreateInfo is a pointer to an instance of the -- VkBufferCreateInfo structure containing parameters affecting -- creation of the buffer.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pBuffer points to a VkBuffer handle in which the -- resulting buffer object is returned.

-- --

Description

-- --

Valid Usage

-- --

If the flags member of pCreateInfo includes -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT, creating this -- VkBuffer must not cause the total required sparse -- memory for all currently valid sparse resources on the device to -- exceed -- VkPhysicalDeviceLimits::sparseAddressSpaceSize

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkBufferCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pBuffer must be a valid pointer to a -- VkBuffer handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- buffer.

-- --

buffer is the buffer to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to buffer, either -- directly or via a VkBufferView, must have completed -- execution

-- --

If VkAllocationCallbacks were provided when -- buffer was created, a compatible set of callbacks must -- be provided here
If no VkAllocationCallbacks were provided when -- buffer was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If buffer is not VK_NULL_HANDLE, buffer -- must be a valid VkBuffer handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If buffer is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to buffer must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

size must be greater than 0

-- --

If sharingMode is VK_SHARING_MODE_CONCURRENT, -- pQueueFamilyIndices must be a valid pointer to an -- array of queueFamilyIndexCount uint32_t values
If sharingMode is VK_SHARING_MODE_CONCURRENT, -- queueFamilyIndexCount must be greater than -- 1
If sharingMode is VK_SHARING_MODE_CONCURRENT, -- each element of pQueueFamilyIndices must be unique and -- must be less than pQueueFamilyPropertyCount returned -- by either vkGetPhysicalDeviceQueueFamilyProperties or -- vkGetPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
If the sparse bindings feature is not enabled, -- flags must not contain -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT
If the sparse buffer residency feature is not enabled, -- flags must not contain -- VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT
If the sparse aliased residency feature is not enabled, -- flags must not contain -- VK_BUFFER_CREATE_SPARSE_ALIASED_BIT
If flags contains -- VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT or -- VK_BUFFER_CREATE_SPARSE_ALIASED_BIT, it must also -- contain VK_BUFFER_CREATE_SPARSE_BINDING_BIT
If the pNext chain contains an instance of -- VkExternalMemoryBufferCreateInfo, its handleTypes -- member must only contain bits that are also in -- VkExternalBufferProperties::externalMemoryProperties.pname:compatibleHandleTypes, -- as returned by vkGetPhysicalDeviceExternalBufferProperties with -- pExternalBufferInfo->handleType equal to any one -- of the handle types specified in -- VkExternalMemoryBufferCreateInfo::handleTypes
If the pNext chain contains an instance of -- VkDedicatedAllocationBufferCreateInfoNV, and the -- dedicatedAllocation member of the chained structure is -- VK_TRUE, then flags must not include -- VK_BUFFER_CREATE_SPARSE_BINDING_BIT, -- VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or -- VK_BUFFER_CREATE_SPARSE_ALIASED_BIT

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO

-- --

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 -- VkDedicatedAllocationBufferCreateInfoNV or -- VkExternalMemoryBufferCreateInfo
Each sType member in the pNext chain must -- be unique
flags must be a valid combination of -- VkBufferCreateFlagBits values
usage must be a valid combination of -- VkBufferUsageFlagBits values
usage must not be 0
sharingMode must be a valid VkSharingMode -- value

-- --

Description

-- -- VkBufferUsageFlags is a bitmask type for setting a mask of -- zero or more VkBufferUsageFlagBits. -- --

Description

-- -- VkBufferCreateFlags is a bitmask type for setting a mask of -- zero or more VkBufferCreateFlagBits. -- --

Description

-- --

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT specifies a -- POSIX file descriptor handle that has only limited valid usage outside -- of Vulkan and other compatible APIs. It must be compatible with -- the POSIX system calls dup, dup2, close, -- and the non-standard system call dup3. Additionally, it -- must be transportable over a socket using an -- SCM_RIGHTS control message. It owns a reference to the -- underlying memory resource represented by its Vulkan memory -- object.

-- --

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT specifies -- an NT handle that has only limited valid usage outside of Vulkan and -- other compatible APIs. It must be compatible with the functions -- DuplicateHandle, CloseHandle, -- CompareObjectHandles, GetHandleInformation, and -- SetHandleInformation. It owns a reference to the underlying -- memory resource represented by its Vulkan memory object.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT -- specifies a global share handle that has only limited valid usage -- outside of Vulkan and other compatible APIs. It is not compatible with -- any native APIs. It does not own a reference to the underlying memory -- resource represented its Vulkan memory object, and will therefore -- become invalid when all Vulkan memory objects associated with it are -- destroyed.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT -- specifies an NT handle returned by -- IDXGIResource1::CreateSharedHandle referring to a -- Direct3D 10 or 11 texture resource. It owns a reference to the memory -- used by the Direct3D resource.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT -- specifies a global share handle returned by -- IDXGIResource::GetSharedHandle referring to a -- Direct3D 10 or 11 texture resource. It does not own a reference to the -- underlying Direct3D resource, and will therefore become invalid when -- all Vulkan memory objects and Direct3D resources associated with it -- are destroyed.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT specifies -- an NT handle returned by -- ID3D12Device::CreateSharedHandle referring to a -- Direct3D 12 heap resource. It owns a reference to the resources used -- by the Direct3D heap.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT -- specifies an NT handle returned by -- ID3D12Device::CreateSharedHandle referring to a -- Direct3D 12 committed resource. It owns a reference to the memory used -- by the Direct3D resource.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT -- specifies a host pointer returned by a host memory allocation command. -- It does not own a reference to the underlying memory resource, and -- will therefore become invalid if the host memory is freed.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT -- specifies a host pointer to host mapped foreign memory. It does -- not own a reference to the underlying memory resource, and will -- therefore become invalid if the foreign memory is unmapped or -- otherwise becomes no longer available.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT is a file -- descriptor for a Linux dma_buf. It owns a reference to the underlying -- memory resource represented by its Vulkan memory object.
VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- specifies an AHardwareBuffer object defined by the Android -- NDK. See Android Hardware Buffers for more details of this -- handle type.

-- -- Some external memory handle types can only be shared within the same -- underlying physical device and/or the same driver version, as defined -- in the following table: -- --

--   +----------------------+----------------------+-----------------------+
--   | Handle type          | @VkPhysicalDeviceIDP | @VkPhysicalDeviceIDPr |
--   |                      | roperties@::@driverU | operties@::@deviceUUI |
--   |                      | UID@                 | D@                    |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_OPAQUE_F |                      |                       |
--   | D_BIT@               |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_OPAQUE_W |                      |                       |
--   | IN32_BIT@            |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_OPAQUE_W |                      |                       |
--   | IN32_KMT_BIT@        |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_D3D11_TE |                      |                       |
--   | XTURE_BIT@           |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_D3D11_TE |                      |                       |
--   | XTURE_KMT_BIT@       |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_D3D12_HE |                      |                       |
--   | AP_BIT@              |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | Must match           | Must match            |
--   | HANDLE_TYPE_D3D12_RE |                      |                       |
--   | SOURCE_BIT@          |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | No restriction       | No restriction        |
--   | HANDLE_TYPE_HOST_ALL |                      |                       |
--   | OCATION_BIT_EXT@     |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | No restriction       | No restriction        |
--   | HANDLE_TYPE_HOST_MAP |                      |                       |
--   | PED_FOREIGN_MEMORY_B |                      |                       |
--   | IT_EXT@              |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | No restriction       | No restriction        |
--   | HANDLE_TYPE_DMA_BUF_ |                      |                       |
--   | BIT_EXT@             |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   | @VK_EXTERNAL_MEMORY_ | No restriction       | No restriction        |
--   | HANDLE_TYPE_ANDROID_ |                      |                       |
--   | HARDWARE_BUFFER_BIT_ |                      |                       |
--   | ANDROID@             |                      |                       |
--   +----------------------+----------------------+-----------------------+
--   
--   External memory handle types compatibility
--

-- -- Note -- -- The above table does not restrict the drivers and devices with which -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT and -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT -- may be shared, as these handle types inherently mean memory -- that does not come from the same device, as they import memory from -- the host or a foreign device, respectively. -- -- Note -- -- Even though the above table does not restrict the drivers and devices -- with which VK_EXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT -- may be shared, query mechanisms exist in the Vulkan API that -- prevent the import of incompatible dma-bufs (such as -- vkGetMemoryFdPropertiesKHR) and that prevent incompatible usage -- of dma-bufs (such as VkPhysicalDeviceExternalBufferInfoKHR and -- VkPhysicalDeviceExternalImageFormatInfoKHR). -- --

Description

-- --

VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT specifies -- that images or buffers created with the specified parameters and -- handle type must use the mechanisms defined in the -- {html_spec_relative}#VK_NV_dedicated_allocation extension to -- create (or import) a dedicated allocation for the image or -- buffer.

-- --

VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT specifies that -- handles of this type can be exported from Vulkan memory -- objects.
VK_INTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT specifies that -- handles of this type can be imported as Vulkan memory -- objects.

-- -- Because their semantics in external APIs roughly align with that of an -- image or buffer with a dedicated allocation in Vulkan, implementations -- are required to report -- VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT for the -- following external handle types: -- --

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT

VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- for images only

-- -- Implementations must not report -- VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT for buffers -- with external handle type -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID. -- --

Parameters

-- --

physicalDevice is the physical device from which to query -- the buffer capabilities.

-- --

pExternalBufferInfo points to an instance of the -- VkPhysicalDeviceExternalBufferInfo structure, describing the -- parameters that would be consumed by vkCreateBuffer.
pExternalBufferProperties points to an instance of the -- VkExternalBufferProperties structure in which capabilities are -- returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pExternalBufferInfo must be a valid pointer to a -- valid VkPhysicalDeviceExternalBufferInfo structure
pExternalBufferProperties must be a valid pointer -- to a VkExternalBufferProperties structure

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO

-- --

pNext must be NULL
flags must be a valid combination of -- VkBufferCreateFlagBits values
usage must be a valid combination of -- VkBufferUsageFlagBits values
usage must not be 0
handleType must be a valid -- VkExternalMemoryHandleTypeFlagBits value

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES

-- --

pNext must be NULL

-- --

Description

-- -- deviceUUID must be immutable for a given device across -- instances, processes, driver APIs, driver versions, and system -- reboots. -- -- Applications can compare the driverUUID value across -- instance and process boundaries, and can make similar queries -- in external APIs to determine whether they are capable of sharing -- memory objects and resources using them with the device. -- -- deviceUUID and/or driverUUID must be used to -- determine whether a particular external object can be shared between -- driver components, where such a restriction exists as defined in the -- compatibility table for the particular object type: -- --

External memory handle types compatibility
External semaphore handle types compatibility
External fence handle types compatibility

-- -- If deviceLUIDValid is VK_FALSE, the contents of -- deviceLUID and deviceNodeMask are undefined. If -- deviceLUIDValid is VK_TRUE and Vulkan is running on -- the Windows operating system, the contents of deviceLUID -- can be cast to an LUID object and must be equal -- to the locally unique identifier of a IDXGIAdapter1 object -- that corresponds to physicalDevice. If -- deviceLUIDValid is VK_TRUE, deviceNodeMask -- must contain exactly one bit. If Vulkan is running on an -- operating system that supports the Direct3D 12 API and -- physicalDevice corresponds to an individual device in a -- linked device adapter, deviceNodeMask identifies the Direct3D -- 12 node corresponding to physicalDevice. Otherwise, -- deviceNodeMask must be 1. -- -- Note -- -- Although they have identical descriptions, -- VkPhysicalDeviceIDProperties::deviceUUID may differ -- from VkPhysicalDeviceProperties2::pipelineCacheUUID. -- The former is intended to identify and correlate devices across API -- and driver boundaries, while the latter is used to identify a -- compatible device and driver combination to use when serializing and -- de-serializing pipeline state. -- -- Note -- -- While VkPhysicalDeviceIDProperties::deviceUUID is -- specified to remain consistent across driver versions and system -- reboots, it is not intended to be usable as a serializable persistent -- identifier for a device. It may change when a device is physically -- added to, removed from, or moved to a different connector in a system -- while that system is powered down. Further, there is no reasonable way -- to verify with conformance testing that a given device retains the -- same UUID in a given system across all driver versions supported in -- that system. While implementations should make every effort to report -- consistent device UUIDs across driver versions, applications should -- avoid relying on the persistence of this value for uses other than -- identifying compatible devices for external object sharing purposes. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_TOO_MANY_OBJECTS
- ```
VK_ERROR_OUT_OF_HOST_MEMORY
```

-- --

Parameters

-- --

device is the logical device that will be importing -- fd.

-- --

handleType is the type of the handle fd.
fd is the handle which will be imported.
pMemoryFdProperties will return properties of the handle -- fd.

-- --

Description

-- --

Valid Usage

-- --

fd must be an external memory handle created -- outside of the Vulkan API.

-- --

handleType must not be -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

handleType must be a valid -- VkExternalMemoryHandleTypeFlagBits value
pMemoryFdProperties must be a valid pointer to a -- VkMemoryFdPropertiesKHR structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- Importing memory from a file descriptor transfers ownership of the -- file descriptor from the application to the Vulkan implementation. The -- application must not perform any operations on the file -- descriptor after a successful import. -- -- Applications can import the same underlying memory into -- multiple instances of Vulkan, into the same instance from which it was -- exported, and multiple times into a given Vulkan instance. In all -- cases, each import operation must create a distinct -- VkDeviceMemory object. -- --

Valid Usage

-- --

If handleType is not 0, it must be -- supported for import, as reported by -- VkExternalImageFormatProperties or -- VkExternalBufferProperties.

-- --

The memory from which fd was exported must have -- been created on the same underlying physical device as -- device.
If handleType is not 0, it must be -- defined as a POSIX file descriptor handle.
If handleType is not 0, fd must -- be a valid handle of the type specified by handleType.
The memory represented by fd must have been -- created from a physical device and driver that is compatible with -- device and handleType, as described in -- {html_spec_relative}#external-memory-handle-types-compatibility.
fd must obey any requirements listed for -- handleType in external memory handle types -- compatibility.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR

-- --

If handleType is not 0, handleType -- must be a valid VkExternalMemoryHandleTypeFlagBits -- value

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR

-- --

pNext must be NULL
memory must be a valid VkDeviceMemory -- handle
handleType must be a valid -- VkExternalMemoryHandleTypeFlagBits value

-- --

Parameters

-- --

device is the logical device that will be importing -- pHostPointer.

-- --

handleType is the type of the handle -- pHostPointer.
pHostPointer is the host pointer to import from.

-- --

Description

-- --

Valid Usage

-- --

handleType must be -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

-- --

pHostPointer must be a pointer aligned to an -- integer multiple of -- VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, -- pHostPointer must be a pointer to host memory
If handleType is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, -- pHostPointer must be a pointer to host mapped foreign -- memory

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

handleType must be a valid -- VkExternalMemoryHandleTypeFlagBits value
pMemoryHostPointerProperties must be a valid -- pointer to a VkMemoryHostPointerPropertiesEXT structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- Importing memory from a host pointer shares ownership of the memory -- between the host and the Vulkan implementation. The application -- can continue to access the memory through the host pointer but -- it is the application’s responsibility to synchronize device and -- non-device access to the underlying memory as defined in Host -- Access to Device Memory Objects. -- -- Applications can import the same underlying memory into -- multiple instances of Vulkan and multiple times into a given Vulkan -- instance. However, implementations may fail to import the same -- underlying memory multiple times into a given physical device due to -- platform constraints. -- -- Importing memory from a particular host pointer may not be -- possible due to additional platform-specific restrictions beyond the -- scope of this specification in which case the implementation -- must fail the memory import operation with the error code -- VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR. -- -- The application must ensure that the imported memory range -- remains valid and accessible for the lifetime of the imported memory -- object. -- --

Valid Usage

-- --

If handleType is not 0, it must be -- supported for import, as reported in -- VkExternalMemoryPropertiesKHR

-- --

If handleType is not 0, it must be -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
pHostPointer must be a pointer aligned to an -- integer multiple of -- VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, -- pHostPointer must be a pointer to -- allocationSize number of bytes of host memory, where -- allocationSize is the member of the -- VkMemoryAllocateInfo structure this structure is chained -- to
If handleType is -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, -- pHostPointer must be a pointer to -- allocationSize number of bytes of host mapped foreign memory, -- where allocationSize is the member of the -- VkMemoryAllocateInfo structure this structure is chained -- to

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

-- --

handleType must be a valid -- VkExternalMemoryHandleTypeFlagBits value

-- --

device is the logical device that owns the queue.

-- --

pQueueInfo points to an instance of the -- VkDeviceQueueInfo2 structure, describing the parameters used to -- create the device queue.
pQueue is a pointer to a VkQueue object that -- will be filled with the handle for the requested queue.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pQueueInfo must be a valid pointer to a valid -- VkDeviceQueueInfo2 structure
pQueue must be a valid pointer to a -- VkQueue handle

-- --

Description

-- --

Valid Usage

-- --

If the protected memory feature is not enabled, -- protectedSubmit must not be VK_TRUE.

-- --

If protectedSubmit is VK_TRUE, then each element -- of the pCommandBuffers array must be a protected -- command buffer.
If protectedSubmit is VK_FALSE, then each -- element of the pCommandBuffers array must be an -- unprotected command buffer.
If the VkSubmitInfo::pNext chain does not -- include a VkProtectedSubmitInfo structure, then each element -- of the command buffer of the pCommandBuffers array -- must be an unprotected command buffer.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PROTECTED_SUBMIT_INFO

-- --

queueFamilyIndex must be one of the queue family -- indices specified when device was created, via the -- VkDeviceQueueCreateInfo structure

-- --

queueIndex must be less than the number of queues -- created for the specified queue family index and -- VkDeviceQueueCreateFlags member flags equal to this -- flags value when device was created, via the -- queueCount member of the VkDeviceQueueCreateInfo -- structure

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_QUEUE_INFO_2

-- --

pNext must be NULL
flags must be a valid combination of -- VkDeviceQueueCreateFlagBits values
flags must not be 0

-- --

Description

-- -- The type(s) of device access supported by each layout are: -- --

VK_IMAGE_LAYOUT_UNDEFINED does not support device access. -- This layout must only be used as the initialLayout -- member of VkImageCreateInfo or -- VkAttachmentDescription, or as the oldLayout in an -- image transition. When transitioning out of this layout, the contents -- of the memory are not guaranteed to be preserved.
VK_IMAGE_LAYOUT_PREINITIALIZED does not support device -- access. This layout must only be used as the -- initialLayout member of VkImageCreateInfo or -- VkAttachmentDescription, or as the oldLayout in an -- image transition. When transitioning out of this layout, the contents -- of the memory are preserved. This layout is intended to be used as the -- initial layout for an image whose contents are written by the host, -- and hence the data can be written to memory immediately, -- without first executing a layout transition. Currently, -- VK_IMAGE_LAYOUT_PREINITIALIZED is only useful with -- VK_IMAGE_TILING_LINEAR images because there is not a standard -- layout defined for VK_IMAGE_TILING_OPTIMAL images.
VK_IMAGE_LAYOUT_GENERAL supports all types of device -- access.
VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL must only -- be used as a color or resolve attachment in a VkFramebuffer. -- This layout is valid only for image subresources of images created -- with the VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT usage bit -- enabled.
VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL -- must only be used as a depth/stencil attachment in a -- VkFramebuffer. This layout is valid only for image -- subresources of images created with the -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit -- enabled.
VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL -- must only be used as a read-only depth/stencil attachment in a -- VkFramebuffer and/or as a read-only image in a shader (which -- can be read as a sampled image, combined image/sampler and/or -- input attachment). This layout is valid only for image subresources of -- images created with the -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit -- enabled. Only image subresources of images created with -- VK_IMAGE_USAGE_SAMPLED_BIT can be used as a sampled -- image or combined image/sampler in a shader. Similarly, only image -- subresources of images created with -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as -- input attachments.
VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL: -- must only be used as a depth/stencil attachment in a -- VkFramebuffer, where the depth aspect is read-only, and/or as -- a read-only image in a shader (which can be read as a sampled -- image, combined image/sampler and/or input attachment) where only the -- depth aspect is accessed. This layout is valid only for image -- subresources of images created with the -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit -- enabled. Only image subresources of images created with -- VK_IMAGE_USAGE_SAMPLED_BIT can be used as a sampled -- image or combined image/sampler in a shader. Similarly, only image -- subresources of images created with -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as -- input attachments.
VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL: -- must only be used as a depth/stencil attachment in a -- VkFramebuffer, where the stencil aspect is read-only, and/or -- as a read-only image in a shader (which can be read as a -- sampled image, combined image/sampler and/or input attachment) where -- only the stencil aspect is accessed. This layout is valid only for -- image subresources of images created with the -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit -- enabled. Only image subresources of images created with -- VK_IMAGE_USAGE_SAMPLED_BIT can be used as a sampled -- image or combined image/sampler in a shader. Similarly, only image -- subresources of images created with -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as -- input attachments.
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL must only -- be used as a read-only image in a shader (which can be read as -- a sampled image, combined image/sampler and/or input attachment). This -- layout is valid only for image subresources of images created with the -- VK_IMAGE_USAGE_SAMPLED_BIT or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage bit enabled.
VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL must only be -- used as a source image of a transfer command (see the definition of -- VK_PIPELINE_STAGE_TRANSFER_BIT). This layout is valid only for -- image subresources of images created with the -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage bit enabled.
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL must only be -- used as a destination image of a transfer command. This layout is -- valid only for image subresources of images created with the -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage bit enabled.
VK_IMAGE_LAYOUT_PRESENT_SRC_KHR must only be used -- for presenting a presentable image for display. A swapchain’s image -- must be transitioned to this layout before calling -- vkQueuePresentKHR, and must be transitioned away from -- this layout after calling vkAcquireNextImageKHR.
VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR is valid only for -- shared presentable images, and must be used for any usage the -- image supports.

-- -- The layout of each image subresource is not a state of the image -- subresource itself, but is rather a property of how the data in memory -- is organized, and thus for each mechanism of accessing an image in the -- API the application must specify a parameter or structure -- member that indicates which image layout the image subresource(s) are -- considered to be in when the image will be accessed. For transfer -- commands, this is a parameter to the command (see -- {html_spec_relative}#clears and -- {html_spec_relative}#copies). For use as a framebuffer -- attachment, this is a member in the substructures of the -- VkRenderPassCreateInfo (see Render Pass). For use in a -- descriptor set, this is a member in the VkDescriptorImageInfo -- structure (see {html_spec_relative}#descriptorsets-updates). At -- the time that any command buffer command accessing an image executes -- on any queue, the layouts of the image subresources that are accessed -- must all match the layout specified via the API controlling -- those accesses. -- -- When performing a layout transition on an image subresource, the old -- layout value must either equal the current layout of the image -- subresource (at the time the transition executes), or else be -- VK_IMAGE_LAYOUT_UNDEFINED (implying that the contents of the -- image subresource need not be preserved). The new layout used in a -- transition must not be VK_IMAGE_LAYOUT_UNDEFINED or -- VK_IMAGE_LAYOUT_PREINITIALIZED. -- -- The image layout of each image subresource of a depth/stencil image -- created with -- VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT is -- dependent on the last sample locations used to render to the image -- subresource as a depth/stencil attachment, thus applications -- must provide the same sample locations that were last used to -- render to the given image subresource whenever a layout transition of -- the image subresource happens, otherwise the contents of the depth -- aspect of the image subresource become undefined. -- -- In addition, depth reads from a depth/stencil attachment referring to -- an image subresource range of a depth/stencil image created with -- VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- using different sample locations than what have been last used to -- perform depth writes to the image subresources of the same image -- subresource range produce undefined results. -- -- Similarly, depth writes to a depth/stencil attachment referring to an -- image subresource range of a depth/stencil image created with -- VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- using different sample locations than what have been last used to -- perform depth writes to the image subresources of the same image -- subresource range make the contents of the depth aspect of those image -- subresources undefined. -- --

Parameters

-- --

device is the logical device that creates the image.

-- --

pCreateInfo is a pointer to an instance of the -- VkImageCreateInfo structure containing parameters to be used -- to create the image.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pImage points to a VkImage handle in which the -- resulting image object is returned.

-- --

Description

-- --

Valid Usage

-- --

If the flags member of pCreateInfo includes -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT, creating this -- VkImage must not cause the total required sparse -- memory for all currently valid sparse resources on the device to -- exceed -- VkPhysicalDeviceLimits::sparseAddressSpaceSize

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkImageCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pImage must be a valid pointer to a -- VkImage handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- image.

-- --

image is the image to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to image, either -- directly or via a VkImageView, must have completed -- execution

-- --

If VkAllocationCallbacks were provided when -- image was created, a compatible set of callbacks must -- be provided here
If no VkAllocationCallbacks were provided when -- image was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If image is not VK_NULL_HANDLE, image -- must be a valid VkImage handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If image is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to image must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

image is the image whose layout is being queried.
pSubresource is a pointer to a VkImageSubresource -- structure selecting a specific image for the image subresource.
pLayout points to a VkSubresourceLayout structure -- in which the layout is returned.

-- --

Description

-- -- If the VkFormat of image is a multi-planar -- format, vkGetImageSubresourceLayout describes one plane -- of the image. -- -- vkGetImageSubresourceLayout is invariant for the lifetime of a -- single image. However, the subresource layout of images in Android -- hardware buffer external memory isn’t known until the image has been -- bound to memory, so calling vkGetImageSubresourceLayout for -- such an image before it has been bound will result in undefined -- behavior. -- --

Valid Usage

-- --

image must have been created with tiling -- equal to VK_IMAGE_TILING_LINEAR

-- --

The aspectMask member of pSubresource -- must only have a single bit set
The mipLevel member of pSubresource must -- be less than the mipLevels specified in -- VkImageCreateInfo when image was created
The arrayLayer member of pSubresource -- must be less than the arrayLayers specified in -- VkImageCreateInfo when image was created
If the format of image is a multi-planar -- format with two planes, the aspectMask member of -- pSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT or -- VK_IMAGE_ASPECT_PLANE_1_BIT
If the format of image is a multi-planar -- format with three planes, the aspectMask member of -- pSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT or -- VK_IMAGE_ASPECT_PLANE_2_BIT
If image was created with the -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- external memory handle type, then image must be bound -- to memory.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

image must be a valid VkImage handle
pSubresource must be a valid pointer to a valid -- VkImageSubresource structure
pLayout must be a valid pointer to a -- VkSubresourceLayout structure
image must have been created, allocated, or -- retrieved from device

-- --

Description

-- -- Images created with tiling equal to -- VK_IMAGE_TILING_LINEAR have further restrictions on their -- limits and capabilities compared to images created with -- tiling equal to VK_IMAGE_TILING_OPTIMAL. Creation of -- images with tiling VK_IMAGE_TILING_LINEAR may not be -- supported unless other parameters meet all of the constraints: -- --

imageType is VK_IMAGE_TYPE_2D
format is not a depth/stencil format
mipLevels is 1
arrayLayers is 1
samples is VK_SAMPLE_COUNT_1_BIT
usage only includes -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT and/or -- VK_IMAGE_USAGE_TRANSFER_DST_BIT

-- -- Implementations may support additional limits and capabilities -- beyond those listed above. -- -- To query an implementation’s specific capabilities for a given -- combination of format, imageType, tiling, -- usage, -- VkExternalMemoryImageCreateInfo::handleTypes and -- flags, call vkGetPhysicalDeviceImageFormatProperties2. -- The return value specifies whether that combination of image settings -- is supported. On success, the VkImageFormatProperties output -- parameter specifies the set of valid samples bits and the -- limits for extent, mipLevels, arrayLayers, -- and maxResourceSize. Even if -- vkGetPhysicalDeviceImageFormatProperties2. returns success and -- the parameters to vkCreateImage are all within the returned limits, -- vkCreateImage must fail and return -- VK_ERROR_OUT_OF_DEVICE_MEMORY if the resulting size of the -- image would be larger than maxResourceSize. -- -- To determine the set of valid usage bits for a given format, -- call vkGetPhysicalDeviceFormatProperties. -- -- Note -- -- For images created without VK_IMAGE_CREATE_EXTENDED_USAGE_BIT -- a usage bit is valid if it is supported for the format the -- image is created with. -- -- For images created with VK_IMAGE_CREATE_EXTENDED_USAGE_BIT a -- usage bit is valid if it is supported for at least one of the -- formats a VkImageView created from the image can have -- (see Image Views for more detail). -- --

Valid Usage

-- --

If the pNext chain doesn’t contain an instance of -- VkExternalFormatANDROID, or if format is not -- VK_FORMAT_UNDEFINED, the combination of format, -- imageType, tiling, usage, and -- flags must be supported, as indicated by a -- VK_SUCCESS return value from -- vkGetPhysicalDeviceImageFormatProperties invoked with the -- same values passed to the corresponding parameters.

-- --

If sharingMode is VK_SHARING_MODE_CONCURRENT, -- pQueueFamilyIndices must be a valid pointer to an -- array of queueFamilyIndexCount uint32_t values
If sharingMode is VK_SHARING_MODE_CONCURRENT, -- queueFamilyIndexCount must be greater than -- 1
If sharingMode is VK_SHARING_MODE_CONCURRENT, -- each element of pQueueFamilyIndices must be unique and -- must be less than pQueueFamilyPropertyCount returned -- by either vkGetPhysicalDeviceQueueFamilyProperties or -- vkGetPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
format must not be -- VK_FORMAT_UNDEFINED
extent::width must be greater than -- 0.
extent::height must be greater than -- 0.
extent::depth must be greater than -- 0.
mipLevels must be greater than 0
arrayLayers must be greater than 0
If flags contains -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, imageType -- must be VK_IMAGE_TYPE_2D
If flags contains -- VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, imageType -- must be VK_IMAGE_TYPE_3D
If imageType is VK_IMAGE_TYPE_1D, -- extent.width must be less than or equal to -- VkPhysicalDeviceLimits::maxImageDimension1D, or -- VkImageFormatProperties::maxExtent.width (as -- returned by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure) - whichever is -- higher
If imageType is VK_IMAGE_TYPE_2D and -- flags does not contain -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, extent.width -- and extent.height must be less than or equal to -- VkPhysicalDeviceLimits::maxImageDimension2D, or -- VkImageFormatProperties::maxExtent.width/height -- (as returned by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure) - whichever is -- higher
If imageType is VK_IMAGE_TYPE_2D and -- flags contains VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, -- extent.width and extent.height must be less -- than or equal to -- VkPhysicalDeviceLimits::maxImageDimensionCube, or -- VkImageFormatProperties::maxExtent.width/height -- (as returned by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure) - whichever is -- higher
If imageType is VK_IMAGE_TYPE_2D and -- flags contains VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, -- extent.width and extent.height must be equal -- and arrayLayers must be greater than or equal to -- 6
If imageType is VK_IMAGE_TYPE_3D, -- extent.width, extent.height and -- extent.depth must be less than or equal to -- VkPhysicalDeviceLimits::maxImageDimension3D, or -- VkImageFormatProperties::maxExtent.width/height/depth -- (as returned by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure) - whichever is -- higher
If imageType is VK_IMAGE_TYPE_1D, both -- extent.height and extent.depth must be -- 1
If imageType is VK_IMAGE_TYPE_2D, -- extent.depth must be 1
mipLevels must be less than or equal to -- ⌊log2(max(extent.width, extent.height, -- extent.depth))⌋ + 1.
mipLevels must be less than or equal to -- VkImageFormatProperties::maxMipLevels (as returned -- by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure)
arrayLayers must be less than or equal to -- VkImageFormatProperties::maxArrayLayers (as returned -- by vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure)
If imageType is VK_IMAGE_TYPE_3D, -- arrayLayers must be 1.
If samples is not VK_SAMPLE_COUNT_1_BIT, -- imageType must be VK_IMAGE_TYPE_2D, -- flags must not contain -- VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, tiling -- must be VK_IMAGE_TILING_OPTIMAL, and -- mipLevels must be equal to 1
If usage includes -- VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, then bits other than -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, and -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT must not be -- set
If usage includes -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.width -- must be less than or equal to -- VkPhysicalDeviceLimits::maxFramebufferWidth
If usage includes -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.height -- must be less than or equal to -- VkPhysicalDeviceLimits::maxFramebufferHeight
If usage includes -- VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, usage -- must also contain at least one of -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT.
samples must be a bit value that is set in -- VkImageFormatProperties::sampleCounts returned by -- vkGetPhysicalDeviceImageFormatProperties with -- format, imageType, tiling, usage, -- and flags equal to those in this structure
If the multisampled storage images feature is not enabled, -- and usage contains VK_IMAGE_USAGE_STORAGE_BIT, -- samples must be VK_SAMPLE_COUNT_1_BIT
If the sparse bindings feature is not enabled, -- flags must not contain -- VK_IMAGE_CREATE_SPARSE_BINDING_BIT
If the sparse aliased residency feature is not enabled, -- flags must not contain -- VK_IMAGE_CREATE_SPARSE_ALIASED_BIT
If imageType is VK_IMAGE_TYPE_1D, flags -- must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for 2D images feature is not -- enabled, and imageType is VK_IMAGE_TYPE_2D, -- flags must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for 3D images feature is not -- enabled, and imageType is VK_IMAGE_TYPE_3D, -- flags must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 2 samples feature -- is not enabled, imageType is VK_IMAGE_TYPE_2D, and -- samples is VK_SAMPLE_COUNT_2_BIT, flags -- must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 4 samples feature -- is not enabled, imageType is VK_IMAGE_TYPE_2D, and -- samples is VK_SAMPLE_COUNT_4_BIT, flags -- must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 8 samples feature -- is not enabled, imageType is VK_IMAGE_TYPE_2D, and -- samples is VK_SAMPLE_COUNT_8_BIT, flags -- must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 16 samples feature -- is not enabled, imageType is VK_IMAGE_TYPE_2D, and -- samples is VK_SAMPLE_COUNT_16_BIT, flags -- must not contain -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If tiling is VK_IMAGE_TILING_LINEAR, -- format must be a format that has at least one -- supported feature bit present in the value of -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties with the same value of -- format
If tiling is VK_IMAGE_TILING_LINEAR, and -- VkFormatProperties::linearTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, usage -- must not contain VK_IMAGE_USAGE_SAMPLED_BIT
If tiling is VK_IMAGE_TILING_LINEAR, and -- VkFormatProperties::linearTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT, usage -- must not contain VK_IMAGE_USAGE_STORAGE_BIT
If tiling is VK_IMAGE_TILING_LINEAR, and -- VkFormatProperties::linearTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, usage -- must not contain -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
If tiling is VK_IMAGE_TILING_LINEAR, and -- VkFormatProperties::linearTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT, -- usage must not contain -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If tiling is VK_IMAGE_TILING_OPTIMAL, -- format must be a format that has at least one -- supported feature bit present in the value of -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties with the same value of -- format
If tiling is VK_IMAGE_TILING_OPTIMAL, and -- VkFormatProperties::optimalTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, usage -- must not contain VK_IMAGE_USAGE_SAMPLED_BIT
If tiling is VK_IMAGE_TILING_OPTIMAL, and -- VkFormatProperties::optimalTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT, usage -- must not contain VK_IMAGE_USAGE_STORAGE_BIT
If tiling is VK_IMAGE_TILING_OPTIMAL, and -- VkFormatProperties::optimalTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, usage -- must not contain -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
If tiling is VK_IMAGE_TILING_OPTIMAL, and -- VkFormatProperties::optimalTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT, -- usage must not contain -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If flags contains -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT or -- VK_IMAGE_CREATE_SPARSE_ALIASED_BIT, it must also -- contain VK_IMAGE_CREATE_SPARSE_BINDING_BIT
If any of the bits VK_IMAGE_CREATE_SPARSE_BINDING_BIT, -- VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or -- VK_IMAGE_CREATE_SPARSE_ALIASED_BIT are set, -- VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT must not also -- be set
If the pNext chain contains an instance of -- VkExternalMemoryImageCreateInfoNV, it must not contain -- an instance of VkExternalMemoryImageCreateInfo.
If the pNext chain contains an instance of -- VkExternalMemoryImageCreateInfo, its handleTypes -- member must only contain bits that are also in -- VkExternalImageFormatProperties::externalMemoryProperties::compatibleHandleTypes, -- as returned by vkGetPhysicalDeviceImageFormatProperties2 with -- format, imageType, tiling, usage, -- and flags equal to those in this structure, and with an -- instance of VkPhysicalDeviceExternalImageFormatInfo in the -- pNext chain, with a handleType equal to any one of -- the handle types specified in -- VkExternalMemoryImageCreateInfo::handleTypes
If the pNext chain contains an instance of -- VkExternalMemoryImageCreateInfoNV, its handleTypes -- member must only contain bits that are also in -- VkExternalImageFormatPropertiesNV::externalMemoryProperties::compatibleHandleTypes, -- as returned by -- vkGetPhysicalDeviceExternalImageFormatPropertiesNV with -- format, imageType, tiling, usage, -- and flags equal to those in this structure, and with -- externalHandleType equal to any one of the handle types -- specified in -- VkExternalMemoryImageCreateInfoNV::handleTypes
If the logical device was created with -- VkDeviceGroupDeviceCreateInfo::physicalDeviceCount -- equal to 1, flags must not contain -- VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT
If flags contains -- VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT, then -- mipLevels must be one, arrayLayers -- must be one, imageType must be -- VK_IMAGE_TYPE_2D, and tiling must be -- VK_IMAGE_TILING_OPTIMAL
If flags contains -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, then -- format must be a block-compressed image format, -- an ETC compressed image format, or an ASTC compressed image -- format.
If flags contains -- VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, then -- flags must also contain -- VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.
initialLayout must be -- VK_IMAGE_LAYOUT_UNDEFINED or -- VK_IMAGE_LAYOUT_PREINITIALIZED.
If the pNext chain includes a -- VkExternalMemoryImageCreateInfo or -- VkExternalMemoryImageCreateInfoNV structure whose -- handleTypes member is not 0, initialLayout -- must be VK_IMAGE_LAYOUT_UNDEFINED
If the image format is one of those listed in -- {html_spec_relative}#features-formats-requiring-sampler-ycbcr-conversion:
- mipLevels -- must be 1
- samples must be -- VK_SAMPLE_COUNT_1_BIT
- imageType must -- be VK_IMAGE_TYPE_2D
- arrayLayers must -- be 1
If tiling is VK_IMAGE_TILING_OPTIMAL, -- format is a multi-planar format, and -- VkFormatProperties::optimalTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_DISJOINT_BIT, flags must -- not contain VK_IMAGE_CREATE_DISJOINT_BIT
If tiling is VK_IMAGE_TILING_LINEAR, -- format is a multi-planar format, and -- VkFormatProperties::linearTilingFeatures (as -- returned by vkGetPhysicalDeviceFormatProperties with the same -- value of format) does not include -- VK_FORMAT_FEATURE_DISJOINT_BIT, flags must -- not contain VK_IMAGE_CREATE_DISJOINT_BIT
If format is not a multi-planar format, and -- flags does not include VK_IMAGE_CREATE_ALIAS_BIT, -- flags must not contain -- VK_IMAGE_CREATE_DISJOINT_BIT
If flags contains -- VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- format must be a depth or depth/stencil format
If the pNext chain includes a -- VkExternalMemoryImageCreateInfo structure whose -- handleTypes member includes -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID:
- imageType -- must be VK_IMAGE_TYPE_2D
- mipLevels -- must either be 1 or equal to -- ⌊log2(max(extent.width, extent.height, -- extent.depth))⌋ + 1.
- If format is not -- VK_FORMAT_UNDEFINED, then format, -- imageType, tiling, usage, flags, -- mipLevels, and samples must be supported with -- VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- external memory handle types according to -- vkGetPhysicalDeviceImageFormatProperties2
- If -- format is VK_FORMAT_UNDEFINED, then the -- pNext chain must include a -- VkExternalFormatANDROID structure whose externalFormat -- member is not 0
If the pNext chain includes a -- VkExternalFormatANDROID structure whose externalFormat -- member is not 0:
- format must be -- VK_FORMAT_UNDEFINED
- flags must not -- include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
- usage -- must not include any usages except -- VK_IMAGE_USAGE_SAMPLED_BIT
- tiling -- must be VK_IMAGE_TILING_OPTIMAL

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO

-- --

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 -- VkDedicatedAllocationImageCreateInfoNV, -- VkExternalFormatANDROID, -- VkExternalMemoryImageCreateInfo, -- VkExternalMemoryImageCreateInfoNV, -- VkImageFormatListCreateInfoKHR, or -- VkImageSwapchainCreateInfoKHR
Each sType member in the pNext chain must -- be unique
flags must be a valid combination of -- VkImageCreateFlagBits values
imageType must be a valid VkImageType -- value
format must be a valid VkFormat value
samples must be a valid -- VkSampleCountFlagBits value
tiling must be a valid VkImageTiling -- value
usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0
sharingMode must be a valid VkSharingMode -- value
initialLayout must be a valid VkImageLayout -- value

-- --

Description

-- -- For images created with linear tiling, rowPitch, -- arrayPitch and depthPitch describe the layout of the -- image subresource in linear memory. For uncompressed formats, -- rowPitch is the number of bytes between texels with the same -- x coordinate in adjacent rows (y coordinates differ by one). -- arrayPitch is the number of bytes between texels with the -- same x and y coordinate in adjacent array layers of the image (array -- layer values differ by one). depthPitch is the number of -- bytes between texels with the same x and y coordinate in adjacent -- slices of a 3D image (z coordinates differ by one). Expressed as an -- addressing formula, the starting byte of a texel in the image -- subresource has address: -- --

--   // (x,y,z,layer) are in texel coordinates
--   address(x,y,z,layer) = layer*arrayPitch + z*depthPitch + y*rowPitch + x*elementSize + offset
--

-- -- For compressed formats, the rowPitch is the number of bytes -- between compressed texel blocks in adjacent rows. arrayPitch -- is the number of bytes between compressed texel blocks in adjacent -- array layers. depthPitch is the number of bytes between -- compressed texel blocks in adjacent slices of a 3D image. -- --

--   // (x,y,z,layer) are in compressed texel block coordinates
--   address(x,y,z,layer) = layer*arrayPitch + z*depthPitch + y*rowPitch + x*compressedTexelBlockByteSize + offset;
--

-- -- arrayPitch is undefined for images that were not created as -- arrays. depthPitch is defined only for 3D images. -- -- For single-plane color formats, the aspectMask member -- of VkImageSubresource must be -- VK_IMAGE_ASPECT_COLOR_BIT. For depth/stencil formats, -- aspectMask must be either -- VK_IMAGE_ASPECT_DEPTH_BIT or -- VK_IMAGE_ASPECT_STENCIL_BIT. On implementations that store -- depth and stencil aspects separately, querying each of these image -- subresource layouts will return a different offset and -- size representing the region of memory used for that aspect. -- On implementations that store depth and stencil aspects interleaved, -- the same offset and size are returned and represent -- the interleaved memory allocation. -- -- For multi-planar formats, the aspectMask member of -- VkImageSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or (for 3-plane formats only) -- VK_IMAGE_ASPECT_PLANE_2_BIT. Querying each of these image -- subresource layouts will return a different offset and -- size representing the region of memory used for that plane. -- --

Description

-- -- A swapchain is an abstraction for an array of presentable images that -- are associated with a surface. The presentable images are represented -- by VkImage objects created by the platform. One image (which -- can be an array image for multiview/stereoscopic-3D surfaces) -- is displayed at a time, but multiple images can be queued for -- presentation. An application renders to the image, and then queues the -- image for presentation to the surface. -- -- A native window cannot be associated with more than one -- swapchain at a time. Further, swapchains cannot be created for -- native windows that have a non-Vulkan graphics API surface associated -- with them. -- -- Note -- -- The presentation engine is an abstraction for the platform’s -- compositor or display engine. -- -- The presentation engine may be synchronous or asynchronous with -- respect to the application and/or logical device. -- -- Some implementations may use the device’s graphics queue or -- dedicated presentation hardware to perform presentation. -- -- The presentable images of a swapchain are owned by the presentation -- engine. An application can acquire use of a presentable image -- from the presentation engine. Use of a presentable image must -- occur only after the image is returned by -- vkAcquireNextImageKHR, and before it is presented by -- vkQueuePresentKHR. This includes transitioning the image -- layout and rendering commands. -- -- An application can acquire use of a presentable image with -- vkAcquireNextImageKHR. After acquiring a presentable image -- and before modifying it, the application must use a -- synchronization primitive to ensure that the presentation engine has -- finished reading from the image. The application can then -- transition the image’s layout, queue rendering commands to it, etc. -- Finally, the application presents the image with -- vkQueuePresentKHR, which releases the acquisition of the -- image. -- -- The presentation engine controls the order in which presentable images -- are acquired for use by the application. -- -- Note -- -- This allows the platform to handle situations which require -- out-of-order return of images after presentation. At the same time, it -- allows the application to generate command buffers referencing all of -- the images in the swapchain at initialization time, rather than in its -- main loop. -- --

Parameters

-- --

device is the device to create the swapchain for.

-- --

pCreateInfo is a pointer to an instance of the -- VkSwapchainCreateInfoKHR structure specifying the parameters of -- the created swapchain.
pAllocator is the allocator used for host memory -- allocated for the swapchain object when there is no more specific -- allocator available (see Memory Allocation).
pSwapchain is a pointer to a VkSwapchainKHR -- handle in which the created swapchain object will be returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkSwapchainCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pSwapchain must be a valid pointer to a -- VkSwapchainKHR handle

-- --

Host Synchronization

-- --

Host access to pCreateInfo.surface must be -- externally synchronized

-- --

Host access to pCreateInfo.oldSwapchain must be -- externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_SURFACE_LOST_KHR
```
```
VK_ERROR_NATIVE_WINDOW_IN_USE_KHR
```

-- --

Parameters

-- --

device is the VkDevice associated with -- swapchain.

-- --

swapchain is the swapchain to destroy.
pAllocator is the allocator used for host memory -- allocated for the swapchain object when there is no more specific -- allocator available (see Memory Allocation).

-- --

Description

-- -- The application must not destroy a swapchain until after -- completion of all outstanding operations on images that were acquired -- from the swapchain. swapchain and all associated -- VkImage handles are destroyed, and must not be -- acquired or used any more by the application. The memory of each -- VkImage will only be freed after that image is no longer used -- by the presentation engine. For example, if one image of the swapchain -- is being displayed in a window, the memory for that image may -- not be freed until the window is destroyed, or another swapchain is -- created for the window. Destroying the swapchain does not invalidate -- the parent VkSurfaceKHR, and a new swapchain can be -- created with it. -- -- When a swapchain associated with a display surface is destroyed, if -- the image most recently presented to the display surface is from the -- swapchain being destroyed, then either any display resources modified -- by presenting images from any swapchain associated with the display -- surface must be reverted by the implementation to their state -- prior to the first present performed on one of these swapchains, or -- such resources must be left in their current state. -- --

Valid Usage

-- --

All uses of presentable images acquired from swapchain -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- swapchain was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- swapchain was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If swapchain is not VK_NULL_HANDLE, -- swapchain must be a valid VkSwapchainKHR -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
Both of device, and swapchain that are valid -- handles must have been created, allocated, or retrieved from -- the same VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to query.
pSwapchainImageCount is a pointer to an integer related -- to the number of presentable images available or queried, as described -- below.
pSwapchainImages is either NULL or a pointer to -- an array of VkImage handles.

-- --

Description

-- -- If pSwapchainImages is NULL, then the number of -- presentable images for swapchain is returned in -- pSwapchainImageCount. Otherwise, -- pSwapchainImageCount must point to a variable set by -- the user to the number of elements in the pSwapchainImages -- array, and on return the variable is overwritten with the number of -- structures actually written to pSwapchainImages. If the value -- of pSwapchainImageCount is less than the number of -- presentable images for swapchain, at most -- pSwapchainImageCount structures will be written. If -- pSwapchainImageCount is smaller than the number of -- presentable images for swapchain, VK_INCOMPLETE will -- be returned instead of VK_SUCCESS to indicate that not all -- the available values were returned. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
pSwapchainImageCount must be a valid pointer to a -- uint32_t value
If the value referenced by pSwapchainImageCount is not -- 0, and pSwapchainImages is not NULL, -- pSwapchainImages must be a valid pointer to an array -- of pSwapchainImageCount VkImage handles
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the non-retired swapchain from which an -- image is being acquired.
timeout specifies how long the function waits, in -- nanoseconds, if no image is available.
semaphore is VK_NULL_HANDLE or a semaphore to -- signal.
fence is VK_NULL_HANDLE or a fence to signal.
pImageIndex is a pointer to a uint32_t that is -- set to the index of the next image to use (i.e. an index into the -- array of images returned by vkGetSwapchainImagesKHR).

-- --

Description

-- --

Valid Usage

-- --

swapchain must not be in the retired state

-- --

If semaphore is not VK_NULL_HANDLE it must -- be unsignaled
If semaphore is not VK_NULL_HANDLE it must -- not have any uncompleted signal or wait operations pending
If fence is not VK_NULL_HANDLE it must be -- unsignaled and must not be associated with any other queue -- command that has not yet completed execution on that queue
semaphore and fence must not both be -- equal to VK_NULL_HANDLE
If the number of currently acquired images is greater than the -- difference between the number of images in swapchain and the -- value of VkSurfaceCapabilitiesKHR::minImageCount as -- returned by a call to -- vkGetPhysicalDeviceSurfaceCapabilities2KHR with the -- surface used to create swapchain, timeout -- must not be UINT64_MAX

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
If semaphore is not VK_NULL_HANDLE, -- semaphore must be a valid VkSemaphore -- handle
If fence is not VK_NULL_HANDLE, fence -- must be a valid VkFence handle
pImageIndex must be a valid pointer to a -- uint32_t value
If semaphore is a valid handle, it must have been -- created, allocated, or retrieved from device
If fence is a valid handle, it must have been -- created, allocated, or retrieved from device
Both of device, and swapchain that are valid -- handles must have been created, allocated, or retrieved from -- the same VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Host access to semaphore must be externally -- synchronized
Host access to fence must be externally -- synchronized

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_TIMEOUT
```
- ```
VK_NOT_READY
```
- ```
VK_SUBOPTIMAL_KHR
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_OUT_OF_DATE_KHR
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

queue is a queue that is capable of presentation to the -- target surface’s platform on the same device as the image’s -- swapchain.

-- --

pPresentInfo is a pointer to an instance of the -- VkPresentInfoKHR structure specifying the parameters of the -- presentation.

-- --

Description

-- -- Note -- -- There is no requirement for an application to present images in the -- same order that they were acquired - applications can arbitrarily -- present any image that is currently acquired. -- --

Valid Usage

-- --

Each element of pSwapchains member of -- pPresentInfo must be a swapchain that is created for a -- surface for which presentation is supported from queue as -- determined using a call to -- vkGetPhysicalDeviceSurfaceSupportKHR

-- --

If more than one member of pSwapchains was created from a -- display surface, all display surfaces referenced that refer to the -- same display must use the same display mode
When a semaphore unsignal operation defined by the elements of the -- pWaitSemaphores member of pPresentInfo executes on -- queue, no other queue must be waiting on the same -- semaphore.
All elements of the pWaitSemaphores member of -- pPresentInfo must be semaphores that are signaled, or -- have semaphore signal operations previously submitted for -- execution.

-- -- Any writes to memory backing the images referenced by the -- pImageIndices and pSwapchains members of -- pPresentInfo, that are available before -- vkQueuePresentKHR is executed, are automatically made visible -- to the read access performed by the presentation engine. This -- automatic visibility operation for an image happens-after the -- semaphore signal operation, and happens-before the presentation engine -- accesses the image. -- -- Queueing an image for presentation defines a set of queue -- operations, including waiting on the semaphores and submitting a -- presentation request to the presentation engine. However, the scope of -- this set of queue operations does not include the actual processing of -- the image by the presentation engine. -- -- If vkQueuePresentKHR fails to enqueue the corresponding set -- of queue operations, it may return -- VK_ERROR_OUT_OF_HOST_MEMORY or -- VK_ERROR_OUT_OF_DEVICE_MEMORY. If it does, the implementation -- must ensure that the state and contents of any resources or -- synchronization primitives referenced is unaffected by the call or its -- failure. -- -- If vkQueuePresentKHR fails in such a way that the -- implementation is unable to make that guarantee, the implementation -- must return VK_ERROR_DEVICE_LOST. -- -- However, if the presentation request is rejected by the presentation -- engine with an error VK_ERROR_OUT_OF_DATE_KHR or -- VK_ERROR_SURFACE_LOST_KHR, the set of queue operations are -- still considered to be enqueued and thus any semaphore to be waited on -- gets unsignaled when the corresponding queue operation is complete. -- --

Valid Usage (Implicit)

-- --

queue must be a valid VkQueue handle

-- --

pPresentInfo must be a valid pointer to a valid -- VkPresentInfoKHR structure

-- --

Host Synchronization

-- --

Host access to queue must be externally -- synchronized

-- --

Host access to pPresentInfo.pWaitSemaphores[] must -- be externally synchronized
Host access to pPresentInfo.pSwapchains[] must be -- externally synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | -               | -               | Any             | -               |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_SUBOPTIMAL_KHR
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_OUT_OF_DATE_KHR
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

device is the logical device.

-- --

pDeviceGroupPresentCapabilities is a pointer to a -- structure of type VkDeviceGroupPresentCapabilitiesKHR that is -- filled with the logical device’s capabilities.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pDeviceGroupPresentCapabilities must be a valid -- pointer to a VkDeviceGroupPresentCapabilitiesKHR -- structure

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device.

-- --

surface is the surface.
pModes is a pointer to a value of type -- VkDeviceGroupPresentModeFlagsKHR that is filled with the -- supported device group present modes for the surface.

-- --

Description

-- -- The modes returned by this command are not invariant, and may -- change in response to the surface being moved, resized, or occluded. -- These modes must be a subset of the modes returned by -- vkGetDeviceGroupPresentCapabilitiesKHR. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pModes must be a valid pointer to a -- VkDeviceGroupPresentModeFlagsKHR value
Both of device, and surface must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

pAcquireInfo is a pointer to a structure of type -- VkAcquireNextImageInfoKHR containing parameters of the -- acquire.
pImageIndex is a pointer to a uint32_t that is -- set to the index of the next image to use.

-- --

Description

-- --

Valid Usage

-- --

If the number of currently acquired images is greater than the -- difference between the number of images in the swapchain -- member of pAcquireInfo and the value of -- VkSurfaceCapabilitiesKHR::minImageCount as returned by -- a call to vkGetPhysicalDeviceSurfaceCapabilities2KHR with the -- surface used to create swapchain, the -- timeout member of pAcquireInfo must not be -- UINT64_MAX

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pAcquireInfo must be a valid pointer to a valid -- VkAcquireNextImageInfoKHR structure
pImageIndex must be a valid pointer to a -- uint32_t value

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_TIMEOUT
```
- ```
VK_NOT_READY
```
- ```
VK_SUBOPTIMAL_KHR
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_OUT_OF_DATE_KHR
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

surface is the surface.
pRectCount is a pointer to an integer related to the -- number of rectangles available or queried, as described below.
pRects is either NULL or a pointer to an array -- of VkRect2D structures.

-- --

Description

-- -- If pRects is NULL, then the number of rectangles -- used when presenting the given surface is returned in -- pRectCount. Otherwise, pRectCount must point -- to a variable set by the user to the number of elements in the -- pRects array, and on return the variable is overwritten with -- the number of structures actually written to pRects. If the -- value of pRectCount is less than the number of rectangles, at -- most pRectCount structures will be written. If -- pRectCount is smaller than the number of rectangles used for -- the given surface, VK_INCOMPLETE will be returned -- instead of VK_SUCCESS to indicate that not all the available -- values were returned. -- -- The values returned by this command are not invariant, and may -- change in response to the surface being moved, resized, or occluded. -- -- The rectangles returned by this command must not overlap. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

surface must be a valid VkSurfaceKHR -- handle
pRectCount must be a valid pointer to a -- uint32_t value
If the value referenced by pRectCount is not 0, -- and pRects is not NULL, pRects must -- be a valid pointer to an array of pRectCount -- VkRect2D structures
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- VkInstance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- -- Note -- -- On some platforms, it is normal that maxImageExtent -- may become (0, 0), for example when the window is -- minimized. In such a case, it is not possible to create a swapchain -- due to the Valid Usage requirements. -- --

imageArrayLayers is the number of views in a -- multiview/stereo surface. For non-stereoscopic-3D applications, this -- value is 1.
imageUsage is a bitmask of VkImageUsageFlagBits -- describing the intended usage of the (acquired) swapchain images.
imageSharingMode is the sharing mode used for the -- image(s) of the swapchain.
queueFamilyIndexCount is the number of queue families -- having access to the image(s) of the swapchain when -- imageSharingMode is VK_SHARING_MODE_CONCURRENT.
pQueueFamilyIndices is an array of queue family indices -- having access to the images(s) of the swapchain when -- imageSharingMode is VK_SHARING_MODE_CONCURRENT.
preTransform is a VkSurfaceTransformFlagBitsKHR -- value describing the transform, relative to the presentation engine’s -- natural orientation, applied to the image content prior to -- presentation. If it does not match the currentTransform value -- returned by vkGetPhysicalDeviceSurfaceCapabilitiesKHR, the -- presentation engine will transform the image content as part of the -- presentation operation.
compositeAlpha is a VkCompositeAlphaFlagBitsKHR -- value indicating the alpha compositing mode to use when this surface -- is composited together with other surfaces on certain window -- systems.
presentMode is the presentation mode the swapchain will -- use. A swapchain’s present mode determines how incoming present -- requests will be processed and queued internally.
clipped specifies whether the Vulkan implementation is -- allowed to discard rendering operations that affect regions of the -- surface that are not visible.
- If set to VK_TRUE, the -- presentable images associated with the swapchain may not own -- all of their pixels. Pixels in the presentable images that correspond -- to regions of the target surface obscured by another window on the -- desktop, or subject to some other clipping mechanism will have -- undefined content when read back. Pixel shaders may not execute -- for these pixels, and thus any side effects they would have had will -- not occur. VK_TRUE value does not guarantee any clipping will -- occur, but allows more optimal presentation methods to be used on some -- platforms.
- If set to VK_FALSE, presentable images -- associated with the swapchain will own all of the pixels they -- contain.

-- -- Note -- -- Applications should set this value to VK_TRUE if they -- do not expect to read back the content of presentable images before -- presenting them or after reacquiring them, and if their pixel shaders -- do not have any side effects that require them to run for all pixels -- in the presentable image. -- --

oldSwapchain is VK_NULL_HANDLE, or the existing -- non-retired swapchain currently associated with surface. -- Providing a valid oldSwapchain may aid in the resource -- reuse, and also allows the application to still present any images -- that are already acquired from it.

-- -- Upon calling vkCreateSwapchainKHR with an -- oldSwapchain that is not VK_NULL_HANDLE, -- oldSwapchain is retired — even if creation of the new -- swapchain fails. The new swapchain is created in the non-retired state -- whether or not oldSwapchain is VK_NULL_HANDLE. -- -- Upon calling vkCreateSwapchainKHR with an -- oldSwapchain that is not VK_NULL_HANDLE, any images -- from oldSwapchain that are not acquired by the application -- may be freed by the implementation, which may occur even -- if creation of the new swapchain fails. The application can -- destroy oldSwapchain to free all memory associated with -- oldSwapchain. -- -- Note -- -- Multiple retired swapchains can be associated with the same -- VkSurfaceKHR through multiple uses of oldSwapchain -- that outnumber calls to vkDestroySwapchainKHR. -- -- After oldSwapchain is retired, the application can -- pass to vkQueuePresentKHR any images it had already acquired -- from oldSwapchain. E.g., an application may present an image -- from the old swapchain before an image from the new swapchain is ready -- to be presented. As usual, vkQueuePresentKHR may fail if -- oldSwapchain has entered a state that causes -- VK_ERROR_OUT_OF_DATE_KHR to be returned. -- -- The application can continue to use a shared presentable image -- obtained from oldSwapchain until a presentable image is -- acquired from the new swapchain, as long as it has not entered a state -- that causes it to return VK_ERROR_OUT_OF_DATE_KHR. -- --

Valid Usage

-- --

surface must be a surface that is supported by the -- device as determined using -- vkGetPhysicalDeviceSurfaceSupportKHR

-- --

minImageCount must be greater than or equal to the -- value returned in the minImageCount member of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the -- surface
minImageCount must be less than or equal to the -- value returned in the maxImageCount member of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the surface if -- the returned maxImageCount is not zero
minImageCount must be 1 if -- presentMode is either -- VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR
imageFormat and imageColorSpace must -- match the format and colorSpace members, -- respectively, of one of the VkSurfaceFormatKHR structures -- returned by vkGetPhysicalDeviceSurfaceFormatsKHR for the -- surface
imageExtent must be between -- minImageExtent and maxImageExtent, inclusive, where -- minImageExtent and maxImageExtent are members of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the -- surface
imageExtent members width and height -- must both be non-zero
imageArrayLayers must be greater than 0 -- and less than or equal to the maxImageArrayLayers member of -- the VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the -- surface
If presentMode is VK_PRESENT_MODE_IMMEDIATE_KHR, -- VK_PRESENT_MODE_MAILBOX_KHR, -- VK_PRESENT_MODE_FIFO_KHR or -- VK_PRESENT_MODE_FIFO_RELAXED_KHR, imageUsage -- must be a subset of the supported usage flags present in the -- supportedUsageFlags member of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for -- surface
If presentMode is -- VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, -- imageUsage must be a subset of the supported usage -- flags present in the sharedPresentSupportedUsageFlags member -- of the VkSharedPresentSurfaceCapabilitiesKHR structure returned -- by vkGetPhysicalDeviceSurfaceCapabilities2KHR for -- surface
If imageSharingMode is -- VK_SHARING_MODE_CONCURRENT, pQueueFamilyIndices -- must be a valid pointer to an array of -- queueFamilyIndexCount uint32_t values
If imageSharingMode is -- VK_SHARING_MODE_CONCURRENT, queueFamilyIndexCount -- must be greater than 1
If imageSharingMode is -- VK_SHARING_MODE_CONCURRENT, each element of -- pQueueFamilyIndices must be unique and must be -- less than pQueueFamilyPropertyCount returned by either -- vkGetPhysicalDeviceQueueFamilyProperties or -- vkGetPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
preTransform must be one of the bits present in -- the supportedTransforms member of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the -- surface
compositeAlpha must be one of the bits present in -- the supportedCompositeAlpha member of the -- VkSurfaceCapabilitiesKHR structure returned by -- vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the -- surface
presentMode must be one of the -- VkPresentModeKHR values returned by -- vkGetPhysicalDeviceSurfacePresentModesKHR for the -- surface
If the logical device was created with -- VkDeviceGroupDeviceCreateInfo::physicalDeviceCount -- equal to 1, flags must not contain -- VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
oldSwapchain must not be in the retired state
imageFormat, imageUsage, imageExtent, -- and imageArrayLayers must be supported for -- VK_IMAGE_TYPE_2D VK_IMAGE_TILING_OPTIMAL images as -- reported by vkGetPhysicalDeviceImageFormatProperties.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR

-- --

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 -- VkDeviceGroupSwapchainCreateInfoKHR or -- VkSwapchainCounterCreateInfoEXT
Each sType member in the pNext chain must -- be unique
flags must be a valid combination of -- VkSwapchainCreateFlagBitsKHR values
surface must be a valid VkSurfaceKHR -- handle
imageFormat must be a valid VkFormat -- value
imageColorSpace must be a valid -- VkColorSpaceKHR value
imageUsage must be a valid combination of -- VkImageUsageFlagBits values
imageUsage must not be 0
imageSharingMode must be a valid -- VkSharingMode value
preTransform must be a valid -- VkSurfaceTransformFlagBitsKHR value
compositeAlpha must be a valid -- VkCompositeAlphaFlagBitsKHR value
presentMode must be a valid -- VkPresentModeKHR value
If oldSwapchain is not VK_NULL_HANDLE, -- oldSwapchain must be a valid VkSwapchainKHR -- handle
If oldSwapchain is a valid handle, it must have -- been created, allocated, or retrieved from surface
Both of oldSwapchain, and surface that are valid -- handles must have been created, allocated, or retrieved from -- the same VkInstance

-- --

Description

-- -- Before an application can present an image, the image’s layout -- must be transitioned to the -- VK_IMAGE_LAYOUT_PRESENT_SRC_KHR layout, or for a shared -- presentable image the VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR -- layout. -- -- Note -- -- When transitioning the image to -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR or -- VK_IMAGE_LAYOUT_PRESENT_SRC_KHR, there is no need to delay -- subsequent processing, or perform any visibility operations (as -- vkQueuePresentKHR performs automatic visibility operations). To -- achieve this, the dstAccessMask member of the -- VkImageMemoryBarrier should be set to 0, and -- the dstStageMask parameter should be set to -- VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT. -- --

Valid Usage

-- --

Each element of pImageIndices must be the index of -- a presentable image acquired from the swapchain specified by the -- corresponding element of the pSwapchains array, and the -- presented image subresource must be in the -- VK_IMAGE_LAYOUT_PRESENT_SRC_KHR or -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout at the time the -- operation is executed on a VkDevice

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PRESENT_INFO_KHR

-- --

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 VkDeviceGroupPresentInfoKHR, -- VkDisplayPresentInfoKHR, VkPresentRegionsKHR, or -- VkPresentTimesInfoGOOGLE
Each sType member in the pNext chain must -- be unique
If waitSemaphoreCount is not 0, -- pWaitSemaphores must be a valid pointer to an array of -- waitSemaphoreCount valid VkSemaphore handles
pSwapchains must be a valid pointer to an array of -- swapchainCount valid VkSwapchainKHR handles
pImageIndices must be a valid pointer to an array -- of swapchainCount uint32_t values
If pResults is not NULL, pResults -- must be a valid pointer to an array of swapchainCount -- VkResult values
swapchainCount must be greater than -- 0
Both of the elements of pSwapchains, and the elements of -- pWaitSemaphores that are valid handles must have been -- created, allocated, or retrieved from the same -- VkInstance

-- --

Description

-- -- modes always has -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR set. -- -- The present mode flags are also used when presenting an image, in -- VkDeviceGroupPresentInfoKHR::mode. -- -- If a device group only includes a single physical device, then -- modes must equal -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage

-- --

If swapchain is not VK_NULL_HANDLE, the fields of -- VkImageCreateInfo must match the implied image -- creation parameters of the swapchain

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR

-- --

If swapchain is not VK_NULL_HANDLE, -- swapchain must be a valid VkSwapchainKHR -- handle

-- --

Description

-- -- If swapchain is not NULL, the swapchain and -- imageIndex are used to determine the memory that the image is -- bound to, instead of memory and memoryOffset. -- -- Memory can be bound to a swapchain and use the -- pDeviceIndices or pSplitInstanceBindRegions members -- of VkBindImageMemoryDeviceGroupInfo. -- --

Valid Usage

-- --

imageIndex must be less than the number of images -- in swapchain

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR

-- --

swapchain must be a valid VkSwapchainKHR -- handle

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Description

-- -- If vkAcquireNextImageKHR is used, the device mask is considered -- to include all physical devices in the logical device. -- -- Note -- -- vkAcquireNextImage2KHR signals at most one semaphore, even if -- the application requests waiting for multiple physical devices to be -- ready via the deviceMask. However, only a single physical -- device can wait on that semaphore, since the semaphore becomes -- unsignaled when the wait succeeds. For other physical devices to wait -- for the image to be ready, it is necessary for the application to -- submit semaphore signal operation(s) to that first physical device to -- signal additional semaphore(s) after the wait succeeds, which the -- other physical device(s) can wait upon. -- --

Valid Usage

-- --

swapchain must not be in the retired state

-- --

If semaphore is not VK_NULL_HANDLE it must -- be unsignaled
If semaphore is not VK_NULL_HANDLE it must -- not have any uncompleted signal or wait operations pending
If fence is not VK_NULL_HANDLE it must be -- unsignaled and must not be associated with any other queue -- command that has not yet completed execution on that queue
semaphore and fence must not both be -- equal to VK_NULL_HANDLE
deviceMask must be a valid device mask
deviceMask must not be zero
semaphore and fence must not both be -- equal to VK_NULL_HANDLE.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR

-- --

pNext must be NULL
swapchain must be a valid VkSwapchainKHR -- handle
If semaphore is not VK_NULL_HANDLE, -- semaphore must be a valid VkSemaphore -- handle
If fence is not VK_NULL_HANDLE, fence -- must be a valid VkFence handle
Each of fence, semaphore, and swapchain -- that are valid handles must have been created, allocated, or -- retrieved from the same VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Host access to semaphore must be externally -- synchronized
Host access to fence must be externally -- synchronized

-- --

Description

-- -- If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element -- of pDeviceMasks selects which instance of the swapchain image -- is presented. Each element of pDeviceMasks must have -- exactly one bit set, and the corresponding physical device must -- have a presentation engine as reported by -- VkDeviceGroupPresentCapabilitiesKHR. -- -- If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each -- element of pDeviceMasks selects which instance of the -- swapchain image is presented. Each element of pDeviceMasks -- must have exactly one bit set, and some physical device in the -- logical device must include that bit in its -- VkDeviceGroupPresentCapabilitiesKHR::presentMask. -- -- If mode is VK_DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, -- then each element of pDeviceMasks selects which instances of -- the swapchain image are component-wise summed and the sum of those -- images is presented. If the sum in any component is outside the -- representable range, the value of that component is undefined. Each -- element of pDeviceMasks must have a value for which -- all set bits are set in one of the elements of -- VkDeviceGroupPresentCapabilitiesKHR::presentMask. -- -- If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then -- each element of pDeviceMasks selects which instance(s) of the -- swapchain images are presented. For each bit set in each element of -- pDeviceMasks, the corresponding physical device must -- have a presentation engine as reported by -- VkDeviceGroupPresentCapabilitiesKHR. -- -- If VkDeviceGroupPresentInfoKHR is not provided or -- swapchainCount is zero then the masks are considered to be -- 1. If VkDeviceGroupPresentInfoKHR is not provided, -- mode is considered to be -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR. -- --

Valid Usage

-- --

swapchainCount must equal 0 or -- VkPresentInfoKHR::swapchainCount

-- --

If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element -- of pDeviceMasks must have exactly one bit set, and the -- corresponding element of -- VkDeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each -- element of pDeviceMasks must have exactly one bit set, -- and some physical device in the logical device must include -- that bit in its -- VkDeviceGroupPresentCapabilitiesKHR::presentMask.
If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, then each element -- of pDeviceMasks must have a value for which all set -- bits are set in one of the elements of -- VkDeviceGroupPresentCapabilitiesKHR::presentMask
If mode is -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then -- for each bit set in each element of pDeviceMasks, the -- corresponding element of -- VkDeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
The value of each element of pDeviceMasks must be -- equal to the device mask passed in -- VkAcquireNextImageInfoKHR::deviceMask when the image -- index was last acquired
mode must have exactly one bit set, and that bit -- must have been included in -- VkDeviceGroupSwapchainCreateInfoKHR::modes

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR

-- --

If swapchainCount is not 0, -- pDeviceMasks must be a valid pointer to an array of -- swapchainCount uint32_t values
mode must be a valid -- VkDeviceGroupPresentModeFlagBitsKHR value

-- --

Description

-- -- If this structure is not present, modes is considered to be -- VK_DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

-- --

modes must be a valid combination of -- VkDeviceGroupPresentModeFlagBitsKHR values
modes must not be 0

-- --

Host access to pCreateInfos[].surface must be -- externally synchronized

-- --

Host access to pCreateInfos[].oldSwapchain must be -- externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_INCOMPATIBLE_DISPLAY_KHR
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Description

-- -- If the extent of the srcRect and dstRect are not -- equal, the presented pixels will be scaled accordingly. -- --

Valid Usage

-- --

srcRect must specify a rectangular region that is -- a subset of the image being presented

-- --

dstRect must specify a rectangular region that is -- a subset of the visibleRegion parameter of the display mode -- the swapchain being presented uses
If the persistentContent member of the -- VkDisplayPropertiesKHR structure returned by -- vkGetPhysicalDeviceDisplayPropertiesKHR for the display the -- present operation targets then persistent must be -- VK_FALSE

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to obtain the refresh duration -- for.
pDisplayTimingProperties is a pointer to an instance of -- the VkRefreshCycleDurationGOOGLE structure.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
pDisplayTimingProperties must be a valid pointer -- to a VkRefreshCycleDurationGOOGLE structure
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_DEVICE_LOST
- ```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to obtain presentation timing -- information duration for.
pPresentationTimingCount is a pointer to an integer -- related to the number of VkPastPresentationTimingGOOGLE -- structures to query, as described below.
pPresentationTimings is either NULL or a pointer -- to an an array of VkPastPresentationTimingGOOGLE -- structures.

-- --

Description

-- -- If pPresentationTimings is NULL, then the number of -- newly-available timing records for the given swapchain is -- returned in pPresentationTimingCount. Otherwise, -- pPresentationTimingCount must point to a variable set -- by the user to the number of elements in the -- pPresentationTimings array, and on return the variable is -- overwritten with the number of structures actually written to -- pPresentationTimings. If the value of -- pPresentationTimingCount is less than the number of -- newly-available timing records, at most -- pPresentationTimingCount structures will be written. If -- pPresentationTimingCount is smaller than the number of -- newly-available timing records for the given swapchain, -- VK_INCOMPLETE will be returned instead of VK_SUCCESS -- to indicate that not all the available values were returned. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
pPresentationTimingCount must be a valid pointer -- to a uint32_t value
If the value referenced by pPresentationTimingCount is -- not 0, and pPresentationTimings is not -- NULL, pPresentationTimings must be a valid -- pointer to an array of pPresentationTimingCount -- VkPastPresentationTimingGOOGLE structures
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_INCOMPLETE
```

-- --

Failure - -- VK_ERROR_DEVICE_LOST

```
VK_ERROR_OUT_OF_DATE_KHR
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

sType must be -- VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE

-- --

If pTimes is not NULL, pTimes -- must be a valid pointer to an array of swapchainCount -- VkPresentTimeGOOGLE structures
swapchainCount must be greater than -- 0

-- --

Description

-- --

Parameters

-- --

device is the logical device where the swapchain(s) were -- created.

-- --

swapchainCount is the number of swapchains included in -- pSwapchains.
pSwapchains is a pointer to the array of -- swapchainCount VkSwapchainKHR handles.
pMetadata is a pointer to the array of -- swapchainCount VkHdrMetadataEXT structures.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pSwapchains must be a valid pointer to an array of -- swapchainCount valid VkSwapchainKHR handles
pMetadata must be a valid pointer to an array of -- swapchainCount valid VkHdrMetadataEXT -- structures
swapchainCount must be greater than -- 0
Both of device, and the elements of pSwapchains -- must have been created, allocated, or retrieved from the same -- VkInstance

-- --

Members

-- --

device is a logical device on which the event may -- occur.

-- --

pDeviceEventInfo is a pointer to an instance of the -- VkDeviceEventInfoEXT structure describing the event of interest -- to the application.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFence points to a handle in which the resulting fence -- object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pDeviceEventInfo must be a valid pointer to a -- valid VkDeviceEventInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pFence must be a valid pointer to a -- VkFence handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Parameters

-- --

device is a logical device associated with -- display

-- --

display is the display on which the event may -- occur.
pDisplayEventInfo is a pointer to an instance of the -- VkDisplayEventInfoEXT structure describing the event of -- interest to the application.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFence points to a handle in which the resulting fence -- object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

display must be a valid VkDisplayKHR -- handle
pDisplayEventInfo must be a valid pointer to a -- valid VkDisplayEventInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pFence must be a valid pointer to a -- VkFence handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Parameters

-- --

device is the VkDevice associated with -- swapchain.

-- --

swapchain is the swapchain from which to query the -- counter value.
counter is the counter to query.
pCounterValue will return the current value of the -- counter.

-- --

Description

-- -- If a counter is not available because the swapchain is out of date, -- the implementation may return -- VK_ERROR_OUT_OF_DATE_KHR. -- --

Valid Usage

-- --

One or more present commands on swapchain must -- have been processed by the presentation engine.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
counter must be a valid -- VkSurfaceCounterFlagBitsEXT value
pCounterValue must be a valid pointer to a -- uint64_t value
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_DEVICE_LOST
- ```
VK_ERROR_OUT_OF_DATE_KHR
```

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT

-- --

pNext must be NULL
powerState must be a valid -- VkDisplayPowerStateEXT value

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT

-- --

pNext must be NULL
deviceEvent must be a valid -- VkDeviceEventTypeEXT value

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT

-- --

pNext must be NULL
displayEvent must be a valid -- VkDisplayEventTypeEXT value

-- --

Description

-- --

Valid Usage

-- --

The bits in surfaceCounters must be supported by -- VkSwapchainCreateInfoKHR::surface, as reported by -- vkGetPhysicalDeviceSurfaceCapabilities2EXT.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT

-- --

surfaceCounters must be a valid combination of -- VkSurfaceCounterFlagBitsEXT values

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to query.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

swapchain must be a valid VkSwapchainKHR -- handle
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- VkInstance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success - -- VK_SUCCESS
- ```
VK_SUBOPTIMAL_KHR
```

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```
```
VK_ERROR_OUT_OF_DATE_KHR
```
```
VK_ERROR_SURFACE_LOST_KHR
```

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

-- --

Description

-- --

VK_TESSELLATION_DOMAIN_ORIGIN_UPPER_LEFT specifies that -- the origin of the domain space is in the upper left corner, as shown -- in figure -- {html_spec_relative}#img-tessellation-topology-ul.

-- --

VK_TESSELLATION_DOMAIN_ORIGIN_LOWER_LEFT specifies that -- the origin of the domain space is in the lower left corner, as shown -- in figure -- {html_spec_relative}#img-tessellation-topology-ll.

-- -- This enum affects how the VertexOrderCw and -- VertexOrderCcw tessellation execution modes are interpreted, -- since the winding is defined relative to the orientation of the -- domain. -- --

Description

-- --

Valid Usage

-- --

There must be an input attachment at -- pCreateInfo::pSubpasses[subpass].pInputAttachments[inputAttachmentIndex].

-- --

The specified input attachment must have more than one -- aspect mask.
aspectMask must be a subset of the aspect masks in -- the specified input attachment.

-- --

Valid Usage (Implicit)

-- --

aspectMask must be a valid combination of -- VkImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_RENDER_PASS_INPUT_ATTACHMENT_ASPECT_CREATE_INFO

-- --

pAspectReferences must be a valid pointer to an -- array of aspectReferenceCount valid -- VkInputAttachmentAspectReference structures
aspectReferenceCount must be greater than -- 0

-- --

Members

-- -- The members of the VkPhysicalDevicePointClippingProperties -- structure describe the following implementation-dependent limit: -- --

Description

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
pointClippingBehavior is the point clipping behavior -- supported by the implementation, and is of type -- VkPointClippingBehavior.

-- -- If the VkPhysicalDevicePointClippingProperties structure is -- included in the pNext chain of -- VkPhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_POINT_CLIPPING_PROPERTIES

-- --

Description

-- -- When this structure is chained to VkImageViewCreateInfo the -- usage field overrides the implicit usage parameter -- inherited from image creation time and its value is used instead for -- the purposes of determining the valid usage conditions of -- VkImageViewCreateInfo. -- --

Valid Usage

-- --

usage must not include any set bits that were not -- set in the usage member of the VkImageCreateInfo -- structure used to create the image this image view is created -- from.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO

-- --

usage must be a valid combination of -- VkImageUsageFlagBits values
usage must not be 0

-- --

Description

-- -- If the VkPipelineTessellationDomainOriginStateCreateInfo -- structure is included in the pNext chain of -- VkPipelineTessellationStateCreateInfo, it controls the origin -- of the tessellation domain. If this structure is not present, it is as -- if domainOrigin were -- VK_TESSELLATION_DOMAIN_ORIGIN_UPPER_LEFT. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_DOMAIN_ORIGIN_STATE_CREATE_INFO

-- --

domainOrigin must be a valid -- VkTessellationDomainOrigin value

-- --

Description

-- -- VkFramebufferCreateFlags is a bitmask type for setting a -- mask, but is currently reserved for future use. -- --

Description

-- -- VkRenderPassCreateFlags is a bitmask type for setting a mask, -- but is currently reserved for future use. -- --

Description

-- --

VK_ACCESS_INDIRECT_COMMAND_READ_BIT specifies read access -- to an indirect command structure read as part of an indirect drawing -- or dispatch command.

-- --

VK_ACCESS_INDEX_READ_BIT specifies read access to an -- index buffer as part of an indexed drawing command, bound by -- vkCmdBindIndexBuffer.
VK_ACCESS_VERTEX_ATTRIBUTE_READ_BIT specifies read access -- to a vertex buffer as part of a drawing command, bound by -- vkCmdBindVertexBuffers.
VK_ACCESS_UNIFORM_READ_BIT specifies read access to a -- uniform buffer.
VK_ACCESS_INPUT_ATTACHMENT_READ_BIT specifies read access -- to an input attachment within a render pass during fragment -- shading.
VK_ACCESS_SHADER_READ_BIT specifies read access to a -- storage buffer, uniform texel buffer, storage texel -- buffer, sampled image, or storage image.
VK_ACCESS_SHADER_WRITE_BIT specifies write access to a -- storage buffer, storage texel buffer, or storage -- image.
VK_ACCESS_COLOR_ATTACHMENT_READ_BIT specifies read access -- to a color attachment, such as via blending, logic -- operations, or via certain subpass load operations. It does -- not include advanced blend operations.
VK_ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT is -- similar to VK_ACCESS_COLOR_ATTACHMENT_READ_BIT, but also -- includes advanced blend operations.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT specifies write -- access to a color or resolve attachment during a render -- pass or via certain subpass load and store operations.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT specifies -- read access to a depth/stencil attachment, via depth or -- stencil operations or via certain subpass load -- operations.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT specifies -- write access to a depth/stencil attachment, via depth or -- stencil operations or via certain subpass load and store -- operations.
VK_ACCESS_TRANSFER_READ_BIT specifies read access to an -- image or buffer in a copy operation.
VK_ACCESS_TRANSFER_WRITE_BIT specifies write access to an -- image or buffer in a clear or copy operation.
VK_ACCESS_HOST_READ_BIT specifies read access by a host -- operation. Accesses of this type are not performed through a resource, -- but directly on memory.
VK_ACCESS_HOST_WRITE_BIT specifies write access by a host -- operation. Accesses of this type are not performed through a resource, -- but directly on memory.
VK_ACCESS_MEMORY_READ_BIT specifies read access via -- non-specific entities. These entities include the Vulkan device and -- host, but may also include entities external to the Vulkan -- device or otherwise not part of the core Vulkan pipeline. When -- included in a destination access mask, makes all available writes -- visible to all future read accesses on entities known to the Vulkan -- device.
VK_ACCESS_MEMORY_WRITE_BIT specifies write access via -- non-specific entities. These entities include the Vulkan device and -- host, but may also include entities external to the Vulkan -- device or otherwise not part of the core Vulkan pipeline. When -- included in a source access mask, all writes that are performed by -- entities known to the Vulkan device are made available. When included -- in a destination access mask, makes all available writes visible to -- all future write accesses on entities known to the Vulkan device.
VK_ACCESS_COMMAND_PROCESS_READ_BIT_NVX specifies reads -- from VkBuffer inputs to vkCmdProcessCommandsNVX.
VK_ACCESS_COMMAND_PROCESS_WRITE_BIT_NVX specifies writes -- to the target command buffer in vkCmdProcessCommandsNVX.

-- -- Certain access types are only performed by a subset of pipeline -- stages. Any synchronization command that takes both stage masks and -- access masks uses both to define the access scopes - only the -- specified access types performed by the specified stages are included -- in the access scope. An application must not specify an access -- flag in a synchronization command if it does not include a pipeline -- stage in the corresponding stage mask that is able to perform accesses -- of that type. The following table lists, for each access flag, which -- pipeline stages can perform that type of access. -- --

--   +-----------------------------------+-----------------------------------+
--   | Access flag                       | Supported pipeline stages         |
--   +===================================+===================================+
--   | @VK_ACCESS_INDIRECT_COMMAND_READ_ | @VK_PIPELINE_STAGE_DRAW_INDIRECT_ |
--   | BIT@                              | BIT@                              |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_INDEX_READ_BIT@        | @VK_PIPELINE_STAGE_VERTEX_INPUT_B |
--   |                                   | IT@                               |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_VERTEX_ATTRIBUTE_READ_ | @VK_PIPELINE_STAGE_VERTEX_INPUT_B |
--   | BIT@                              | IT@                               |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_UNIFORM_READ_BIT@      | @VK_PIPELINE_STAGE_VERTEX_SHADER_ |
--   |                                   | BIT@,                             |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_C |
--   |                                   | ONTROL_SHADER_BIT@,               |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_E |
--   |                                   | VALUATION_SHADER_BIT@,            |
--   |                                   | @VK_PIPELINE_STAGE_GEOMETRY_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | @VK_PIPELINE_STAGE_FRAGMENT_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | or                                |
--   |                                   | @VK_PIPELINE_STAGE_COMPUTE_SHADER |
--   |                                   | _BIT@                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_INPUT_ATTACHMENT_READ_ | @VK_PIPELINE_STAGE_FRAGMENT_SHADE |
--   | BIT@                              | R_BIT@                            |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_SHADER_READ_BIT@       | @VK_PIPELINE_STAGE_VERTEX_SHADER_ |
--   |                                   | BIT@,                             |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_C |
--   |                                   | ONTROL_SHADER_BIT@,               |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_E |
--   |                                   | VALUATION_SHADER_BIT@,            |
--   |                                   | @VK_PIPELINE_STAGE_GEOMETRY_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | @VK_PIPELINE_STAGE_FRAGMENT_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | or                                |
--   |                                   | @VK_PIPELINE_STAGE_COMPUTE_SHADER |
--   |                                   | _BIT@                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_SHADER_WRITE_BIT@      | @VK_PIPELINE_STAGE_VERTEX_SHADER_ |
--   |                                   | BIT@,                             |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_C |
--   |                                   | ONTROL_SHADER_BIT@,               |
--   |                                   | @VK_PIPELINE_STAGE_TESSELLATION_E |
--   |                                   | VALUATION_SHADER_BIT@,            |
--   |                                   | @VK_PIPELINE_STAGE_GEOMETRY_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | @VK_PIPELINE_STAGE_FRAGMENT_SHADE |
--   |                                   | R_BIT@,                           |
--   |                                   | or                                |
--   |                                   | @VK_PIPELINE_STAGE_COMPUTE_SHADER |
--   |                                   | _BIT@                             |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_COLOR_ATTACHMENT_READ_ | @VK_PIPELINE_STAGE_COLOR_ATTACHME |
--   | BIT@                              | NT_OUTPUT_BIT@                    |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_COLOR_ATTACHMENT_READ_ | @VK_PIPELINE_STAGE_COLOR_ATTACHME |
--   | NONCOHERENT_BIT_EXT@              | NT_OUTPUT_BIT@                    |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_COLOR_ATTACHMENT_WRITE | @VK_PIPELINE_STAGE_COLOR_ATTACHME |
--   | _BIT@                             | NT_OUTPUT_BIT@                    |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_DEPTH_STENCIL_ATTACHME | @VK_PIPELINE_STAGE_EARLY_FRAGMENT |
--   | NT_READ_BIT@                      | _TESTS_BIT@,                      |
--   |                                   | or                                |
--   |                                   | @VK_PIPELINE_STAGE_LATE_FRAGMENT_ |
--   |                                   | TESTS_BIT@                        |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_DEPTH_STENCIL_ATTACHME | @VK_PIPELINE_STAGE_EARLY_FRAGMENT |
--   | NT_WRITE_BIT@                     | _TESTS_BIT@,                      |
--   |                                   | or                                |
--   |                                   | @VK_PIPELINE_STAGE_LATE_FRAGMENT_ |
--   |                                   | TESTS_BIT@                        |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_TRANSFER_READ_BIT@     | @VK_PIPELINE_STAGE_TRANSFER_BIT@  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_TRANSFER_WRITE_BIT@    | @VK_PIPELINE_STAGE_TRANSFER_BIT@  |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_HOST_READ_BIT@         | @VK_PIPELINE_STAGE_HOST_BIT@      |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_HOST_WRITE_BIT@        | @VK_PIPELINE_STAGE_HOST_BIT@      |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_MEMORY_READ_BIT@       | N\/A                              |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_MEMORY_WRITE_BIT@      | N\/A                              |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_COMMAND_PROCESS_READ_B | @VK_PIPELINE_STAGE_COMMAND_PROCES |
--   | IT_NVX@                           | S_BIT_NVX@                        |
--   +-----------------------------------+-----------------------------------+
--   | @VK_ACCESS_COMMAND_PROCESS_WRITE_ | @VK_PIPELINE_STAGE_COMMAND_PROCES |
--   | BIT_NVX@                          | S_BIT_NVX@                        |
--   +-----------------------------------+-----------------------------------+
--   
--   Supported access types
--

-- -- If a memory object does not have the -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT property, then -- vkFlushMappedMemoryRanges must be called in order to -- guarantee that writes to the memory object from the host are made -- visible to the VK_ACCESS_HOST_WRITE_BIT access type, -- where it can be further made available to the device by -- synchronization commands. Similarly, -- vkInvalidateMappedMemoryRanges must be called to -- guarantee that writes which are visible to the -- VK_ACCESS_HOST_READ_BIT access type are made visible -- to host operations. -- -- If the memory object does have the -- VK_MEMORY_PROPERTY_HOST_COHERENT_BIT property flag, writes to -- the memory object from the host are automatically made visible to the -- VK_ACCESS_HOST_WRITE_BIT access type. Similarly, -- writes made visible to the VK_ACCESS_HOST_READ_BIT access -- type are automatically made visible to the host. -- -- Note -- -- The vkQueueSubmit command automatically guarantees that host -- writes flushed to VK_ACCESS_HOST_WRITE_BIT are made available if -- they were flushed before the command executed, so in most cases an -- explicit memory barrier is not needed for this case. In the few -- circumstances where a submit does not occur between the host write and -- the device read access, writes can be made available by using -- an explicit memory barrier. -- --

Description

-- --

Parameters

-- --

device is the logical device that creates the -- framebuffer.

-- --

pCreateInfo points to a VkFramebufferCreateInfo -- structure which describes additional information about framebuffer -- creation.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFramebuffer points to a VkFramebuffer handle in -- which the resulting framebuffer object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkFramebufferCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pFramebuffer must be a valid pointer to a -- VkFramebuffer handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- framebuffer.

-- --

framebuffer is the handle of the framebuffer to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to framebuffer -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- framebuffer was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- framebuffer was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If framebuffer is not VK_NULL_HANDLE, -- framebuffer must be a valid VkFramebuffer -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If framebuffer is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to framebuffer must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that creates the render -- pass.

-- --

pCreateInfo is a pointer to an instance of the -- VkRenderPassCreateInfo structure that describes the parameters -- of the render pass.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pRenderPass points to a VkRenderPass handle in -- which the resulting render pass object is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkRenderPassCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pRenderPass must be a valid pointer to a -- VkRenderPass handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the render -- pass.

-- --

renderPass is the handle of the render pass to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to renderPass -- must have completed execution

-- --

If VkAllocationCallbacks were provided when -- renderPass was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- renderPass was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If renderPass is not VK_NULL_HANDLE, -- renderPass must be a valid VkRenderPass -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If renderPass is a valid handle, it must have been -- created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to renderPass must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the render -- pass.

-- --

renderPass is a handle to a render pass.
pGranularity points to a VkExtent2D structure in -- which the granularity is returned.

-- --

Description

-- -- The conditions leading to an optimal renderArea are: -- --

the offset.x member in renderArea is a multiple -- of the width member of the returned VkExtent2D (the -- horizontal granularity).
the offset.y member in renderArea is a multiple -- of the height of the returned VkExtent2D (the vertical -- granularity).
either the offset.width member in renderArea is -- a multiple of the horizontal granularity or -- offset.x+offset.width is equal to the width -- of the framebuffer in the VkRenderPassBeginInfo.
either the offset.height member in renderArea is -- a multiple of the vertical granularity or -- offset.y+offset.height is equal to the -- height of the framebuffer in the -- VkRenderPassBeginInfo.

-- -- Subpass dependencies are not affected by the render area, and apply to -- the entire image subresources attached to the framebuffer as specified -- in the description of automatic layout transitions. Similarly, -- pipeline barriers are valid even if their effect extends outside the -- render area. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

renderPass must be a valid VkRenderPass -- handle
pGranularity must be a valid pointer to a -- VkExtent2D structure
renderPass must have been created, allocated, or -- retrieved from device

-- --

Description

-- -- If the attachment uses a color format, then loadOp and -- storeOp are used, and stencilLoadOp and -- stencilStoreOp are ignored. If the format has depth and/or -- stencil components, loadOp and storeOp apply only to -- the depth data, while stencilLoadOp and -- stencilStoreOp define how the stencil data is handled. -- loadOp and stencilLoadOp define the load -- operations that execute as part of the first subpass that uses the -- attachment. storeOp and stencilStoreOp define the -- store operations that execute as part of the last subpass that -- uses the attachment. -- -- The load operation for each sample in an attachment happens-before any -- recorded command which accesses the sample in the first subpass where -- the attachment is used. Load operations for attachments with a -- depth/stencil format execute in the -- VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT pipeline stage. -- Load operations for attachments with a color format execute in the -- VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage. -- -- The store operation for each sample in an attachment happens-after any -- recorded command which accesses the sample in the last subpass where -- the attachment is used. Store operations for attachments with a -- depth/stencil format execute in the -- VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT pipeline stage. -- Store operations for attachments with a color format execute in the -- VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage. -- -- If an attachment is not used by any subpass, then loadOp, -- storeOp, stencilStoreOp, and stencilLoadOp -- are ignored, and the attachment’s memory contents will not be modified -- by execution of a render pass instance. -- -- The load and store operations apply on the first and last use of each -- view in the render pass, respectively. If a view index of an -- attachment is not included in the view mask in any subpass that uses -- it, then the load and store operations are ignored, and the -- attachment’s memory contents will not be modified by execution of a -- render pass instance. -- -- During a render pass instance, input/color attachments with color -- formats that have a component size of 8, 16, or 32 bits must be -- represented in the attachment’s format throughout the instance. -- Attachments with other floating- or fixed-point color formats, or with -- depth components may be represented in a format with a -- precision higher than the attachment format, but must be -- represented with the same range. When such a component is loaded via -- the loadOp, it will be converted into an -- implementation-dependent format used by the render pass. Such -- components must be converted from the render pass format, to -- the format of the attachment, before they are resolved or stored at -- the end of a render pass instance via storeOp. Conversions -- occur as described in Numeric Representation and Computation -- and Fixed-Point Data Conversions. -- -- If flags includes -- VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT, then the attachment -- is treated as if it shares physical memory with another attachment in -- the same render pass. This information limits the ability of the -- implementation to reorder certain operations (like layout transitions -- and the loadOp) such that it is not improperly reordered -- against other uses of the same physical memory via a different -- attachment. This is described in more detail below. -- --

Valid Usage

-- --

finalLayout must not be -- VK_IMAGE_LAYOUT_UNDEFINED or -- VK_IMAGE_LAYOUT_PREINITIALIZED

-- --

Valid Usage (Implicit)

-- --

flags must be a valid combination of -- VkAttachmentDescriptionFlagBits values

-- --

format must be a valid VkFormat value
samples must be a valid -- VkSampleCountFlagBits value
loadOp must be a valid VkAttachmentLoadOp -- value
storeOp must be a valid VkAttachmentStoreOp -- value
stencilLoadOp must be a valid -- VkAttachmentLoadOp value
stencilStoreOp must be a valid -- VkAttachmentStoreOp value
initialLayout must be a valid VkImageLayout -- value
finalLayout must be a valid VkImageLayout -- value

-- --

pipelineBindPoint must be -- VK_PIPELINE_BIND_POINT_GRAPHICS

-- --

colorAttachmentCount must be less than or equal to -- VkPhysicalDeviceLimits::maxColorAttachments
If the first use of an attachment in this render pass is as an -- input attachment, and the attachment is not also used as a color or -- depth/stencil attachment in the same subpass, then loadOp -- must not be VK_ATTACHMENT_LOAD_OP_CLEAR
If pResolveAttachments is not NULL, for each -- resolve attachment that does not have the value -- VK_ATTACHMENT_UNUSED, the corresponding color attachment -- must not have the value VK_ATTACHMENT_UNUSED
If pResolveAttachments is not NULL, the sample -- count of each element of pColorAttachments must be -- anything other than VK_SAMPLE_COUNT_1_BIT
Each element of pResolveAttachments must have a -- sample count of VK_SAMPLE_COUNT_1_BIT
Each element of pResolveAttachments must have the -- same VkFormat as its corresponding color attachment
All attachments in pColorAttachments that are not -- VK_ATTACHMENT_UNUSED must have the same sample -- count
All attachments in pColorAttachments that are not -- VK_ATTACHMENT_UNUSED must have a sample count that is -- smaller than or equal to the sample count of -- pDepthStencilAttachment if it is not -- VK_ATTACHMENT_UNUSED
If any input attachments are VK_ATTACHMENT_UNUSED, then -- any pipelines bound during the subpass must not access those -- input attachments from the fragment shader
The attachment member of each element of -- pPreserveAttachments must not be -- VK_ATTACHMENT_UNUSED
Each element of pPreserveAttachments must not also -- be an element of any other member of the subpass description
If any attachment is used as both an input attachment and a color -- or depth/stencil attachment, then each use must use the same -- layout
If flags includes -- VK_SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX, it -- must also include -- VK_SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX.

-- --

Valid Usage (Implicit)

-- --

flags must be a valid combination of -- VkSubpassDescriptionFlagBits values

-- --

pipelineBindPoint must be a valid -- VkPipelineBindPoint value
If inputAttachmentCount is not 0, -- pInputAttachments must be a valid pointer to an array -- of inputAttachmentCount valid VkAttachmentReference -- structures
If colorAttachmentCount is not 0, -- pColorAttachments must be a valid pointer to an array -- of colorAttachmentCount valid VkAttachmentReference -- structures
If colorAttachmentCount is not 0, and -- pResolveAttachments is not NULL, -- pResolveAttachments must be a valid pointer to an -- array of colorAttachmentCount valid -- VkAttachmentReference structures
If pDepthStencilAttachment is not NULL, -- pDepthStencilAttachment must be a valid pointer to a -- valid VkAttachmentReference structure
If preserveAttachmentCount is not 0, -- pPreserveAttachments must be a valid pointer to an -- array of preserveAttachmentCount uint32_t -- values

-- --

Description

-- -- If srcSubpass is equal to dstSubpass then the -- VkSubpassDependency describes a subpass self-dependency, -- and only constrains the pipeline barriers allowed within a subpass -- instance. Otherwise, when a render pass instance which includes a -- subpass dependency is submitted to a queue, it defines a memory -- dependency between the subpasses identified by srcSubpass and -- dstSubpass. -- -- If srcSubpass is equal to VK_SUBPASS_EXTERNAL, the -- first synchronization scope includes commands that occur -- earlier in submission order than the -- vkCmdBeginRenderPass used to begin the render pass instance. -- Otherwise, the first set of commands includes all commands submitted -- as part of the subpass instance identified by srcSubpass and -- any load, store or multisample resolve operations on attachments used -- in srcSubpass. In either case, the first synchronization -- scope is limited to operations on the pipeline stages determined by -- the source stage mask specified by srcStageMask. -- -- If dstSubpass is equal to VK_SUBPASS_EXTERNAL, the -- second synchronization scope includes commands that occur later -- in submission order than the vkCmdEndRenderPass used to -- end the render pass instance. Otherwise, the second set of commands -- includes all commands submitted as part of the subpass instance -- identified by dstSubpass and any load, store or multisample -- resolve operations on attachments used in dstSubpass. In -- either case, the second synchronization scope is limited to operations -- on the pipeline stages determined by the destination stage mask -- specified by dstStageMask. -- -- The first access scope is limited to access in the pipeline -- stages determined by the source stage mask specified by -- srcStageMask. It is also limited to access types in the -- source access mask specified by srcAccessMask. -- -- The second access scope is limited to access in the pipeline -- stages determined by the destination stage mask specified by -- dstStageMask. It is also limited to access types in the -- destination access mask specified by dstAccessMask. -- -- The availability and visibility operations defined by a subpass -- dependency affect the execution of image layout transitions -- within the render pass. -- -- Note -- -- For non-attachment resources, the memory dependency expressed by -- subpass dependency is nearly identical to that of a -- VkMemoryBarrier (with matching -- srcAccessMask/dstAccessMask parameters) submitted as -- a part of a vkCmdPipelineBarrier (with matching -- srcStageMask/dstStageMask parameters). The only -- difference being that its scopes are limited to the identified -- subpasses rather than potentially affecting everything before and -- after. -- -- For attachments however, subpass dependencies work more like an -- VkImageMemoryBarrier defined similarly to the -- VkMemoryBarrier above, the queue family indices set to -- VK_QUEUE_FAMILY_IGNORED, and layouts as follows: -- --

The equivalent to oldLayout is the attachment’s layout -- according to the subpass description for srcSubpass.
The equivalent to newLayout is the attachment’s layout -- according to the subpass description for dstSubpass.

-- --

Valid Usage

-- --

If srcSubpass is not VK_SUBPASS_EXTERNAL, -- srcStageMask must not include -- VK_PIPELINE_STAGE_HOST_BIT

-- --

If dstSubpass is not VK_SUBPASS_EXTERNAL, -- dstStageMask must not include -- VK_PIPELINE_STAGE_HOST_BIT
If the geometry shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
srcSubpass must be less than or equal to -- dstSubpass, unless one of them is -- VK_SUBPASS_EXTERNAL, to avoid cyclic dependencies and ensure -- a valid execution order
srcSubpass and dstSubpass must not both -- be equal to VK_SUBPASS_EXTERNAL
If srcSubpass is equal to dstSubpass, -- srcStageMask and dstStageMask must only -- contain one of VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT, -- VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT, -- VK_PIPELINE_STAGE_VERTEX_INPUT_BIT, -- VK_PIPELINE_STAGE_VERTEX_SHADER_BIT, -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT, -- VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, -- VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, -- VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT, -- VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, -- VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, or -- VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT
If srcSubpass is equal to dstSubpass and not all -- of the stages in srcStageMask and dstStageMask are -- framebuffer-space stages, the logically latest pipeline -- stage in srcStageMask must be logically earlier -- than or equal to the logically earliest pipeline stage in -- dstStageMask
Any access flag included in srcAccessMask must be -- supported by one of the pipeline stages in srcStageMask, as -- specified in the table of supported access types.
Any access flag included in dstAccessMask must be -- supported by one of the pipeline stages in dstStageMask, as -- specified in the table of supported access types.
If dependencyFlags includes -- VK_DEPENDENCY_VIEW_LOCAL_BIT, then both srcSubpass -- and dstSubpass must not equal -- VK_SUBPASS_EXTERNAL
If dependencyFlags includes -- VK_DEPENDENCY_VIEW_LOCAL_BIT, then the render pass -- must have multiview enabled
If srcSubpass equals dstSubpass and that subpass -- has more than one bit set in the view mask, then -- dependencyFlags must include -- VK_DEPENDENCY_VIEW_LOCAL_BIT

-- --

Valid Usage (Implicit)

-- --

srcStageMask must be a valid combination of -- VkPipelineStageFlagBits values

-- --

srcStageMask must not be 0
dstStageMask must be a valid combination of -- VkPipelineStageFlagBits values
dstStageMask must not be 0
srcAccessMask must be a valid combination of -- VkAccessFlagBits values
dstAccessMask must be a valid combination of -- VkAccessFlagBits values
dependencyFlags must be a valid combination of -- VkDependencyFlagBits values

-- --

Description

-- --

Valid Usage

-- --

If any two subpasses operate on attachments with overlapping -- ranges of the same VkDeviceMemory object, and at least one -- subpass writes to that area of VkDeviceMemory, a subpass -- dependency must be included (either directly or via some -- intermediate subpasses) between them

-- --

If the attachment member of any element of -- pInputAttachments, pColorAttachments, -- pResolveAttachments or pDepthStencilAttachment, or -- the attachment indexed by any element of pPreserveAttachments -- in any element of pSubpasses is bound to a range of a -- VkDeviceMemory object that overlaps with any other attachment -- in any subpass (including the same subpass), the -- VkAttachmentDescription structures describing them -- must include VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT -- in flags
If the attachment member of any element of -- pInputAttachments, pColorAttachments, -- pResolveAttachments or pDepthStencilAttachment, or -- any element of pPreserveAttachments in any element of -- pSubpasses is not VK_ATTACHMENT_UNUSED, it -- must be less than attachmentCount
The value of each element of the pPreserveAttachments -- member in each element of pSubpasses must not be -- VK_ATTACHMENT_UNUSED
For any member of pAttachments with a loadOp -- equal to VK_ATTACHMENT_LOAD_OP_CLEAR, the first use of that -- attachment must not specify a layout equal to -- VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL or -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL.
For any member of pAttachments with a loadOp -- equal to VK_ATTACHMENT_LOAD_OP_CLEAR, the first use of that -- attachment must not specify a layout equal to -- VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL.
For any member of pAttachments with a -- stencilLoadOp equal to VK_ATTACHMENT_LOAD_OP_CLEAR, -- the first use of that attachment must not specify a -- layout equal to -- VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL.
For any element of pDependencies, if the -- srcSubpass is not VK_SUBPASS_EXTERNAL, all stage -- flags included in the srcStageMask member of that dependency -- must be a pipeline stage supported by the pipeline -- identified by the pipelineBindPoint member of the source -- subpass.
For any element of pDependencies, if the -- dstSubpass is not VK_SUBPASS_EXTERNAL, all stage -- flags included in the dstStageMask member of that dependency -- must be a pipeline stage supported by the pipeline -- identified by the pipelineBindPoint member of the source -- subpass.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO

-- --

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 -- VkRenderPassInputAttachmentAspectCreateInfo or -- VkRenderPassMultiviewCreateInfo
Each sType member in the pNext chain must -- be unique
flags must be 0
If attachmentCount is not 0, -- pAttachments must be a valid pointer to an array of -- attachmentCount valid VkAttachmentDescription -- structures
pSubpasses must be a valid pointer to an array of -- subpassCount valid VkSubpassDescription -- structures
If dependencyCount is not 0, -- pDependencies must be a valid pointer to an array of -- dependencyCount valid VkSubpassDependency -- structures
subpassCount must be greater than 0

-- --

Description

-- -- Applications must ensure that all accesses to memory that backs -- image subresources used as attachments in a given renderpass instance -- either happen-before the load operations for those attachments, -- or happen-after the store operations for those attachments. -- -- For depth/stencil attachments, each aspect can be used -- separately as attachments and non-attachments as long as the -- non-attachment accesses are also via an image subresource in either -- the -- VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL -- layout or the -- VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL -- layout, and the attachment resource uses whichever of those two -- layouts the image accesses do not. Use of non-attachment aspects in -- this case is only well defined if the attachment is used in the -- subpass where the non-attachment access is being made, or the layout -- of the image subresource is constant throughout the entire render pass -- instance, including the initialLayout and -- finalLayout. -- -- Note -- -- These restrictions mean that the render pass has full knowledge of all -- uses of all of the attachments, so that the implementation is able to -- make correct decisions about when and how to perform layout -- transitions, when to overlap execution of subpasses, etc. -- -- It is legal for a subpass to use no color or depth/stencil -- attachments, and rather use shader side effects such as image stores -- and atomics to produce an output. In this case, the subpass continues -- to use the width, height, and layers of the -- framebuffer to define the dimensions of the rendering area, and the -- rasterizationSamples from each pipeline’s -- VkPipelineMultisampleStateCreateInfo to define the number of -- samples used in rasterization; however, if -- VkPhysicalDeviceFeatures::variableMultisampleRate is -- VK_FALSE, then all pipelines to be bound with a given -- zero-attachment subpass must have the same value for -- VkPipelineMultisampleStateCreateInfo::rasterizationSamples. -- --

Valid Usage

-- --

attachmentCount must be equal to the attachment -- count specified in renderPass

-- --

Each element of pAttachments that is used as a color -- attachment or resolve attachment by renderPass must -- have been created with a usage value including -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
Each element of pAttachments that is used as a -- depth/stencil attachment by renderPass must have been -- created with a usage value including -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
Each element of pAttachments that is used as an input -- attachment by renderPass must have been created with a -- usage value including -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
Each element of pAttachments must have been -- created with an VkFormat value that matches the VkFormat -- specified by the corresponding VkAttachmentDescription in -- renderPass
Each element of pAttachments must have been -- created with a samples value that matches the -- samples value specified by the corresponding -- VkAttachmentDescription in renderPass
Each element of pAttachments must have dimensions -- at least as large as the corresponding framebuffer dimension
Each element of pAttachments must only specify a -- single mip level
Each element of pAttachments must have been -- created with the identity swizzle
width must be greater than 0.
width must be less than or equal to -- VkPhysicalDeviceLimits::maxFramebufferWidth
height must be greater than 0.
height must be less than or equal to -- VkPhysicalDeviceLimits::maxFramebufferHeight
layers must be greater than 0.
layers must be less than or equal to -- VkPhysicalDeviceLimits::maxFramebufferLayers
Each element of pAttachments that is a 2D or 2D array -- image view taken from a 3D image must not be a depth/stencil -- format

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
renderPass must be a valid VkRenderPass -- handle
If attachmentCount is not 0, -- pAttachments must be a valid pointer to an array of -- attachmentCount valid VkImageView handles
Both of renderPass, and the elements of -- pAttachments that are valid handles must have been -- created, allocated, or retrieved from the same VkDevice

-- --

VK_BLEND_OVERLAP_UNCORRELATED_EXT specifies that there is -- no correlation between the source and destination coverage.

-- --

VK_BLEND_OVERLAP_CONJOINT_EXT specifies that the source -- and destination coverage are considered to have maximal overlap.
VK_BLEND_OVERLAP_DISJOINT_EXT specifies that the source -- and destination coverage are considered to have minimal overlap.

-- --

--   +-----------------------------------+-----------------------------------+
--   | Overlap Mode                      | Weighting Equations               |
--   +===================================+===================================+
--   | @VK_BLEND_OVERLAP_UNCORRELATED_EX | \\[                               |
--   | T@                                |                 \\begin{aligned}  |
--   |                                   |                                   |
--   |                                   |                p_0(A_s,A_d) & = A |
--   |                                   | _sA_d \\\\                        |
--   |                                   |                                   |
--   |                                   |                p_1(A_s,A_d) & = A |
--   |                                   | _s(1-A_d) \\\\                    |
--   |                                   |                                   |
--   |                                   |                p_2(A_s,A_d) & = A |
--   |                                   | _d(1-A_s) \\\\                    |
--   |                                   |                                   |
--   |                                   |              \\end{aligned}\\]    |
--   +-----------------------------------+-----------------------------------+
--   | @VK_BLEND_OVERLAP_CONJOINT_EXT@   | \\[                               |
--   |                                   |                 \\begin{aligned}  |
--   |                                   |                                   |
--   |                                   |                p_0(A_s,A_d) & = m |
--   |                                   | in(A_s,A_d) \\\\                  |
--   |                                   |                                   |
--   |                                   |                p_1(A_s,A_d) & = m |
--   |                                   | ax(A_s-A_d,0) \\\\                |
--   |                                   |                                   |
--   |                                   |                p_2(A_s,A_d) & = m |
--   |                                   | ax(A_d-A_s,0) \\\\                |
--   |                                   |                                   |
--   |                                   |              \\end{aligned}\\]    |
--   +-----------------------------------+-----------------------------------+
--   | @VK_BLEND_OVERLAP_DISJOINT_EXT@   | \\[                               |
--   |                                   |                 \\begin{aligned}  |
--   |                                   |                                   |
--   |                                   |                p_0(A_s,A_d) & = m |
--   |                                   | ax(A_s+A_d-1,0) \\\\              |
--   |                                   |                                   |
--   |                                   |                p_1(A_s,A_d) & = m |
--   |                                   | in(A_s,1-A_d) \\\\                |
--   |                                   |                                   |
--   |                                   |                p_2(A_s,A_d) & = m |
--   |                                   | in(A_d,1-A_s) \\\\                |
--   |                                   |                                   |
--   |                                   |              \\end{aligned}\\]    |
--   +-----------------------------------+-----------------------------------+
--   
--   Advanced Blend Overlap Modes
--

-- --

sType must be -- VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_ADVANCED_STATE_CREATE_INFO_EXT

-- --

blendOverlap must be a valid -- VkBlendOverlapEXT value

-- --

Members

-- -- The members of the VkPhysicalDeviceMultiviewFeatures -- structure describe the following features: -- --

Description

-- --

multiview specifies whether the implementation supports -- multiview rendering within a render pass. If this feature is not -- enabled, the view mask of each subpass must always be -- zero.

-- --

multiviewGeometryShader specifies whether the -- implementation supports multiview rendering within a render pass, with -- geometry shaders. If this feature is not enabled, then a -- pipeline compiled against a subpass with a non-zero view mask -- must not include a geometry shader.
multiviewTessellationShader specifies whether the -- implementation supports multiview rendering within a render pass, with -- tessellation shaders. If this feature is not enabled, then a -- pipeline compiled against a subpass with a non-zero view mask -- must not include any tessellation shaders.

-- -- If the VkPhysicalDeviceMultiviewFeatures structure is -- included in the pNext chain of -- VkPhysicalDeviceFeatures2, it is filled with values indicating -- whether each feature is supported. -- VkPhysicalDeviceMultiviewFeatures can also be used in -- the pNext chain of VkDeviceCreateInfo to enable the -- features. -- --

Valid Usage

-- --

If multiviewGeometryShader is enabled then -- multiview must also be enabled.

-- --

If multiviewTessellationShader is enabled then -- multiview must also be enabled.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES

-- --

Members

-- -- The members of the VkPhysicalDeviceMultiviewProperties -- structure describe the following implementation-dependent limits: -- --

Description

-- --

maxMultiviewViewCount is one greater than the maximum -- view index that can be used in a subpass.

-- --

maxMultiviewInstanceIndex is the maximum valid value of -- instance index allowed to be generated by a drawing command recorded -- within a subpass of a multiview render pass instance.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES

-- -- If the VkPhysicalDeviceMultiviewProperties structure is -- included in the pNext chain of -- VkPhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- --

Description

-- -- When a subpass uses a non-zero view mask, multiview -- functionality is considered to be enabled. Multiview is all-or-nothing -- for a render pass - that is, either all subpasses must have a -- non-zero view mask (though some subpasses may have only one -- view) or all must be zero. Multiview causes all drawing and -- clear commands in the subpass to behave as if they were broadcast to -- each view, where a view is represented by one layer of the framebuffer -- attachments. All draws and clears are broadcast to each view -- index whose bit is set in the view mask. The view index is -- provided in the ViewIndex shader input variable, and color, -- depth/stencil, and input attachments all read/write the layer of the -- framebuffer corresponding to the view index. -- -- If the view mask is zero for all subpasses, multiview is considered to -- be disabled and all drawing commands execute normally, without this -- additional broadcasting. -- -- Some implementations may not support multiview in conjunction -- with geometry shaders or tessellation shaders. -- -- When multiview is enabled, the VK_DEPENDENCY_VIEW_LOCAL_BIT -- bit in a dependency can be used to express a view-local -- dependency, meaning that each view in the destination subpass depends -- on a single view in the source subpass. Unlike pipeline barriers, a -- subpass dependency can potentially have a different view mask -- in the source subpass and the destination subpass. If the dependency -- is view-local, then each view (dstView) in the destination subpass -- depends on the view dstView + pViewOffsets[dependency] in the source -- subpass. If there is not such a view in the source subpass, then this -- dependency does not affect that view in the destination subpass. If -- the dependency is not view-local, then all views in the destination -- subpass depend on all views in the source subpass, and the view offset -- is ignored. A non-zero view offset is not allowed in a -- self-dependency. -- -- The elements of pCorrelationMasks are a set of masks of views -- indicating that views in the same mask may exhibit spatial -- coherency between the views, making it more efficient to render them -- concurrently. Correlation masks must not have a functional -- effect on the results of the multiview rendering. -- -- When multiview is enabled, at the beginning of each subpass all -- non-render pass state is undefined. In particular, each time -- vkCmdBeginRenderPass or vkCmdNextSubpass is called the -- graphics pipeline must be bound, any relevant descriptor sets -- or vertex/index buffers must be bound, and any relevant dynamic -- state or push constants must be set before they are used. -- -- A multiview subpass can declare that its shaders will write -- per-view attributes for all views in a single invocation, by setting -- the VK_SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX bit in -- the subpass description. The only supported per-view attributes are -- position and viewport mask, and per-view position and viewport masks -- are written to output array variables decorated with -- PositionPerViewNV and ViewportMaskPerViewNV, -- respectively. If {html_spec_relative}#VK_NV_viewport_array2 -- is not supported and enabled, ViewportMaskPerViewNV -- must not be used. Values written to elements of -- PositionPerViewNV and ViewportMaskPerViewNV -- must not depend on the ViewIndex. The shader -- must also write to an output variable decorated with -- Position, and the value written to Position -- must equal the value written to -- PositionPerViewNV[ViewIndex]. Similarly, if -- ViewportMaskPerViewNV is written to then the shader -- must also write to an output variable decorated with -- ViewportMaskNV, and the value written to -- ViewportMaskNV must equal the value written to -- ViewportMaskPerViewNV[ViewIndex]. Implementations -- will either use values taken from Position and -- ViewportMaskNV and invoke the shader once for each view, or -- will use values taken from PositionPerViewNV and -- ViewportMaskPerViewNV and invoke the shader fewer times. The -- values written to Position and ViewportMaskNV -- must not depend on the values written to -- PositionPerViewNV and ViewportMaskPerViewNV, or vice -- versa (to allow compilers to eliminate the unused outputs). All -- attributes that do not have *PerViewNV counterparts must not -- depend on ViewIndex. -- -- Per-view attributes are all-or-nothing for a subpass. That is, all -- pipelines compiled against a subpass that includes the -- VK_SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX bit -- must write per-view attributes to the *PerViewNV[] shader -- outputs, in addition to the non-per-view (e.g. Position) -- outputs. Pipelines compiled against a subpass that does not include -- this bit must not include the *PerViewNV[] outputs in their -- interfaces. -- --

Valid Usage

-- --

If subpassCount is not zero, subpassCount -- must be equal to the subpassCount in the -- VkRenderPassCreateInfo structure at the start of the -- chain

-- --

If dependencyCount is not zero, dependencyCount -- must be equal to the dependencyCount in the -- VkRenderPassCreateInfo structure at the start of the -- chain
Each view index must not be set in more than one element of -- pCorrelationMasks
If an element of pViewOffsets is non-zero, the -- corresponding VkSubpassDependency structure must have -- different values of srcSubpass and dstSubpass.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_RENDER_PASS_MULTIVIEW_CREATE_INFO

-- --

If subpassCount is not 0, pViewMasks -- must be a valid pointer to an array of subpassCount -- uint32_t values
If dependencyCount is not 0, -- pViewOffsets must be a valid pointer to an array of -- dependencyCount int32_t values
If correlationMaskCount is not 0, -- pCorrelationMasks must be a valid pointer to an array -- of correlationMaskCount uint32_t values

-- --

Description

-- --

VK_PEER_MEMORY_FEATURE_COPY_SRC_BIT specifies that the -- memory can be accessed as the source of a -- vkCmdCopyBuffer, vkCmdCopyImage, -- vkCmdCopyBufferToImage, or vkCmdCopyImageToBuffer -- command.

-- --

VK_PEER_MEMORY_FEATURE_COPY_DST_BIT specifies that the -- memory can be accessed as the destination of a -- vkCmdCopyBuffer, vkCmdCopyImage, -- vkCmdCopyBufferToImage, or vkCmdCopyImageToBuffer -- command.
VK_PEER_MEMORY_FEATURE_GENERIC_SRC_BIT specifies that the -- memory can be read as any memory access type.
VK_PEER_MEMORY_FEATURE_GENERIC_DST_BIT specifies that the -- memory can be written as any memory access type. Shader atomics -- are considered to be writes.

-- -- Note -- -- The peer memory features of a memory heap also apply to any accesses -- that may be performed during image layout transitions. -- -- VK_PEER_MEMORY_FEATURE_COPY_DST_BIT must be supported -- for all host local heaps and for at least one device local heap. -- -- If a device does not support a peer memory feature, it is still valid -- to use a resource that includes both local and peer memory bindings -- with the corresponding access type as long as only the local bindings -- are actually accessed. For example, an application doing split-frame -- rendering would use framebuffer attachments that include both local -- and peer memory bindings, but would scissor the rendering to only -- update local memory. -- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

heapIndex is the index of the memory heap from which the -- memory is allocated.
localDeviceIndex is the device index of the physical -- device that performs the memory access.
remoteDeviceIndex is the device index of the physical -- device that the memory is allocated for.
pPeerMemoryFeatures is a pointer to a bitmask of -- VkPeerMemoryFeatureFlagBits indicating which types of memory -- accesses are supported for the combination of heap, local, and remote -- devices.

-- --

Description

-- --

Valid Usage

-- --

heapIndex must be less than -- memoryHeapCount

-- --

localDeviceIndex must be a valid device index
remoteDeviceIndex must be a valid device -- index
localDeviceIndex must not equal -- remoteDeviceIndex

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pPeerMemoryFeatures must be a valid pointer to a -- VkPeerMemoryFeatureFlags value
pPeerMemoryFeatures must not be 0

-- --

Parameters

-- --

commandBuffer is command buffer whose current device mask -- is modified.

-- --

deviceMask is the new value of the current device -- mask.

-- --

Description

-- -- deviceMask is used to filter out subsequent commands from -- executing on all physical devices whose bit indices are not set in the -- mask. -- --

Valid Usage

-- --

deviceMask must be a valid device mask value

-- --

deviceMask must not be zero
deviceMask must not include any set bits that were -- not in the -- VkDeviceGroupCommandBufferBeginInfo::deviceMask value -- when the command buffer began recording.
If vkCmdSetDeviceMask is called inside a render pass -- instance, deviceMask must not include any set bits -- that were not in the -- VkDeviceGroupRenderPassBeginInfo::deviceMask value -- when the render pass instance began recording.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, compute, or transfer -- operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   |                 |                 | Transfer        |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

baseGroupX is the start value for the X component of -- WorkgroupId.
baseGroupY is the start value for the Y component of -- WorkgroupId.
baseGroupZ is the start value for the Z component of -- WorkgroupId.
groupCountX is the number of local workgroups to dispatch -- in the X dimension.
groupCountY is the number of local workgroups to dispatch -- in the Y dimension.
groupCountZ is the number of local workgroups to dispatch -- in the Z dimension.

-- --

Description

-- -- When the command is executed, a global workgroup consisting of -- groupCountX × groupCountY × groupCountZ local workgroups is assembled, -- with WorkgroupId values ranging from [baseGroup, baseGroup + -- groupCount) in each component. vkCmdDispatch is equivalent to -- vkCmdDispatchBase(0,0,0,groupCountX,groupCountY,groupCountZ). -- --

Valid Usage

-- --

All valid usage rules from vkCmdDispatch apply

-- --

baseGroupX must be less than -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[0]
baseGroupX must be less than -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1]
baseGroupZ must be less than -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]
groupCountX must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[0] -- minus baseGroupX
groupCountY must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1] -- minus baseGroupY
groupCountZ must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2] -- minus baseGroupZ
If any of baseGroupX, baseGroupY, or -- baseGroupZ are not zero, then the bound compute pipeline -- must have been created with the -- VK_PIPELINE_CREATE_DISPATCH_BASE flag.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support compute operations
This command must only be called outside of a render pass -- instance

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Compute         |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Description

-- -- If VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT is not set, the number -- of instances allocated depends on whether -- VK_MEMORY_HEAP_MULTI_INSTANCE_BIT is set in the memory heap. -- If VK_MEMORY_HEAP_MULTI_INSTANCE_BIT is set, then memory is -- allocated for every physical device in the logical device (as if -- deviceMask has bits set for all device indices). If -- VK_MEMORY_HEAP_MULTI_INSTANCE_BIT is not set, then a single -- instance of memory is allocated (as if deviceMask is set to -- one). -- -- On some implementations, allocations from a multi-instance heap -- may consume memory on all physical devices even if the -- deviceMask excludes some devices. If -- VkPhysicalDeviceGroupProperties::subsetAllocation is -- VK_TRUE, then memory is only consumed for the devices in the -- device mask. -- -- Note -- -- In practice, most allocations on a multi-instance heap will be -- allocated across all physical devices. Unicast allocation support is -- an optional optimization for a minority of allocations. -- --

Valid Usage

-- --

If VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT is set, -- deviceMask must be a valid device mask.

-- --

If VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT is set, -- deviceMask must not be zero

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO

-- --

flags must be a valid combination of -- VkMemoryAllocateFlagBits values

-- --

Description

-- -- The deviceMask serves several purposes. It is an upper bound -- on the set of physical devices that can be used during the -- render pass instance, and the initial device mask when the render pass -- instance begins. Render pass attachment load, store, and resolve -- operations only apply to physical devices included in the device mask. -- Subpass dependencies only apply to the physical devices in the device -- mask. -- -- If deviceRenderAreaCount is not zero, then the elements of -- pDeviceRenderAreas override the value of -- VkRenderPassBeginInfo::renderArea, and provide a -- render area specific to each physical device. These render areas serve -- the same purpose as VkRenderPassBeginInfo::renderArea, -- including controlling the region of attachments that are cleared by -- VK_ATTACHMENT_LOAD_OP_CLEAR and that are resolved into -- resolve attachments. -- -- If this structure is not present, the render pass instance’s device -- mask is the value of -- VkDeviceGroupCommandBufferBeginInfo::deviceMask. If -- this structure is not present or if deviceRenderAreaCount is -- zero, VkRenderPassBeginInfo::renderArea is used for -- all physical devices. -- --

Valid Usage

-- --

deviceMask must be a valid device mask value

-- --

deviceMask must not be zero
deviceMask must be a subset of the command -- buffer’s initial device mask
deviceRenderAreaCount must either be zero or equal -- to the number of physical devices in the logical device.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO

-- --

If deviceRenderAreaCount is not 0, -- pDeviceRenderAreas must be a valid pointer to an array -- of deviceRenderAreaCount VkRect2D structures

-- --

Description

-- -- The initial device mask also acts as an upper bound on the set of -- devices that can ever be in the device mask in the command -- buffer. -- -- If this structure is not present, the initial value of a command -- buffer’s device mask is set to include all physical devices in the -- logical device when the command buffer begins recording. -- --

Valid Usage

-- --

deviceMask must be a valid device mask value

-- --

deviceMask must not be zero

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO

-- --

Description

-- -- If this structure is not present, semaphore operations and command -- buffers execute on device index zero. -- --

Valid Usage

-- --

waitSemaphoreCount must equal -- VkSubmitInfo::waitSemaphoreCount

-- --

commandBufferCount must equal -- VkSubmitInfo::commandBufferCount
signalSemaphoreCount must equal -- VkSubmitInfo::signalSemaphoreCount
All elements of pWaitSemaphoreDeviceIndices and -- pSignalSemaphoreDeviceIndices must be valid device -- indices
All elements of pCommandBufferDeviceMasks must be -- valid device masks

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO

-- --

If waitSemaphoreCount is not 0, -- pWaitSemaphoreDeviceIndices must be a valid pointer to -- an array of waitSemaphoreCount uint32_t values
If commandBufferCount is not 0, -- pCommandBufferDeviceMasks must be a valid pointer to -- an array of commandBufferCount uint32_t values
If signalSemaphoreCount is not 0, -- pSignalSemaphoreDeviceIndices must be a valid pointer -- to an array of signalSemaphoreCount uint32_t -- values

-- --

Description

-- -- These device indices apply to all buffer and image memory binds -- included in the batch that points to this structure. The semaphore -- waits and signals for the batch are executed only by the physical -- device specified by the resourceDeviceIndex. -- -- If this structure is not present, resourceDeviceIndex and -- memoryDeviceIndex are assumed to be zero. -- --

Valid Usage

-- --

resourceDeviceIndex and memoryDeviceIndex -- must both be valid device indices.

-- --

Each memory allocation bound in this batch must have -- allocated an instance for memoryDeviceIndex.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the command -- pool.

-- --

commandPool is the command pool from which the command -- buffers were allocated.
commandBufferCount is the length of the -- pCommandBuffers array.
pCommandBuffers is an array of handles of command buffers -- to free.

-- --

Description

-- -- Any primary command buffer that is in the recording or executable -- state and has any element of pCommandBuffers recorded -- into it, becomes invalid. -- --

Valid Usage

-- --

All elements of pCommandBuffers must not be in the -- pending state

-- --

pCommandBuffers must be a valid pointer to an -- array of commandBufferCount VkCommandBuffer handles, -- each element of which must either be a valid handle or -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

commandPool must be a valid VkCommandPool -- handle
commandBufferCount must be greater than -- 0
commandPool must have been created, allocated, or -- retrieved from device
Each element of pCommandBuffers that is a valid handle -- must have been created, allocated, or retrieved from -- commandPool

-- --

Host Synchronization

-- --

Host access to commandPool must be externally -- synchronized

-- --

Host access to each member of pCommandBuffers must -- be externally synchronized

-- --

Parameters

-- --

commandBuffer is the handle of the command buffer which -- is to be put in the recording state.

-- --

pBeginInfo is an instance of the -- VkCommandBufferBeginInfo structure, which defines additional -- information about how the command buffer begins recording.

-- --

Description

-- --

Valid Usage

-- --

commandBuffer must not be in the recording or -- pending state.

-- --

If commandBuffer was allocated from a -- VkCommandPool which did not have the -- VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT flag set, -- commandBuffer must be in the initial -- state.
If commandBuffer is a secondary command buffer, the -- pInheritanceInfo member of pBeginInfo must be -- a valid VkCommandBufferInheritanceInfo structure
If commandBuffer is a secondary command buffer and either -- the occlusionQueryEnable member of the -- pInheritanceInfo member of pBeginInfo is -- VK_FALSE, or the precise occlusion queries feature is not -- enabled, the queryFlags member of the -- pInheritanceInfo member pBeginInfo must not -- contain VK_QUERY_CONTROL_PRECISE_BIT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pBeginInfo must be a valid pointer to a valid -- VkCommandBufferBeginInfo structure

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

commandBuffer is the command buffer to complete -- recording.

-- --

Description

-- -- If there was an error during recording, the application will be -- notified by an unsuccessful return code returned by -- vkEndCommandBuffer. If the application wishes to further use -- the command buffer, the command buffer must be reset. The -- command buffer must have been in the recording state, -- and is moved to the executable state. -- --

Valid Usage

-- --

commandBuffer must be in the recording -- state.

-- --

If commandBuffer is a primary command buffer, there -- must not be an active render pass instance
All queries made active during the recording of -- commandBuffer must have been made inactive
If commandBuffer is a secondary command buffer, there -- must not be an outstanding vkCmdBeginDebugUtilsLabelEXT -- command recorded to commandBuffer that has not previously -- been ended by a call to vkCmdEndDebugUtilsLabelEXT.
If commandBuffer is a secondary command buffer, there -- must not be an outstanding vkCmdDebugMarkerBeginEXT -- command recorded to commandBuffer that has not previously -- been ended by a call to vkCmdDebugMarkerEndEXT.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

commandBuffer is the command buffer to reset. The command -- buffer can be in any state other than pending, and is -- moved into the initial state.

-- --

flags is a bitmask of VkCommandBufferResetFlagBits -- controlling the reset operation.

-- --

Description

-- -- Any primary command buffer that is in the recording or executable -- state and has commandBuffer recorded into it, becomes -- invalid. -- --

Valid Usage

-- --

commandBuffer must not be in the pending -- state

-- --

commandBuffer must have been allocated from a pool -- that was created with the -- VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

flags must be a valid combination of -- VkCommandBufferResetFlagBits values

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Description

-- --

Valid Usage

-- --

commandBufferCount must be greater than -- 0

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO

-- --

pNext must be NULL
commandPool must be a valid VkCommandPool -- handle
level must be a valid VkCommandBufferLevel -- value

-- --

Members

-- --

sType is the type of this structure.

-- --

pNext is NULL or a pointer to an -- extension-specific structure.
renderPass is a VkRenderPass object defining -- which render passes the VkCommandBuffer will be -- compatible with and can be executed within. If the -- VkCommandBuffer will not be executed within a render pass -- instance, renderPass is ignored.
subpass is the index of the subpass within the render -- pass instance that the VkCommandBuffer will be executed -- within. If the VkCommandBuffer will not be executed within a -- render pass instance, subpass is ignored.
framebuffer optionally refers to the -- VkFramebuffer object that the VkCommandBuffer will -- be rendering to if it is executed within a render pass instance. It -- can be VK_NULL_HANDLE if the framebuffer is not known, -- or if the VkCommandBuffer will not be executed within a -- render pass instance.NoteSpecifying the exact framebuffer that -- the secondary command buffer will be executed with may result -- in better performance at command buffer execution time.
occlusionQueryEnable specifies whether the command buffer -- can be executed while an occlusion query is active in the -- primary command buffer. If this is VK_TRUE, then this command -- buffer can be executed whether the primary command buffer has -- an occlusion query active or not. If this is VK_FALSE, then -- the primary command buffer must not have an occlusion query -- active.
queryFlags specifies the query flags that can be -- used by an active occlusion query in the primary command buffer when -- this secondary command buffer is executed. If this value includes the -- VK_QUERY_CONTROL_PRECISE_BIT bit, then the active query -- can return boolean results or actual sample counts. If this bit -- is not set, then the active query must not use the -- VK_QUERY_CONTROL_PRECISE_BIT bit.
pipelineStatistics is a bitmask of -- VkQueryPipelineStatisticFlagBits specifying the set of pipeline -- statistics that can be counted by an active query in the -- primary command buffer when this secondary command buffer is executed. -- If this value includes a given bit, then this command buffer -- can be executed whether the primary command buffer has a -- pipeline statistics query active that includes this bit or not. If -- this value excludes a given bit, then the active pipeline statistics -- query must not be from a query pool that counts that -- statistic.

-- --

Description

-- --

Valid Usage

-- --

If the inherited queries feature is not enabled, -- occlusionQueryEnable must be VK_FALSE

-- --

If the inherited queries feature is enabled, -- queryFlags must be a valid combination of -- VkQueryControlFlagBits values
If the pipeline statistics queries feature is not enabled, -- pipelineStatistics must be 0

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO

-- --

pNext must be NULL
Both of framebuffer, and renderPass that are -- valid handles must have been created, allocated, or retrieved -- from the same VkDevice

-- --

Description

-- --

Valid Usage

-- --

If flags contains -- VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the -- renderPass member of pInheritanceInfo must be -- a valid VkRenderPass

-- --

If flags contains -- VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the -- subpass member of pInheritanceInfo must be a -- valid subpass index within the renderPass member of -- pInheritanceInfo
If flags contains -- VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the -- framebuffer member of pInheritanceInfo must -- be either VK_NULL_HANDLE, or a valid VkFramebuffer -- that is compatible with the renderPass member of -- pInheritanceInfo

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of VkDeviceGroupCommandBufferBeginInfo
flags must be a valid combination of -- VkCommandBufferUsageFlagBits values

-- --

Description

-- -- VkQueryControlFlags is a bitmask type for setting a mask of -- zero or more VkQueryControlFlagBits. -- --

Description

-- -- VkCommandBufferResetFlags is a bitmask type for setting a -- mask of zero or more VkCommandBufferResetFlagBits. -- --

Description

-- -- VkCommandBufferUsageFlags is a bitmask type for setting a -- mask of zero or more VkCommandBufferUsageFlagBits. -- --

Description

-- --

VK_DESCRIPTOR_TYPE_SAMPLER specifies a sampler -- descriptor.

-- --

VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER specifies a -- combined image sampler descriptor.
VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE specifies a sampled -- image descriptor.
VK_DESCRIPTOR_TYPE_STORAGE_IMAGE specifies a storage -- image descriptor.
VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER specifies a -- uniform texel buffer descriptor.
VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER specifies a -- storage texel buffer descriptor.
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER specifies a uniform -- buffer descriptor.
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER specifies a storage -- buffer descriptor.
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC specifies a -- dynamic uniform buffer descriptor.
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC specifies a -- dynamic storage buffer descriptor.
VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT specifies a input -- attachment descriptor.

-- -- When a descriptor set is updated via elements of -- VkWriteDescriptorSet, members of pImageInfo, -- pBufferInfo and pTexelBufferView are only accessed -- by the implementation when they correspond to descriptor type being -- defined - otherwise they are ignored. The members accessed are as -- follows for each descriptor type: -- --

For VK_DESCRIPTOR_TYPE_SAMPLER, only the sample -- member of each element of -- VkWriteDescriptorSet::pImageInfo is accessed.
For VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, only the -- imageView and imageLayout members of each element of -- VkWriteDescriptorSet::pImageInfo are accessed.
For VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, all -- members of each element of -- VkWriteDescriptorSet::pImageInfo are accessed.
For VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER, -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, all members of -- each element of VkWriteDescriptorSet::pBufferInfo are -- accessed.
For VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of -- VkWriteDescriptorSet::pTexelBufferView is -- accessed.

-- --

Description

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the descriptor -- set layout.

-- --

descriptorSetLayout is the descriptor set layout to -- destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- descriptorSetLayout was created, a compatible set of -- callbacks must be provided here

-- --

If no VkAllocationCallbacks were provided when -- descriptorSetLayout was created, pAllocator -- must be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If descriptorSetLayout is not VK_NULL_HANDLE, -- descriptorSetLayout must be a valid -- VkDescriptorSetLayout handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If descriptorSetLayout is a valid handle, it must -- have been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to descriptorSetLayout must be -- externally synchronized

-- --

Parameters

-- --

device is the logical device that creates the descriptor -- pool.

-- --

pCreateInfo is a pointer to an instance of the -- VkDescriptorPoolCreateInfo structure specifying the state of -- the descriptor pool object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDescriptorPool points to a VkDescriptorPool -- handle in which the resulting descriptor pool object is returned.

-- --

Description

-- -- pAllocator controls host memory allocation as described in -- the Memory Allocation chapter. -- -- The created descriptor pool is returned in pDescriptorPool. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkDescriptorPoolCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pDescriptorPool must be a valid pointer to a -- VkDescriptorPool handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_FRAGMENTATION_EXT
```

-- --

Parameters

-- --

device is the logical device that destroys the descriptor -- pool.

-- --

descriptorPool is the descriptor pool to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- -- When a pool is destroyed, all descriptor sets allocated from the pool -- are implicitly freed and become invalid. Descriptor sets allocated -- from a given pool do not need to be freed before destroying that -- descriptor pool. -- --

Valid Usage

-- --

All submitted commands that refer to descriptorPool (via -- any allocated descriptor sets) must have completed -- execution

-- --

If VkAllocationCallbacks were provided when -- descriptorPool was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- descriptorPool was created, pAllocator must -- be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If descriptorPool is not VK_NULL_HANDLE, -- descriptorPool must be a valid -- VkDescriptorPool handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If descriptorPool is a valid handle, it must have -- been created, allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to descriptorPool must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that owns the descriptor -- pool.

-- --

descriptorPool is the descriptor pool to be reset.
flags is reserved for future use.

-- --

Description

-- -- Resetting a descriptor pool recycles all of the resources from all of -- the descriptor sets allocated from the descriptor pool back to the -- descriptor pool, and the descriptor sets are implicitly freed. -- --

Valid Usage

-- --

All uses of descriptorPool (via any allocated descriptor -- sets) must have completed execution

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

descriptorPool must be a valid -- VkDescriptorPool handle
flags must be 0
descriptorPool must have been created, allocated, -- or retrieved from device

-- --

Host Synchronization

-- --

Host access to descriptorPool must be externally -- synchronized

-- --

Host access to any VkDescriptorSet objects allocated from -- descriptorPool must be externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the descriptor -- pool.

-- --

pAllocateInfo is a pointer to an instance of the -- VkDescriptorSetAllocateInfo structure describing parameters of -- the allocation.
pDescriptorSets is a pointer to an array of -- VkDescriptorSet handles in which the resulting descriptor set -- objects are returned.

-- --

Description

-- -- The allocated descriptor sets are returned in -- pDescriptorSets. -- -- When a descriptor set is allocated, the initial state is largely -- uninitialized and all descriptors are undefined. However, the -- descriptor set can be bound in a command buffer without causing -- errors or exceptions. For descriptor set bindings created with the -- VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT bit set, all -- descriptors in that binding that are dynamically used must have -- been populated before the descriptor set is consumed. For -- descriptor set bindings created without the -- VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT bit set, all -- descriptors in that binding that are statically used must have -- been populated before the descriptor set is consumed. Entries -- that are not used by a pipeline can have uninitialized -- descriptors or descriptors of resources that have been destroyed, and -- executing a draw or dispatch with such a descriptor set bound does not -- cause undefined behavior. This means applications need not populate -- unused entries with dummy descriptors. -- -- If a call to vkAllocateDescriptorSets would cause the total -- number of descriptor sets allocated from the pool to exceed the value -- of VkDescriptorPoolCreateInfo::maxSets used to create -- pAllocateInfo→descriptorPool, then the allocation -- may fail due to lack of space in the descriptor pool. -- Similarly, the allocation may fail due to lack of space if the -- call to vkAllocateDescriptorSets would cause the number of -- any given descriptor type to exceed the sum of all the -- descriptorCount members of each element of -- VkDescriptorPoolCreateInfo::pPoolSizes with a -- member equal to that type. If the allocation fails due to no -- more space in the descriptor pool, and not because of system or device -- memory exhaustion, then VK_ERROR_OUT_OF_POOL_MEMORY -- must be returned. -- -- vkAllocateDescriptorSets can be used to create -- multiple descriptor sets. If the creation of any of those descriptor -- sets fails, then the implementation must destroy all -- successfully created descriptor set objects from this command, set all -- entries of the pDescriptorSets array to VK_NULL_HANDLE -- and return the error. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pAllocateInfo must be a valid pointer to a valid -- VkDescriptorSetAllocateInfo structure
pDescriptorSets must be a valid pointer to an -- array of pAllocateInfo::descriptorSetCount -- VkDescriptorSet handles

-- --

Host Synchronization

-- --

Host access to pAllocateInfo::descriptorPool must -- be externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_FRAGMENTED_POOL
```
```
VK_ERROR_OUT_OF_POOL_MEMORY
```

-- --

Parameters

-- --

device is the logical device that owns the descriptor -- pool.

-- --

descriptorPool is the descriptor pool from which the -- descriptor sets were allocated.
descriptorSetCount is the number of elements in the -- pDescriptorSets array.
pDescriptorSets is an array of handles to -- VkDescriptorSet objects.

-- --

Description

-- -- After a successful call to vkFreeDescriptorSets, all -- descriptor sets in pDescriptorSets are invalid. -- --

Valid Usage

-- --

All submitted commands that refer to any element of -- pDescriptorSets must have completed execution

-- --

pDescriptorSets must be a valid pointer to an -- array of descriptorSetCount VkDescriptorSet handles, -- each element of which must either be a valid handle or -- VK_NULL_HANDLE
Each valid handle in pDescriptorSets must have -- been allocated from descriptorPool
descriptorPool must have been created with the -- VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT flag

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

descriptorPool must be a valid -- VkDescriptorPool handle
descriptorSetCount must be greater than -- 0
descriptorPool must have been created, allocated, -- or retrieved from device
Each element of pDescriptorSets that is a valid handle -- must have been created, allocated, or retrieved from -- descriptorPool

-- --

Host Synchronization

-- --

Host access to descriptorPool must be externally -- synchronized

-- --

Host access to each member of pDescriptorSets must -- be externally synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that updates the descriptor -- sets.

-- --

descriptorWriteCount is the number of elements in the -- pDescriptorWrites array.
pDescriptorWrites is a pointer to an array of -- VkWriteDescriptorSet structures describing the descriptor sets -- to write to.
descriptorCopyCount is the number of elements in the -- pDescriptorCopies array.
pDescriptorCopies is a pointer to an array of -- VkCopyDescriptorSet structures describing the descriptor sets -- to copy between.

-- --

Description

-- -- The operations described by pDescriptorWrites are performed -- first, followed by the operations described by -- pDescriptorCopies. Within each array, the operations are -- performed in the order they appear in the array. -- -- Each element in the pDescriptorWrites array describes an -- operation updating the descriptor set using descriptors for resources -- specified in the structure. -- -- Each element in the pDescriptorCopies array is a -- VkCopyDescriptorSet structure describing an operation copying -- descriptors between sets. -- -- If the dstSet member of any element of -- pDescriptorWrites or pDescriptorCopies is bound, -- accessed, or modified by any command that was recorded to a command -- buffer which is currently in the recording or executable state, -- and any of the descriptor bindings that are updated were not created -- with the VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT or -- VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT -- bits set, that command buffer becomes invalid. -- --

Valid Usage

-- --

Descriptor bindings updated by this command which were created -- without the VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT -- or VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT -- bits set must not be used by any command that was recorded to a -- command buffer which is in the pending state.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If descriptorWriteCount is not 0, -- pDescriptorWrites must be a valid pointer to an array -- of descriptorWriteCount valid VkWriteDescriptorSet -- structures
If descriptorCopyCount is not 0, -- pDescriptorCopies must be a valid pointer to an array -- of descriptorCopyCount valid VkCopyDescriptorSet -- structures

-- --

Host Synchronization

-- --

Host access to pDescriptorWrites[].dstSet must be -- externally synchronized

-- --

Host access to pDescriptorCopies[].dstSet must be -- externally synchronized

-- --

Description

-- -- Note -- -- When setting range to VK_WHOLE_SIZE, the effective -- range must not be larger than the maximum range for the -- descriptor type (maxUniformBufferRange or -- maxStorageBufferRange). This means that VK_WHOLE_SIZE -- is not typically useful in the common case where uniform buffer -- descriptors are suballocated from a buffer that is much larger than -- maxUniformBufferRange. -- -- For VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC and -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC descriptor types, -- offset is the base offset from which the dynamic offset is -- applied and range is the static size used for all dynamic -- offsets. -- --

Valid Usage

-- --

offset must be less than the size of -- buffer

-- --

If range is not equal to VK_WHOLE_SIZE, -- range must be greater than 0
If range is not equal to VK_WHOLE_SIZE, -- range must be less than or equal to the size of -- buffer minus offset

-- --

Valid Usage (Implicit)

-- --

buffer must be a valid VkBuffer -- handle

-- --

Description

-- -- Members of VkDescriptorImageInfo that are not used in an -- update (as described above) are ignored. -- --

Valid Usage

-- --

imageView must not be 2D or 2D array image view -- created from a 3D image

-- --

imageLayout must match the actual -- VkImageLayout of each subresource accessible from -- imageView at the time this descriptor is accessed
If sampler is used and enables sampler Y’CBCR -- conversion:
- The format of the imageView -- must be the same as the VkFormat of the -- image
- The aspectMask of the imageView -- must be VK_IMAGE_ASPECT_COLOR_BIT
- The -- components.a of the imageView must be -- VK_COMPONENT_SWIZZLE_IDENTITY
- The -- components.r of the imageView must be -- VK_COMPONENT_SWIZZLE_IDENTITY
- The -- components.g of the imageView must be -- VK_COMPONENT_SWIZZLE_IDENTITY
- The -- components.b of the imageView must be -- VK_COMPONENT_SWIZZLE_IDENTITY
- The pNext -- chain of the imageView must contain a -- VkSamplerYcbcrConversionInfo which has a conversion -- which is an identically defined object to the -- conversion of the VkSamplerYcbcrConversionInfo which -- is in the pNext chain of the sampler
If sampler is used and does not enable sampler Y’CBCR -- conversion and the VkFormat of the image is a -- multi-planar format, the image must have been created -- with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the -- aspectMask of the imageView must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT or (for three-plane formats only) -- VK_IMAGE_ASPECT_PLANE_2_BIT

-- --

Valid Usage (Implicit)

-- --

Both of imageView, and sampler that are valid -- handles must have been created, allocated, or retrieved from -- the same VkDevice

-- --

Description

-- -- Only one of pImageInfo, pBufferInfo, or -- pTexelBufferView members is used according to the descriptor -- type specified in the descriptorType member of the containing -- VkWriteDescriptorSet structure, as specified below. -- -- If the dstBinding has fewer than descriptorCount -- array elements remaining starting from dstArrayElement, then -- the remainder will be used to update the subsequent binding - -- dstBinding+1 starting at array element zero. If a binding has -- a descriptorCount of zero, it is skipped. This behavior -- applies recursively, with the update affecting consecutive bindings as -- needed to update all descriptorCount descriptors. -- --

Valid Usage

-- --

dstBinding must be less than or equal to the -- maximum value of binding of all -- VkDescriptorSetLayoutBinding structures specified when -- dstSet’s descriptor set layout was created

-- --

dstBinding must be a binding with a non-zero -- descriptorCount
All consecutive bindings updated via a single -- VkWriteDescriptorSet structure, except those with a -- descriptorCount of zero, must have identical -- descriptorType and stageFlags.
All consecutive bindings updated via a single -- VkWriteDescriptorSet structure, except those with a -- descriptorCount of zero, must all either use immutable -- samplers or must all not use immutable samplers.
descriptorType must match the type of -- dstBinding within dstSet
dstSet must be a valid VkDescriptorSet -- handle
The sum of dstArrayElement and descriptorCount -- must be less than or equal to the number of array elements in -- the descriptor set binding specified by dstBinding, and all -- applicable consecutive bindings, as described by -- {html_spec_relative}#descriptorsets-updates-consecutive
If descriptorType is VK_DESCRIPTOR_TYPE_SAMPLER, -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, pImageInfo -- must be a valid pointer to an array of descriptorCount -- valid VkDescriptorImageInfo structures
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, -- pTexelBufferView must be a valid pointer to an array -- of descriptorCount valid VkBufferView handles
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER, -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, -- pBufferInfo must be a valid pointer to an array of -- descriptorCount valid VkDescriptorBufferInfo -- structures
If descriptorType is VK_DESCRIPTOR_TYPE_SAMPLER -- or VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and -- dstSet was not allocated with a layout that included -- immutable samplers for dstBinding with -- descriptorType, the sampler member of each element -- of pImageInfo must be a valid VkSampler -- object
If descriptorType is -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView -- and imageLayout members of each element of -- pImageInfo must be a valid VkImageView and -- VkImageLayout, respectively
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, for each descriptor that -- will be accessed via load or store operations the imageLayout -- member for corresponding elements of pImageInfo must -- be VK_IMAGE_LAYOUT_GENERAL
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the -- offset member of each element of pBufferInfo -- must be a multiple of -- VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the -- offset member of each element of pBufferInfo -- must be a multiple of -- VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER, or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, and the -- buffer member of any element of pBufferInfo is the -- handle of a non-sparse buffer, then that buffer must be bound -- completely and contiguously to a single VkDeviceMemory -- object
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the -- buffer member of each element of pBufferInfo -- must have been created with -- VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT set
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the -- buffer member of each element of pBufferInfo -- must have been created with -- VK_BUFFER_USAGE_STORAGE_BUFFER_BIT set
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the range -- member of each element of pBufferInfo, or the effective range -- if range is VK_WHOLE_SIZE, must be less than -- or equal to -- VkPhysicalDeviceLimits::maxUniformBufferRange
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the range -- member of each element of pBufferInfo, or the effective range -- if range is VK_WHOLE_SIZE, must be less than -- or equal to -- VkPhysicalDeviceLimits::maxStorageBufferRange
If descriptorType is -- VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, the -- VkBuffer that each element of pTexelBufferView was -- created from must have been created with -- VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT set
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, the -- VkBuffer that each element of pTexelBufferView was -- created from must have been created with -- VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT set
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE or -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView -- member of each element of pImageInfo must have been -- created with the identity swizzle
If descriptorType is -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE or -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the -- imageView member of each element of pImageInfo -- must have been created with VK_IMAGE_USAGE_SAMPLED_BIT -- set
If descriptorType is -- VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE or -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the -- imageLayout member of each element of pImageInfo -- must be VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
If descriptorType is -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView -- member of each element of pImageInfo must have been -- created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If descriptorType is -- VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, the imageView -- member of each element of pImageInfo must have been -- created with VK_IMAGE_USAGE_STORAGE_BIT set
All consecutive bindings updated via a single -- VkWriteDescriptorSet structure, except those with a -- descriptorCount of zero, must have identical -- VkDescriptorBindingFlagBitsEXT.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET

-- --

pNext must be NULL
descriptorType must be a valid -- VkDescriptorType value
descriptorCount must be greater than -- 0
Both of dstSet, and the elements of -- pTexelBufferView that are valid handles must have been -- created, allocated, or retrieved from the same VkDevice

-- --

Description

-- --

Valid Usage

-- --

srcBinding must be a valid binding within -- srcSet

-- --

The sum of srcArrayElement and descriptorCount -- must be less than or equal to the number of array elements in -- the descriptor set binding specified by srcBinding, and all -- applicable consecutive bindings, as described by -- {html_spec_relative}#descriptorsets-updates-consecutive
dstBinding must be a valid binding within -- dstSet
The sum of dstArrayElement and descriptorCount -- must be less than or equal to the number of array elements in -- the descriptor set binding specified by dstBinding, and all -- applicable consecutive bindings, as described by -- {html_spec_relative}#descriptorsets-updates-consecutive
If srcSet is equal to dstSet, then the source -- and destination ranges of descriptors must not overlap, where -- the ranges may include array elements from consecutive bindings -- as described by -- {html_spec_relative}#descriptorsets-updates-consecutive
If srcSet’s layout was created with the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- flag set, then dstSet’s layout must also have been -- created with the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- flag set
If srcSet’s layout was created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- flag set, then dstSet’s layout must also have been -- created without the -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT -- flag set
If the descriptor pool from which srcSet was allocated -- was created with the -- VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set, -- then the descriptor pool from which dstSet was allocated -- must also have been created with the -- VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag -- set
If the descriptor pool from which srcSet was allocated -- was created without the -- VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set, -- then the descriptor pool from which dstSet was allocated -- must also have been created without the -- VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag -- set

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET

-- --

pNext must be NULL
srcSet must be a valid VkDescriptorSet -- handle
dstSet must be a valid VkDescriptorSet -- handle
Both of dstSet, and srcSet must have been -- created, allocated, or retrieved from the same VkDevice

-- --

Members

-- --

binding is the binding number of this entry and -- corresponds to a resource of the same binding number in the shader -- stages.

-- --

descriptorType is a VkDescriptorType specifying -- which type of resource descriptors are used for this binding.
descriptorCount is the number of descriptors contained in -- the binding, accessed in a shader as an array. If -- descriptorCount is zero this binding entry is reserved and -- the resource must not be accessed from any stage via this -- binding within any pipeline using the set layout.
stageFlags member is a bitmask of -- VkShaderStageFlagBits specifying which pipeline shader stages -- can access a resource for this binding. -- VK_SHADER_STAGE_ALL is a shorthand specifying that all -- defined shader stages, including any additional stages defined by -- extensions, can access the resource.If a shader stage is not -- included in stageFlags, then a resource must not be -- accessed from that stage via this binding within any pipeline using -- the set layout. Other than input attachments which are limited to the -- fragment shader, there are no limitations on what combinations of -- stages can use a descriptor binding, and in particular a -- binding can be used by both graphics stages and the compute -- stage.

-- --

Description

-- --

pImmutableSamplers affects initialization of samplers. If -- descriptorType specifies a -- VK_DESCRIPTOR_TYPE_SAMPLER or -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER type descriptor, -- then pImmutableSamplers can be used to initialize a -- set of /immutable samplers/. Immutable samplers are permanently bound -- into the set layout; later binding a sampler into an immutable sampler -- slot in a descriptor set is not allowed. If -- pImmutableSamplers is not NULL, then it is -- considered to be a pointer to an array of sampler handles that will be -- consumed by the set layout and used for the corresponding binding. If -- pImmutableSamplers is NULL, then the sampler slots -- are dynamic and sampler handles must be bound into descriptor -- sets using this layout. If descriptorType is not one of these -- descriptor types, then pImmutableSamplers is ignored.

-- -- The above layout definition allows the descriptor bindings to be -- specified sparsely such that not all binding numbers between 0 and the -- maximum binding number need to be specified in the pBindings -- array. Bindings that are not specified have a descriptorCount -- and stageFlags of zero, and the descriptorType is -- treated as undefined. However, all binding numbers between 0 and the -- maximum binding number in the -- VkDescriptorSetLayoutCreateInfo::pBindings array -- may consume memory in the descriptor set layout even if not all -- descriptor bindings are used, though it should not consume -- additional memory from the descriptor pool. -- -- Note -- -- The maximum binding number specified should be as compact as -- possible to avoid wasted memory. -- --

Valid Usage

-- --

If descriptorType is VK_DESCRIPTOR_TYPE_SAMPLER -- or VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and -- descriptorCount is not 0 and -- pImmutableSamplers is not NULL, -- pImmutableSamplers must be a valid pointer to an array -- of descriptorCount valid VkSampler handles

-- --

If descriptorCount is not 0, stageFlags -- must be a valid combination of VkShaderStageFlagBits -- values
If descriptorType is -- VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT and -- descriptorCount is not 0, then stageFlags -- must be 0 or -- VK_SHADER_STAGE_FRAGMENT_BIT

-- --

Valid Usage (Implicit)

-- --

descriptorType must be a valid -- VkDescriptorType value

-- --

Description

-- --

Valid Usage

-- --

The VkDescriptorSetLayoutBinding::binding members -- of the elements of the pBindings array must each have -- different values.

-- --

If flags contains -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then -- all elements of pBindings must not have a -- descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
If flags contains -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then -- the total number of elements of all bindings must be less than -- or equal to -- VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors
If any binding has the -- VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT bit set, -- flags must include -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT
If any binding has the -- VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT bit set, then -- all bindings must not have descriptorType of -- VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or -- VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkDescriptorSetLayoutBindingFlagsCreateInfoEXT
flags must be a valid combination of -- VkDescriptorSetLayoutCreateFlagBits values
If bindingCount is not 0, pBindings -- must be a valid pointer to an array of bindingCount -- valid VkDescriptorSetLayoutBinding structures

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkDescriptorSetVariableDescriptorCountAllocateInfoEXT
descriptorPool must be a valid -- VkDescriptorPool handle
pSetLayouts must be a valid pointer to an array of -- descriptorSetCount valid VkDescriptorSetLayout -- handles
descriptorSetCount must be greater than -- 0
Both of descriptorPool, and the elements of -- pSetLayouts must have been created, allocated, or -- retrieved from the same VkDevice

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO_EXT

-- --

If bindingCount is not 0, pBindingFlags -- must be a valid pointer to an array of bindingCount -- valid combinations of VkDescriptorBindingFlagBitsEXT -- values
Each element of pBindingFlags must not be -- 0

-- --

Description

-- -- If descriptorSetCount is zero or this structure is not -- included in the pNext chain, then the variable lengths are -- considered to be zero. Otherwise, pDescriptorCounts[i] is the -- number of descriptors in the variable count descriptor binding in the -- corresponding descriptor set layout. If -- VkDescriptorSetAllocateInfo::pSetLayouts[i] does not -- include a variable count descriptor binding, then -- pDescriptorCounts[i] is ignored. -- --

Valid Usage

-- --

If descriptorSetCount is not zero, -- descriptorSetCount must equal -- VkDescriptorSetAllocateInfo::descriptorSetCount

-- --

If VkDescriptorSetAllocateInfo::pSetLayouts[i] has -- a variable descriptor count binding, then -- pDescriptorCounts[i] must be less than or equal to the -- descriptor count specified for that binding when the descriptor set -- layout was created.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_ALLOCATE_INFO_EXT

-- --

If descriptorSetCount is not 0, -- pDescriptorCounts must be a valid pointer to an array -- of descriptorSetCount uint32_t values

-- --

Description

-- -- If the create info includes a variable-sized descriptor, then -- supported is determined assuming the requested size of the -- variable-sized descriptor, and maxVariableDescriptorCount is -- set to the maximum size of that descriptor that can be -- successfully created (which is greater than or equal to the requested -- size passed in). If the create info does not include a variable-sized -- descriptor or if the -- VkPhysicalDeviceDescriptorIndexingFeaturesEXT::descriptorBindingVariableDescriptorCount -- feature is not enabled, then maxVariableDescriptorCount is -- set to zero. For the purposes of this command, a variable-sized -- descriptor binding with a descriptorCount of zero is treated -- as if the descriptorCount is one, and thus the binding is not -- ignored and the maximum descriptor count will be returned. If the -- layout is not supported, then the value written to -- maxVariableDescriptorCount is undefined. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_LAYOUT_SUPPORT_EXT

-- --

Parameters

-- --

device is the logical device that would create the -- descriptor set layout.

-- --

pCreateInfo is a pointer to an instance of the -- VkDescriptorSetLayoutCreateInfo structure specifying the state -- of the descriptor set layout object.
pSupport points to a VkDescriptorSetLayoutSupport -- structure in which information about support for the descriptor set -- layout object is returned.

-- --

Description

-- -- Some implementations have limitations on what fits in a descriptor set -- which are not easily expressible in terms of existing limits like -- maxDescriptorSet*, for example if all descriptor types share -- a limited space in memory but each descriptor is a different size or -- alignment. This command returns information about whether a descriptor -- set satisfies this limit. If the descriptor set layout satisfies the -- VkPhysicalDeviceMaintenance3Properties::maxPerSetDescriptors -- limit, this command is guaranteed to return VK_TRUE in -- VkDescriptorSetLayoutSupport::supported. If the -- descriptor set layout exceeds the -- VkPhysicalDeviceMaintenance3Properties::maxPerSetDescriptors -- limit, whether the descriptor set layout is supported is -- implementation-dependent and may depend on whether the -- descriptor sizes and alignments cause the layout to exceed an internal -- limit. -- -- This command does not consider other limits such as -- maxPerStageDescriptor*, and so a descriptor set layout that -- is supported according to this command must still satisfy the -- pipeline layout limits such as maxPerStageDescriptor* in -- order to be used in a pipeline layout. -- -- Note -- -- This is a VkDevice query rather than -- VkPhysicalDevice because the answer may depend on -- enabled features. -- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkDescriptorSetLayoutCreateInfo structure
pSupport must be a valid pointer to a -- VkDescriptorSetLayoutSupport structure

-- --

Members

-- -- The members of the VkPhysicalDeviceMaintenance3Properties -- structure describe the following implementation-dependent limits: -- --

Description

-- --

maxPerSetDescriptors is a maximum number of descriptors -- (summed over all descriptor types) in a single descriptor set that is -- guaranteed to satisfy any implementation-dependent constraints on the -- size of a descriptor set itself. Applications can query whether -- a descriptor set that goes beyond this limit is supported using -- vkGetDescriptorSetLayoutSupport.

-- --

maxMemoryAllocationSize is the maximum size of a memory -- allocation that can be created, even if there is more space -- available in the heap.

-- -- If the VkPhysicalDeviceMaintenance3Properties structure is -- included in the pNext chain of -- VkPhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_3_PROPERTIES

-- --

Description

-- -- supported is set to VK_TRUE if the descriptor set -- can be created, or else is set to VK_FALSE. -- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_SUPPORT

-- --

pNext must be NULL or a pointer to a -- valid instance of -- VkDescriptorSetVariableDescriptorCountLayoutSupportEXT

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that has been used to create -- the descriptor update template

-- --

descriptorUpdateTemplate is the descriptor update -- template to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

If VkAllocationCallbacks were provided when -- descriptorSetLayout was created, a compatible set of -- callbacks must be provided here

-- --

If no VkAllocationCallbacks were provided when -- descriptorSetLayout was created, pAllocator -- must be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

If descriptorUpdateTemplate is not VK_NULL_HANDLE, -- descriptorUpdateTemplate must be a valid -- VkDescriptorUpdateTemplate handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
If descriptorUpdateTemplate is a valid handle, it -- must have been created, allocated, or retrieved from -- device

-- --

Host Synchronization

-- --

Host access to descriptorUpdateTemplate must be -- externally synchronized

-- --

Parameters

-- --

device is the logical device that updates the descriptor -- sets.

-- --

descriptorSet is the descriptor set to update
descriptorUpdateTemplate is the -- VkDescriptorUpdateTemplate which specifies the update mapping -- between pData and the descriptor set to update.
pData is a pointer to memory which contains one or more -- structures of VkDescriptorImageInfo, -- VkDescriptorBufferInfo, or VkBufferView used to write -- the descriptors.

-- --

Description

-- --

Valid Usage

-- --

pData must be a valid pointer to a memory that -- contains one or more valid instances of VkDescriptorImageInfo, -- VkDescriptorBufferInfo, or VkBufferView in a layout -- defined by descriptorUpdateTemplate when it was created with -- vkCreateDescriptorUpdateTemplate

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

descriptorSet must be a valid -- VkDescriptorSet handle
descriptorUpdateTemplate must be a valid -- VkDescriptorUpdateTemplate handle
descriptorUpdateTemplate must have been created, -- allocated, or retrieved from device

-- --

Host Synchronization

-- --

Host access to descriptorSet must be externally -- synchronized

-- -- API example. -- --

--   struct AppBufferView {
--       VkBufferView bufferView;
--       uint32_t     applicationRelatedInformation;
--   };
--   
--   struct AppDataStructure
--   {
--       VkDescriptorImageInfo  imageInfo;          // a single image info
--       VkDescriptorBufferInfo bufferInfoArray[3]; // 3 buffer infos in an array
--       AppBufferView          bufferView[2];      // An application defined structure containing a bufferView
--       // ... some more application related data
--   };
--   
--   const VkDescriptorUpdateTemplateEntry descriptorUpdateTemplateEntries[] =
--   {
--       // binding to a single image descriptor
--       {
--           0,                                           // binding
--           0,                                           // dstArrayElement
--           1,                                           // descriptorCount
--           VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,   // descriptorType
--           offsetof(AppDataStructure, imageInfo),       // offset
--           0                                            // stride is not required if descriptorCount is 1.
--       },
--   
--       // binding to an array of buffer descriptors
--       {
--           0,                                           // binding
--           0,                                           // dstArrayElement
--           3,                                           // descriptorCount
--           VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER,           // descriptorType
--           offsetof(AppDataStructure, bufferInfoArray), // offset
--           sizeof(VkDescriptorBufferInfo)               // stride, descriptor buffer infos are compact
--       },
--   
--       // binding to an array of buffer views
--       {
--           0,                                           // binding
--           3,                                           // dstArrayElement
--           1,                                           // descriptorCount
--           VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER,     // descriptorType
--           offsetof(AppDataStructure, bufferView),      // offset
--           sizeof(AppBufferView)                        // stride, bufferViews do not have to be compact
--       },
--   };
--   
--   // create an descriptor update template for descriptor set updates
--   const VkDescriptorUpdateTemplateCreateInfo createInfo =
--   {
--       VK_STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO,  // sType
--       NULL,                                                          // pNext
--       0,                                                             // flags
--       3,                                                             // descriptorUpdateEntryCount
--       descriptorUpdateTemplateEntries,                               // pDescriptorUpdateEntries
--       VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET,         // templateType
--       myLayout,                                                      // descriptorSetLayout
--       0,                                                             // pipelineBindPoint, ignored by given templateType
--       0,                                                             // pipelineLayout, ignored by given templateType
--       0,                                                             // set, ignored by given templateType
--   };
--   
--   VkDescriptorUpdateTemplate myDescriptorUpdateTemplate;
--   myResult = vkCreateDescriptorUpdateTemplate(
--       myDevice,
--       &createInfo,
--       NULL,
--       &myDescriptorUpdateTemplate);
--   }
--   
--   
--   AppDataStructure appData;
--   
--   // fill appData here or cache it in your engine
--   vkUpdateDescriptorSetWithTemplate(myDevice, myDescriptorSet, myDescriptorUpdateTemplate, &appData);
--

-- --

Members

-- --

dstBinding is the descriptor binding to update when using -- this descriptor update template.

-- --

dstArrayElement is the starting element in the array -- belonging to dstBinding.
descriptorCount is the number of descriptors to update. -- If descriptorCount is greater than the number of remaining -- array elements in the destination binding, those affect consecutive -- bindings in a manner similar to VkWriteDescriptorSet -- above.
descriptorType is a VkDescriptorType specifying -- the type of the descriptor.
offset is the offset in bytes of the first binding in the -- raw data structure.
stride is the stride in bytes between two consecutive -- array elements of the descriptor update informations in the raw data -- structure. The actual pointer ptr for each array element j of update -- entry i is computed using the following formula:
```
 const char *ptr
--   = (const char *)pData + pDescriptorUpdateEntries[i].offset + j *
--   pDescriptorUpdateEntries[i].stride
```
The stride is useful in case -- the bindings are stored in structs along with other data.

-- --

Description

-- --

Valid Usage

-- --

dstBinding must be a valid binding in the -- descriptor set layout implicitly specified when using a descriptor -- update template to update descriptors.

-- --

dstArrayElement and descriptorCount must -- be less than or equal to the number of array elements in the -- descriptor set binding implicitly specified when using a descriptor -- update template to update descriptors, and all applicable consecutive -- bindings, as described by -- {html_spec_relative}#descriptorsets-updates-consecutive

-- --

Valid Usage (Implicit)

-- --

descriptorType must be a valid -- VkDescriptorType value

-- --

Description

-- --

Valid Usage

-- --

If templateType is -- VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET, -- descriptorSetLayout must be a valid -- VkDescriptorSetLayout handle

-- --

If templateType is -- VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR, -- pipelineBindPoint must be a valid -- VkPipelineBindPoint value
If templateType is -- VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR, -- pipelineLayout must be a valid -- VkPipelineLayout handle
If templateType is -- VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR, -- set must be the unique set number in the pipeline -- layout that uses a descriptor set layout that was created with -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO

-- --

pNext must be NULL
flags must be 0
pDescriptorUpdateEntries must be a valid pointer -- to an array of descriptorUpdateEntryCount valid -- VkDescriptorUpdateTemplateEntry structures
templateType must be a valid -- VkDescriptorUpdateTemplateType value
If descriptorSetLayout is not VK_NULL_HANDLE, -- descriptorSetLayout must be a valid -- VkDescriptorSetLayout handle
descriptorUpdateEntryCount must be greater than -- 0
Both of descriptorSetLayout, and pipelineLayout -- that are valid handles must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Parameters

-- --

commandBuffer is the command buffer that the descriptors -- will be recorded in.

-- --

pipelineBindPoint is a VkPipelineBindPoint -- indicating whether the descriptors will be used by graphics pipelines -- or compute pipelines. There is a separate set of push descriptor -- bindings for each of graphics and compute, so binding one does not -- disturb the other.
layout is a VkPipelineLayout object used to -- program the bindings.
set is the set number of the descriptor set in the -- pipeline layout that will be updated.
descriptorWriteCount is the number of elements in the -- pDescriptorWrites array.
pDescriptorWrites is a pointer to an array of -- VkWriteDescriptorSet structures describing the descriptors to -- be updated.

-- --

Description

-- -- Push descriptors are a small bank of descriptors whose storage -- is internally managed by the command buffer rather than being written -- into a descriptor set and later bound to a command buffer. Push -- descriptors allow for incremental updates of descriptors without -- managing the lifetime of descriptor sets. -- -- When a command buffer begins recording, all push descriptors have -- undefined contents. Push descriptors can be updated -- incrementally and cause shaders to use the updated descriptors for -- subsequent rendering commands (either compute or graphics, according -- to the pipelineBindPoint) until the descriptor is -- overwritten, or else until the set is disturbed as described in -- Pipeline Layout Compatibility. When the set is disturbed or -- push descriptors with a different descriptor set layout are set, all -- push descriptors become invalid. -- -- Valid descriptors must be pushed for all bindings that any -- shaders in a pipeline access, at the time that a draw or dispatch -- command is recorded to execute using that pipeline. This includes -- immutable sampler descriptors, which must be pushed before they -- are accessed by a pipeline. However, if none of the shaders in a -- pipeline statically use certain bindings in the push descriptor set, -- then those descriptors need not be valid. -- -- Push descriptors do not use dynamic offsets. Instead, the -- corresponding non-dynamic descriptor types can be used and the -- offset member of VkDescriptorBufferInfo can be -- changed each time the descriptor is written. -- -- Each element of pDescriptorWrites is interpreted as in -- VkWriteDescriptorSet, except the dstSet member is -- ignored. -- -- To push an immutable sampler, use a VkWriteDescriptorSet with -- dstBinding and dstArrayElement selecting the -- immutable sampler’s binding. If the descriptor type is -- VK_DESCRIPTOR_TYPE_SAMPLER, the pImageInfo parameter -- is ignored and the immutable sampler is taken from the push descriptor -- set layout in the pipeline layout. If the descriptor type is -- VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the -- sampler member of the pImageInfo parameter is -- ignored and the immutable sampler is taken from the push descriptor -- set layout in the pipeline layout. -- --

Valid Usage

-- --

pipelineBindPoint must be supported by the -- commandBuffer’s parent VkCommandPool’s queue -- family

-- --

set must be less than -- VkPipelineLayoutCreateInfo::setLayoutCount provided -- when layout was created
set must be the unique set number in the pipeline -- layout that uses a descriptor set layout that was created with -- VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pipelineBindPoint must be a valid -- VkPipelineBindPoint value
layout must be a valid VkPipelineLayout -- handle
pDescriptorWrites must be a valid pointer to an -- array of descriptorWriteCount valid -- VkWriteDescriptorSet structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
descriptorWriteCount must be greater than -- 0
Both of commandBuffer, and layout must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer that the descriptors -- will be recorded in.

-- --

descriptorUpdateTemplate A descriptor update template -- which defines how to interpret the descriptor information in -- pData.
layout is a VkPipelineLayout object used to -- program the bindings. It must be compatible with the layout -- used to create the descriptorUpdateTemplate handle.
set is the set number of the descriptor set in the -- pipeline layout that will be updated. This must be the same -- number used to create the descriptorUpdateTemplate -- handle.
pData Points to memory which contains the descriptors for -- the templated update.

-- --

Description

-- --

Valid Usage

-- --

The pipelineBindPoint specified during the creation of the -- descriptor update template must be supported by the -- commandBuffer’s parent VkCommandPool’s queue -- family

-- --

pData must be a valid pointer to a memory that -- contains one or more valid instances of VkDescriptorImageInfo, -- VkDescriptorBufferInfo, or VkBufferView in a layout -- defined by descriptorUpdateTemplate when it was created with -- vkCreateDescriptorUpdateTemplateKHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

descriptorUpdateTemplate must be a valid -- VkDescriptorUpdateTemplate handle
layout must be a valid VkPipelineLayout -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
Each of commandBuffer, descriptorUpdateTemplate, -- and layout must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- -- API example. -- --

--   struct AppBufferView {
--       VkBufferView bufferView;
--       uint32_t     applicationRelatedInformation;
--   };
--   
--   struct AppDataStructure
--   {
--       VkDescriptorImageInfo  imageInfo;          // a single image info
--       // ... some more application related data
--   };
--   
--   const VkDescriptorUpdateTemplateEntry descriptorUpdateTemplateEntries[] =
--   {
--       // binding to a single image descriptor
--       {
--           0,                                           // binding
--           0,                                           // dstArrayElement
--           1,                                           // descriptorCount
--           VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,   // descriptorType
--           offsetof(AppDataStructure, imageInfo),       // offset
--           0                                            // stride is not required if descriptorCount is 1.
--       }
--   
--   };
--   
--   // create an descriptor update template for descriptor set updates
--   const VkDescriptorUpdateTemplateCreateInfo createInfo =
--   {
--       VK_STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO,  // sType
--       NULL,                                                          // pNext
--       0,                                                             // flags
--       1,                                                             // descriptorUpdateEntryCount
--       descriptorUpdateTemplateEntries,                               // pDescriptorUpdateEntries
--       VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR,       // templateType
--       0,                                                             // descriptorSetLayout, ignored by given templateType
--       VK_PIPELINE_BIND_POINT_GRAPHICS,                               // pipelineBindPoint
--       myPipelineLayout,                                              // pipelineLayout
--       0,                                                             // set
--   };
--   
--   VkDescriptorUpdateTemplate myDescriptorUpdateTemplate;
--   myResult = vkCreateDescriptorUpdateTemplate(
--       myDevice,
--       &createInfo,
--       NULL,
--       &myDescriptorUpdateTemplate);
--   }
--   
--   AppDataStructure appData;
--   // fill appData here or cache it in your engine
--   vkCmdPushDescriptorSetWithTemplateKHR(myCmdBuffer, myDescriptorUpdateTemplate, myPipelineLayout, 0,&appData);
--

-- --

commandBuffer is the command buffer that the pipeline -- will be bound to.

-- --

pipelineBindPoint is a VkPipelineBindPoint value -- specifying whether to bind to the compute or graphics bind point. -- Binding one does not disturb the other.
pipeline is the pipeline to be bound.

-- --

Description

-- -- Once bound, a pipeline binding affects subsequent graphics or compute -- commands in the command buffer until a different pipeline is bound to -- the bind point. The pipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE controls the behavior of -- vkCmdDispatch and vkCmdDispatchIndirect. The pipeline -- bound to VK_PIPELINE_BIND_POINT_GRAPHICS controls the -- behavior of all drawing commands. No other commands are -- affected by the pipeline state. -- --

Valid Usage

-- --

If pipelineBindPoint is -- VK_PIPELINE_BIND_POINT_COMPUTE, the VkCommandPool -- that commandBuffer was allocated from must support -- compute operations

-- --

If pipelineBindPoint is -- VK_PIPELINE_BIND_POINT_GRAPHICS, the VkCommandPool -- that commandBuffer was allocated from must support -- graphics operations
If pipelineBindPoint is -- VK_PIPELINE_BIND_POINT_COMPUTE, pipeline must -- be a compute pipeline
If pipelineBindPoint is -- VK_PIPELINE_BIND_POINT_GRAPHICS, pipeline -- must be a graphics pipeline
If the variable multisample rate feature is not supported, -- pipeline is a graphics pipeline, the current subpass has no -- attachments, and this is not the first call to this function with a -- graphics pipeline after transitioning to the current subpass, then the -- sample count specified by this pipeline must match that set in -- the previous pipeline
If -- VkPhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations -- is VK_FALSE, and pipeline is a graphics pipeline -- created with a VkPipelineSampleLocationsStateCreateInfoEXT -- structure having its sampleLocationsEnable member set to -- VK_TRUE but without -- VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT enabled then the -- current render pass instance must have been begun by specifying -- a VkRenderPassSampleLocationsBeginInfoEXT structure whose -- pPostSubpassSampleLocations member contains an element with a -- subpassIndex matching the current subpass index and the -- sampleLocationsInfo member of that element must match -- the sampleLocationsInfo specified in -- VkPipelineSampleLocationsStateCreateInfoEXT when the pipeline -- was created

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pipelineBindPoint must be a valid -- VkPipelineBindPoint value
pipeline must be a valid VkPipeline -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
Both of commandBuffer, and pipeline must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

firstViewport is the index of the first viewport whose -- parameters are updated by the command.
viewportCount is the number of viewports whose parameters -- are updated by the command.
pViewports is a pointer to an array of VkViewport -- structures specifying viewport parameters.

-- --

Description

-- -- The viewport parameters taken from element i of pViewports -- replace the current state for the viewport index -- firstViewport + i, for i in [0, viewportCount). -- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_VIEWPORT dynamic state enabled

-- --

firstViewport must be less than -- VkPhysicalDeviceLimits::maxViewports
The sum of firstViewport and viewportCount -- must be between 1 and -- VkPhysicalDeviceLimits::maxViewports, inclusive
If the multiple viewports feature is not enabled, -- firstViewport must be 0
If the multiple viewports feature is not enabled, -- viewportCount must be 1

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pViewports must be a valid pointer to an array of -- viewportCount VkViewport structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
viewportCount must be greater than 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

firstScissor is the index of the first scissor whose -- state is updated by the command.
scissorCount is the number of scissors whose rectangles -- are updated by the command.
pScissors is a pointer to an array of VkRect2D -- structures defining scissor rectangles.

-- --

Description

-- -- The scissor rectangles taken from element i of pScissors -- replace the current state for the scissor index firstScissor -- + i, for i in [0, scissorCount). -- -- Each scissor rectangle is described by a VkRect2D structure, -- with the offset.x and offset.y values determining -- the upper left corner of the scissor rectangle, and the -- extent.width and extent.height values determining -- the size in pixels. -- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_SCISSOR dynamic state enabled

-- --

firstScissor must be less than -- VkPhysicalDeviceLimits::maxViewports
The sum of firstScissor and scissorCount -- must be between 1 and -- VkPhysicalDeviceLimits::maxViewports, inclusive
If the multiple viewports feature is not enabled, -- firstScissor must be 0
If the multiple viewports feature is not enabled, -- scissorCount must be 1
The x and y members of offset -- must be greater than or equal to 0
Evaluation of (offset.x + extent.width) -- must not cause a signed integer addition overflow
Evaluation of (offset.y + extent.height) -- must not cause a signed integer addition overflow

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pScissors must be a valid pointer to an array of -- scissorCount VkRect2D structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
scissorCount must be greater than 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

lineWidth is the width of rasterized line segments.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_LINE_WIDTH dynamic state enabled

-- --

If the wide lines feature is not enabled, -- lineWidth must be 1.0

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

depthBiasConstantFactor is a scalar factor controlling -- the constant depth value added to each fragment.
depthBiasClamp is the maximum (or minimum) depth bias of -- a fragment.
depthBiasSlopeFactor is a scalar factor applied to a -- fragment’s slope in depth bias calculations.

-- --

Description

-- -- If depthBiasEnable is VK_FALSE, no depth bias is -- applied and the fragment’s depth values are unchanged. -- -- depthBiasSlopeFactor scales the maximum depth slope of the -- polygon, and depthBiasConstantFactor scales an -- implementation-dependent constant that relates to the usable -- resolution of the depth buffer. The resulting values are summed to -- produce the depth bias value which is then clamped to a minimum or -- maximum value specified by depthBiasClamp. -- depthBiasSlopeFactor, depthBiasConstantFactor, and -- depthBiasClamp can each be positive, negative, or -- zero. -- -- The maximum depth slope m of a triangle is -- -- \[m = \sqrt{ \left({{\partial z_f} \over {\partial x_f}}\right)^2 + -- \left({{\partial z_f} \over {\partial y_f}}\right)^2}\] -- -- where (xf, yf, zf) is a point on the triangle. m may be -- approximated as -- -- \[m = \max\left( \left| { {\partial z_f} \over {\partial x_f} } -- \right|, \left| { {\partial z_f} \over {\partial y_f} } \right| -- \right).\] -- -- The minimum resolvable difference r is an implementation-dependent -- parameter that depends on the depth buffer representation. It is the -- smallest difference in framebuffer coordinate z values that is -- guaranteed to remain distinct throughout polygon rasterization and in -- the depth buffer. All pairs of fragments generated by the -- rasterization of two polygons with otherwise identical vertices, but -- zf values that differ by $r$, will have distinct depth -- values. -- -- For fixed-point depth buffer representations, r is constant throughout -- the range of the entire depth buffer. For floating-point depth -- buffers, there is no single minimum resolvable difference. In this -- case, the minimum resolvable difference for a given polygon is -- dependent on the maximum exponent, e, in the range of z values spanned -- by the primitive. If n is the number of bits in the floating-point -- mantissa, the minimum resolvable difference, r, for the given -- primitive is defined as -- --

r = 2e-n

-- -- If a triangle is rasterized using the -- VK_POLYGON_MODE_FILL_RECTANGLE_NV polygon mode, then this -- minimum resolvable difference may not be resolvable for samples -- outside of the triangle, where the depth is extrapolated. -- -- If no depth buffer is present, r is undefined. -- -- The bias value o for a polygon is -- -- \[o = \begin{cases} m \times depthBiasSlopeFactor + r \times -- depthBiasConstantFactor & depthBiasClamp = 0\ or\ NaN \\ \min(m -- \times depthBiasSlopeFactor + r \times depthBiasConstantFactor, -- depthBiasClamp) & depthBiasClamp > 0 \\ \max(m \times -- depthBiasSlopeFactor + r \times depthBiasConstantFactor, -- depthBiasClamp) & depthBiasClamp < 0 \\ \end{cases}\] -- -- m is computed as described above. If the depth buffer uses a -- fixed-point representation, m is a function of depth values in the -- range [0,1], and o is applied to depth values in the same range. -- -- For fixed-point depth buffers, fragment depth values are always -- limited to the range [0,1] by clamping after depth bias addition is -- performed. Unless the -- {html_spec_relative}#VK_EXT_depth_range_unrestricted -- extension is enabled, fragment depth values are clamped even when the -- depth buffer uses a floating-point representation. -- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_DEPTH_BIAS dynamic state enabled

-- --

If the depth bias clamping feature is not enabled, -- depthBiasClamp must be 0.0

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

blendConstants is an array of four values specifying the -- R, G, B, and A components of the blend constant color used in -- blending, depending on the blend factor.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_BLEND_CONSTANTS dynamic state enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

minDepthBounds is the lower bound of the range of depth -- values used in the depth bounds test.
maxDepthBounds is the upper bound of the range.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_DEPTH_BOUNDS dynamic state enabled

-- --

Unless the -- {html_spec_relative}#VK_EXT_depth_range_unrestricted -- extension is enabled minDepthBounds must be between -- 0.0 and 1.0, inclusive
Unless the -- {html_spec_relative}#VK_EXT_depth_range_unrestricted -- extension is enabled maxDepthBounds must be between -- 0.0 and 1.0, inclusive

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

faceMask is a bitmask of VkStencilFaceFlagBits -- specifying the set of stencil state for which to update the compare -- mask.
compareMask is the new value to use as the stencil -- compare mask.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK dynamic state -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

faceMask must be a valid combination of -- VkStencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

faceMask is a bitmask of VkStencilFaceFlagBits -- specifying the set of stencil state for which to update the write -- mask, as described above for vkCmdSetStencilCompareMask.
writeMask is the new value to use as the stencil write -- mask.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_STENCIL_WRITE_MASK dynamic state -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

faceMask must be a valid combination of -- VkStencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

faceMask is a bitmask of VkStencilFaceFlagBits -- specifying the set of stencil state for which to update the reference -- value, as described above for vkCmdSetStencilCompareMask.
reference is the new value to use as the stencil -- reference value.

-- --

Description

-- --

Valid Usage

-- --

The bound graphics pipeline must have been created with the -- VK_DYNAMIC_STATE_STENCIL_REFERENCE dynamic state enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

faceMask must be a valid combination of -- VkStencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer that the descriptor -- sets will be bound to.

-- --

pipelineBindPoint is a VkPipelineBindPoint -- indicating whether the descriptors will be used by graphics pipelines -- or compute pipelines. There is a separate set of bind points for each -- of graphics and compute, so binding one does not disturb the -- other.
layout is a VkPipelineLayout object used to -- program the bindings.
firstSet is the set number of the first descriptor set to -- be bound.
descriptorSetCount is the number of elements in the -- pDescriptorSets array.
pDescriptorSets is an array of handles to -- VkDescriptorSet objects describing the descriptor sets to -- write to.
dynamicOffsetCount is the number of dynamic offsets in -- the pDynamicOffsets array.
pDynamicOffsets is a pointer to an array of -- uint32_t values specifying dynamic offsets.

-- --

Description

-- -- vkCmdBindDescriptorSets causes the sets numbered -- [firstSet.. firstSet+descriptorSetCount-1] -- to use the bindings stored in -- pDescriptorSets[0..descriptorSetCount-1] for -- subsequent rendering commands (either compute or graphics, according -- to the pipelineBindPoint). Any bindings that were previously -- applied via these sets are no longer valid. -- -- Once bound, a descriptor set affects rendering of subsequent graphics -- or compute commands in the command buffer until a different set is -- bound to the same set number, or else until the set is disturbed as -- described in Pipeline Layout Compatibility. -- -- A compatible descriptor set must be bound for all set numbers -- that any shaders in a pipeline access, at the time that a draw or -- dispatch command is recorded to execute using that pipeline. However, -- if none of the shaders in a pipeline statically use any bindings with -- a particular set number, then no descriptor set need be bound for that -- set number, even if the pipeline layout includes a non-trivial -- descriptor set layout for that set number. -- -- If any of the sets being bound include dynamic uniform or storage -- buffers, then pDynamicOffsets includes one element for each -- array element in each dynamic descriptor type binding in each set. -- Values are taken from pDynamicOffsets in an order such that -- all entries for set N come before set N+1; within a set, entries are -- ordered by the binding numbers in the descriptor set layouts; and -- within a binding array, elements are in order. -- dynamicOffsetCount must equal the total number of -- dynamic descriptors in the sets being bound. -- -- The effective offset used for dynamic uniform and storage buffer -- bindings is the sum of the relative offset taken from -- pDynamicOffsets, and the base address of the buffer plus base -- offset in the descriptor set. The length of the dynamic uniform and -- storage buffer bindings is the buffer range as specified in the -- descriptor set. -- -- Each of the pDescriptorSets must be compatible with -- the pipeline layout specified by layout. The layout used to -- program the bindings must also be compatible with the pipeline -- used in subsequent graphics or compute commands, as defined in the -- Pipeline Layout Compatibility section. -- -- The descriptor set contents bound by a call to -- vkCmdBindDescriptorSets may be consumed at the -- following times: -- --

For descriptor bindings created with the -- VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT bit set, the -- contents may be consumed when the command buffer is submitted -- to a queue, or during shader execution of the resulting draws and -- dispatches, or any time in between. Otherwise,
during host execution of the command, or during shader execution -- of the resulting draws and dispatches, or any time in between.

-- -- Thus, the contents of a descriptor set binding must not be -- altered (overwritten by an update command, or freed) between the first -- point in time that it may be consumed, and and when the command -- completes executing on the queue. -- -- The contents of pDynamicOffsets are consumed immediately -- during execution of vkCmdBindDescriptorSets. Once all pending -- uses have completed, it is legal to update and reuse a descriptor set. -- --

Valid Usage

-- --

Each element of pDescriptorSets must have been -- allocated with a VkDescriptorSetLayout that matches (is the -- same as, or identically defined as) the VkDescriptorSetLayout -- at set n in layout, where n is the sum of -- firstSet and the index into pDescriptorSets

-- --

dynamicOffsetCount must be equal to the total -- number of dynamic descriptors in pDescriptorSets
The sum of firstSet and descriptorSetCount -- must be less than or equal to -- VkPipelineLayoutCreateInfo::setLayoutCount provided -- when layout was created
pipelineBindPoint must be supported by the -- commandBuffer’s parent VkCommandPool’s queue -- family
Each element of pDynamicOffsets must satisfy the -- required alignment for the corresponding descriptor binding’s -- descriptor type

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pipelineBindPoint must be a valid -- VkPipelineBindPoint value
layout must be a valid VkPipelineLayout -- handle
pDescriptorSets must be a valid pointer to an -- array of descriptorSetCount valid VkDescriptorSet -- handles
If dynamicOffsetCount is not 0, -- pDynamicOffsets must be a valid pointer to an array of -- dynamicOffsetCount uint32_t values
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
descriptorSetCount must be greater than -- 0
Each of commandBuffer, layout, and the elements -- of pDescriptorSets must have been created, allocated, -- or retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

buffer is the buffer being bound.
offset is the starting offset in bytes within -- buffer used in index buffer address calculations.
indexType is a VkIndexType value specifying -- whether indices are treated as 16 bits or 32 bits.

-- --

Description

-- --

Valid Usage

-- --

offset must be less than the size of -- buffer

-- --

The sum of offset and the address of the range of -- VkDeviceMemory object that is backing buffer, -- must be a multiple of the type indicated by -- indexType
buffer must have been created with the -- VK_BUFFER_USAGE_INDEX_BUFFER_BIT flag
If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
indexType must be a valid VkIndexType -- value
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
Both of buffer, and commandBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

firstBinding is the index of the first vertex input -- binding whose state is updated by the command.
bindingCount is the number of vertex input bindings whose -- state is updated by the command.
pBuffers is a pointer to an array of buffer handles.
pOffsets is a pointer to an array of buffer offsets.

-- --

Description

-- -- The values taken from elements i of pBuffers and -- pOffsets replace the current state for the vertex input -- binding firstBinding + i, for i in [0, -- bindingCount). The vertex input binding is updated to start -- at the offset indicated by pOffsets[i] from the start of the -- buffer pBuffers[i]. All vertex input attributes that use each -- of these bindings will use these updated addresses in their address -- calculations for subsequent draw commands. -- --

Valid Usage

-- --

firstBinding must be less than -- VkPhysicalDeviceLimits::maxVertexInputBindings

-- --

The sum of firstBinding and bindingCount -- must be less than or equal to -- VkPhysicalDeviceLimits::maxVertexInputBindings
All elements of pOffsets must be less than the -- size of the corresponding element in pBuffers
All elements of pBuffers must have been created -- with the VK_BUFFER_USAGE_VERTEX_BUFFER_BIT flag
Each element of pBuffers that is non-sparse must -- be bound completely and contiguously to a single -- VkDeviceMemory object

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pBuffers must be a valid pointer to an array of -- bindingCount valid VkBuffer handles
pOffsets must be a valid pointer to an array of -- bindingCount VkDeviceSize values
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
bindingCount must be greater than 0
Both of commandBuffer, and the elements of -- pBuffers must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

vertexCount is the number of vertices to draw.
instanceCount is the number of instances to draw.
firstVertex is the index of the first vertex to -- draw.
firstInstance is the instance ID of the first instance to -- draw.

-- --

Description

-- -- When the command is executed, primitives are assembled using the -- current primitive topology and vertexCount consecutive vertex -- indices with the first vertexIndex value equal to -- firstVertex. The primitives are drawn instanceCount -- times with instanceIndex starting with firstInstance -- and increasing sequentially for each instance. The assembled -- primitives execute the bound graphics pipeline. -- --

Valid Usage

-- --

The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.

-- --

The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in -- {html_spec_relative}#fxvertex-input
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

indexCount is the number of vertices to draw.
instanceCount is the number of instances to draw.
firstIndex is the base index within the index -- buffer.
vertexOffset is the value added to the vertex index -- before indexing into the vertex buffer.
firstInstance is the instance ID of the first instance to -- draw.

-- --

Description

-- -- When the command is executed, primitives are assembled using the -- current primitive topology and indexCount vertices whose -- indices are retrieved from the index buffer. The index buffer is -- treated as an array of tightly packed unsigned integers of size -- defined by the vkCmdBindIndexBuffer::indexType -- parameter with which the buffer was bound. -- -- The first vertex index is at an offset of firstIndex * -- indexSize + offset within the bound index buffer, -- where offset is the offset specified by -- vkCmdBindIndexBuffer and indexSize is the byte size -- of the type specified by indexType. Subsequent index values -- are retrieved from consecutive locations in the index buffer. Indices -- are first compared to the primitive restart value, then zero extended -- to 32 bits (if the indexType is -- VK_INDEX_TYPE_UINT16) and have vertexOffset added to -- them, before being supplied as the vertexIndex value. -- -- The primitives are drawn instanceCount times with -- instanceIndex starting with firstInstance and -- increasing sequentially for each instance. The assembled primitives -- execute the bound graphics pipeline. -- --

Valid Usage

-- --

The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.

-- --

The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in -- {html_spec_relative}#fxvertex-input
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
(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 -- vkCmdBindIndexBuffer
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

buffer is the buffer containing draw parameters.
offset is the byte offset into buffer where -- parameters begin.
drawCount is the number of draws to execute, and -- can be zero.
stride is the byte stride between successive sets of draw -- parameters.

-- --

Description

-- -- vkCmdDrawIndirect behaves similarly to vkCmdDraw -- except that the parameters are read by the device from a buffer during -- execution. drawCount draws are executed by the command, with -- parameters taken from buffer starting at offset and -- increasing by stride bytes for each successive draw. The -- parameters of each draw are encoded in an array of -- VkDrawIndirectCommand structures. If drawCount is less -- than or equal to one, stride is ignored. -- --

Valid Usage

-- --

If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

buffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
If drawCount is greater than 1, stride -- must be a multiple of 4 and must be greater -- than or equal to sizeof(VkDrawIndirectCommand)
If the multi-draw indirect feature is not enabled, -- drawCount must be 0 or 1
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- VkDrawIndirectCommand structures accessed by this command -- must be 0
The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
If drawCount is equal to 1, (offset + -- sizeof(VkDrawIndirectCommand)) must be less -- than or equal to the size of buffer
If drawCount is greater than 1, (stride -- × (drawCount - 1) + offset + -- sizeof(VkDrawIndirectCommand)) must be less -- than or equal to the size of buffer
drawCount must be less than or equal to -- VkPhysicalDeviceLimits::maxDrawIndirectCount
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
Both of buffer, and commandBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

buffer is the buffer containing draw parameters.
offset is the byte offset into buffer where -- parameters begin.
drawCount is the number of draws to execute, and -- can be zero.
stride is the byte stride between successive sets of draw -- parameters.

-- --

Description

-- -- vkCmdDrawIndexedIndirect behaves similarly to -- vkCmdDrawIndexed except that the parameters are read by the -- device from a buffer during execution. drawCount draws are -- executed by the command, with parameters taken from buffer -- starting at offset and increasing by stride bytes -- for each successive draw. The parameters of each draw are encoded in -- an array of VkDrawIndexedIndirectCommand structures. If -- drawCount is less than or equal to one, stride is -- ignored. -- --

Valid Usage

-- --

If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

buffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
If drawCount is greater than 1, stride -- must be a multiple of 4 and must be greater -- than or equal to -- sizeof(VkDrawIndexedIndirectCommand)
If the multi-draw indirect feature is not enabled, -- drawCount must be 0 or 1
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- VkDrawIndexedIndirectCommand structures accessed by this -- command must be 0
The current render pass must be compatible with the -- renderPass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
The subpass index of the current render pass must be equal -- to the subpass member of the -- VkGraphicsPipelineCreateInfo structure specified when -- creating the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS.
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_GRAPHICS, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_GRAPHICS, with a -- VkPipelineLayout that is compatible for push constants, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- valid buffers bound
A valid graphics pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_GRAPHICS
If the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, -- that state must have been set on the current command -- buffer
If drawCount is equal to 1, (offset + -- sizeof(VkDrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
If drawCount is greater than 1, (stride -- × (drawCount - 1) + offset + -- sizeof(VkDrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
drawCount must be less than or equal to -- VkPhysicalDeviceLimits::maxDrawIndirectCount
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used to sample from any -- VkImage with a VkImageView of the type -- VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS uses unnormalized -- coordinates, it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_GRAPHICS accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Image subresources used as attachments in the current render pass -- must not be accessed in any way other than as an attachment by -- this command.
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
If the draw is recorded in a render pass instance with multiview -- enabled, the maximum instance index must be less than or equal -- to -- VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex.
If the bound graphics pipeline was created with -- VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to VK_TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- bit set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
Both of buffer, and commandBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

groupCountX is the number of local workgroups to dispatch -- in the X dimension.
groupCountY is the number of local workgroups to dispatch -- in the Y dimension.
groupCountZ is the number of local workgroups to dispatch -- in the Z dimension.

-- --

Description

-- -- When the command is executed, a global workgroup consisting of -- groupCountX × groupCountY × groupCountZ local workgroups is assembled. -- --

Valid Usage

-- --

groupCountX must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[0]

-- --

groupCountY must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1]
groupCountZ must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]
For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_COMPUTE, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_COMPUTE, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
A valid compute pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_COMPUTE
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_COMPUTE, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_COMPUTE, with a -- VkPipelineLayout that is compatible for push constants with -- the one used to create the current VkPipeline, as described -- in {html_spec_relative}#descriptorsets-compatibility
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used to sample from any VkImage with a -- VkImageView of the type VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_COMPUTE accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_COMPUTE accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support compute operations
This command must only be called outside of a render pass -- instance

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Compute         | Compute         |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

buffer is the buffer containing dispatch parameters.
offset is the byte offset into buffer where -- parameters begin.

-- --

Description

-- -- vkCmdDispatchIndirect behaves similarly to -- vkCmdDispatch except that the parameters are read by the device -- from a buffer during execution. The parameters of the dispatch are -- encoded in a VkDispatchIndirectCommand structure taken from -- buffer starting at offset. -- --

Valid Usage

-- --

If buffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

For each set n that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_COMPUTE, -- a descriptor set must have been bound to n at -- VK_PIPELINE_BIND_POINT_COMPUTE, with a -- VkPipelineLayout that is compatible for set n, with -- the VkPipelineLayout used to create the current -- VkPipeline, as described in -- {html_spec_relative}#descriptorsets-compatibility
Descriptors in each bound descriptor set, specified via -- vkCmdBindDescriptorSets, must be valid if they are -- statically used by the bound VkPipeline object, specified via -- vkCmdBindPipeline
A valid compute pipeline must be bound to the current -- command buffer with VK_PIPELINE_BIND_POINT_COMPUTE
buffer must have been created with the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
The sum of offset and the size of -- VkDispatchIndirectCommand must be less than or equal -- to the size of buffer
For each push constant that is statically used by the -- VkPipeline bound to VK_PIPELINE_BIND_POINT_COMPUTE, -- a push constant value must have been set for -- VK_PIPELINE_BIND_POINT_COMPUTE, with a -- VkPipelineLayout that is compatible for push constants with -- the one used to create the current VkPipeline, as described -- in {html_spec_relative}#descriptorsets-compatibility
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used to sample from any VkImage with a -- VkImageView of the type VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, -- VK_IMAGE_VIEW_TYPE_1D_ARRAY, -- VK_IMAGE_VIEW_TYPE_2D_ARRAY or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- with ImplicitLod, Dref or Proj in their -- name, in any shader stage
If any VkSampler object that is accessed from a shader by -- the VkPipeline bound to -- VK_PIPELINE_BIND_POINT_COMPUTE uses unnormalized coordinates, -- it must not be used with any of the SPIR-V -- OpImageSample* or OpImageSparseSample* instructions -- that includes a LOD bias or any offset values, in any shader -- stage
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_COMPUTE accesses a uniform buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
If the robust buffer access feature is not enabled, and any -- shader stage in the VkPipeline object bound to -- VK_PIPELINE_BIND_POINT_COMPUTE accesses a storage buffer, it -- must not access values outside of the range of that buffer -- specified in the bound descriptor set
Any VkImageView being sampled with -- VK_FILTER_LINEAR as a result of this command must be -- of a format which supports linear filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- be of a format which supports cubic filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
Any VkImageView being sampled with -- VK_FILTER_CUBIC_IMG as a result of this command must -- not have a VkImageViewType of VK_IMAGE_VIEW_TYPE_3D, -- VK_IMAGE_VIEW_TYPE_CUBE, or -- VK_IMAGE_VIEW_TYPE_CUBE_ARRAY

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

buffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support compute operations
This command must only be called outside of a render pass -- instance
Both of buffer, and commandBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Compute         | Compute         |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcBuffer is the source buffer.
dstBuffer is the destination buffer.
regionCount is the number of regions to copy.
pRegions is a pointer to an array of VkBufferCopy -- structures specifying the regions to copy.

-- --

Description

-- -- Each region in pRegions is copied from the source buffer to -- the same region of the destination buffer. srcBuffer and -- dstBuffer can be the same buffer or alias the same -- memory, but the result is undefined if the copy regions overlap in -- memory. -- --

Valid Usage

-- --

The size member of each element of pRegions -- must be greater than 0

-- --

The srcOffset member of each element of pRegions -- must be less than the size of srcBuffer
The dstOffset member of each element of pRegions -- must be less than the size of dstBuffer
The size member of each element of pRegions -- must be less than or equal to the size of srcBuffer -- minus srcOffset
The size member of each element of pRegions -- must be less than or equal to the size of dstBuffer -- minus dstOffset
The union of the source regions, and the union of the destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
srcBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
If srcBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcBuffer must be a valid VkBuffer -- handle
dstBuffer must be a valid VkBuffer -- handle
pRegions must be a valid pointer to an array of -- regionCount VkBufferCopy structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstBuffer, and -- srcBuffer must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcImage is the source image.
srcImageLayout is the current layout of the source image -- subresource.
dstImage is the destination image.
dstImageLayout is the current layout of the destination -- image subresource.
regionCount is the number of regions to copy.
pRegions is a pointer to an array of VkImageCopy -- structures specifying the regions to copy.

-- --

Description

-- -- Each region in pRegions is copied from the source image to -- the same region of the destination image. srcImage and -- dstImage can be the same image or alias the same -- memory. -- -- The formats of srcImage and dstImage must be -- compatible. Formats are considered compatible if their element size is -- the same between both formats. For example, -- VK_FORMAT_R8G8B8A8_UNORM is compatible with -- VK_FORMAT_R32_UINT because both texels are 4 bytes in size. -- Depth/stencil formats must match exactly. -- -- If the format of srcImage or dstImage is a -- multi-planar image format, regions of each plane to be copied -- must be specified separately using the srcSubresource -- and dstSubresource members of the VkImageCopy -- structure. In this case, the aspectMask of the -- srcSubresource or dstSubresource that refers to the -- multi-planar image must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT. For the purposes of -- vkCmdCopyImage, each plane of a multi-planar image is treated -- as having the format listed in -- {html_spec_relative}#features-formats-compatible-planes for the -- plane identified by the aspectMask of the corresponding -- subresource. This applies both to VkFormat and to coordinates -- used in the copy, which correspond to texels in the plane -- rather than how these texels map to coordinates in the image as a -- whole. -- -- Note -- -- For example, the VK_IMAGE_ASPECT_PLANE_1_BIT plane of a -- VK_FORMAT_G8_B8R8_2PLANE_420_UNORM image is compatible with -- an image of format VK_FORMAT_R8G8_UNORM and (less usefully) -- with the VK_IMAGE_ASPECT_PLANE_0_BIT plane of an image of -- format VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16, -- as each texel is 2 bytes in size. -- -- vkCmdCopyImage allows copying between size-compatible -- compressed and uncompressed internal formats. Formats are -- size-compatible if the element size of the uncompressed format is -- equal to the element size (compressed texel block size) of the -- compressed format. Such a copy does not perform on-the-fly compression -- or decompression. When copying from an uncompressed format to a -- compressed format, each texel of uncompressed data of the source image -- is copied as a raw value to the corresponding compressed texel block -- of the destination image. When copying from a compressed format to an -- uncompressed format, each compressed texel block of the source image -- is copied as a raw value to the corresponding texel of uncompressed -- data in the destination image. Thus, for example, it is legal to copy -- between a 128-bit uncompressed format and a compressed format which -- has a 128-bit sized compressed texel block representing 4×4 texels -- (using 8 bits per texel), or between a 64-bit uncompressed format and -- a compressed format which has a 64-bit sized compressed texel block -- representing 4×4 texels (using 4 bits per texel). -- -- When copying between compressed and uncompressed formats the -- extent members represent the texel dimensions of the source -- image and not the destination. When copying from a compressed image to -- an uncompressed image the image texel dimensions written to the -- uncompressed image will be source extent divided by the compressed -- texel block dimensions. When copying from an uncompressed image to a -- compressed image the image texel dimensions written to the compressed -- image will be the source extent multiplied by the compressed texel -- block dimensions. In both cases the number of bytes read and the -- number of bytes written will be identical. -- -- Copying to or from block-compressed images is typically done in -- multiples of the compressed texel block size. For this reason the -- extent must be a multiple of the compressed texel -- block dimension. There is one exception to this rule which is -- required to handle compressed images created with dimensions -- that are not a multiple of the compressed texel block dimensions: if -- the srcImage is compressed, then: -- --

If extent.width is not a multiple of the compressed texel -- block width, then (extent.width + srcOffset.x) -- must equal the image subresource width.
If extent.height is not a multiple of the compressed -- texel block height, then (extent.height + -- srcOffset.y) must equal the image subresource -- height.
If extent.depth is not a multiple of the compressed texel -- block depth, then (extent.depth + srcOffset.z) -- must equal the image subresource depth.

-- -- Similarly, if the dstImage is compressed, then: -- --

If extent.width is not a multiple of the compressed texel -- block width, then (extent.width + dstOffset.x) -- must equal the image subresource width.
If extent.height is not a multiple of the compressed -- texel block height, then (extent.height + -- dstOffset.y) must equal the image subresource -- height.
If extent.depth is not a multiple of the compressed texel -- block depth, then (extent.depth + dstOffset.z) -- must equal the image subresource depth.

-- -- This allows the last compressed texel block of the image in each -- non-multiple dimension to be included as a source or destination of -- the copy. -- -- “_422” image formats that are not multi-planar are -- treated as having a 2×1 compressed texel block for the purposes of -- these rules. -- -- vkCmdCopyImage can be used to copy image data between -- multisample images, but both images must have the same number -- of samples. -- --

Valid Usage

-- --

The source region specified by each element of pRegions -- must be a region that is contained within srcImage if -- the srcImage’s VkFormat is not a multi-planar -- format, and must be a region that is contained within the -- plane being copied if the srcImage’s VkFormat is a -- multi-planar format

-- --

The destination region specified by each element of -- pRegions must be a region that is contained within -- dstImage if the dstImage’s VkFormat is not a -- multi-planar format, and must be a region that is -- contained within the plane being copied to if the dstImage’s -- VkFormat is a multi-planar format
The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
srcImage must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
srcImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
If srcImage is non-sparse then the image or -- disjoint plane to be copied must be bound completely and -- contiguously to a single VkDeviceMemory object
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a VkDevice
srcImageLayout must be -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, -- VK_IMAGE_LAYOUT_GENERAL, or -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
dstImage must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_DST_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
dstImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If dstImage is non-sparse then the image or -- disjoint plane that is the destination of the copy must -- be bound completely and contiguously to a single -- VkDeviceMemory object
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a VkDevice
dstImageLayout must be -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, -- VK_IMAGE_LAYOUT_GENERAL, or -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
If the VkFormat of each of srcImage and -- dstImage is not a multi-planar format, the -- VkFormat of each of srcImage and dstImage -- must be compatible, as defined below
In a copy to or from a plane of a multi-planar image, the -- VkFormat of the image and plane must be compatible -- according to the description of compatible planes for the plane -- being copied
When a copy is performed to or from an image with a -- multi-planar format, the aspectMask of the -- srcSubresource and/or dstSubresource that refers to -- the multi-planar image must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT (with -- VK_IMAGE_ASPECT_PLANE_2_BIT valid only for a VkFormat -- with three planes)
The sample count of srcImage and dstImage -- must match
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when dstImage was -- created
The srcSubresource.baseArrayLayer + -- srcSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- srcImage was created
The dstSubresource.baseArrayLayer + -- dstSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- dstImage was created
The srcOffset and and extent members of each -- element of pRegions must respect the image transfer -- granularity requirements of commandBuffer’s command pool’s -- queue family, as described in VkQueueFamilyProperties
The dstOffset and and extent members of each -- element of pRegions must respect the image transfer -- granularity requirements of commandBuffer’s command pool’s -- queue family, as described in VkQueueFamilyProperties

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcImage must be a valid VkImage -- handle
srcImageLayout must be a valid -- VkImageLayout value
dstImage must be a valid VkImage -- handle
dstImageLayout must be a valid -- VkImageLayout value
pRegions must be a valid pointer to an array of -- regionCount valid VkImageCopy structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstImage, and -- srcImage must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcImage is the source image.
srcImageLayout is the layout of the source image -- subresources for the blit.
dstImage is the destination image.
dstImageLayout is the layout of the destination image -- subresources for the blit.
regionCount is the number of regions to blit.
pRegions is a pointer to an array of VkImageBlit -- structures specifying the regions to blit.
filter is a VkFilter specifying the filter to -- apply if the blits require scaling.

-- --

Description

-- -- vkCmdBlitImage must not be used for multisampled -- source or destination images. Use vkCmdResolveImage for this -- purpose. -- -- As the sizes of the source and destination extents can differ -- in any dimension, texels in the source extent are scaled and filtered -- to the destination extent. Scaling occurs via the following -- operations: -- --

For each destination texel, the integer coordinate of that texel -- is converted to an unnormalized texture coordinate, using the -- effective inverse of the equations described in unnormalized to -- integer conversion:
- ubase = i + ½
- vbase = j + -- ½
- wbase = k + ½
These base coordinates are then offset by the first destination -- offset:
- uoffset = ubase - xdst0
- voffset = vbase - -- ydst0
- woffset = wbase - zdst0
- aoffset = a - -- baseArrayCountdst
The scale is determined from the source and destination regions, -- and applied to the offset coordinates:
- scale_u = (xsrc1 - -- xsrc0) / (xdst1 - xdst0)
- scale_v = (ysrc1 - ysrc0) / (ydst1 - -- ydst0)
- scale_w = (zsrc1 - zsrc0) / (zdst1 - -- zdst0)
- uscaled = uoffset * scaleu
- vscaled = voffset * -- scalev
- wscaled = woffset * scalew
Finally the source offset is added to the scaled coordinates, to -- determine the final unnormalized coordinates used to sample from -- srcImage:
- u = uscaled + xsrc0
- v = vscaled + -- ysrc0
- w = wscaled + zsrc0
- q = -- mipLevel
- a = aoffset + -- baseArrayCountsrc

-- -- These coordinates are used to sample from the source image, as -- described in Image Operations chapter, with the filter mode -- equal to that of filter, a mipmap mode of -- VK_SAMPLER_MIPMAP_MODE_NEAREST and an address mode of -- VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE. Implementations -- must clamp at the edge of the source image, and may -- additionally clamp to the edge of the source region. -- -- Note -- -- Due to allowable rounding errors in the generation of the source -- texture coordinates, it is not always possible to guarantee exactly -- which source texels will be sampled for a given blit. As rounding -- errors are implementation dependent, the exact results of a blitting -- operation are also implementation dependent. -- -- Blits are done layer by layer starting with the -- baseArrayLayer member of srcSubresource for the -- source and dstSubresource for the destination. -- layerCount layers are blitted to the destination image. -- -- 3D textures are blitted slice by slice. Slices in the source region -- bounded by srcOffsets[0].z and -- srcOffsets[1].z are copied to slices in the -- destination region bounded by dstOffsets[0].z and -- dstOffsets[1].z. For each destination slice, a -- source z coordinate is linearly interpolated between -- srcOffsets[0].z and -- srcOffsets[1].z. If the filter parameter is -- VK_FILTER_LINEAR then the value sampled from the source image -- is taken by doing linear filtering using the interpolated z -- coordinate. If filter parameter is VK_FILTER_NEAREST -- then value sampled from the source image is taken from the single -- nearest slice (with undefined rounding mode). -- -- The following filtering and conversion rules apply: -- --

Integer formats can only be converted to other integer -- formats with the same signedness.
No format conversion is supported between depth/stencil images. -- The formats must match.
Format conversions on unorm, snorm, unscaled and packed float -- formats of the copied aspect of the image are performed by first -- converting the pixels to float values.
For sRGB source formats, nonlinear RGB values are converted to -- linear representation prior to filtering.
After filtering, the float values are first clamped and then cast -- to the destination image format. In case of sRGB destination format, -- linear RGB values are converted to nonlinear representation before -- writing the pixel to the image.

-- -- Signed and unsigned integers are converted by first clamping to the -- representable range of the destination format, then casting the value. -- --

Valid Usage

-- --

The source region specified by each element of pRegions -- must be a region that is contained within -- srcImage

-- --

The destination region specified by each element of -- pRegions must be a region that is contained within -- dstImage
The union of all destination regions, specified by the elements of -- pRegions, must not overlap in memory with any texel -- that may be sampled during the blit operation
srcImage must use a format that supports -- VK_FORMAT_FEATURE_BLIT_SRC_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
srcImage must not use a format listed in -- {html_spec_relative}#features-formats-requiring-sampler-ycbcr-conversion
srcImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
If srcImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a VkDevice
srcImageLayout must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
dstImage must use a format that supports -- VK_FORMAT_FEATURE_BLIT_DST_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
dstImage must not use a format listed in -- {html_spec_relative}#features-formats-requiring-sampler-ycbcr-conversion
dstImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a VkDevice
dstImageLayout must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
The sample count of srcImage and dstImage -- must both be equal to VK_SAMPLE_COUNT_1_BIT
If either of srcImage or dstImage was created -- with a signed integer VkFormat, the other must also have -- been created with a signed integer VkFormat
If either of srcImage or dstImage was created -- with an unsigned integer VkFormat, the other must also -- have been created with an unsigned integer VkFormat
If either of srcImage or dstImage was created -- with a depth/stencil format, the other must have exactly the -- same format
If srcImage was created with a depth/stencil format, -- filter must be VK_FILTER_NEAREST
srcImage must have been created with a -- samples value of VK_SAMPLE_COUNT_1_BIT
dstImage must have been created with a -- samples value of VK_SAMPLE_COUNT_1_BIT
If filter is VK_FILTER_LINEAR, srcImage -- must be of a format which supports linear filtering, as -- specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
If filter is VK_FILTER_CUBIC_IMG, -- srcImage must be of a format which supports cubic -- filtering, as specified by the -- VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG flag in -- VkFormatProperties::linearTilingFeatures (for a -- linear image) or -- VkFormatProperties::optimalTilingFeatures(for an -- optimally tiled image) returned by -- vkGetPhysicalDeviceFormatProperties
If filter is VK_FILTER_CUBIC_IMG, -- srcImage must have a VkImageType of -- VK_IMAGE_TYPE_3D
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when dstImage was -- created
The srcSubresource.baseArrayLayer + -- srcSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- srcImage was created
The dstSubresource.baseArrayLayer + -- dstSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- dstImage was created

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcImage must be a valid VkImage -- handle
srcImageLayout must be a valid -- VkImageLayout value
dstImage must be a valid VkImage -- handle
dstImageLayout must be a valid -- VkImageLayout value
pRegions must be a valid pointer to an array of -- regionCount valid VkImageBlit structures
filter must be a valid VkFilter value
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstImage, and -- srcImage must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Transfer        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcBuffer is the source buffer.
dstImage is the destination image.
dstImageLayout is the layout of the destination image -- subresources for the copy.
regionCount is the number of regions to copy.
pRegions is a pointer to an array of -- VkBufferImageCopy structures specifying the regions to -- copy.

-- --

Description

-- -- Each region in pRegions is copied from the specified region -- of the source buffer to the specified region of the destination image. -- -- If the format of dstImage is a multi-planar image -- format), regions of each plane to be a target of a copy -- must be specified separately using the pRegions member -- of the VkBufferImageCopy structure. In this case, the -- aspectMask of imageSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT. For the purposes of -- vkCmdCopyBufferToImage, each plane of a multi-planar image is -- treated as having the format listed in -- {html_spec_relative}#features-formats-compatible-planes for the -- plane identified by the aspectMask of the corresponding -- subresource. This applies both to VkFormat and to coordinates -- used in the copy, which correspond to texels in the plane -- rather than how these texels map to coordinates in the image as a -- whole. -- --

Valid Usage

-- --

The buffer region specified by each element of pRegions -- must be a region that is contained within -- srcBuffer

-- --

The image region specified by each element of pRegions -- must be a region that is contained within dstImage if -- the dstImage’s VkFormat is not a multi-planar -- format, and must be a region that is contained within the -- plane being copied to if the dstImage’s VkFormat is a -- multi-planar format
The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
srcBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
dstImage must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_DST_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
If srcBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstImage must have a sample count equal to -- VK_SAMPLE_COUNT_1_BIT
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a VkDevice
dstImageLayout must be -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, -- VK_IMAGE_LAYOUT_GENERAL, or -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
The imageSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when dstImage was -- created
The imageSubresource.baseArrayLayer + -- imageSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- dstImage was created
The imageOffset and and imageExtent members of -- each element of pRegions must respect the image -- transfer granularity requirements of commandBuffer’s command -- pool’s queue family, as described in -- VkQueueFamilyProperties

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcBuffer must be a valid VkBuffer -- handle
dstImage must be a valid VkImage -- handle
dstImageLayout must be a valid -- VkImageLayout value
pRegions must be a valid pointer to an array of -- regionCount valid VkBufferImageCopy structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstImage, and -- srcBuffer must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcImage is the source image.
srcImageLayout is the layout of the source image -- subresources for the copy.
dstBuffer is the destination buffer.
regionCount is the number of regions to copy.
pRegions is a pointer to an array of -- VkBufferImageCopy structures specifying the regions to -- copy.

-- --

Description

-- -- Each region in pRegions is copied from the specified region -- of the source image to the specified region of the destination buffer. -- -- If the VkFormat of srcImage is a multi-planar image -- format, regions of each plane to be a source of a copy must -- be specified separately using the pRegions member of the -- VkBufferImageCopy structure. In this case, the -- aspectMask of imageSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT. For the purposes of -- vkCmdCopyBufferToImage, each plane of a multi-planar image is -- treated as having the format listed in -- {html_spec_relative}#features-formats-compatible-planes for the -- plane identified by the aspectMask of the corresponding -- subresource. This applies both to VkFormat and to coordinates -- used in the copy, which correspond to texels in the plane -- rather than how these texels map to coordinates in the image as a -- whole. -- --

Valid Usage

-- --

The image region specified by each element of pRegions -- must be a region that is contained within srcImage if -- the srcImage’s VkFormat is not a multi-planar -- format, and must be a region that is contained within the -- plane being copied if the srcImage’s VkFormat is a -- multi-planar format

-- --

The buffer region specified by each element of pRegions -- must be a region that is contained within -- dstBuffer
The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
srcImage must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties
srcImage must have been created with -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
If srcImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
srcImage must have a sample count equal to -- VK_SAMPLE_COUNT_1_BIT
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a VkDevice
srcImageLayout must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
The imageSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when srcImage was -- created
The imageSubresource.baseArrayLayer + -- imageSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- srcImage was created
The imageOffset and and imageExtent members of -- each element of pRegions must respect the image -- transfer granularity requirements of commandBuffer’s command -- pool’s queue family, as described in -- VkQueueFamilyProperties

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcImage must be a valid VkImage -- handle
srcImageLayout must be a valid -- VkImageLayout value
dstBuffer must be a valid VkBuffer -- handle
pRegions must be a valid pointer to an array of -- regionCount valid VkBufferImageCopy structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstBuffer, and -- srcImage must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

dstBuffer is a handle to the buffer to be updated.
dstOffset is the byte offset into the buffer to start -- updating, and must be a multiple of 4.
dataSize is the number of bytes to update, and -- must be a multiple of 4.
pData is a pointer to the source data for the buffer -- update, and must be at least dataSize bytes in -- size.

-- --

Description

-- -- dataSize must be less than or equal to 65536 bytes. -- For larger updates, applications can use buffer to buffer -- copies. -- -- Note -- -- Buffer updates performed with vkCmdUpdateBuffer first copy -- the data into command buffer memory when the command is recorded -- (which requires additional storage and may incur an additional -- allocation), and then copy the data from the command buffer into -- dstBuffer when the command is executed on a device. -- -- The additional cost of this functionality compared to buffer to -- buffer copies means it is only recommended for very small amounts -- of data, and is why it is limited to only 65536 bytes. -- -- Applications can work around this by issuing multiple -- vkCmdUpdateBuffer commands to different ranges of the same -- buffer, but it is strongly recommended that they should not. -- -- The source data is copied from the user pointer to the command buffer -- when the command is called. -- -- vkCmdUpdateBuffer is only allowed outside of a render pass. -- This command is treated as “transfer” operation, for the purposes of -- synchronization barriers. The -- VK_BUFFER_USAGE_TRANSFER_DST_BIT must be specified in -- usage of VkBufferCreateInfo in order for the buffer to -- be compatible with vkCmdUpdateBuffer. -- --

Valid Usage

-- --

dstOffset must be less than the size of -- dstBuffer

-- --

dataSize must be less than or equal to the size of -- dstBuffer minus dstOffset
dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstOffset must be a multiple of 4
dataSize must be less than or equal to -- 65536
dataSize must be a multiple of 4

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

dstBuffer must be a valid VkBuffer -- handle
pData must be a valid pointer to an array of -- dataSize bytes
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
dataSize must be greater than 0
Both of commandBuffer, and dstBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

dstBuffer is the buffer to be filled.
dstOffset is the byte offset into the buffer at which to -- start filling, and must be a multiple of 4.
size is the number of bytes to fill, and must be -- either a multiple of 4, or VK_WHOLE_SIZE to fill the range -- from offset to the end of the buffer. If -- VK_WHOLE_SIZE is used and the remaining size of the buffer is -- not a multiple of 4, then the nearest smaller multiple is used.
data is the 4-byte word written repeatedly to the buffer -- to fill size bytes of data. The data word is written to -- memory according to the host endianness.

-- --

Description

-- -- vkCmdFillBuffer is treated as “transfer” operation for the -- purposes of synchronization barriers. The -- VK_BUFFER_USAGE_TRANSFER_DST_BIT must be specified in -- usage of VkBufferCreateInfo in order for the buffer -- to be compatible with vkCmdFillBuffer. -- --

Valid Usage

-- --

dstOffset must be less than the size of -- dstBuffer

-- --

dstOffset must be a multiple of 4
If size is not equal to VK_WHOLE_SIZE, -- size must be greater than 0
If size is not equal to VK_WHOLE_SIZE, -- size must be less than or equal to the size of -- dstBuffer minus dstOffset
If size is not equal to VK_WHOLE_SIZE, -- size must be a multiple of 4
dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

dstBuffer must be a valid VkBuffer -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics or compute -- operations
This command must only be called outside of a render pass -- instance
Both of commandBuffer, and dstBuffer must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

image is the image to be cleared.
imageLayout specifies the current layout of the image -- subresource ranges to be cleared, and must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_GENERAL or -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL.
pColor is a pointer to a VkClearColorValue -- structure that contains the values the image subresource ranges will -- be cleared to (see {html_spec_relative}#clears-values -- below).
rangeCount is the number of image subresource range -- structures in pRanges.
pRanges points to an array of -- VkImageSubresourceRange structures that describe a range of -- mipmap levels, array layers, and aspects to be cleared, as described -- in Image Views. The aspectMask of all image -- subresource ranges must only include -- VK_IMAGE_ASPECT_COLOR_BIT.

-- --

Description

-- -- Each specified range in pRanges is cleared to the value -- specified by pColor. -- --

Valid Usage

-- --

image must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_DST_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties

-- --

image must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag
image must not use a format listed in -- {html_spec_relative}#features-formats-requiring-sampler-ycbcr-conversion
If image is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
imageLayout must specify the layout of the image -- subresource ranges of image specified in pRanges at -- the time this command is executed on a VkDevice
imageLayout must be -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, -- VK_IMAGE_LAYOUT_GENERAL, or -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
The VkImageSubresourceRange::baseMipLevel members -- of the elements of the pRanges array must each be less -- than the mipLevels specified in VkImageCreateInfo when -- image was created
For each VkImageSubresourceRange element of -- pRanges, if the levelCount member is not -- VK_REMAINING_MIP_LEVELS, then baseMipLevel + -- levelCount must be less than the mipLevels -- specified in VkImageCreateInfo when image was -- created
The VkImageSubresourceRange::baseArrayLayer -- members of the elements of the pRanges array must each -- be less than the arrayLayers specified in -- VkImageCreateInfo when image was created
For each VkImageSubresourceRange element of -- pRanges, if the layerCount member is not -- VK_REMAINING_ARRAY_LAYERS, then baseArrayLayer + -- layerCount must be less than the arrayLayers -- specified in VkImageCreateInfo when image was -- created
image must not have a compressed or depth/stencil -- format

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

image must be a valid VkImage handle
imageLayout must be a valid VkImageLayout -- value
pColor must be a valid pointer to a valid -- VkClearColorValue union
pRanges must be a valid pointer to an array of -- rangeCount valid VkImageSubresourceRange -- structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
rangeCount must be greater than 0
Both of commandBuffer, and image must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Transfer        |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

image is the image to be cleared.
imageLayout specifies the current layout of the image -- subresource ranges to be cleared, and must be -- VK_IMAGE_LAYOUT_GENERAL or -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL.
pDepthStencil is a pointer to a -- VkClearDepthStencilValue structure that contains the values the -- depth and stencil image subresource ranges will be cleared to (see -- {html_spec_relative}#clears-values below).
rangeCount is the number of image subresource range -- structures in pRanges.
pRanges points to an array of -- VkImageSubresourceRange structures that describe a range of -- mipmap levels, array layers, and aspects to be cleared, as described -- in Image Views. The aspectMask of each image -- subresource range in pRanges can include -- VK_IMAGE_ASPECT_DEPTH_BIT if the image format has a depth -- component, and VK_IMAGE_ASPECT_STENCIL_BIT if the image -- format has a stencil component. pDepthStencil is a pointer to -- a VkClearDepthStencilValue structure that contains the values -- the image subresource ranges will be cleared to (see -- {html_spec_relative}#clears-values below).

-- --

Description

-- --

Valid Usage

-- --

image must use a format that supports -- VK_FORMAT_FEATURE_TRANSFER_DST_BIT, which is indicated by -- VkFormatProperties::linearTilingFeatures (for -- linearly tiled images) or -- VkFormatProperties::optimalTilingFeatures (for -- optimally tiled images) - as returned by -- vkGetPhysicalDeviceFormatProperties

-- --

image must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If image is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
imageLayout must specify the layout of the image -- subresource ranges of image specified in pRanges at -- the time this command is executed on a VkDevice
imageLayout must be either of -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
The VkImageSubresourceRange::baseMipLevel members -- of the elements of the pRanges array must each be less -- than the mipLevels specified in VkImageCreateInfo when -- image was created
For each VkImageSubresourceRange element of -- pRanges, if the levelCount member is not -- VK_REMAINING_MIP_LEVELS, then baseMipLevel + -- levelCount must be less than the mipLevels -- specified in VkImageCreateInfo when image was -- created
The VkImageSubresourceRange::baseArrayLayer -- members of the elements of the pRanges array must each -- be less than the arrayLayers specified in -- VkImageCreateInfo when image was created
For each VkImageSubresourceRange element of -- pRanges, if the layerCount member is not -- VK_REMAINING_ARRAY_LAYERS, then baseArrayLayer + -- layerCount must be less than the arrayLayers -- specified in VkImageCreateInfo when image was -- created
image must have a depth/stencil format

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

image must be a valid VkImage handle
imageLayout must be a valid VkImageLayout -- value
pDepthStencil must be a valid pointer to a valid -- VkClearDepthStencilValue structure
pRanges must be a valid pointer to an array of -- rangeCount valid VkImageSubresourceRange -- structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called outside of a render pass -- instance
rangeCount must be greater than 0
Both of commandBuffer, and image must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Transfer        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

attachmentCount is the number of entries in the -- pAttachments array.
pAttachments is a pointer to an array of -- VkClearAttachment structures defining the attachments to clear -- and the clear values to use.
rectCount is the number of entries in the pRects -- array.
pRects points to an array of VkClearRect -- structures defining regions within each selected attachment to -- clear.

-- --

Description

-- -- vkCmdClearAttachments can clear multiple regions of -- each attachment used in the current subpass of a render pass instance. -- This command must be called only inside a render pass instance, -- and implicitly selects the images to clear based on the current -- framebuffer attachments and the command parameters. -- --

Valid Usage

-- --

If the aspectMask member of any element of -- pAttachments contains VK_IMAGE_ASPECT_COLOR_BIT, the -- colorAttachment member of that element must refer to a -- valid color attachment in the current subpass

-- --

The rectangular region specified by each element of -- pRects must be contained within the render area of the -- current render pass instance
The layers specified by each element of pRects -- must be contained within every attachment that -- pAttachments refers to
If the render pass instance this is recorded in uses multiview, -- then baseArrayLayer must be zero and -- layerCount must be one.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pAttachments must be a valid pointer to an array -- of attachmentCount valid VkClearAttachment -- structures
pRects must be a valid pointer to an array of -- rectCount VkClearRect structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
attachmentCount must be greater than -- 0
rectCount must be greater than 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

srcImage is the source image.
srcImageLayout is the layout of the source image -- subresources for the resolve.
dstImage is the destination image.
dstImageLayout is the layout of the destination image -- subresources for the resolve.
regionCount is the number of regions to resolve.
pRegions is a pointer to an array of -- VkImageResolve structures specifying the regions to -- resolve.

-- --

Description

-- -- During the resolve the samples corresponding to each pixel location in -- the source are converted to a single sample before being written to -- the destination. If the source formats are floating-point or -- normalized types, the sample values for each pixel are resolved in an -- implementation-dependent manner. If the source formats are integer -- types, a single sample’s value is selected for each pixel. -- -- srcOffset and dstOffset select the initial -- x, y, and z offsets in texels of the -- sub-regions of the source and destination image data. extent -- is the size in texels of the source image to resolve in -- width, height and depth. -- -- Resolves are done layer by layer starting with baseArrayLayer -- member of srcSubresource for the source and -- dstSubresource for the destination. layerCount -- layers are resolved to the destination image. -- --

Valid Usage

-- --

The source region specified by each element of pRegions -- must be a region that is contained within -- srcImage

-- --

The destination region specified by each element of -- pRegions must be a region that is contained within -- dstImage
The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
If srcImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
srcImage must have a sample count equal to any -- valid sample count value other than -- VK_SAMPLE_COUNT_1_BIT
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
dstImage must have a sample count equal to -- VK_SAMPLE_COUNT_1_BIT
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a VkDevice
srcImageLayout must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a VkDevice
dstImageLayout must be -- VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- VK_IMAGE_LAYOUT_GENERAL
If dstImage was created with tiling equal to -- VK_IMAGE_TILING_LINEAR, dstImage must have -- been created with a format that supports being a color -- attachment, as specified by the -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in -- VkFormatProperties::linearTilingFeatures returned by -- vkGetPhysicalDeviceFormatProperties
If dstImage was created with tiling equal to -- VK_IMAGE_TILING_OPTIMAL, dstImage must have -- been created with a format that supports being a color -- attachment, as specified by the -- VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT flag in -- VkFormatProperties::optimalTilingFeatures returned -- by vkGetPhysicalDeviceFormatProperties
srcImage and dstImage must have been -- created with the same image format
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in VkImageCreateInfo when dstImage was -- created
The srcSubresource.baseArrayLayer + -- srcSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- srcImage was created
The dstSubresource.baseArrayLayer + -- dstSubresource.layerCount of each element of -- pRegions must be less than or equal to the -- arrayLayers specified in VkImageCreateInfo when -- dstImage was created

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcImage must be a valid VkImage -- handle
srcImageLayout must be a valid -- VkImageLayout value
dstImage must be a valid VkImage -- handle
dstImageLayout must be a valid -- VkImageLayout value
pRegions must be a valid pointer to an array of -- regionCount valid VkImageResolve structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called outside of a render pass -- instance
regionCount must be greater than 0
Each of commandBuffer, dstImage, and -- srcImage must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Transfer        |
--   | Secondary       |                 |                 |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

event is the event that will be signaled.
stageMask specifies the source stage mask used to -- determine when the event is signaled.

-- --

Description

-- -- When vkCmdSetEvent is submitted to a queue, it defines an -- execution dependency on commands that were submitted before it, and -- defines an event signal operation which sets the event to the signaled -- state. -- -- The first synchronization scope includes all commands that -- occur earlier in submission order. The synchronization scope is -- limited to operations on the pipeline stages determined by the -- source stage mask specified by stageMask. -- -- The second synchronization scope includes only the event signal -- operation. -- -- If event is already in the signaled state when -- vkCmdSetEvent is executed on the device, then -- vkCmdSetEvent has no effect, no event signal operation occurs, -- and no execution dependency is generated. -- --

Valid Usage

-- --

stageMask must not include -- VK_PIPELINE_STAGE_HOST_BIT

-- --

If the geometry shaders feature is not enabled, -- stageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- stageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
commandBuffer’s current device mask must include -- exactly one physical device.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

event must be a valid VkEvent handle
stageMask must be a valid combination of -- VkPipelineStageFlagBits values
stageMask must not be 0
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
Both of commandBuffer, and event must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

event is the event that will be unsignaled.
stageMask is a bitmask of VkPipelineStageFlagBits -- specifying the source stage mask used to determine when the -- event is unsignaled.

-- --

Description

-- -- When vkCmdResetEvent is submitted to a queue, it defines an -- execution dependency on commands that were submitted before it, and -- defines an event unsignal operation which resets the event to the -- unsignaled state. -- -- The first synchronization scope includes all commands that -- occur earlier in submission order. The synchronization scope is -- limited to operations on the pipeline stages determined by the -- source stage mask specified by stageMask. -- -- The second synchronization scope includes only the event -- unsignal operation. -- -- If event is already in the unsignaled state when -- vkCmdResetEvent is executed on the device, then -- vkCmdResetEvent has no effect, no event unsignal operation -- occurs, and no execution dependency is generated. -- --

Valid Usage

-- --

stageMask must not include -- VK_PIPELINE_STAGE_HOST_BIT

-- --

If the geometry shaders feature is not enabled, -- stageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- stageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
When this command executes, event must not be -- waited on by a vkCmdWaitEvents command that is currently -- executing
commandBuffer’s current device mask must include -- exactly one physical device.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

event must be a valid VkEvent handle
stageMask must be a valid combination of -- VkPipelineStageFlagBits values
stageMask must not be 0
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
Both of commandBuffer, and event must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

eventCount is the length of the pEvents -- array.
pEvents is an array of event object handles to wait -- on.
srcStageMask is a bitmask of -- VkPipelineStageFlagBits specifying the source stage -- mask.
dstStageMask is a bitmask of -- VkPipelineStageFlagBits specifying the destination stage -- mask.
memoryBarrierCount is the length of the -- pMemoryBarriers array.
pMemoryBarriers is a pointer to an array of -- VkMemoryBarrier structures.
bufferMemoryBarrierCount is the length of the -- pBufferMemoryBarriers array.
pBufferMemoryBarriers is a pointer to an array of -- VkBufferMemoryBarrier structures.
imageMemoryBarrierCount is the length of the -- pImageMemoryBarriers array.
pImageMemoryBarriers is a pointer to an array of -- VkImageMemoryBarrier structures.

-- --

Description

-- -- When vkCmdWaitEvents is submitted to a queue, it defines a -- memory dependency between prior event signal operations on the same -- queue or the host, and subsequent commands. vkCmdWaitEvents -- must not be used to wait on event signal operations occuring on -- other queues. -- -- The first synchronization scope only includes event signal operations -- that operate on members of pEvents, and the operations that -- happened-before the event signal operations. Event signal operations -- performed by vkCmdSetEvent that occur earlier in submission -- order are included in the first synchronization scope, if the -- logically latest pipeline stage in their stageMask -- parameter is logically earlier than or equal to the -- logically latest pipeline stage in srcStageMask. Event -- signal operations performed by vkSetEvent are only included in -- the first synchronization scope if VK_PIPELINE_STAGE_HOST_BIT -- is included in srcStageMask. -- -- The second synchronization scope includes all commands that -- occur later in submission order. The second synchronization -- scope is limited to operations on the pipeline stages determined by -- the destination stage mask specified by dstStageMask. -- -- The first access scope is limited to access in the pipeline -- stages determined by the source stage mask specified by -- srcStageMask. Within that, the first access scope only -- includes the first access scopes defined by elements of the -- pMemoryBarriers, pBufferMemoryBarriers and -- pImageMemoryBarriers arrays, which each define a set of -- memory barriers. If no memory barriers are specified, then the -- first access scope includes no accesses. -- -- The second access scope is limited to access in the pipeline -- stages determined by the destination stage mask specified by -- dstStageMask. Within that, the second access scope only -- includes the second access scopes defined by elements of the -- pMemoryBarriers, pBufferMemoryBarriers and -- pImageMemoryBarriers arrays, which each define a set of -- memory barriers. If no memory barriers are specified, then the -- second access scope includes no accesses. -- -- Note -- -- vkCmdWaitEvents is used with vkCmdSetEvent to define a -- memory dependency between two sets of action commands, roughly in the -- same way as pipeline barriers, but split into two commands such that -- work between the two may execute unhindered. -- -- Note -- -- Applications should be careful to avoid race conditions when -- using events. There is no direct ordering guarantee between a -- vkCmdResetEvent command and a vkCmdWaitEvents command -- submitted after it, so some other execution dependency must be -- included between these commands (e.g. a semaphore). -- --

Valid Usage

-- --

srcStageMask must be the bitwise OR of the -- stageMask parameter used in previous calls to -- vkCmdSetEvent with any of the members of pEvents and -- VK_PIPELINE_STAGE_HOST_BIT if any of the members of -- pEvents was set using vkSetEvent

-- --

If the geometry shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If pEvents includes one or more events that will be -- signaled by vkSetEvent after commandBuffer has been -- submitted to a queue, then vkCmdWaitEvents must not be -- called inside a render pass instance
Any pipeline stage included in srcStageMask or -- dstStageMask must be supported by the capabilities of -- the queue family specified by the queueFamilyIndex member of -- the VkCommandPoolCreateInfo structure that was used to create -- the VkCommandPool that commandBuffer was allocated -- from, as specified in the table of supported pipeline -- stages.
Each element of pMemoryBarriers, -- pBufferMemoryBarriers or pImageMemoryBarriers -- must not have any access flag included in its -- srcAccessMask member if that bit is not supported by any of -- the pipeline stages in srcStageMask, as specified in the -- table of supported access types.
Each element of pMemoryBarriers, -- pBufferMemoryBarriers or pImageMemoryBarriers -- must not have any access flag included in its -- dstAccessMask member if that bit is not supported by any of -- the pipeline stages in dstStageMask, as specified in the -- table of supported access types.
commandBuffer’s current device mask must include -- exactly one physical device.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pEvents must be a valid pointer to an array of -- eventCount valid VkEvent handles
srcStageMask must be a valid combination of -- VkPipelineStageFlagBits values
srcStageMask must not be 0
dstStageMask must be a valid combination of -- VkPipelineStageFlagBits values
dstStageMask must not be 0
If memoryBarrierCount is not 0, -- pMemoryBarriers must be a valid pointer to an array of -- memoryBarrierCount valid VkMemoryBarrier -- structures
If bufferMemoryBarrierCount is not 0, -- pBufferMemoryBarriers must be a valid pointer to an -- array of bufferMemoryBarrierCount valid -- VkBufferMemoryBarrier structures
If imageMemoryBarrierCount is not 0, -- pImageMemoryBarriers must be a valid pointer to an -- array of imageMemoryBarrierCount valid -- VkImageMemoryBarrier structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
eventCount must be greater than 0
Both of commandBuffer, and the elements of -- pEvents must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command is recorded.

-- --

srcStageMask is a bitmask of -- VkPipelineStageFlagBits specifying the source stage -- mask.
dstStageMask is a bitmask of -- VkPipelineStageFlagBits specifying the destination stage -- mask.
dependencyFlags is a bitmask of -- VkDependencyFlagBits specifying how execution and memory -- dependencies are formed.
memoryBarrierCount is the length of the -- pMemoryBarriers array.
pMemoryBarriers is a pointer to an array of -- VkMemoryBarrier structures.
bufferMemoryBarrierCount is the length of the -- pBufferMemoryBarriers array.
pBufferMemoryBarriers is a pointer to an array of -- VkBufferMemoryBarrier structures.
imageMemoryBarrierCount is the length of the -- pImageMemoryBarriers array.
pImageMemoryBarriers is a pointer to an array of -- VkImageMemoryBarrier structures.

-- --

Description

-- -- When vkCmdPipelineBarrier is submitted to a queue, it defines a -- memory dependency between commands that were submitted before it, and -- those submitted after it. -- -- If vkCmdPipelineBarrier was recorded outside a render pass -- instance, the first synchronization scope includes all commands -- that occur earlier in submission order. If -- vkCmdPipelineBarrier was recorded inside a render pass -- instance, the first synchronization scope includes only commands that -- occur earlier in submission order within the same subpass. In -- either case, the first synchronization scope is limited to operations -- on the pipeline stages determined by the source stage mask -- specified by srcStageMask. -- -- If vkCmdPipelineBarrier was recorded outside a render pass -- instance, the second synchronization scope includes all -- commands that occur later in submission order. If -- vkCmdPipelineBarrier was recorded inside a render pass -- instance, the second synchronization scope includes only commands that -- occur later in submission order within the same subpass. In -- either case, the second synchronization scope is limited to operations -- on the pipeline stages determined by the destination stage mask -- specified by dstStageMask. -- -- The first access scope is limited to access in the pipeline -- stages determined by the source stage mask specified by -- srcStageMask. Within that, the first access scope only -- includes the first access scopes defined by elements of the -- pMemoryBarriers, pBufferMemoryBarriers and -- pImageMemoryBarriers arrays, which each define a set of -- memory barriers. If no memory barriers are specified, then the -- first access scope includes no accesses. -- -- The second access scope is limited to access in the pipeline -- stages determined by the destination stage mask specified by -- dstStageMask. Within that, the second access scope only -- includes the second access scopes defined by elements of the -- pMemoryBarriers, pBufferMemoryBarriers and -- pImageMemoryBarriers arrays, which each define a set of -- memory barriers. If no memory barriers are specified, then the -- second access scope includes no accesses. -- -- If dependencyFlags includes -- VK_DEPENDENCY_BY_REGION_BIT, then any dependency between -- framebuffer-space pipeline stages is framebuffer-local - -- otherwise it is framebuffer-global. -- --

Valid Usage

-- --

If the geometry shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT

-- --

If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If vkCmdPipelineBarrier is called within a render pass -- instance, the render pass must have been created with a -- VkSubpassDependency instance in pDependencies that -- expresses a dependency from the current subpass to itself.
If vkCmdPipelineBarrier is called within a render pass -- instance, srcStageMask must contain a subset of the -- bit values in the srcStageMask member of that instance of -- VkSubpassDependency
If vkCmdPipelineBarrier is called within a render pass -- instance, dstStageMask must contain a subset of the -- bit values in the dstStageMask member of that instance of -- VkSubpassDependency
If vkCmdPipelineBarrier is called within a render pass -- instance, the srcAccessMask of any element of -- pMemoryBarriers or pImageMemoryBarriers must -- contain a subset of the bit values the srcAccessMask member -- of that instance of VkSubpassDependency
If vkCmdPipelineBarrier is called within a render pass -- instance, the dstAccessMask of any element of -- pMemoryBarriers or pImageMemoryBarriers must -- contain a subset of the bit values the dstAccessMask member -- of that instance of VkSubpassDependency
If vkCmdPipelineBarrier is called within a render pass -- instance, dependencyFlags must be equal to the -- dependencyFlags member of that instance of -- VkSubpassDependency
If vkCmdPipelineBarrier is called within a render pass -- instance, bufferMemoryBarrierCount must be -- 0
If vkCmdPipelineBarrier is called within a render pass -- instance, the image member of any element of -- pImageMemoryBarriers must be equal to one of the -- elements of pAttachments that the current -- framebuffer was created with, that is also referred to by one -- of the elements of the pColorAttachments, -- pResolveAttachments or pDepthStencilAttachment -- members of the VkSubpassDescription instance that the current -- subpass was created with
If vkCmdPipelineBarrier is called within a render pass -- instance, the oldLayout and newLayout members of any -- element of pImageMemoryBarriers must be equal to the -- layout member of an element of the -- pColorAttachments, pResolveAttachments or -- pDepthStencilAttachment members of the -- VkSubpassDescription instance that the current subpass was -- created with, that refers to the same image
If vkCmdPipelineBarrier is called within a render pass -- instance, the oldLayout and newLayout members of an -- element of pImageMemoryBarriers must be equal
If vkCmdPipelineBarrier is called within a render pass -- instance, the srcQueueFamilyIndex and -- dstQueueFamilyIndex members of any element of -- pImageMemoryBarriers must be -- VK_QUEUE_FAMILY_IGNORED
Any pipeline stage included in srcStageMask or -- dstStageMask must be supported by the capabilities of -- the queue family specified by the queueFamilyIndex member of -- the VkCommandPoolCreateInfo structure that was used to create -- the VkCommandPool that commandBuffer was allocated -- from, as specified in the table of supported pipeline -- stages.
Each element of pMemoryBarriers, -- pBufferMemoryBarriers and pImageMemoryBarriers -- must not have any access flag included in its -- srcAccessMask member if that bit is not supported by any of -- the pipeline stages in srcStageMask, as specified in the -- table of supported access types.
Each element of pMemoryBarriers, -- pBufferMemoryBarriers and pImageMemoryBarriers -- must not have any access flag included in its -- dstAccessMask member if that bit is not supported by any of -- the pipeline stages in dstStageMask, as specified in the -- table of supported access types.
If vkCmdPipelineBarrier is called outside of a render -- pass instance, dependencyFlags must not include -- VK_DEPENDENCY_VIEW_LOCAL_BIT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

srcStageMask must be a valid combination of -- VkPipelineStageFlagBits values
srcStageMask must not be 0
dstStageMask must be a valid combination of -- VkPipelineStageFlagBits values
dstStageMask must not be 0
dependencyFlags must be a valid combination of -- VkDependencyFlagBits values
If memoryBarrierCount is not 0, -- pMemoryBarriers must be a valid pointer to an array of -- memoryBarrierCount valid VkMemoryBarrier -- structures
If bufferMemoryBarrierCount is not 0, -- pBufferMemoryBarriers must be a valid pointer to an -- array of bufferMemoryBarrierCount valid -- VkBufferMemoryBarrier structures
If imageMemoryBarrierCount is not 0, -- pImageMemoryBarriers must be a valid pointer to an -- array of imageMemoryBarrierCount valid -- VkImageMemoryBarrier structures
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Transfer        |                 |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which this -- command will be recorded.

-- --

queryPool is the query pool that will manage the results -- of the query.
query is the query index within the query pool that will -- contain the results.
flags is a bitmask of VkQueryControlFlagBits -- specifying constraints on the types of queries that can be -- performed.

-- --

Description

-- -- If the queryType of the pool is -- VK_QUERY_TYPE_OCCLUSION and flags contains -- VK_QUERY_CONTROL_PRECISE_BIT, an implementation must -- return a result that matches the actual number of samples passed. This -- is described in more detail in Occlusion Queries. -- -- After beginning a query, that query is considered active within -- the command buffer it was called in until that same query is ended. -- Queries active in a primary command buffer when secondary command -- buffers are executed are considered active for those secondary command -- buffers. -- --

Valid Usage

-- --

queryPool must have been created with a -- queryType that differs from that of any queries that are -- active within commandBuffer

-- --

All queries used by the command must be unavailable
If the precise occlusion queries feature is not enabled, or -- the queryType used to create queryPool was not -- VK_QUERY_TYPE_OCCLUSION, flags must not -- contain VK_QUERY_CONTROL_PRECISE_BIT
query must be less than the number of queries in -- queryPool
If the queryType used to create queryPool was -- VK_QUERY_TYPE_OCCLUSION, the VkCommandPool that -- commandBuffer was allocated from must support graphics -- operations
If the queryType used to create queryPool was -- VK_QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate graphics operations, the -- VkCommandPool that commandBuffer was allocated from -- must support graphics operations
If the queryType used to create queryPool was -- VK_QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate compute operations, the -- VkCommandPool that commandBuffer was allocated from -- must support compute operations
If vkCmdBeginQuery is called within a render pass -- instance, the sum of query and the number of bits set in the -- current subpass’s view mask must be less than or equal to the -- number of queries in queryPool

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

queryPool must be a valid VkQueryPool -- handle
flags must be a valid combination of -- VkQueryControlFlagBits values
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
Both of commandBuffer, and queryPool must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which this -- command will be recorded.

-- --

queryPool is the query pool that is managing the results -- of the query.
query is the query index within the query pool where the -- result is stored.

-- --

Description

-- -- As queries operate asynchronously, ending a query does not immediately -- set the query’s status to available. A query is considered -- finished when the final results of the query are ready to be -- retrieved by vkGetQueryPoolResults and -- vkCmdCopyQueryPoolResults, and this is when the query’s status -- is set to available. -- -- Once a query is ended the query must finish in finite time, -- unless the state of the query is changed using other commands, e.g. by -- issuing a reset of the query. -- --

Valid Usage

-- --

All queries used by the command must be active

-- --

query must be less than the number of queries in -- queryPool
If vkCmdEndQuery is called within a render pass instance, -- the sum of query and the number of bits set in the current -- subpass’s view mask must be less than or equal to the number of -- queries in queryPool

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

queryPool must be a valid VkQueryPool -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
Both of commandBuffer, and queryPool must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which this -- command will be recorded.

-- --

queryPool is the handle of the query pool managing the -- queries being reset.
firstQuery is the initial query index to reset.
queryCount is the number of queries to reset.

-- --

Description

-- -- When executed on a queue, this command sets the status of query -- indices [firstQuery, firstQuery + -- queryCount - 1] to unavailable. -- --

Valid Usage

-- --

firstQuery must be less than the number of queries -- in queryPool

-- --

The sum of firstQuery and queryCount must -- be less than or equal to the number of queries in -- queryPool

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

queryPool must be a valid VkQueryPool -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
Both of commandBuffer, and queryPool must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which the -- command will be recorded.

-- --

pipelineStage is one of the -- VkPipelineStageFlagBits, specifying a stage of the -- pipeline.
queryPool is the query pool that will manage the -- timestamp.
query is the query within the query pool that will -- contain the timestamp.

-- --

Description

-- -- vkCmdWriteTimestamp latches the value of the timer when all -- previous commands have completed executing as far as the specified -- pipeline stage, and writes the timestamp value to memory. When the -- timestamp value is written, the availability status of the query is -- set to available. -- -- Note -- -- If an implementation is unable to detect completion and latch the -- timer at any specific stage of the pipeline, it may instead do -- so at any logically later stage. -- -- vkCmdCopyQueryPoolResults can then be called to copy the -- timestamp value from the query pool into buffer memory, with ordering -- and synchronization behavior equivalent to how other queries operate. -- Timestamp values can also be retrieved from the query pool -- using vkGetQueryPoolResults. As with other queries, the query -- must be reset using vkCmdResetQueryPool before -- requesting the timestamp value be written to it. -- -- While vkCmdWriteTimestamp can be called inside or -- outside of a render pass instance, vkCmdCopyQueryPoolResults -- must only be called outside of a render pass instance. -- -- Timestamps may only be meaningfully compared if they are -- written by commands submitted to the same queue. -- -- Note -- -- An example of such a comparison is determining the execution time of a -- sequence of commands. -- -- If vkCmdWriteTimestamp is called while executing a render -- pass instance that has multiview enabled, the timestamp uses N -- consecutive query indices in the query pool (starting at -- query) where N is the number of bits set in the view mask of -- the subpass the command is executed in. The resulting query values are -- determined by an implementation-dependent choice of one of the -- following behaviors: -- --

The first query is a timestamp value and (if more than one bit is -- set in the view mask) zero is written to the remaining queries. If two -- timestamps are written in the same subpass, the sum of the execution -- time of all views between those commands is the difference between the -- first query written by each command.
All N queries are timestamp values. If two timestamps are written -- in the same subpass, the sum of the execution time of all views -- between those commands is the sum of the difference between -- corresponding queries written by each command. The difference between -- corresponding queries may be the execution time of a single -- view.

-- -- In either case, the application can sum the differences between -- all N queries to determine the total execution time. -- --

Valid Usage

-- --

queryPool must have been created with a -- queryType of VK_QUERY_TYPE_TIMESTAMP

-- --

The query identified by queryPool and query -- must be unavailable
The command pool’s queue family must support a non-zero -- timestampValidBits
All queries used by the command must be unavailable
If vkCmdWriteTimestamp is called within a render pass -- instance, the sum of query and the number of bits set in the -- current subpass’s view mask must be less than or equal to the -- number of queries in queryPool

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pipelineStage must be a valid -- VkPipelineStageFlagBits value
queryPool must be a valid VkQueryPool -- handle
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
Both of commandBuffer, and queryPool must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Transfer        | Transfer        |
--   | Secondary       |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer into which this -- command will be recorded.

-- --

queryPool is the query pool managing the queries -- containing the desired results.
firstQuery is the initial query index.
queryCount is the number of queries. firstQuery -- and queryCount together define a range of queries.
dstBuffer is a VkBuffer object that will receive -- the results of the copy command.
dstOffset is an offset into dstBuffer.
stride is the stride in bytes between results for -- individual queries within dstBuffer. The required size of the -- backing memory for dstBuffer is determined as described above -- for vkGetQueryPoolResults.
flags is a bitmask of VkQueryResultFlagBits -- specifying how and when results are returned.

-- --

Description

-- -- vkCmdCopyQueryPoolResults is guaranteed to see the effect of -- previous uses of vkCmdResetQueryPool in the same queue, -- without any additional synchronization. Thus, the results will always -- reflect the most recent use of the query. -- -- flags has the same possible values described above for the -- flags parameter of vkGetQueryPoolResults, but the -- different style of execution causes some subtle behavioral -- differences. Because vkCmdCopyQueryPoolResults executes in -- order with respect to other query commands, there is less ambiguity -- about which use of a query is being requested. -- -- If no bits are set in flags, results for all requested -- queries in the available state are written as 32-bit unsigned integer -- values, and nothing is written for queries in the unavailable state. -- -- If VK_QUERY_RESULT_64_BIT is set, the results are written as -- an array of 64-bit unsigned integer values as described for -- vkGetQueryPoolResults. -- -- If VK_QUERY_RESULT_WAIT_BIT is set, the implementation will -- wait for each query’s status to be in the available state before -- retrieving the numerical results for that query. This is guaranteed to -- reflect the most recent use of the query on the same queue, assuming -- that the query is not being simultaneously used by other queues. If -- the query does not become available in a finite amount of time (e.g. -- due to not issuing a query since the last reset), a -- VK_ERROR_DEVICE_LOST error may occur. -- -- Similarly, if VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is set -- and VK_QUERY_RESULT_WAIT_BIT is not set, the availability is -- guaranteed to reflect the most recent use of the query on the same -- queue, assuming that the query is not being simultaneously used by -- other queues. As with vkGetQueryPoolResults, implementations -- must guarantee that if they return a non-zero availability -- value, then the numerical results are valid. -- -- If VK_QUERY_RESULT_PARTIAL_BIT is set, -- VK_QUERY_RESULT_WAIT_BIT is not set, and the query’s status -- is unavailable, an intermediate result value between zero and the -- final result value is written for that query. -- -- VK_QUERY_RESULT_PARTIAL_BIT must not be used if the -- pool’s queryType is VK_QUERY_TYPE_TIMESTAMP. -- -- vkCmdCopyQueryPoolResults is considered to be a transfer -- operation, and its writes to buffer memory must be synchronized -- using VK_PIPELINE_STAGE_TRANSFER_BIT and -- VK_ACCESS_TRANSFER_WRITE_BIT before using the results. -- --

Valid Usage

-- --

dstOffset must be less than the size of -- dstBuffer

-- --

firstQuery must be less than the number of queries -- in queryPool
The sum of firstQuery and queryCount must -- be less than or equal to the number of queries in -- queryPool
If VK_QUERY_RESULT_64_BIT is not set in flags -- then dstOffset and stride must be multiples -- of 4
If VK_QUERY_RESULT_64_BIT is set in flags then -- dstOffset and stride must be multiples of -- 8
dstBuffer must have enough storage, from -- dstOffset, to contain the result of each query, as described -- here
dstBuffer must have been created with -- VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single VkDeviceMemory -- object
If the queryType used to create queryPool was -- VK_QUERY_TYPE_TIMESTAMP, flags must not -- contain VK_QUERY_RESULT_PARTIAL_BIT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

queryPool must be a valid VkQueryPool -- handle
dstBuffer must be a valid VkBuffer -- handle
flags must be a valid combination of -- VkQueryResultFlagBits values
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called outside of a render pass -- instance
Each of commandBuffer, dstBuffer, and -- queryPool must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Transfer        |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer in which the push -- constant update will be recorded.

-- --

layout is the pipeline layout used to program the push -- constant updates.
stageFlags is a bitmask of VkShaderStageFlagBits -- specifying the shader stages that will use the push constants in the -- updated range.
offset is the start offset of the push constant range to -- update, in units of bytes.
size is the size of the push constant range to update, in -- units of bytes.
pValues is an array of size bytes containing the -- new push constant values.

-- --

Description

-- --

Valid Usage

-- --

For each byte in the range specified by offset and -- size and for each shader stage in stageFlags, there -- must be a push constant range in layout that includes -- that byte and that stage

-- --

For each byte in the range specified by offset and -- size and for each push constant range that overlaps that -- byte, stageFlags must include all stages in that push -- constant range’s VkPushConstantRange::stageFlags
offset must be a multiple of 4
size must be a multiple of 4
offset must be less than -- VkPhysicalDeviceLimits::maxPushConstantsSize
size must be less than or equal to -- VkPhysicalDeviceLimits::maxPushConstantsSize minus -- offset

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

layout must be a valid VkPipelineLayout -- handle
stageFlags must be a valid combination of -- VkShaderStageFlagBits values
stageFlags must not be 0
pValues must be a valid pointer to an array of -- size bytes
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
size must be greater than 0
Both of commandBuffer, and layout must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer in which to record -- the command.

-- --

pRenderPassBegin is a pointer to a -- VkRenderPassBeginInfo structure (defined below) which specifies -- the render pass to begin an instance of, and the framebuffer the -- instance uses.
contents is a VkSubpassContents value specifying -- how the commands in the first subpass will be provided.

-- --

Description

-- -- After beginning a render pass instance, the command buffer is ready to -- record the commands for the first subpass of that render pass. -- --

Valid Usage

-- --

If any of the initialLayout or finalLayout -- member of the VkAttachmentDescription structures or the -- layout member of the VkAttachmentReference -- structures specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then the -- corresponding attachment image subresource of the framebuffer -- specified in the framebuffer member of -- pRenderPassBegin must have been created with -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT set

-- --

If any of the initialLayout or finalLayout -- member of the VkAttachmentDescription structures or the -- layout member of the VkAttachmentReference -- structures specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, -- VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, or -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then the -- corresponding attachment image subresource of the framebuffer -- specified in the framebuffer member of -- pRenderPassBegin must have been created with -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If any of the initialLayout or finalLayout -- member of the VkAttachmentDescription structures or the -- layout member of the VkAttachmentReference -- structures specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then the -- corresponding attachment image subresource of the framebuffer -- specified in the framebuffer member of -- pRenderPassBegin must have been created with -- VK_IMAGE_USAGE_SAMPLED_BIT or -- VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If any of the initialLayout or finalLayout -- member of the VkAttachmentDescription structures or the -- layout member of the VkAttachmentReference -- structures specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then the corresponding -- attachment image subresource of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT -- set
If any of the initialLayout or finalLayout -- member of the VkAttachmentDescription structures or the -- layout member of the VkAttachmentReference -- structures specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then the corresponding -- attachment image subresource of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with VK_IMAGE_USAGE_TRANSFER_DST_BIT -- set
If any of the initialLayout members of the -- VkAttachmentDescription structures specified when creating -- the render pass specified in the renderPass member of -- pRenderPassBegin is not VK_IMAGE_LAYOUT_UNDEFINED, -- then each such initialLayout must be equal to the -- current layout of the corresponding attachment image subresource of -- the framebuffer specified in the framebuffer member of -- pRenderPassBegin
The srcStageMask and dstStageMask members of any -- element of the pDependencies member of -- VkRenderPassCreateInfo used to create renderPass -- must be supported by the capabilities of the queue family -- identified by the queueFamilyIndex member of the -- VkCommandPoolCreateInfo used to create the command pool which -- commandBuffer was allocated from.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pRenderPassBegin must be a valid pointer to a -- valid VkRenderPassBeginInfo structure
contents must be a valid VkSubpassContents -- value
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called outside of a render pass -- instance
commandBuffer must be a primary -- VkCommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Outside         | Graphics        | Graphics        |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer in which to record -- the command.

-- --

contents specifies how the commands in the next subpass -- will be provided, in the same fashion as the corresponding parameter -- of vkCmdBeginRenderPass.

-- --

Description

-- -- The subpass index for a render pass begins at zero when -- vkCmdBeginRenderPass is recorded, and increments each time -- vkCmdNextSubpass is recorded. -- -- Moving to the next subpass automatically performs any multisample -- resolve operations in the subpass being ended. End-of-subpass -- multisample resolves are treated as color attachment writes for the -- purposes of synchronization. That is, they are considered to execute -- in the VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline -- stage and their writes are synchronized with -- VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT. Synchronization between -- rendering within a subpass and any resolve operations at the end of -- the subpass occurs automatically, without need for explicit -- dependencies or pipeline barriers. However, if the resolve attachment -- is also used in a different subpass, an explicit dependency is needed. -- -- After transitioning to the next subpass, the application can -- record the commands for that subpass. -- --

Valid Usage

-- --

The current subpass index must be less than the number of -- subpasses in the render pass minus one

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

contents must be a valid VkSubpassContents -- value
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
commandBuffer must be a primary -- VkCommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the command buffer in which to end the -- current render pass instance.

-- --

Description

-- -- Ending a render pass instance performs any multisample resolve -- operations on the final subpass. -- --

Valid Usage

-- --

The current subpass index must be equal to the number of -- subpasses in the render pass minus one

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics operations
This command must only be called inside of a render pass -- instance
commandBuffer must be a primary -- VkCommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        | Graphics        |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is a handle to a primary command buffer -- that the secondary command buffers are executed in.

-- --

commandBufferCount is the length of the -- pCommandBuffers array.
pCommandBuffers is an array of secondary command buffer -- handles, which are recorded to execute in the primary command buffer -- in the order they are listed in the array.

-- --

Description

-- -- If any element of pCommandBuffers was not recorded with the -- VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flag, and it was -- recorded into any other primary command buffer which is currently in -- the executable or recording state, that primary command buffer -- becomes invalid. -- --

Valid Usage

-- --

commandBuffer must have been allocated with a -- level of VK_COMMAND_BUFFER_LEVEL_PRIMARY

-- --

Each element of pCommandBuffers must have been -- allocated with a level of -- VK_COMMAND_BUFFER_LEVEL_SECONDARY
Each element of pCommandBuffers must be in the -- pending or executable state.
If any element of pCommandBuffers was not recorded with -- the VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flag, and it -- was recorded into any other primary command buffer, that primary -- command buffer must not be in the pending state
If any element of pCommandBuffers was not recorded with -- the VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flag, it -- must not be in the pending state.
If any element of pCommandBuffers was not recorded with -- the VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flag, it -- must not have already been recorded to -- commandBuffer.
If any element of pCommandBuffers was not recorded with -- the VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flag, it -- must not appear more than once in -- pCommandBuffers.
Each element of pCommandBuffers must have been -- allocated from a VkCommandPool that was created for the same -- queue family as the VkCommandPool from which -- commandBuffer was allocated
If vkCmdExecuteCommands is being called within a render -- pass instance, that render pass instance must have been begun -- with the contents parameter of vkCmdBeginRenderPass -- set to VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS
If vkCmdExecuteCommands is being called within a render -- pass instance, each element of pCommandBuffers must -- have been recorded with the -- VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
If vkCmdExecuteCommands is being called within a render -- pass instance, each element of pCommandBuffers must -- have been recorded with -- VkCommandBufferInheritanceInfo::subpass set to the -- index of the subpass which the given command buffer will be executed -- in
If vkCmdExecuteCommands is being called within a render -- pass instance, the render passes specified in the -- pname::pBeginInfo::pInheritanceInfo::renderPass -- members of the vkBeginCommandBuffer commands used to begin -- recording each element of pCommandBuffers must be -- compatible with the current render pass.
If vkCmdExecuteCommands is being called within a render -- pass instance, and any element of pCommandBuffers was -- recorded with -- VkCommandBufferInheritanceInfo::framebuffer not -- equal to VK_NULL_HANDLE, that VkFramebuffer -- must match the VkFramebuffer used in the current -- render pass instance
If vkCmdExecuteCommands is not being called within a -- render pass instance, each element of pCommandBuffers -- must not have been recorded with the -- VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
If the inherited queries feature is not enabled, -- commandBuffer must not have any queries -- active
If commandBuffer has a VK_QUERY_TYPE_OCCLUSION -- query active, then each element of pCommandBuffers -- must have been recorded with -- VkCommandBufferInheritanceInfo::occlusionQueryEnable -- set to VK_TRUE
If commandBuffer has a VK_QUERY_TYPE_OCCLUSION -- query active, then each element of pCommandBuffers -- must have been recorded with -- VkCommandBufferInheritanceInfo::queryFlags having -- all bits set that are set for the query
If commandBuffer has a -- VK_QUERY_TYPE_PIPELINE_STATISTICS query active, then -- each element of pCommandBuffers must have been -- recorded with -- VkCommandBufferInheritanceInfo::pipelineStatistics -- having all bits set that are set in the VkQueryPool the query -- uses
Each element of pCommandBuffers must not begin any -- query types that are active in commandBuffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pCommandBuffers must be a valid pointer to an -- array of commandBufferCount valid VkCommandBuffer -- handles
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support transfer, graphics, or compute -- operations
commandBuffer must be a primary -- VkCommandBuffer
commandBufferCount must be greater than -- 0
Both of commandBuffer, and the elements of -- pCommandBuffers must have been created, allocated, or -- retrieved from the same VkDevice

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Both            | Transfer        |                 |
--   |                 |                 | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

aspectMask must be a valid combination of -- VkImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

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)

-- --

sType must be -- VK_STRUCTURE_TYPE_MEMORY_BARRIER

-- --

pNext must be NULL
srcAccessMask must be a valid combination of -- VkAccessFlagBits values
dstAccessMask must be a valid combination of -- VkAccessFlagBits values

-- --

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 VK_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 VK_ACCESS_HOST_WRITE_BIT or -- VK_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 VK_WHOLE_SIZE, -- size must be greater than 0
If size is not equal to VK_WHOLE_SIZE, -- size must be less than or equal to than the size of -- buffer minus offset
If buffer was created with a sharing mode of -- VK_SHARING_MODE_CONCURRENT, at least one of -- srcQueueFamilyIndex and dstQueueFamilyIndex -- must be VK_QUEUE_FAMILY_IGNORED
If buffer was created with a sharing mode of -- VK_SHARING_MODE_CONCURRENT, and one of -- srcQueueFamilyIndex and dstQueueFamilyIndex is -- VK_QUEUE_FAMILY_IGNORED, the other must be -- VK_QUEUE_FAMILY_IGNORED or a special queue family reserved -- for external memory ownership transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If buffer was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is -- VK_QUEUE_FAMILY_IGNORED, dstQueueFamilyIndex -- must also be VK_QUEUE_FAMILY_IGNORED
If buffer was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is -- not VK_QUEUE_FAMILY_IGNORED, it must be a valid queue -- family or a special queue family reserved for external memory -- transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If buffer was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and dstQueueFamilyIndex is -- not VK_QUEUE_FAMILY_IGNORED, it must be a valid queue -- family or a special queue family reserved for external memory -- transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If buffer was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex -- and dstQueueFamilyIndex are not -- VK_QUEUE_FAMILY_IGNORED, at least one of them must be -- the same as the family of the queue that will execute this -- barrier

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER

-- --

pNext must be NULL
srcAccessMask must be a valid combination of -- VkAccessFlagBits values
dstAccessMask must be a valid combination of -- VkAccessFlagBits values
buffer must be a valid VkBuffer -- handle

-- --

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 VK_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 VK_ACCESS_HOST_WRITE_BIT or -- VK_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 oldLayout is not equal to newLayout, then the -- memory barrier defines an image layout transition for the -- specified image subresource range. -- -- Layout transitions that are performed via image memory barriers -- execute in their entirety in submission order, relative to -- other image layout transitions submitted to the same queue, including -- those performed by render passes. In effect there is an -- implicit execution dependency from each such layout transition to all -- layout transitions previously submitted to the same queue. -- -- The image layout of each image subresource of a depth/stencil image -- created with -- VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT is -- dependent on the last sample locations used to render to the image -- subresource as a depth/stencil attachment, thus when the -- image member of an VkImageMemoryBarrier is an image -- created with this flag the application can chain a -- VkSampleLocationsInfoEXT structure to the pNext chain -- of VkImageMemoryBarrier to specify the sample locations to -- use during the image layout transition. -- -- If the VkSampleLocationsInfoEXT structure in the -- pNext chain of VkImageMemoryBarrier does not match -- the sample location state last used to render to the image subresource -- range specified by subresourceRange or if no -- VkSampleLocationsInfoEXT structure is in the pNext -- chain of VkImageMemoryBarrier then the contents of the given -- image subresource range becomes undefined as if oldLayout -- would equal VK_IMAGE_LAYOUT_UNDEFINED. -- -- If image has a multi-planar format and the image is -- disjoint, then including VK_IMAGE_ASPECT_COLOR_BIT in -- the aspectMask member of subresourceRange is -- equivalent to including VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, and (for three-plane formats -- only) VK_IMAGE_ASPECT_PLANE_2_BIT. -- --

Valid Usage

-- --

oldLayout must be -- VK_IMAGE_LAYOUT_UNDEFINED or the current layout of the image -- subresources affected by the barrier

-- --

newLayout must not be -- VK_IMAGE_LAYOUT_UNDEFINED or -- VK_IMAGE_LAYOUT_PREINITIALIZED
If image was created with a sharing mode of -- VK_SHARING_MODE_CONCURRENT, at least one of -- srcQueueFamilyIndex and dstQueueFamilyIndex -- must be VK_QUEUE_FAMILY_IGNORED
If image was created with a sharing mode of -- VK_SHARING_MODE_CONCURRENT, and one of -- srcQueueFamilyIndex and dstQueueFamilyIndex is -- VK_QUEUE_FAMILY_IGNORED, the other must be -- VK_QUEUE_FAMILY_IGNORED or a special queue family reserved -- for external memory transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If image was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is -- VK_QUEUE_FAMILY_IGNORED, dstQueueFamilyIndex -- must also be VK_QUEUE_FAMILY_IGNORED.
If image was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is -- not VK_QUEUE_FAMILY_IGNORED, it must be a valid queue -- family or a special queue family reserved for external memory -- transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If image was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE and dstQueueFamilyIndex is -- not VK_QUEUE_FAMILY_IGNORED, it must be a valid queue -- family or a special queue family reserved for external memory -- transfers, as described in -- {html_spec_relative}#synchronization-queue-transfers.
If image was created with a sharing mode of -- VK_SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex -- and dstQueueFamilyIndex are not -- VK_QUEUE_FAMILY_IGNORED, at least one of them must be -- the same as the family of the queue that will execute this -- barrier
subresourceRange.baseMipLevel must be less than -- the mipLevels specified in VkImageCreateInfo when -- image was created
If subresourceRange.levelCount is not -- VK_REMAINING_MIP_LEVELS, -- subresourceRange.baseMipLevel + -- subresourceRange.levelCount must be less than or equal -- to the mipLevels specified in VkImageCreateInfo when -- image was created
subresourceRange.baseArrayLayer must be less than -- the arrayLayers specified in VkImageCreateInfo when -- image was created
If subresourceRange.layerCount is not -- VK_REMAINING_ARRAY_LAYERS, -- subresourceRange.baseArrayLayer + -- subresourceRange.layerCount must be less than or equal -- to the arrayLayers specified in VkImageCreateInfo when -- image was created
If image has a depth/stencil format with both depth and -- stencil components, then the aspectMask member of -- subresourceRange must include both -- VK_IMAGE_ASPECT_DEPTH_BIT and -- VK_IMAGE_ASPECT_STENCIL_BIT
If image has a single-plane color format or is not -- disjoint, then the aspectMask member of -- subresourceRange must be -- VK_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 -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, and -- VK_IMAGE_ASPECT_PLANE_2_BIT; or must include -- VK_IMAGE_ASPECT_COLOR_BIT
If image has a multi-planar format with only two planes, -- then the aspectMask member of subresourceRange -- must not include VK_IMAGE_ASPECT_PLANE_2_BIT
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then image -- must have been created with -- VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL then -- image must have been created with -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then -- image must have been created with -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL -- then image must have been created with -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL -- then image must have been created with -- VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image -- must have been created with VK_IMAGE_USAGE_SAMPLED_BIT -- or VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then image -- must have been created with -- VK_IMAGE_USAGE_TRANSFER_SRC_BIT set
If either oldLayout or newLayout is -- VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then image -- must have been created with -- VK_IMAGE_USAGE_TRANSFER_DST_BIT set

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER

-- --

pNext must be NULL or a pointer to a -- valid instance of VkSampleLocationsInfoEXT
srcAccessMask must be a valid combination of -- VkAccessFlagBits values
dstAccessMask must be a valid combination of -- VkAccessFlagBits values
oldLayout must be a valid VkImageLayout -- value
newLayout must be a valid VkImageLayout -- value
image must be a valid VkImage handle
subresourceRange must be a valid -- VkImageSubresourceRange structure

-- --

srcSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

dstSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

Description

-- -- For each element of the pRegions array, a blit operation is -- performed the specified source and destination regions. -- --

Valid Usage

-- --

The aspectMask member of srcSubresource and -- dstSubresource must match

-- --

The layerCount member of srcSubresource and -- dstSubresource must match
If either of the calling command’s srcImage or -- dstImage parameters are of VkImageType -- VK_IMAGE_TYPE_3D, the baseArrayLayer and -- layerCount members of both srcSubresource and -- dstSubresource must be 0 and 1, -- respectively
The aspectMask member of srcSubresource -- must specify aspects present in the calling command’s -- srcImage
The aspectMask member of dstSubresource -- must specify aspects present in the calling command’s -- dstImage
srcOffset[0].x and -- srcOffset[1].x must both be greater than or -- equal to 0 and less than or equal to the source image -- subresource width
srcOffset[0].y and -- srcOffset[1].y must both be greater than or -- equal to 0 and less than or equal to the source image -- subresource height
If the calling command’s srcImage is of type -- VK_IMAGE_TYPE_1D, then srcOffset[0].y must be -- 0 and srcOffset[1].y must be 1.
srcOffset[0].z and -- srcOffset[1].z must both be greater than or -- equal to 0 and less than or equal to the source image -- subresource depth
If the calling command’s srcImage is of type -- VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then -- srcOffset[0].z must be 0 and -- srcOffset[1].z must be 1.
dstOffset[0].x and -- dstOffset[1].x must both be greater than or -- equal to 0 and less than or equal to the destination image -- subresource width
dstOffset[0].y and -- dstOffset[1].y must both be greater than or -- equal to 0 and less than or equal to the destination image -- subresource height
If the calling command’s dstImage is of type -- VK_IMAGE_TYPE_1D, then dstOffset[0].y must be -- 0 and dstOffset[1].y must be 1.
dstOffset[0].z and -- dstOffset[1].z must both be greater than or -- equal to 0 and less than or equal to the destination image -- subresource depth
If the calling command’s dstImage is of type -- VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then -- dstOffset[0].z must be 0 and -- dstOffset[1].z must be 1.

-- --

Valid Usage (Implicit)

-- --

srcSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

dstSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

Description

-- -- When copying to or from a depth or stencil aspect, the data in buffer -- memory uses a layout that is a (mostly) tightly packed representation -- of the depth or stencil data. Specifically: -- --

data copied to or from the stencil aspect of any depth/stencil -- format is tightly packed with one VK_FORMAT_S8_UINT value per -- texel.
data copied to or from the depth aspect of a -- VK_FORMAT_D16_UNORM or VK_FORMAT_D16_UNORM_S8_UINT -- format is tightly packed with one VK_FORMAT_D16_UNORM value -- per texel.
data copied to or from the depth aspect of a -- VK_FORMAT_D32_SFLOAT or VK_FORMAT_D32_SFLOAT_S8_UINT -- format is tightly packed with one VK_FORMAT_D32_SFLOAT value -- per texel.
data copied to or from the depth aspect of a -- VK_FORMAT_X8_D24_UNORM_PACK32 or -- VK_FORMAT_D24_UNORM_S8_UINT format is packed with one 32-bit -- word per texel with the D24 value in the LSBs of the word, and -- undefined values in the eight MSBs.

-- -- Note -- -- To copy both the depth and stencil aspects of a depth/stencil format, -- two entries in pRegions can be used, where one -- specifies the depth aspect in imageSubresource, and the other -- specifies the stencil aspect. -- -- Because depth or stencil aspect buffer to image copies may -- require format conversions on some implementations, they are not -- supported on queues that do not support graphics. When copying to a -- depth aspect, the data in buffer memory must be in the the -- range [0,1] or undefined results occur. -- -- Copies are done layer by layer starting with image layer -- baseArrayLayer member of imageSubresource. -- layerCount layers are copied from the source image or to the -- destination image. -- --

Valid Usage

-- --

If the calling command’s VkImage parameter’s format is -- not a depth/stencil format or a multi-planar format, then -- bufferOffset must be a multiple of the format’s -- element size

-- --

If the calling command’s VkImage parameter’s format is a -- multi-planar format, then bufferOffset must be -- a multiple of the element size of the compatible format for the format -- and the aspectMask of the imageSubresource as -- defined in -- {html_spec_relative}#features-formats-compatible-planes
bufferOffset must be a multiple of 4
bufferRowLength must be 0, or greater -- than or equal to the width member of -- imageExtent
bufferImageHeight must be 0, or greater -- than or equal to the height member of -- imageExtent
imageOffset.x and (imageExtent.width + -- imageOffset.x) must both be greater than or equal to -- 0 and less than or equal to the image subresource width where -- this refers to the width of the plane of the image involved in -- the copy in the case of a multi-planar format
imageOffset.y and (imageExtent.height + -- imageOffset.y) must both be greater than or equal to -- 0 and less than or equal to the image subresource height -- where this refers to the height of the plane of the image -- involved in the copy in the case of a multi-planar format
If the calling command’s srcImage -- (vkCmdCopyImageToBuffer) or dstImage -- (vkCmdCopyBufferToImage) is of type VK_IMAGE_TYPE_1D, -- then imageOffset.y must be 0 and -- imageExtent.height must be 1.
imageOffset.z and (imageExtent.depth + -- imageOffset.z) must both be greater than or equal to -- 0 and less than or equal to the image subresource depth
If the calling command’s srcImage -- (vkCmdCopyImageToBuffer) or dstImage -- (vkCmdCopyBufferToImage) is of type VK_IMAGE_TYPE_1D -- or VK_IMAGE_TYPE_2D, then imageOffset.z must -- be 0 and imageExtent.depth must be -- 1
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, bufferRowLength must be a multiple of the -- compressed texel block width
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, bufferImageHeight must be a multiple of the -- compressed texel block height
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, all members of imageOffset must be a multiple -- of the corresponding dimensions of the compressed texel block
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, bufferOffset must be a multiple of the -- compressed texel block size in bytes
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, imageExtent.width must be a multiple of the -- compressed texel block width or (imageExtent.width + -- imageOffset.x) must equal the image subresource -- width
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, imageExtent.height must be a multiple of the -- compressed texel block height or (imageExtent.height + -- imageOffset.y) must equal the image subresource -- height
If the calling command’s VkImage parameter is a -- compressed image, or a single-plane, “_422” image -- format, imageExtent.depth must be a multiple of the -- compressed texel block depth or (imageExtent.depth + -- imageOffset.z) must equal the image subresource -- depth
The aspectMask member of imageSubresource -- must specify aspects present in the calling command’s -- VkImage parameter
If the calling command’s VkImage parameter’s format is a -- multi-planar format, then the aspectMask member of -- imageSubresource must be -- VK_IMAGE_ASPECT_PLANE_0_BIT, -- VK_IMAGE_ASPECT_PLANE_1_BIT, or -- VK_IMAGE_ASPECT_PLANE_2_BIT (with -- VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with -- three planes)
The aspectMask member of imageSubresource -- must only have a single bit set
If the calling command’s VkImage parameter is of -- VkImageType VK_IMAGE_TYPE_3D, the -- baseArrayLayer and layerCount members of -- imageSubresource must be 0 and 1, -- respectively
When copying to the depth aspect of an image subresource, the data -- in the source buffer must be in the range [0,1]

-- --

Valid Usage (Implicit)

-- --

imageSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

Description

-- --

Valid Usage

-- --

The aspectMask member of srcSubresource and -- dstSubresource must only contain -- VK_IMAGE_ASPECT_COLOR_BIT

-- --

The layerCount member of srcSubresource and -- dstSubresource must match
If either of the calling command’s srcImage or -- dstImage parameters are of VkImageType -- VK_IMAGE_TYPE_3D, the baseArrayLayer and -- layerCount members of both srcSubresource and -- dstSubresource must be 0 and 1, -- respectively
srcOffset.x and (extent.width + -- srcOffset.x) must both be greater than or equal to -- 0 and less than or equal to the source image subresource -- width
srcOffset.y and (extent.height + -- srcOffset.y) must both be greater than or equal to -- 0 and less than or equal to the source image subresource -- height
If the calling command’s srcImage is of type -- VK_IMAGE_TYPE_1D, then srcOffset.y must be -- 0 and extent.height must be 1.
srcOffset.z and (extent.depth + -- srcOffset.z) must both be greater than or equal to -- 0 and less than or equal to the source image subresource -- depth
If the calling command’s srcImage is of type -- VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then -- srcOffset.z must be 0 and -- extent.depth must be 1.
dstOffset.x and (extent.width + -- dstOffset.x) must both be greater than or equal to -- 0 and less than or equal to the destination image subresource -- width
dstOffset.y and (extent.height + -- dstOffset.y) must both be greater than or equal to -- 0 and less than or equal to the destination image subresource -- height
If the calling command’s dstImage is of type -- VK_IMAGE_TYPE_1D, then dstOffset.y must be -- 0 and extent.height must be 1.
dstOffset.z and (extent.depth + -- dstOffset.z) must both be greater than or equal to -- 0 and less than or equal to the destination image subresource -- depth
If the calling command’s dstImage is of type -- VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D, then -- dstOffset.z must be 0 and -- extent.depth must be 1.

-- --

Valid Usage (Implicit)

-- --

srcSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

dstSubresource must be a valid -- VkImageSubresourceLayers structure

-- --

Description

-- -- renderArea is the render area that is affected by the render -- pass instance. The effects of attachment load, store and multisample -- resolve operations are restricted to the pixels whose x and y -- coordinates fall within the render area on all attachments. The render -- area extends to all layers of framebuffer. The application -- must ensure (using scissor if necessary) that all rendering is -- contained within the render area, otherwise the pixels outside of the -- render area become undefined and shader side effects may occur -- for fragments outside the render area. The render area must be -- contained within the framebuffer dimensions. -- -- When multiview is enabled, the resolve operation at the end of a -- subpass applies to all views in the view mask. -- -- Note -- -- There may be a performance cost for using a render area smaller -- than the framebuffer, unless it matches the render area granularity -- for the render pass. -- --

Valid Usage

-- --

clearValueCount must be greater than the largest -- attachment index in renderPass that specifies a -- loadOp (or stencilLoadOp, if the attachment has a -- depth/stencil format) of VK_ATTACHMENT_LOAD_OP_CLEAR

-- --

If clearValueCount is not 0, -- pClearValues must be a valid pointer to an array of -- clearValueCount valid VkClearValue unions
renderPass must be compatible with the -- renderPass member of the VkFramebufferCreateInfo -- structure specified when creating framebuffer.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO

-- --

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 VkDeviceGroupRenderPassBeginInfo -- or VkRenderPassSampleLocationsBeginInfoEXT
Each sType member in the pNext chain must -- be unique
renderPass must be a valid VkRenderPass -- handle
framebuffer must be a valid VkFramebuffer -- handle
Both of framebuffer, and renderPass must -- have been created, allocated, or retrieved from the same -- VkDevice

-- --

aspectMask must be a valid combination of -- VkImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

Description

-- -- The members of VkDrawIndirectCommand have the same meaning as -- the similarly named parameters of vkCmdDraw. -- --

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 -- {html_spec_relative}#fxvertex-input

-- --

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

-- --

Description

-- -- The members of VkDrawIndexedIndirectCommand have the same -- meaning as the similarly named parameters of vkCmdDrawIndexed. -- --

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 -- {html_spec_relative}#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 -- vkCmdBindIndexBuffer
If the drawIndirectFirstInstance feature is not enabled, -- firstInstance must be 0

-- --

Description

-- -- The members of VkDispatchIndirectCommand have the same -- meaning as the corresponding parameters of vkCmdDispatch. -- --

Valid Usage

-- --

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

-- --

y must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1]
z must be less than or equal to -- VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]

-- --

commandBuffer is the primary command buffer in which the -- generation process takes space.

-- --

pProcessCommandsInfo is a pointer to an instance of the -- VkCmdProcessCommandsInfoNVX structure containing parameters -- affecting the processing of commands.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pProcessCommandsInfo must be a valid pointer to a -- valid VkCmdProcessCommandsInfoNVX structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called inside of a render pass -- instance

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Primary         | Inside          | Graphics        |                 |
--   | Secondary       |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

commandBuffer is the secondary command buffer in which -- the space for device-generated commands is reserved.

-- --

pProcessCommandsInfo is a pointer to an instance of the -- vkCmdReserveSpaceForCommandsNVX structure containing parameters -- affecting the reservation of command buffer space.

-- --

Description

-- --

Valid Usage

-- --

The provided commandBuffer must not have had a -- prior space reservation since its creation or the last reset.

-- --

The state of the commandBuffer must be legal to -- execute all commands within the sequence provided by the -- indirectCommandsLayout member of -- pProcessCommandsInfo.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid -- VkCommandBuffer handle

-- --

pReserveSpaceInfo must be a valid pointer to a -- valid VkCmdReserveSpaceForCommandsInfoNVX structure
commandBuffer must be in the recording -- state
The VkCommandPool that commandBuffer was -- allocated from must support graphics, or compute -- operations
This command must only be called inside of a render pass -- instance
commandBuffer must be a secondary -- VkCommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Host access to the VkCommandPool that -- commandBuffer was allocated from must be externally -- synchronized

-- --

Command Properties

-- --

--   +-----------------+-----------------+-----------------+-----------------+
--   | <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
--   | erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
--   |  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
--   |                 |                 |                 | ine Type>       |
--   +=================+=================+=================+=================+
--   | Secondary       | Inside          | Graphics        |                 |
--   |                 |                 | Compute         |                 |
--   +-----------------+-----------------+-----------------+-----------------+
--

-- --

Parameters

-- --

device is the logical device that creates the indirect -- command layout.

-- --

pCreateInfo is a pointer to an instance of the -- VkIndirectCommandsLayoutCreateInfoNVX structure containing -- parameters affecting creation of the indirect command layout.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pIndirectCommandsLayout points to a -- VkIndirectCommandsLayoutNVX handle in which the resulting -- indirect command layout is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkIndirectCommandsLayoutCreateInfoNVX structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pIndirectCommandsLayout must be a valid pointer to -- a VkIndirectCommandsLayoutNVX handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- layout.

-- --

indirectCommandsLayout is the table to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to -- indirectCommandsLayout must have completed -- execution

-- --

If VkAllocationCallbacks were provided when -- objectTable was created, a compatible set of callbacks -- must be provided here
If no VkAllocationCallbacks were provided when -- objectTable was created, pAllocator must be -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

indirectCommandsLayout must be a valid -- VkIndirectCommandsLayoutNVX handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
indirectCommandsLayout must have been created, -- allocated, or retrieved from device

-- --

Parameters

-- --

device is the logical device that creates the object -- table.

-- --

pCreateInfo is a pointer to an instance of the -- VkObjectTableCreateInfoNVX structure containing parameters -- affecting creation of the table.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pObjectTable points to a VkObjectTableNVX handle -- in which the resulting object table is returned.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- VkObjectTableCreateInfoNVX structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
pObjectTable must be a valid pointer to a -- VkObjectTableNVX handle

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that destroys the -- table.

-- --

objectTable is the table to destroy.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Description

-- --

Valid Usage

-- --

All submitted commands that refer to objectTable -- must have completed execution.

-- --

If VkAllocationCallbacks were provided when -- objectTable was created, a compatible set of callbacks -- must be provided here.
If no VkAllocationCallbacks were provided when -- objectTable was created, pAllocator must be -- NULL.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

objectTable must be a valid -- VkObjectTableNVX handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid -- VkAllocationCallbacks structure
objectTable must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to objectTable must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that creates the object -- table.

-- --

objectTable is the table for which the resources are -- registered.
objectCount is the number of resources to register.
ppObjectTableEntries provides an array for detailed -- binding informations, each array element is a pointer to a struct of -- type VkObjectTablePipelineEntryNVX, -- VkObjectTableDescriptorSetEntryNVX, -- VkObjectTableVertexBufferEntryNVX, -- VkObjectTableIndexBufferEntryNVX or -- VkObjectTablePushConstantEntryNVX (see below for -- details).
pObjectIndices are the indices at which each resource is -- registered.

-- --

Description

-- --

Valid Usage

-- --

The contents of pObjectTableEntry must yield -- plausible bindings supported by the device.

-- --

At any pObjectIndices there must not be a -- registered resource already.
Any value inside pObjectIndices must be below the -- appropriate -- VkObjectTableCreateInfoNVX::pObjectEntryCounts -- limits provided at objectTable creation time.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

objectTable must be a valid -- VkObjectTableNVX handle
ppObjectTableEntries must be a valid pointer to an -- array of objectCount valid VkObjectTableEntryNVX -- structures
pObjectIndices must be a valid pointer to an array -- of objectCount uint32_t values
objectCount must be greater than 0
objectTable must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to objectTable must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

device is the logical device that creates the object -- table.

-- --

objectTable is the table from which the resources are -- unregistered.
objectCount is the number of resources being removed from -- the object table.
pObjectEntryType provides an array of -- VkObjectEntryTypeNVX for the resources being removed.
pObjectIndices provides the array of object indices to be -- removed.

-- --

Description

-- --

Valid Usage

-- --

At any pObjectIndices there must be a registered -- resource already.

-- --

The pObjectEntryTypes of the resource at -- pObjectIndices must match.
All operations on the device using the registered resource -- must have been completed.

-- --

Valid Usage (Implicit)

-- --

device must be a valid VkDevice -- handle

-- --

objectTable must be a valid -- VkObjectTableNVX handle
pObjectEntryTypes must be a valid pointer to an -- array of objectCount valid VkObjectEntryTypeNVX -- values
pObjectIndices must be a valid pointer to an array -- of objectCount uint32_t values
objectCount must be greater than 0
objectTable must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to objectTable must be externally -- synchronized

-- --

Return Codes

-- --

Success - VK_SUCCESS

-- --

Failure - -- VK_ERROR_OUT_OF_HOST_MEMORY
- ```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

-- --

Parameters

-- --

physicalDevice is the handle to the physical device whose -- properties will be queried.

-- --

pFeatures points to an instance of the -- VkDeviceGeneratedCommandsFeaturesNVX structure, that will be -- filled with returned information.
pLimits points to an instance of the -- VkDeviceGeneratedCommandsLimitsNVX structure, that will be -- filled with returned information.

-- --

Description

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- VkPhysicalDevice handle

-- --

pFeatures must be a valid pointer to a -- VkDeviceGeneratedCommandsFeaturesNVX structure
pLimits must be a valid pointer to a -- VkDeviceGeneratedCommandsLimitsNVX structure

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GENERATED_COMMANDS_FEATURES_NVX

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_DEVICE_GENERATED_COMMANDS_LIMITS_NVX

-- --

pNext must be NULL

-- --

Description

-- --

Valid Usage

-- --

The buffer’s usage flag must have the -- VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set.

-- --

The offset must be aligned to -- VkDeviceGeneratedCommandsLimitsNVX::minCommandsTokenBufferOffsetAlignment.

-- --

Valid Usage (Implicit)

-- --

tokenType must be a valid -- VkIndirectCommandsTokenTypeNVX value

-- --

buffer must be a valid VkBuffer -- handle

-- --

Description

-- --

Valid Usage

-- --

bindingUnit must stay within device supported -- limits for the appropriate commands.

-- --

dynamicCount must stay within device supported -- limits for the appropriate commands.
divisor must be greater than 0 and a -- power of two.

-- --

Valid Usage (Implicit)

-- --

tokenType must be a valid -- VkIndirectCommandsTokenTypeNVX value

-- --

Description

-- -- The following code illustrates some of the key flags: -- --

--   void cmdProcessAllSequences(cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequencesCount, indexbuffer, indexbufferoffset)
--   {
--     for (s = 0; s < sequencesCount; s++)
--     {
--       sequence = s;
--   
--       if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_NVX) {
--         sequence = incoherent_implementation_dependent_permutation[ sequence ];
--       }
--       if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_INDEXED_SEQUENCES_BIT_NVX) {
--         sequence = indexbuffer.load_uint32( sequence * sizeof(uint32_t) + indexbufferoffset);
--       }
--   
--       cmdProcessSequence( cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequence );
--     }
--   }
--

-- --

Valid Usage

-- --

tokenCount must be greater than 0 and -- below -- VkDeviceGeneratedCommandsLimitsNVX::maxIndirectCommandsLayoutTokenCount

-- --

If the -- VkDeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport -- feature is not enabled, then pipelineBindPoint must -- not be VK_PIPELINE_BIND_POINT_COMPUTE
If pTokens contains an entry of -- VK_INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NVX it must -- be the first element of the array and there must be only a -- single element of such token type.
All state binding tokens in pTokens must occur -- prior work provoking tokens -- (VK_INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NVX, -- VK_INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NVX, -- VK_INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NVX).
The content of pTokens must include one single -- work provoking token that is compatible with the -- pipelineBindPoint.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVX

-- --

pNext must be NULL
pipelineBindPoint must be a valid -- VkPipelineBindPoint value
flags must be a valid combination of -- VkIndirectCommandsLayoutUsageFlagBitsNVX values
flags must not be 0
pTokens must be a valid pointer to an array of -- tokenCount valid VkIndirectCommandsLayoutTokenNVX -- structures
tokenCount must be greater than 0

-- --

Description

-- --

Valid Usage

-- --

The provided objectTable must include all objects -- referenced by the generation process.

-- --

indirectCommandsTokenCount must match the -- indirectCommandsLayout’s tokenCount.
The tokenType member of each entry in the -- pIndirectCommandsTokens array must match the values -- used at creation time of indirectCommandsLayout
If targetCommandBuffer is provided, it must have -- reserved command space.
If targetCommandBuffer is provided, the -- objectTable must match the reservation’s objectTable -- and must have had all referenced objects registered at -- reservation time.
If targetCommandBuffer is provided, the -- indirectCommandsLayout must match the reservation’s -- indirectCommandsLayout.
If targetCommandBuffer is provided, the -- maxSequencesCount must not exceed the reservation’s -- maxSequencesCount.
If sequencesCountBuffer is used, its usage flag -- must have VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit -- set.
If sequencesCountBuffer is used, -- sequencesCountOffset must be aligned to -- VkDeviceGeneratedCommandsLimitsNVX::minSequenceCountBufferOffsetAlignment.
If sequencesIndexBuffer is used, its usage flag -- must have VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit -- set.
If sequencesIndexBuffer is used, -- sequencesIndexOffset must be aligned to -- VkDeviceGeneratedCommandsLimitsNVX::minSequenceIndexBufferOffsetAlignment.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_CMD_PROCESS_COMMANDS_INFO_NVX

-- --

pNext must be NULL
objectTable must be a valid -- VkObjectTableNVX handle
indirectCommandsLayout must be a valid -- VkIndirectCommandsLayoutNVX handle
pIndirectCommandsTokens must be a valid pointer to -- an array of indirectCommandsTokenCount valid -- VkIndirectCommandsTokenNVX structures
If targetCommandBuffer is not NULL, -- targetCommandBuffer must be a valid -- VkCommandBuffer handle
If sequencesCountBuffer is not VK_NULL_HANDLE, -- sequencesCountBuffer must be a valid VkBuffer -- handle
If sequencesIndexBuffer is not VK_NULL_HANDLE, -- sequencesIndexBuffer must be a valid VkBuffer -- handle
indirectCommandsTokenCount must be greater than -- 0
Each of indirectCommandsLayout, objectTable, -- sequencesCountBuffer, sequencesIndexBuffer, and -- targetCommandBuffer that are valid handles must have -- been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to objectTable must be externally -- synchronized

-- --

Host access to targetCommandBuffer must be -- externally synchronized

-- --

Description

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_CMD_RESERVE_SPACE_FOR_COMMANDS_INFO_NVX

-- --

pNext must be NULL
objectTable must be a valid -- VkObjectTableNVX handle
indirectCommandsLayout must be a valid -- VkIndirectCommandsLayoutNVX handle
Both of indirectCommandsLayout, and objectTable -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Host Synchronization

-- --

Host access to objectTable must be externally -- synchronized

-- --

Description

-- --

Valid Usage

-- --

If the -- VkDeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport -- feature is not enabled, pObjectEntryUsageFlags must -- not contain VK_OBJECT_ENTRY_USAGE_COMPUTE_BIT_NVX

-- --

Any value within pObjectEntryCounts must not -- exceed -- VkDeviceGeneratedCommandsLimitsNVX::maxObjectEntryCounts
maxUniformBuffersPerDescriptor must be within the -- limits supported by the device.
maxStorageBuffersPerDescriptor must be within the -- limits supported by the device.
maxStorageImagesPerDescriptor must be within the -- limits supported by the device.
maxSampledImagesPerDescriptor must be within the -- limits supported by the device.

-- --

Valid Usage (Implicit)

-- --

sType must be -- VK_STRUCTURE_TYPE_OBJECT_TABLE_CREATE_INFO_NVX

-- --

pNext must be NULL
pObjectEntryTypes must be a valid pointer to an -- array of objectCount valid VkObjectEntryTypeNVX -- values
pObjectEntryCounts must be a valid pointer to an -- array of objectCount uint32_t values
pObjectEntryUsageFlags must be a valid pointer to -- an array of objectCount valid combinations of -- VkObjectEntryUsageFlagBitsNVX values
Each element of pObjectEntryUsageFlags must not be -- 0
objectCount must be greater than 0

-- --

Description

-- --

Valid Usage

-- --

If the -- VkDeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport -- feature is not enabled, flags must not contain -- VK_OBJECT_ENTRY_USAGE_COMPUTE_BIT_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0

-- --

Description

-- --

Valid Usage

-- --

type must be -- VK_OBJECT_ENTRY_TYPE_PIPELINE_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0
pipeline must be a valid VkPipeline -- handle

-- --

Description

-- --

Valid Usage

-- --

type must be -- VK_OBJECT_ENTRY_TYPE_DESCRIPTOR_SET_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0
pipelineLayout must be a valid -- VkPipelineLayout handle
descriptorSet must be a valid -- VkDescriptorSet handle
Both of descriptorSet, and pipelineLayout -- must have been created, allocated, or retrieved from the same -- VkDevice

-- --

Description

-- --

Valid Usage

-- --

type must be -- VK_OBJECT_ENTRY_TYPE_VERTEX_BUFFER_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0
buffer must be a valid VkBuffer -- handle

-- --

Description

-- --

Valid Usage

-- --

type must be -- VK_OBJECT_ENTRY_TYPE_INDEX_BUFFER_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0
buffer must be a valid VkBuffer -- handle
indexType must be a valid VkIndexType -- value

-- --

Description

-- --

Valid Usage

-- --

type must be -- VK_OBJECT_ENTRY_TYPE_PUSH_CONSTANT_NVX

-- --

Valid Usage (Implicit)

-- --

type must be a valid VkObjectEntryTypeNVX -- value

-- --

flags must be a valid combination of -- VkObjectEntryUsageFlagBitsNVX values
flags must not be 0
pipelineLayout must be a valid -- VkPipelineLayout handle
stageFlags must be a valid combination of -- VkShaderStageFlagBits values
stageFlags must not be 0

-- --

Description

-- -- VkIndirectCommandsLayoutUsageFlagsNVX is a bitmask type for -- setting a mask of zero or more -- VkIndirectCommandsLayoutUsageFlagBitsNVX. -- --

Description

-- -- VkObjectEntryUsageFlagsNVX is a bitmask type for setting a -- mask of zero or more VkObjectEntryUsageFlagBitsNVX. -- --

Description

See Also

See Also

Description

See Also

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

See Also

Description

Valid Usage (Implicit)

See Also

Description

Valid Usage (Implicit)

See Also

Members

Description

Valid Usage

Valid Usage (Implicit)

See Also

See Also

Description

Valid Usage (Implicit)

See Also

Members

Description

Valid Usage (Implicit)

See Also

Description

See Also

See Also

Description

See Also

Members

Description

Valid Usage (Implicit)

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Description

See Also

Description

Valid Usage (Implicit)

See Also

See Also

Description

Valid Usage (Implicit)

See Also

Description

Valid Usage

See Also

Description

Valid Usage (Implicit)

See Also

Members

Description

Valid Usage (Implicit)

See Also

Description

Valid Usage

Valid Usage (Implicit)