-- --

SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_IDENTITY specifies no -- model conversion but the inputs are range expanded as for Y′CBCR.
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.
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.
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 -- SamplerYcbcrConversionCreateInfo::components). -- -- Note -- -- For example, an “YUVA” 32-bit format comprising four 8-bit channels -- can be implemented as FORMAT_R8G8B8A8_UNORM with a component -- mapping: -- --

components.a = COMPONENT_SWIZZLE_IDENTITY
components.r = COMPONENT_SWIZZLE_B
components.g = COMPONENT_SWIZZLE_R
components.b = COMPONENT_SWIZZLE_G

-- --

Description

-- -- Note -- -- Khronos vendor IDs may be allocated by vendors at any time. Only the -- latest canonical versions of this Specification, of the corresponding -- vk.xml API Registry, and of the corresponding -- vulkan_core.h header file must contain all reserved -- Khronos vendor IDs. -- -- Only Khronos vendor IDs are given symbolic names at present. PCI -- vendor IDs returned by the implementation can be looked up in the -- PCI-SIG database. -- --

Description

-- --

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

-- --

SYSTEM_ALLOCATION_SCOPE_OBJECT specifies that the -- allocation is scoped to the lifetime of the Vulkan object that is -- being created or used.
SYSTEM_ALLOCATION_SCOPE_CACHE specifies that the allocation -- is scoped to the lifetime of a PipelineCache or -- ValidationCacheEXT object.
SYSTEM_ALLOCATION_SCOPE_DEVICE specifies that the -- allocation is scoped to the lifetime of the Vulkan device.
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 SYSTEM_ALLOCATION_SCOPE_OBJECT or -- 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 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 Device has -- an allocator it will be used, else if the parent Instance has -- an allocator it will be used. Else,
If an allocation is associated with a ValidationCacheEXT or -- PipelineCache object, the allocator will use the -- 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 Device or Instance, the allocator -- will use an allocation scope of 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 -- 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 SYSTEM_ALLOCATION_SCOPE_INSTANCE.
Otherwise an implementation will allocate memory through an -- alternative mechanism that is unspecified.

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY

-- --

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

-- --

pOriginal must be either NULL or a -- pointer previously returned by pfnReallocation or -- pfnAllocation of a compatible 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 SystemAllocationScope 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. -- --

Parameters

-- --

pUserData is the value specified for -- AllocationCallbacks::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 SystemAllocationScope 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 Instance objects are going to operate correctly (even -- destroyInstance), 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 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 ERROR_OUT_OF_HOST_MEMORY as -- a result of this failed allocation. -- --

Parameters

-- --

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

-- --

pMemory is the allocation to be freed.

-- --

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 -- ImageCreateInfo, as described in the compatibility -- table

-- --

If ImageCreateInfo::flags does not contain -- IMAGE_CREATE_MUTABLE_FORMAT_BIT, viewFormatCount -- must be 0 or 1
If viewFormatCount is not 0, -- ImageCreateInfo::format must be in -- pViewFormats

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO

-- --

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

-- --

Description

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

Description

-- --

DESCRIPTOR_TYPE_SAMPLER specifies a sampler -- descriptor.

-- --

DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER specifies a -- combined image sampler descriptor.
DESCRIPTOR_TYPE_SAMPLED_IMAGE specifies a sampled image -- descriptor.
DESCRIPTOR_TYPE_STORAGE_IMAGE specifies a storage image -- descriptor.
DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER specifies a uniform -- texel buffer descriptor.
DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER specifies a storage -- texel buffer descriptor.
DESCRIPTOR_TYPE_UNIFORM_BUFFER specifies a uniform -- buffer descriptor.
DESCRIPTOR_TYPE_STORAGE_BUFFER specifies a storage -- buffer descriptor.
DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC specifies a -- dynamic uniform buffer descriptor.
DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC specifies a -- dynamic storage buffer descriptor.
DESCRIPTOR_TYPE_INPUT_ATTACHMENT specifies an input -- attachment descriptor.
DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT specifies an -- inline uniform block.

-- -- When a descriptor set is updated via elements of -- WriteDescriptorSet, 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 DESCRIPTOR_TYPE_SAMPLER, only the sampler -- member of each element of -- WriteDescriptorSet::pImageInfo is accessed.
For DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT, only the imageView -- and imageLayout members of each element of -- WriteDescriptorSet::pImageInfo are accessed.
For DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, all members of -- each element of WriteDescriptorSet::pImageInfo are -- accessed.
For DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- DESCRIPTOR_TYPE_STORAGE_BUFFER, -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, all members of each -- element of WriteDescriptorSet::pBufferInfo are -- accessed.
For DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of -- WriteDescriptorSet::pTexelBufferView is accessed.

-- -- If coverageModulationTableEnable is TRUE, the value R -- is computed using a programmable lookup table. The lookup table has N -- / M elements, and the element of the table is selected by: -- --

R = pCoverageModulationTable[popcount(associated coverage -- bits)-1]

-- -- Note that the table does not have an entry for popcount(associated -- coverage bits) = 0, because such samples would have been killed. -- -- The values of pCoverageModulationTable may be rounded -- to an implementation-dependent precision, which is at least as fine as -- 1 / N, and clamped to [0,1]. -- -- For each color attachment with a floating point or normalized color -- format, each fragment output color value is replicated to M values -- which can each be modulated (multiplied) by that color sample’s -- associated value of R. Which components are modulated is controlled by -- coverageModulationMode. -- -- If this structure is not present, it is as if -- coverageModulationMode is -- COVERAGE_MODULATION_MODE_NONE_NV. -- -- If the coverage reduction mode is -- COVERAGE_REDUCTION_MODE_TRUNCATE_NV, each color sample is -- associated with only a single coverage sample. In this case, it is as -- if coverageModulationMode is -- COVERAGE_MODULATION_MODE_NONE_NV. -- --

Valid Usage

-- --

If coverageModulationTableEnable is TRUE, -- coverageModulationTableCount must be equal to the -- number of rasterization samples divided by the number of color samples -- in the subpass

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_COVERAGE_MODULATION_STATE_CREATE_INFO_NV

-- --

flags must be 0
coverageModulationMode must be a valid -- CoverageModulationModeNV value

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NV

-- --

flags must be 0

-- --

robustImageAccess2 indicates whether image accesses are -- tightly bounds-checked against the dimensions of the image view. Out -- of bounds image loads will return zero values, with (0,0,1) values -- inserted for missing G, B, or A components based on the -- format.
nullDescriptor indicates whether descriptors can -- be written with a NULL_HANDLE resource or view, which are -- considered valid to access and act as if the descriptor were bound to -- nothing.

-- -- If the PhysicalDeviceRobustness2FeaturesEXT structure is -- included in the pNext chain of -- PhysicalDeviceFeatures2, it is filled with values indicating -- whether each feature is supported. -- --

Valid Usage

-- --

If robustBufferAccess2 is enabled then -- robustBufferAccess must also be enabled

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_ROBUSTNESS_2_FEATURES_EXT

-- --

When chained to GraphicsPipelineCreateInfo, -- PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount -- must equal -- GraphicsPipelineCreateInfo::stageCount

-- --

When chained to ComputePipelineCreateInfo, -- PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount -- must equal 1
When chained to RayTracingPipelineCreateInfoKHR, -- PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount -- must equal -- RayTracingPipelineCreateInfoKHR::stageCount
When chained to RayTracingPipelineCreateInfoNV, -- PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount -- must equal -- RayTracingPipelineCreateInfoNV::stageCount

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_CREATION_FEEDBACK_CREATE_INFO_EXT

-- --

pPipelineCreationFeedback must be a valid pointer -- to a PipelineCreationFeedbackEXT structure
pPipelineStageCreationFeedbacks must be a valid -- pointer to an array of pipelineStageCreationFeedbackCount -- PipelineCreationFeedbackEXT structures
pipelineStageCreationFeedbackCount must be greater -- than 0

-- --

If the non-premultiplied source color property is not -- supported, srcPremultiplied must be TRUE

-- --

If the non-premultiplied destination color property is not -- supported, dstPremultiplied must be TRUE
If the correlated overlap property is not supported, -- blendOverlap must be -- BLEND_OVERLAP_UNCORRELATED_EXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_ADVANCED_STATE_CREATE_INFO_EXT

-- --

blendOverlap must be a valid -- BlendOverlapEXT value

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

Description

-- --

PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT specifies that the -- created pipeline will not be optimized. Using this flag may -- reduce the time taken to create the pipeline.

-- --

PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT specifies that the -- pipeline to be created is allowed to be the parent of a pipeline that -- will be created in a subsequent pipeline creation call.
PIPELINE_CREATE_DERIVATIVE_BIT specifies that the pipeline -- to be created will be a child of a previously created parent -- pipeline.
PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT specifies -- that any shader input variables decorated as ViewIndex will -- be assigned values as if they were decorated as -- DeviceIndex.
PIPELINE_CREATE_DISPATCH_BASE specifies that a compute -- pipeline can be used with cmdDispatchBase with a -- non-zero base workgroup.
PIPELINE_CREATE_DEFER_COMPILE_BIT_NV specifies that a -- pipeline is created with all shaders in the deferred state. Before -- using the pipeline the application must call -- compileDeferredNV exactly once on each shader in the pipeline -- before using the pipeline.
PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR specifies that -- the shader compiler should capture statistics for the executables -- produced by the compile process which can later be retrieved by -- calling getPipelineExecutableStatisticsKHR. Enabling this flag -- must not affect the final compiled pipeline but may -- disable pipeline caching or otherwise affect pipeline creation -- time.
PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR -- specifies that the shader compiler should capture the internal -- representations of executables produced by the compile process which -- can later be retrieved by calling -- getPipelineExecutableInternalRepresentationsKHR. Enabling this -- flag must not affect the final compiled pipeline but may -- disable pipeline caching or otherwise affect pipeline creation -- time.
PIPELINE_CREATE_LIBRARY_BIT_KHR specifies that the pipeline -- cannot be used directly, and instead defines a pipeline -- library that can be combined with other pipelines using the -- PipelineLibraryCreateInfoKHR structure. This is available in -- raytracing pipelines.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR -- specifies that an any hit shader will always be present when an any -- hit shader would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR -- specifies that a closest hit shader will always be present when a -- closest hit shader would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR -- specifies that a miss shader will always be present when a miss shader -- would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR -- specifies that an intersection shader will always be present when an -- intersection shader would be executed.
PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR -- specifies that triangle primitives will be skipped during traversal -- using OpTraceKHR.
PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR specifies -- that AABB primitives will be skipped during traversal using -- OpTraceKHR.
PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV specifies that the -- pipeline can be used in combination with -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#device-generated-commands.
PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT -- specifies that pipeline creation will fail if a compile is required -- for creation of a valid Pipeline object; -- PIPELINE_COMPILE_REQUIRED_EXT will be returned by pipeline -- creation, and the Pipeline will be set to -- NULL_HANDLE.
When creating multiple pipelines, -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT specifies that -- control will be returned to the application on failure of the -- corresponding pipeline rather than continuing to create additional -- pipelines.

-- --

sType must be -- STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO

-- --

stencilUsage must be a valid combination of -- ImageUsageFlagBits values
stencilUsage must not be 0

-- --

aspectMask must be a valid combination of -- ImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

Description

-- -- The following bits may be set in linearTilingFeatures, -- optimalTilingFeatures, and -- DrmFormatModifierPropertiesEXT::drmFormatModifierTilingFeatures, -- specifying that the features are supported by images or -- image views or sampler Y′CBCR conversion objects created -- with the queried -- getPhysicalDeviceFormatProperties::format: -- --

FORMAT_FEATURE_SAMPLED_IMAGE_BIT specifies that an image -- view can be sampled from.
FORMAT_FEATURE_STORAGE_IMAGE_BIT specifies that an image -- view can be used as a storage images.
FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT specifies that an -- image view can be used as storage image that supports atomic -- operations.
FORMAT_FEATURE_COLOR_ATTACHMENT_BIT specifies that an image -- view can be used as a framebuffer color attachment and as an -- input attachment.
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.
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.
FORMAT_FEATURE_BLIT_SRC_BIT specifies that an image -- can be used as srcImage for the cmdBlitImage -- command.
FORMAT_FEATURE_BLIT_DST_BIT specifies that an image -- can be used as dstImage for the cmdBlitImage -- command.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT specifies -- that if 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 FILTER_LINEAR, -- or mipmapMode set to SAMPLER_MIPMAP_MODE_LINEAR. If -- FORMAT_FEATURE_BLIT_SRC_BIT is also set, an image can be used -- as the srcImage to cmdBlitImage with a filter -- of FILTER_LINEAR. This bit must only be exposed for -- formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT -- or 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.
FORMAT_FEATURE_TRANSFER_SRC_BIT specifies that an image -- can be used as a source image for copy commands.
FORMAT_FEATURE_TRANSFER_DST_BIT specifies that an image -- can be used as a destination image for copy commands and -- clear commands.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT specifies -- Image can be used as a sampled image with a min or max -- SamplerReductionMode. This bit must only be exposed for -- formats that also support the -- FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT specifies -- that Image can be used with a sampler that has either of -- magFilter or minFilter set to -- FILTER_CUBIC_EXT, or be the source image for a blit with -- filter set to FILTER_CUBIC_EXT. This bit must -- only be exposed for formats that also support the -- 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.
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 SamplerYcbcrConversionCreateInfo -- xChromaOffset and/or yChromaOffset of -- CHROMA_LOCATION_MIDPOINT. Otherwise both xChromaOffset -- and yChromaOffset must be -- 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 -- FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT.
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 SamplerYcbcrConversionCreateInfo -- xChromaOffset and/or yChromaOffset of -- CHROMA_LOCATION_COSITED_EVEN. Otherwise both -- xChromaOffset and yChromaOffset must be -- CHROMA_LOCATION_MIDPOINT. If neither -- FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT nor -- FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT is set, the -- application must not define a sampler Y′CBCR conversion -- using this format as a source.
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.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT -- specifies that the format can have different chroma, min, and mag -- filters.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- specifies that reconstruction is explicit, as described in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#textures-chroma-reconstruction. -- If this bit is not present, reconstruction is implicit by -- default.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT -- specifies that reconstruction can be forcibly made explicit by -- setting -- SamplerYcbcrConversionCreateInfo::forceExplicitReconstruction -- to TRUE. If the format being queried supports -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- it must also support -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT.
FORMAT_FEATURE_DISJOINT_BIT specifies that a multi-planar -- image can have the IMAGE_CREATE_DISJOINT_BIT set during -- image creation. An implementation must not set -- FORMAT_FEATURE_DISJOINT_BIT for single-plane -- formats.
FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT specifies that -- an image view can be used as a fragment density map -- attachment.

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

FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT specifies that the -- format can be used to create a buffer view that can be -- bound to a DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER -- descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT specifies that the -- format can be used to create a buffer view that can be -- bound to a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER -- descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT specifies -- that atomic operations are supported on -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER with this format.
FORMAT_FEATURE_VERTEX_BUFFER_BIT specifies that the format -- can be used as a vertex attribute format -- (VertexInputAttributeDescription::format).

-- --

If bindingCount is not zero, bindingCount -- must equal -- DescriptorSetLayoutCreateInfo::bindingCount

-- --

If DescriptorSetLayoutCreateInfo::flags includes -- DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR, then all -- elements of pBindingFlags must not include -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT, -- DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT, or -- DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT
If an element of pBindingFlags includes -- DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, then all -- other elements of -- DescriptorSetLayoutCreateInfo::pBindings must -- have a smaller value of binding
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUniformBufferUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_UNIFORM_BUFFER must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingSampledImageUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_SAMPLER, -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, or -- DESCRIPTOR_TYPE_SAMPLED_IMAGE must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageImageUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_STORAGE_IMAGE must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageBufferUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_STORAGE_BUFFER must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUniformTexelBufferUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingStorageTexelBufferUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceInlineUniformBlockFeaturesEXT::descriptorBindingInlineUniformBlockUpdateAfterBind -- is not enabled, all bindings with descriptor type -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
All bindings with descriptor type -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT, -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC must not use -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingUpdateUnusedWhilePending -- is not enabled, all elements of pBindingFlags must not -- include DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingPartiallyBound -- is not enabled, all elements of pBindingFlags must not -- include DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT
If -- PhysicalDeviceDescriptorIndexingFeatures::descriptorBindingVariableDescriptorCount -- is not enabled, all elements of pBindingFlags must not -- include DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT
If an element of pBindingFlags includes -- DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT, that -- element’s descriptorType must not be -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO

-- --

If bindingCount is not 0, and -- pBindingFlags is not NULL, pBindingFlags -- must be a valid pointer to an array of bindingCount -- valid combinations of DescriptorBindingFlagBits values

-- --

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 the variable count descriptor -- binding in the corresponding descriptor set layout has a descriptor -- type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then -- pDescriptorCounts[i] specifies the binding’s capacity in -- bytes. If DescriptorSetAllocateInfo::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 -- DescriptorSetAllocateInfo::descriptorSetCount

-- --

If DescriptorSetAllocateInfo::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 -- STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_ALLOCATE_INFO

-- --

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 -- PhysicalDeviceDescriptorIndexingFeatures::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)

-- --

Description

Members

-- -- The members of the PhysicalDeviceMultiviewFeatures 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 PhysicalDeviceMultiviewFeatures structure is included in -- the pNext chain of PhysicalDeviceFeatures2, it is -- filled with values indicating whether each feature is supported. -- PhysicalDeviceMultiviewFeatures can also be included in -- the pNext chain of DeviceCreateInfo 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 -- STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES

-- --

Description

Members

-- -- Note -- -- A ExternalMemoryImageCreateInfo structure must be included in -- the creation parameters for an image that will be bound to memory that -- is either exported or imported. -- --

Valid Usage (Implicit)

-- --

Members

-- -- Note -- -- A ExternalMemoryBufferCreateInfo structure must be included in -- the creation parameters for a buffer that will be bound to memory that -- is either exported or imported. -- --

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

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

-- --

imageView is an image view handle specifying the shading -- rate image. imageView may be set to -- NULL_HANDLE, which is equivalent to specifying a view of an -- image filled with zero values.
imageLayout is the layout that the image subresources -- accessible from imageView will be in when the shading rate -- image is accessed.

-- --

Valid Usage

-- --

The shading rate image feature must be enabled

-- --

If imageView is not NULL_HANDLE, it must be -- a valid ImageView handle of type IMAGE_VIEW_TYPE_2D or -- IMAGE_VIEW_TYPE_2D_ARRAY
If imageView is not NULL_HANDLE, it must -- have a format of FORMAT_R8_UINT
If imageView is not NULL_HANDLE, it must -- have been created with a usage value including -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
If imageView is not NULL_HANDLE, -- imageLayout must match the actual ImageLayout -- of each subresource accessible from imageView at the time the -- subresource is accessed
If imageView is not NULL_HANDLE, -- imageLayout must be -- IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV or -- IMAGE_LAYOUT_GENERAL

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

If imageView is not NULL_HANDLE, -- imageView must be a valid ImageView handle
imageLayout must be a valid ImageLayout -- value
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
Both of commandBuffer, and imageView that are -- valid handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

firstViewport is the index of the first viewport whose -- shading rate palette is updated by the command.
viewportCount is the number of viewports whose shading -- rate palettes are updated by the command.
pShadingRatePalettes is a pointer to an array of -- ShadingRatePaletteNV structures defining the palette for each -- viewport.

-- --

Valid Usage

-- --

The shading rate image feature must be enabled

-- --

firstViewport must be less than -- PhysicalDeviceLimits::maxViewports
The sum of firstViewport and viewportCount -- must be between 1 and -- PhysicalDeviceLimits::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 CommandBuffer -- handle

-- --

pShadingRatePalettes must be a valid pointer to an -- array of viewportCount valid ShadingRatePaletteNV -- structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

sampleOrderType specifies the mechanism used to order -- coverage samples in fragments larger than one pixel.
customSampleOrderCount specifies the number of custom -- sample orderings to use when ordering coverage samples.
pCustomSampleOrders is a pointer to an array of -- CoarseSampleOrderCustomNV structures, each of which specifies -- the coverage sample order for a single combination of fragment area -- and coverage sample count.

-- --

Description

-- -- If sampleOrderType is -- COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order -- used for any combination of fragment area and coverage sample count -- not enumerated in pCustomSampleOrders will be identical to -- that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV. -- --

Valid Usage

-- --

If sampleOrderType is not -- COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, -- customSamplerOrderCount must be 0

-- --

The array pCustomSampleOrders must not contain two -- structures with matching values for both the shadingRate and -- sampleCount members

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

sampleOrderType must be a valid -- CoarseSampleOrderTypeNV value
If customSampleOrderCount is not 0, -- pCustomSampleOrders must be a valid pointer to an -- array of customSampleOrderCount valid -- CoarseSampleOrderCustomNV structures
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV

-- --

If viewportCount is not 0, and -- pShadingRatePalettes is not NULL, -- pShadingRatePalettes must be a valid pointer to an -- array of viewportCount valid ShadingRatePaletteNV -- structures

-- --

sampleCount must correspond to a sample count -- enumerated in SampleCountFlags whose corresponding bit is set -- in -- PhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts
sampleLocationCount must be equal to the product -- of sampleCount, the fragment width for shadingRate, -- and the fragment height for shadingRate
sampleLocationCount must be less than or equal to -- the value of -- PhysicalDeviceShadingRateImagePropertiesNV::shadingRateMaxCoarseSamples
The array pSampleLocations must contain exactly -- one entry for every combination of valid values for pixelX, -- pixelY, and sample in the structure -- CoarseSampleOrderCustomNV

-- --

Valid Usage (Implicit)

-- --

shadingRate must be a valid -- ShadingRatePaletteEntryNV value

-- --

pSampleLocations must be a valid pointer to an -- array of sampleLocationCount CoarseSampleLocationNV -- structures
sampleLocationCount must be greater than -- 0

-- --

Description

-- -- If this structure is not present, sampleOrderType is -- considered to be COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV. -- -- If sampleOrderType is -- COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order -- used for any combination of fragment area and coverage sample count -- not enumerated in pCustomSampleOrders will be identical to -- that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV. -- -- If the pipeline was created with -- DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV, the contents of -- this structure (if present) are ignored, and the coverage sample order -- is instead specified by cmdSetCoarseSampleOrderNV. -- --

Valid Usage

-- --

If sampleOrderType is not -- COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, -- customSamplerOrderCount must be 0

-- --

The array pCustomSampleOrders must not contain two -- structures with matching values for both the shadingRate and -- sampleCount members

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV

-- --

sampleOrderType must be a valid -- CoarseSampleOrderTypeNV value
If customSampleOrderCount is not 0, -- pCustomSampleOrders must be a valid pointer to an -- array of customSampleOrderCount valid -- CoarseSampleOrderCustomNV structures

-- --

Description

-- -- The following table indicates the width and height (in pixels) of each -- fragment generated using the indicated shading rate, as well as the -- maximum number of fragment shader invocations launched for each -- fragment. When processing regions of a primitive that have a shading -- rate of SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV, no -- fragments will be generated in that region. -- -- TODO: table -- --

Parameters

-- --

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

-- --

taskCount is the number of local workgroups to dispatch -- in the X dimension. Y and Z dimension are implicitly set to one.
firstTask is the X component of the first workgroup -- ID.

-- --

Description

-- -- When the command is executed, a global workgroup consisting of -- taskCount local workgroups is assembled. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
taskCount must be less than or equal to -- PhysicalDeviceMeshShaderPropertiesNV::maxDrawMeshTasksCount

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDrawMeshTasksIndirectNV behaves similarly to -- cmdDrawMeshTasksNV 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 DrawMeshTasksIndirectCommandNV structures. If -- drawCount is less than or equal to one, stride is -- ignored. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If the multi-draw indirect feature is not enabled, -- drawCount must be 0 or 1
drawCount must be less than or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
If drawCount is greater than 1, stride -- must be a multiple of 4 and must be greater -- than or equal to -- sizeof(DrawMeshTasksIndirectCommandNV)
If drawCount is equal to 1, (offset + -- sizeof(DrawMeshTasksIndirectCommandNV)) must be -- less than or equal to the size of buffer
If drawCount is greater than 1, (stride -- × (drawCount - 1) + offset + -- sizeof(DrawMeshTasksIndirectCommandNV)) must be -- less than or equal to the size of buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDrawMeshTasksIndirectCountNV behaves similarly to -- cmdDrawMeshTasksIndirectNV 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 a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If countBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
countBuffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
countBufferOffset must be a multiple of -- 4
The count stored in countBuffer must be less than -- or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
stride must be a multiple of 4 and -- must be greater than or equal to -- sizeof(DrawMeshTasksIndirectCommandNV)
If maxDrawCount is greater than or equal to 1, -- (stride × (maxDrawCount - 1) + offset + -- sizeof(DrawMeshTasksIndirectCommandNV)) must be -- less than or equal to the size of buffer
If the count stored in countBuffer is equal to -- 1, (offset + -- sizeof(DrawMeshTasksIndirectCommandNV)) 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(DrawMeshTasksIndirectCommandNV)) must be -- less than or equal to the size of buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
countBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

queue is the Queue object the caller would like to -- retrieve checkpoint data for

-- --

pCheckpointDataCount is a pointer to an integer related -- to the number of checkpoint markers available or queried, as described -- below.
pCheckpointData is either NULL or a pointer to -- an array of CheckpointDataNV structures.

-- --

Description

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

Valid Usage

-- --

The device that queue belongs to must be in the -- lost state

-- --

Valid Usage (Implicit)

-- --

queue must be a valid Queue handle

-- --

pCheckpointDataCount must be a valid pointer to a -- uint32_t value
If the value referenced by pCheckpointDataCount is not -- 0, and pCheckpointData is not NULL, -- pCheckpointData must be a valid pointer to an array of -- pCheckpointDataCount CheckpointDataNV structures

-- --

physicalDevice is the physical device from which to query -- the set of combinations.

-- --

pCombinationCount is a pointer to an integer related to -- the number of combinations available or queried, as described -- below.
pCombinations is either NULL or a pointer to an -- array of FramebufferMixedSamplesCombinationNV values, -- indicating the supported combinations of coverage reduction mode, -- rasterization samples, and color, depth, stencil attachment sample -- counts.

-- --

Description

-- -- If pCombinations is NULL, then the number of -- supported combinations for the given physicalDevice is -- returned in pCombinationCount. Otherwise, -- pCombinationCount must point to a variable set by the -- user to the number of elements in the pCombinations array, -- and on return the variable is overwritten with the number of values -- actually written to pCombinations. If the value of -- pCombinationCount is less than the number of combinations -- supported for the given physicalDevice, at most -- pCombinationCount values will be written -- pCombinations and INCOMPLETE will be returned instead -- of SUCCESS to indicate that not all the supported values were -- returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pCombinationCount must be a valid pointer to a -- uint32_t value
If the value referenced by pCombinationCount is not -- 0, and pCombinations is not NULL, -- pCombinations must be a valid pointer to an array of -- pCombinationCount FramebufferMixedSamplesCombinationNV -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV

-- --

flags must be 0
coverageReductionMode must be a valid -- CoverageReductionModeNV value

-- --

Description

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

Parameters

-- --

physicalDevice is the physical device.

-- --

pPropertyCount is a pointer to an integer related to the -- number of cooperative matrix properties available or queried.
pProperties is either NULL or a pointer to an -- array of CooperativeMatrixPropertiesNV structures.

-- --

Description

-- -- If pProperties is NULL, then the number of -- cooperative matrix 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 cooperative matrix properties available, at most -- pPropertyCount structures will be written. If -- pPropertyCount is smaller than the number of cooperative -- matrix properties available, INCOMPLETE will be returned -- instead of SUCCESS, to indicate that not all the available -- cooperative matrix properties were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 CooperativeMatrixPropertiesNV -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- -- All enum values match the corresponding SPIR-V value. -- --

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.
pViewportWScalings is a pointer to an array of -- ViewportWScalingNV structures specifying viewport -- parameters.

-- --

Description

-- -- The viewport parameters taken from element i of -- pViewportWScalings replace the current state for the viewport -- index firstViewport + i, for i in [0, -- viewportCount). -- --

Valid Usage

-- --

firstViewport must be less than -- PhysicalDeviceLimits::maxViewports

-- --

The sum of firstViewport and viewportCount -- must be between 1 and -- PhysicalDeviceLimits::maxViewports, inclusive

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pViewportWScalings must be a valid pointer to an -- array of viewportCount ViewportWScalingNV -- structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pInfo describes the image view to query and type of -- handle.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

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

-- --

imageView is a handle to the image view.
pProperties contains the device address and size when the -- call returns.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure
- ERROR_UNKNOWN

-- --

Parameters

-- --

device is the device that created the pipeline.

-- --

pPipelineInfo describes the pipeline being queried.
pExecutableCount is a pointer to an integer related to -- the number of pipeline executables available or queried, as described -- below.
pProperties is either NULL or a pointer to an -- array of PipelineExecutablePropertiesKHR structures.

-- --

Description

-- -- If pProperties is NULL, then the number of -- executables associated with the pipeline is returned in -- pExecutableCount. Otherwise, pExecutableCount -- 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 pExecutableCount is less than the -- number of executables associated with the pipeline, at most -- pExecutableCount structures will be written and -- getPipelineExecutablePropertiesKHR will return -- INCOMPLETE. -- --

Valid Usage

-- --

pipelineExecutableInfo must be enabled

-- --

pipeline member of pPipelineInfo must -- have been created with device

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pPipelineInfo must be a valid pointer to a valid -- PipelineInfoKHR structure
pExecutableCount must be a valid pointer to a -- uint32_t value
If the value referenced by pExecutableCount is not -- 0, and pProperties is not NULL, -- pProperties must be a valid pointer to an array of -- pExecutableCount PipelineExecutablePropertiesKHR -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the device that created the pipeline.

-- --

pExecutableInfo describes the pipeline executable being -- queried.
pStatisticCount is a pointer to an integer related to the -- number of statistics available or queried, as described below.
pStatistics is either NULL or a pointer to an -- array of PipelineExecutableStatisticKHR structures.

-- --

Description

-- -- If pStatistics is NULL, then the number of -- statistics associated with the pipeline executable is returned in -- pStatisticCount. Otherwise, pStatisticCount -- must point to a variable set by the user to the number of -- elements in the pStatistics array, and on return the variable -- is overwritten with the number of structures actually written to -- pStatistics. If pStatisticCount is less than the -- number of statistics associated with the pipeline executable, at most -- pStatisticCount structures will be written and -- getPipelineExecutableStatisticsKHR will return -- INCOMPLETE. -- --

Valid Usage

-- --

pipelineExecutableInfo must be enabled

-- --

pipeline member of pExecutableInfo must -- have been created with device
pipeline member of pExecutableInfo must -- have been created with -- PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR set in the -- flags field of GraphicsPipelineCreateInfo or -- ComputePipelineCreateInfo

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pExecutableInfo must be a valid pointer to a valid -- PipelineExecutableInfoKHR structure
pStatisticCount must be a valid pointer to a -- uint32_t value
If the value referenced by pStatisticCount is not -- 0, and pStatistics is not NULL, -- pStatistics must be a valid pointer to an array of -- pStatisticCount PipelineExecutableStatisticKHR -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the device that created the pipeline.

-- --

pExecutableInfo describes the pipeline executable being -- queried.
pInternalRepresentationCount is a pointer to an integer -- related to the number of internal representations available or -- queried, as described below.
pInternalRepresentations is either NULL or a -- pointer to an array of -- PipelineExecutableInternalRepresentationKHR structures.

-- --

Description

-- -- If pInternalRepresentations is NULL, then the number -- of internal representations associated with the pipeline executable is -- returned in pInternalRepresentationCount. Otherwise, -- pInternalRepresentationCount must point to a variable -- set by the user to the number of elements in the -- pInternalRepresentations array, and on return the variable is -- overwritten with the number of structures actually written to -- pInternalRepresentations. If -- pInternalRepresentationCount is less than the number of -- internal representations associated with the pipeline executable, at -- most pInternalRepresentationCount structures will be written -- and getPipelineExecutableInternalRepresentationsKHR will return -- INCOMPLETE. -- -- While the details of the internal representations remain -- implementation dependent, the implementation should order the -- internal representations in the order in which they occur in the -- compile pipeline with the final shader assembly (if any) last. -- --

Valid Usage

-- --

pipelineExecutableInfo must be enabled

-- --

pipeline member of pExecutableInfo must -- have been created with device
pipeline member of pExecutableInfo must -- have been created with -- PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR set in -- the flags field of GraphicsPipelineCreateInfo or -- ComputePipelineCreateInfo

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pExecutableInfo must be a valid pointer to a valid -- PipelineExecutableInfoKHR structure
pInternalRepresentationCount must be a valid -- pointer to a uint32_t value
If the value referenced by pInternalRepresentationCount -- is not 0, and pInternalRepresentations is not -- NULL, pInternalRepresentations must be a -- valid pointer to an array of pInternalRepresentationCount -- PipelineExecutableInternalRepresentationKHR structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

physicalDevice is the handle to the physical device whose -- queue family performance query counter properties will be -- queried.

-- --

queueFamilyIndex is the index into the queue family of -- the physical device we want to get properties for.
pCounterCount is a pointer to an integer related to the -- number of counters available or queried, as described below.
pCounters is either NULL or a pointer to an -- array of PerformanceCounterKHR structures.
pCounterDescriptions is either NULL or a pointer -- to an array of PerformanceCounterDescriptionKHR -- structures.

-- --

Description

-- -- If pCounters is NULL and -- pCounterDescriptions is NULL, then the number of -- counters available is returned in pCounterCount. Otherwise, -- pCounterCount must point to a variable set by the user -- to the number of elements in the pCounters, -- pCounterDescriptions, or both arrays and on return the -- variable is overwritten with the number of structures actually written -- out. If pCounterCount is less than the number of counters -- available, at most pCounterCount structures will be written -- and INCOMPLETE will be returned instead of SUCCESS. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pCounterCount must be a valid pointer to a -- uint32_t value
If the value referenced by pCounterCount is not -- 0, and pCounters is not NULL, -- pCounters must be a valid pointer to an array of -- pCounterCount PerformanceCounterKHR structures
If the value referenced by pCounterCount is not -- 0, and pCounterDescriptions is not NULL, -- pCounterDescriptions must be a valid pointer to an -- array of pCounterCount -- PerformanceCounterDescriptionKHR structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Parameters

-- --

physicalDevice is the handle to the physical device whose -- queue family performance query counter properties will be -- queried.

-- --

pPerformanceQueryCreateInfo is a pointer to a -- QueryPoolPerformanceCreateInfoKHR of the performance query that -- is to be created.
pNumPasses is a pointer to an integer related to the -- number of passes required to query the performance query pool, as -- described below.

-- --

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

-- --

pGetWin32HandleInfo is a pointer to a -- SemaphoreGetWin32HandleInfoKHR structure containing parameters -- of the export operation.
pHandle will return the Windows handle representing the -- semaphore state.

-- --

Description

-- -- For handle types defined as NT handles, the handles returned by -- getSemaphoreWin32HandleKHR are owned by the application. To -- avoid leaking resources, the application must release ownership -- of them using the CloseHandle system call when they are no -- longer needed. -- -- Exporting a Windows handle from a semaphore may have side -- effects depending on the transference of the specified handle type, as -- described in Importing Semaphore Payloads. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

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

-- --

pImportSemaphoreWin32HandleInfo is a pointer to a -- ImportSemaphoreWin32HandleInfoKHR structure specifying the -- semaphore and import parameters.

-- --

Description

-- -- Importing a semaphore payload from Windows handles does not transfer -- ownership of the handle to the Vulkan implementation. For handle types -- defined as NT handles, the application must release ownership -- using the CloseHandle system call when the handle is no -- longer needed. -- -- 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- The handle types supported by handleType are: -- -- TODO: table -- -- Handle Types Supported by ImportSemaphoreWin32HandleInfoKHR -- --

Valid Usage

-- --

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

-- --

If handleType is not -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, name -- must be NULL
If handleType is not 0 and handle is -- NULL, name must name a valid synchronization -- primitive of the type specified by handleType
If handleType is not 0 and name is -- NULL, handle must be a valid handle of the -- type specified by handleType
If handle is not NULL, name must -- be NULL
If handle is not NULL, it must obey any -- requirements listed for handleType in external semaphore -- handle types compatibility
If name is not NULL, it must obey any -- requirements listed for handleType in external semaphore -- handle types compatibility
If handleType is -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the -- SemaphoreCreateInfo::flags field must match -- that of the semaphore from which handle or name was -- exported
If handleType is -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the -- SemaphoreTypeCreateInfo::semaphoreType field -- must match that of the semaphore from which handle or -- name was exported
If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, -- the SemaphoreTypeCreateInfo::semaphoreType field of -- the semaphore from which handle or name was exported -- must not be SEMAPHORE_TYPE_TIMELINE

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid Semaphore -- handle
flags must be a valid combination of -- SemaphoreImportFlagBits values
If handleType is not 0, handleType -- must be a valid ExternalSemaphoreHandleTypeFlagBits -- value

-- --

Host Synchronization

-- --

Host access to semaphore must be externally -- synchronized

-- --

Description

-- -- If ExportSemaphoreCreateInfo is not present in the same -- pNext chain, this structure is ignored. -- -- If ExportSemaphoreCreateInfo is present in the pNext -- chain of SemaphoreCreateInfo with a Windows -- handleType, but either -- ExportSemaphoreWin32HandleInfoKHR is not present in the -- pNext chain, or if it is but pAttributes is set to -- NULL, default security descriptor values will be used, and -- child processes created by the application will not inherit the -- handle, as described in the MSDN documentation for “Synchronization -- Object Security and Access Rights”1. Further, if the structure is not -- present, the access rights used depend on the handle type. -- -- For handles of the following types: -- -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT -- -- The implementation must ensure the access rights allow both -- signal and wait operations on the semaphore. -- -- For handles of the following types: -- -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT -- -- The access rights must be: -- --

--   GENERIC_ALL
--

-- --

1 -- https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

-- --

Valid Usage

-- --

If ExportSemaphoreCreateInfo::handleTypes does not -- include EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, -- ExportSemaphoreWin32HandleInfoKHR must not be included -- in the pNext chain of SemaphoreCreateInfo

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR

-- --

If pAttributes is not NULL, pAttributes -- must be a valid pointer to a valid SECURITY_ATTRIBUTES -- value

-- --

Description

-- -- If the semaphore in SubmitInfo::pWaitSemaphores or -- SubmitInfo::pSignalSemaphores corresponding to an -- entry in pWaitSemaphoreValues or -- pSignalSemaphoreValues respectively does not currently have a -- payload referring to a Direct3D 12 fence, the implementation -- must ignore the value in the pWaitSemaphoreValues or -- pSignalSemaphoreValues entry. -- -- Note -- -- As the introduction of the external semaphore handle type -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT predates that of -- timeline semaphores, support for importing semaphore payloads from -- external handles of that type into semaphores created (implicitly or -- explicitly) with a SemaphoreType of -- SEMAPHORE_TYPE_BINARY is preserved for backwards compatibility. -- However, applications should prefer importing such handle types -- into semaphores created with a SemaphoreType of -- SEMAPHORE_TYPE_TIMELINE, and use the -- TimelineSemaphoreSubmitInfo structure instead of the -- D3D12FenceSubmitInfoKHR structure to specify the values to use -- when waiting for and signaling such semaphores. -- --

Valid Usage

-- --

waitSemaphoreValuesCount must be the same value as -- SubmitInfo::waitSemaphoreCount, where -- SubmitInfo is in the pNext chain of this -- D3D12FenceSubmitInfoKHR structure

-- --

signalSemaphoreValuesCount must be the same value -- as SubmitInfo::signalSemaphoreCount, where -- SubmitInfo is in the pNext chain of this -- D3D12FenceSubmitInfoKHR structure

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR

-- --

If waitSemaphoreValuesCount is not 0, and -- pWaitSemaphoreValues is not NULL, -- pWaitSemaphoreValues must be a valid pointer to an -- array of waitSemaphoreValuesCount uint64_t -- values
If signalSemaphoreValuesCount is not 0, and -- pSignalSemaphoreValues is not NULL, -- pSignalSemaphoreValues must be a valid pointer to an -- array of signalSemaphoreValuesCount uint64_t -- values

-- --

Description

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

Valid Usage

-- --

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

-- --

If handleType is defined as an NT handle, -- getSemaphoreWin32HandleKHR must be called no more than -- once for each valid unique combination of semaphore and -- handleType
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 -- ExternalSemaphoreProperties::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 an NT handle or a -- global share handle

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid Semaphore -- handle
handleType must be a valid -- ExternalSemaphoreHandleTypeFlagBits value

-- --

Parameters

-- --

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

-- --

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

-- --

Description

-- -- Each call to getSemaphoreFdKHR 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

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

-- --

pImportSemaphoreFdInfo is a pointer to a -- ImportSemaphoreFdInfoKHR 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- The handle types supported by handleType are: -- -- TODO: table -- -- Handle Types Supported by ImportSemaphoreFdInfoKHR -- --

Valid Usage

-- --

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

-- --

fd must obey any requirements listed for -- handleType in external semaphore handle types -- compatibility
If handleType is -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, the -- SemaphoreCreateInfo::flags field must match -- that of the semaphore from which fd was exported
If handleType is -- EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD_BIT, the -- SemaphoreTypeCreateInfo::semaphoreType field -- must match that of the semaphore from which fd was -- exported
If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, -- the SemaphoreTypeCreateInfo::semaphoreType field of -- the semaphore from which fd was exported must not be -- SEMAPHORE_TYPE_TIMELINE

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid Semaphore -- handle
flags must be a valid combination of -- SemaphoreImportFlagBits values
handleType must be a valid -- ExternalSemaphoreHandleTypeFlagBits 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 ExternalSemaphoreHandleTypeFlagBits -- for a description of the properties of the defined external semaphore -- handle types. -- --

Valid Usage

-- --

handleType must have been included in -- ExportSemaphoreCreateInfo::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 -- ExternalSemaphoreProperties::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
If handleType refers to a handle type with copy payload -- transference semantics, semaphore must have been -- created with a SemaphoreType of -- SEMAPHORE_TYPE_BINARY
If handleType refers to a handle type with copy payload -- transference semantics, semaphore must have an -- associated semaphore signal operation that has been submitted for -- execution and any semaphore signal operations on which it depends (if -- any) must have also been submitted for execution

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

-- --

pNext must be NULL
semaphore must be a valid Semaphore -- handle
handleType must be a valid -- ExternalSemaphoreHandleTypeFlagBits value

-- --

Parameters

-- --

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

-- --

pGetWin32HandleInfo is a pointer to a -- MemoryGetWin32HandleInfoKHR structure containing parameters of -- the export operation.
pHandle will return the Windows handle representing the -- underlying resources of the device memory object.

-- --

Description

-- -- For handle types defined as NT handles, the handles returned by -- getMemoryWin32HandleKHR are owned by the application. To avoid -- leaking resources, the application must release ownership of -- them using the CloseHandle system call when they are no -- longer needed. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device that will be importing -- handle.

-- --

handleType is the type of the handle -- handle.
handle is the handle which will be imported.
pMemoryWin32HandleProperties will return properties of -- handle.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- Importing memory objects from Windows handles does not transfer -- ownership of the handle to the Vulkan implementation. For handle types -- defined as NT handles, the application must release ownership -- using the CloseHandle system call when the handle is no -- longer needed. -- -- 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 -- DeviceMemory object. -- --

Valid Usage

-- --

If handleType is not 0, it must be -- supported for import, as reported by -- ExternalImageFormatProperties or -- ExternalBufferProperties

-- --

The memory from which handle was exported, or the memory -- named by name must have been created on the same -- underlying physical device as device
If handleType is not 0, it must be -- defined as an NT handle or a global share handle
If handleType is not -- EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, name -- must be NULL
If handleType is not 0 and handle is -- NULL, name must name a valid memory resource -- of the type specified by handleType
If handleType is not 0 and name is -- NULL, handle must be a valid handle of the -- type specified by handleType
if handle is not NULL, name must -- be NULL
If handle is not NULL, it must obey any -- requirements listed for handleType in external memory -- handle types compatibility
If name is not NULL, it must obey any -- requirements listed for handleType in external memory -- handle types compatibility

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR

-- --

If handleType is not 0, handleType -- must be a valid ExternalMemoryHandleTypeFlagBits -- value

-- --

Description

-- -- If ExportMemoryAllocateInfo is not present in the same -- pNext chain, this structure is ignored. -- -- If ExportMemoryAllocateInfo is present in the pNext -- chain of MemoryAllocateInfo with a Windows handleType, -- but either ExportMemoryWin32HandleInfoKHR is not present in the -- pNext chain, or if it is but pAttributes is set to -- NULL, default security descriptor values will be used, and -- child processes created by the application will not inherit the -- handle, as described in the MSDN documentation for “Synchronization -- Object Security and Access Rights”1. Further, if the structure is not -- present, the access rights used depend on the handle type. -- -- For handles of the following types: -- -- EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT -- -- The implementation must ensure the access rights allow read and -- write access to the memory. -- -- For handles of the following types: -- -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT -- -- The access rights must be: -- --

--   GENERIC_ALL
--

-- --

1 -- https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

-- --

Valid Usage

-- --

If ExportMemoryAllocateInfo::handleTypes does not -- include EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or -- EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, a -- ExportMemoryWin32HandleInfoKHR structure must not be -- included in the pNext chain of MemoryAllocateInfo

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_KHR

-- --

If pAttributes is not NULL, pAttributes -- must be a valid pointer to a valid SECURITY_ATTRIBUTES -- value

-- --

Description

-- -- The properties of the handle returned depend on the value of -- handleType. See ExternalMemoryHandleTypeFlagBits for a -- description of the properties of the defined external memory handle -- types. -- --

Valid Usage

-- --

handleType must have been included in -- ExportMemoryAllocateInfo::handleTypes when -- memory was created

-- --

If handleType is defined as an NT handle, -- getMemoryWin32HandleKHR must be called no more than once -- for each valid unique combination of memory and -- handleType
handleType must be defined as an NT handle or a -- global share handle

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR

-- --

pNext must be NULL
memory must be a valid DeviceMemory -- handle
handleType must be a valid -- ExternalMemoryHandleTypeFlagBits value

-- --

Parameters

-- --

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

-- --

pGetFdInfo is a pointer to a MemoryGetFdInfoKHR -- structure containing parameters of the export operation.
pFd will return a file descriptor representing the -- underlying resources of the device memory object.

-- --

Description

-- -- Each call to getMemoryFdKHR 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 using the close system call when it is no -- longer needed, or by importing a Vulkan memory object from it. Where -- supported by the operating system, the implementation must set -- the file descriptor to be closed automatically when an execve -- system call is made. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- 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 is a pointer to a -- MemoryFdPropertiesKHR structure in which the properties of the -- handle fd are returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- 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 -- DeviceMemory object. -- --

Valid Usage

-- --

If handleType is not 0, it must be -- supported for import, as reported by -- ExternalImageFormatProperties or -- ExternalBufferProperties

-- --

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 -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#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 -- STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR

-- --

If handleType is not 0, handleType -- must be a valid ExternalMemoryHandleTypeFlagBits -- value

-- --

device is the logical device that created the fence.

-- --

pImportFenceWin32HandleInfo is a pointer to a -- ImportFenceWin32HandleInfoKHR structure specifying the fence -- and import parameters.

-- --

Description

-- -- Importing a fence payload from Windows handles does not transfer -- ownership of the handle to the Vulkan implementation. For handle types -- defined as NT handles, the application must release ownership -- using the CloseHandle system call when the handle is no -- longer needed. -- -- 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- The handle types supported by handleType are: -- -- TODO: table -- -- Handle Types Supported by ImportFenceWin32HandleInfoKHR -- --

Valid Usage

-- --

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

-- --

If handleType is not -- EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT, name -- must be NULL
If handleType is not 0 and handle is -- NULL, name must name a valid synchronization -- primitive of the type specified by handleType
If handleType is not 0 and name is -- NULL, handle must be a valid handle of the -- type specified by handleType
If handle is not NULL, name must -- be NULL
If handle is not NULL, it must obey any -- requirements listed for handleType in external fence -- handle types compatibility
If name is not NULL, it must obey any -- requirements listed for handleType in external fence -- handle types compatibility

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR

-- --

pNext must be NULL
fence must be a valid Fence handle
flags must be a valid combination of -- FenceImportFlagBits values
If handleType is not 0, handleType -- must be a valid ExternalFenceHandleTypeFlagBits -- value

-- --

Host Synchronization

-- --

Host access to fence must be externally -- synchronized

-- --

Description

-- -- If ExportFenceCreateInfo is not present in the same -- pNext chain, this structure is ignored. -- -- If ExportFenceCreateInfo is present in the pNext chain -- of FenceCreateInfo with a Windows handleType, but -- either ExportFenceWin32HandleInfoKHR is not present in the -- pNext chain, or if it is but pAttributes is set to -- NULL, default security descriptor values will be used, and -- child processes created by the application will not inherit the -- handle, as described in the MSDN documentation for “Synchronization -- Object Security and Access Rights”1. Further, if the structure is not -- present, the access rights will be -- -- DXGI_SHARED_RESOURCE_READ | -- DXGI_SHARED_RESOURCE_WRITE -- -- for handles of the following types: -- -- EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT -- --

1 -- https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

-- --

Valid Usage

-- --

If ExportFenceCreateInfo::handleTypes does not -- include EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT, a -- ExportFenceWin32HandleInfoKHR structure must not be -- included in the pNext chain of FenceCreateInfo

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR

-- --

If pAttributes is not NULL, pAttributes -- must be a valid pointer to a valid SECURITY_ATTRIBUTES -- value

-- --

Description

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

Valid Usage

-- --

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

-- --

If handleType is defined as an NT handle, -- getFenceWin32HandleKHR must be called no more than once -- for each valid unique combination of fence and -- handleType
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 -- ExternalFenceProperties::exportFromImportedHandleTypes -- for handleType
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
handleType must be defined as an NT handle or a -- global share handle

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR

-- --

pNext must be NULL
fence must be a valid Fence handle
handleType must be a valid -- ExternalFenceHandleTypeFlagBits value

-- --

Parameters

-- --

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

-- --

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

-- --

Description

-- -- Each call to getFenceFdKHR 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 -- EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT and the fence is -- signaled at the time getFenceFdKHR 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device that created the fence.

-- --

pImportFenceFdInfo is a pointer to a -- ImportFenceFdInfoKHR 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_INVALID_EXTERNAL_HANDLE

-- --

Description

-- -- The handle types supported by handleType are: -- -- TODO: table -- -- Handle Types Supported by ImportFenceFdInfoKHR -- --

Valid Usage

-- --

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

-- --

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

-- -- If handleType is -- 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 Fence 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 does not need to be waited for. It is -- consistent with the option for implementations to return a -1 -- file descriptor when exporting a -- EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT from a Fence -- which is signaled. -- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR

-- --

pNext must be NULL
fence must be a valid Fence handle
flags must be a valid combination of -- FenceImportFlagBits values
handleType must be a valid -- ExternalFenceHandleTypeFlagBits 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 ExternalFenceHandleTypeFlagBits for a -- description of the properties of the defined external fence handle -- types. -- --

Valid Usage

-- --

handleType must have been included in -- ExportFenceCreateInfo::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 -- ExternalFenceProperties::exportFromImportedHandleTypes -- for handleType
handleType must be defined as a POSIX file -- descriptor handle

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

-- --

pNext must be NULL
fence must be a valid Fence handle
handleType must be a valid -- ExternalFenceHandleTypeFlagBits value

-- --

Parameters

-- --

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

-- --

firstBinding is the index of the first transform feedback -- binding whose state is updated by the command.
bindingCount is the number of transform feedback 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.
pSizes is an optional array of buffer sizes, specifying -- the maximum number of bytes to capture to the corresponding transform -- feedback buffer. If pSizes is NULL, or the value of -- the pSizes array element is WHOLE_SIZE, then the -- maximum bytes captured will be the size of the corresponding buffer -- minus the buffer offset.

-- --

Description

-- -- The values taken from elements i of pBuffers, -- pOffsets and pSizes replace the current state for -- the transform feedback binding firstBinding + i, for i in [0, -- bindingCount). The transform feedback binding is updated to -- start at the offset indicated by pOffsets[i] from the start -- of the buffer pBuffers[i]. -- --

Valid Usage

-- --

PhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback -- must be enabled

-- --

firstBinding must be less than -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
The sum of firstBinding and bindingCount -- must be less than or equal to -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
All elements of pOffsets must be less than the -- size of the corresponding element in pBuffers
All elements of pOffsets must be a multiple of -- 4
All elements of pBuffers must have been created -- with the BUFFER_USAGE_TRANSFORM_FEEDBACK_BUFFER_BIT_EXT -- flag
If the optional pSize array is specified, each element of -- pSizes must either be WHOLE_SIZE, or be less -- than or equal to -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBufferSize
All elements of pSizes must be less than or equal -- to the size of the corresponding buffer in pBuffers
All elements of pOffsets plus pSizes, where the -- pSizes, element is not WHOLE_SIZE, must be less -- than or equal to the size of the corresponding element in -- pBuffers
Each element of pBuffers that is non-sparse must -- be bound completely and contiguously to a single DeviceMemory -- object
Transform feedback must not be active when the -- cmdBindTransformFeedbackBuffersEXT command is recorded

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pBuffers must be a valid pointer to an array of -- bindingCount valid Buffer handles
pOffsets must be a valid pointer to an array of -- bindingCount DeviceSize values
If pSizes is not NULL, pSizes -- must be a valid pointer to an array of bindingCount -- DeviceSize values
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
If pSizes is not NULL, bindingCount -- must be greater than 0
Both of commandBuffer, and the elements of -- pBuffers must have been created, allocated, or -- retrieved from the same Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

firstCounterBuffer is the index of the first transform -- feedback buffer corresponding to pCounterBuffers[0] and -- pCounterBufferOffsets[0].
counterBufferCount is the size of the -- pCounterBuffers and pCounterBufferOffsets -- arrays.
pCounterBuffers is an optional array of buffer handles to -- the counter buffers which contain a 4 byte integer value representing -- the byte offset from the start of the corresponding transform feedback -- buffer from where to start capturing vertex data. If the byte offset -- stored to the counter buffer location was done using -- cmdEndTransformFeedbackEXT it can be used to resume transform -- feedback from the previous location. If pCounterBuffers is -- NULL, then transform feedback will start capturing vertex -- data to byte offset zero in all bound transform feedback buffers. For -- each element of pCounterBuffers that is NULL_HANDLE, -- transform feedback will start capturing vertex data to byte zero in -- the corresponding bound transform feedback buffer.
pCounterBufferOffsets is an optional array of offsets -- within each of the pCounterBuffers where the counter values -- were previously written. The location in each counter buffer at these -- offsets must be large enough to contain 4 bytes of data. This -- data is the number of bytes captured by the previous transform -- feedback to this buffer. If pCounterBufferOffsets is -- NULL, then it is assumed the offsets are zero.

-- --

Description

-- -- The active transform feedback buffers will capture primitives emitted -- from the corresponding XfbBuffer in the bound graphics -- pipeline. Any XfbBuffer emitted that does not output to an -- active transform feedback buffer will not be captured. -- --

Valid Usage

-- --

PhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback -- must be enabled

-- --

Transform feedback must not be active
firstCounterBuffer must be less than -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
The sum of firstCounterBuffer and -- counterBufferCount must be less than or equal to -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
If counterBufferCount is not 0, and -- pCounterBuffers is not NULL, -- pCounterBuffers must be a valid pointer to an array of -- counterBufferCount Buffer handles that are either -- valid or NULL_HANDLE
For each buffer handle in the array, if it is not -- NULL_HANDLE it must reference a buffer large enough to -- hold 4 bytes at the corresponding offset from the -- pCounterBufferOffsets array
If pCounterBuffer is NULL, then -- pCounterBufferOffsets must also be NULL
For each buffer handle in the pCounterBuffers array that -- is not NULL_HANDLE it must have been created with a -- usage value containing -- BUFFER_USAGE_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT
Transform feedback must not be made active in a render pass -- instance with multiview enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

If counterBufferCount is not 0, and -- pCounterBufferOffsets is not NULL, -- pCounterBufferOffsets must be a valid pointer to an -- array of counterBufferCount DeviceSize values
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
This command must only be called inside of a render pass -- instance
Both of commandBuffer, and the elements of -- pCounterBuffers that are valid handles of non-ignored -- parameters must have been created, allocated, or retrieved from -- the same Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

firstCounterBuffer is the index of the first transform -- feedback buffer corresponding to pCounterBuffers[0] and -- pCounterBufferOffsets[0].
counterBufferCount is the size of the -- pCounterBuffers and pCounterBufferOffsets -- arrays.
pCounterBuffers is an optional array of buffer handles to -- the counter buffers used to record the current byte positions of each -- transform feedback buffer where the next vertex output data would be -- captured. This can be used by a subsequent -- cmdBeginTransformFeedbackEXT call to resume transform feedback -- capture from this position. It can also be used by -- cmdDrawIndirectByteCountEXT to determine the vertex count of -- the draw call.
pCounterBufferOffsets is an optional array of offsets -- within each of the pCounterBuffers where the counter values -- can be written. The location in each counter buffer at these offsets -- must be large enough to contain 4 bytes of data. The data -- stored at this location is the byte offset from the start of the -- transform feedback buffer binding where the next vertex data would be -- written. If pCounterBufferOffsets is NULL, then it -- is assumed the offsets are zero.

-- --

Valid Usage

-- --

PhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback -- must be enabled

-- --

Transform feedback must be active
firstCounterBuffer must be less than -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
The sum of firstCounterBuffer and -- counterBufferCount must be less than or equal to -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackBuffers
If counterBufferCount is not 0, and -- pCounterBuffers is not NULL, -- pCounterBuffers must be a valid pointer to an array of -- counterBufferCount Buffer handles that are either -- valid or NULL_HANDLE
For each buffer handle in the array, if it is not -- NULL_HANDLE it must reference a buffer large enough to -- hold 4 bytes at the corresponding offset from the -- pCounterBufferOffsets array
If pCounterBuffer is NULL, then -- pCounterBufferOffsets must also be NULL
For each buffer handle in the pCounterBuffers array that -- is not NULL_HANDLE it must have been created with a -- usage value containing -- BUFFER_USAGE_TRANSFORM_FEEDBACK_COUNTER_BUFFER_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

If counterBufferCount is not 0, and -- pCounterBufferOffsets is not NULL, -- pCounterBufferOffsets must be a valid pointer to an -- array of counterBufferCount DeviceSize values
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
This command must only be called inside of a render pass -- instance
Both of commandBuffer, and the elements of -- pCounterBuffers that are valid handles of non-ignored -- parameters must have been created, allocated, or retrieved from -- the same Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 QueryControlFlagBits -- specifying constraints on the types of queries that can be -- performed.
index is the query type specific index. When the query -- type is QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the index -- represents the vertex stream.

-- --

Description

-- -- The cmdBeginQueryIndexedEXT command operates the same as the -- cmdBeginQuery command, except that it also accepts a query type -- specific index parameter. -- --

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
The queryType used to create queryPool -- must not be QUERY_TYPE_TIMESTAMP
If the precise occlusion queries feature is not enabled, or -- the queryType used to create queryPool was not -- QUERY_TYPE_OCCLUSION, flags must not contain -- QUERY_CONTROL_PRECISE_BIT
query must be less than the number of queries in -- queryPool
If the queryType used to create queryPool was -- QUERY_TYPE_OCCLUSION, the CommandPool that -- commandBuffer was allocated from must support graphics -- operations
If the queryType used to create queryPool was -- QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate graphics operations, the -- CommandPool that commandBuffer was allocated from -- must support graphics operations
If the queryType used to create queryPool was -- QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate compute operations, the -- CommandPool that commandBuffer was allocated from -- must support compute operations
commandBuffer must not be a protected command -- buffer
If 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
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the CommandPool -- that commandBuffer was allocated from must support -- graphics operations
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the index -- parameter must be less than -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackStreams
If the queryType used to create queryPool was -- not QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the index -- must be zero
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT then -- PhysicalDeviceTransformFeedbackPropertiesEXT::transformFeedbackQueries -- must be supported
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, the profiling lock -- must have been held before beginCommandBuffer was called -- on commandBuffer
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one of the counters used -- to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_COMMAND_BUFFER_KHR, the query begin -- must be the first recorded command in -- commandBuffer
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one of the counters used -- to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_RENDER_PASS_KHR, the begin command -- must not be recorded within a render pass instance
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and another query pool with a -- queryType QUERY_TYPE_PERFORMANCE_QUERY_KHR has been -- used within commandBuffer, its parent primary command buffer -- or secondary command buffer recorded within the same parent primary -- command buffer as commandBuffer, the -- performanceCounterMultipleQueryPools feature must be -- enabled
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, this command must not -- be recorded in a command buffer that, either directly or through -- secondary command buffers, also contains a cmdResetQueryPool -- command affecting the same query

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
flags must be a valid combination of -- QueryControlFlagBits values
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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.
index is the query type specific index.

-- --

Description

-- -- The cmdEndQueryIndexedEXT command operates the same as the -- cmdEndQuery command, except that it also accepts a query type -- specific index parameter. -- --

Valid Usage

-- --

All queries used by the command must be active

-- --

query must be less than the number of queries in -- queryPool
commandBuffer must not be a protected command -- buffer
If cmdEndQueryIndexedEXT 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
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the index -- parameter must be less than -- PhysicalDeviceTransformFeedbackPropertiesEXT::maxTransformFeedbackStreams
If the queryType used to create queryPool was -- not QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the index -- must be zero
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT index -- must equal the index used to begin the query

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

instanceCount is the number of instances to draw.
firstInstance is the instance ID of the first instance to -- draw.
counterBuffer is the buffer handle from where the byte -- count is read.
counterBufferOffset is the offset into the buffer used to -- read the byte count, which is used to calculate the vertex count for -- this draw call.
counterOffset is subtracted from the byte count read from -- the counterBuffer at the counterBufferOffset
vertexStride is the stride in bytes between each element -- of the vertex data that is used to calculate the vertex count from the -- counter value. This value is typically the same value that was used in -- the graphics pipeline state when the transform feedback was captured -- as the XfbStride.

-- --

Description

-- -- When the command is executed, primitives are assembled in the same way -- as done with cmdDraw except the vertexCount is -- calculated based on the byte count read from counterBuffer at -- offset counterBufferOffset. The assembled primitives execute -- the bound graphics pipeline. -- -- The effective vertexCount is calculated as follows: -- --

--   const uint32_t * counterBufferPtr = (const uint8_t *)counterBuffer.address + counterBufferOffset;
--   vertexCount = floor(max(0, (*counterBufferPtr - counterOffset)) / vertexStride);
--

-- -- The effective firstVertex is zero. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
PhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback -- must be enabled
The implementation must support -- PhysicalDeviceTransformFeedbackPropertiesEXT::transformFeedbackDraw
vertexStride must be greater than 0 and less than -- or equal to -- PhysicalDeviceLimits::maxTransformFeedbackBufferDataStride
counterBuffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
commandBuffer must not be a protected command -- buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

counterBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
This command must only be called inside of a render pass -- instance
Both of commandBuffer, and counterBuffer -- must have been created, allocated, or retrieved from the same -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pToolCount must be a valid pointer to a -- uint32_t value
If the value referenced by pToolCount is not 0, -- and pToolProperties is not NULL, -- pToolProperties must be a valid pointer to an array of -- pToolCount PhysicalDeviceToolPropertiesEXT -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Parameters

-- --

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

-- --

pSampleLocationsInfo is the sample locations state to -- set.

-- --

Valid Usage

-- --

The sampleLocationsPerPixel member of -- pSampleLocationsInfo must equal the -- rasterizationSamples member of the -- PipelineMultisampleStateCreateInfo structure the bound graphics -- pipeline has been created with

-- --

If -- PhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations -- is FALSE then the current render pass must have been -- begun by specifying a RenderPassSampleLocationsBeginInfoEXT -- 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 CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- MultisamplePropertiesEXT structure in which information about -- the additional multisampling capabilities specific to the sample count -- is returned.

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT

-- --

If sampleLocationsPerPixel is not 0, -- sampleLocationsPerPixel must be a valid -- SampleCountFlagBits value
If sampleLocationsCount is not 0, -- pSampleLocations must be a valid pointer to an array -- of sampleLocationsCount SampleLocationEXT -- structures

-- --

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

-- --

lineStippleFactor is the repeat factor used in stippled -- line rasterization.
lineStipplePattern is the bit pattern used in stippled -- line rasterization.

-- --

Valid Usage

-- --

lineStippleFactor must be in the range -- [1,256]

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

pConditionalRenderingBegin is a pointer to a -- ConditionalRenderingBeginInfoEXT structure specifying -- parameters of conditional rendering.

-- --

Valid Usage

-- --

Conditional rendering must not already be -- active

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

sType must be -- STRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT

-- --

pNext must be NULL
buffer must be a valid Buffer handle
flags must be a valid combination of -- ConditionalRenderingFlagBitsEXT values

-- --

physicalDevice is the physical device from which to query -- the set of calibrateable time domains.

-- --

pTimeDomainCount is a pointer to an integer related to -- the number of calibrateable time domains available or queried, as -- described below.
pTimeDomains is either NULL or a pointer to an -- array of TimeDomainEXT values, indicating the supported -- calibrateable time domains.

-- --

Description

-- -- If pTimeDomains is NULL, then the number of -- calibrateable time domains supported for the given -- physicalDevice is returned in pTimeDomainCount. -- Otherwise, pTimeDomainCount must point to a variable -- set by the user to the number of elements in the pTimeDomains -- array, and on return the variable is overwritten with the number of -- values actually written to pTimeDomains. If the value of -- pTimeDomainCount is less than the number of calibrateable -- time domains supported, at most pTimeDomainCount values will -- be written to pTimeDomains. If pTimeDomainCount is -- smaller than the number of calibrateable time domains supported for -- the given physicalDevice, INCOMPLETE will be returned -- instead of SUCCESS to indicate that not all the available -- values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pTimeDomainCount must be a valid pointer to a -- uint32_t value
If the value referenced by pTimeDomainCount is not -- 0, and pTimeDomains is not NULL, -- pTimeDomains must be a valid pointer to an array of -- pTimeDomainCount TimeDomainEXT values

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device used to perform the -- query.

-- --

timestampCount is the number of timestamps to query.
pTimestampInfos is a pointer to an array of -- timestampCount CalibratedTimestampInfoEXT structures, -- describing the time domains the calibrated timestamps should be -- captured from.
pTimestamps is a pointer to an array of -- timestampCount 64-bit unsigned integer values in which the -- requested calibrated timestamp values are returned.
pMaxDeviation is a pointer to a 64-bit unsigned integer -- value in which the strictly positive maximum deviation, in -- nanoseconds, of the calibrated timestamp values is returned.

-- --

Description

-- -- Note -- -- The maximum deviation may vary between calls to -- getCalibratedTimestampsEXT even for the same set of time -- domains due to implementation and platform specific reasons. It is the -- application’s responsibility to assess whether the returned maximum -- deviation makes the timestamp values suitable for any particular -- purpose and can choose to re-issue the timestamp calibration -- call pursuing a lower devation value. -- -- Calibrated timestamp values can be extrapolated to estimate -- future coinciding timestamp values, however, depending on the nature -- of the time domains and other properties of the platform extrapolating -- values over a sufficiently long period of time may no longer be -- accurate enough to fit any particular purpose so applications are -- expected to re-calibrate the timestamps on a regular basis. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

-- --

--   struct timespec tv;
--   clock_gettime(CLOCK_MONOTONIC, &tv);
--   return tv.tv_nsec + tv.tv_sec*1000000000ull;
--

-- --

--   struct timespec tv;
--   clock_gettime(CLOCK_MONOTONIC_RAW, &tv);
--   return tv.tv_nsec + tv.tv_sec*1000000000ull;
--

-- --

--   LARGE_INTEGER counter;
--   QueryPerformanceCounter(&counter);
--   return counter.QuadPart;
--

-- --

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 getShaderInfoAMD will -- return 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 -- ERROR_FEATURE_NOT_PRESENT. -- -- If information is successfully and fully queried, the function will -- return SUCCESS. -- -- For infoType SHADER_INFO_TYPE_STATISTICS_AMD, a -- ShaderStatisticsInfoAMD structure 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 infoType SHADER_INFO_TYPE_DISASSEMBLY_AMD, -- pInfo is a pointer 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 infoType 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 Device handle

-- --

pipeline must be a valid Pipeline -- handle
shaderStage must be a valid -- ShaderStageFlagBits value
infoType must be a valid ShaderInfoTypeAMD -- 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 --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_FEATURE_NOT_PRESENT
- ERROR_OUT_OF_HOST_MEMORY

-- --

Description

-- -- Some implementations may merge multiple logical shader stages together -- in a single shader. In such cases, shaderStageMask will -- contain a bitmask of all of the stages that are active within that -- shader. Consequently, if specifying those stages as input to -- getShaderInfoAMD, the same output information may be -- returned for all such shader stage queries. -- -- The number of available VGPRs and SGPRs (numAvailableVgprs -- and numAvailableSgprs respectively) are the -- shader-addressable subset of physical registers that is given as a -- limit to the compiler for register assignment. These values may -- further be limited by implementations due to performance optimizations -- where register pressure is a bottleneck. -- --

Parameters

-- --

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

-- --

pipelineStage is one of the PipelineStageFlagBits -- 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 cmdWriteBufferMarkerAMD 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 ACCESS_TRANSFER_WRITE_BIT, and the pipeline -- stages for identifying the synchronization scope must include -- both pipelineStage and PIPELINE_STAGE_TRANSFER_BIT. -- -- Note -- -- Similar to cmdWriteTimestamp, 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 -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstOffset must be a multiple of 4

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pipelineStage must be a valid -- PipelineStageFlagBits value
dstBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

semaphore is the handle of the semaphore to query.
pValue is a pointer to a 64-bit integer value in which -- the current counter value of the semaphore is returned.

-- --

Description

-- -- Note -- -- If a queue submission command is pending execution, then the -- value returned by this command may immediately be out of date. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

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

-- --

pWaitInfo is a pointer to a SemaphoreWaitInfo -- structure containing information about the wait condition.
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 waitSemaphores is called, -- then waitSemaphores returns immediately. If the condition is -- not satisfied at the time waitSemaphores is called, then -- waitSemaphores will block and wait up to timeout -- nanoseconds for the condition to become satisfied. -- -- If timeout is zero, then waitSemaphores does not wait, -- but simply returns information about the current state of the -- semaphore. 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, waitSemaphores returns TIMEOUT. If the -- condition is satisfied before timeout nanoseconds has -- expired, waitSemaphores returns SUCCESS. -- -- If device loss occurs (see Lost Device) before the timeout has -- expired, waitSemaphores must return in finite time with -- either SUCCESS or ERROR_DEVICE_LOST. -- --

Return Codes

-- --

Success --
- SUCCESS
- TIMEOUT

-- --

Failure --

-- --

Parameters

-- --

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

-- --

pSignalInfo is a pointer to a SemaphoreSignalInfo -- structure containing information about the signal operation.

-- --

Description

-- -- When signalSemaphore is executed on the host, it defines and -- immediately executes a semaphore signal operation which sets -- the timeline semaphore to the given value. -- -- The first synchronization scope is defined by the host execution -- model, but includes execution of signalSemaphore on the host -- and anything that happened-before it. -- -- The second synchronization scope is empty. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO

-- --

If waitSemaphoreValueCount is not 0, and -- pWaitSemaphoreValues is not NULL, -- pWaitSemaphoreValues must be a valid pointer to an -- array of waitSemaphoreValueCount uint64_t -- values
If signalSemaphoreValueCount is not 0, and -- pSignalSemaphoreValues is not NULL, -- pSignalSemaphoreValues must be a valid pointer to an -- array of signalSemaphoreValueCount uint64_t -- values

-- --

Description

pNext must be NULL
flags must be a valid combination of -- ImageCreateFlagBits values
usage must be a valid combination of -- ImageUsageFlagBits values
usage must not be 0
If viewFormatCount is not 0, -- pViewFormats must be a valid pointer to an array of -- viewFormatCount valid Format values

-- --

Description

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

-- -- cmdDrawIndirectCount behaves similarly to -- cmdDrawIndirect 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 a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If countBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
countBuffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
countBufferOffset must be a multiple of -- 4
The count stored in countBuffer must be less than -- or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
stride must be a multiple of 4 and -- must be greater than or equal to -- sizeof(DrawIndirectCommand)
If maxDrawCount is greater than or equal to 1, -- (stride × (maxDrawCount - 1) + offset + -- sizeof(DrawIndirectCommand)) must be less than or equal -- to the size of buffer
If the count stored in countBuffer is equal to -- 1, (offset + sizeof(DrawIndirectCommand)) -- 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(DrawIndirectCommand)) must be -- less than or equal to the size of buffer
If drawIndirectCount is not enabled this function -- must not be used

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
countBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDrawIndexedIndirectCount behaves similarly to -- cmdDrawIndexedIndirect 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 a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If countBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
countBuffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
countBufferOffset must be a multiple of -- 4
The count stored in countBuffer must be less than -- or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
stride must be a multiple of 4 and -- must be greater than or equal to -- sizeof(DrawIndexedIndirectCommand)
If maxDrawCount is greater than or equal to 1, -- (stride × (maxDrawCount - 1) + offset + -- sizeof(DrawIndexedIndirectCommand)) must be less than or -- equal to the size of buffer
If count stored in countBuffer is equal to 1, -- (offset + sizeof(DrawIndexedIndirectCommand)) -- 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(DrawIndexedIndirectCommand)) -- must be less than or equal to the size of buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
countBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the logical device that the buffer was created -- on.

-- --

pInfo is a pointer to a BufferDeviceAddressInfo -- structure specifying the buffer to retrieve an address for.

-- --

Description

-- -- The 64-bit return value is an opaque capture address of the start of -- pInfo->buffer. -- -- If the buffer was created with a non-zero value of -- BufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress -- the return value must be the same address. -- --

Valid Usage

-- --

The bufferDeviceAddress feature must be enabled

-- --

If device was created with multiple physical devices, -- then the bufferDeviceAddressMultiDevice feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- BufferDeviceAddressInfo structure

-- --

Parameters

-- --

device is the logical device that the buffer was created -- on.

-- --

pInfo is a pointer to a BufferDeviceAddressInfo -- structure specifying the buffer to retrieve an address for.

-- --

Description

-- -- The 64-bit return value is an address of the start of -- pInfo->buffer. The address range starting at this value -- and whose size is the size of the buffer can be used in a -- shader to access the memory bound to that buffer, using the -- SPV_KHR_physical_storage_buffer extension or the equivalent -- SPV_EXT_physical_storage_buffer extension and the -- PhysicalStorageBuffer storage class. For example, this value -- can be stored in a uniform buffer, and the shader can -- read the value from the uniform buffer and use it to do a dependent -- read/write to this buffer. A value of zero is reserved as a “null” -- pointer and must not be returned as a valid buffer device -- address. All loads, stores, and atomics in a shader through -- PhysicalStorageBuffer pointers must access addresses -- in the address range of some buffer. -- -- If the buffer was created with a non-zero value of -- BufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress -- or BufferDeviceAddressCreateInfoEXT::deviceAddress the -- return value will be the same address that was returned at capture -- time. -- --

Valid Usage

-- --

The bufferDeviceAddress or ::bufferDeviceAddress -- feature must be enabled

-- --

If device was created with multiple physical devices, -- then the bufferDeviceAddressMultiDevice or -- ::bufferDeviceAddressMultiDevice feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- BufferDeviceAddressInfo structure

-- --

Parameters

-- --

device is the logical device that the memory object was -- allocated on.

-- --

pInfo is a pointer to a -- DeviceMemoryOpaqueCaptureAddressInfo structure specifying the -- memory object to retrieve an address for.

-- --

Description

-- -- The 64-bit return value is an opaque address representing the start of -- pInfo->memory. -- -- If the memory object was allocated with a non-zero value of -- MemoryOpaqueCaptureAddressAllocateInfo::opaqueCaptureAddress, -- the return value must be the same address. -- -- Note -- -- The expected usage for these opaque addresses is only for trace -- capture/replay tools to store these addresses in a trace and -- subsequently specify them during replay. -- --

Valid Usage

-- --

The bufferDeviceAddress feature must be enabled

-- --

If device was created with multiple physical devices, -- then the bufferDeviceAddressMultiDevice feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- DeviceMemoryOpaqueCaptureAddressInfo structure

-- --

The hostQueryReset feature must be enabled

-- --

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
Submitted commands that refer to the range specified by -- firstQuery and queryCount in queryPool -- must have completed execution
The range of queries specified by firstQuery and -- queryCount in queryPool must not be in use by -- calls to getQueryPoolResults or resetQueryPool in other -- threads

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

queryPool must be a valid QueryPool -- handle
queryPool must have been created, allocated, or -- retrieved from device

-- --

Members

-- -- The members of the PhysicalDeviceHostQueryResetFeatures -- structure describe the following features: -- --

Description

-- -- If the PhysicalDeviceHostQueryResetFeatures structure is -- included in the pNext chain of -- PhysicalDeviceFeatures2, it is filled with values indicating -- whether the feature is supported. -- PhysicalDeviceHostQueryResetFeatures can also be -- included in the pNext chain of DeviceCreateInfo to -- enable features. -- --

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

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

-- --

commandPool is the command pool to trim.
flags is reserved for future use.

-- --

Description

-- -- Trimming a command pool recycles unused memory from the command pool -- back to the system. Command buffers allocated from the pool are not -- affected by the command. -- -- Note -- -- This command provides applications with some control over the internal -- memory allocations used by command pools. -- -- Unused memory normally arises from command buffers that have been -- recorded and later reset, such that they are no longer using the -- memory. On reset, a command buffer can return memory to its command -- pool, but the only way to release memory from a command pool to the -- system requires calling resetCommandPool, which cannot be -- executed while any command buffers from that pool are still in use. -- Subsequent recording operations into command buffers will re-use this -- memory but since total memory requirements fluctuate over time, unused -- memory can accumulate. -- -- In this situation, trimming a command pool may be useful to -- return unused memory back to the system, returning the total -- outstanding memory allocated by the pool back to a more “average” -- value. -- -- Implementations utilize many internal allocation strategies that make -- it impossible to guarantee that all unused memory is released back to -- the system. For instance, an implementation of a command pool -- may involve allocating memory in bulk from the system and -- sub-allocating from that memory. In such an implementation any live -- command buffer that holds a reference to a bulk allocation would -- prevent that allocation from being freed, even if only a small -- proportion of the bulk allocation is in use. -- -- In most cases trimming will result in a reduction in allocated but -- unused memory, but it does not guarantee the “ideal” behavior. -- -- Trimming may be an expensive operation, and should not -- be called frequently. Trimming should be treated as a way to -- relieve memory pressure after application-known points when there -- exists enough unused memory that the cost of trimming is “worth” it. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

commandPool must be a valid CommandPool -- handle
flags must be 0
commandPool must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to commandPool must be externally -- synchronized

-- --

Description

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

Description

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

Description

FORMAT_FEATURE_SAMPLED_IMAGE_BIT specifies that an image -- view can be sampled from.
FORMAT_FEATURE_STORAGE_IMAGE_BIT specifies that an image -- view can be used as a storage images.
FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT specifies that an -- image view can be used as storage image that supports atomic -- operations.
FORMAT_FEATURE_COLOR_ATTACHMENT_BIT specifies that an image -- view can be used as a framebuffer color attachment and as an -- input attachment.
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.
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.
FORMAT_FEATURE_BLIT_SRC_BIT specifies that an image -- can be used as srcImage for the cmdBlitImage -- command.
FORMAT_FEATURE_BLIT_DST_BIT specifies that an image -- can be used as dstImage for the cmdBlitImage -- command.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT specifies -- that if 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 FILTER_LINEAR, -- or mipmapMode set to SAMPLER_MIPMAP_MODE_LINEAR. If -- FORMAT_FEATURE_BLIT_SRC_BIT is also set, an image can be used -- as the srcImage to cmdBlitImage with a filter -- of FILTER_LINEAR. This bit must only be exposed for -- formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT -- or 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.
FORMAT_FEATURE_TRANSFER_SRC_BIT specifies that an image -- can be used as a source image for copy commands.
FORMAT_FEATURE_TRANSFER_DST_BIT specifies that an image -- can be used as a destination image for copy commands and -- clear commands.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT specifies -- Image can be used as a sampled image with a min or max -- SamplerReductionMode. This bit must only be exposed for -- formats that also support the -- FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT specifies -- that Image can be used with a sampler that has either of -- magFilter or minFilter set to -- FILTER_CUBIC_EXT, or be the source image for a blit with -- filter set to FILTER_CUBIC_EXT. This bit must -- only be exposed for formats that also support the -- 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.
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 SamplerYcbcrConversionCreateInfo -- xChromaOffset and/or yChromaOffset of -- CHROMA_LOCATION_MIDPOINT. Otherwise both xChromaOffset -- and yChromaOffset must be -- 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 -- FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT.
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 SamplerYcbcrConversionCreateInfo -- xChromaOffset and/or yChromaOffset of -- CHROMA_LOCATION_COSITED_EVEN. Otherwise both -- xChromaOffset and yChromaOffset must be -- CHROMA_LOCATION_MIDPOINT. If neither -- FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT nor -- FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT is set, the -- application must not define a sampler Y′CBCR conversion -- using this format as a source.
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.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT -- specifies that the format can have different chroma, min, and mag -- filters.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- specifies that reconstruction is explicit, as described in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#textures-chroma-reconstruction. -- If this bit is not present, reconstruction is implicit by -- default.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT -- specifies that reconstruction can be forcibly made explicit by -- setting -- SamplerYcbcrConversionCreateInfo::forceExplicitReconstruction -- to TRUE. If the format being queried supports -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- it must also support -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT.
FORMAT_FEATURE_DISJOINT_BIT specifies that a multi-planar -- image can have the IMAGE_CREATE_DISJOINT_BIT set during -- image creation. An implementation must not set -- FORMAT_FEATURE_DISJOINT_BIT for single-plane -- formats.
FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT specifies that -- an image view can be used as a fragment density map -- attachment.

FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT specifies that the -- format can be used to create a buffer view that can be -- bound to a DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER -- descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT specifies that the -- format can be used to create a buffer view that can be -- bound to a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER -- descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT specifies -- that atomic operations are supported on -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER with this format.
FORMAT_FEATURE_VERTEX_BUFFER_BIT specifies that the format -- can be used as a vertex attribute format -- (VertexInputAttributeDescription::format).

-- --

Parameters

-- --

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

-- --

pExternalBufferInfo is a pointer to a -- PhysicalDeviceExternalBufferInfo structure describing the -- parameters that would be consumed by createBuffer.
pExternalBufferProperties is a pointer to a -- ExternalBufferProperties structure in which capabilities are -- returned.

-- --

Valid Usage (Implicit)

-- --

deviceUUID is an array of UUID_SIZE -- uint8_t values representing a universally unique identifier -- for the device.

-- --

driverUUID is an array of UUID_SIZE -- uint8_t values representing a universally unique identifier -- for the driver build in use by the device.
deviceLUID is an array of LUID_SIZE -- uint8_t values representing a locally unique identifier for -- the device.
deviceNodeMask is a uint32_t bitfield -- identifying the node within a linked device adapter corresponding to -- the device.
deviceLUIDValid is a boolean value that will be -- TRUE if deviceLUID contains a valid LUID and -- deviceNodeMask contains a valid node mask, and FALSE -- if they do not.

-- -- 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 FALSE, the values of -- deviceLUID and deviceNodeMask are undefined. If -- deviceLUIDValid is 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 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, -- PhysicalDeviceIDProperties::deviceUUID may differ from -- PhysicalDeviceProperties2::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 PhysicalDeviceIDProperties::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 -- STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES

-- --

Description

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.
pMemoryHostPointerProperties is a pointer to a -- MemoryHostPointerPropertiesEXT structure in which the host -- pointer properties are returned.

-- --

Valid Usage

-- --

handleType must be -- EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or -- EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

-- --

pHostPointer must be a pointer aligned to an -- integer multiple of -- PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is -- EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, -- pHostPointer must be a pointer to host memory
If handleType is -- 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 Device handle

-- --

handleType must be a valid -- ExternalMemoryHandleTypeFlagBits value
pMemoryHostPointerProperties must be a valid -- pointer to a MemoryHostPointerPropertiesEXT structure

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- 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 -- 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 -- ExternalMemoryProperties

-- --

If handleType is not 0, it must be -- EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or -- EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
pHostPointer must be a pointer aligned to an -- integer multiple of -- PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is -- 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 MemoryAllocateInfo -- structure this structure is chained to
If handleType is -- 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 -- MemoryAllocateInfo structure this structure is chained to

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

-- --

handleType must be a valid -- ExternalMemoryHandleTypeFlagBits value

-- --

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

-- --

pExternalFenceInfo is a pointer to a -- PhysicalDeviceExternalFenceInfo structure describing the -- parameters that would be consumed by createFence.
pExternalFenceProperties is a pointer to a -- ExternalFenceProperties structure in which capabilities are -- returned.

Parameters

-- --

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

-- --

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 PhysicalDeviceGroupProperties -- 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, INCOMPLETE -- will be returned instead of 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 Instance -- 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 -- PhysicalDeviceGroupProperties structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Description

-- -- The elements of the pPhysicalDevices array are an ordered -- list of the physical devices that the logical device represents. These -- must be a subset of a single device group, and need not be in -- the same order as they were enumerated. The order of the physical -- devices in the pPhysicalDevices array determines the -- device index of each physical device, with element i being -- assigned a device index of i. Certain commands and structures refer to -- one or more physical devices by using device indices or device -- masks formed using device indices. -- -- A logical device created without using -- DeviceGroupDeviceCreateInfo, or with -- physicalDeviceCount equal to zero, is equivalent to a -- physicalDeviceCount of one and pPhysicalDevices -- pointing to the physicalDevice parameter to -- createDevice. In particular, the device index of that physical -- device is zero. -- --

Valid Usage

-- --

Each element of pPhysicalDevices must be -- unique

-- --

All elements of pPhysicalDevices must be in the -- same device group as enumerated by -- enumeratePhysicalDeviceGroups
If physicalDeviceCount is not 0, the -- physicalDevice parameter of createDevice must -- be an element of pPhysicalDevices

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFO

-- --

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

-- --

Description

-- -- When the implementation sets requiresDedicatedAllocation to -- TRUE, it must also set -- prefersDedicatedAllocation to TRUE. -- -- If the MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed as the pMemoryRequirements parameter of a -- getBufferMemoryRequirements2 call, -- requiresDedicatedAllocation may be TRUE under -- one of the following conditions: -- --

The pNext chain of BufferCreateInfo for the call -- to createBuffer used to create the buffer being queried -- included a ExternalMemoryBufferCreateInfo structure, and any of -- the handle types specified in -- ExternalMemoryBufferCreateInfo::handleTypes requires -- dedicated allocation, as reported by -- getPhysicalDeviceExternalBufferProperties in -- ExternalBufferProperties::externalMemoryProperties.externalMemoryFeatures, -- the requiresDedicatedAllocation field will be set to -- TRUE.

-- -- In all other cases, requiresDedicatedAllocation must -- be set to FALSE by the implementation whenever a -- MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed to a call to getBufferMemoryRequirements2. -- -- If the MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed as the pMemoryRequirements parameter of a -- getBufferMemoryRequirements2 call and -- BUFFER_CREATE_SPARSE_BINDING_BIT was set in -- BufferCreateInfo::flags when buffer was -- created then the implementation must set both -- prefersDedicatedAllocation and -- requiresDedicatedAllocation to FALSE. -- -- If the MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed as the pMemoryRequirements parameter of a -- getImageMemoryRequirements2 call, -- requiresDedicatedAllocation may be TRUE under -- one of the following conditions: -- --

The pNext chain of ImageCreateInfo for the call to -- createImage used to create the image being queried included a -- ExternalMemoryImageCreateInfo structure, and any of the handle -- types specified in -- ExternalMemoryImageCreateInfo::handleTypes requires -- dedicated allocation, as reported by -- getPhysicalDeviceImageFormatProperties2 in -- ExternalImageFormatProperties::externalMemoryProperties.externalMemoryFeatures, -- the requiresDedicatedAllocation field will be set to -- TRUE.

-- -- In all other cases, requiresDedicatedAllocation must -- be set to FALSE by the implementation whenever a -- MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed to a call to getImageMemoryRequirements2. -- -- If the MemoryDedicatedRequirements structure is included in the -- pNext chain of the MemoryRequirements2 structure -- passed as the pMemoryRequirements parameter of a -- getImageMemoryRequirements2 call and -- IMAGE_CREATE_SPARSE_BINDING_BIT was set in -- ImageCreateInfo::flags when image was created -- then the implementation must set both -- prefersDedicatedAllocation and -- requiresDedicatedAllocation to FALSE. -- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

-- --

Description

Parameters

-- --

device is the logical device that owns the queue.

-- --

pQueueInfo is a pointer to a DeviceQueueInfo2 -- structure, describing the parameters used to create the device -- queue.
pQueue is a pointer to a Queue object that will be -- filled with the handle for the requested queue.

-- --

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

-- --

QUEUE_COMPUTE_BIT specifies that queues in this queue -- family support compute operations.
QUEUE_TRANSFER_BIT specifies that queues in this queue -- family support transfer operations.
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 QUEUE_PROTECTED_BIT is set, then the queues in this -- queue family support the DEVICE_QUEUE_CREATE_PROTECTED_BIT bit. -- (see Protected Memory). If the protected memory physical device -- feature is supported, then at least one queue family of at least one -- physical device exposed by the implementation must support this -- bit.

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

instance is the instance with which to associate the -- surface.

-- --

pCreateInfo is a pointer to a -- MacOSSurfaceCreateInfoMVK structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- MacOSSurfaceCreateInfoMVK structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

instance is the instance with which to associate the -- surface.

-- --

pCreateInfo is a pointer to a -- IOSSurfaceCreateInfoMVK structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- IOSSurfaceCreateInfoMVK structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

instance is the instance to associate the surface -- with.

-- --

pCreateInfo is a pointer to a -- XlibSurfaceCreateInfoKHR structure containing the parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- XlibSurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

queueFamilyIndex is the queue family index.
dpy is a pointer to an Xlib Display connection to -- the server.
visualId is an X11 visual (VisualID).

-- --

Description

-- -- This platform-specific function can be called prior to creating -- a surface. -- --

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

instance is the instance to associate the surface -- with.

-- --

pCreateInfo is a pointer to a -- XcbSurfaceCreateInfoKHR structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- XcbSurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

queueFamilyIndex is the queue family index.
connection is a pointer to an xcb_connection_t -- to the X server.
visual_id is an X11 visual -- (xcb_visualid_t).

-- --

Description

-- -- This platform-specific function can be called prior to creating -- a surface. -- --

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

instance is the instance to associate the surface -- with.

-- --

pCreateInfo is a pointer to a -- Win32SurfaceCreateInfoKHR structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- Win32SurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

queueFamilyIndex is the queue family index.

-- --

Description

-- -- This platform-specific function can be called prior to creating -- a surface. -- --

Valid Usage (Implicit)

-- --

Description

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

Description

Parameters

-- --

instance is the instance to associate the surface -- with.

-- --

pCreateInfo is a pointer to a -- WaylandSurfaceCreateInfoKHR structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- WaylandSurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

physicalDevice is the physical device.

-- --

queueFamilyIndex is the queue family index.
display is a pointer to the wl_display -- associated with a Wayland compositor.

-- --

Description

-- -- This platform-specific function can be called prior to creating -- a surface. -- --

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to query.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- handle
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success --
- SUCCESS
- SUBOPTIMAL_KHR

-- --

Failure --

-- --

Description

-- -- The supported ImageUsageFlagBits 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: -- -- TODO: table -- -- Presentable image usage queries -- -- Note -- -- For reference, the mode indicated by 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 -- 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

Parameters

-- --

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 DisplayPropertiesKHR 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, INCOMPLETE will be -- returned instead of SUCCESS to indicate that not all the -- available values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 DisplayPropertiesKHR structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayPlanePropertiesKHR 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 -- PhysicalDevice 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 DisplayPlanePropertiesKHR -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayKHR 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, INCOMPLETE will be returned instead of -- 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 -- getPhysicalDeviceDisplayPlanePropertiesKHR

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 DisplayKHR handles

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayModePropertiesKHR 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, INCOMPLETE will be returned instead of -- SUCCESS to indicate that not all the available values were -- returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

display must be a valid DisplayKHR -- 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 DisplayModePropertiesKHR -- structures
display must have been created, allocated, or -- retrieved from physicalDevice

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayModeCreateInfoKHR -- 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.

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

display must be a valid DisplayKHR -- handle
pCreateInfo must be a valid pointer to a valid -- DisplayModeCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pMode must be a valid pointer to a -- DisplayModeKHR handle
display must have been created, allocated, or -- retrieved from physicalDevice

-- --

Host Synchronization

-- --

Host access to display must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 -- DisplayPlaneCapabilitiesKHR structure in which the capabilities -- are returned.

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

mode must be a valid DisplayModeKHR -- handle
pCapabilities must be a valid pointer to a -- DisplayPlaneCapabilitiesKHR structure

-- --

Host Synchronization

-- --

Host access to mode must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 a -- DisplaySurfaceCreateInfoKHR 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 is a pointer to a SurfaceKHR handle in -- which the created surface is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- DisplaySurfaceCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

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

-- --

If the planeReorderPossible member of the -- DisplayPropertiesKHR structure returned by -- getPhysicalDeviceDisplayPropertiesKHR for the display -- corresponding to displayMode is TRUE then -- planeStackIndex must be less than the number of -- display planes supported by the device as determined by calling -- getPhysicalDeviceDisplayPlanePropertiesKHR; otherwise -- planeStackIndex must equal the -- currentStackIndex member of DisplayPlanePropertiesKHR -- returned by getPhysicalDeviceDisplayPlanePropertiesKHR for the -- display plane corresponding to displayMode
If alphaMode is DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR -- then globalAlpha must be between 0 and -- 1, inclusive
alphaMode must be 0 or one of the bits -- present in the supportedAlpha member of -- DisplayPlaneCapabilitiesKHR returned by -- getDisplayPlaneCapabilitiesKHR for the display plane -- corresponding to displayMode
The width and height members of -- imageExtent must be less than the -- maxImageDimensions2D member of -- PhysicalDeviceLimits

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

-- --

pNext must be NULL
flags must be 0
displayMode must be a valid DisplayModeKHR -- handle
transform must be a valid -- SurfaceTransformFlagBitsKHR value
alphaMode must be a valid -- DisplayPlaneAlphaFlagBitsKHR value

-- --

Description

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

Description

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

Description

Parameters

-- --

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 DisplayProperties2KHR structures.

-- --

Description

-- -- getPhysicalDeviceDisplayProperties2KHR behaves similarly to -- getPhysicalDeviceDisplayPropertiesKHR, with the ability to -- return extended information via chained output structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 DisplayProperties2KHR structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayPlaneProperties2KHR structures.

-- --

Description

-- -- getPhysicalDeviceDisplayPlaneProperties2KHR behaves similarly -- to getPhysicalDeviceDisplayPlanePropertiesKHR, with the ability -- to return extended information via chained output structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 DisplayPlaneProperties2KHR -- structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 DisplayModeProperties2KHR structures.

-- --

Description

-- -- getDisplayModeProperties2KHR behaves similarly to -- getDisplayModePropertiesKHR, with the ability to return -- extended information via chained output structures. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

display must be a valid DisplayKHR -- 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 DisplayModeProperties2KHR -- structures
display must have been created, allocated, or -- retrieved from physicalDevice

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

physicalDevice is the physical device associated with -- pDisplayPlaneInfo.

-- --

pDisplayPlaneInfo is a pointer to a -- DisplayPlaneInfo2KHR structure describing the plane and -- mode.
pCapabilities is a pointer to a -- DisplayPlaneCapabilities2KHR structure in which the -- capabilities are returned.

-- --

Description

-- -- getDisplayPlaneCapabilities2KHR behaves similarly to -- getDisplayPlaneCapabilitiesKHR, with the ability to specify -- extended inputs via chained input structures, and to return extended -- information via chained output structures. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

-- -- Note -- -- This parameter also implicitly specifies a display. -- --

planeIndex is the plane which the application intends to -- use with the display.

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

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

-- --

pNext must be NULL
mode must be a valid DisplayModeKHR -- handle

-- --

Host Synchronization

-- --

Host access to mode must be externally -- synchronized

-- --

Description

-- -- Note -- -- For example, a 60Hz display mode would report a refreshRate -- of 60,000. -- --

Valid Usage

-- --

The width member of visibleRegion must be -- greater than 0

-- --

The height member of visibleRegion must -- be greater than 0
refreshRate must be greater than 0

-- --

Description

Parameters

-- --

device is the device which owns operation.

-- --

pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDeferredOperation is a pointer to a handle in which the -- created DeferredOperationKHR is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pDeferredOperation must be a valid pointer to a -- DeferredOperationKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the device which owns operation.

-- --

operation is the completed operation to be -- destroyed.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Valid Usage

-- --

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

-- --

If no AllocationCallbacks were provided when -- operation was created, pAllocator must be -- NULL
operation must be completed

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

operation must be a valid -- DeferredOperationKHR handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
operation must have been created, allocated, or -- retrieved from device

-- --

Parameters

-- --

device is the device which owns operation.

-- --

operation is the deferred operation to be queried.

-- -- The deferredOperationJoinKHR command will execute a portion of -- the deferred operation on the calling thread. -- -- The return value will be one of the following: -- --

A return value of SUCCESS indicates that operation -- is complete. The application should use -- getDeferredOperationResultKHR to retrieve the result of -- operation.
A return value of THREAD_DONE_KHR indicates that the -- deferred operation is not complete, but there is no work remaining to -- assign to threads. Future calls to deferredOperationJoinKHR are -- not necessary and will simply harm performance. This situation -- may occur when other threads executing -- deferredOperationJoinKHR are about to complete -- operation, and the implementation is unable to partition the -- workload any further.
A return value of THREAD_IDLE_KHR indicates that the -- deferred operation is not complete, and there is no work for the -- thread to do at the time of the call. This situation may occur -- if the operation encounters a temporary reduction in parallelism. By -- returning THREAD_IDLE_KHR, the implementation is signaling that -- it expects that more opportunities for parallelism will emerge as -- execution progresses, and that future calls to -- deferredOperationJoinKHR can be beneficial. In the -- meantime, the application can perform other work on the calling -- thread.

-- -- Implementations must guarantee forward progress by enforcing -- the following invariants: -- --

If only one thread has invoked deferredOperationJoinKHR on -- a given operation, that thread must execute the operation to -- completion and return SUCCESS.
If multiple threads have concurrently invoked -- deferredOperationJoinKHR on the same operation, then at least -- one of them must complete the operation and return -- SUCCESS.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

operation must be a valid -- DeferredOperationKHR handle
operation must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success --

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

device is the logical device used for the queries.

-- --

pInitializeInfo is a pointer to a -- InitializePerformanceApiInfoINTEL structure specifying -- initialization parameters.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device used for the queries.

-- --

commandBuffer is the command buffer where the override -- takes place.

-- --

pOverrideInfo is a pointer to a -- PerformanceOverrideInfoINTEL structure selecting the parameter -- to override.

-- --

Valid Usage

-- --

pOverrideInfo must not be used with a -- PerformanceOverrideTypeINTEL that is not reported available by -- getPerformanceParameterINTEL

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pOverrideInfo must be a valid pointer to a valid -- PerformanceOverrideInfoINTEL structure
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics, compute, or transfer -- operations

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device that the performance query -- commands will be submitted to.

-- --

pAcquireInfo is a pointer to a -- PerformanceConfigurationAcquireInfoINTEL structure, specifying -- the performance configuration to acquire.
pConfiguration is a pointer to a -- PerformanceConfigurationINTEL handle in which the resulting -- configuration object is returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the device associated to the configuration -- object to release.

-- --

configuration is the configuration object to -- release.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

queue is the queue on which the configuration will be -- used.

-- --

configuration is the configuration to use.

-- --

Valid Usage (Implicit)

-- --

queue must be a valid Queue handle

-- --

configuration must be a valid -- PerformanceConfigurationINTEL handle
Both of configuration, and queue must -- have been created, allocated, or retrieved from the same -- Device

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device to query.

-- --

parameter is the parameter to query.
pValue is a pointer to a PerformanceValueINTEL -- structure in which the type and value of the parameter are -- returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- handle
pDisplayTimingProperties must be a valid pointer -- to a RefreshCycleDurationGOOGLE structure
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_DEVICE_LOST
- 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 PastPresentationTimingGOOGLE -- structures to query, as described below.
pPresentationTimings is either NULL or a pointer -- to an array of PastPresentationTimingGOOGLE 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, -- INCOMPLETE will be returned instead of SUCCESS to -- indicate that not all the available values were returned. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- 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 -- PastPresentationTimingGOOGLE structures
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Description

-- -- The results for a given swapchain and presentID are -- only returned once from getPastPresentationTimingGOOGLE. -- -- The application can use the PastPresentationTimingGOOGLE -- values to occasionally adjust its timing. For example, if -- actualPresentTime is later than expected (e.g. one -- refreshDuration late), the application may increase its -- target IPD to a higher multiple of refreshDuration (e.g. -- decrease its frame rate from 60Hz to 30Hz). If -- actualPresentTime and earliestPresentTime are -- consistently different, and if presentMargin is consistently -- large enough, the application may decrease its target IPD to a smaller -- multiple of refreshDuration (e.g. increase its frame rate -- from 30Hz to 60Hz). If actualPresentTime and -- earliestPresentTime are same, and if presentMargin -- is consistently high, the application may delay the start of its -- input-render-present loop in order to decrease the latency between -- user input and the corresponding present (always leaving some margin -- in case a new image takes longer to render than the previous image). -- An application that desires its target IPD to always be the same as -- refreshDuration, can also adjust features until -- actualPresentTime is never late and presentMargin is -- satisfactory. -- --

Description

Parameters

-- --

instance is the instance to associate with the -- surface.

-- --

pCreateInfo is a pointer to a -- StreamDescriptorSurfaceCreateInfoGGP structure containing -- parameters that affect the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- StreamDescriptorSurfaceCreateInfoGGP structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

instance is the instance to associate with the -- surface.

-- --

pCreateInfo is a pointer to a -- ImagePipeSurfaceCreateInfoFUCHSIA structure containing -- parameters affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- ImagePipeSurfaceCreateInfoFUCHSIA structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- ValidationCacheCreateInfoEXT structure containing the initial -- parameters for the validation cache object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pValidationCache is a pointer to a -- ValidationCacheEXT handle in which the resulting validation -- cache object is returned.

-- --

Description

-- -- Note -- -- Applications can track and manage the total host memory size of -- a validation cache object using the pAllocator. Applications -- can limit the amount of data retrieved from a validation cache -- object in getValidationCacheDataEXT. Implementations -- should not internally limit the total number of entries added -- to a validation cache object or the total host memory consumed. -- -- Once created, a validation cache can be passed to the -- createShaderModule command by adding this object to the -- ShaderModuleCreateInfo structure’s pNext chain. If a -- ShaderModuleValidationCacheCreateInfoEXT object is included in -- the ShaderModuleCreateInfo::pNext chain, and its -- validationCache field is not NULL_HANDLE, the -- implementation will query it for possible reuse opportunities and -- update it with new content. The use of the validation cache object in -- these commands is internally synchronized, and the same validation -- cache object can be used in multiple threads simultaneously. -- -- Note -- -- Implementations should make every effort to limit any critical -- sections to the actual accesses to the cache, which is expected to be -- significantly shorter than the duration of the -- createShaderModule command. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- ValidationCacheCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pValidationCache must be a valid pointer to a -- ValidationCacheEXT handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

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

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If validationCache is not NULL_HANDLE, -- validationCache must be a valid -- ValidationCacheEXT handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 -- getValidationCacheDataEXT will return INCOMPLETE. Any -- data written to pData is valid and can be provided as -- the pInitialData member of the -- ValidationCacheCreateInfoEXT structure passed to -- createValidationCacheEXT. -- -- Two calls to getValidationCacheDataEXT 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: -- -- TODO: table -- -- Layout for validation cache header version -- 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 ValidationCacheHeaderVersionEXT. 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 Device handle

-- --

validationCache must be a valid -- ValidationCacheEXT 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 --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 a pointer to 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 Device handle

-- --

dstCache must be a valid ValidationCacheEXT -- handle
pSrcCaches must be a valid pointer to an array of -- srcCacheCount valid ValidationCacheEXT 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
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

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

Parameters

-- --

instance is the instance with which to associate the -- surface.

-- --

pCreateInfo is a pointer to a -- MetalSurfaceCreateInfoEXT structure specifying parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- MetalSurfaceCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

Parameters

-- --

instance is the instance to associate the surface -- with.

-- --

pCreateInfo is a pointer to a -- HeadlessSurfaceCreateInfoEXT structure containing parameters -- affecting the creation of the surface object.
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 is a pointer to a SurfaceKHR handle in -- which the created surface object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- HeadlessSurfaceCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSurface must be a valid pointer to a -- SurfaceKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

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 an array of -- swapchainCount SwapchainKHR handles.
pMetadata is a pointer to an array of -- swapchainCount HdrMetadataEXT structures.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pSwapchains must be a valid pointer to an array of -- swapchainCount valid SwapchainKHR handles
pMetadata must be a valid pointer to an array of -- swapchainCount valid HdrMetadataEXT 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 -- Instance

-- --

Description

Parameters

-- --

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

-- --

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

-- --

Description

-- -- getPhysicalDeviceSurfaceCapabilities2EXT behaves similarly to -- getPhysicalDeviceSurfaceCapabilitiesKHR, 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 -- PhysicalDevice handle

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Members

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

Valid Usage (Implicit)

-- --

Description

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

Description

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 SurfaceKHR 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 SwapchainKHR objects created for surface -- must have been destroyed prior to destroying -- surface

-- --

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

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

If surface is not NULL_HANDLE, surface -- must be a valid SurfaceKHR handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 Bool32, which is set -- to TRUE to indicate support, and FALSE otherwise.

-- --

Valid Usage

-- --

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

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

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

-- --

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 SurfaceFormatKHR structures.

-- --

Description

-- -- If pSurfaceFormats is NULL, then the number of -- format pairs supported for the given surface is returned in -- pSurfaceFormatCount. 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, -- INCOMPLETE will be returned instead of SUCCESS to -- indicate that not all the available values were returned. -- -- The number of format pairs supported must be greater than or -- equal to 1. pSurfaceFormats must not contain an entry -- whose value for format is FORMAT_UNDEFINED. -- -- If pSurfaceFormats includes an entry whose value for -- colorSpace is COLOR_SPACE_SRGB_NONLINEAR_KHR and whose -- value for format is a UNORM (or SRGB) format and the -- corresponding SRGB (or UNORM) format is a color renderable format for -- IMAGE_TILING_OPTIMAL, then pSurfaceFormats must -- also contain an entry with the same value for colorSpace and -- format equal to the corresponding SRGB (or UNORM) format. -- --

Valid Usage

-- --

surface must be supported by -- physicalDevice, as reported by -- getPhysicalDeviceSurfaceSupportKHR or an equivalent -- platform-specific mechanism

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

surface must be a valid SurfaceKHR -- 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 SurfaceFormatKHR structures
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- Instance

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Parameters

-- --

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

-- --

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 PresentModeKHR 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, -- INCOMPLETE will be returned instead of SUCCESS to -- indicate that not all the available values were returned. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

surface must be a valid SurfaceKHR -- 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 PresentModeKHR values
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- Instance

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

device must be a valid Device handle

-- --

display must be a valid DisplayKHR -- handle
pDisplayPowerInfo must be a valid pointer to a -- valid DisplayPowerInfoEXT structure
Both of device, and display must have -- been created, allocated, or retrieved from the same -- PhysicalDevice

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Parameters

-- --

device is a logical device on which the event may -- occur.

-- --

pDeviceEventInfo is a pointer to a -- DeviceEventInfoEXT structure describing the event of interest -- to the application.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFence is a pointer to a handle in which the resulting -- fence object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pDeviceEventInfo must be a valid pointer to a -- valid DeviceEventInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pFence must be a valid pointer to a Fence -- handle

-- --

Return Codes

-- --

Success
- 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 a -- DisplayEventInfoEXT structure describing the event of interest -- to the application.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFence is a pointer to a handle in which the resulting -- fence object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

display must be a valid DisplayKHR -- handle
pDisplayEventInfo must be a valid pointer to a -- valid DisplayEventInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pFence must be a valid pointer to a Fence -- handle
Both of device, and display must have -- been created, allocated, or retrieved from the same -- PhysicalDevice

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Parameters

-- --

device is the Device 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 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 Device handle

-- --

swapchain must be a valid SwapchainKHR -- handle
counter must be a valid -- SurfaceCounterFlagBitsEXT 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 -- Instance

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_DEVICE_LOST
- ERROR_OUT_OF_DATE_KHR

-- --

Description

Parameters

-- --

physicalDevice The physical device the display is -- on.

-- --

display The display to release control of.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Parameters

-- --

device is the device that created the object.

-- --

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

-- --

Valid Usage

-- --

pNameInfo->objectType must not be -- OBJECT_TYPE_UNKNOWN

-- --

pNameInfo->objectHandle must not be -- NULL_HANDLE

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

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

-- --

Host Synchronization

-- --

Host access to pNameInfo->objectHandle must be -- externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the device that created the object.

-- --

pTagInfo is a pointer to a -- DebugUtilsObjectTagInfoEXT structure specifying parameters of -- the tag to attach to the object.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pLabelInfo is a pointer to a DebugUtilsLabelEXT -- structure specifying parameters of the label region to open.

-- --

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

-- --

pLabelInfo is a pointer to a DebugUtilsLabelEXT -- structure specifying parameters of the label to insert.

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pLabelInfo is a pointer to a DebugUtilsLabelEXT -- structure specifying parameters of the label region to open.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pInfo is a pointer to a DebugUtilsLabelEXT -- structure specifying parameters of the label to insert.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- DebugUtilsMessengerCreateInfoEXT structure containing the -- callback pointer, as well as defining 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 a -- DebugUtilsMessengerEXT handle in which the created object is -- returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- DebugUtilsMessengerCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pMessenger must be a valid pointer to a -- DebugUtilsMessengerEXT handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY

-- -- The application must ensure that -- createDebugUtilsMessengerEXT is not executed in parallel with -- any Vulkan command that is also called with instance or child -- of instance as the dispatchable argument. -- --

Parameters

-- --

instance is the instance where the callback was -- created.

-- --

messenger is the DebugUtilsMessengerEXT 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 destroyDebugUtilsMessengerEXT must not be called -- when a callback is active.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

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

-- --

Host Synchronization

-- --

Host access to messenger must be externally -- synchronized

-- -- The application must ensure that -- destroyDebugUtilsMessengerEXT is not executed in parallel with -- any Vulkan command that is also called with instance or child -- of instance as the dispatchable argument. -- --

Parameters

-- --

instance is the debug stream’s Instance.

-- --

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

-- --

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 messenger was registered. -- --

Valid Usage

-- --

The objectType member of each element of -- pCallbackData->pObjects must not be -- OBJECT_TYPE_UNKNOWN

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

messageSeverity must be a valid -- DebugUtilsMessageSeverityFlagBitsEXT value
messageTypes must be a valid combination of -- DebugUtilsMessageTypeFlagBitsEXT values
messageTypes must not be 0
pCallbackData must be a valid pointer to a valid -- DebugUtilsMessengerCallbackDataEXT structure

-- --

Description

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

Valid Usage

-- --

If objectType is OBJECT_TYPE_UNKNOWN, -- objectHandle must not be NULL_HANDLE

-- --

If objectType is not OBJECT_TYPE_UNKNOWN, -- objectHandle must be NULL_HANDLE or a valid -- Vulkan handle of the type associated with objectType as -- defined in the VkObjectType and Vulkan Handle Relationship -- table

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT

-- --

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

-- --

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

-- --

messageTypes is a bitmask of -- DebugUtilsMessageTypeFlagBitsEXT specifying which type of -- event(s) triggered this callback.
pCallbackData contains all the callback related data in -- the DebugUtilsMessengerCallbackDataEXT structure.
pUserData is the user data provided when the -- DebugUtilsMessengerEXT was created.

-- --

Description

-- -- The callback must not call -- destroyDebugUtilsMessengerEXT. -- -- The callback returns a Bool32, which is interpreted in a -- layer-specified manner. The application should always return -- FALSE. The TRUE value is reserved for use in layer -- development. -- --

Description

Parameters

-- --

instance is the instance the callback will be logged -- on.

-- --

pCreateInfo is a pointer to a -- DebugReportCallbackCreateInfoEXT structure defining the -- conditions under which this callback will be called.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pCallback is a pointer to a DebugReportCallbackEXT -- handle in which the created object is returned.

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

pCreateInfo must be a valid pointer to a valid -- DebugReportCallbackCreateInfoEXT structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pCallback must be a valid pointer to a -- DebugReportCallbackEXT handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

instance is the instance where the callback was -- created.

-- --

callback is the DebugReportCallbackEXT 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 destroyDebugReportCallbackEXT must not be called -- when a callback is active.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

callback must be a valid -- DebugReportCallbackEXT handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 Instance.

-- --

flags specifies the DebugReportFlagBitsEXT -- classification of this event/message.
objectType is a DebugReportObjectTypeEXT -- 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. -- object can be 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

Valid Usage

-- --

object must be a Vulkan object or -- NULL_HANDLE

-- --

If objectType is not -- DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object is not -- NULL_HANDLE, object must be a Vulkan object of -- the corresponding type associated with objectType as defined -- in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#debug-report-object-types

-- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- handle

-- --

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

-- --

Description

-- --

device must be a valid Device handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the device that created the object.

-- --

pTagInfo is a pointer to a -- DebugMarkerObjectTagInfoEXT structure specifying the parameters -- of the tag to attach to the object.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pMarkerInfo is a pointer to a -- DebugMarkerMarkerInfoEXT structure specifying the parameters of -- the marker region to open.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pMarkerInfo is a pointer to a -- DebugMarkerMarkerInfoEXT structure specifying the parameters of -- the marker to insert.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

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

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Description

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

Valid Usage (Implicit)

-- --

Description

Valid Usage (Implicit)

-- --

Description

Parameters

-- --

physicalDevice The physical device the display is -- on.

-- --

dpy A connection to the X11 server that currently owns -- display.
display The display the caller wishes to control in -- Vulkan.

-- --

Description

-- -- All permissions necessary to control the display are granted to the -- Vulkan instance associated with physicalDevice until the -- display is released or the X11 connection specified by dpy is -- terminated. Permission to access the display may be temporarily -- revoked during periods when the X11 server from which control was -- acquired itself loses access to display. During such periods, -- operations which require access to the display must fail with -- an approriate error code. If the X11 server associated with -- dpy does not own display, or if permission to access -- it has already been acquired by another entity, the call must -- return the error code ERROR_INITIALIZATION_FAILED. -- -- Note -- -- One example of when an X11 server loses access to a display is when it -- loses ownership of its virtual terminal. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_INITIALIZATION_FAILED

-- --

Parameters

-- --

physicalDevice The physical device to query the display -- handle on.

-- --

dpy A connection to the X11 server from which -- rrOutput was queried.
rrOutput An X11 RandR output ID.
pDisplay The corresponding DisplayKHR handle will -- be returned here.

-- --

Description

-- -- If there is no DisplayKHR corresponding to rrOutput on -- physicalDevice, NULL_HANDLE must be returned in -- pDisplay. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Parameters

-- --

device is the device associated with -- swapChain.

-- --

swapChain handle to enable local dimming.
localDimmingEnable specifies whether local dimming is -- enabled for the swapchain.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapChain must be a valid SwapchainKHR -- handle
Both of device, and swapChain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Valid Usage

-- --

It is only valid to call setLocalDimmingAMD if -- DisplayNativeHdrSurfaceCapabilitiesAMD::localDimmingSupport -- is supported

Parameters

-- --

device is the logical device that creates the descriptor -- update template.

-- --

pCreateInfo is a pointer to a -- DescriptorUpdateTemplateCreateInfo structure specifying the set -- of descriptors to update with a single call to -- cmdPushDescriptorSetWithTemplateKHR or -- updateDescriptorSetWithTemplate.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDescriptorUpdateTemplate is a pointer to a -- DescriptorUpdateTemplate handle in which the resulting -- descriptor update template object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- DescriptorUpdateTemplateCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pDescriptorUpdateTemplate must be a valid pointer -- to a DescriptorUpdateTemplate handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

If no AllocationCallbacks were provided when -- descriptorSetLayout was created, pAllocator -- must be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If descriptorUpdateTemplate is not NULL_HANDLE, -- descriptorUpdateTemplate must be a valid -- DescriptorUpdateTemplate handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 a -- DescriptorUpdateTemplate object specifying the update mapping -- between pData and the descriptor set to update.
pData is a pointer to memory containing one or more -- DescriptorImageInfo, DescriptorBufferInfo, or -- BufferView structures used to write the descriptors.

-- --

Valid Usage

-- --

pData must be a valid pointer to a memory -- containing one or more valid instances of DescriptorImageInfo, -- DescriptorBufferInfo, or BufferView in a layout defined -- by descriptorUpdateTemplate when it was created with -- createDescriptorUpdateTemplate

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

descriptorSet must be a valid DescriptorSet -- handle
descriptorUpdateTemplate must be a valid -- DescriptorUpdateTemplate 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
--       {
--           1,                                           // 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
--       {
--           2,                                           // binding
--           0,                                           // dstArrayElement
--           2,                                           // descriptorCount
--           VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER,     // descriptorType
--           offsetof(AppDataStructure, bufferView) +
--             offsetof(AppBufferView, bufferView),       // offset
--           sizeof(AppBufferView)                        // stride, bufferViews do not have to be compact
--       },
--   };
--   
--   // create a 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);
--

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- PipelineLayoutCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelineLayout must be a valid pointer to a -- PipelineLayout handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

If no AllocationCallbacks were provided when -- pipelineLayout was created, pAllocator must -- be NULL
pipelineLayout must not have been passed to any -- vkCmd* command for any command buffers that are still in the -- recording state when destroyPipelineLayout is -- called

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineLayout is not NULL_HANDLE, -- pipelineLayout must be a valid PipelineLayout -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- PipelineCacheCreateInfo structure containing initial parameters -- for the pipeline cache object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelineCache is a pointer to a PipelineCache -- handle in which the resulting pipeline cache object is returned.

-- --

Description

-- -- Note -- -- Applications can track and manage the total host memory size of -- a pipeline cache object using the pAllocator. Applications -- can limit the amount of data retrieved from a pipeline cache -- object in getPipelineCacheData. Implementations should -- not internally limit the total number of entries added to a pipeline -- cache object or the total host memory consumed. -- -- Once created, a pipeline cache can be passed to the -- createGraphicsPipelines createRayTracingPipelinesKHR, -- createRayTracingPipelinesNV, and createComputePipelines -- commands. If the pipeline cache passed into these commands is not -- NULL_HANDLE, the implementation will query it for possible -- reuse opportunities and update it with new content. The use of the -- pipeline cache object in these commands is internally synchronized, -- and the same pipeline cache object can be used in multiple -- threads simultaneously. -- -- If flags of pCreateInfo includes -- PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, all -- commands that modify the returned pipeline cache object must be -- externally synchronized. -- -- Note -- -- Implementations should make every effort to limit any critical -- sections to the actual accesses to the cache, which is expected to be -- significantly shorter than the duration of the -- vkCreate*Pipelines commands. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- PipelineCacheCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelineCache must be a valid pointer to a -- PipelineCache handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineCache is not NULL_HANDLE, -- pipelineCache must be a valid PipelineCache -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 size_t 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 getPipelineCacheData will -- return INCOMPLETE. Any data written to pData is valid -- and can be provided as the pInitialData member of the -- PipelineCacheCreateInfo structure passed to -- createPipelineCache. -- -- Two calls to getPipelineCacheData 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: -- -- TODO: table -- -- Layout for pipeline cache header version -- 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 PipelineCacheHeaderVersion. 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 Device handle

-- --

pipelineCache must be a valid PipelineCache -- 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 --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 a pointer to 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 Device handle

-- --

dstCache must be a valid PipelineCache -- handle
pSrcCaches must be a valid pointer to an array of -- srcCacheCount valid PipelineCache 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
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that owns the buffer.

-- --

buffer is the buffer to query.
pMemoryRequirements is a pointer to a -- MemoryRequirements structure in which the memory requirements -- of the buffer object are returned.

-- --

Valid Usage

-- --

If buffer was created with the -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- external memory handle type, then buffer must be bound -- to memory.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

buffer must be a valid Buffer handle
pMemoryRequirements must be a valid pointer to a -- MemoryRequirements structure
buffer must have been created, allocated, or -- retrieved from device

-- --

Parameters

-- --

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

-- --

buffer is the buffer to be attached to memory.
memory is a DeviceMemory 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 MemoryRequirements::size member -- in memory, starting from memoryOffset bytes, will be -- bound to the specified buffer.

-- --

Description

-- -- bindBufferMemory is equivalent to passing the same parameters -- through BindBufferMemoryInfo to bindBufferMemory2. -- --

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
memory must have been allocated using one of the -- memory types allowed in the memoryTypeBits member of the -- MemoryRequirements structure returned from a call to -- getBufferMemoryRequirements with buffer
memoryOffset must be an integer multiple of the -- alignment member of the MemoryRequirements structure -- returned from a call to getBufferMemoryRequirements with -- buffer
The size member of the MemoryRequirements -- structure returned from a call to getBufferMemoryRequirements -- with buffer must be less than or equal to the size of -- memory minus memoryOffset
If buffer requires a dedicated allocation(as reported by -- getBufferMemoryRequirements2 in -- MemoryDedicatedRequirements::requiresDedicatedAllocation for -- buffer), memory must have been created with -- MemoryDedicatedAllocateInfo::buffer equal to -- buffer
If the MemoryAllocateInfo provided when memory was -- allocated included a MemoryDedicatedAllocateInfo structure in -- its pNext chain, and -- MemoryDedicatedAllocateInfo::buffer was not -- NULL_HANDLE, then buffer must equal -- MemoryDedicatedAllocateInfo::buffer, and -- memoryOffset must be zero
If buffer was created with the BUFFER_CREATE_PROTECTED_BIT -- bit set, the buffer must be bound to a memory object allocated -- with a memory type that reports -- MEMORY_PROPERTY_PROTECTED_BIT
If buffer was created with the BUFFER_CREATE_PROTECTED_BIT -- bit not set, the buffer must not be bound to a memory object -- created with a memory type that reports -- MEMORY_PROPERTY_PROTECTED_BIT
If buffer was created with -- DedicatedAllocationBufferCreateInfoNV::dedicatedAllocation -- equal to TRUE, memory must have been created -- with DedicatedAllocationMemoryAllocateInfoNV::buffer -- equal to a buffer handle created with identical creation parameters to -- buffer and memoryOffset must be zero
If the value of -- ExportMemoryAllocateInfo::handleTypes used to allocate -- memory is not 0, it must include at least one -- of the handles set in -- ExternalMemoryBufferCreateInfo::handleTypes when -- buffer was created
If memory was created by a memory import operation, that -- is not ImportAndroidHardwareBufferInfoANDROID with a -- non-NULL buffer value, the external handle type of -- the imported memory must also have been set in -- ExternalMemoryBufferCreateInfo::handleTypes when -- buffer was created
If memory was created with the -- ImportAndroidHardwareBufferInfoANDROID memory import operation -- with a non-NULL buffer value, -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- must also have been set in -- ExternalMemoryBufferCreateInfo::handleTypes when -- buffer was created
If the -- PhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddress -- feature is enabled and buffer was created with the -- BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT bit set, memory -- must have been allocated with the -- MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT bit set

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

buffer must be a valid Buffer handle
memory must be a valid DeviceMemory -- 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
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

image is the image to query.
pMemoryRequirements is a pointer to a -- MemoryRequirements structure in which the memory requirements -- of the image object are returned.

-- --

Valid Usage

-- --

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

-- --

If image was created with the -- 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 Device handle

-- --

image must be a valid Image handle
pMemoryRequirements must be a valid pointer to a -- MemoryRequirements 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 DeviceMemory 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 MemoryRequirements::size member in -- memory, starting from memoryOffset bytes, will be -- bound to the specified image.

-- --

Description

-- -- bindImageMemory is equivalent to passing the same parameters -- through BindImageMemoryInfo to bindImageMemory2. -- --

Valid Usage

-- --

image must not have been created with the -- 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 -- MemoryRequirements structure returned from a call to -- getImageMemoryRequirements with image
memoryOffset must be an integer multiple of the -- alignment member of the MemoryRequirements structure -- returned from a call to getImageMemoryRequirements with -- image
The difference of the size of memory and -- memoryOffset must be greater than or equal to the -- size member of the MemoryRequirements structure -- returned from a call to getImageMemoryRequirements with the -- same image
If image requires a dedicated allocation (as reported by -- getImageMemoryRequirements2 in -- MemoryDedicatedRequirements::requiresDedicatedAllocation for -- image), memory must have been created with -- MemoryDedicatedAllocateInfo::image equal to -- image
If the dedicated allocation image aliasing feature is not -- enabled, and the MemoryAllocateInfo provided when -- memory was allocated included a -- MemoryDedicatedAllocateInfo structure in its pNext -- chain, and MemoryDedicatedAllocateInfo::image was not -- NULL_HANDLE, then image must equal -- MemoryDedicatedAllocateInfo::image and -- memoryOffset must be zero
If the dedicated allocation image aliasing feature is -- enabled, and the MemoryAllocateInfo provided when -- memory was allocated included a -- MemoryDedicatedAllocateInfo structure in its pNext -- chain, and MemoryDedicatedAllocateInfo::image was not -- NULL_HANDLE, then memoryOffset must be zero, -- and image must be either equal to -- MemoryDedicatedAllocateInfo::image or an image that -- was created using the same parameters in ImageCreateInfo, with -- the exception that extent and arrayLayers may -- differ subject to the following restrictions: every dimension in the -- extent parameter of the image being bound must be -- equal to or smaller than the original image for which the allocation -- was created; and the arrayLayers parameter of the image being -- bound must be equal to or smaller than the original image for -- which the allocation was created
If image was created with the IMAGE_CREATE_PROTECTED_BIT -- bit set, the image must be bound to a memory object allocated -- with a memory type that reports -- MEMORY_PROPERTY_PROTECTED_BIT
If image was created with the IMAGE_CREATE_PROTECTED_BIT -- bit not set, the image must not be bound to a memory object -- created with a memory type that reports -- MEMORY_PROPERTY_PROTECTED_BIT
If image was created with -- DedicatedAllocationImageCreateInfoNV::dedicatedAllocation -- equal to TRUE, memory must have been created -- with DedicatedAllocationMemoryAllocateInfoNV::image -- equal to an image handle created with identical creation parameters to -- image and memoryOffset must be zero
If the value of -- ExportMemoryAllocateInfo::handleTypes used to allocate -- memory is not 0, it must include at least one -- of the handles set in -- ExternalMemoryImageCreateInfo::handleTypes when -- image was created
If memory was created by a memory import operation, that -- is not ImportAndroidHardwareBufferInfoANDROID with a -- non-NULL buffer value, the external handle type of -- the imported memory must also have been set in -- ExternalMemoryImageCreateInfo::handleTypes when -- image was created
If memory was created with the -- ImportAndroidHardwareBufferInfoANDROID memory import operation -- with a non-NULL buffer value, -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- must also have been set in -- ExternalMemoryImageCreateInfo::handleTypes when -- image was created

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

image must be a valid Image handle
memory must be a valid DeviceMemory -- 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
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

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 LayerProperties 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, INCOMPLETE will be returned instead of -- 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 -- enumerateInstanceLayerProperties 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 LayerProperties structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 LayerProperties 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, INCOMPLETE will be returned instead of -- SUCCESS, to indicate that not all the available layer -- properties were returned. -- -- The list of layers enumerated by enumerateDeviceLayerProperties -- must be exactly the sequence of layers enabled for the -- instance. The members of LayerProperties for each enumerated -- layer must be the same as the properties when the layer was -- enumerated by enumerateInstanceLayerProperties. -- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 LayerProperties structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the event.

-- --

pCreateInfo is a pointer to a EventCreateInfo -- structure containing information about how the event is to be -- created.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pEvent is a pointer to a handle in which the resulting -- event object is returned.

-- --

Description

-- -- When created, the event object is in the unsignaled state. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- EventCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pEvent must be a valid pointer to a Event -- handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If event is not NULL_HANDLE, event -- must be a valid Event handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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, getEventStatus returns the state of the event -- object with the following return codes: -- -- TODO: table -- -- Event Object Status Codes -- -- If a cmdSetEvent or cmdResetEvent 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 -- getEventStatus will return the new state. If an event is -- already in the requested state, then updating it to the same state has -- no effect. -- --

Return Codes

-- --

Success --
- EVENT_SET
- EVENT_RESET

-- --

Failure --

-- --

Parameters

-- --

device is the logical device that owns the event.

-- --

event is the event to set.

-- --

Description

-- -- When setEvent 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 -- setEvent is executed, then setEvent has no effect, and -- no event signal operation occurs. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

event must be a valid Event handle
event must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to event must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that owns the event.

-- --

event is the event to reset.

-- --

Description

-- -- When resetEvent 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 -- resetEvent is executed, then resetEvent has no effect, -- and no event unsignal operation occurs. -- --

Valid Usage

-- --

event must not be waited on by a -- cmdWaitEvents command that is currently executing

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

event must be a valid Event handle
event must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to event must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- CommandPoolCreateInfo structure specifying the state of the -- command pool object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pCommandPool is a pointer to a CommandPool handle -- in which the created pool is returned.

-- --

Valid Usage

-- --

pCreateInfo->queueFamilyIndex must be the index -- of a queue family available in the logical device device

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- CommandPoolCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pCommandPool must be a valid pointer to a -- CommandPool handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 CommandPool -- 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 CommandBuffer objects allocated from -- commandPool must not be in the pending -- state

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If commandPool is not NULL_HANDLE, -- commandPool must be a valid CommandPool -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 CommandPoolResetFlagBits -- 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 CommandPool -- 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 CommandBuffer objects allocated from -- commandPool must not be in the pending -- state

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

commandPool must be a valid CommandPool -- handle
flags must be a valid combination of -- CommandPoolResetFlagBits values
commandPool must have been created, allocated, or -- retrieved from device

-- --

Host Synchronization

-- --

Host access to commandPool must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the buffer -- view.

-- --

pCreateInfo is a pointer to a BufferViewCreateInfo -- structure containing parameters to be used to create the buffer.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pView is a pointer to a BufferView handle in which -- the resulting buffer view object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- BufferViewCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pView must be a valid pointer to a -- BufferView handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If bufferView is not NULL_HANDLE, -- bufferView must be a valid BufferView -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

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 ExtensionProperties 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, INCOMPLETE will be returned instead of -- SUCCESS, to indicate that not all the available properties were -- returned. -- -- Because the list of available layers may change externally between -- calls to enumerateInstanceExtensionProperties, 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. -- -- Implementations must not advertise any pair of extensions that -- cannot be enabled together due to behavioral differences, or any -- extension that cannot be enabled against the advertised version. -- --

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 ExtensionProperties structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

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 -- enumerateInstanceExtensionProperties::pPropertyCount -- parameter.
pProperties is either NULL or a pointer to an -- array of ExtensionProperties structures.

-- --

Description

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 ExtensionProperties structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

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

-- --

pSurfaceInfo is a pointer to a -- PhysicalDeviceSurfaceInfo2KHR structure describing the surface -- and other fixed parameters that would be consumed by -- createSwapchainKHR.
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 SurfaceFormat2KHR structures.

-- --

Description

-- -- getPhysicalDeviceSurfaceFormats2KHR behaves similarly to -- getPhysicalDeviceSurfaceFormatsKHR, with the ability to be -- extended via pNext chains. -- -- If pSurfaceFormats is NULL, then the number of -- format tuples supported for the given surface is returned in -- pSurfaceFormatCount. 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, INCOMPLETE will be returned instead of -- SUCCESS to indicate that not all the available values were -- returned. -- --

Valid Usage

-- --

pSurfaceInfo->surface must be supported by -- physicalDevice, as reported by -- getPhysicalDeviceSurfaceSupportKHR or an equivalent -- platform-specific mechanism

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pSurfaceInfo must be a valid pointer to a valid -- PhysicalDeviceSurfaceInfo2KHR 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 SurfaceFormat2KHR structures

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Description

-- -- The members of PhysicalDeviceSurfaceInfo2KHR correspond to the -- arguments to getPhysicalDeviceSurfaceCapabilitiesKHR, with -- sType and pNext added for extensibility. -- -- Additional capabilities of a surface may be available to -- swapchains created with different full-screen exclusive settings - -- particularly if exclusive full-screen access is application -- controlled. These additional capabilities can be queried by -- adding a SurfaceFullScreenExclusiveInfoEXT structure to the -- pNext chain of this structure when used to query surface -- properties. Additionally, for Win32 surfaces with application -- controlled exclusive full-screen access, chaining a -- SurfaceFullScreenExclusiveWin32InfoEXT structure may -- also report additional surface capabilities. These additional -- capabilities only apply to swapchains created with the same parameters -- included in the pNext chain of SwapchainCreateInfoKHR. -- --

Valid Usage

-- --

If the pNext chain includes a -- SurfaceFullScreenExclusiveInfoEXT structure with its -- fullScreenExclusive member set to -- FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and -- surface was created using createWin32SurfaceKHR, a -- SurfaceFullScreenExclusiveWin32InfoEXT structure must be -- included in the pNext chain

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_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 -- SurfaceFullScreenExclusiveInfoEXT or -- SurfaceFullScreenExclusiveWin32InfoEXT
The sType value of each struct in the pNext -- chain must be unique
surface must be a valid SurfaceKHR -- handle

-- --

Description

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

Parameters

-- --

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

-- --

pExternalSemaphoreInfo is a pointer to a -- PhysicalDeviceExternalSemaphoreInfo structure describing the -- parameters that would be consumed by createSemaphore.
pExternalSemaphoreProperties is a pointer to a -- ExternalSemaphoreProperties structure in which capabilities are -- returned.

-- --

Valid Usage (Implicit)

-- --

Description

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

Valid Usage (Implicit)

-- --

Description

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 -- bindInfoCount BindBufferMemoryInfo structures -- describing buffers and memory to bind.

-- --

Description

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

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 -- BindImageMemoryInfo structures, 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

-- --

If any BindImageMemoryInfo::image was created with -- IMAGE_CREATE_DISJOINT_BIT then all planes of -- BindImageMemoryInfo::image must be bound individually in -- separate pBindInfos

-- --

pBindInfos must not refer to the same image -- subresource more than once.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

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

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- ShaderModuleCreateInfo structure.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pShaderModule is a pointer to a ShaderModule -- handle in which the resulting shader module object is returned.

-- --

Description

-- -- Once a shader module has been created, any entry points it contains -- can be used in pipeline shader stages as described in -- Compute Pipelines and Graphics Pipelines. -- -- If the shader stage fails to compile ERROR_INVALID_SHADER_NV -- will be generated and the compile log will be reported back to the -- application by VK_EXT_debug_report if enabled. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- ShaderModuleCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pShaderModule must be a valid pointer to a -- ShaderModule handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 AllocationCallbacks were provided when -- shaderModule was created, a compatible set of callbacks -- must be provided here

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If shaderModule is not NULL_HANDLE, -- shaderModule must be a valid ShaderModule -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a SamplerCreateInfo -- structure specifying the state of the sampler object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pSampler is a pointer to a Sampler handle in which -- the resulting sampler object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- SamplerCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSampler must be a valid pointer to a -- Sampler handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If sampler is not NULL_HANDLE, sampler -- must be a valid Sampler handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

Description

-- -- Mapping of OpenGL to Vulkan filter modes -- -- magFilter values of FILTER_NEAREST and -- 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 FILTER_LINEAR and -- mipmapMode of 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 SAMPLER_MIPMAP_MODE_NEAREST, -- minLod = 0, and maxLod = 0.25, and using -- minFilter = FILTER_LINEAR or minFilter = -- 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 -- PhysicalDeviceLimits structure. If -- maxSamplerAllocationCount is exceeded, createSampler -- will return ERROR_TOO_MANY_OBJECTS. -- -- Since Sampler 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 -- PhysicalDeviceLimits::maxSamplerLodBias

-- --

maxLod must be greater than or equal to -- minLod
If the anisotropic sampling feature is not enabled, -- anisotropyEnable must be FALSE
If anisotropyEnable is TRUE, -- maxAnisotropy must be between 1.0 and -- PhysicalDeviceLimits::maxSamplerAnisotropy, -- inclusive
If sampler Y′CBCR conversion is enabled and the sampler -- Y′CBCR conversion’s features do not support -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT, -- minFilter and magFilter must be equal to the -- sampler Y′CBCR conversion’s chromaFilter
If unnormalizedCoordinates is TRUE, -- minFilter and magFilter must be equal
If unnormalizedCoordinates is TRUE, -- mipmapMode must be -- SAMPLER_MIPMAP_MODE_NEAREST
If unnormalizedCoordinates is TRUE, -- minLod and maxLod must be zero
If unnormalizedCoordinates is TRUE, -- addressModeU and addressModeV must each be -- either SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or -- SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
If unnormalizedCoordinates is TRUE, -- anisotropyEnable must be FALSE
If unnormalizedCoordinates is TRUE, -- compareEnable must be FALSE
If any of addressModeU, addressModeV or -- addressModeW are SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, -- borderColor must be a valid BorderColor -- value
If sampler Y′CBCR conversion is enabled, -- addressModeU, addressModeV, and -- addressModeW must be -- SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, anisotropyEnable -- must be FALSE, and unnormalizedCoordinates -- must be FALSE
The sampler reduction mode must be set to -- SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE if sampler Y′CBCR -- conversion is enabled
If samplerMirrorClampToEdge is not enabled, and if the -- VK_KHR_sampler_mirror_clamp_to_edge extension is not enabled, -- addressModeU, addressModeV and addressModeW -- must not be -- SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE
If compareEnable is TRUE, compareOp -- must be a valid CompareOp value
If either magFilter or minFilter is -- FILTER_CUBIC_EXT, anisotropyEnable must be -- FALSE
If compareEnable is TRUE, the -- reductionMode member of SamplerReductionModeCreateInfo -- must be SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minFilter and -- magFilter must be equal
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then mipmapMode -- must be SAMPLER_MIPMAP_MODE_NEAREST
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then minLod and -- maxLod must be zero
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then addressModeU -- and addressModeV must each be either -- SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or -- SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then -- anisotropyEnable must be FALSE
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then compareEnable -- must be FALSE
If flags includes -- SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, then -- unnormalizedCoordinates must be FALSE

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 SamplerReductionModeCreateInfo -- or SamplerYcbcrConversionInfo
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- SamplerCreateFlagBits values
magFilter must be a valid Filter value
minFilter must be a valid Filter value
mipmapMode must be a valid -- SamplerMipmapMode value
addressModeU must be a valid -- SamplerAddressMode value
addressModeV must be a valid -- SamplerAddressMode value
addressModeW must be a valid -- SamplerAddressMode value

-- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- SemaphoreCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSemaphore must be a valid pointer to a -- Semaphore handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If semaphore is not NULL_HANDLE, -- semaphore must be a valid Semaphore handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

Parameters

-- --

device is the logical device that owns the queue.

-- --

queueFamilyIndex is the index of the queue family to -- which the queue belongs.
queueIndex is the index within this queue family of the -- queue to retrieve.
pQueue is a pointer to a Queue object that will be -- filled with the handle for the requested queue.

-- --

Description

-- -- getDeviceQueue must only be used to get queues that were -- created with the flags parameter of -- DeviceQueueCreateInfo set to zero. To get queues that were -- created with a non-zero flags parameter use -- getDeviceQueue2. -- --

Valid Usage

-- --

queueFamilyIndex must be one of the queue family -- indices specified when device was created, via the -- DeviceQueueCreateInfo structure

-- --

queueIndex must be less than the number of queues -- created for the specified queue family index when device was -- created, via the queueCount member of the -- DeviceQueueCreateInfo structure
DeviceQueueCreateInfo::flags must have been -- set to zero when device was created

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pQueue must be a valid pointer to a Queue -- 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 SubmitInfo -- 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 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 -- queueSubmit as possible. -- -- queueSubmit is a queue submission command, with each -- batch defined by an element of pSubmits. Batches begin -- execution in the order they appear in pSubmits, but -- may complete out of order. -- -- Fence and semaphore operations submitted with queueSubmit 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 -- COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag, it instead moves -- to the invalid state. -- -- If queueSubmit fails, it may return -- ERROR_OUT_OF_HOST_MEMORY or 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 -- queueSubmit fails in such a way that the implementation is -- unable to make that guarantee, the implementation must return -- ERROR_DEVICE_LOST. See Lost Device. -- --

Valid Usage

-- --

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

-- --

If fence is not NULL_HANDLE, fence -- must not be associated with any other queue command that has -- not yet completed execution on that queue
Any calls to cmdSetEvent, cmdResetEvent or -- cmdWaitEvents that have been recorded into any of the command -- buffer elements of the pCommandBuffers member of any element -- of pSubmits, must not reference any Event 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 wait operation referring to a binary semaphore -- defined by any element of the pWaitSemaphores member of any -- element of pSubmits executes on queue, there -- must be no other queues waiting on the same semaphore
All elements of the pWaitSemaphores member of all -- elements of pSubmits created with a SemaphoreType of -- SEMAPHORE_TYPE_BINARY must reference a semaphore signal -- operation that has been submitted for execution and any semaphore -- signal operations on which it depends (if any) must have also -- been 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 -- 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 -- 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 -- CommandPool that was created for the same queue family -- queue belongs to
If any element of pSubmits->pCommandBuffers includes a -- Queue Family Transfer Acquire Operation, there must -- exist a previously submitted Queue Family Transfer Release -- Operation on a queue in the queue family identified by the acquire -- operation, with parameters matching the acquire operation as defined -- in the definition of such acquire operations, and which -- happens-before the acquire operation
If a command recorded into any element of pCommandBuffers -- was a cmdBeginQuery whose queryPool was created with a -- queryType of QUERY_TYPE_PERFORMANCE_QUERY_KHR, the -- profiling lock must have been held continuously on the -- Device that queue was retrieved from, throughout -- recording of those command buffers
Any resource created with SHARING_MODE_EXCLUSIVE that is -- read by an operation specified by pSubmits must not be -- owned by any queue family other than the one which queue -- belongs to, at the time it is executed

-- --

Valid Usage (Implicit)

-- --

queue must be a valid Queue handle

-- --

If submitCount is not 0, pSubmits -- must be a valid pointer to an array of submitCount -- valid SubmitInfo structures
If fence is not NULL_HANDLE, fence -- must be a valid Fence handle
Both of fence, and queue that are valid handles -- of non-ignored parameters must have been created, allocated, or -- retrieved from the same Device

-- --

Host Synchronization

-- --

Host access to queue must be externally -- synchronized

-- --

Host access to fence must be externally -- synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

queue is the queue on which to wait.

-- --

sType must be -- 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 D3D12FenceSubmitInfoKHR, -- DeviceGroupSubmitInfo, PerformanceQuerySubmitInfoKHR, -- ProtectedSubmitInfo, TimelineSemaphoreSubmitInfo, -- Win32KeyedMutexAcquireReleaseInfoKHR, or -- Win32KeyedMutexAcquireReleaseInfoNV
The sType value of each struct in the pNext -- chain must be unique
If waitSemaphoreCount is not 0, -- pWaitSemaphores must be a valid pointer to an array of -- waitSemaphoreCount valid Semaphore handles
If waitSemaphoreCount is not 0, -- pWaitDstStageMask must be a valid pointer to an array -- of waitSemaphoreCount valid combinations of -- PipelineStageFlagBits 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 CommandBuffer handles
If signalSemaphoreCount is not 0, -- pSignalSemaphores must be a valid pointer to an array -- of signalSemaphoreCount valid Semaphore handles
Each of the elements of pCommandBuffers, the elements of -- pSignalSemaphores, and the elements of -- pWaitSemaphores that are valid handles of non-ignored -- parameters must have been created, allocated, or retrieved from -- the same Device

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a QueryPoolCreateInfo -- 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 QueryPool handle in -- which the resulting query pool object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- QueryPoolCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pQueryPool must be a valid pointer to a -- QueryPool handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If queryPool is not NULL_HANDLE, -- queryPool must be a valid QueryPool handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 to read.
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 QueryResultFlagBits -- specifying how and when results are returned.

-- --

Description

-- -- The range of queries read is defined by [firstQuery, -- firstQuery + queryCount - 1]. For pipeline -- statistics queries, each query index in the pool contains one integer -- value for each bit that is enabled in -- QueryPoolCreateInfo::pipelineStatistics when the pool -- is created. -- -- 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 QUERY_RESULT_64_BIT is not set and the result overflows a -- 32-bit value, the value may either wrap or saturate. Similarly, -- if QUERY_RESULT_64_BIT is set and the result overflows a 64-bit -- value, the value may either wrap or saturate. -- -- If 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, getQueryPoolResults is -- guaranteed to succeed and return 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 getQueryPoolResults may not return in -- finite time. -- -- If QUERY_RESULT_WAIT_BIT and 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 getQueryPoolResults returns NOT_READY. However, -- availability state is still written to pData for those -- queries if QUERY_RESULT_WITH_AVAILABILITY_BIT is set. -- -- Note -- -- Applications must take care to ensure that use of the -- 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 cmdResetQueryPool, cmdBeginQuery, -- and cmdEndQuery for that query, then the query will remain in -- the available state until resetQueryPool is called or the -- cmdResetQueryPool 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 QUERY_RESULT_WAIT_BIT is used in -- combination with QUERY_RESULT_WITH_AVAILABILITY_BIT. In this -- case, the returned availability status may reflect the result -- of a previous use of the query unless resetQueryPool is called -- or the cmdResetQueryPool 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 QUERY_RESULT_PARTIAL_BIT is set, -- 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. -- -- If 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 -- 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 QUERY_RESULT_64_BIT is not set in flags, then -- pData and stride must be multiples of -- 4
If QUERY_RESULT_64_BIT is not set in flags and the -- queryType used to create queryPool was not -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, then pData and -- stride must be multiples of 4
If QUERY_RESULT_64_BIT is set in flags then -- pData and stride must be multiples of -- 8
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, then pData and -- stride must be multiples of the size of -- PerformanceCounterResultKHR
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 -- QUERY_TYPE_TIMESTAMP, flags must not contain -- QUERY_RESULT_PARTIAL_BIT
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, flags must -- not contain QUERY_RESULT_WITH_AVAILABILITY_BIT, -- QUERY_RESULT_PARTIAL_BIT or QUERY_RESULT_64_BIT
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, the queryPool -- must have been recorded once for each pass as retrieved via a -- call to -- getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

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

-- --

Return Codes

-- --

Success --
- SUCCESS
- NOT_READY

-- --

Failure --

-- --

Description

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

Valid Usage

-- --

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

-- --

If queryType is QUERY_TYPE_PIPELINE_STATISTICS, -- pipelineStatistics must be a valid combination of -- QueryPipelineStatisticFlagBits values
If queryType is QUERY_TYPE_PERFORMANCE_QUERY_KHR, -- the pNext chain must include a structure of type -- QueryPoolPerformanceCreateInfoKHR
queryCount must be greater than 0

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_QUERY_POOL_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 -- QueryPoolPerformanceCreateInfoKHR or -- QueryPoolPerformanceQueryCreateInfoINTEL
The sType value of each struct in the pNext -- chain must be unique
flags must be 0
queryType must be a valid QueryType -- value

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a -- FramebufferCreateInfo structure describing additional -- information about framebuffer creation.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFramebuffer is a pointer to a Framebuffer handle -- in which the resulting framebuffer object is returned.

-- --

Valid Usage

-- --

If pCreateInfo->flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, and attachmentCount -- is not 0, each element of -- pCreateInfo->pAttachments must have been created on -- device

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- FramebufferCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pFramebuffer must be a valid pointer to a -- Framebuffer handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If framebuffer is not NULL_HANDLE, -- framebuffer must be a valid Framebuffer -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 a RenderPassCreateInfo -- structure describing the parameters of the render pass.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pRenderPass is a pointer to a RenderPass handle in -- which the resulting render pass object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- RenderPassCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pRenderPass must be a valid pointer to a -- RenderPass handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If renderPass is not NULL_HANDLE, -- renderPass must be a valid RenderPass -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 is a pointer to a Extent2D 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 Extent2D (the -- horizontal granularity).
the offset.y member in renderArea is a multiple -- of the height of the returned Extent2D (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 RenderPassBeginInfo.
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 -- RenderPassBeginInfo.

-- -- 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 Device handle

-- --

renderPass must be a valid RenderPass -- handle
pGranularity must be a valid pointer to a -- Extent2D 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 -- PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT pipeline stage. Load -- operations for attachments with a color format execute in the -- 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 -- PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT pipeline stage. Store -- operations for attachments with a color format execute in the -- 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 -- 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. -- -- If a render pass uses multiple attachments that alias the same device -- memory, those attachments must each include the -- ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT bit in their attachment -- description flags. Attachments aliasing the same memory occurs in -- multiple ways: -- --

Multiple attachments being assigned the same image view as part of -- framebuffer creation.
Attachments using distinct image views that correspond to the same -- image subresource of an image.
Attachments using views of distinct image subresources which are -- bound to overlapping memory ranges.

-- -- Note -- -- Render passes must include subpass dependencies (either -- directly or via a subpass dependency chain) between any two subpasses -- that operate on the same attachment or aliasing attachments and those -- subpass dependencies must include execution and memory -- dependencies separating uses of the aliases, if at least one of those -- subpasses writes to one of the aliases. These dependencies must -- not include the DEPENDENCY_BY_REGION_BIT if the aliases are -- views of distinct image subresources which overlap in memory. -- -- Multiple attachments that alias the same memory must not be -- used in a single subpass. A given attachment index must not be -- used multiple times in a single subpass, with one exception: two -- subpass attachments can use the same attachment index if at -- least one use is as an input attachment and neither use is as a -- resolve or preserve attachment. In other words, the same view -- can be used simultaneously as an input and color or -- depth/stencil attachment, but must not be used as multiple -- color or depth/stencil attachments nor as resolve or preserve -- attachments. The precise set of valid scenarios is described in more -- detail below. -- -- If a set of attachments alias each other, then all except the first to -- be used in the render pass must use an initialLayout -- of IMAGE_LAYOUT_UNDEFINED, since the earlier uses of the other -- aliases make their contents undefined. Once an alias has been used and -- a different alias has been used after it, the first alias must -- not be used in any later subpasses. However, an application can -- assign the same image view to multiple aliasing attachment indices, -- which allows that image view to be used multiple times even if other -- aliases are used in between. -- -- Note -- -- Once an attachment needs the -- ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT bit, there should -- be no additional cost of introducing additional aliases, and using -- these additional aliases may allow more efficient clearing of -- the attachments on multiple uses via ATTACHMENT_LOAD_OP_CLEAR. -- --

Valid Usage

-- --

finalLayout must not be -- IMAGE_LAYOUT_UNDEFINED or -- IMAGE_LAYOUT_PREINITIALIZED

-- --

If format is a color format, initialLayout -- must not be -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If format is a depth/stencil format, -- initialLayout must not be -- IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
If format is a color format, finalLayout -- must not be -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If format is a depth/stencil format, finalLayout -- must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
If the separateDepthStencilLayouts feature is not enabled, -- initialLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If the separateDepthStencilLayouts feature is not enabled, -- finalLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a color format, initialLayout -- must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a color format, finalLayout -- must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes both -- depth and stencil aspects, initialLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes both -- depth and stencil aspects, finalLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only -- the depth aspect, initialLayout must not be -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only -- the depth aspect, finalLayout must not be -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only -- the stencil aspect, initialLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only -- the stencil aspect, finalLayout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL

-- --

Valid Usage (Implicit)

-- --

flags must be a valid combination of -- AttachmentDescriptionFlagBits values

-- --

format must be a valid Format value
samples must be a valid SampleCountFlagBits -- value
loadOp must be a valid AttachmentLoadOp -- value
storeOp must be a valid AttachmentStoreOp -- value
stencilLoadOp must be a valid -- AttachmentLoadOp value
stencilStoreOp must be a valid -- AttachmentStoreOp value
initialLayout must be a valid ImageLayout -- value
finalLayout must be a valid ImageLayout -- value

-- --

Description

-- -- Each element of the pInputAttachments array corresponds to an -- input attachment index in a fragment shader, i.e. if a shader declares -- an image variable decorated with a InputAttachmentIndex value -- of X, then it uses the attachment provided in -- pInputAttachments[X]. Input attachments must -- also be bound to the pipeline in a descriptor set. If the -- attachment member of any element of -- pInputAttachments is ATTACHMENT_UNUSED, the -- application must not read from the corresponding input -- attachment index. Fragment shaders can use subpass input -- variables to access the contents of an input attachment at the -- fragment’s (x, y, layer) framebuffer coordinates. Input attachments -- must not be used by any subpasses within a renderpass that -- enables render pass transform. -- -- Each element of the pColorAttachments array corresponds to an -- output location in the shader, i.e. if the shader declares an output -- variable decorated with a Location value of X, then it -- uses the attachment provided in pColorAttachments[X]. -- If the attachment member of any element of -- pColorAttachments is ATTACHMENT_UNUSED, writes to the -- corresponding location by a fragment are discarded. -- -- If flags does not include -- SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if -- pResolveAttachments is not NULL, each of its -- elements corresponds to a color attachment (the element in -- pColorAttachments at the same index), and a multisample -- resolve operation is defined for each attachment. At the end of each -- subpass, multisample resolve operations read the subpass’s color -- attachments, and resolve the samples for each pixel within the render -- area to the same pixel location in the corresponding resolve -- attachments, unless the resolve attachment index is -- ATTACHMENT_UNUSED. -- -- Similarly, if flags does not include -- SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and -- SubpassDescriptionDepthStencilResolve::pDepthStencilResolveAttachment -- is not NULL and does not have the value -- ATTACHMENT_UNUSED, it corresponds to the depth/stencil -- attachment in pDepthStencilAttachment, and multisample -- resolve operations for depth and stencil are defined by -- SubpassDescriptionDepthStencilResolve::depthResolveMode -- and -- SubpassDescriptionDepthStencilResolve::stencilResolveMode, -- respectively. At the end of each subpass, multisample resolve -- operations read the subpass’s depth/stencil attachment, and resolve -- the samples for each pixel to the same pixel location in the -- corresponding resolve attachment. If -- SubpassDescriptionDepthStencilResolve::depthResolveMode -- is RESOLVE_MODE_NONE, then the depth component of the resolve -- attachment is not written to and its contents are preserved. -- Similarly, if -- SubpassDescriptionDepthStencilResolve::stencilResolveMode -- is RESOLVE_MODE_NONE, then the stencil component of the resolve -- attachment is not written to and its contents are preserved. -- SubpassDescriptionDepthStencilResolve::depthResolveMode -- is ignored if the Format of the -- pDepthStencilResolveAttachment does not have a depth -- component. Similarly, -- SubpassDescriptionDepthStencilResolve::stencilResolveMode -- is ignored if the Format of the -- pDepthStencilResolveAttachment does not have a stencil -- component. -- -- If the image subresource range referenced by the depth/stencil -- attachment is created with -- IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT, then -- the multisample resolve operation uses the sample locations state -- specified in the sampleLocationsInfo member of the element of -- the -- RenderPassSampleLocationsBeginInfoEXT::pPostSubpassSampleLocations -- for the subpass. -- -- If pDepthStencilAttachment is NULL, or if its -- attachment index is ATTACHMENT_UNUSED, it indicates that no -- depth/stencil attachment will be used in the subpass. -- -- The contents of an attachment within the render area become undefined -- at the start of a subpass S if all of the following conditions -- are true: -- --

The attachment is used as a color, depth/stencil, or resolve -- attachment in any subpass in the render pass.
There is a subpass S1 that uses or preserves the -- attachment, and a subpass dependency from S1 to S.
The attachment is not used or preserved in subpass S.

-- -- In addition, the contents of an attachment within the render area -- become undefined at the start of a subpass S if all of the -- following conditions are true: -- --

SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM is set.
The attachment is used as a color or depth/stencil in the -- subpass.

-- -- Once the contents of an attachment become undefined in subpass -- S, they remain undefined for subpasses in subpass dependency -- chains starting with subpass S until they are written again. -- However, they remain valid for subpasses in other subpass dependency -- chains starting with subpass S1 if those subpasses use or -- preserve the attachment. -- --

Valid Usage

-- --

pipelineBindPoint must be -- PIPELINE_BIND_POINT_GRAPHICS

-- --

colorAttachmentCount must be less than or equal to -- PhysicalDeviceLimits::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 ATTACHMENT_LOAD_OP_CLEAR
If pResolveAttachments is not NULL, for each -- resolve attachment that is not ATTACHMENT_UNUSED, the -- corresponding color attachment must not be -- ATTACHMENT_UNUSED
If pResolveAttachments is not NULL, for each -- resolve attachment that is not ATTACHMENT_UNUSED, the -- corresponding color attachment must not have a sample count of -- SAMPLE_COUNT_1_BIT
If pResolveAttachments is not NULL, each resolve -- attachment that is not ATTACHMENT_UNUSED must have a -- sample count of SAMPLE_COUNT_1_BIT
If pResolveAttachments is not NULL, each resolve -- attachment that is not ATTACHMENT_UNUSED must have the -- same Format as its corresponding color attachment
All attachments in pColorAttachments that are not -- ATTACHMENT_UNUSED must have the same sample count
All attachments in pInputAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain at least one of FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
All attachments in pColorAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
All attachments in pResolveAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
If pDepthStencilAttachment is not NULL and the -- attachment is not ATTACHMENT_UNUSED then it must have a -- format whose features contain -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
If the VK_AMD_mixed_attachment_samples extension is -- enabled, and all attachments in pColorAttachments that are -- not ATTACHMENT_UNUSED must have a sample count that is -- smaller than or equal to the sample count of -- pDepthStencilAttachment if it is not -- ATTACHMENT_UNUSED
If neither the VK_AMD_mixed_attachment_samples nor the -- VK_NV_framebuffer_mixed_samples extensions are enabled, and -- if pDepthStencilAttachment is not ATTACHMENT_UNUSED -- and any attachments in pColorAttachments are not -- ATTACHMENT_UNUSED, they must have the same sample -- count
The attachment member of each element of -- pPreserveAttachments must not be -- 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 by more than one -- AttachmentReference member, then each use must use the -- same layout
If flags includes -- SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX, it -- must also include -- SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX
If flags includes -- SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if -- pResolveAttachments is not NULL, then each resolve -- attachment must be ATTACHMENT_UNUSED
If flags includes -- SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if -- pDepthStencilResolveAttachmentKHR is not NULL, then -- the depth/stencil resolve attachment must be -- ATTACHMENT_UNUSED
If flags includes -- SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, then the subpass -- must be the last subpass in a subpass dependency chain
If flags includes -- SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM, then the sample -- count of the input attachments must equal -- rasterizationSamples
If flags includes -- SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM, and if -- sampleShadingEnable is enabled (explicitly or implicitly) -- then minSampleShading must equal 0.0
If the render pass is created with -- RENDER_PASS_CREATE_TRANSFORM_BIT_QCOM each of the elements of -- pInputAttachments must be -- ATTACHMENT_UNUSED

-- --

Valid Usage (Implicit)

-- --

flags must be a valid combination of -- SubpassDescriptionFlagBits values

-- --

pipelineBindPoint must be a valid -- PipelineBindPoint value
If inputAttachmentCount is not 0, -- pInputAttachments must be a valid pointer to an array -- of inputAttachmentCount valid AttachmentReference -- structures
If colorAttachmentCount is not 0, -- pColorAttachments must be a valid pointer to an array -- of colorAttachmentCount valid AttachmentReference -- structures
If colorAttachmentCount is not 0, and -- pResolveAttachments is not NULL, -- pResolveAttachments must be a valid pointer to an -- array of colorAttachmentCount valid -- AttachmentReference structures
If pDepthStencilAttachment is not NULL, -- pDepthStencilAttachment must be a valid pointer to a -- valid AttachmentReference 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 -- SubpassDependency 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 SUBPASS_EXTERNAL, the first -- synchronization scope includes commands that occur earlier in -- submission order than the cmdBeginRenderPass 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 SUBPASS_EXTERNAL, the second -- synchronization scope includes commands that occur later in -- submission order than the cmdEndRenderPass 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 -- MemoryBarrier (with matching srcAccessMask and -- dstAccessMask parameters) submitted as a part of a -- cmdPipelineBarrier (with matching srcStageMask and -- 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 a -- ImageMemoryBarrier defined similarly to the -- MemoryBarrier above, the queue family indices set to -- 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 the geometry shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT

-- --

If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
srcSubpass must be less than or equal to -- dstSubpass, unless one of them is SUBPASS_EXTERNAL, to -- avoid cyclic dependencies and ensure a valid execution order
srcSubpass and dstSubpass must not both -- be equal to SUBPASS_EXTERNAL
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 srcSubpass equals dstSubpass, and -- srcStageMask and dstStageMask both include a -- framebuffer-space stage, then dependencyFlags -- must include DEPENDENCY_BY_REGION_BIT
If dependencyFlags includes -- DEPENDENCY_VIEW_LOCAL_BIT, srcSubpass must not -- be equal to SUBPASS_EXTERNAL
If dependencyFlags includes -- DEPENDENCY_VIEW_LOCAL_BIT, dstSubpass must not -- be equal to SUBPASS_EXTERNAL
If srcSubpass equals dstSubpass and that subpass -- has more than one bit set in the view mask, then -- dependencyFlags must include -- DEPENDENCY_VIEW_LOCAL_BIT
If the mesh shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
If the mesh shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV

-- --

Valid Usage (Implicit)

-- --

srcStageMask must be a valid combination of -- PipelineStageFlagBits values

-- --

srcStageMask must not be 0
dstStageMask must be a valid combination of -- PipelineStageFlagBits values
dstStageMask must not be 0
srcAccessMask must be a valid combination of -- AccessFlagBits values
dstAccessMask must be a valid combination of -- AccessFlagBits values
dependencyFlags must be a valid combination of -- DependencyFlagBits values

-- --

Description

-- -- Note -- -- Care should be taken to avoid a data race here; if any subpasses -- access attachments with overlapping memory locations, and one of those -- accesses is a write, a subpass dependency needs to be included between -- them. -- --

Valid Usage

-- --

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 ATTACHMENT_UNUSED, it must be -- less than attachmentCount

-- --

For any member of pAttachments with a loadOp -- equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that -- attachment must not specify a layout equal to -- IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
For any member of pAttachments with a -- stencilLoadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the -- first use of that attachment must not specify a layout -- equal to IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
For any member of pAttachments with a loadOp -- equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that -- attachment must not specify a layout equal to -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
For any member of pAttachments with a -- stencilLoadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the -- first use of that attachment must not specify a layout -- equal to -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
If the pNext chain includes a -- RenderPassInputAttachmentAspectCreateInfo structure, the -- subpass member of each element of its -- pAspectReferences member must be less than -- subpassCount
If the pNext chain includes a -- RenderPassInputAttachmentAspectCreateInfo structure, the -- inputAttachmentIndex member of each element of its -- pAspectReferences member must be less than the value -- of inputAttachmentCount in the member of pSubpasses -- identified by its subpass member
If the pNext chain includes a -- RenderPassInputAttachmentAspectCreateInfo structure, for any -- element of the pInputAttachments member of any element of -- pSubpasses where the attachment member is not -- ATTACHMENT_UNUSED, the aspectMask member of the -- corresponding element of -- RenderPassInputAttachmentAspectCreateInfo::pAspectReferences -- must only include aspects that are present in images of the -- format specified by the element of pAttachments at -- attachment
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, and its -- subpassCount member is not zero, that member must be -- equal to the value of subpassCount
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, if its -- dependencyCount member is not zero, it must be equal -- to dependencyCount
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, for each non-zero -- element of pViewOffsets, the srcSubpass and -- dstSubpass members of pDependencies at the same -- index must not be equal
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, for any element of -- pDependencies with a dependencyFlags member that -- does not include DEPENDENCY_VIEW_LOCAL_BIT, the corresponding -- element of the pViewOffsets member of that -- RenderPassMultiviewCreateInfo instance must be -- 0
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, elements of its -- pViewMasks member must either all be 0, or -- all not be 0
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, and each element of -- its pViewMasks member is 0, the -- dependencyFlags member of each element of -- pDependencies must not include -- DEPENDENCY_VIEW_LOCAL_BIT
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, and each element of -- its pViewMasks member is 0, -- correlatedViewMaskCount must be 0
If the pNext chain includes a -- RenderPassMultiviewCreateInfo structure, each element of its -- pViewMask member must not have a bit set at an index -- greater than or equal to -- PhysicalDeviceLimits::maxFramebufferLayers
For any element of pDependencies, if the -- srcSubpass is not 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 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 destination -- subpass
The srcSubpass member of each element of -- pDependencies must be less than -- subpassCount
The dstSubpass member of each element of -- pDependencies must be less than -- subpassCount

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- RenderPassFragmentDensityMapCreateInfoEXT, -- RenderPassInputAttachmentAspectCreateInfo, or -- RenderPassMultiviewCreateInfo
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- RenderPassCreateFlagBits values
If attachmentCount is not 0, -- pAttachments must be a valid pointer to an array of -- attachmentCount valid AttachmentDescription -- structures
pSubpasses must be a valid pointer to an array of -- subpassCount valid SubpassDescription structures
If dependencyCount is not 0, -- pDependencies must be a valid pointer to an array of -- dependencyCount valid SubpassDependency -- 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 IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL -- layout or the -- 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, either because it has no attachment references or because -- all of them are ATTACHMENT_UNUSED. This kind of subpass -- can 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 -- PipelineMultisampleStateCreateInfo to define the number of -- samples used in rasterization; however, if -- PhysicalDeviceFeatures::variableMultisampleRate is -- FALSE, then all pipelines to be bound with the subpass -- must have the same value for -- PipelineMultisampleStateCreateInfo::rasterizationSamples. -- --

Valid Usage

-- --

attachmentCount must be equal to the attachment -- count specified in renderPass

-- --

If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, and attachmentCount -- is not 0, pAttachments must be a valid -- pointer to an array of attachmentCount valid ImageView -- handles
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, 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 -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments that is used as a depth/stencil attachment by -- renderPass must have been created with a -- usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments that is used as a depth/stencil resolve -- attachment by renderPass must have been created with a -- usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments that is used as an input attachment by -- renderPass must have been created with a -- usage value including -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT
Each element of pAttachments that is used as a fragment -- density map attachment by renderPass must not have -- been created with a flags value including -- IMAGE_CREATE_SUBSAMPLED_BIT_EXT
If renderPass has a fragment density map attachment and -- non-subsample image feature is not enabled, each element of -- pAttachments must have been created with a -- flags value including IMAGE_CREATE_SUBSAMPLED_BIT_EXT -- unless that element is the fragment density map attachment
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments must have been created with a -- Format value that matches the Format specified by the -- corresponding AttachmentDescription in renderPass
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments must have been created with a -- samples value that matches the samples value -- specified by the corresponding AttachmentDescription in -- renderPass
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments must have dimensions at least as large as -- the corresponding framebuffer dimension except for any element that is -- referenced by fragmentDensityMapAttachment
If renderPass was specified with non-zero view masks, -- each element of pAttachments that is not referenced by -- fragmentDensityMapAttachment must have a -- layerCount greater than the index of the most significant bit -- set in any of those view masks
If renderPass was specified with non-zero view masks, -- each element of pAttachments that is referenced by -- fragmentDensityMapAttachment must have a -- layerCount equal to 1 or greater than the index of -- the most significant bit set in any of those view masks
If renderPass was not specified with non-zero view masks, -- each element of pAttachments that is referenced by -- fragmentDensityMapAttachment must have a -- layerCount equal to 1
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of -- pAttachments that is referenced by -- fragmentDensityMapAttachment must have a width at -- least as large as <math>
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of -- pAttachments that is referenced by -- fragmentDensityMapAttachment must have a height at -- least as large as <math>
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of -- pAttachments must only specify a single mip level
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, 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 -- PhysicalDeviceLimits::maxFramebufferWidth
height must be greater than 0
height must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferHeight
layers must be greater than 0
layers must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferLayers
If renderPass was specified with non-zero view masks, -- layers must be 1
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, 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
If flags does not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, and attachmentCount -- is not 0, pAttachments must be a valid pointer to an -- array of attachmentCount valid ImageView handles
If the imageless framebuffer feature is not enabled, -- flags must not include -- FRAMEBUFFER_CREATE_IMAGELESS_BIT
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the pNext chain -- must include a FramebufferAttachmentsCreateInfo -- structure
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the -- attachmentImageInfoCount member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be equal to either zero or -- attachmentCount
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the width member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be greater than or equal to -- width, except for any element that is referenced by -- RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment -- in renderPass
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the height member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be greater than or equal to -- height, except for any element that is referenced by -- RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment -- in renderPass
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the width member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that is referenced by -- RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment -- in renderPass must be greater than or equal to -- <math>
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the height member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that is referenced by -- RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment -- in renderPass must be greater than or equal to -- <math>
If multiview is enabled for renderPass, and -- flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the -- layerCount member of any element of the -- pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be greater than the maximum bit index -- set in the view mask in the subpasses in which it is used in -- renderPass
If multiview is not enabled for renderPass, and -- flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the -- layerCount member of any element of the -- pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be greater than or equal to -- layers
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that refers to an attachment used as a color -- attachment or resolve attachment by renderPass must -- include IMAGE_USAGE_COLOR_ATTACHMENT_BIT
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that refers to an attachment used as a -- depth/stencil attachment by renderPass must include -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that refers to an attachment used as a -- depth/stencil resolve attachment by renderPass must -- include IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of -- any element of the pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain that refers to an attachment used as an input -- attachment by renderPass must include -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT
If flags includes -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, at least one element of the -- pViewFormats member of any element of the -- pAttachmentImageInfos member of a -- FramebufferAttachmentsCreateInfo structure included in the -- pNext chain must be equal to the corresponding value -- of AttachmentDescription::format used to create -- renderPass

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of FramebufferAttachmentsCreateInfo
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- FramebufferCreateFlagBits values
renderPass must be a valid RenderPass -- handle
Both of renderPass, and the elements of -- pAttachments that are valid handles of non-ignored parameters -- must have been created, allocated, or retrieved from the same -- Device

-- --

sType must be -- STRUCTURE_TYPE_RENDER_PASS_FRAGMENT_DENSITY_MAP_CREATE_INFO_EXT

-- --

fragmentDensityMapAttachment must be a valid -- AttachmentReference structure

-- --

Description

-- --

sType must be -- STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER

-- --

pNext must be NULL
buffer must be a valid Buffer 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 ACCESS_HOST_WRITE_BIT, memory -- writes performed by that access type are also made visible, as that -- access type is not performed through a resource. -- -- The second access scope is limited to access to memory through -- the specified image subresource range, via access types in the -- destination access mask specified by dstAccessMask. If -- dstAccessMask includes ACCESS_HOST_WRITE_BIT or -- ACCESS_HOST_READ_BIT, available memory writes are also made -- visible to accesses of those types, as those access types are not -- performed through a resource. -- -- If srcQueueFamilyIndex is not equal to -- dstQueueFamilyIndex, and srcQueueFamilyIndex is -- equal to the current queue family, then the memory barrier defines a -- queue family release operation for the specified image -- subresource range, and the second access scope includes no access, as -- if dstAccessMask was 0. -- -- If dstQueueFamilyIndex is not equal to -- srcQueueFamilyIndex, and dstQueueFamilyIndex is -- equal to the current queue family, then the memory barrier defines a -- queue family acquire operation for the specified image -- subresource range, and the first access scope includes no access, as -- if srcAccessMask was 0. -- -- If 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 -- 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 a ImageMemoryBarrier is an image -- created with this flag the application can include a -- SampleLocationsInfoEXT structure in the pNext chain of -- ImageMemoryBarrier to specify the sample locations to use -- during the image layout transition. -- -- If the SampleLocationsInfoEXT structure included in the -- pNext chain of ImageMemoryBarrier does not match the -- sample location state last used to render to the image subresource -- range specified by subresourceRange or if no -- SampleLocationsInfoEXT structure is included in the -- pNext chain of ImageMemoryBarrier, then the contents -- of the given image subresource range becomes undefined as if -- oldLayout would equal IMAGE_LAYOUT_UNDEFINED. -- -- If image has a multi-planar format and the image is -- disjoint, then including IMAGE_ASPECT_COLOR_BIT in the -- aspectMask member of subresourceRange is equivalent -- to including IMAGE_ASPECT_PLANE_0_BIT, -- IMAGE_ASPECT_PLANE_1_BIT, and (for three-plane formats only) -- IMAGE_ASPECT_PLANE_2_BIT. -- --

Valid Usage

-- --

oldLayout must be IMAGE_LAYOUT_UNDEFINED or -- the current layout of the image subresources affected by the -- barrier

-- --

newLayout must not be -- IMAGE_LAYOUT_UNDEFINED or -- IMAGE_LAYOUT_PREINITIALIZED
If image was created with a sharing mode of -- SHARING_MODE_CONCURRENT, at least one of -- srcQueueFamilyIndex and dstQueueFamilyIndex -- must be QUEUE_FAMILY_IGNORED
If image was created with a sharing mode of -- SHARING_MODE_CONCURRENT, and one of -- srcQueueFamilyIndex and dstQueueFamilyIndex is -- QUEUE_FAMILY_IGNORED, the other must be -- QUEUE_FAMILY_IGNORED or a special queue family reserved for -- external memory transfers, as described in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers
If image was created with a sharing mode of -- SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is -- QUEUE_FAMILY_IGNORED, dstQueueFamilyIndex must -- also be QUEUE_FAMILY_IGNORED
If image was created with a sharing mode of -- SHARING_MODE_EXCLUSIVE and srcQueueFamilyIndex is not -- QUEUE_FAMILY_IGNORED, it must be a valid queue family or -- a special queue family reserved for external memory transfers, as -- described in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers
If image was created with a sharing mode of -- SHARING_MODE_EXCLUSIVE and dstQueueFamilyIndex is not -- QUEUE_FAMILY_IGNORED, it must be a valid queue family or -- a special queue family reserved for external memory transfers, as -- described in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#synchronization-queue-transfers
If image was created with a sharing mode of -- SHARING_MODE_EXCLUSIVE, and srcQueueFamilyIndex and -- dstQueueFamilyIndex are not 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 ImageCreateInfo when -- image was created
If subresourceRange.levelCount is not -- REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + -- subresourceRange.levelCount must be less than or equal -- to the mipLevels specified in ImageCreateInfo when -- image was created
subresourceRange.baseArrayLayer must be less than -- the arrayLayers specified in ImageCreateInfo when -- image was created
If subresourceRange.layerCount is not -- REMAINING_ARRAY_LAYERS, -- subresourceRange.baseArrayLayer + -- subresourceRange.layerCount must be less than or equal -- to the arrayLayers specified in ImageCreateInfo when -- image was created
If image has a depth/stencil format with both depth and -- stencil and the separateDepthStencilLayouts feature is enabled, -- then the aspectMask member of subresourceRange -- must include either or both IMAGE_ASPECT_DEPTH_BIT and -- IMAGE_ASPECT_STENCIL_BIT
If image has a depth/stencil format with both depth and -- stencil and the separateDepthStencilLayouts feature is not -- enabled, then the aspectMask member of -- subresourceRange must include both -- IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT
If image has a color format and either the format is -- single-plane or the image is not disjoint then the aspectMask -- member of subresourceRange must only include -- IMAGE_ASPECT_COLOR_BIT
If image has a multi-planar format and the image is -- disjoint, then the aspectMask member of -- subresourceRange must include either at least one of -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, and -- IMAGE_ASPECT_PLANE_2_BIT; or must include -- IMAGE_ASPECT_COLOR_BIT
If image has a multi-planar format with only two planes, -- then the aspectMask member of subresourceRange -- must not include IMAGE_ASPECT_PLANE_2_BIT
If either oldLayout or newLayout is -- IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then image -- must have been created with -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL then -- image must have been created with -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then -- image must have been created with -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL then -- image must have been created with -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL then -- image must have been created with -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then image -- must have been created with IMAGE_USAGE_SAMPLED_BIT or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then image -- must have been created with IMAGE_USAGE_TRANSFER_SRC_BIT -- set
If either oldLayout or newLayout is -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then image -- must have been created with IMAGE_USAGE_TRANSFER_DST_BIT -- set
If image is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
If either oldLayout or newLayout is -- IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV then image -- must have been created with -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV set

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER

-- --

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

-- --

Description

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

Valid Usage

-- --

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

-- --

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

-- --

Description

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

Valid Usage

-- --

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

-- --

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

Parameters

-- --

device is the logical device that owns the memory.

-- --

pAllocateInfo is a pointer to a MemoryAllocateInfo -- structure describing parameters of the allocation. A successful -- returned allocation must use the requested parameters — no -- substitution is permitted by the implementation.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pMemory is a pointer to a DeviceMemory handle in -- which information about the allocated memory is returned.

-- --

Description

-- -- Allocations returned by allocateMemory are guaranteed to meet -- any alignment requirement of the implementation. For example, if an -- implementation requires 128 byte alignment for images and 64 byte -- alignment for buffers, the device memory returned through this -- mechanism would be 128-byte aligned. This ensures that applications -- can correctly suballocate objects of different types (with -- potentially different alignment requirements) in the same memory -- object. -- -- When memory is allocated, its contents are undefined with the -- following constraint: -- --

The contents of unprotected memory must not be a function -- of data protected memory objects, even if those memory objects were -- previously freed.

-- -- Note -- -- The contents of memory allocated by one application should not -- be a function of data from protected memory objects of another -- application, even if those memory objects were previously freed. -- -- The maximum number of valid memory allocations that can exist -- simultaneously within a Device may be restricted by -- implementation- or platform-dependent limits. If a call to -- allocateMemory would cause the total number of allocations to -- exceed these limits, such a call will fail and must return -- ERROR_TOO_MANY_OBJECTS. The maxMemoryAllocationCount -- feature describes the number of allocations that can exist -- simultaneously before encountering these internal limits. -- -- Some platforms may have a limit on the maximum size of a single -- allocation. For example, certain systems may fail to create -- allocations with a size greater than or equal to 4GB. Such a limit is -- implementation-dependent, and if such a failure occurs then the error -- ERROR_OUT_OF_DEVICE_MEMORY must be returned. This limit -- is advertised in -- PhysicalDeviceMaintenance3Properties::maxMemoryAllocationSize. -- -- The cumulative memory size allocated to a heap can be limited -- by the size of the specified heap. In such cases, allocated memory is -- tracked on a per-device and per-heap basis. Some platforms allow -- overallocation into other heaps. The overallocation behavior -- can be specified through the -- VK_AMD_memory_overallocation_behavior extension. -- --

Valid Usage

-- --

pAllocateInfo->allocationSize must be less than -- or equal to -- PhysicalDeviceMemoryProperties::memoryHeaps[memindex].size -- where memindex = -- PhysicalDeviceMemoryProperties::memoryTypes[pAllocateInfo->memoryTypeIndex].heapIndex -- as returned by getPhysicalDeviceMemoryProperties for the -- PhysicalDevice that device was created from

-- --

pAllocateInfo->memoryTypeIndex must be less -- than PhysicalDeviceMemoryProperties::memoryTypeCount -- as returned by getPhysicalDeviceMemoryProperties for the -- PhysicalDevice that device was created from
If the deviceCoherentMemory feature is not enabled, -- pAllocateInfo->memoryTypeIndex must not identify a -- memory type supporting -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pAllocateInfo must be a valid pointer to a valid -- MemoryAllocateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pMemory must be a valid pointer to a -- DeviceMemory handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the DeviceMemory 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. Memory can be -- freed whilst still bound to resources, but those resources must -- not be used afterwards. 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 Device handle

-- --

If memory is not NULL_HANDLE, memory -- must be a valid DeviceMemory handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 DeviceMemory 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 -- WHOLE_SIZE to map from offset to the end of the -- allocation.
flags is reserved for future use.
ppData is a pointer to a void * variable 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 -- PhysicalDeviceLimits::minMemoryMapAlignment.

-- --

Description

-- -- After a successful call to mapMemory the memory object -- memory is considered to be currently host mapped. -- -- Note -- -- It is an application error to call mapMemory on a memory object -- that is already host mapped. -- -- Note -- -- mapMemory 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, -- mapMemory must return 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 unmapMemory. -- -- mapMemory 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 -- 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 -- PhysicalDeviceLimits::nonCoherentAtomSize, and round -- the end of the range up to the nearest multiple of -- PhysicalDeviceLimits::nonCoherentAtomSize. -- -- While a range of device memory is host mapped, 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 host mapped

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

memory must be a valid DeviceMemory -- 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
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the memory object to be unmapped.

-- --

Valid Usage

-- --

memory must be currently host mapped

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

memory must be a valid DeviceMemory -- 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 -- MappedMemoryRange structures describing the memory ranges to -- flush.

-- --

Description

-- -- flushMappedMemoryRanges guarantees that host writes to the -- memory ranges described by pMemoryRanges are made available -- to the host memory domain, such that they can be made available -- to the device memory domain via memory domain operations using -- the 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 host -- 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 host -- 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). -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 -- MappedMemoryRange structures describing the memory ranges to -- invalidate.

-- --

Description

-- -- invalidateMappedMemoryRanges guarantees that device writes to -- the memory ranges described by pMemoryRanges, which have been -- made available to the host memory domain using the -- ACCESS_HOST_WRITE_BIT and 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 -- host mapped, or the last time it was invalidated. -- -- Note -- -- Mapping non-coherent memory does not implicitly invalidate that -- memory. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 -- DeviceSize value in which the number of bytes currently -- committed is returned, on success.

-- --

sType must be -- 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 -- DedicatedAllocationMemoryAllocateInfoNV, -- ExportMemoryAllocateInfo, ExportMemoryAllocateInfoNV, -- ExportMemoryWin32HandleInfoKHR, -- ExportMemoryWin32HandleInfoNV, -- ImportAndroidHardwareBufferInfoANDROID, -- ImportMemoryFdInfoKHR, ImportMemoryHostPointerInfoEXT, -- ImportMemoryWin32HandleInfoKHR, -- ImportMemoryWin32HandleInfoNV, MemoryAllocateFlagsInfo, -- MemoryDedicatedAllocateInfo, -- MemoryOpaqueCaptureAddressAllocateInfo, or -- MemoryPriorityAllocateInfoEXT
The sType value of each struct in the pNext -- chain must be unique

-- --

Parameters

-- --

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

-- --

pCreateInfo is a pointer to a ImageViewCreateInfo -- structure containing parameters to be used to create the image -- view.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pView is a pointer to a ImageView handle in which -- the resulting image view object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- ImageViewCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pView must be a valid pointer to a -- ImageView handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If imageView is not NULL_HANDLE, -- imageView must be a valid ImageView handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- -- Some of the image creation parameters are inherited by the -- view. In particular, image view creation inherits the implicit -- parameter usage specifying the allowed usages of the image -- view that, by default, takes the value of the corresponding -- usage parameter specified in ImageCreateInfo at image -- creation time. If the image was has a depth-stencil format and was -- created with a ImageStencilUsageCreateInfo structure included -- in the pNext chain of ImageCreateInfo, the usage is -- calculated based on the subresource.aspectMask provided: -- --

If aspectMask includes only -- IMAGE_ASPECT_STENCIL_BIT, the implicit usage is equal -- to ImageStencilUsageCreateInfo::stencilUsage.
If aspectMask includes only -- IMAGE_ASPECT_DEPTH_BIT, the implicit usage is equal to -- ImageCreateInfo::usage.
If both aspects are included in aspectMask, the implicit -- usage is equal to the intersection of -- ImageCreateInfo::usage and -- ImageStencilUsageCreateInfo::stencilUsage. The -- implicit usage can be overriden by adding a -- ImageViewUsageCreateInfo structure to the pNext -- chain.

-- -- If image was created with the -- 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 -- 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 -- 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 SamplerYcbcrConversion to that used to create the -- sampler must be passed to createImageView in a -- SamplerYcbcrConversionInfo included in the pNext chain -- of ImageViewCreateInfo. Conversely, if a -- SamplerYcbcrConversion object is passed to -- createImageView, an identically defined -- SamplerYcbcrConversion object must be used when sampling -- the image. -- -- If the image has a multi-planar format and -- subresourceRange.aspectMask is 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 -- IMAGE_CREATE_MUTABLE_FORMAT_BIT and the image has a -- multi-planar format, and if -- subresourceRange.aspectMask is -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- 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. -- -- TODO: table -- -- Image and image view parameter compatibility requirements -- --

Valid Usage

-- --

If image was not created with -- IMAGE_CREATE_CUBE_COMPATIBLE_BIT then viewType -- must not be IMAGE_VIEW_TYPE_CUBE or -- IMAGE_VIEW_TYPE_CUBE_ARRAY

-- --

If the image cubemap arrays feature is not enabled, -- viewType must not be -- IMAGE_VIEW_TYPE_CUBE_ARRAY
If image was created with IMAGE_TYPE_3D but -- without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set then -- viewType must not be IMAGE_VIEW_TYPE_2D or -- IMAGE_VIEW_TYPE_2D_ARRAY
image must have been created with a usage -- value containing at least one of IMAGE_USAGE_SAMPLED_BIT, -- IMAGE_USAGE_STORAGE_BIT, -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, or -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
The format features of the resultant image view must -- contain at least one bit
If usage contains IMAGE_USAGE_SAMPLED_BIT, then -- the format features of the resultant image view must -- contain FORMAT_FEATURE_SAMPLED_IMAGE_BIT
If usage contains IMAGE_USAGE_STORAGE_BIT, then -- the image view’s format features must contain -- FORMAT_FEATURE_STORAGE_IMAGE_BIT
If usage contains -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, then the image view’s -- format features must contain -- FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
If usage contains -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, then the image view’s -- format features must contain -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
If usage contains -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, then the image view’s -- format features must contain at least one of -- FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
subresourceRange.baseMipLevel must be less than -- the mipLevels specified in ImageCreateInfo when -- image was created
If subresourceRange.levelCount is not -- REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + -- subresourceRange.levelCount must be less than or equal -- to the mipLevels specified in ImageCreateInfo when -- image was created
If image was created with usage containing -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, -- subresourceRange.levelCount must be 1
If image is not a 3D image created with -- IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or viewType -- is not IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange.baseArrayLayer must be less than the -- arrayLayers specified in ImageCreateInfo when -- image was created
If subresourceRange.layerCount is not -- REMAINING_ARRAY_LAYERS, image is not a 3D image -- created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, or -- viewType is not IMAGE_VIEW_TYPE_2D or -- 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 ImageCreateInfo when -- image was created
If image is a 3D image created with -- IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType -- is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, -- subresourceRange.baseArrayLayer must be less than the -- depth computed from baseMipLevel and extent.depth -- specified in ImageCreateInfo when image was created, -- according to the formula defined in Image Miplevel Sizing
If subresourceRange.layerCount is not -- REMAINING_ARRAY_LAYERS, image is a 3D image created -- with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and -- viewType is IMAGE_VIEW_TYPE_2D or -- IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange.layerCount -- must be non-zero and subresourceRange.baseArrayLayer + -- subresourceRange.layerCount must be less than or equal -- to the depth computed from baseMipLevel and -- extent.depth specified in ImageCreateInfo when -- image was created, according to the formula defined in -- Image Miplevel Sizing
If image was created with the -- IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, but without the -- 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 -- 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 -- IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, the -- levelCount and layerCount members of -- subresourceRange must both be 1
If a ImageFormatListCreateInfo structure was included in -- the pNext chain of the ImageCreateInfo structure used -- when creating image and the viewFormatCount field of -- ImageFormatListCreateInfo is not zero then format -- must be one of the formats in -- ImageFormatListCreateInfo::pViewFormats
If image was created with the -- IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, if the format of -- the image is a multi-planar format, and if -- subresourceRange.aspectMask is one of -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- IMAGE_ASPECT_PLANE_2_BIT, then format must be -- compatible with the Format for the plane of the image -- format indicated by subresourceRange.aspectMask, as -- defined in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes
If image was not created with the -- IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, or if the format -- of the image is a multi-planar format and if -- subresourceRange.aspectMask is IMAGE_ASPECT_COLOR_BIT, -- format must be identical to the format used -- to create image
If the pNext chain includes a -- SamplerYcbcrConversionInfo structure with a conversion -- value other than NULL_HANDLE, all members of -- components must have the value -- COMPONENT_SWIZZLE_IDENTITY
If image is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- 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 FORMAT_UNDEFINED
If image has an external format, the -- pNext chain must include a -- SamplerYcbcrConversionInfo structure with a conversion -- object created with the same external format as image
If image has an external format, all members of -- components must be -- COMPONENT_SWIZZLE_IDENTITY
If image was created with usage containing -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType -- must be IMAGE_VIEW_TYPE_2D or -- IMAGE_VIEW_TYPE_2D_ARRAY
If image was created with usage containing -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format -- must be FORMAT_R8_UINT
If dynamic fragment density map feature is not enabled, -- flags must not contain -- IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT
If dynamic fragment density map feature is not enabled and -- image was created with usage containing -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, flags -- must not contain any of IMAGE_CREATE_PROTECTED_BIT, -- IMAGE_CREATE_SPARSE_BINDING_BIT, -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or -- IMAGE_CREATE_SPARSE_ALIASED_BIT
If the pNext chain includes a -- ImageViewUsageCreateInfo structure, and image was not -- created with a ImageStencilUsageCreateInfo structure included -- in the pNext chain of ImageCreateInfo, its -- usage member must not include any bits that were not -- set in the usage member of the ImageCreateInfo -- structure used to create image
If the pNext chain includes a -- ImageViewUsageCreateInfo structure, image was created -- with a ImageStencilUsageCreateInfo structure included in the -- pNext chain of ImageCreateInfo, and -- subResourceRange.aspectMask includes -- IMAGE_ASPECT_STENCIL_BIT, the usage member of the -- ImageViewUsageCreateInfo instance must not include any -- bits that were not set in the usage member of the -- ImageStencilUsageCreateInfo structure used to create -- image
If the pNext chain includes a -- ImageViewUsageCreateInfo structure, image was created -- with a ImageStencilUsageCreateInfo structure included in the -- pNext chain of ImageCreateInfo, and -- subResourceRange.aspectMask includes bits other than -- IMAGE_ASPECT_STENCIL_BIT, the usage member of the -- ImageViewUsageCreateInfo structure must not include any -- bits that were not set in the usage member of the -- ImageCreateInfo structure used to create image
If viewType is IMAGE_VIEW_TYPE_CUBE and -- subresourceRange.layerCount is not -- REMAINING_ARRAY_LAYERS, subresourceRange.layerCount -- must be 6
If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and -- subresourceRange.layerCount is not -- REMAINING_ARRAY_LAYERS, subresourceRange.layerCount -- must be a multiple of 6
If viewType is IMAGE_VIEW_TYPE_CUBE and -- subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, -- the remaining number of layers must be 6
If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and -- subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, -- the remaining number of layers must be a multiple of -- 6

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 ImageViewASTCDecodeModeEXT, -- ImageViewUsageCreateInfo, or -- SamplerYcbcrConversionInfo
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- ImageViewCreateFlagBits values
image must be a valid Image handle
viewType must be a valid ImageViewType -- value
format must be a valid Format value
components must be a valid ComponentMapping -- structure
subresourceRange must be a valid -- ImageSubresourceRange structure

-- --

Parameters

-- --

device is the logical device that will be importing -- buffer.

-- --

buffer is the Android hardware buffer which will be -- imported.
pProperties is a pointer to a -- AndroidHardwareBufferPropertiesANDROID structure in which the -- properties of buffer are returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_INVALID_EXTERNAL_HANDLE_KHR

-- --

Parameters

-- --

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

-- --

pInfo is a pointer to a -- MemoryGetAndroidHardwareBufferInfoANDROID structure containing -- parameters of the export operation.
pBuffer will return an Android hardware buffer -- representing the underlying resources of the device memory -- object.

-- --

Description

-- -- Each call to getMemoryAndroidHardwareBufferANDROID must -- return an Android hardware buffer with a new reference acquired in -- addition to the reference held by the DeviceMemory. To avoid -- leaking resources, the application must release the reference -- by calling AHardwareBuffer_release when it is no longer -- needed. When called with the same handle in -- MemoryGetAndroidHardwareBufferInfoANDROID::memory, -- getMemoryAndroidHardwareBufferANDROID must return the -- same Android hardware buffer object. If the device memory was created -- by importing an Android hardware buffer, -- getMemoryAndroidHardwareBufferANDROID must return that -- same Android hardware buffer object. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

Description

-- -- If the allocateMemory command succeeds, the implementation -- must acquire a reference to the imported hardware buffer, which -- it must release when the device memory object is freed. If the -- command fails, the implementation must not retain a reference. -- --

Valid Usage

-- --

If buffer is not NULL, Android hardware buffers -- must be supported for import, as reported by -- ExternalImageFormatProperties or -- ExternalBufferProperties

-- --

If buffer is not NULL, it must be a valid -- Android hardware buffer object with -- AHardwareBuffer_Desc::format and -- AHardwareBuffer_Desc::usage compatible with Vulkan -- as described in Android Hardware Buffers

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

-- --

buffer must be a valid pointer to an -- AHardwareBuffer value

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If ycbcrConversion is not NULL_HANDLE, -- ycbcrConversion must be a valid -- SamplerYcbcrConversion handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- -- Note -- -- Setting forceExplicitReconstruction to TRUE may -- have a performance penalty on implementations where explicit -- reconstruction is not the default mode of operation. -- -- If format supports -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT -- the forceExplicitReconstruction value behaves as if it was -- set to TRUE. -- -- If the pNext chain includes a ExternalFormatANDROID -- structure with non-zero externalFormat member, the sampler -- Y′CBCR conversion object represents an external format -- conversion, and format must be -- 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 FORMAT_UNDEFINED, otherwise it must not -- be FORMAT_UNDEFINED

-- --

The sampler Y′CBCR conversion’s features must -- support FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or -- FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT
If the sampler Y′CBCR conversion’s features do not support -- FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT, -- xChromaOffset and yChromaOffset must not be -- CHROMA_LOCATION_COSITED_EVEN
If the sampler Y′CBCR conversion’s features do not support -- FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT, -- xChromaOffset and yChromaOffset must not be -- CHROMA_LOCATION_MIDPOINT
If the format has a _422 or _420 suffix, then -- components.g must be -- COMPONENT_SWIZZLE_IDENTITY
If the format has a _422 or _420 suffix, then -- components.a must be -- COMPONENT_SWIZZLE_IDENTITY, COMPONENT_SWIZZLE_ONE, or -- COMPONENT_SWIZZLE_ZERO
If the format has a _422 or _420 suffix, then -- components.r must be COMPONENT_SWIZZLE_IDENTITY -- or COMPONENT_SWIZZLE_B
If the format has a _422 or _420 suffix, then -- components.b must be COMPONENT_SWIZZLE_IDENTITY -- or COMPONENT_SWIZZLE_R
If the format has a _422 or _420 suffix, and if -- either components.r or components.b is -- COMPONENT_SWIZZLE_IDENTITY, both values must be -- COMPONENT_SWIZZLE_IDENTITY
If ycbcrModel is not -- 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 -- COMPONENT_SWIZZLE_ZERO or COMPONENT_SWIZZLE_ONE, and -- must not correspond to a channel which contains zero or one as -- a consequence of conversion to RGBA
If ycbcrRange is SAMPLER_YCBCR_RANGE_ITU_NARROW -- then the R, G and B channels obtained by applying the -- component swizzle to format must each have a -- bit-depth greater than or equal to 8
If the sampler Y′CBCR conversion’s features do not support -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT -- forceExplicitReconstruction must be FALSE
If the sampler Y′CBCR conversion’s features do not support -- FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT, -- chromaFilter must not be FILTER_LINEAR

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of ExternalFormatANDROID
The sType value of each struct in the pNext -- chain must be unique
format must be a valid Format value
ycbcrModel must be a valid -- SamplerYcbcrModelConversion value
ycbcrRange must be a valid -- SamplerYcbcrRange value
components must be a valid ComponentMapping -- structure
xChromaOffset must be a valid -- ChromaLocation value
yChromaOffset must be a valid -- ChromaLocation value
chromaFilter must be a valid Filter -- value

-- -- If chromaFilter is 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. -- --

Members

-- -- The members of the PhysicalDeviceSamplerYcbcrConversionFeatures -- structure describe the following feature: -- --

SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY specifies that -- the input values to the conversion are unmodified.

-- --

SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_IDENTITY specifies no -- model conversion but the inputs are range expanded as for Y′CBCR.
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.
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.
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.

components.a = COMPONENT_SWIZZLE_IDENTITY
components.r = COMPONENT_SWIZZLE_B
components.g = COMPONENT_SWIZZLE_R
components.b = COMPONENT_SWIZZLE_G

-- --

Description

Parameters

-- --

device is the logical device that creates the image.

-- --

pCreateInfo is a pointer to a ImageCreateInfo -- structure containing parameters to be used to create the image.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pImage is a pointer to a Image handle in which the -- resulting image object is returned.

-- --

Valid Usage

-- --

If the flags member of pCreateInfo includes -- IMAGE_CREATE_SPARSE_BINDING_BIT, creating this Image -- must not cause the total required sparse memory for all -- currently valid sparse resources on the device to exceed -- PhysicalDeviceLimits::sparseAddressSpaceSize

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- ImageCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pImage must be a valid pointer to a Image -- handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

All submitted commands that refer to image, either -- directly or via a ImageView, must have completed -- execution

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If image is not NULL_HANDLE, image -- must be a valid Image handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 ImageSubresource -- structure selecting a specific image for the image subresource.
pLayout is a pointer to a SubresourceLayout -- structure in which the layout is returned.

-- --

Description

-- -- If the image is linear, then the returned layout is valid for -- host access. -- -- If the image’s tiling is IMAGE_TILING_LINEAR and its format is -- a multi-planar format, then getImageSubresourceLayout -- describes one format plane of the image. If the image’s tiling -- is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then -- getImageSubresourceLayout describes one memory plane of -- the image. If the image’s tiling is -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT and the image is -- non-linear, then the returned layout has an -- implementation-dependent meaning; the vendor of the image’s DRM -- format modifier may provide documentation that explains how -- to interpret the returned layout. -- -- getImageSubresourceLayout is invariant for the lifetime of a -- single image. However, the subresource layout of images in Android -- hardware buffer external memory is not known until the image has been -- bound to memory, so applications must not call -- getImageSubresourceLayout for such an image before it has been -- bound. -- --

Valid Usage

-- --

image must have been created with tiling -- equal to IMAGE_TILING_LINEAR or -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT

-- --

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 -- ImageCreateInfo when image was created
The arrayLayer member of pSubresource -- must be less than the arrayLayers specified in -- ImageCreateInfo when image was created
If the tiling of the image is -- IMAGE_TILING_LINEAR and its format is a -- multi-planar format with two planes, the aspectMask -- member of pSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT or -- IMAGE_ASPECT_PLANE_1_BIT
If the tiling of the image is -- IMAGE_TILING_LINEAR and its format is a -- multi-planar format with three planes, the aspectMask -- member of pSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or -- IMAGE_ASPECT_PLANE_2_BIT
If image was created with the -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID -- external memory handle type, then image must be bound -- to memory
If the tiling of the image is -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then the -- aspectMask member of pSubresource must be -- VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT and the index -- i must be less than the -- DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount -- associated with the image’s format and -- ImageDrmFormatModifierPropertiesEXT::drmFormatModifier

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

image must be a valid Image handle
pSubresource must be a valid pointer to a valid -- ImageSubresource structure
pLayout must be a valid pointer to a -- SubresourceLayout structure
image must have been created, allocated, or -- retrieved from device

-- --

Description

-- -- Images created with tiling equal to -- IMAGE_TILING_LINEAR have further restrictions on their limits -- and capabilities compared to images created with tiling equal -- to IMAGE_TILING_OPTIMAL. Creation of images with tiling -- IMAGE_TILING_LINEAR may not be supported unless other -- parameters meet all of the constraints: -- --

imageType is IMAGE_TYPE_2D
format is not a depth/stencil format
mipLevels is 1
arrayLayers is 1
samples is SAMPLE_COUNT_1_BIT
usage only includes IMAGE_USAGE_TRANSFER_SRC_BIT -- and/or IMAGE_USAGE_TRANSFER_DST_BIT

-- -- Images created with a format from one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion -- have further restrictions on their limits and capabilities compared to -- images created with other formats. Creation of images with a format -- requiring Y′CBCR conversion may not be supported unless -- other parameters meet all of the constraints: -- --

imageType is IMAGE_TYPE_2D
mipLevels is 1
arrayLayers is 1
samples is SAMPLE_COUNT_1_BIT

-- -- Implementations may support additional limits and capabilities -- beyond those listed above. -- -- To determine the set of valid usage bits for a given format, -- call getPhysicalDeviceFormatProperties. -- -- If the size of the resultant image would exceed -- maxResourceSize, then createImage must fail and -- return ERROR_OUT_OF_DEVICE_MEMORY. This failure may -- occur even when all image creation parameters satisfy their valid -- usage requirements. -- -- Note -- -- For images created without 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 IMAGE_CREATE_EXTENDED_USAGE_BIT a -- usage bit is valid if it is supported for at least one of the -- formats a ImageView created from the image can have (see -- Image Views for more detail). -- -- Valid values for some image creation parameters are limited by a -- numerical upper bound or by inclusion in a bitset. For example, -- ImageCreateInfo::arrayLayers is limited by -- imageCreateMaxArrayLayers, defined below; and -- ImageCreateInfo::samples is limited by -- imageCreateSampleCounts, also defined below. -- -- Several limiting values are defined below, as well as assisting values -- from which the limiting values are derived. The limiting values are -- referenced by the relevant valid usage statements of -- ImageCreateInfo. -- --

Let uint64_t imageCreateDrmFormatModifiers[] be the set -- of Linux DRM format modifiers that the resultant image -- may have.
- If tiling is not -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then -- imageCreateDrmFormatModifiers is empty.
- If -- ImageCreateInfo::pNext contains -- ImageDrmFormatModifierExplicitCreateInfoEXT, then -- imageCreateDrmFormatModifiers contains exactly one modifier, -- ImageDrmFormatModifierExplicitCreateInfoEXT::drmFormatModifier.
- If -- ImageCreateInfo::pNext contains -- ImageDrmFormatModifierListCreateInfoEXT, then -- imageCreateDrmFormatModifiers contains the entire array -- ImageDrmFormatModifierListCreateInfoEXT::pDrmFormatModifiers.
Let VkBool32 imageCreateMaybeLinear indicate if the -- resultant image may be linear.
- If tiling is -- IMAGE_TILING_LINEAR, then imageCreateMaybeLinear is -- true.
- If tiling is -- IMAGE_TILING_OPTIMAL, then imageCreateMaybeLinear is -- false.
- If tiling is -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then -- imageCreateMaybeLinear_ is true if and only if -- imageCreateDrmFormatModifiers contains -- DRM_FORMAT_MOD_LINEAR.
Let VkFormatFeatureFlags imageCreateFormatFeatures be the -- set of valid format features available during image -- creation.
- If tiling is IMAGE_TILING_LINEAR, -- then imageCreateFormatFeatures is the value of -- ImageFormatProperties::linearTilingFeatures found by -- calling getPhysicalDeviceFormatProperties with parameter -- format equal to -- ImageCreateInfo::format.
- If tiling is -- IMAGE_TILING_OPTIMAL, and if the pNext chain includes -- no ExternalFormatANDROID structure with non-zero -- externalFormat, then imageCreateFormatFeatures is -- value of ImageFormatProperties::optimalTilingFeatures -- found by calling getPhysicalDeviceFormatProperties with -- parameter format equal to -- ImageCreateInfo::format.
- If tiling is -- IMAGE_TILING_OPTIMAL, and if the pNext chain includes -- a ExternalFormatANDROID structure with non-zero -- externalFormat, then imageCreateFormatFeatures is -- the value of -- AndroidHardwareBufferFormatPropertiesANDROID::formatFeatures -- obtained by getAndroidHardwareBufferPropertiesANDROID with a -- matching externalFormat value.
- If tiling is -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then the value of -- imageCreateFormatFeatures is found by calling -- getPhysicalDeviceFormatProperties2 with -- ImageFormatProperties::format equal to -- ImageCreateInfo::format and with -- DrmFormatModifierPropertiesListEXT chained into -- ImageFormatProperties2; by collecting all members of the -- returned array -- DrmFormatModifierPropertiesListEXT::pDrmFormatModifierProperties -- whose drmFormatModifier belongs to -- imageCreateDrmFormatModifiers; and by taking the bitwise -- intersection, over the collected array members, of -- drmFormatModifierTilingFeatures. (The resultant -- imageCreateFormatFeatures may be -- empty).
Let VkImageFormatProperties2 -- imageCreateImageFormatPropertiesList[] be defined as -- follows.
- If ImageCreateInfo::pNext contains no -- ExternalFormatANDROID structure with non-zero -- externalFormat, then -- imageCreateImageFormatPropertiesList is the list of -- structures obtained by calling -- getPhysicalDeviceImageFormatProperties2, possibly multiple -- times, as follows:
  - The parameters -- PhysicalDeviceImageFormatInfo2::format, -- imageType, tiling, usage, and -- flags must be equal to those in -- ImageCreateInfo.
  - If -- ImageCreateInfo::pNext contains a -- ExternalMemoryImageCreateInfo structure whose -- handleTypes is not 0, then -- PhysicalDeviceImageFormatInfo2::pNext must -- contain a PhysicalDeviceExternalImageFormatInfo structure whose -- handleType is not 0; and -- getPhysicalDeviceImageFormatProperties2 must be called -- for each handle type in -- ExternalMemoryImageCreateInfo::handleTypes, -- successively setting -- PhysicalDeviceExternalImageFormatInfo::handleType on -- each call.
  - If ImageCreateInfo::pNext contains -- no ExternalMemoryImageCreateInfo structure, or contains a -- structure whose handleTypes is 0, then -- PhysicalDeviceImageFormatInfo2::pNext must -- either contain no PhysicalDeviceExternalImageFormatInfo -- structure, or contain a structure whose handleType is -- 0.
  - If tiling is -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then -- PhysicalDeviceImageFormatInfo2::pNext must -- contain a PhysicalDeviceImageDrmFormatModifierInfoEXT structure -- where sharingMode is equal to -- ImageCreateInfo::sharingMode; and, if -- sharingMode is SHARING_MODE_CONCURRENT, then -- queueFamilyIndexCount and pQueueFamilyIndices -- must be equal to those in ImageCreateInfo; and, if -- flags contains IMAGE_CREATE_MUTABLE_FORMAT_BIT, then -- the ImageFormatListCreateInfo structure included in the -- pNext chain of PhysicalDeviceImageFormatInfo2 -- must be equivalent to the one included in the pNext -- chain of ImageCreateInfo; and -- getPhysicalDeviceImageFormatProperties2 must be called -- for each modifier in imageCreateDrmFormatModifiers, -- successively setting -- PhysicalDeviceImageDrmFormatModifierInfoEXT::drmFormatModifier -- on each call.
  - If tiling is not -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then -- PhysicalDeviceImageFormatInfo2::pNext must -- contain no PhysicalDeviceImageDrmFormatModifierInfoEXT -- structure.
  - If any call to -- getPhysicalDeviceImageFormatProperties2 returns an error, then -- imageCreateImageFormatPropertiesList is defined to be the -- empty list.
- If -- ImageCreateInfo::pNext contains a -- ExternalFormatANDROID structure with non-zero -- externalFormat, then -- imageCreateImageFormatPropertiesList contains a single -- element -- where:
  - ImageFormatProperties::maxMipLevels is -- ⌊log2(max(extent.width, extent.height, -- extent.depth))⌋ + -- 1.
  - ImageFormatProperties::maxArrayLayers is -- PhysicalDeviceLimits::maxImageArrayLayers.
  - Each -- component of ImageFormatProperties::maxExtent is -- PhysicalDeviceLimits::maxImageDimension2D.
  - ImageFormatProperties::sampleCounts -- contains exactly SAMPLE_COUNT_1_BIT.
Let uint32_t imageCreateMaxMipLevels be the minimum value -- of ImageFormatProperties::maxMipLevels in -- imageCreateImageFormatPropertiesList. The value is undefined -- if imageCreateImageFormatPropertiesList is empty.
Let uint32_t imageCreateMaxArrayLayers be the minimum -- value of ImageFormatProperties::maxArrayLayers in -- imageCreateImageFormatPropertiesList. The value is undefined -- if imageCreateImageFormatPropertiesList is empty.
Let VkExtent3D imageCreateMaxExtent be the component-wise -- minimum over all ImageFormatProperties::maxExtent -- values in imageCreateImageFormatPropertiesList. The value is -- undefined if imageCreateImageFormatPropertiesList is -- empty.
Let VkSampleCountFlags imageCreateSampleCounts be the -- intersection of each -- ImageFormatProperties::sampleCounts in -- imageCreateImageFormatPropertiesList. The value is undefined -- if imageCreateImageFormatPropertiesList is empty.

-- --

Valid Usage

-- --

Each of the following values (as described in Image Creation -- Limits) must not be undefined -- imageCreateMaxMipLevels, imageCreateMaxArrayLayers, -- imageCreateMaxExtent, and -- imageCreateSampleCounts

-- --

If sharingMode is SHARING_MODE_CONCURRENT, -- pQueueFamilyIndices must be a valid pointer to an -- array of queueFamilyIndexCount uint32_t values
If sharingMode is SHARING_MODE_CONCURRENT, -- queueFamilyIndexCount must be greater than -- 1
If sharingMode is SHARING_MODE_CONCURRENT, each -- element of pQueueFamilyIndices must be unique and -- must be less than pQueueFamilyPropertyCount returned -- by either getPhysicalDeviceQueueFamilyProperties or -- getPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
If the pNext chain includes a -- ExternalFormatANDROID structure, and its -- externalFormat member is non-zero the format -- must be FORMAT_UNDEFINED
If the pNext chain does not include a -- ExternalFormatANDROID structure, or does and its -- externalFormat member is 0, the format -- must not be 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 -- IMAGE_CREATE_CUBE_COMPATIBLE_BIT, imageType -- must be IMAGE_TYPE_2D
If flags contains -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, imageType -- must be IMAGE_TYPE_2D
If flags contains -- IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, imageType -- must be IMAGE_TYPE_3D
extent.width must be less than or equal to -- imageCreateMaxExtent.width (as defined in Image Creation -- Limits)
extent.height must be less than or equal to -- imageCreateMaxExtent.height (as defined in Image Creation -- Limits)
extent.depth must be less than or equal to -- imageCreateMaxExtent.depth (as defined in Image Creation -- Limits)
If imageType is IMAGE_TYPE_2D and flags -- contains 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 IMAGE_TYPE_1D, both -- extent.height and extent.depth must be -- 1
If imageType is IMAGE_TYPE_2D, -- extent.depth must be 1
mipLevels must be less than or equal to the number -- of levels in the complete mipmap chain based on extent.width, -- extent.height, and extent.depth
mipLevels must be less than or equal to -- imageCreateMaxMipLevels (as defined in Image Creation -- Limits)
arrayLayers must be less than or equal to -- imageCreateMaxArrayLayers (as defined in Image Creation -- Limits)
If imageType is IMAGE_TYPE_3D, -- arrayLayers must be 1
If samples is not SAMPLE_COUNT_1_BIT, then -- imageType must be IMAGE_TYPE_2D, flags -- must not contain IMAGE_CREATE_CUBE_COMPATIBLE_BIT, -- mipLevels must be equal to 1, and -- imageCreateMaybeLinear (as defined in Image Creation -- Limits) must be false,
If samples is not SAMPLE_COUNT_1_BIT, -- usage must not contain -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
If usage includes -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, then bits other than -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, and -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT must not be set
If usage includes -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.width -- must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferWidth
If usage includes -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.height -- must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferHeight
If usage includes -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, extent.width -- must be less than or equal to <math>
If usage includes -- IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, -- extent.height must be less than or equal to -- <math>
If usage includes -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, usage -- must also contain at least one of -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT, -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT
samples must be a bit value that is set in -- imageCreateSampleCounts (as defined in Image Creation -- Limits)
If the multisampled storage images feature is not enabled, -- and usage contains IMAGE_USAGE_STORAGE_BIT, -- samples must be SAMPLE_COUNT_1_BIT
If the sparse bindings feature is not enabled, -- flags must not contain -- IMAGE_CREATE_SPARSE_BINDING_BIT
If the sparse aliased residency feature is not enabled, -- flags must not contain -- IMAGE_CREATE_SPARSE_ALIASED_BIT
If imageType is IMAGE_TYPE_1D, flags -- must not contain IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for 2D images feature is not -- enabled, and imageType is IMAGE_TYPE_2D, -- flags must not contain -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for 3D images feature is not -- enabled, and imageType is IMAGE_TYPE_3D, -- flags must not contain -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 2 samples feature -- is not enabled, imageType is IMAGE_TYPE_2D, and -- samples is SAMPLE_COUNT_2_BIT, flags -- must not contain IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 4 samples feature -- is not enabled, imageType is IMAGE_TYPE_2D, and -- samples is SAMPLE_COUNT_4_BIT, flags -- must not contain IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 8 samples feature -- is not enabled, imageType is IMAGE_TYPE_2D, and -- samples is SAMPLE_COUNT_8_BIT, flags -- must not contain IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If the sparse residency for images with 16 samples feature -- is not enabled, imageType is IMAGE_TYPE_2D, and -- samples is SAMPLE_COUNT_16_BIT, flags -- must not contain IMAGE_CREATE_SPARSE_RESIDENCY_BIT
If flags contains -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT or -- IMAGE_CREATE_SPARSE_ALIASED_BIT, it must also contain -- IMAGE_CREATE_SPARSE_BINDING_BIT
If any of the bits IMAGE_CREATE_SPARSE_BINDING_BIT, -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or -- IMAGE_CREATE_SPARSE_ALIASED_BIT are set, -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT must not also be -- set
If the protected memory feature is not enabled, flags -- must not contain IMAGE_CREATE_PROTECTED_BIT
If any of the bits IMAGE_CREATE_SPARSE_BINDING_BIT, -- IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or -- IMAGE_CREATE_SPARSE_ALIASED_BIT are set, -- IMAGE_CREATE_PROTECTED_BIT must not also be set
If the pNext chain includes a -- ExternalMemoryImageCreateInfoNV structure, it must not -- contain a ExternalMemoryImageCreateInfo structure
If the pNext chain includes a -- ExternalMemoryImageCreateInfo structure, its -- handleTypes member must only contain bits that are -- also in -- ExternalImageFormatProperties::externalMemoryProperties.compatibleHandleTypes, -- as returned by getPhysicalDeviceImageFormatProperties2 with -- format, imageType, tiling, usage, -- and flags equal to those in this structure, and with a -- PhysicalDeviceExternalImageFormatInfo structure included in the -- pNext chain, with a handleType equal to any one of -- the handle types specified in -- ExternalMemoryImageCreateInfo::handleTypes
If the pNext chain includes a -- ExternalMemoryImageCreateInfoNV structure, its -- handleTypes member must only contain bits that are -- also in -- ExternalImageFormatPropertiesNV::externalMemoryProperties.compatibleHandleTypes, -- as returned by getPhysicalDeviceExternalImageFormatPropertiesNV -- 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 -- ExternalMemoryImageCreateInfoNV::handleTypes
If the logical device was created with -- DeviceGroupDeviceCreateInfo::physicalDeviceCount equal -- to 1, flags must not contain -- IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT
If flags contains -- IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT, then -- mipLevels must be one, arrayLayers -- must be one, imageType must be -- IMAGE_TYPE_2D. and imageCreateMaybeLinear (as defined -- in Image Creation Limits) must be false
If flags contains -- 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 -- IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, then -- flags must also contain -- IMAGE_CREATE_MUTABLE_FORMAT_BIT
initialLayout must be -- IMAGE_LAYOUT_UNDEFINED or -- IMAGE_LAYOUT_PREINITIALIZED
If the pNext chain includes a -- ExternalMemoryImageCreateInfo or -- ExternalMemoryImageCreateInfoNV structure whose -- handleTypes member is not 0, initialLayout -- must be IMAGE_LAYOUT_UNDEFINED
If the image format is one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion, -- then mipLevels must be 1
If the image format is one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion, -- samples must be SAMPLE_COUNT_1_BIT
If the image format is one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion, -- imageType must be IMAGE_TYPE_2D
If the image format is one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion, -- and the ycbcrImageArrays feature is not enabled, -- arrayLayers must be 1
If format is a multi-planar format, and if -- imageCreateFormatFeatures (as defined in Image Creation -- Limits) does not contain FORMAT_FEATURE_DISJOINT_BIT, then -- flags must not contain -- IMAGE_CREATE_DISJOINT_BIT
If format is not a multi-planar format, and -- flags does not include IMAGE_CREATE_ALIAS_BIT, -- flags must not contain -- IMAGE_CREATE_DISJOINT_BIT
If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, -- then the pNext chain must include exactly one of -- ImageDrmFormatModifierListCreateInfoEXT or -- ImageDrmFormatModifierExplicitCreateInfoEXT structures
If the pNext chain includes a -- ImageDrmFormatModifierListCreateInfoEXT or -- ImageDrmFormatModifierExplicitCreateInfoEXT structure, then -- tiling must be -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT -- and flags contains IMAGE_CREATE_MUTABLE_FORMAT_BIT, -- then the pNext chain must include a -- ImageFormatListCreateInfo structure with non-zero -- viewFormatCount
If flags contains -- IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT -- format must be a depth or depth/stencil format
If the pNext chain includes a -- ExternalMemoryImageCreateInfo structure whose -- handleTypes member includes -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID, -- imageType must be IMAGE_TYPE_2D
If the pNext chain includes a -- ExternalMemoryImageCreateInfo structure whose -- handleTypes member includes -- EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID, -- mipLevels must either be 1 or equal to the -- number of levels in the complete mipmap chain based on -- extent.width, extent.height, and -- extent.depth
If the pNext chain includes a -- ExternalFormatANDROID structure whose externalFormat -- member is not 0, flags must not include -- IMAGE_CREATE_MUTABLE_FORMAT_BIT
If the pNext chain includes a -- ExternalFormatANDROID structure whose externalFormat -- member is not 0, usage must not include any -- usages except IMAGE_USAGE_SAMPLED_BIT
If the pNext chain includes a -- ExternalFormatANDROID structure whose externalFormat -- member is not 0, tiling must be -- IMAGE_TILING_OPTIMAL
If format is a depth-stencil format, usage -- includes IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, and the -- pNext chain includes a ImageStencilUsageCreateInfo -- structure, then its -- ImageStencilUsageCreateInfo::stencilUsage member -- must also include -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If format is a depth-stencil format, usage does -- not include IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, and the -- pNext chain includes a ImageStencilUsageCreateInfo -- structure, then its -- ImageStencilUsageCreateInfo::stencilUsage member -- must also not include -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If format is a depth-stencil format, usage -- includes IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, and the -- pNext chain includes a ImageStencilUsageCreateInfo -- structure, then its -- ImageStencilUsageCreateInfo::stencilUsage member -- must also include -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
If format is a depth-stencil format, usage does -- not include IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, and the -- pNext chain includes a ImageStencilUsageCreateInfo -- structure, then its -- ImageStencilUsageCreateInfo::stencilUsage member -- must also not include -- IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
If Format is a depth-stencil format and the pNext -- chain includes a ImageStencilUsageCreateInfo structure with its -- stencilUsage member including -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.width -- must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferWidth
If format is a depth-stencil format and the -- pNext chain includes a ImageStencilUsageCreateInfo -- structure with its stencilUsage member including -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT, extent.height -- must be less than or equal to -- PhysicalDeviceLimits::maxFramebufferHeight
If the multisampled storage images feature is not enabled, -- format is a depth-stencil format and the pNext chain -- includes a ImageStencilUsageCreateInfo structure with its -- stencilUsage including IMAGE_USAGE_STORAGE_BIT, -- samples must be SAMPLE_COUNT_1_BIT
If flags contains -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV, imageType -- must be IMAGE_TYPE_2D or IMAGE_TYPE_3D
If flags contains -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV, it must not contain -- IMAGE_CREATE_CUBE_COMPATIBLE_BIT and the format -- must not be a depth/stencil format
If flags contains -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV and imageType is -- IMAGE_TYPE_2D, extent.width and extent.height -- must be greater than 1
If flags contains -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV and imageType is -- IMAGE_TYPE_3D, extent.width, extent.height, -- and extent.depth must be greater than 1
If usage includes -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, imageType -- must be IMAGE_TYPE_2D
If usage includes -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, samples -- must be SAMPLE_COUNT_1_BIT
If usage includes -- IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, tiling -- must be IMAGE_TILING_OPTIMAL
If flags contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT, -- tiling must be IMAGE_TILING_OPTIMAL
If flags contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT, -- imageType must be IMAGE_TYPE_2D
If flags contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT, -- flags must not contain -- IMAGE_CREATE_CUBE_COMPATIBLE_BIT
If flags contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT, -- mipLevels must be 1

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- DedicatedAllocationImageCreateInfoNV, -- ExternalFormatANDROID, ExternalMemoryImageCreateInfo, -- ExternalMemoryImageCreateInfoNV, -- ImageDrmFormatModifierExplicitCreateInfoEXT, -- ImageDrmFormatModifierListCreateInfoEXT, -- ImageFormatListCreateInfo, ImageStencilUsageCreateInfo, -- or ImageSwapchainCreateInfoKHR
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- ImageCreateFlagBits values
imageType must be a valid ImageType -- value
format must be a valid Format value
samples must be a valid SampleCountFlagBits -- value
tiling must be a valid ImageTiling -- value
usage must be a valid combination of -- ImageUsageFlagBits values
usage must not be 0
sharingMode must be a valid SharingMode -- value
initialLayout must be a valid ImageLayout -- value

-- -- </section> = See Also -- -- Extent3D, Format, ImageCreateFlags, -- ImageLayout, ImageTiling, ImageType, -- ImageUsageFlags, SampleCountFlagBits, -- SharingMode, StructureType, createImage data ImageCreateInfo (es :: [Type]) ImageCreateInfo :: Chain es -> ImageCreateFlags -> ImageType -> Format -> Extent3D -> Word32 -> Word32 -> SampleCountFlagBits -> ImageTiling -> ImageUsageFlags -> SharingMode -> Vector Word32 -> ImageLayout -> ImageCreateInfo -- | pNext is NULL or a pointer to an extension-specific -- structure. [$sel:next:ImageCreateInfo] :: ImageCreateInfo -> Chain es -- | flags is a bitmask of ImageCreateFlagBits describing -- additional parameters of the image. [$sel:flags:ImageCreateInfo] :: ImageCreateInfo -> ImageCreateFlags -- | imageType is a ImageType value specifying the basic -- dimensionality of the image. Layers in array textures do not count as -- a dimension for the purposes of the image type. [$sel:imageType:ImageCreateInfo] :: ImageCreateInfo -> ImageType -- | format is a Format describing the format and type of -- the texel blocks that will be contained in the image. [$sel:format:ImageCreateInfo] :: ImageCreateInfo -> Format -- | extent is a Extent3D describing the number of data -- elements in each dimension of the base level. [$sel:extent:ImageCreateInfo] :: ImageCreateInfo -> Extent3D -- | mipLevels describes the number of levels of detail available -- for minified sampling of the image. [$sel:mipLevels:ImageCreateInfo] :: ImageCreateInfo -> Word32 -- | arrayLayers is the number of layers in the image. [$sel:arrayLayers:ImageCreateInfo] :: ImageCreateInfo -> Word32 -- | samples is a SampleCountFlagBits specifying the number -- of samples per texel. [$sel:samples:ImageCreateInfo] :: ImageCreateInfo -> SampleCountFlagBits -- | tiling is a ImageTiling value specifying the tiling -- arrangement of the texel blocks in memory. [$sel:tiling:ImageCreateInfo] :: ImageCreateInfo -> ImageTiling -- | usage is a bitmask of ImageUsageFlagBits describing -- the intended usage of the image. [$sel:usage:ImageCreateInfo] :: ImageCreateInfo -> ImageUsageFlags -- | sharingMode is a SharingMode value specifying the -- sharing mode of the image when it will be accessed by multiple queue -- families. [$sel:sharingMode:ImageCreateInfo] :: ImageCreateInfo -> SharingMode -- | pQueueFamilyIndices is a list of queue families that will -- access this image (ignored if sharingMode is not -- SHARING_MODE_CONCURRENT). [$sel:queueFamilyIndices:ImageCreateInfo] :: ImageCreateInfo -> Vector Word32 -- | initialLayout is a ImageLayout value specifying the -- initial ImageLayout of all image subresources of the image. See -- Image Layouts. [$sel:initialLayout:ImageCreateInfo] :: ImageCreateInfo -> ImageLayout -- | VkSubresourceLayout - Structure specifying subresource layout -- --

Description

-- -- If the image is linear, then 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;
--

-- -- The value of arrayPitch is undefined for images that were not -- created as arrays. depthPitch is defined only for 3D images. -- -- If the image has a single-plane color format and its tiling is -- IMAGE_TILING_LINEAR , then the aspectMask member of -- ImageSubresource must be IMAGE_ASPECT_COLOR_BIT. -- -- If the image has a depth/stencil format and its tiling is -- IMAGE_TILING_LINEAR , then aspectMask must be -- either IMAGE_ASPECT_DEPTH_BIT or -- 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. -- -- If the image has a multi-planar format and its tiling is -- IMAGE_TILING_LINEAR , then the aspectMask member of -- ImageSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- (for 3-plane formats only) 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. If the image is disjoint, then the -- offset is relative to the base address of the plane. If the -- image is non-disjoint, then the offset is relative to -- the base address of the image. -- -- If the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, -- then the aspectMask member of ImageSubresource -- must be one of VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, -- where the maximum allowed plane index i is defined by the -- DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount -- associated with the image’s ImageCreateInfo::format -- and modifier. The memory range used by the subresource is -- described by offset and size. If the image is -- disjoint, then the offset is relative to the base -- address of the memory plane. If the image is -- non-disjoint, then the offset is relative to the base -- address of the image. If the image is non-linear, then -- rowPitch, arrayPitch, and depthPitch have -- an implementation-dependent meaning. -- --

Parameters

-- --

device is the logical device that owns the image.

-- --

image is the queried image.
pProperties will return properties of the image’s /DRM -- format modifier/.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_DRM_FORMAT_MODIFIER_INFO_EXT

-- --

sharingMode must be a valid SharingMode -- value

-- --

Description

-- -- The ith member of pPlaneLayouts describes the layout -- of the image’s ith memory plane (that is, -- VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT). In each element of -- pPlaneLayouts, the implementation must ignore -- size. The implementation calculates the size of each plane, -- which the application can query with -- getImageSubresourceLayout. -- -- When creating an image with -- ImageDrmFormatModifierExplicitCreateInfoEXT, it is the -- application’s responsibility to satisfy all valid usage requirements. -- However, the implementation must validate that the provided -- pPlaneLayouts, when combined with the provided -- drmFormatModifier and other creation parameters in -- ImageCreateInfo and its pNext chain, produce a valid -- image. (This validation is necessarily implementation-dependent and -- outside the scope of Vulkan, and therefore not described by valid -- usage requirements). If this validation fails, then createImage -- returns ERROR_INVALID_DRM_FORMAT_MODIFIER_PLANE_LAYOUT_EXT. -- --

Valid Usage

-- --

drmFormatModifier must be compatible with the -- parameters in ImageCreateInfo and its pNext chain, as -- determined by querying PhysicalDeviceImageFormatInfo2 extended -- with PhysicalDeviceImageDrmFormatModifierInfoEXT

-- --

drmFormatModifierPlaneCount must be equal to the -- DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount -- associated with ImageCreateInfo::format and -- drmFormatModifier, as found by querying -- DrmFormatModifierPropertiesListEXT
For each element of pPlaneLayouts, size -- must be 0
For each element of pPlaneLayouts, arrayPitch -- must be 0 if ImageCreateInfo::arrayLayers is -- 1
For each element of pPlaneLayouts, depthPitch -- must be 0 if ImageCreateInfo::extent.depth is -- 1

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT

-- --

If drmFormatModifierPlaneCount is not 0, -- pPlaneLayouts must be a valid pointer to an array of -- drmFormatModifierPlaneCount SubresourceLayout -- structures

-- --

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 -- SampleCountFlagBits.
usage is a bitmask describing the intended usage of the -- image.
tiling is the tiling arrangement of the texel blocks 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 SparseImageFormatProperties 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 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 -- SparseImageFormatProperties data. -- -- Depth/stencil images with depth and stencil data interleaved into a -- single plane will return a single SparseImageFormatProperties -- structure with the aspectMask set to -- IMAGE_ASPECT_DEPTH_BIT | IMAGE_ASPECT_STENCIL_BIT. -- --

Valid Usage

-- --

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

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

format must be a valid Format value
type must be a valid ImageType value
samples must be a valid SampleCountFlagBits -- value
usage must be a valid combination of -- ImageUsageFlagBits values
usage must not be 0
tiling must be a valid ImageTiling -- 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 SparseImageFormatProperties -- 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 a pointer to an array of -- BindSparseInfo structures, each specifying a sparse binding -- submission batch.
fence is an optional handle to a fence to be -- signaled. If fence is not NULL_HANDLE, it defines a -- fence signal operation.

-- --

Description

-- -- queueBindSparse is a queue submission command, with each -- batch defined by an element of pBindInfo as a -- BindSparseInfo 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 queueBindSparse 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 NULL_HANDLE, fence -- must be unsignaled

-- --

If fence is not 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 wait operation referring to a binary semaphore -- defined by any element of the pWaitSemaphores member of any -- element of pBindInfo executes on queue, there -- must be no other queues waiting on the same semaphore
All elements of the pWaitSemaphores member of all -- elements of pBindInfo member referring to a binary semaphore -- must be semaphores that are signaled, or have semaphore -- signal operations previously submitted for execution
All elements of the pWaitSemaphores member of all -- elements of pBindInfo created with a SemaphoreType of -- SEMAPHORE_TYPE_BINARY must reference a semaphore signal -- operation that has been submitted for execution and any semaphore -- signal operations on which it depends (if any) must have also -- been submitted for execution

-- --

Valid Usage (Implicit)

-- --

queue must be a valid Queue handle

-- --

If bindInfoCount is not 0, pBindInfo -- must be a valid pointer to an array of bindInfoCount -- valid BindSparseInfo structures
If fence is not NULL_HANDLE, fence -- must be a valid Fence handle
The queue must support sparse binding -- operations
Both of fence, and queue that are valid handles -- of non-ignored parameters must have been created, allocated, or -- retrieved from the same Device

-- --

Host Synchronization

-- --

Host access to queue 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

-- -- ' -- -- TODO: table -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

-- -- The binding range [resourceOffset, -- resourceOffset + size) has different constraints -- based on flags. If flags contains -- 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 -- SparseImageMemoryRequirements 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 -- SparseImageMemoryRequirements::formatProperties.flags -- contains SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT. -- -- If flags does not contain -- SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must -- be within the range [0,MemoryRequirements::size). -- --

Valid Usage

-- --

If memory is not NULL_HANDLE, memory and -- memoryOffset must match the memory requirements of the -- resource, as described in section -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#resources-association

-- --

If memory is not NULL_HANDLE, memory -- must not have been created with a memory type that reports -- 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
If memory was created with -- ExportMemoryAllocateInfo::handleTypes not equal to -- 0, at least one handle type it contained must also -- have been set in -- ExternalMemoryBufferCreateInfo::handleTypes or -- ExternalMemoryImageCreateInfo::handleTypes when the -- resource was created
If memory was created by a memory import operation, the -- external handle type of the imported memory must also have been -- set in ExternalMemoryBufferCreateInfo::handleTypes or -- ExternalMemoryImageCreateInfo::handleTypes when the -- resource was created

-- --

Valid Usage (Implicit)

-- --

If memory is not NULL_HANDLE, memory -- must be a valid DeviceMemory handle

-- --

flags must be a valid combination of -- SparseMemoryBindFlagBits values

-- --

Parameters

-- --

device is the logical device that owns the buffer.

-- --

pInfo is a pointer to a -- BufferMemoryRequirementsInfo2 structure containing parameters -- required for the memory requirements query.
pMemoryRequirements is a pointer to a -- MemoryRequirements2 structure in which the memory requirements -- of the buffer object are returned.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

pInfo is a pointer to a -- ImageMemoryRequirementsInfo2 structure containing parameters -- required for the memory requirements query.
pMemoryRequirements is a pointer to a -- MemoryRequirements2 structure in which the memory requirements -- of the image object are returned.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

device is the logical device that owns the image.

-- --

pInfo is a pointer to a -- ImageSparseMemoryRequirementsInfo2 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 SparseImageMemoryRequirements2 -- structures.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- ImageSparseMemoryRequirementsInfo2 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 -- SparseImageMemoryRequirements2 structures

-- --

Description

Parameters

-- --

device is the logical device that creates the fence.

-- --

pCreateInfo is a pointer to a FenceCreateInfo -- structure containing information about how the fence is to be -- created.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pFence is a pointer to a handle in which the resulting -- fence object is returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- FenceCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pFence must be a valid pointer to a Fence -- handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

All queue submission commands that refer to fence -- must have completed execution

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If fence is not NULL_HANDLE, fence -- must be a valid Fence handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 resetFences 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 resetFences is executed, then resetFences 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 Device handle

-- --

pFences must be a valid pointer to an array of -- fenceCount valid Fence 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
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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, getFenceStatus returns the status of the fence -- object, with the following return codes: -- -- TODO: table -- -- 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), -- getFenceStatus may return any of the above status codes. -- If the device has been lost and getFenceStatus is called -- repeatedly, it will eventually return either SUCCESS or -- ERROR_DEVICE_LOST. -- --

Return Codes

-- --

Success --
- SUCCESS
- NOT_READY

-- --

Failure --

-- --

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 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 waitForFences is called, -- then waitForFences returns immediately. If the condition is not -- satisfied at the time waitForFences is called, then -- waitForFences will block and wait up to timeout -- nanoseconds for the condition to become satisfied. -- -- If timeout is zero, then waitForFences does not wait, -- but simply returns the current state of the fences. 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, waitForFences returns TIMEOUT. If the -- condition is satisfied before timeout nanoseconds has -- expired, waitForFences returns SUCCESS. -- -- If device loss occurs (see Lost Device) before the timeout has -- expired, waitForFences must return in finite time with -- either SUCCESS or ERROR_DEVICE_LOST. -- -- Note -- -- While we guarantee that waitForFences 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 waitForFences -- will not result in a permanently (or seemingly permanently) dead -- process. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pFences must be a valid pointer to an array of -- fenceCount valid Fence handles
fenceCount must be greater than 0
Each element of pFences must have been created, -- allocated, or retrieved from device

-- --

Return Codes

-- --

Success --
- SUCCESS
- TIMEOUT

-- --

Failure --

-- --

Parameters

-- --

pCreateInfo is a pointer to a InstanceCreateInfo -- structure controlling creation of the instance.

-- --

pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pInstance points a Instance handle in which the -- resulting instance is returned.

-- --

Description

-- -- createInstance verifies that the requested layers exist. If -- not, createInstance will return ERROR_LAYER_NOT_PRESENT. -- Next createInstance verifies that the requested extensions are -- supported (e.g. in the implementation or in any enabled instance -- layer) and if any requested extension is not supported, -- createInstance must return -- ERROR_EXTENSION_NOT_PRESENT. After verifying and enabling the -- instance layers and extensions the Instance 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 createInstance time for the creation to succeed. -- --

Valid Usage

-- --

All required extensions for each extension in the -- InstanceCreateInfo::ppEnabledExtensionNames list -- must also be present in that list

-- --

Valid Usage (Implicit)

-- --

pCreateInfo must be a valid pointer to a valid -- InstanceCreateInfo structure

-- --

If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pInstance must be a valid pointer to a -- Instance handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

instance is the handle of the instance to destroy.

-- --

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

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

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

-- --

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

-- --

Host Synchronization

-- --

Host access to instance must be externally -- synchronized

-- --

Host access to all PhysicalDevice objects enumerated from -- instance must be externally synchronized

-- --

Parameters

-- --

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

-- --

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 PhysicalDevice 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, INCOMPLETE will be -- returned instead of SUCCESS, to indicate that not all the -- available physical devices were returned. -- --

Valid Usage (Implicit)

-- --

instance must be a valid Instance -- 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 PhysicalDevice handles

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

If instance is not NULL, instance -- must be a valid Instance 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 is a pointer to a -- PhysicalDeviceProperties structure in which properties are -- returned.

-- --

Valid Usage (Implicit)

-- --

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 QueueFamilyProperties structures.

-- --

Description

-- -- If pQueueFamilyProperties is NULL, then the number -- of queue families available is returned in -- pQueueFamilyPropertyCount. Implementations must -- support at least one queue family. 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 -- PhysicalDevice 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 -- QueueFamilyProperties structures

-- --

Parameters

-- --

physicalDevice is the handle to the device to query.

-- --

pMemoryProperties is a pointer to a -- PhysicalDeviceMemoryProperties structure in which the -- properties are returned.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

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 -- FormatProperties structure in which physical device properties -- for format are returned.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

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

-- --

format is a Format value specifying the image -- format, corresponding to ImageCreateInfo::format.
type is a ImageType value specifying the image -- type, corresponding to -- ImageCreateInfo::imageType.
tiling is a ImageTiling value specifying the image -- tiling, corresponding to ImageCreateInfo::tiling.
usage is a bitmask of ImageUsageFlagBits -- specifying the intended usage of the image, corresponding to -- ImageCreateInfo::usage.
flags is a bitmask of ImageCreateFlagBits -- specifying additional parameters of the image, corresponding to -- ImageCreateInfo::flags.
pImageFormatProperties is a pointer to a -- ImageFormatProperties structure in which capabilities are -- returned.

-- --

Description

-- -- The format, type, tiling, usage, -- and flags parameters correspond to parameters that would be -- consumed by createImage (as members of ImageCreateInfo). -- -- 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 -- getPhysicalDeviceImageFormatProperties returns -- ERROR_FORMAT_NOT_SUPPORTED. -- -- The limitations on an image format that are reported by -- getPhysicalDeviceImageFormatProperties have the following -- property: if usage1 and usage2 of type -- ImageUsageFlags are such that the bits set in usage1 -- are a subset of the bits set in usage2, and flags1 -- and flags2 of type ImageCreateFlags 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. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Description

-- -- Note -- -- The value of apiVersion may be different than the -- version returned by enumerateInstanceVersion; either higher or -- lower. In such cases, the application must not use -- functionality that exceeds the version of Vulkan associated with a -- given object. The pApiVersion parameter returned by -- enumerateInstanceVersion is the version associated with a -- Instance and its children, except for a PhysicalDevice -- and its children. PhysicalDeviceProperties::apiVersion -- is the version associated with a PhysicalDevice and its -- children. -- -- The vendorID and deviceID fields are provided to -- allow applications to adapt to device characteristics that are not -- adequately exposed by other Vulkan queries. -- -- Note -- -- These may include performance profiles, hardware errata, or -- other characteristics. -- -- The vendor identified by vendorID is the entity -- responsible for the most salient characteristics of the underlying -- implementation of the PhysicalDevice being queried. -- -- Note -- -- For example, in the case of a discrete GPU implementation, this -- should be the GPU chipset vendor. In the case of a hardware -- accelerator integrated into a system-on-chip (SoC), this should -- be the supplier of the silicon IP used to create the accelerator. -- -- If the vendor has a PCI vendor ID, the low 16 bits of -- vendorID must contain that PCI vendor ID, and the -- remaining bits must be set to zero. Otherwise, the value -- returned must be a valid Khronos vendor ID, obtained as -- described in the Vulkan Documentation and Extensions: Procedures -- and Conventions document in the section “Registering a Vendor ID -- with Khronos”. Khronos vendor IDs are allocated starting at 0x10000, -- to distinguish them from the PCI vendor ID namespace. Khronos vendor -- IDs are symbolically defined in the VendorId type. -- -- The vendor is also responsible for the value returned in -- deviceID. If the implementation is driven primarily by a -- PCI device with a PCI device ID, the low 16 bits of -- deviceID must contain that PCI device ID, and the -- remaining bits must be set to zero. Otherwise, the choice of -- what values to return may be dictated by operating system or -- platform policies - but should uniquely identify both the -- device version and any major configuration options (for example, core -- count in the case of multicore devices). -- -- Note -- -- The same device ID should be used for all physical -- implementations of that device version and configuration. For example, -- all uses of a specific silicon IP GPU version and configuration -- should use the same device ID, even if those uses occur in -- different SoCs. -- --

Description

-- -- Vulkan 1.0 implementations were required to return -- ERROR_INCOMPATIBLE_DRIVER if apiVersion was larger -- than 1.0. Implementations that support Vulkan 1.1 or later must -- not return ERROR_INCOMPATIBLE_DRIVER for any value of -- apiVersion. -- -- Note -- -- Because Vulkan 1.0 implementations may fail with -- ERROR_INCOMPATIBLE_DRIVER, applications should determine -- the version of Vulkan available before calling createInstance. -- If the getInstanceProcAddr returns NULL for -- enumerateInstanceVersion, it is a Vulkan 1.0 implementation. -- Otherwise, the application can call -- enumerateInstanceVersion to determine the version of Vulkan. -- -- As long as the instance supports at least Vulkan 1.1, an application -- can use different versions of Vulkan with an instance than it -- does with a device or physical device. -- -- Note -- -- The Khronos validation layers will treat apiVersion as the -- highest API version the application targets, and will validate API -- usage against the minimum of that version and the implementation -- version (instance or device, depending on context). If an application -- tries to use functionality from a greater version than this, a -- validation error will be triggered. -- -- For example, if the instance supports Vulkan 1.1 and three physical -- devices support Vulkan 1.0, Vulkan 1.1, and Vulkan 1.2, respectively, -- and if the application sets apiVersion to 1.2, the -- application can use the following versions of Vulkan: -- --

Vulkan 1.0 can be used with the instance and with all -- physical devices.
Vulkan 1.1 can be used with the instance and with the -- physical devices that support Vulkan 1.1 and Vulkan 1.2.
Vulkan 1.2 can be used with the physical device that -- supports Vulkan 1.2.

-- -- If we modify the above example so that the application sets -- apiVersion to 1.1, then the application must not use -- Vulkan 1.2 functionality on the physical device that supports Vulkan -- 1.2. -- -- Implicit layers must be disabled if they do not support a -- version at least as high as apiVersion. See the Vulkan -- Loader Specification and Architecture Overview document for -- additional information. -- -- Note -- -- Providing a NULL -- InstanceCreateInfo::pApplicationInfo or providing an -- apiVersion of 0 is equivalent to providing an -- apiVersion of VK_MAKE_VERSION(1,0,0). -- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_APPLICATION_INFO

-- --

pNext must be NULL
If pApplicationName is not NULL, -- pApplicationName must be a null-terminated UTF-8 -- string
If pEngineName is not NULL, pEngineName -- must be a null-terminated UTF-8 string

-- --

Description

-- -- The value returned in minImageTransferGranularity has a unit -- of compressed texel blocks for images having a block-compressed -- format, and a unit of texels otherwise. -- -- Possible values of minImageTransferGranularity are: -- --

(0,0,0) which indicates that only whole mip levels must be -- transferred using the image transfer operations on the corresponding -- queues. In this case, the following restrictions apply to all offset -- and extent parameters of image transfer operations:
- The -- x, y, and z members of a Offset3D -- parameter must always be zero.
- The width, -- height, and depth members of a Extent3D -- parameter must always match the width, height, and depth of the -- image subresource corresponding to the parameter, -- respectively.
(Ax, Ay, Az) where Ax, Ay, and Az are all integer powers of two. -- In this case the following restrictions apply to all image transfer -- operations:
- x, y, and z of a -- Offset3D parameter must be integer multiples of Ax, Ay, -- and Az, respectively.
- width of a Extent3D -- parameter must be an integer multiple of Ax, or else x -- + width must equal the width of the image subresource -- corresponding to the parameter.
- height of a -- Extent3D parameter must be an integer multiple of Ay, or -- else y + height must equal the height of the -- image subresource corresponding to the -- parameter.
- depth of a Extent3D parameter -- must be an integer multiple of Az, or else z + -- depth must equal the depth of the image subresource -- corresponding to the parameter.
- If the format of the image -- corresponding to the parameters is one of the block-compressed formats -- then for the purposes of the above calculations the granularity -- must be scaled up by the compressed texel block -- dimensions.

-- -- Queues supporting graphics and/or compute operations must -- report (1,1,1) in minImageTransferGranularity, meaning that -- there are no additional restrictions on the granularity of image -- transfer operations for these queues. Other queues supporting image -- transfer operations are only required to support whole mip -- level transfers, thus minImageTransferGranularity for queues -- belonging to such queue families may be (0,0,0). -- -- The Device Memory section describes memory properties queried -- from the physical device. -- -- For physical device feature queries see the Features chapter. -- --

Description

-- -- The PhysicalDeviceMemoryProperties 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 MAX_MEMORY_HEAPS. Each heap is described -- by an element of the memoryHeaps array as a MemoryHeap -- structure. The number of memory types available across all memory -- heaps is given by memoryTypeCount and is less than or equal -- to MAX_MEMORY_TYPES. Each memory type is described by an -- element of the memoryTypes array as a MemoryType -- structure. -- -- At least one heap must include -- MEMORY_HEAP_DEVICE_LOCAL_BIT in -- MemoryHeap::flags. If there are multiple heaps that -- all have similar performance characteristics, they may all -- include 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 getPhysicalDeviceMemoryProperties -- must have its propertyFlags set to one of the -- following values: -- --

0
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT
MEMORY_PROPERTY_PROTECTED_BIT
MEMORY_PROPERTY_PROTECTED_BIT | -- MEMORY_PROPERTY_DEVICE_LOCAL_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD | -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD | -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD | -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD | -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT | -- MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_CACHED_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT | -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD | -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD

-- -- There must be at least one memory type with both the -- MEMORY_PROPERTY_HOST_VISIBLE_BIT and -- MEMORY_PROPERTY_HOST_COHERENT_BIT bits set in its -- propertyFlags. There must be at least one memory type -- with the MEMORY_PROPERTY_DEVICE_LOCAL_BIT bit set in its -- propertyFlags. If the deviceCoherentMemory feature is -- enabled, there must be at least one memory type with the -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD 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: -- --

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) ; or
the propertyFlags members of Y includes -- MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD or -- MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD and X does -- not

-- -- 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 a valid -- order. But if instead MEMORY_PROPERTY_DEVICE_LOCAL_BIT was -- before MEMORY_PROPERTY_HOST_VISIBLE_BIT | -- MEMORY_PROPERTY_HOST_COHERENT_BIT, the list would still be in a -- valid order. -- -- There may be a performance penalty for using device coherent or -- uncached device memory types, and using these accidentally is -- undesirable. In order to avoid this, memory types with these -- properties always appear at the end of the list; but are subject to -- the same rules otherwise. -- -- 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

-- -- Note -- -- If no format feature flags are supported, the format itself is not -- supported, and images of that format cannot be created. -- -- If format is a block-compressed format, then -- bufferFeatures must not support any features for the -- format. -- -- If format is not a multi-plane format then -- linearTilingFeatures and optimalTilingFeatures -- must not contain FORMAT_FEATURE_DISJOINT_BIT. -- --

Members

-- --

maxExtent are the maximum image dimensions. See the -- Allowed Extent Values section below for how these values are -- constrained by type.

-- --

maxMipLevels is the maximum number of mipmap levels. -- maxMipLevels must be equal to the number of levels in -- the complete mipmap chain based on the maxExtent.width, -- maxExtent.height, and maxExtent.depth, except when -- one of the following conditions is true, in which case it may -- instead be -- 1:
- getPhysicalDeviceImageFormatProperties::tiling -- was -- IMAGE_TILING_LINEAR
- PhysicalDeviceImageFormatInfo2::tiling -- was IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
- the -- PhysicalDeviceImageFormatInfo2::pNext chain included a -- PhysicalDeviceExternalImageFormatInfo structure with a handle -- type included in the handleTypes member for which mipmap -- image support is not required
- image format is one of -- those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
- flags -- contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT
maxArrayLayers is the maximum number of array layers. -- maxArrayLayers must be no less than -- PhysicalDeviceLimits::maxImageArrayLayers, except when -- one of the following conditions is true, in which case it may -- instead be 1:
- tiling is -- IMAGE_TILING_LINEAR
- tiling is -- IMAGE_TILING_OPTIMAL and type is -- IMAGE_TYPE_3D
- format is one of those listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, -- then maxArrayLayers must not be 0.
sampleCounts is a bitmask of SampleCountFlagBits -- specifying all the supported sample counts for this image as described -- below.
maxResourceSize is an upper bound on the total image size -- in bytes, inclusive of all image subresources. Implementations -- may have an address space limit on total size of a resource, -- which is advertised by this property. maxResourceSize -- must be at least 231.

-- --

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

-- --

format is the image format, corresponding to -- ImageCreateInfo::format.
type is the image type, corresponding to -- ImageCreateInfo::imageType.
tiling is the image tiling, corresponding to -- ImageCreateInfo::tiling.
usage is the intended usage of the image, corresponding -- to ImageCreateInfo::usage.
flags is a bitmask describing additional parameters of -- the image, corresponding to -- ImageCreateInfo::flags.
externalHandleType is either one of the bits from -- ExternalMemoryHandleTypeFlagBitsNV, or 0.
pExternalImageFormatProperties is a pointer to a -- ExternalImageFormatPropertiesNV structure in which capabilities -- are returned.

-- --

Description

-- -- If externalHandleType is 0, -- pExternalImageFormatProperties->imageFormatProperties will -- return the same values as a call to -- getPhysicalDeviceImageFormatProperties, and the other members -- of pExternalImageFormatProperties will all be 0. Otherwise, -- they are filled in as described for -- ExternalImageFormatPropertiesNV. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the logical device that owns the memory.

-- --

memory is the DeviceMemory object.
handleType is a bitmask of -- ExternalMemoryHandleTypeFlagBitsNV containing a single bit -- specifying the type of handle requested.
handle is a pointer to a Windows HANDLE in which -- the handle is returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_TOO_MANY_OBJECTS
- ERROR_OUT_OF_HOST_MEMORY

-- --

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

-- --

pFeatures is a pointer to a -- PhysicalDeviceFeatures2 structure in which the physical device -- features are returned.

-- --

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 -- FormatProperties2 structure in which physical device properties -- for format are returned.

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 getPhysicalDeviceQueueFamilyProperties.
pQueueFamilyProperties is either NULL or a -- pointer to an array of QueueFamilyProperties2 structures.

-- --

Description

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

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice 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 -- QueueFamilyProperties2 structures

-- --

Parameters

-- --

physicalDevice is the handle to the device to query.

-- --

pMemoryProperties is a pointer to a -- PhysicalDeviceMemoryProperties2 structure in which the -- properties are returned.

-- --

sType must be -- 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 -- PhysicalDeviceBlendOperationAdvancedPropertiesEXT, -- PhysicalDeviceConservativeRasterizationPropertiesEXT, -- PhysicalDeviceCooperativeMatrixPropertiesNV, -- PhysicalDeviceDepthStencilResolveProperties, -- PhysicalDeviceDescriptorIndexingProperties, -- PhysicalDeviceDeviceGeneratedCommandsPropertiesNV, -- PhysicalDeviceDiscardRectanglePropertiesEXT, -- PhysicalDeviceDriverProperties, -- PhysicalDeviceExternalMemoryHostPropertiesEXT, -- PhysicalDeviceFloatControlsProperties, -- PhysicalDeviceFragmentDensityMapPropertiesEXT, -- PhysicalDeviceIDProperties, -- PhysicalDeviceInlineUniformBlockPropertiesEXT, -- PhysicalDeviceLineRasterizationPropertiesEXT, -- PhysicalDeviceMaintenance3Properties, -- PhysicalDeviceMeshShaderPropertiesNV, -- PhysicalDeviceMultiviewPerViewAttributesPropertiesNVX, -- PhysicalDeviceMultiviewProperties, -- PhysicalDevicePCIBusInfoPropertiesEXT, -- PhysicalDevicePerformanceQueryPropertiesKHR, -- PhysicalDevicePointClippingProperties, -- PhysicalDeviceProtectedMemoryProperties, -- PhysicalDevicePushDescriptorPropertiesKHR, -- PhysicalDeviceRayTracingPropertiesKHR, -- PhysicalDeviceRayTracingPropertiesNV, -- PhysicalDeviceRobustness2PropertiesEXT, -- PhysicalDeviceSampleLocationsPropertiesEXT, -- PhysicalDeviceSamplerFilterMinmaxProperties, -- PhysicalDeviceShaderCoreProperties2AMD, -- PhysicalDeviceShaderCorePropertiesAMD, -- PhysicalDeviceShaderSMBuiltinsPropertiesNV, -- PhysicalDeviceShadingRateImagePropertiesNV, -- PhysicalDeviceSubgroupProperties, -- PhysicalDeviceSubgroupSizeControlPropertiesEXT, -- PhysicalDeviceTexelBufferAlignmentPropertiesEXT, -- PhysicalDeviceTimelineSemaphoreProperties, -- PhysicalDeviceTransformFeedbackPropertiesEXT, -- PhysicalDeviceVertexAttributeDivisorPropertiesEXT, -- PhysicalDeviceVulkan11Properties, or -- PhysicalDeviceVulkan12Properties
The sType value of each struct in the pNext -- chain must be unique

-- --

Description

-- -- If the combination of parameters to -- getPhysicalDeviceImageFormatProperties2 is not supported by the -- implementation for use in createImage, 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 -- 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 -- AndroidHardwareBufferUsageANDROID, -- ExternalImageFormatProperties, -- FilterCubicImageViewImageFormatPropertiesEXT, -- SamplerYcbcrConversionImageFormatProperties, or -- TextureLODGatherFormatPropertiesAMD
The sType value of each struct in the pNext -- chain must be unique

-- --

Description

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

Valid Usage

-- --

tiling must be -- IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT if and only if the -- pNext chain includes -- PhysicalDeviceImageDrmFormatModifierInfoEXT

-- --

If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT -- and flags contains IMAGE_CREATE_MUTABLE_FORMAT_BIT, -- then the pNext chain must include a -- ImageFormatListCreateInfo structure with non-zero -- viewFormatCount

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_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 ImageFormatListCreateInfo, -- ImageStencilUsageCreateInfo, -- PhysicalDeviceExternalImageFormatInfo, -- PhysicalDeviceImageDrmFormatModifierInfoEXT, or -- PhysicalDeviceImageViewImageFormatInfoEXT
The sType value of each struct in the pNext -- chain must be unique
format must be a valid Format value
type must be a valid ImageType value
tiling must be a valid ImageTiling -- value
usage must be a valid combination of -- ImageUsageFlagBits values
usage must not be 0
flags must be a valid combination of -- ImageCreateFlagBits values

-- --

Description

Parameters

-- --

physicalDevice must be one of the device handles -- returned from a call to enumeratePhysicalDevices (see -- Physical Device Enumeration).

-- --

pCreateInfo is a pointer to a DeviceCreateInfo -- structure containing information about how to create the device.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDevice is a pointer to a handle in which the created -- Device is returned.

-- --

Description

-- -- createDevice 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, -- createDevice must return -- ERROR_EXTENSION_NOT_PRESENT. If any requested feature is not -- supported, createDevice must return -- ERROR_FEATURE_NOT_PRESENT. Support for extensions can be -- checked before creating a device by querying -- enumerateDeviceExtensionProperties. Support for features -- can similarly be checked by querying -- getPhysicalDeviceFeatures. -- -- After verifying and enabling the extensions the Device 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 createInstance 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, createDevice will return ERROR_TOO_MANY_OBJECTS. -- --

Valid Usage

-- --

All required extensions for each extension in the -- DeviceCreateInfo::ppEnabledExtensionNames list -- must also be present in that list

-- --

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

pCreateInfo must be a valid pointer to a valid -- DeviceCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pDevice must be a valid pointer to a Device -- handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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, deviceWaitIdle -- 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 -- Device object. Therefore, to avoid resource leaks, it is -- critical that an application explicitly free all of these resources -- prior to calling destroyDevice. -- --

Valid Usage

-- --

All child objects created on device must have been -- destroyed prior to destroying device

-- --

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

-- --

Valid Usage (Implicit)

-- --

If device is not NULL, device -- must be a valid Device handle

-- --

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

-- --

Host Synchronization

-- --

Host access to device must be externally -- synchronized

-- --

Parameters

-- --

device is the logical device that creates the descriptor -- set layout.

-- --

pCreateInfo is a pointer to a -- DescriptorSetLayoutCreateInfo structure specifying the state of -- the descriptor set layout object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pSetLayout is a pointer to a DescriptorSetLayout -- handle in which the resulting descriptor set layout object is -- returned.

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- DescriptorSetLayoutCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSetLayout must be a valid pointer to a -- DescriptorSetLayout handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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.

-- --

Valid Usage

-- --

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

-- --

If no AllocationCallbacks were provided when -- descriptorSetLayout was created, pAllocator -- must be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If descriptorSetLayout is not NULL_HANDLE, -- descriptorSetLayout must be a valid -- DescriptorSetLayout handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 a -- DescriptorPoolCreateInfo structure specifying the state of the -- descriptor pool object.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pDescriptorPool is a pointer to a DescriptorPool -- 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 Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- DescriptorPoolCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pDescriptorPool must be a valid pointer to a -- DescriptorPool handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 AllocationCallbacks were provided when -- descriptorPool was created, a compatible set of callbacks -- must be provided here
If no AllocationCallbacks were provided when -- descriptorPool was created, pAllocator must -- be NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If descriptorPool is not NULL_HANDLE, -- descriptorPool must be a valid DescriptorPool -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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 Device handle

-- --

descriptorPool must be a valid -- DescriptorPool 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 DescriptorSet objects allocated from -- descriptorPool must be externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Parameters

-- --

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

-- --

pAllocateInfo is a pointer to a -- DescriptorSetAllocateInfo structure describing parameters of -- the allocation.
pDescriptorSets is a pointer to an array of -- DescriptorSet 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. Descriptors also -- become undefined if the underlying resource is destroyed. Descriptor -- sets containing undefined descriptors can still be bound and -- used, subject to the following conditions: -- --

For descriptor set bindings created with the -- DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT 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 -- DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT bit set, all descriptors -- in that binding that are statically used must have been -- populated before the descriptor set is consumed.
Descriptor bindings with descriptor type of -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT can be -- undefined when the descriptor set is consumed; though values in -- that block will be undefined.
Entries that are not used by a pipeline can have undefined -- descriptors.

-- -- If a call to allocateDescriptorSets would cause the total -- number of descriptor sets allocated from the pool to exceed the value -- of DescriptorPoolCreateInfo::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 allocateDescriptorSets would cause the number of any -- given descriptor type to exceed the sum of all the -- descriptorCount members of each element of -- DescriptorPoolCreateInfo::pPoolSizes with a -- member equal to that type. -- -- Additionally, the allocation may also fail if a call to -- allocateDescriptorSets would cause the total number of inline -- uniform block bindings allocated from the pool to exceed the value of -- DescriptorPoolInlineUniformBlockCreateInfoEXT::maxInlineUniformBlockBindings -- used to create the descriptor pool. -- -- If the allocation fails due to no more space in the descriptor pool, -- and not because of system or device memory exhaustion, then -- ERROR_OUT_OF_POOL_MEMORY must be returned. -- -- allocateDescriptorSets 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 NULL_HANDLE and return -- the error. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pAllocateInfo must be a valid pointer to a valid -- DescriptorSetAllocateInfo structure
pDescriptorSets must be a valid pointer to an -- array of pAllocateInfo->descriptorSetCount -- DescriptorSet handles
The value referenced by -- pAllocateInfo->descriptorSetCount must be greater -- than 0

-- --

Host Synchronization

-- --

Host access to pAllocateInfo->descriptorPool -- must be externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 a pointer to an array of handles to -- DescriptorSet objects.

-- --

Description

-- -- After calling freeDescriptorSets, 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 DescriptorSet handles, -- each element of which must either be a valid handle or -- NULL_HANDLE
Each valid handle in pDescriptorSets must have -- been allocated from descriptorPool
descriptorPool must have been created with the -- DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT flag

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

descriptorPool must be a valid -- DescriptorPool 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
- SUCCESS

-- --

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 -- WriteDescriptorSet 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 -- CopyDescriptorSet 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 -- CopyDescriptorSet 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 DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT or -- DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT bits set, -- that command buffer becomes invalid. -- --

Valid Usage

-- --

Descriptor bindings updated by this command which were created -- without the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT or -- DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT 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 Device handle

-- --

If descriptorWriteCount is not 0, -- pDescriptorWrites must be a valid pointer to an array -- of descriptorWriteCount valid WriteDescriptorSet -- structures
If descriptorCopyCount is not 0, -- pDescriptorCopies must be a valid pointer to an array -- of descriptorCopyCount valid CopyDescriptorSet -- 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 WHOLE_SIZE, the effective range -- must not be larger than the maximum range for the descriptor -- type (maxUniformBufferRange or maxStorageBufferRange). -- This means that 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 DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC and -- 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 WHOLE_SIZE, -- range must be greater than 0
If range is not equal to WHOLE_SIZE, -- range must be less than or equal to the size of -- buffer minus offset
If the nullDescriptor feature is not enabled, -- buffer must not be NULL_HANDLE
If buffer is NULL_HANDLE, offset -- must be zero and range must be -- WHOLE_SIZE

-- --

Valid Usage (Implicit)

-- --

If buffer is not NULL_HANDLE, buffer -- must be a valid Buffer handle

-- --

Description

-- -- Members of DescriptorImageInfo 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

-- --

If imageView is created from a depth/stencil image, the -- aspectMask used to create the imageView must -- include either IMAGE_ASPECT_DEPTH_BIT or -- IMAGE_ASPECT_STENCIL_BIT but not both
imageLayout must match the actual -- ImageLayout of each subresource accessible from -- imageView at the time this descriptor is accessed as defined -- by the image layout matching rules
If sampler is used and the Format of the image is -- a multi-planar format, the image must have been created -- with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the -- aspectMask of the imageView must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or -- (for three-plane formats only) IMAGE_ASPECT_PLANE_2_BIT

-- --

Valid Usage (Implicit)

-- --

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

-- --

Description

-- -- Only one of pImageInfo, pBufferInfo, or -- pTexelBufferView members is used according to the descriptor -- type specified in the descriptorType member of the containing -- WriteDescriptorSet structure, or none of them in case -- descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, in which case the -- source data for the descriptor writes is taken from the -- WriteDescriptorSetInlineUniformBlockEXT structure included in -- the pNext chain of WriteDescriptorSet, or if -- descriptorType is -- DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, in which case the -- source data for the descriptor writes is taken from the -- WriteDescriptorSetAccelerationStructureKHR structure in the -- pNext chain of WriteDescriptorSet, as specified below. -- -- If the nullDescriptor feature is enabled, the buffer, -- imageView, or bufferView can be NULL_HANDLE. Loads from -- a null descriptor return zero values and stores and atomics to a null -- descriptor are discarded. -- -- 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. -- -- Note -- -- The same behavior applies to bindings with a descriptor type of -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT where -- descriptorCount specifies the number of bytes to update while -- dstArrayElement specifies the starting byte offset, thus in -- this case if the dstBinding has a smaller byte size than the -- sum of dstArrayElement and descriptorCount, then the -- remainder will be used to update the subsequent binding - -- dstBinding+1 starting at offset zero. This falls out as a -- special case of the above rule. -- --

Valid Usage

-- --

dstBinding must be less than or equal to the -- maximum value of binding of all -- DescriptorSetLayoutBinding 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 -- WriteDescriptorSet structure, except those with a -- descriptorCount of zero, must have identical -- descriptorType and stageFlags
All consecutive bindings updated via a single -- WriteDescriptorSet 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 DescriptorSet -- 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 -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#descriptorsets-updates-consecutive
If descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, -- dstArrayElement must be an integer multiple of -- 4
If descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, -- descriptorCount must be an integer multiple of -- 4
If descriptorType is DESCRIPTOR_TYPE_SAMPLER, -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT, pImageInfo -- must be a valid pointer to an array of descriptorCount -- valid DescriptorImageInfo structures
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of -- pTexelBufferView must be either a valid -- BufferView handle or NULL_HANDLE
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER and the -- nullDescriptor feature is not enabled, each element of -- pTexelBufferView must not be NULL_HANDLE
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- DESCRIPTOR_TYPE_STORAGE_BUFFER, -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, pBufferInfo -- must be a valid pointer to an array of descriptorCount -- valid DescriptorBufferInfo structures
If descriptorType is DESCRIPTOR_TYPE_SAMPLER or -- 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 -- Sampler object
If descriptorType is -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member -- of each element of pImageInfo must be either a valid -- ImageView handle or NULL_HANDLE
If descriptorType is -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, -- DESCRIPTOR_TYPE_SAMPLED_IMAGE, -- DESCRIPTOR_TYPE_STORAGE_IMAGE, or -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT and the nullDescriptor -- feature is not enabled, the imageView member of each element -- of pImageInfo must not be NULL_HANDLE
If descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, the pNext -- chain must include a -- WriteDescriptorSetInlineUniformBlockEXT structure whose -- dataSize member equals descriptorCount
If descriptorType is -- DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, the pNext -- chain must include a -- WriteDescriptorSetAccelerationStructureKHR structure whose -- accelerationStructureCount member equals -- descriptorCount
If descriptorType is -- DESCRIPTOR_TYPE_SAMPLED_IMAGE, then the imageView -- member of each pImageInfo element must have been -- created without a SamplerYcbcrConversionInfo structure in its -- pNext chain
If descriptorType is -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and if any element of -- pImageInfo has a imageView member that was created -- with a SamplerYcbcrConversionInfo structure in its -- pNext chain, then dstSet must have been -- allocated with a layout that included immutable samplers for -- dstBinding, and the corresponding immutable sampler -- must have been created with an identically defined -- SamplerYcbcrConversionInfo object
If descriptorType is -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and dstSet was -- allocated with a layout that included immutable samplers for -- dstBinding, then the imageView member of each -- element of pImageInfo which corresponds to an immutable -- sampler that enables sampler Y′CBCR conversion must have -- been created with a SamplerYcbcrConversionInfo structure in its -- pNext chain with an identically defined -- SamplerYcbcrConversionInfo to the corresponding immutable -- sampler
If descriptorType is -- 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 -- IMAGE_LAYOUT_GENERAL
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the offset -- member of each element of pBufferInfo must be a -- multiple of -- PhysicalDeviceLimits::minUniformBufferOffsetAlignment
If descriptorType is -- DESCRIPTOR_TYPE_STORAGE_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the offset -- member of each element of pBufferInfo must be a -- multiple of -- PhysicalDeviceLimits::minStorageBufferOffsetAlignment
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_BUFFER, -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, -- DESCRIPTOR_TYPE_STORAGE_BUFFER, or -- 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 DeviceMemory object
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the buffer -- member of each element of pBufferInfo must have been -- created with BUFFER_USAGE_UNIFORM_BUFFER_BIT set
If descriptorType is -- DESCRIPTOR_TYPE_STORAGE_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the buffer -- member of each element of pBufferInfo must have been -- created with BUFFER_USAGE_STORAGE_BUFFER_BIT set
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_BUFFER or -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the range -- member of each element of pBufferInfo, or the effective range -- if range is WHOLE_SIZE, must be less than or -- equal to -- PhysicalDeviceLimits::maxUniformBufferRange
If descriptorType is -- DESCRIPTOR_TYPE_STORAGE_BUFFER or -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the range -- member of each element of pBufferInfo, or the effective range -- if range is WHOLE_SIZE, must be less than or -- equal to -- PhysicalDeviceLimits::maxStorageBufferRange
If descriptorType is -- DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, the Buffer that -- each element of pTexelBufferView was created from must -- have been created with BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT -- set
If descriptorType is -- DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, the Buffer that -- each element of pTexelBufferView was created from must -- have been created with BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT -- set
If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE -- or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView -- member of each element of pImageInfo must have been -- created with the identity swizzle
If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE -- or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the -- imageView member of each element of pImageInfo -- must have been created with IMAGE_USAGE_SAMPLED_BIT -- set
If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE -- or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the -- imageLayout member of each element of pImageInfo -- must be a member of the list given in Sampled Image or -- Combined Image Sampler, corresponding to its type
If descriptorType is -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member -- of each element of pImageInfo must have been created -- with IMAGE_USAGE_INPUT_ATTACHMENT_BIT set
If descriptorType is -- DESCRIPTOR_TYPE_STORAGE_IMAGE, the imageView member of -- each element of pImageInfo must have been created with -- IMAGE_USAGE_STORAGE_BIT set
All consecutive bindings updated via a single -- WriteDescriptorSet structure, except those with a -- descriptorCount of zero, must have identical -- DescriptorBindingFlagBits
If descriptorType is DESCRIPTOR_TYPE_SAMPLER, then -- dstSet must not have been allocated with a layout that -- included immutable samplers for dstBinding

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET

-- --

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 -- WriteDescriptorSetAccelerationStructureKHR or -- WriteDescriptorSetInlineUniformBlockEXT
The sType value of each struct in the pNext -- chain must be unique
descriptorType must be a valid -- DescriptorType value
descriptorCount must be greater than -- 0
Both of dstSet, and the elements of -- pTexelBufferView that are valid handles of non-ignored -- parameters must have been created, allocated, or retrieved from -- the same Device

-- --

Description

-- --

pImmutableSamplers affects initialization of samplers. If -- descriptorType specifies a DESCRIPTOR_TYPE_SAMPLER or -- 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 and must not be changed; updating a -- DESCRIPTOR_TYPE_SAMPLER descriptor with immutable samplers is -- not allowed and updates to a -- DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER descriptor with -- immutable samplers does not modify the samplers (the image views are -- updated, but the sampler updates are ignored). If -- pImmutableSamplers is not NULL, then it points to an -- array of sampler handles that will be copied into the set layout and -- used for the corresponding binding. Only the sampler handles are -- copied; the sampler objects must not be destroyed before the -- final use of the set layout and any descriptor pools and sets created -- using it. 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 value of -- descriptorType is undefined. However, all binding numbers -- between 0 and the maximum binding number in the -- DescriptorSetLayoutCreateInfo::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 DESCRIPTOR_TYPE_SAMPLER or -- 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 Sampler handles

-- --

If descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then -- descriptorCount must be a multiple of 4
If descriptorType is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then -- descriptorCount must be less than or equal to -- PhysicalDeviceInlineUniformBlockPropertiesEXT::maxInlineUniformBlockSize
If descriptorCount is not 0, stageFlags -- must be a valid combination of ShaderStageFlagBits -- values
If descriptorType is -- DESCRIPTOR_TYPE_INPUT_ATTACHMENT and descriptorCount -- is not 0, then stageFlags must be 0 -- or SHADER_STAGE_FRAGMENT_BIT

-- --

Valid Usage (Implicit)

-- --

descriptorType must be a valid -- DescriptorType value

-- --

Description

-- -- Note -- -- When creating a descriptor pool that will contain descriptors for -- combined image samplers of multi-planar formats, an application needs -- to account for non-trivial descriptor consumption when choosing the -- descriptorCount value, as indicated by -- SamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount. -- --

Valid Usage

-- --

descriptorCount must be greater than -- 0

-- --

If type is -- DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then -- descriptorCount must be a multiple of 4

-- --

Valid Usage (Implicit)

-- --

type must be a valid DescriptorType -- value

-- --

Description

-- -- If multiple DescriptorPoolSize structures appear in the -- pPoolSizes array then the pool will be created with enough -- storage for the total number of descriptors of each type. -- -- Fragmentation of a descriptor pool is possible and may lead to -- descriptor set allocation failures. A failure due to fragmentation is -- defined as failing a descriptor set allocation despite the sum of all -- outstanding descriptor set allocations from the pool plus the -- requested allocation requiring no more than the total number of -- descriptors requested at pool creation. Implementations provide -- certain guarantees of when fragmentation must not cause -- allocation failure, as described below. -- -- If a descriptor pool has not had any descriptor sets freed since it -- was created or most recently reset then fragmentation must not -- cause an allocation failure (note that this is always the case for a -- pool created without the -- DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT bit set). -- Additionally, if all sets allocated from the pool since it was created -- or most recently reset use the same number of descriptors (of each -- type) and the requested allocation also uses that same number of -- descriptors (of each type), then fragmentation must not cause -- an allocation failure. -- -- If an allocation failure occurs due to fragmentation, an application -- can create an additional descriptor pool to perform further -- descriptor set allocations. -- -- If flags has the -- DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT bit set, -- descriptor pool creation may fail with the error -- ERROR_FRAGMENTATION if the total number of descriptors across -- all pools (including this one) created with this bit set exceeds -- maxUpdateAfterBindDescriptorsInAllPools, or if fragmentation -- of the underlying hardware resources occurs. -- --

Valid Usage

-- --

maxSets must be greater than 0

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- DescriptorPoolInlineUniformBlockCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- DescriptorPoolCreateFlagBits values
pPoolSizes must be a valid pointer to an array of -- poolSizeCount valid DescriptorPoolSize structures
poolSizeCount must be greater than 0

-- --

Parameters

-- --

commandBuffer is the command buffer that the descriptors -- will be recorded in.

-- --

pipelineBindPoint is a PipelineBindPoint -- 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 PipelineLayout 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 -- WriteDescriptorSet 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 are -- undefined. 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 are -- undefined. -- -- Push descriptors that are statically used by a pipeline -- must not be undefined 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 (the immutable samplers are pushed, rather -- than the samplers in pDescriptorWrites). Push descriptors -- that are not statically used can remain undefined. -- -- Push descriptors do not use dynamic offsets. Instead, the -- corresponding non-dynamic descriptor types can be used and the -- offset member of DescriptorBufferInfo can be -- changed each time the descriptor is written. -- -- Each element of pDescriptorWrites is interpreted as in -- WriteDescriptorSet, except the dstSet member is -- ignored. -- -- To push an immutable sampler, use a WriteDescriptorSet with -- dstBinding and dstArrayElement selecting the -- immutable sampler’s binding. If the descriptor type is -- 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 -- 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 CommandPool’s queue family

-- --

set must be less than -- PipelineLayoutCreateInfo::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 -- DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pipelineBindPoint must be a valid -- PipelineBindPoint value
layout must be a valid PipelineLayout -- handle
pDescriptorWrites must be a valid pointer to an -- array of descriptorWriteCount valid WriteDescriptorSet -- structures
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer that the descriptors -- will be recorded in.

-- --

descriptorUpdateTemplate is a descriptor update template -- defining how to interpret the descriptor information in -- pData.
layout is a PipelineLayout 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 is a pointer to memory containing descriptors for -- the templated update.

-- --

Valid Usage

-- --

The pipelineBindPoint specified during the creation of -- the descriptor update template must be supported by the -- commandBuffer’s parent CommandPool’s queue family

-- --

pData must be a valid pointer to a memory -- containing one or more valid instances of DescriptorImageInfo, -- DescriptorBufferInfo, or BufferView in a layout defined -- by descriptorUpdateTemplate when it was created with -- createDescriptorUpdateTemplateKHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

descriptorUpdateTemplate must be a valid -- DescriptorUpdateTemplate handle
layout must be a valid PipelineLayout -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- -- API example. -- --

--   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 a 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);
--

-- --

Members

-- --

The pipelineBindPoint specified during the creation of -- the descriptor update template must be supported by the -- commandBuffer’s parent CommandPool’s queue family

-- --

pData must be a valid pointer to a memory -- containing one or more valid instances of DescriptorImageInfo, -- DescriptorBufferInfo, or BufferView in a layout defined -- by descriptorUpdateTemplate when it was created with -- createDescriptorUpdateTemplateKHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

descriptorUpdateTemplate must be a valid -- DescriptorUpdateTemplate handle
layout must be a valid PipelineLayout -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- -- API example. -- --

--   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 a 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);
--

-- --

Description

Parameters

-- --

device is the logical device that would create the -- descriptor set layout.

-- --

pCreateInfo is a pointer to a -- DescriptorSetLayoutCreateInfo structure specifying the state of -- the descriptor set layout object.
pSupport is a pointer to a -- DescriptorSetLayoutSupport structure, in which information -- about support for the descriptor set layout object is returned.

Parameters

-- --

commandBuffer is the command buffer that the pipeline -- will be bound to.

-- --

pipelineBindPoint is a PipelineBindPoint 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 -- PIPELINE_BIND_POINT_COMPUTE controls the behavior of -- cmdDispatch and cmdDispatchIndirect. The pipeline bound -- to PIPELINE_BIND_POINT_GRAPHICS controls the behavior of all -- drawing commands. The pipeline bound to -- PIPELINE_BIND_POINT_RAY_TRACING_KHR controls the behavior of -- cmdTraceRaysKHR. No other commands are affected by the pipeline -- state. -- --

Valid Usage

-- --

If pipelineBindPoint is -- PIPELINE_BIND_POINT_COMPUTE, the CommandPool that -- commandBuffer was allocated from must support compute -- operations

-- --

If pipelineBindPoint is -- PIPELINE_BIND_POINT_GRAPHICS, the CommandPool that -- commandBuffer was allocated from must support graphics -- operations
If pipelineBindPoint is -- PIPELINE_BIND_POINT_COMPUTE, pipeline must be a -- compute pipeline
If pipelineBindPoint is -- 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 uses -- 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 -- PhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations -- is FALSE, and pipeline is a graphics pipeline created -- with a PipelineSampleLocationsStateCreateInfoEXT structure -- having its sampleLocationsEnable member set to TRUE -- but without DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT enabled then the -- current render pass instance must have been begun by specifying -- a RenderPassSampleLocationsBeginInfoEXT 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 -- PipelineSampleLocationsStateCreateInfoEXT when the pipeline was -- created
This command must not be recorded when transform feedback -- is active
If pipelineBindPoint is -- PIPELINE_BIND_POINT_RAY_TRACING_KHR, the CommandPool -- that commandBuffer was allocated from must support -- compute operations
If pipelineBindPoint is -- PIPELINE_BIND_POINT_RAY_TRACING_KHR, the pipeline -- must be a ray tracing pipeline
The pipeline must not have been created with -- PIPELINE_CREATE_LIBRARY_BIT_KHR set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pipelineBindPoint must be a valid -- PipelineBindPoint value
pipeline must be a valid Pipeline -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- --

firstViewport must be less than -- PhysicalDeviceLimits::maxViewports

-- --

The sum of firstViewport and viewportCount -- must be between 1 and -- PhysicalDeviceLimits::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 CommandBuffer -- handle

-- --

pViewports must be a valid pointer to an array of -- viewportCount valid Viewport structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 Rect2D -- 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 Rect2D 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. -- -- If a render pass transform is enabled, the (offset.x and -- offset.y) and (extent.width and -- extent.height) values are transformed as described in -- render pass transform before participating in the scissor test. -- --

Valid Usage

-- --

firstScissor must be less than -- PhysicalDeviceLimits::maxViewports

-- --

The sum of firstScissor and scissorCount -- must be between 1 and -- PhysicalDeviceLimits::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 member of -- any element of pScissors must be greater than or equal -- to 0
Evaluation of (offset.x + extent.width) -- must not cause a signed integer addition overflow for any -- element of pScissors
Evaluation of (offset.y + extent.height) -- must not cause a signed integer addition overflow for any -- element of pScissors

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pScissors must be a valid pointer to an array of -- scissorCount Rect2D structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

lineWidth is the width of rasterized line segments.

-- --

Valid Usage

-- --

If the wide lines feature is not enabled, -- lineWidth must be 1.0

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 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 -- -- <math> -- -- where (xf, yf, zf) is a point on the triangle. m may be -- approximated as -- -- <math> -- -- 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 -- 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 -- -- [begin{aligned} o &= mathrm{dbclamp}( m times -- mathtt{depthBiasSlopeFactor} + r times mathtt{depthBiasConstantFactor} -- ) -- text{where} &quad mathrm{dbclamp}(x) = -- -- Command Buffer Levels | Render Pass Scope | Supported -- Queue Types | Pipeline Type | -- +============================================================================================================================+========================================================================================================================+=======================================================================================================================+=====================================================================================================================================+ -- | Primary | Both | Graphics | | | Secondary | | | | -- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -- --

Parameters

-- --

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

-- --

blendConstants is a pointer to 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.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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.

-- --

Valid Usage

-- --

Unless the VK_EXT_depth_range_unrestricted extension is -- enabled minDepthBounds must be between 0.0 -- and 1.0, inclusive

-- --

Unless the 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 CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

faceMask is a bitmask of StencilFaceFlagBits -- 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.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

faceMask must be a valid combination of -- StencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

faceMask is a bitmask of StencilFaceFlagBits -- specifying the set of stencil state for which to update the write -- mask, as described above for cmdSetStencilCompareMask.
writeMask is the new value to use as the stencil write -- mask.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

faceMask must be a valid combination of -- StencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

faceMask is a bitmask of StencilFaceFlagBits -- specifying the set of stencil state for which to update the reference -- value, as described above for cmdSetStencilCompareMask.
reference is the new value to use as the stencil -- reference value.

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

faceMask must be a valid combination of -- StencilFaceFlagBits values
faceMask must not be 0
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer that the descriptor -- sets will be bound to.

-- --

pipelineBindPoint is a PipelineBindPoint -- 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 PipelineLayout 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 a pointer to an array of handles to -- DescriptorSet 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

-- -- cmdBindDescriptorSets 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 range 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 -- cmdBindDescriptorSets may be consumed at the following -- times: -- --

For descriptor bindings created with the -- DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT 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 when the command -- completes executing on the queue. -- -- The contents of pDynamicOffsets are consumed immediately -- during execution of cmdBindDescriptorSets. 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 DescriptorSetLayout that matches (is the same -- as, or identically defined as) the DescriptorSetLayout 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 -- PipelineLayoutCreateInfo::setLayoutCount provided when -- layout was created
pipelineBindPoint must be supported by the -- commandBuffer’s parent CommandPool’s queue family
Each element of pDynamicOffsets which corresponds to a -- descriptor binding with type -- DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC must be a -- multiple of -- PhysicalDeviceLimits::minUniformBufferOffsetAlignment
Each element of pDynamicOffsets which corresponds to a -- descriptor binding with type -- DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC must be a -- multiple of -- PhysicalDeviceLimits::minStorageBufferOffsetAlignment
For each dynamic uniform or storage buffer binding in -- pDescriptorSets, the sum of the effective offset, as defined -- above, and the range of the binding must be less than or equal -- to the size of the buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pipelineBindPoint must be a valid -- PipelineBindPoint value
layout must be a valid PipelineLayout -- handle
pDescriptorSets must be a valid pointer to an -- array of descriptorSetCount valid DescriptorSet -- 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 CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 IndexType value specifying whether -- indices are treated as 16 bits or 32 bits.

-- --

Valid Usage

-- --

offset must be less than the size of -- buffer

-- --

The sum of offset and the address of the range of -- DeviceMemory object that is backing buffer, -- must be a multiple of the type indicated by -- indexType
buffer must have been created with the -- BUFFER_USAGE_INDEX_BUFFER_BIT flag
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
indexType must not be -- INDEX_TYPE_NONE_KHR
If indexType is INDEX_TYPE_UINT8_EXT, the -- indexTypeUint8 feature must be enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
indexType must be a valid IndexType -- value
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
Both of buffer, and commandBuffer must -- have been created, allocated, or retrieved from the same -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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. If the -- nullDescriptor feature is enabled, elements of -- pBuffers can be NULL_HANDLE, and can be -- used by the vertex shader. If a vertex input attribute is bound to a -- vertex input binding that is NULL_HANDLE, the values taken from -- memory are considered to be zero, and missing G, B, or A components -- are filled with (0,0,1). -- --

Valid Usage

-- --

firstBinding must be less than -- PhysicalDeviceLimits::maxVertexInputBindings

-- --

The sum of firstBinding and bindingCount -- must be less than or equal to -- PhysicalDeviceLimits::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 BUFFER_USAGE_VERTEX_BUFFER_BIT flag
Each element of pBuffers that is non-sparse must -- be bound completely and contiguously to a single DeviceMemory -- object
If the nullDescriptor feature is not enabled, all elements -- of pBuffers must not be NULL_HANDLE
If an element of pBuffers is NULL_HANDLE, then the -- corresponding element of pOffsets must be zero

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pBuffers must be a valid pointer to an array of -- bindingCount valid or NULL_HANDLE Buffer -- handles
pOffsets must be a valid pointer to an array of -- bindingCount DeviceSize values
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
bindingCount must be greater than 0
Both of commandBuffer, and the elements of -- pBuffers that are valid handles of non-ignored parameters -- must have been created, allocated, or retrieved from the same -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
If commandBuffer is a protected command buffer, any -- resource written to by the Pipeline object bound to the -- pipeline bind point used by this command must not be an -- unprotected resource
If commandBuffer is a protected command buffer, pipeline -- stages other than the framebuffer-space and compute stages in the -- Pipeline object bound to the pipeline bind point must -- not write to any resource
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 cmdBindIndexBuffer::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 -- cmdBindIndexBuffer 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 INDEX_TYPE_UINT8_EXT or -- 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

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
If commandBuffer is a protected command buffer, any -- resource written to by the Pipeline object bound to the -- pipeline bind point used by this command must not be an -- unprotected resource
If commandBuffer is a protected command buffer, pipeline -- stages other than the framebuffer-space and compute stages in the -- Pipeline object bound to the pipeline bind point must -- not write to any resource
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
(indexSize * (firstIndex + indexCount) -- + offset) must be less than or equal to the size of -- the bound index buffer, with indexSize being based on the -- type specified by indexType, where the index buffer, -- indexType, and offset are specified via -- cmdBindIndexBuffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDrawIndirect behaves similarly to cmdDraw 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 DrawIndirectCommand -- structures. If drawCount is less than or equal to one, -- stride is ignored. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If the multi-draw indirect feature is not enabled, -- drawCount must be 0 or 1
drawCount must be less than or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- DrawIndirectCommand structures accessed by this command -- must be 0
If drawCount is greater than 1, stride -- must be a multiple of 4 and must be greater -- than or equal to sizeof(DrawIndirectCommand)
If drawCount is equal to 1, (offset + -- sizeof(DrawIndirectCommand)) must be less than -- or equal to the size of buffer
If drawCount is greater than 1, (stride -- × (drawCount - 1) + offset + -- sizeof(DrawIndirectCommand)) must be less than -- or equal to the size of buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDrawIndexedIndirect behaves similarly to -- cmdDrawIndexed 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 DrawIndexedIndirectCommand structures. If -- drawCount is less than or equal to one, stride is -- ignored. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
The current render pass must be compatible with the -- renderPass member of the GraphicsPipelineCreateInfo -- structure specified when creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
The subpass index of the current render pass must be equal -- to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
Every input attachment used by the current subpass must be -- bound to the pipeline via a descriptor set
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 -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
If the bound graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
All vertex input bindings accessed via vertex input variables -- declared in the vertex shader entry point’s interface must have -- either valid or NULL_HANDLE buffers bound
If the nullDescriptor feature is not enabled, all vertex -- input bindings accessed via vertex input variables declared in the -- vertex shader entry point’s interface must not be -- NULL_HANDLE
For a given vertex buffer binding, any attribute data fetched -- must be entirely contained within the corresponding vertex -- buffer binding, as described in ???
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
If the multi-draw indirect feature is not enabled, -- drawCount must be 0 or 1
drawCount must be less than or equal to -- PhysicalDeviceLimits::maxDrawIndirectCount
If drawCount is greater than 1, stride -- must be a multiple of 4 and must be greater -- than or equal to -- sizeof(DrawIndexedIndirectCommand)
If the drawIndirectFirstInstance feature is not enabled, -- all the firstInstance members of the -- DrawIndexedIndirectCommand structures accessed by this command -- must be 0
If drawCount is equal to 1, (offset + -- sizeof(DrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
If drawCount is greater than 1, (stride -- × (drawCount - 1) + offset + -- sizeof(DrawIndexedIndirectCommand)) must be -- less than or equal to the size of buffer
If drawIndirectCount is not enabled this function -- must not be used

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
If commandBuffer is a protected command buffer, any -- resource written to by the Pipeline object bound to the -- pipeline bind point used by this command must not be an -- unprotected resource
If commandBuffer is a protected command buffer, pipeline -- stages other than the framebuffer-space and compute stages in the -- Pipeline object bound to the pipeline bind point must -- not write to any resource
groupCountX must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
groupCountY must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
groupCountZ must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- cmdDispatchIndirect behaves similarly to cmdDispatch -- except that the parameters are read by the device from a buffer during -- execution. The parameters of the dispatch are encoded in a -- DispatchIndirectCommand structure taken from buffer -- starting at offset. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
The sum of offset and the size of -- DispatchIndirectCommand must be less than or equal to -- the size of buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

buffer must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 BufferCopy -- 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 resulting values are undefined if the copy regions -- overlap in memory. -- --

Valid Usage

-- --

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 -- BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
If srcBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstBuffer must have been created with -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
If commandBuffer is an unprotected command buffer, then -- srcBuffer must not be a protected buffer
If commandBuffer is an unprotected command buffer, then -- dstBuffer must not be a protected buffer
If commandBuffer is a protected command buffer, then -- dstBuffer must not be an unprotected buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcBuffer must be a valid Buffer -- handle
dstBuffer must be a valid Buffer -- handle
pRegions must be a valid pointer to an array of -- regionCount valid BufferCopy structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 ImageCopy -- 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 compatible if they share the same class, as -- shown in the Compatible Formats table. 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 ImageCopy structure. -- In this case, the aspectMask of the srcSubresource -- or dstSubresource that refers to the multi-planar image -- must be IMAGE_ASPECT_PLANE_0_BIT, -- IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT. -- For the purposes of cmdCopyImage, each plane of a multi-planar -- image is treated as having the format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes -- for the plane identified by the aspectMask of the -- corresponding subresource. This applies both to Format 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 IMAGE_ASPECT_PLANE_1_BIT plane of a -- FORMAT_G8_B8R8_2PLANE_420_UNORM image is compatible with an -- image of format FORMAT_R8G8_UNORM and (less usefully) with the -- IMAGE_ASPECT_PLANE_0_BIT plane of an image of format -- FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16, as each -- texel is 2 bytes in size. -- -- cmdCopyImage allows copying between size-compatible -- compressed and uncompressed internal formats. Formats are -- size-compatible if the texel block size of the uncompressed format is -- equal to the 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. -- -- cmdCopyImage can be used to copy image data between -- multisample images, but both images must have the same number -- of samples. -- --

Valid Usage

-- --

The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory

-- --

The format features of srcImage must -- contain FORMAT_FEATURE_TRANSFER_SRC_BIT
srcImage must have been created with -- 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 DeviceMemory object
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a Device
srcImageLayout must be -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_GENERAL, -- or IMAGE_LAYOUT_SHARED_PRESENT_KHR
The format features of dstImage must -- contain FORMAT_FEATURE_TRANSFER_DST_BIT
dstImage must have been created with -- 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 DeviceMemory -- object
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a Device
dstImageLayout must be -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, -- or IMAGE_LAYOUT_SHARED_PRESENT_KHR
If the Format of each of srcImage and -- dstImage is not a multi-planar format, the -- Format of each of srcImage and dstImage -- must be compatible, as defined above
In a copy to or from a plane of a multi-planar image, the -- Format of the image and plane must be compatible -- according to the description of compatible planes for the plane -- being copied
The sample count of srcImage and dstImage -- must match
If commandBuffer is an unprotected command buffer, then -- srcImage must not be a protected image
If commandBuffer is an unprotected command buffer, then -- dstImage must not be a protected image
If commandBuffer is a protected command buffer, then -- dstImage must not be an unprotected image
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo 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 ImageCreateInfo 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 ImageCreateInfo when -- dstImage was created
The srcOffset 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 QueueFamilyProperties
The dstOffset 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 QueueFamilyProperties
dstImage and srcImage must not have been -- created with flags containing -- IMAGE_CREATE_SUBSAMPLED_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout -- value
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout -- value
pRegions must be a valid pointer to an array of -- regionCount valid ImageCopy structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 ImageBlit -- structures specifying the regions to blit.
filter is a Filter specifying the filter to apply -- if the blits require scaling.

-- --

Description

-- -- cmdBlitImage must not be used for multisampled source or -- destination images. Use cmdResolveImage 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 -- SAMPLER_MIPMAP_MODE_NEAREST and an address mode of -- 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 -- 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 FILTER_NEAREST then -- the value sampled from the source image is taken from the single -- nearest slice, with an implementation-dependent arithmetic 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
The format features of srcImage must -- contain FORMAT_FEATURE_BLIT_SRC_BIT
srcImage must not use a format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
srcImage must have been created with -- IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
If srcImage is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
srcImageLayout must specify the layout of the -- image subresources of srcImage specified in pRegions -- at the time this command is executed on a Device
srcImageLayout must be -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- IMAGE_LAYOUT_GENERAL
The format features of dstImage must -- contain FORMAT_FEATURE_BLIT_DST_BIT
dstImage must not use a format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
dstImage must have been created with -- IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstImageLayout must specify the layout of the -- image subresources of dstImage specified in pRegions -- at the time this command is executed on a Device
dstImageLayout must be -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- IMAGE_LAYOUT_GENERAL
If either of srcImage or dstImage was created -- with a signed integer Format, the other must also have -- been created with a signed integer Format
If either of srcImage or dstImage was created -- with an unsigned integer Format, the other must also -- have been created with an unsigned integer Format
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 FILTER_NEAREST
srcImage must have been created with a -- samples value of SAMPLE_COUNT_1_BIT
dstImage must have been created with a -- samples value of SAMPLE_COUNT_1_BIT
If filter is FILTER_LINEAR, then the format -- features of srcImage must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
If filter is FILTER_CUBIC_EXT, then the format -- features of srcImage must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
If filter is FILTER_CUBIC_EXT, srcImage -- must have a ImageType of IMAGE_TYPE_2D
If commandBuffer is an unprotected command buffer, then -- srcImage must not be a protected image
If commandBuffer is an unprotected command buffer, then -- dstImage must not be a protected image
If commandBuffer is a protected command buffer, then -- dstImage must not be an unprotected image
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo 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 ImageCreateInfo 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 ImageCreateInfo when -- dstImage was created
dstImage and srcImage must not have been -- created with flags containing -- IMAGE_CREATE_SUBSAMPLED_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout -- value
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout -- value
pRegions must be a valid pointer to an array of -- regionCount valid ImageBlit structures
filter must be a valid Filter value
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- BufferImageCopy 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 BufferImageCopy structure. In this case, the -- aspectMask of imageSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- IMAGE_ASPECT_PLANE_2_BIT. For the purposes of -- cmdCopyBufferToImage, each plane of a multi-planar image is -- treated as having the format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes -- for the plane identified by the aspectMask of the -- corresponding subresource. This applies both to Format 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

-- --

srcBuffer must be large enough to contain all -- buffer locations that are accessed according to Buffer and Image -- Addressing, for each element of pRegions

-- --

The image region specified by each element of pRegions -- must be a region that is contained within dstImage if -- the dstImage’s Format is not a multi-planar -- format, and must be a region that is contained within the -- plane being copied to if the dstImage’s Format 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 -- BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
The format features of dstImage must -- contain FORMAT_FEATURE_TRANSFER_DST_BIT
If srcBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstImage must have been created with -- IMAGE_USAGE_TRANSFER_DST_BIT usage flag
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstImage must have a sample count equal to -- 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 Device
dstImageLayout must be -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, -- or IMAGE_LAYOUT_SHARED_PRESENT_KHR
If commandBuffer is an unprotected command buffer, then -- srcBuffer must not be a protected buffer
If commandBuffer is an unprotected command buffer, then -- dstImage must not be a protected image
If commandBuffer is a protected command buffer, then -- dstImage must not be an unprotected image
The imageSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo 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 ImageCreateInfo when -- dstImage was created
The imageOffset 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 QueueFamilyProperties
dstImage must not have been created with -- flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcBuffer must be a valid Buffer -- handle
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout -- value
pRegions must be a valid pointer to an array of -- regionCount valid BufferImageCopy structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- BufferImageCopy 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 Format 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 -- BufferImageCopy structure. In this case, the -- aspectMask of imageSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- IMAGE_ASPECT_PLANE_2_BIT. For the purposes of -- cmdCopyBufferToImage, each plane of a multi-planar image is -- treated as having the format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes -- for the plane identified by the aspectMask of the -- corresponding subresource. This applies both to Format 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 Format is not a multi-planar -- format, and must be a region that is contained within the -- plane being copied if the srcImage’s Format is a -- multi-planar format

-- --

dstBuffer must be large enough to contain all -- buffer locations that are accessed according to Buffer and Image -- Addressing, for each element of pRegions
The union of all source regions, and the union of all destination -- regions, specified by the elements of pRegions, must -- not overlap in memory
The format features of srcImage must -- contain FORMAT_FEATURE_TRANSFER_SRC_BIT
srcImage must have been created with -- IMAGE_USAGE_TRANSFER_SRC_BIT usage flag
If srcImage is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
srcImage must have a sample count equal to -- 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 Device
srcImageLayout must be -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- IMAGE_LAYOUT_GENERAL
dstBuffer must have been created with -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
If commandBuffer is an unprotected command buffer, then -- srcImage must not be a protected image
If commandBuffer is an unprotected command buffer, then -- dstBuffer must not be a protected buffer
If commandBuffer is a protected command buffer, then -- dstBuffer must not be an unprotected buffer
The imageSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo 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 ImageCreateInfo when -- srcImage was created
The imageOffset 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 QueueFamilyProperties
srcImage must not have been created with -- flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout -- value
dstBuffer must be a valid Buffer -- handle
pRegions must be a valid pointer to an array of -- regionCount valid BufferImageCopy structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 cmdUpdateBuffer 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 -- cmdUpdateBuffer 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. -- -- cmdUpdateBuffer is only allowed outside of a render pass. This -- command is treated as “transfer” operation, for the purposes of -- synchronization barriers. The BUFFER_USAGE_TRANSFER_DST_BIT -- must be specified in usage of BufferCreateInfo -- in order for the buffer to be compatible with cmdUpdateBuffer. -- --

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 -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstOffset must be a multiple of 4
dataSize must be less than or equal to -- 65536
dataSize must be a multiple of 4
If commandBuffer is an unprotected command buffer, then -- dstBuffer must not be a protected buffer
If commandBuffer is a protected command buffer, then -- dstBuffer must not be an unprotected buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

dstBuffer must be a valid Buffer -- handle
pData must be a valid pointer to an array of -- dataSize bytes
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 WHOLE_SIZE to fill the range from -- offset to the end of the buffer. If 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

-- -- cmdFillBuffer is treated as “transfer” operation for the -- purposes of synchronization barriers. The -- BUFFER_USAGE_TRANSFER_DST_BIT must be specified in -- usage of BufferCreateInfo in order for the buffer to -- be compatible with cmdFillBuffer. -- --

Valid Usage

-- --

dstOffset must be less than the size of -- dstBuffer

-- --

dstOffset must be a multiple of 4
If size is not equal to WHOLE_SIZE, size -- must be greater than 0
If size is not equal to WHOLE_SIZE, size -- must be less than or equal to the size of dstBuffer -- minus dstOffset
If size is not equal to WHOLE_SIZE, size -- must be a multiple of 4
dstBuffer must have been created with -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
If commandBuffer is an unprotected command buffer, then -- dstBuffer must not be a protected buffer
If commandBuffer is a protected command buffer, then -- dstBuffer must not be an unprotected buffer

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

dstBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, IMAGE_LAYOUT_GENERAL or -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL.
pColor is a pointer to a ClearColorValue structure -- containing the values that the image subresource ranges will be -- cleared to (see -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#clears-values -- below).
rangeCount is the number of image subresource range -- structures in pRanges.
pRanges is a pointer to an array of -- ImageSubresourceRange structures describing a range of mipmap -- levels, array layers, and aspects to be cleared, as described in -- Image Views.

-- --

Description

-- -- Each specified range in pRanges is cleared to the value -- specified by pColor. -- --

Valid Usage

-- --

The format features of image must contain -- FORMAT_FEATURE_TRANSFER_DST_BIT

-- --

image must have been created with -- IMAGE_USAGE_TRANSFER_DST_BIT usage flag
image must not use a format listed in -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
If image is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- 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 Device
imageLayout must be -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, -- or IMAGE_LAYOUT_SHARED_PRESENT_KHR
The ImageSubresourceRange::aspectMask members of -- the elements of the pRanges array must each only -- include IMAGE_ASPECT_COLOR_BIT
The ImageSubresourceRange::baseMipLevel members of -- the elements of the pRanges array must each be less -- than the mipLevels specified in ImageCreateInfo when -- image was created
For each ImageSubresourceRange element of pRanges, -- if the levelCount member is not REMAINING_MIP_LEVELS, -- then baseMipLevel + levelCount must be less -- than the mipLevels specified in ImageCreateInfo when -- image was created
The ImageSubresourceRange::baseArrayLayer members -- of the elements of the pRanges array must each be less -- than the arrayLayers specified in ImageCreateInfo when -- image was created
For each ImageSubresourceRange element of pRanges, -- if the layerCount member is not -- REMAINING_ARRAY_LAYERS, then baseArrayLayer + -- layerCount must be less than the arrayLayers -- specified in ImageCreateInfo when image was -- created
image must not have a compressed or depth/stencil -- format
If commandBuffer is an unprotected command buffer, then -- image must not be a protected image
If commandBuffer is a protected command buffer, then -- image must not be an unprotected image

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

image must be a valid Image handle
imageLayout must be a valid ImageLayout -- value
pColor must be a valid pointer to a valid -- ClearColorValue union
pRanges must be a valid pointer to an array of -- rangeCount valid ImageSubresourceRange structures
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- IMAGE_LAYOUT_GENERAL or -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL.
pDepthStencil is a pointer to a -- ClearDepthStencilValue structure containing the values that the -- depth and stencil image subresource ranges will be cleared to (see -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#clears-values -- below).
rangeCount is the number of image subresource range -- structures in pRanges.
pRanges is a pointer to an array of -- ImageSubresourceRange structures describing a range of mipmap -- levels, array layers, and aspects to be cleared, as described in -- Image Views.

-- --

Valid Usage

-- --

The format features of image must contain -- FORMAT_FEATURE_TRANSFER_DST_BIT

-- --

If the aspect member of any element of pRanges -- includes IMAGE_ASPECT_STENCIL_BIT, and image was -- created with separate stencil usage, -- IMAGE_USAGE_TRANSFER_DST_BIT must have been included in -- the ImageStencilUsageCreateInfo::stencilUsage used to -- create image
If the aspect member of any element of pRanges -- includes IMAGE_ASPECT_STENCIL_BIT, and image was not -- created with separate stencil usage, -- IMAGE_USAGE_TRANSFER_DST_BIT must have been included in -- the ImageCreateInfo::usage used to create -- image
If the aspect member of any element of pRanges -- includes IMAGE_ASPECT_DEPTH_BIT, -- IMAGE_USAGE_TRANSFER_DST_BIT must have been included in -- the ImageCreateInfo::usage used to create -- image
If image is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- 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 Device
imageLayout must be either of -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- IMAGE_LAYOUT_GENERAL
The ImageSubresourceRange::aspectMask member of -- each element of the pRanges array must not include -- bits other than IMAGE_ASPECT_DEPTH_BIT or -- IMAGE_ASPECT_STENCIL_BIT
If the image’s format does not have a stencil component, -- then the ImageSubresourceRange::aspectMask member of -- each element of the pRanges array must not include the -- IMAGE_ASPECT_STENCIL_BIT bit
If the image’s format does not have a depth component, -- then the ImageSubresourceRange::aspectMask member of -- each element of the pRanges array must not include the -- IMAGE_ASPECT_DEPTH_BIT bit
The ImageSubresourceRange::baseMipLevel members of -- the elements of the pRanges array must each be less -- than the mipLevels specified in ImageCreateInfo when -- image was created
For each ImageSubresourceRange element of pRanges, -- if the levelCount member is not REMAINING_MIP_LEVELS, -- then baseMipLevel + levelCount must be less -- than the mipLevels specified in ImageCreateInfo when -- image was created
The ImageSubresourceRange::baseArrayLayer members -- of the elements of the pRanges array must each be less -- than the arrayLayers specified in ImageCreateInfo when -- image was created
For each ImageSubresourceRange element of pRanges, -- if the layerCount member is not -- REMAINING_ARRAY_LAYERS, then baseArrayLayer + -- layerCount must be less than the arrayLayers -- specified in ImageCreateInfo when image was -- created
image must have a depth/stencil format
If commandBuffer is an unprotected command buffer, then -- image must not be a protected image
If commandBuffer is a protected command buffer, then -- image must not be an unprotected image

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

image must be a valid Image handle
imageLayout must be a valid ImageLayout -- value
pDepthStencil must be a valid pointer to a valid -- ClearDepthStencilValue structure
pRanges must be a valid pointer to an array of -- rangeCount valid ImageSubresourceRange structures
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 -- ClearAttachment structures defining the attachments to clear -- and the clear values to use. If any attachment to be cleared in the -- current subpass is ATTACHMENT_UNUSED, then the clear has no -- effect on that attachment.
rectCount is the number of entries in the pRects -- array.
pRects is a pointer to an array of ClearRect -- structures defining regions within each selected attachment to -- clear.

-- --

Description

-- -- cmdClearAttachments 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. -- -- If the render pass has a fragment density map attachment, -- clears follow the operations of fragment density maps as if -- each clear region was a primitive which generates fragments. The clear -- color is applied to all pixels inside each fragment’s area regardless -- if the pixels lie outside of the clear region. Clears may have -- a different set of supported fragment areas than draws. -- -- Unlike other clear commands, cmdClearAttachments -- executes as a drawing command, rather than a transfer command, with -- writes performed by it executing in rasterization order. Clears -- to color attachments are executed as color attachment writes, by the -- PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT stage. Clears to -- depth/stencil attachments are executed as depth writes and -- writes by the PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT -- and PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT stages. -- --

Valid Usage

-- --

If the aspectMask member of any element of -- pAttachments contains IMAGE_ASPECT_COLOR_BIT, then the -- colorAttachment member of that element must either -- refer to a color attachment which is ATTACHMENT_UNUSED, or -- must be a valid color attachment

-- --

If the aspectMask member of any element of -- pAttachments contains IMAGE_ASPECT_DEPTH_BIT, then the -- current subpass' depth/stencil attachment must either be -- ATTACHMENT_UNUSED, or must have a depth component
If the aspectMask member of any element of -- pAttachments contains IMAGE_ASPECT_STENCIL_BIT, then -- the current subpass' depth/stencil attachment must either be -- ATTACHMENT_UNUSED, or must have a stencil component
The rect member of each element of pRects -- must have an extent.width greater than 0
The rect member of each element of pRects -- must have an extent.height greater than -- 0
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
The layerCount member of each element of pRects -- must not be 0
If commandBuffer is an unprotected command buffer, then -- each attachment to be cleared must not be a protected -- image
If commandBuffer is a protected command buffer, then each -- attachment to be cleared must not be an unprotected image
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 CommandBuffer -- handle

-- --

pAttachments must be a valid pointer to an array -- of attachmentCount valid ClearAttachment -- structures
pRects must be a valid pointer to an array of -- rectCount ClearRect structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 ImageResolve -- 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 DeviceMemory -- object
srcImage must have a sample count equal to any -- valid sample count value other than SAMPLE_COUNT_1_BIT
If dstImage is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
dstImage must have a sample count equal to -- 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 Device
srcImageLayout must be -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL or -- 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 Device
dstImageLayout must be -- IMAGE_LAYOUT_SHARED_PRESENT_KHR, -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or -- IMAGE_LAYOUT_GENERAL
The format features of dstImage must -- contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
srcImage and dstImage must have been -- created with the same image format
If commandBuffer is an unprotected command buffer, then -- srcImage must not be a protected image
If commandBuffer is an unprotected command buffer, then -- dstImage must not be a protected image
If commandBuffer is a protected command buffer, then -- dstImage must not be an unprotected image
The srcSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo when srcImage was -- created
The dstSubresource.mipLevel member of each element of -- pRegions must be less than the mipLevels -- specified in ImageCreateInfo 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 ImageCreateInfo 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 ImageCreateInfo when -- dstImage was created
dstImage and srcImage must not have been -- created with flags containing -- IMAGE_CREATE_SUBSAMPLED_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcImage must be a valid Image handle
srcImageLayout must be a valid ImageLayout -- value
dstImage must be a valid Image handle
dstImageLayout must be a valid ImageLayout -- value
pRegions must be a valid pointer to an array of -- regionCount valid ImageResolve structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 cmdSetEvent 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 -- cmdSetEvent is executed on the device, then cmdSetEvent -- has no effect, no event signal operation occurs, and no execution -- dependency is generated. -- --

Valid Usage

-- --

stageMask must not include -- PIPELINE_STAGE_HOST_BIT

-- --

If the geometry shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
commandBuffer’s current device mask must include -- exactly one physical device
If the mesh shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

event must be a valid Event handle
stageMask must be a valid combination of -- PipelineStageFlagBits values
stageMask must not be 0
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 PipelineStageFlagBits -- specifying the source stage mask used to determine when the -- event is unsignaled.

-- --

Description

-- -- When cmdResetEvent 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 -- cmdResetEvent is executed on the device, then -- cmdResetEvent has no effect, no event unsignal operation -- occurs, and no execution dependency is generated. -- --

Valid Usage

-- --

stageMask must not include -- PIPELINE_STAGE_HOST_BIT

-- --

If the geometry shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
When this command executes, event must not be -- waited on by a cmdWaitEvents command that is currently -- executing
commandBuffer’s current device mask must include -- exactly one physical device
If the mesh shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- stageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

event must be a valid Event handle
stageMask must be a valid combination of -- PipelineStageFlagBits values
stageMask must not be 0
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

eventCount is the length of the pEvents -- array.
pEvents is a pointer to an array of event object handles -- to wait on.
srcStageMask is a bitmask of PipelineStageFlagBits -- specifying the source stage mask.
dstStageMask is a bitmask of PipelineStageFlagBits -- specifying the destination stage mask.
memoryBarrierCount is the length of the -- pMemoryBarriers array.
pMemoryBarriers is a pointer to an array of -- MemoryBarrier structures.
bufferMemoryBarrierCount is the length of the -- pBufferMemoryBarriers array.
pBufferMemoryBarriers is a pointer to an array of -- BufferMemoryBarrier structures.
imageMemoryBarrierCount is the length of the -- pImageMemoryBarriers array.
pImageMemoryBarriers is a pointer to an array of -- ImageMemoryBarrier structures.

-- --

Description

-- -- When cmdWaitEvents 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. cmdWaitEvents must -- not be used to wait on event signal operations occurring 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 cmdSetEvent 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 setEvent are only included in -- the first synchronization scope if 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 -- -- cmdWaitEvents is used with cmdSetEvent 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. -- -- Unlike cmdPipelineBarrier, a queue family ownership -- transfer cannot be performed using cmdWaitEvents. -- -- Note -- -- Applications should be careful to avoid race conditions when -- using events. There is no direct ordering guarantee between a -- cmdResetEvent command and a cmdWaitEvents 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 -- cmdSetEvent with any of the members of pEvents and -- PIPELINE_STAGE_HOST_BIT if any of the members of -- pEvents was set using setEvent

-- --

If the geometry shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If pEvents includes one or more events that will be -- signaled by setEvent after commandBuffer has been -- submitted to a queue, then cmdWaitEvents 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 CommandPoolCreateInfo structure that was used to create the -- CommandPool 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
The srcQueueFamilyIndex and dstQueueFamilyIndex -- members of any element of pBufferMemoryBarriers or -- pImageMemoryBarriers must be equal
commandBuffer’s current device mask must include -- exactly one physical device
If the mesh shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
If the mesh shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
The srcAccessMask member of each element of -- pMemoryBarriers must only include access flags that -- are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
The dstAccessMask member of each element of -- pMemoryBarriers must only include access flags that -- are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types
The srcAccessMask member of each element of -- pBufferMemoryBarriers must only include access flags -- that are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
The dstAccessMask member of each element of -- pBufferMemoryBarriers must only include access flags -- that are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types
The srcAccessMask member of each element of -- pImageMemoryBarriers must only include access flags -- that are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
The dstAccessMask member of any element of -- pImageMemoryBarriers must only include access flags -- that are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pEvents must be a valid pointer to an array of -- eventCount valid Event handles
srcStageMask must be a valid combination of -- PipelineStageFlagBits values
srcStageMask must not be 0
dstStageMask must be a valid combination of -- PipelineStageFlagBits values
dstStageMask must not be 0
If memoryBarrierCount is not 0, -- pMemoryBarriers must be a valid pointer to an array of -- memoryBarrierCount valid MemoryBarrier structures
If bufferMemoryBarrierCount is not 0, -- pBufferMemoryBarriers must be a valid pointer to an -- array of bufferMemoryBarrierCount valid -- BufferMemoryBarrier structures
If imageMemoryBarrierCount is not 0, -- pImageMemoryBarriers must be a valid pointer to an -- array of imageMemoryBarrierCount valid -- ImageMemoryBarrier structures
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

srcStageMask is a bitmask of PipelineStageFlagBits -- specifying the source stage mask.
dstStageMask is a bitmask of PipelineStageFlagBits -- specifying the destination stage mask.
dependencyFlags is a bitmask of DependencyFlagBits -- specifying how execution and memory dependencies are formed.
memoryBarrierCount is the length of the -- pMemoryBarriers array.
pMemoryBarriers is a pointer to an array of -- MemoryBarrier structures.
bufferMemoryBarrierCount is the length of the -- pBufferMemoryBarriers array.
pBufferMemoryBarriers is a pointer to an array of -- BufferMemoryBarrier structures.
imageMemoryBarrierCount is the length of the -- pImageMemoryBarriers array.
pImageMemoryBarriers is a pointer to an array of -- ImageMemoryBarrier structures.

-- --

Description

-- -- When cmdPipelineBarrier is submitted to a queue, it defines a -- memory dependency between commands that were submitted before it, and -- those submitted after it. -- -- If cmdPipelineBarrier was recorded outside a render pass -- instance, the first synchronization scope includes all commands -- that occur earlier in submission order. If -- cmdPipelineBarrier 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 cmdPipelineBarrier was recorded outside a render pass -- instance, the second synchronization scope includes all -- commands that occur later in submission order. If -- cmdPipelineBarrier 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 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 -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT

-- --

If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If cmdPipelineBarrier is called within a render pass -- instance, the render pass must have been created with at least -- one SubpassDependency instance in -- RenderPassCreateInfo::pDependencies that expresses a -- dependency from the current subpass to itself, and for which -- srcStageMask contains a subset of the bit values in -- SubpassDependency::srcStageMask, dstStageMask -- contains a subset of the bit values in -- SubpassDependency::dstStageMask, -- dependencyFlags is equal to -- SubpassDependency::dependencyFlags, -- srcAccessMask member of each element of -- pMemoryBarriers and pImageMemoryBarriers contains a -- subset of the bit values in -- SubpassDependency::srcAccessMask, and -- dstAccessMask member of each element of -- pMemoryBarriers and pImageMemoryBarriers contains a -- subset of the bit values in -- SubpassDependency::dstAccessMask
If cmdPipelineBarrier is called within a render pass -- instance, bufferMemoryBarrierCount must be -- 0
If cmdPipelineBarrier 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 SubpassDescription instance or by the -- pDepthStencilResolveAttachment member of the -- SubpassDescriptionDepthStencilResolve structure that the -- current subpass was created with
If cmdPipelineBarrier 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 -- SubpassDescription instance or by the -- pDepthStencilResolveAttachment member of the -- SubpassDescriptionDepthStencilResolve structure that the -- current subpass was created with, that refers to the same -- image
If cmdPipelineBarrier is called within a render pass -- instance, the oldLayout and newLayout members of an -- element of pImageMemoryBarriers must be equal
If cmdPipelineBarrier is called within a render pass -- instance, the srcQueueFamilyIndex and -- dstQueueFamilyIndex members of any element of -- pImageMemoryBarriers must be -- 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 CommandPoolCreateInfo structure that was used to create the -- CommandPool that commandBuffer was allocated from, as -- specified in the table of supported pipeline stages
If cmdPipelineBarrier is called outside of a render pass -- instance, dependencyFlags must not include -- DEPENDENCY_VIEW_LOCAL_BIT
If the mesh shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
If the mesh shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
The srcAccessMask member of each element of -- pMemoryBarriers must only include access flags that -- are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
The dstAccessMask member of each element of -- pMemoryBarriers must only include access flags that -- are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types
For any element of pBufferMemoryBarriers, if its -- srcQueueFamilyIndex and dstQueueFamilyIndex members -- are equal, or if its srcQueueFamilyIndex is the queue family -- index that was used to create the command pool that -- commandBuffer was allocated from, then its -- srcAccessMask member must only contain access flags -- that are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
For any element of pBufferMemoryBarriers, if its -- srcQueueFamilyIndex and dstQueueFamilyIndex members -- are equal, or if its dstQueueFamilyIndex is the queue family -- index that was used to create the command pool that -- commandBuffer was allocated from, then its -- dstAccessMask member must only contain access flags -- that are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types
For any element of pImageMemoryBarriers, if its -- srcQueueFamilyIndex and dstQueueFamilyIndex members -- are equal, or if its srcQueueFamilyIndex is the queue family -- index that was used to create the command pool that -- commandBuffer was allocated from, then its -- srcAccessMask member must only contain access flags -- that are supported by one or more of the pipeline stages in -- srcStageMask, as specified in the table of supported -- access types
For any element of pImageMemoryBarriers, if its -- srcQueueFamilyIndex and dstQueueFamilyIndex members -- are equal, or if its dstQueueFamilyIndex is the queue family -- index that was used to create the command pool that -- commandBuffer was allocated from, then its -- dstAccessMask member must only contain access flags -- that are supported by one or more of the pipeline stages in -- dstStageMask, as specified in the table of supported -- access types

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

srcStageMask must be a valid combination of -- PipelineStageFlagBits values
srcStageMask must not be 0
dstStageMask must be a valid combination of -- PipelineStageFlagBits values
dstStageMask must not be 0
dependencyFlags must be a valid combination of -- DependencyFlagBits values
If memoryBarrierCount is not 0, -- pMemoryBarriers must be a valid pointer to an array of -- memoryBarrierCount valid MemoryBarrier structures
If bufferMemoryBarrierCount is not 0, -- pBufferMemoryBarriers must be a valid pointer to an -- array of bufferMemoryBarrierCount valid -- BufferMemoryBarrier structures
If imageMemoryBarrierCount is not 0, -- pImageMemoryBarriers must be a valid pointer to an -- array of imageMemoryBarrierCount valid -- ImageMemoryBarrier structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 QueryControlFlagBits -- specifying constraints on the types of queries that can be -- performed.

-- --

Description

-- -- If the queryType of the pool is QUERY_TYPE_OCCLUSION -- and flags contains 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. -- -- Calling cmdBeginQuery is equivalent to calling -- cmdBeginQueryIndexedEXT with the index parameter set -- to zero. -- -- 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
The queryType used to create queryPool -- must not be QUERY_TYPE_TIMESTAMP
If the precise occlusion queries feature is not enabled, or -- the queryType used to create queryPool was not -- QUERY_TYPE_OCCLUSION, flags must not contain -- QUERY_CONTROL_PRECISE_BIT
query must be less than the number of queries in -- queryPool
If the queryType used to create queryPool was -- QUERY_TYPE_OCCLUSION, the CommandPool that -- commandBuffer was allocated from must support graphics -- operations
If the queryType used to create queryPool was -- QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate graphics operations, the -- CommandPool that commandBuffer was allocated from -- must support graphics operations
If the queryType used to create queryPool was -- QUERY_TYPE_PIPELINE_STATISTICS and any of the -- pipelineStatistics indicate compute operations, the -- CommandPool that commandBuffer was allocated from -- must support compute operations
commandBuffer must not be a protected command -- buffer
If 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
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT the CommandPool -- that commandBuffer was allocated from must support -- graphics operations
If the queryType used to create queryPool was -- QUERY_TYPE_TRANSFORM_FEEDBACK_STREAM_EXT then -- PhysicalDeviceTransformFeedbackPropertiesEXT::transformFeedbackQueries -- must be supported
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, the profiling lock -- must have been held before beginCommandBuffer was called -- on commandBuffer
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one of the counters used -- to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_COMMAND_BUFFER_KHR, the query begin -- must be the first recorded command in -- commandBuffer
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one of the counters used -- to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_RENDER_PASS_KHR, the begin command -- must not be recorded within a render pass instance
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and another query pool with a -- queryType QUERY_TYPE_PERFORMANCE_QUERY_KHR has been -- used within commandBuffer, its parent primary command buffer -- or secondary command buffer recorded within the same parent primary -- command buffer as commandBuffer, the -- performanceCounterMultipleQueryPools feature must be -- enabled
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, this command must not -- be recorded in a command buffer that, either directly or through -- secondary command buffers, also contains a cmdResetQueryPool -- command affecting the same query

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
flags must be a valid combination of -- QueryControlFlagBits values
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- -- Calling cmdEndQuery is equivalent to calling -- cmdEndQueryIndexedEXT with the index parameter set to -- zero. -- -- 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 getQueryPoolResults and -- cmdCopyQueryPoolResults, 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
commandBuffer must not be a protected command -- buffer
If cmdEndQuery 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
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one or more of the -- counters used to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_COMMAND_BUFFER_KHR, the -- cmdEndQuery must be the last recorded command in -- commandBuffer
If queryPool was created with a queryType of -- QUERY_TYPE_PERFORMANCE_QUERY_KHR and one or more of the -- counters used to create queryPool was -- PERFORMANCE_COUNTER_SCOPE_RENDER_PASS_KHR, the -- cmdEndQuery must not be recorded within a render pass -- instance

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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. -- -- If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, this command sets the status -- of query indices [firstQuery, firstQuery + -- queryCount - 1] to unavailable for each pass of -- queryPool, as indicated by a call to -- getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR. -- -- Note -- -- Because cmdResetQueryPool resets all the passes of the -- indicated queries, applications must not record a -- cmdResetQueryPool command for a queryPool created with -- QUERY_TYPE_PERFORMANCE_QUERY_KHR in a command buffer that needs -- to be submitted multiple times as indicated by a call to -- getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR. -- Otherwise applications will never be able to complete the recorded -- queries. -- --

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
All queries used by the command must not be active
If queryPool was created with -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, this command must not -- be recorded in a command buffer that, either directly or through -- secondary command buffers, also contains begin commands for a query -- from the set of queries [firstQuery, firstQuery + -- queryCount - 1]

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pipelineStage is one of the PipelineStageFlagBits, -- 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

-- -- cmdWriteTimestamp 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. -- -- cmdCopyQueryPoolResults 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 getQueryPoolResults. As with other queries, the query -- must be reset using cmdResetQueryPool or -- resetQueryPool before requesting the timestamp value be written -- to it. -- -- While cmdWriteTimestamp can be called inside or outside -- of a render pass instance, cmdCopyQueryPoolResults 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 cmdWriteTimestamp 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 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 cmdWriteTimestamp 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 CommandBuffer -- handle

-- --

pipelineStage must be a valid -- PipelineStageFlagBits value
queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 Buffer 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 getQueryPoolResults.
flags is a bitmask of QueryResultFlagBits -- specifying how and when results are returned.

-- --

Description

-- -- cmdCopyQueryPoolResults is guaranteed to see the effect of -- previous uses of cmdResetQueryPool 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 getQueryPoolResults, but the -- different style of execution causes some subtle behavioral -- differences. Because cmdCopyQueryPoolResults executes in order -- with respect to other query commands, there is less ambiguity about -- which use of a query is being requested. -- -- Results for all requested occlusion queries, pipeline statistics -- queries, transform feedback queries, and timestamp queries are written -- as 64-bit unsigned integer values if QUERY_RESULT_64_BIT is set -- or 32-bit unsigned integer values otherwise. Performance queries store -- results in a tightly packed array whose type is determined by the -- unit member of the corresponding -- PerformanceCounterKHR. -- -- If neither of QUERY_RESULT_WAIT_BIT and -- QUERY_RESULT_WITH_AVAILABILITY_BIT are set, results are only -- written out for queries in the available state. -- -- If 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 ERROR_DEVICE_LOST -- error may occur. -- -- Similarly, if QUERY_RESULT_WITH_AVAILABILITY_BIT is set and -- 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 getQueryPoolResults, implementations -- must guarantee that if they return a non-zero availability -- value, then the numerical results are valid. -- -- If QUERY_RESULT_PARTIAL_BIT is set, -- 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. -- -- QUERY_RESULT_PARTIAL_BIT must not be used if the pool’s -- queryType is QUERY_TYPE_TIMESTAMP. -- -- cmdCopyQueryPoolResults is considered to be a transfer -- operation, and its writes to buffer memory must be synchronized -- using PIPELINE_STAGE_TRANSFER_BIT and -- 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 QUERY_RESULT_64_BIT is not set in flags then -- dstOffset and stride must be multiples of -- 4
If 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 -- BUFFER_USAGE_TRANSFER_DST_BIT usage flag
If dstBuffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
If the queryType used to create queryPool was -- QUERY_TYPE_TIMESTAMP, flags must not contain -- QUERY_RESULT_PARTIAL_BIT
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, -- PhysicalDevicePerformanceQueryPropertiesKHR::allowCommandBufferQueryCopies -- must be TRUE
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, flags must -- not contain QUERY_RESULT_WITH_AVAILABILITY_BIT, -- QUERY_RESULT_PARTIAL_BIT or QUERY_RESULT_64_BIT
If the queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_KHR, the queryPool -- must have been submitted once for each pass as retrieved via a -- call to -- getPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR
cmdCopyQueryPoolResults must not be called if the -- queryType used to create queryPool was -- QUERY_TYPE_PERFORMANCE_QUERY_INTEL

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

queryPool must be a valid QueryPool -- handle
dstBuffer must be a valid Buffer -- handle
flags must be a valid combination of -- QueryResultFlagBits values
commandBuffer must be in the recording -- state
The CommandPool 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 Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 ShaderStageFlagBits -- 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 a pointer to an array of size bytes -- containing the new push constant values.

-- --

Description

-- -- Note -- -- As stageFlags needs to include all flags the relevant push -- constant ranges were created with, any flags that are not supported by -- the queue family that the CommandPool used to allocate -- commandBuffer was created on are ignored. -- --

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 PushConstantRange::stageFlags
offset must be a multiple of 4
size must be a multiple of 4
offset must be less than -- PhysicalDeviceLimits::maxPushConstantsSize
size must be less than or equal to -- PhysicalDeviceLimits::maxPushConstantsSize minus -- offset

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

layout must be a valid PipelineLayout -- handle
stageFlags must be a valid combination of -- ShaderStageFlagBits 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 CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer in which to record -- the command.

-- --

pRenderPassBegin is a pointer to a -- RenderPassBeginInfo structure specifying the render pass to -- begin an instance of, and the framebuffer the instance uses.
contents is a SubpassContents 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 AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT

-- --

If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then the -- corresponding attachment image view of the framebuffer specified in -- the framebuffer member of pRenderPassBegin -- must have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the stencilInitialLayout or -- stencilFinalLayout member of the -- AttachmentDescriptionStencilLayout structures or the -- stencilLayout member of the -- AttachmentReferenceStencilLayout structures specified when -- creating the render pass specified in the renderPass member -- of pRenderPassBegin is -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_SAMPLED_BIT or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_TRANSFER_SRC_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_TRANSFER_DST_BIT
If any of the initialLayout members of the -- AttachmentDescription structures specified when creating the -- render pass specified in the renderPass member of -- pRenderPassBegin is not 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 -- RenderPassCreateInfo used to create renderPass -- must be supported by the capabilities of the queue family -- identified by the queueFamilyIndex member of the -- CommandPoolCreateInfo used to create the command pool which -- commandBuffer was allocated from
For any attachment in framebuffer that is used by -- renderPass and is bound to memory locations that are also -- bound to another attachment used by renderPass, and if at -- least one of those uses causes either attachment to be written to, -- both attachments must have had the -- ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pRenderPassBegin must be a valid pointer to a -- valid RenderPassBeginInfo structure
contents must be a valid SubpassContents -- value
commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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

-- --

Description

-- -- The subpass index for a render pass begins at zero when -- cmdBeginRenderPass is recorded, and increments each time -- cmdNextSubpass 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. This applies to resolve operations for -- both color and depth/stencil attachments. That is, they are considered -- to execute in the PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT -- pipeline stage and their writes are synchronized with -- 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

-- --

This command must not be recorded when transform feedback -- is active

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

contents must be a valid SubpassContents -- value
commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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 a pointer to an array of -- commandBufferCount 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 -- 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

-- --

Each element of pCommandBuffers must have been -- allocated with a level of -- 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 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 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 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 CommandPool that was created for the same -- queue family as the CommandPool from which -- commandBuffer was allocated
If cmdExecuteCommands is being called within a render pass -- instance, that render pass instance must have been begun with -- the contents parameter of cmdBeginRenderPass set to -- SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS
If cmdExecuteCommands is being called within a render pass -- instance, each element of pCommandBuffers must have -- been recorded with the -- COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
If cmdExecuteCommands is being called within a render pass -- instance, each element of pCommandBuffers must have -- been recorded with -- CommandBufferInheritanceInfo::subpass set to the index -- of the subpass which the given command buffer will be executed in
If cmdExecuteCommands is being called within a render pass -- instance, the render passes specified in the -- pBeginInfo->pInheritanceInfo->renderPass members of the -- beginCommandBuffer commands used to begin recording each -- element of pCommandBuffers must be compatible -- with the current render pass
If cmdExecuteCommands is being called within a render pass -- instance, and any element of pCommandBuffers was recorded -- with CommandBufferInheritanceInfo::framebuffer not -- equal to NULL_HANDLE, that Framebuffer must match -- the Framebuffer used in the current render pass instance
If cmdExecuteCommands is being called within a render pass -- instance that included RenderPassTransformBeginInfoQCOM in the -- pNext chain of RenderPassBeginInfo, then each element -- of pCommandBuffers must have been recorded with -- CommandBufferInheritanceRenderPassTransformInfoQCOM in the -- pNext chain of CommandBufferBeginInfo
If cmdExecuteCommands is being called within a render pass -- instance that included RenderPassTransformBeginInfoQCOM in the -- pNext chain of RenderPassBeginInfo, then each element -- of pCommandBuffers must have been recorded with -- CommandBufferInheritanceRenderPassTransformInfoQCOM::transform -- identical to -- RenderPassTransformBeginInfoQCOM::transform
If cmdExecuteCommands is being called within a render pass -- instance that included RenderPassTransformBeginInfoQCOM in the -- pNext chain of RenderPassBeginInfo, then each element -- of pCommandBuffers must have been recorded with -- CommandBufferInheritanceRenderPassTransformInfoQCOM::renderArea -- identical to RenderPassBeginInfo::renderArea
If cmdExecuteCommands is not being called within a render -- pass instance, each element of pCommandBuffers must -- not have been recorded with the -- 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 QUERY_TYPE_OCCLUSION query -- active, then each element of pCommandBuffers -- must have been recorded with -- CommandBufferInheritanceInfo::occlusionQueryEnable set -- to TRUE
If commandBuffer has a QUERY_TYPE_OCCLUSION query -- active, then each element of pCommandBuffers -- must have been recorded with -- CommandBufferInheritanceInfo::queryFlags having all -- bits set that are set for the query
If commandBuffer has a -- QUERY_TYPE_PIPELINE_STATISTICS query active, then each -- element of pCommandBuffers must have been recorded -- with CommandBufferInheritanceInfo::pipelineStatistics -- having all bits set that are set in the QueryPool the query -- uses
Each element of pCommandBuffers must not begin any -- query types that are active in commandBuffer
If commandBuffer is a protected command buffer, then each -- element of pCommandBuffers must be a protected command -- buffer
If commandBuffer is an unprotected command buffer, then -- each element of pCommandBuffers must be an unprotected -- command buffer
This command must not be recorded when transform feedback -- is active

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pCommandBuffers must be a valid pointer to an -- array of commandBufferCount valid CommandBuffer -- handles
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support transfer, graphics, or compute -- operations
commandBuffer must be a primary -- CommandBuffer
commandBufferCount must be greater than -- 0
Both of commandBuffer, and the elements of -- pCommandBuffers must have been created, allocated, or -- retrieved from the same Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Description

-- -- The framebuffer depth coordinate zf may be represented -- using either a fixed-point or floating-point representation. However, -- a floating-point representation must be used if the -- depth/stencil attachment has a floating-point depth component. If an -- m-bit fixed-point representation is used, we assume that it represents -- each value <math>, where k ∈ { 0, 1, …, 2m-1 }, as k (e.g. 1.0 -- is represented in binary as a string of all ones). -- -- The viewport parameters shown in the above equations are found from -- these values as -- --

ox = x + width / 2
oy = y + height / 2
oz = minDepth
px = width
py = height
pz = maxDepth - minDepth.

-- -- If a render pass transform is enabled, the values (px,py) and (ox, oy) -- defining the viewport are transformed as described in render pass -- transform before participating in the viewport transform. -- -- The application can specify a negative term for -- height, which has the effect of negating the y coordinate in -- clip space before performing the transform. When using a negative -- height, the application should also adjust the -- y value to point to the lower left corner of the viewport -- instead of the upper left corner. Using the negative height -- allows the application to avoid having to negate the y component of -- the Position output from the last vertex processing stage in -- shaders that also target other graphics APIs. -- -- The width and height of the implementation-dependent maximum -- viewport dimensions must be greater than or equal to the -- width and height of the largest image which can be created and -- attached to a framebuffer. -- -- The floating-point viewport bounds are represented with an -- implementation-dependent precision. -- --

Valid Usage

-- --

width must be greater than 0.0

-- --

width must be less than or equal to -- PhysicalDeviceLimits::maxViewportDimensions[0]
The absolute value of height must be less than or -- equal to -- PhysicalDeviceLimits::maxViewportDimensions[1]
x must be greater than or equal to -- viewportBoundsRange[0]
(x + width) must be less than or equal to -- viewportBoundsRange[1]
y must be greater than or equal to -- viewportBoundsRange[0]
y must be less than or equal to -- viewportBoundsRange[1]
(y + height) must be greater than or -- equal to viewportBoundsRange[0]
(y + height) must be less than or equal -- to viewportBoundsRange[1]
Unless VK_EXT_depth_range_unrestricted extension is -- enabled minDepth must be between 0.0 and -- 1.0, inclusive
Unless VK_EXT_depth_range_unrestricted extension is -- enabled maxDepth must be between 0.0 and -- 1.0, inclusive

-- --

srcSubresource must be a valid -- ImageSubresourceLayers structure

-- --

dstSubresource must be a valid -- ImageSubresourceLayers 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 ImageType -- 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 -- 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 -- IMAGE_TYPE_1D or 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 -- 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 -- IMAGE_TYPE_1D or 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 -- ImageSubresourceLayers structure

-- --

dstSubresource must be a valid -- ImageSubresourceLayers 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 FORMAT_S8_UINT value per -- texel.
data copied to or from the depth aspect of a -- FORMAT_D16_UNORM or FORMAT_D16_UNORM_S8_UINT format is -- tightly packed with one FORMAT_D16_UNORM value per texel.
data copied to or from the depth aspect of a -- FORMAT_D32_SFLOAT or FORMAT_D32_SFLOAT_S8_UINT format is -- tightly packed with one FORMAT_D32_SFLOAT value per texel.
data copied to or from the depth aspect of a -- FORMAT_X8_D24_UNORM_PACK32 or 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, and the -- VK_EXT_depth_range_unrestricted extension is not enabled, the -- data in buffer memory must be in the range [0,1], or the -- resulting values are undefined. -- -- 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 Image parameter’s format is not a -- depth/stencil format or a multi-planar format, then -- bufferOffset must be a multiple of the format’s texel -- block size

-- --

If the calling command’s Image 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 -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#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 -- (cmdCopyImageToBuffer) or dstImage -- (cmdCopyBufferToImage) is of type 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 -- (cmdCopyImageToBuffer) or dstImage -- (cmdCopyBufferToImage) is of type IMAGE_TYPE_1D or -- IMAGE_TYPE_2D, then imageOffset.z must be -- 0 and imageExtent.depth must be -- 1
If the calling command’s Image 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 Image 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 Image 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 Image 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 Image 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 Image 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 Image 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 -- Image parameter
If the calling command’s Image parameter’s format is a -- multi-planar format, then the aspectMask member of -- imageSubresource must be -- IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or -- IMAGE_ASPECT_PLANE_2_BIT (with 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 Image parameter is of -- ImageType IMAGE_TYPE_3D, the baseArrayLayer and -- layerCount members of imageSubresource must -- be 0 and 1, respectively

-- --

Valid Usage (Implicit)

-- --

imageSubresource must be a valid -- ImageSubresourceLayers 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. The render area, after any transform -- specified by -- RenderPassTransformBeginInfoQCOM::transform is -- applied, must be contained within the framebuffer dimensions. -- -- If render pass transform is enabled, then renderArea -- must equal the framebuffer pre-transformed dimensions. After -- renderArea has been transformed by -- RenderPassTransformBeginInfoQCOM::transform, the -- resulting render area must be equal to 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 ATTACHMENT_LOAD_OP_CLEAR

-- --

renderPass must be compatible with the -- renderPass member of the FramebufferCreateInfo -- structure specified when creating framebuffer
If the pNext chain does not contain -- DeviceGroupRenderPassBeginInfo or its -- deviceRenderAreaCount member is equal to 0, -- renderArea.offset.x must be greater than or equal to -- 0
If the pNext chain does not contain -- DeviceGroupRenderPassBeginInfo or its -- deviceRenderAreaCount member is equal to 0, -- renderArea.offset.y must be greater than or equal to -- 0
If the pNext chain does not contain -- DeviceGroupRenderPassBeginInfo or its -- deviceRenderAreaCount member is equal to 0, -- renderArea.offset.x + renderArea.offset.width -- must be less than or equal to -- FramebufferCreateInfo::width the framebuffer -- was created with
If the pNext chain does not contain -- DeviceGroupRenderPassBeginInfo or its -- deviceRenderAreaCount member is equal to 0, -- renderArea.offset.y + renderArea.offset.height -- must be less than or equal to -- FramebufferCreateInfo::height the framebuffer -- was created with
If the pNext chain contains -- DeviceGroupRenderPassBeginInfo, the offset.x member of -- each element of pDeviceRenderAreas must be greater -- than or equal to 0
If the pNext chain contains -- DeviceGroupRenderPassBeginInfo, the offset.y member of -- each element of pDeviceRenderAreas must be greater -- than or equal to 0
If the pNext chain contains -- DeviceGroupRenderPassBeginInfo, offset.x + -- offset.width of each element of pDeviceRenderAreas -- must be less than or equal to -- FramebufferCreateInfo::width the framebuffer -- was created with
If the pNext chain contains -- DeviceGroupRenderPassBeginInfo, offset.y + -- offset.height of each element of pDeviceRenderAreas -- must be less than or equal to -- FramebufferCreateInfo::height the framebuffer -- was created with
If framebuffer was created with a -- FramebufferCreateInfo::flags value that did not -- include FRAMEBUFFER_CREATE_IMAGELESS_BIT, and the -- pNext chain includes a RenderPassAttachmentBeginInfo -- structure, its attachmentCount must be zero
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, the attachmentCount -- of a RenderPassAttachmentBeginInfo structure included in the -- pNext chain must be equal to the value of -- FramebufferAttachmentsCreateInfo::attachmentImageInfoCount -- used to create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must have been -- created on the same Device as framebuffer and -- renderPass
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageCreateInfo::flags equal to the flags -- member of the corresponding element of -- FramebufferAttachmentsCreateInfoKHR::pAttachments used -- to create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageCreateInfo::usage equal to the usage -- member of the corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView with a width equal to the width member of -- the corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView with a height equal to the height member of -- the corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageViewCreateInfo::subresourceRange.layerCount equal -- to the layerCount member of the corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageFormatListCreateInfo::viewFormatCount equal to -- the viewFormatCount member of the corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a set of elements in -- ImageFormatListCreateInfo::pViewFormats equal to the -- set of elements in the pViewFormats member of the -- corresponding element of -- FramebufferAttachmentsCreateInfo::pAttachments used to -- create framebuffer
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageViewCreateInfo::format equal to the corresponding -- value of AttachmentDescription::format in -- renderPass
If framebuffer was created with a -- FramebufferCreateInfo::flags value that included -- FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of the -- pAttachments member of a RenderPassAttachmentBeginInfo -- structure included in the pNext chain must be a -- ImageView of an image created with a value of -- ImageCreateInfo::samples equal to the corresponding -- value of AttachmentDescription::samples in -- renderPass
If the pNext chain includes -- RenderPassTransformBeginInfoQCOM, -- renderArea::offset must equal (0,0)
If the pNext chain includes -- RenderPassTransformBeginInfoQCOM, -- renderArea::extent transformed by -- RenderPassTransformBeginInfoQCOM::transform -- must equal the framebuffer dimensions

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 DeviceGroupRenderPassBeginInfo, -- RenderPassAttachmentBeginInfo, -- RenderPassSampleLocationsBeginInfoEXT, or -- RenderPassTransformBeginInfoQCOM
The sType value of each struct in the pNext -- chain must be unique
renderPass must be a valid RenderPass -- handle
framebuffer must be a valid Framebuffer -- handle
If clearValueCount is not 0, -- pClearValues must be a valid pointer to an array of -- clearValueCount ClearValue unions
Both of framebuffer, and renderPass must -- have been created, allocated, or retrieved from the same -- Device

-- --

Description

-- -- No memory barriers are needed between cmdClearAttachments and -- preceding or subsequent draw or attachment clear commands in the same -- subpass. -- -- The cmdClearAttachments command is not affected by the bound -- pipeline state. -- -- Attachments can also be cleared at the beginning of a render -- pass instance by setting loadOp (or stencilLoadOp) -- of AttachmentDescription to ATTACHMENT_LOAD_OP_CLEAR, as -- described for createRenderPass. -- --

Valid Usage

-- --

If aspectMask includes IMAGE_ASPECT_COLOR_BIT, it -- must not include IMAGE_ASPECT_DEPTH_BIT or -- IMAGE_ASPECT_STENCIL_BIT

-- --

aspectMask must not include -- IMAGE_ASPECT_METADATA_BIT
aspectMask must not include -- VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index -- i
clearValue must be a valid ClearValue -- union

-- --

Valid Usage (Implicit)

-- --

aspectMask must be a valid combination of -- ImageAspectFlagBits values

-- --

aspectMask must not be 0

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pExclusiveScissors must be a valid pointer to an -- array of exclusiveScissorCount Rect2D structures
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics operations
exclusiveScissorCount must be greater than -- 0

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Members

-- -- The members of the PhysicalDeviceExclusiveScissorFeaturesNV -- structure describe the following features: -- --

Description

-- -- See Exclusive Scissor Test for more information. -- -- If the PhysicalDeviceExclusiveScissorFeaturesNV structure is -- included in the pNext chain of -- PhysicalDeviceFeatures2, it is filled with values indicating -- whether the feature is supported. -- PhysicalDeviceExclusiveScissorFeaturesNV can also be -- included in the pNext chain of DeviceCreateInfo to -- enable the feature. -- --

Valid Usage (Implicit)

-- --

Description

-- -- If this structure is not present, exclusiveScissorCount is -- considered to be 0 and the exclusive scissor test is -- disabled. -- --

Valid Usage

-- --

If the multiple viewports feature is not enabled, -- exclusiveScissorCount must be 0 or -- 1

-- --

exclusiveScissorCount must be less than or equal -- to PhysicalDeviceLimits::maxViewports
exclusiveScissorCount must be 0 or -- identical to the viewportCount member of -- PipelineViewportStateCreateInfo
If no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV -- and exclusiveScissorCount is not 0, -- pExclusiveScissors must be a valid pointer to an array -- of exclusiveScissorCount Rect2D structures

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV

-- --

If exclusiveScissorCount is not 0, and -- pExclusiveScissors is not NULL, -- pExclusiveScissors must be a valid pointer to an array -- of exclusiveScissorCount Rect2D structures

-- --

Parameters

-- --

device is the device to create the swapchain for.

-- --

pCreateInfo is a pointer to a -- SwapchainCreateInfoKHR 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 SwapchainKHR handle -- in which the created swapchain object will be returned.

-- --

Description

-- -- If the oldSwapchain parameter of pCreateInfo is a -- valid swapchain, which has exclusive full-screen access, that access -- is released from oldSwapchain. If the command succeeds in -- this case, the newly created swapchain will automatically acquire -- exclusive full-screen access from oldSwapchain. -- -- Note -- -- This implicit transfer is intended to avoid exiting and entering -- full-screen exclusive mode, which may otherwise cause unwanted visual -- updates to the display. -- -- In some cases, swapchain creation may fail if exclusive -- full-screen mode is requested for application control, but for some -- implementation-specific reason exclusive full-screen access is -- unavailable for the particular combination of parameters provided. If -- this occurs, ERROR_INITIALIZATION_FAILED will be returned. -- -- Note -- -- In particular, it will fail if the imageExtent member of -- pCreateInfo does not match the extents of the monitor. Other -- reasons for failure may include the app not being set as high-dpi -- aware, or if the physical device and monitor are not compatible in -- this mode. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- SwapchainCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSwapchain must be a valid pointer to a -- SwapchainKHR handle

-- --

Host Synchronization

-- --

Host access to pCreateInfo->surface must be -- externally synchronized

-- --

Host access to pCreateInfo->oldSwapchain must -- be externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the Device 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 Image -- handles are destroyed, and must not be acquired or used any -- more by the application. The memory of each Image 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 -- SurfaceKHR, 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. -- -- If swapchain has exclusive full-screen access, it is released -- before the swapchain is destroyed. -- --

Valid Usage

-- --

All uses of presentable images acquired from swapchain -- must have completed execution

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If swapchain is not NULL_HANDLE, -- swapchain must be a valid SwapchainKHR -- handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
Both of device, and swapchain that are valid -- handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Instance

-- --

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 Image 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, INCOMPLETE will be -- returned instead of SUCCESS to indicate that not all the -- available values were returned. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- 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 Image handles
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 NULL_HANDLE or a semaphore to -- signal.
fence is NULL_HANDLE or a fence to signal.
pImageIndex is a pointer to a uint32_t in which -- the index of the next image to use (i.e. an index into the array of -- images returned by getSwapchainImagesKHR) is returned.

-- --

Valid Usage

-- --

swapchain must not be in the retired state

-- --

If semaphore is not NULL_HANDLE it must be -- unsignaled
If semaphore is not NULL_HANDLE it must not -- have any uncompleted signal or wait operations pending
If fence is not 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 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 SurfaceCapabilitiesKHR::minImageCount as -- returned by a call to getPhysicalDeviceSurfaceCapabilities2KHR -- with the surface used to create swapchain, -- timeout must not be UINT64_MAX
semaphore must have a SemaphoreType of -- SEMAPHORE_TYPE_BINARY

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- handle
If semaphore is not NULL_HANDLE, -- semaphore must be a valid Semaphore handle
If fence is not NULL_HANDLE, fence -- must be a valid Fence 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 of non-ignored parameters must have been created, -- allocated, or retrieved from the same Instance

-- --

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

-- --

Failure --

-- --

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 a PresentInfoKHR -- structure specifying 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 -- getPhysicalDeviceSurfaceSupportKHR

-- --

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 wait operation referring to a binary semaphore -- defined by the elements of the pWaitSemaphores member of -- pPresentInfo executes on queue, there must be -- no other queues 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
All elements of the pWaitSemaphores member of -- pPresentInfo must be created with a -- SemaphoreType of SEMAPHORE_TYPE_BINARY
All elements of the pWaitSemaphores member of -- pPresentInfo must reference a semaphore signal -- operation that has been submitted for execution and any semaphore -- signal operations on which it depends (if any) must have also -- been submitted for execution

-- -- Any writes to memory backing the images referenced by the -- pImageIndices and pSwapchains members of -- pPresentInfo, that are available before -- queuePresentKHR 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. -- -- Note -- -- The origin of the native orientation of the surface coordinate system -- is not specified in the Vulkan specification; it depends on the -- platform. For most platforms the origin is by default upper-left, -- meaning the pixel of the presented Image at coordinates (0,0) -- would appear at the upper left pixel of the platform surface (assuming -- SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the display standing -- the right way up). -- -- If queuePresentKHR fails to enqueue the corresponding set of -- queue operations, it may return ERROR_OUT_OF_HOST_MEMORY -- or 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 queuePresentKHR fails in such a way that the implementation -- is unable to make that guarantee, the implementation must -- return ERROR_DEVICE_LOST. -- -- However, if the presentation request is rejected by the presentation -- engine with an error ERROR_OUT_OF_DATE_KHR, -- ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT, or -- ERROR_SURFACE_LOST_KHR, the set of queue operations are still -- considered to be enqueued and thus any semaphore wait operation -- specified in PresentInfoKHR will execute when the corresponding -- queue operation is complete. -- -- If any swapchain member of pPresentInfo was created -- with FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, -- ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT will be returned if -- that swapchain does not have exclusive full-screen access, possibly -- for implementation-specific reasons outside of the application’s -- control. -- --

Valid Usage (Implicit)

-- --

queue must be a valid Queue handle

-- --

pPresentInfo must be a valid pointer to a valid -- PresentInfoKHR 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

-- -- ' -- -- TODO: table -- --

Return Codes

-- --

Success --
- SUCCESS
- SUBOPTIMAL_KHR

-- --

Failure --

-- --

Parameters

-- --

device is the logical device.

-- --

pDeviceGroupPresentCapabilities is a pointer to a -- DeviceGroupPresentCapabilitiesKHR structure in which the -- device’s capabilities are returned.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device.

-- --

surface is the surface.
pModes is a pointer to a -- DeviceGroupPresentModeFlagsKHR in which the supported device -- group present modes for the surface are returned.

-- --

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

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

surface must be a valid SurfaceKHR -- handle
pModes must be a valid pointer to a -- DeviceGroupPresentModeFlagsKHR value
Both of device, and surface must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

pAcquireInfo is a pointer to a -- AcquireNextImageInfoKHR structure 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.

-- --

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 -- SurfaceCapabilitiesKHR::minImageCount as returned by a -- call to getPhysicalDeviceSurfaceCapabilities2KHR 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 Device handle

-- --

pAcquireInfo must be a valid pointer to a valid -- AcquireNextImageInfoKHR structure
pImageIndex must be a valid pointer to a -- uint32_t value

-- --

Return Codes

-- --

Success --

-- --

Failure --

-- --

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 Rect2D 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, INCOMPLETE will be returned instead -- of 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 -- PhysicalDevice handle

-- --

surface must be a valid SurfaceKHR -- 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 Rect2D -- structures
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 ImageUsageFlagBits -- 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 SHARING_MODE_CONCURRENT.
pQueueFamilyIndices is a pointer to an array of queue -- family indices having access to the images(s) of the swapchain when -- imageSharingMode is SHARING_MODE_CONCURRENT.
preTransform is a SurfaceTransformFlagBitsKHR -- 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 getPhysicalDeviceSurfaceCapabilitiesKHR, the -- presentation engine will transform the image content as part of the -- presentation operation.
compositeAlpha is a CompositeAlphaFlagBitsKHR -- 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 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. Fragment shaders may not -- execute for these pixels, and thus any side effects they would have -- had will not occur. TRUE value does not guarantee any clipping -- will occur, but allows more optimal presentation methods to be used on -- some platforms.
- If set to FALSE, presentable images -- associated with the swapchain will own all of the pixels they -- contain.

-- -- Note -- -- Applications should set this value to TRUE if they do -- not expect to read back the content of presentable images before -- presenting them or after reacquiring them, and if their fragment -- shaders do not have any side effects that require them to run for all -- pixels in the presentable image. -- --

oldSwapchain is 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 createSwapchainKHR with an oldSwapchain -- that is not 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 NULL_HANDLE. -- -- Upon calling createSwapchainKHR with an oldSwapchain -- that is not 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 -- SurfaceKHR through multiple uses of oldSwapchain that -- outnumber calls to destroySwapchainKHR. -- -- After oldSwapchain is retired, the application can -- pass to queuePresentKHR 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, queuePresentKHR may fail if -- oldSwapchain has entered a state that causes -- 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 ERROR_OUT_OF_DATE_KHR. -- --

Valid Usage

-- --

surface must be a surface that is supported by the -- device as determined using -- getPhysicalDeviceSurfaceSupportKHR

-- --

minImageCount must be less than or equal to the -- value returned in the maxImageCount member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface if the -- returned maxImageCount is not zero
If presentMode is not -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR nor -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, then -- minImageCount must be greater than or equal to the -- value returned in the minImageCount member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
minImageCount must be 1 if -- presentMode is either -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR
imageFormat and imageColorSpace must -- match the format and colorSpace members, -- respectively, of one of the SurfaceFormatKHR structures -- returned by getPhysicalDeviceSurfaceFormatsKHR for the -- surface
imageExtent must be between -- minImageExtent and maxImageExtent, inclusive, where -- minImageExtent and maxImageExtent are members of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR 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 SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
If presentMode is PRESENT_MODE_IMMEDIATE_KHR, -- PRESENT_MODE_MAILBOX_KHR, PRESENT_MODE_FIFO_KHR or -- PRESENT_MODE_FIFO_RELAXED_KHR, imageUsage must -- be a subset of the supported usage flags present in the -- supportedUsageFlags member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for -- surface
If presentMode is -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, imageUsage -- must be a subset of the supported usage flags present in the -- sharedPresentSupportedUsageFlags member of the -- SharedPresentSurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilities2KHR for -- surface
If imageSharingMode is SHARING_MODE_CONCURRENT, -- pQueueFamilyIndices must be a valid pointer to an -- array of queueFamilyIndexCount uint32_t values
If imageSharingMode is SHARING_MODE_CONCURRENT, -- queueFamilyIndexCount must be greater than -- 1
If imageSharingMode is SHARING_MODE_CONCURRENT, -- each element of pQueueFamilyIndices must be unique and -- must be less than pQueueFamilyPropertyCount returned -- by either getPhysicalDeviceQueueFamilyProperties or -- getPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
preTransform must be one of the bits present in -- the supportedTransforms member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
compositeAlpha must be one of the bits present in -- the supportedCompositeAlpha member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
presentMode must be one of the -- PresentModeKHR values returned by -- getPhysicalDeviceSurfacePresentModesKHR for the surface
If the logical device was created with -- DeviceGroupDeviceCreateInfo::physicalDeviceCount equal -- to 1, flags must not contain -- SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
If oldSwapchain is not NULL_HANDLE, -- oldSwapchain must be a non-retired swapchain -- associated with native window referred to by surface
The implied image creation parameters of the swapchain -- must be supported as reported by -- getPhysicalDeviceImageFormatProperties
If flags contains -- SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR then the pNext -- chain must include a ImageFormatListCreateInfo structure -- with a viewFormatCount greater than zero and -- pViewFormats must have an element equal to -- imageFormat
If flags contains -- SWAPCHAIN_CREATE_PROTECTED_BIT_KHR, then -- SurfaceProtectedCapabilitiesKHR::supportsProtected -- must be TRUE in the -- SurfaceProtectedCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilities2KHR for -- surface
If the pNext chain includes a -- SurfaceFullScreenExclusiveInfoEXT structure with its -- fullScreenExclusive member set to -- FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and -- surface was created using createWin32SurfaceKHR, a -- SurfaceFullScreenExclusiveWin32InfoEXT structure must be -- included in the pNext chain

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- DeviceGroupSwapchainCreateInfoKHR, -- ImageFormatListCreateInfo, -- SurfaceFullScreenExclusiveInfoEXT, -- SurfaceFullScreenExclusiveWin32InfoEXT, -- SwapchainCounterCreateInfoEXT, or -- SwapchainDisplayNativeHdrCreateInfoAMD
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- SwapchainCreateFlagBitsKHR values
surface must be a valid SurfaceKHR -- handle
imageFormat must be a valid Format -- value
imageColorSpace must be a valid -- ColorSpaceKHR value
imageUsage must be a valid combination of -- ImageUsageFlagBits values
imageUsage must not be 0
imageSharingMode must be a valid -- SharingMode value
preTransform must be a valid -- SurfaceTransformFlagBitsKHR value
compositeAlpha must be a valid -- CompositeAlphaFlagBitsKHR value
presentMode must be a valid PresentModeKHR -- value
If oldSwapchain is not NULL_HANDLE, -- oldSwapchain must be a valid SwapchainKHR -- 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 of non-ignored parameters must have been created, -- allocated, or retrieved from the same Instance

-- --

Description

-- -- Before an application can present an image, the image’s layout -- must be transitioned to the IMAGE_LAYOUT_PRESENT_SRC_KHR -- layout, or for a shared presentable image the -- IMAGE_LAYOUT_SHARED_PRESENT_KHR layout. -- -- Note -- -- When transitioning the image to IMAGE_LAYOUT_SHARED_PRESENT_KHR -- or IMAGE_LAYOUT_PRESENT_SRC_KHR, there is no need to delay -- subsequent processing, or perform any visibility operations (as -- queuePresentKHR performs automatic visibility operations). To -- achieve this, the dstAccessMask member of the -- ImageMemoryBarrier should be set to 0, and the -- dstStageMask parameter should be set to -- 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 -- IMAGE_LAYOUT_PRESENT_SRC_KHR or -- IMAGE_LAYOUT_SHARED_PRESENT_KHR layout at the time the -- operation is executed on a Device

-- --

All elements of the pWaitSemaphores must have a -- SemaphoreType of SEMAPHORE_TYPE_BINARY

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 DeviceGroupPresentInfoKHR, -- DisplayPresentInfoKHR, PresentFrameTokenGGP, -- PresentRegionsKHR, or PresentTimesInfoGOOGLE
The sType value of each struct in the pNext -- chain must be unique
If waitSemaphoreCount is not 0, -- pWaitSemaphores must be a valid pointer to an array of -- waitSemaphoreCount valid Semaphore handles
pSwapchains must be a valid pointer to an array of -- swapchainCount valid SwapchainKHR 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 -- Result values
swapchainCount must be greater than -- 0
Both of the elements of pSwapchains, and the elements of -- pWaitSemaphores that are valid handles of non-ignored -- parameters must have been created, allocated, or retrieved from -- the same Instance

-- --

sType must be -- STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR

-- --

swapchain must be a valid SwapchainKHR -- handle

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Description

-- -- If acquireNextImageKHR is used, the device mask is considered -- to include all physical devices in the logical device. -- -- Note -- -- acquireNextImage2KHR 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 NULL_HANDLE it must be -- unsignaled
If semaphore is not NULL_HANDLE it must not -- have any uncompleted signal or wait operations pending
If fence is not 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 NULL_HANDLE
deviceMask must be a valid device mask
deviceMask must not be zero
semaphore must have a SemaphoreType of -- SEMAPHORE_TYPE_BINARY

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR

-- --

pNext must be NULL
swapchain must be a valid SwapchainKHR -- handle
If semaphore is not NULL_HANDLE, -- semaphore must be a valid Semaphore handle
If fence is not NULL_HANDLE, fence -- must be a valid Fence handle
Each of fence, semaphore, and swapchain -- that are valid handles of non-ignored parameters must have been -- created, allocated, or retrieved from the same Instance

-- --

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 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 DeviceGroupPresentCapabilitiesKHR. -- -- If mode is 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 DeviceGroupPresentCapabilitiesKHR::presentMask. -- -- If mode is 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 -- DeviceGroupPresentCapabilitiesKHR::presentMask. -- -- If mode is -- 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 -- DeviceGroupPresentCapabilitiesKHR. -- -- If DeviceGroupPresentInfoKHR is not provided or -- swapchainCount is zero then the masks are considered to be -- 1. If DeviceGroupPresentInfoKHR is not provided, -- mode is considered to be -- DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR. -- --

Valid Usage

-- --

swapchainCount must equal 0 or -- PresentInfoKHR::swapchainCount

-- --

If mode is -- DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of -- pDeviceMasks must have exactly one bit set, and the -- corresponding element of -- DeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
If mode is -- 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 -- DeviceGroupPresentCapabilitiesKHR::presentMask
If mode is 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 -- DeviceGroupPresentCapabilitiesKHR::presentMask
If mode is -- DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then for -- each bit set in each element of pDeviceMasks, the -- corresponding element of -- DeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
The value of each element of pDeviceMasks must be -- equal to the device mask passed in -- AcquireNextImageInfoKHR::deviceMask when the image -- index was last acquired
mode must have exactly one bit set, and that bit -- must have been included in -- DeviceGroupSwapchainCreateInfoKHR::modes

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- DeviceGroupPresentModeFlagBitsKHR value

-- --

Description

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --

-- --

Parameters

-- --

device is the logical device.

-- --

pSurfaceInfo is a pointer to a -- PhysicalDeviceSurfaceInfo2KHR structure describing the surface -- and other fixed parameters that would be consumed by -- createSwapchainKHR.
pModes is a pointer to a -- DeviceGroupPresentModeFlagsKHR in which the supported device -- group present modes for the surface are returned.

-- --

Description

-- -- getDeviceGroupSurfacePresentModes2EXT behaves similarly to -- getDeviceGroupSurfacePresentModesKHR, with the ability to -- specify extended inputs via chained input structures. -- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to acquire exclusive -- full-screen access for.

-- --

Valid Usage

-- --

swapchain must not be in the retired state

-- --

swapchain must be a swapchain created with a -- SurfaceFullScreenExclusiveInfoEXT structure, with -- fullScreenExclusive set to -- FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT
swapchain must not currently have exclusive -- full-screen access

-- -- A return value of SUCCESS indicates that the swapchain -- successfully acquired exclusive full-screen access. The swapchain will -- retain this exclusivity until either the application releases -- exclusive full-screen access with -- releaseFullScreenExclusiveModeEXT, destroys the swapchain, or -- if any of the swapchain commands return -- ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT indicating that the -- mode was lost because of platform-specific changes. -- -- If the swapchain was unable to acquire exclusive full-screen access to -- the display then ERROR_INITIALIZATION_FAILED is returned. An -- application can attempt to acquire exclusive full-screen access -- again for the same swapchain even if this command fails, or if -- ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT has been returned by -- a swapchain command. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

swapchain must be a valid SwapchainKHR -- handle
Both of device, and swapchain must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

swapchain is the swapchain to release exclusive -- full-screen access from.

-- --

Description

Valid Usage

-- --

If the pNext chain includes a -- SurfaceFullScreenExclusiveInfoEXT structure with its -- fullScreenExclusive member set to -- FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and -- surface was created using createWin32SurfaceKHR, a -- SurfaceFullScreenExclusiveWin32InfoEXT structure must be -- included in the pNext chain

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_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 -- SurfaceFullScreenExclusiveInfoEXT or -- SurfaceFullScreenExclusiveWin32InfoEXT
The sType value of each struct in the pNext -- chain must be unique
surface must be a valid SurfaceKHR -- handle

-- --

Description

Parameters

-- --

device is the device to create the swapchains for.

-- --

swapchainCount is the number of swapchains to -- create.
pCreateInfos is a pointer to an array of -- SwapchainCreateInfoKHR structures specifying the parameters of -- the created swapchains.
pAllocator is the allocator used for host memory -- allocated for the swapchain objects when there is no more specific -- allocator available (see Memory Allocation).
pSwapchains is a pointer to an array of -- SwapchainKHR handles in which the created swapchain objects -- will be returned.

-- --

Description

-- -- createSharedSwapchainsKHR is similar to -- createSwapchainKHR, except that it takes an array of -- SwapchainCreateInfoKHR structures, and returns an array of -- swapchain objects. -- -- The swapchain creation parameters that affect the properties and -- number of presentable images must match between all the -- swapchains. If the displays used by any of the swapchains do not use -- the same presentable image layout or are incompatible in a way that -- prevents sharing images, swapchain creation will fail with the result -- code ERROR_INCOMPATIBLE_DISPLAY_KHR. If any error occurs, no -- swapchains will be created. Images presented to multiple swapchains -- must be re-acquired from all of them before transitioning away -- from IMAGE_LAYOUT_PRESENT_SRC_KHR. After destroying one or more -- of the swapchains, the remaining swapchains and the presentable images -- can continue to be used. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfos must be a valid pointer to an array -- of swapchainCount valid SwapchainCreateInfoKHR -- structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pSwapchains must be a valid pointer to an array of -- swapchainCount SwapchainKHR handles
swapchainCount must be greater than -- 0

-- --

Host Synchronization

-- --

Host access to pCreateInfos[].surface must be -- externally synchronized

-- --

Host access to pCreateInfos[].oldSwapchain must be -- externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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 -- DisplayPropertiesKHR structure returned by -- getPhysicalDeviceDisplayPropertiesKHR for the display the -- present operation targets then persistent must be -- FALSE

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR

-- --

Description

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 ImageUsageFlagBits -- 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 SHARING_MODE_CONCURRENT.
pQueueFamilyIndices is a pointer to an array of queue -- family indices having access to the images(s) of the swapchain when -- imageSharingMode is SHARING_MODE_CONCURRENT.
preTransform is a SurfaceTransformFlagBitsKHR -- 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 getPhysicalDeviceSurfaceCapabilitiesKHR, the -- presentation engine will transform the image content as part of the -- presentation operation.
compositeAlpha is a CompositeAlphaFlagBitsKHR -- 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 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. Fragment shaders may not -- execute for these pixels, and thus any side effects they would have -- had will not occur. TRUE value does not guarantee any clipping -- will occur, but allows more optimal presentation methods to be used on -- some platforms.
- If set to FALSE, presentable images -- associated with the swapchain will own all of the pixels they -- contain.

oldSwapchain is 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.

Valid Usage

-- --

surface must be a surface that is supported by the -- device as determined using -- getPhysicalDeviceSurfaceSupportKHR

-- --

minImageCount must be less than or equal to the -- value returned in the maxImageCount member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface if the -- returned maxImageCount is not zero
If presentMode is not -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR nor -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, then -- minImageCount must be greater than or equal to the -- value returned in the minImageCount member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
minImageCount must be 1 if -- presentMode is either -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR
imageFormat and imageColorSpace must -- match the format and colorSpace members, -- respectively, of one of the SurfaceFormatKHR structures -- returned by getPhysicalDeviceSurfaceFormatsKHR for the -- surface
imageExtent must be between -- minImageExtent and maxImageExtent, inclusive, where -- minImageExtent and maxImageExtent are members of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR 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 SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
If presentMode is PRESENT_MODE_IMMEDIATE_KHR, -- PRESENT_MODE_MAILBOX_KHR, PRESENT_MODE_FIFO_KHR or -- PRESENT_MODE_FIFO_RELAXED_KHR, imageUsage must -- be a subset of the supported usage flags present in the -- supportedUsageFlags member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for -- surface
If presentMode is -- PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or -- PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, imageUsage -- must be a subset of the supported usage flags present in the -- sharedPresentSupportedUsageFlags member of the -- SharedPresentSurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilities2KHR for -- surface
If imageSharingMode is SHARING_MODE_CONCURRENT, -- pQueueFamilyIndices must be a valid pointer to an -- array of queueFamilyIndexCount uint32_t values
If imageSharingMode is SHARING_MODE_CONCURRENT, -- queueFamilyIndexCount must be greater than -- 1
If imageSharingMode is SHARING_MODE_CONCURRENT, -- each element of pQueueFamilyIndices must be unique and -- must be less than pQueueFamilyPropertyCount returned -- by either getPhysicalDeviceQueueFamilyProperties or -- getPhysicalDeviceQueueFamilyProperties2 for the -- physicalDevice that was used to create device
preTransform must be one of the bits present in -- the supportedTransforms member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
compositeAlpha must be one of the bits present in -- the supportedCompositeAlpha member of the -- SurfaceCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilitiesKHR for the surface
presentMode must be one of the -- PresentModeKHR values returned by -- getPhysicalDeviceSurfacePresentModesKHR for the surface
If the logical device was created with -- DeviceGroupDeviceCreateInfo::physicalDeviceCount equal -- to 1, flags must not contain -- SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
If oldSwapchain is not NULL_HANDLE, -- oldSwapchain must be a non-retired swapchain -- associated with native window referred to by surface
The implied image creation parameters of the swapchain -- must be supported as reported by -- getPhysicalDeviceImageFormatProperties
If flags contains -- SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR then the pNext -- chain must include a ImageFormatListCreateInfo structure -- with a viewFormatCount greater than zero and -- pViewFormats must have an element equal to -- imageFormat
If flags contains -- SWAPCHAIN_CREATE_PROTECTED_BIT_KHR, then -- SurfaceProtectedCapabilitiesKHR::supportsProtected -- must be TRUE in the -- SurfaceProtectedCapabilitiesKHR structure returned by -- getPhysicalDeviceSurfaceCapabilities2KHR for -- surface
If the pNext chain includes a -- SurfaceFullScreenExclusiveInfoEXT structure with its -- fullScreenExclusive member set to -- FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, and -- surface was created using createWin32SurfaceKHR, a -- SurfaceFullScreenExclusiveWin32InfoEXT structure must be -- included in the pNext chain

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- DeviceGroupSwapchainCreateInfoKHR, -- ImageFormatListCreateInfo, -- SurfaceFullScreenExclusiveInfoEXT, -- SurfaceFullScreenExclusiveWin32InfoEXT, -- SwapchainCounterCreateInfoEXT, or -- SwapchainDisplayNativeHdrCreateInfoAMD
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- SwapchainCreateFlagBitsKHR values
surface must be a valid SurfaceKHR -- handle
imageFormat must be a valid Format -- value
imageColorSpace must be a valid -- ColorSpaceKHR value
imageUsage must be a valid combination of -- ImageUsageFlagBits values
imageUsage must not be 0
imageSharingMode must be a valid -- SharingMode value
preTransform must be a valid -- SurfaceTransformFlagBitsKHR value
compositeAlpha must be a valid -- CompositeAlphaFlagBitsKHR value
presentMode must be a valid PresentModeKHR -- value
If oldSwapchain is not NULL_HANDLE, -- oldSwapchain must be a valid SwapchainKHR -- 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 of non-ignored parameters must have been created, -- allocated, or retrieved from the same Instance

-- --

Description

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

Parameters

-- --

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

-- --

firstDiscardRectangle is the index of the first discard -- rectangle whose state is updated by the command.
discardRectangleCount is the number of discard rectangles -- whose state are updated by the command.
pDiscardRectangles is a pointer to an array of -- Rect2D structures specifying discard rectangles.

-- --

Description

-- -- The discard rectangle taken from element i of -- pDiscardRectangles replace the current state for the discard -- rectangle index firstDiscardRectangle + i, for i in [0, -- discardRectangleCount). -- --

Valid Usage

-- --

The sum of firstDiscardRectangle and -- discardRectangleCount must be less than or equal to -- PhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles

-- --

The x and y member of offset in each -- Rect2D element of pDiscardRectangles must be -- greater than or equal to 0
Evaluation of (offset.x + extent.width) in each -- Rect2D element of pDiscardRectangles must not -- cause a signed integer addition overflow
Evaluation of (offset.y + extent.height) in each -- Rect2D element of pDiscardRectangles must not -- cause a signed integer addition overflow

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pDiscardRectangles must be a valid pointer to an -- array of discardRectangleCount Rect2D structures
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- RenderPassCreateInfo2 structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pRenderPass must be a valid pointer to a -- RenderPass handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

commandBuffer is the command buffer in which to record -- the command.

-- --

pRenderPassBegin is a pointer to a -- RenderPassBeginInfo structure specifying the render pass to -- begin an instance of, and the framebuffer the instance uses.
pSubpassBeginInfo is a pointer to a -- SubpassBeginInfo structure containing information about the -- subpass which is about to begin rendering.

-- --

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

-- --

Both the framebuffer and renderPass members of -- pRenderPassBegin must have been created on the same -- Device that commandBuffer was allocated on

-- --

If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_COLOR_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL then the -- corresponding attachment image view of the framebuffer specified in -- the framebuffer member of pRenderPassBegin -- must have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the stencilInitialLayout or -- stencilFinalLayout member of the -- AttachmentDescriptionStencilLayout structures or the -- stencilLayout member of the -- AttachmentReferenceStencilLayout structures specified when -- creating the render pass specified in the renderPass member -- of pRenderPassBegin is -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_SAMPLED_BIT or -- IMAGE_USAGE_INPUT_ATTACHMENT_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_TRANSFER_SRC_BIT
If any of the initialLayout or finalLayout -- member of the AttachmentDescription structures or the -- layout member of the AttachmentReference structures -- specified when creating the render pass specified in the -- renderPass member of pRenderPassBegin is -- IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL then the corresponding -- attachment image view of the framebuffer specified in the -- framebuffer member of pRenderPassBegin must -- have been created with a usage value including -- IMAGE_USAGE_TRANSFER_DST_BIT
If any of the initialLayout members of the -- AttachmentDescription structures specified when creating the -- render pass specified in the renderPass member of -- pRenderPassBegin is not 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 -- RenderPassCreateInfo used to create renderPass -- must be supported by the capabilities of the queue family -- identified by the queueFamilyIndex member of the -- CommandPoolCreateInfo used to create the command pool which -- commandBuffer was allocated from
For any attachment in framebuffer that is used by -- renderPass and is bound to memory locations that are also -- bound to another attachment used by renderPass, and if at -- least one of those uses causes either attachment to be written to, -- both attachments must have had the -- ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT set

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pRenderPassBegin must be a valid pointer to a -- valid RenderPassBeginInfo structure
pSubpassBeginInfo must be a valid pointer to a -- valid SubpassBeginInfo structure
commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer in which to record -- the command.

-- --

pSubpassBeginInfo is a pointer to a -- SubpassBeginInfo structure containing information about the -- subpass which is about to begin rendering.
pSubpassEndInfo is a pointer to a SubpassEndInfo -- structure containing information about how the previous subpass will -- be ended.

-- --

Description

-- -- cmdNextSubpass2 is semantically identical to -- cmdNextSubpass, except that it is extensible, and that -- contents is provided as part of an extensible structure -- instead of as a flat parameter. -- --

Valid Usage

-- --

The current subpass index must be less than the number of -- subpasses in the render pass minus one

-- --

This command must not be recorded when transform feedback -- is active

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pSubpassBeginInfo must be a valid pointer to a -- valid SubpassBeginInfo structure
pSubpassEndInfo must be a valid pointer to a valid -- SubpassEndInfo structure
commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer in which to end the -- current render pass instance.

-- --

pSubpassEndInfo is a pointer to a SubpassEndInfo -- structure containing information about how the previous subpass will -- be ended.

-- --

Description

-- -- cmdEndRenderPass2 is semantically identical to -- cmdEndRenderPass, except that it is extensible. -- --

Valid Usage

-- --

The current subpass index must be equal to the number of -- subpasses in the render pass minus one

-- --

This command must not be recorded when transform feedback -- is active

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pSubpassEndInfo must be a valid pointer to a valid -- SubpassEndInfo structure
commandBuffer must be in the recording -- state
The CommandPool 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 -- CommandBuffer

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

sType must be -- STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2

-- --

flags must be a valid combination of -- AttachmentDescriptionFlagBits values
format must be a valid Format value
samples must be a valid SampleCountFlagBits -- value
loadOp must be a valid AttachmentLoadOp -- value
storeOp must be a valid AttachmentStoreOp -- value
stencilLoadOp must be a valid -- AttachmentLoadOp value
stencilStoreOp must be a valid -- AttachmentStoreOp value
initialLayout must be a valid ImageLayout -- value
finalLayout must be a valid ImageLayout -- value

-- --

Description

-- -- Parameters defined by this structure with the same name as those in -- AttachmentReference have the identical effect to those -- parameters. -- -- aspectMask is ignored when this structure is used to describe -- anything other than an input attachment reference. -- -- If the separateDepthStencilLayouts feature is enabled, and -- attachment has a depth/stencil format, layout -- can be set to a layout that only specifies the layout of the -- depth aspect. -- -- If layout only specifies the layout of the depth aspect of -- the attachment, the layout of the stencil aspect is specified by the -- stencilLayout member of a -- AttachmentReferenceStencilLayout structure included in the -- pNext chain. Otherwise, layout describes the layout -- for all relevant image aspects. -- --

Valid Usage

-- --

If attachment is not ATTACHMENT_UNUSED, -- layout must not be IMAGE_LAYOUT_UNDEFINED, -- IMAGE_LAYOUT_PREINITIALIZED, or -- IMAGE_LAYOUT_PRESENT_SRC_KHR

-- --

If attachment is not ATTACHMENT_UNUSED, and -- aspectMask does not include IMAGE_ASPECT_STENCIL_BIT -- or IMAGE_ASPECT_DEPTH_BIT, layout must not be -- IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If attachment is not ATTACHMENT_UNUSED, and -- aspectMask does not include IMAGE_ASPECT_COLOR_BIT, -- layout must not be -- IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
If the separateDepthStencilLayouts feature is not enabled, -- and attachment is not ATTACHMENT_UNUSED, -- layout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
If attachment is not ATTACHMENT_UNUSED, and -- aspectMask includes IMAGE_ASPECT_COLOR_BIT, -- layout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
If attachment is not ATTACHMENT_UNUSED, and -- aspectMask includes both IMAGE_ASPECT_DEPTH_BIT and -- IMAGE_ASPECT_STENCIL_BIT, and layout is -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain -- must include a AttachmentReferenceStencilLayout -- structure
If attachment is not ATTACHMENT_UNUSED, and -- aspectMask includes only IMAGE_ASPECT_DEPTH_BIT then -- layout must not be -- IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If attachment is not ATTACHMENT_UNUSED, and -- aspectMask includes only IMAGE_ASPECT_STENCIL_BIT then -- layout must not be -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2

-- --

layout must be a valid ImageLayout -- value

-- --

Description

-- -- Parameters defined by this structure with the same name as those in -- SubpassDescription have the identical effect to those -- parameters. -- -- viewMask has the same effect for the described subpass as -- RenderPassMultiviewCreateInfo::pViewMasks has on each -- corresponding subpass. -- --

Valid Usage

-- --

pipelineBindPoint must be -- PIPELINE_BIND_POINT_GRAPHICS

-- --

colorAttachmentCount must be less than or equal to -- PhysicalDeviceLimits::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 ATTACHMENT_LOAD_OP_CLEAR
If pResolveAttachments is not NULL, for each -- resolve attachment that does not have the value -- ATTACHMENT_UNUSED, the corresponding color attachment -- must not have the value ATTACHMENT_UNUSED
If pResolveAttachments is not NULL, for each -- resolve attachment that is not ATTACHMENT_UNUSED, the -- corresponding color attachment must not have a sample count of -- SAMPLE_COUNT_1_BIT
If pResolveAttachments is not NULL, each resolve -- attachment that is not ATTACHMENT_UNUSED must have a -- sample count of SAMPLE_COUNT_1_BIT
Any given element of pResolveAttachments must have -- the same Format as its corresponding color attachment
All attachments in pColorAttachments that are not -- ATTACHMENT_UNUSED must have the same sample count
All attachments in pInputAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain at least one of FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
All attachments in pColorAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
All attachments in pResolveAttachments that are not -- ATTACHMENT_UNUSED must have formats whose features -- contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
If pDepthStencilAttachment is not NULL and the -- attachment is not ATTACHMENT_UNUSED then it must have a -- format whose features contain -- FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
If the VK_AMD_mixed_attachment_samples extension is -- enabled, all attachments in pColorAttachments that are not -- ATTACHMENT_UNUSED must have a sample count that is -- smaller than or equal to the sample count of -- pDepthStencilAttachment if it is not -- ATTACHMENT_UNUSED
If neither the VK_AMD_mixed_attachment_samples nor the -- VK_NV_framebuffer_mixed_samples extensions are enabled, and -- if pDepthStencilAttachment is not ATTACHMENT_UNUSED -- and any attachments in pColorAttachments are not -- ATTACHMENT_UNUSED, they must have the same sample -- count
The attachment member of any element of -- pPreserveAttachments must not be -- ATTACHMENT_UNUSED
Any given element of pPreserveAttachments must not -- also be an element of any other member of the subpass description
If any attachment is used by more than one -- AttachmentReference member, then each use must use the -- same layout
If flags includes -- SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX, it -- must also include -- SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX
If the attachment member of any element of -- pInputAttachments is not ATTACHMENT_UNUSED, then the -- aspectMask member must be a valid combination of -- ImageAspectFlagBits
If the attachment member of any element of -- pInputAttachments is not ATTACHMENT_UNUSED, then the -- aspectMask member must not be 0
If the attachment member of any element of -- pInputAttachments is not ATTACHMENT_UNUSED, then the -- aspectMask member must not include -- IMAGE_ASPECT_METADATA_BIT

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2

-- --

flags must be a valid combination of -- SubpassDescriptionFlagBits values
pipelineBindPoint must be a valid -- PipelineBindPoint value
If inputAttachmentCount is not 0, -- pInputAttachments must be a valid pointer to an array -- of inputAttachmentCount valid AttachmentReference2 -- structures
If colorAttachmentCount is not 0, -- pColorAttachments must be a valid pointer to an array -- of colorAttachmentCount valid AttachmentReference2 -- structures
If colorAttachmentCount is not 0, and -- pResolveAttachments is not NULL, -- pResolveAttachments must be a valid pointer to an -- array of colorAttachmentCount valid -- AttachmentReference2 structures
If pDepthStencilAttachment is not NULL, -- pDepthStencilAttachment must be a valid pointer to a -- valid AttachmentReference2 structure
If preserveAttachmentCount is not 0, -- pPreserveAttachments must be a valid pointer to an -- array of preserveAttachmentCount uint32_t -- values

-- --

Description

-- -- Parameters defined by this structure with the same name as those in -- SubpassDependency have the identical effect to those -- parameters. -- -- viewOffset has the same effect for the described subpass -- dependency as -- RenderPassMultiviewCreateInfo::pViewOffsets has on -- each corresponding subpass dependency. -- --

Valid Usage

-- --

If the geometry shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT

-- --

If the geometry shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellation shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the tessellation shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or -- PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
srcSubpass must be less than or equal to -- dstSubpass, unless one of them is SUBPASS_EXTERNAL, to -- avoid cyclic dependencies and ensure a valid execution order
srcSubpass and dstSubpass must not both -- be equal to SUBPASS_EXTERNAL
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 -- DEPENDENCY_VIEW_LOCAL_BIT, srcSubpass must not -- be equal to SUBPASS_EXTERNAL
If dependencyFlags includes -- DEPENDENCY_VIEW_LOCAL_BIT, dstSubpass must not -- be equal to SUBPASS_EXTERNAL
If srcSubpass equals dstSubpass, and -- srcStageMask and dstStageMask both include a -- framebuffer-space stage, then dependencyFlags -- must include DEPENDENCY_BY_REGION_BIT
If viewOffset is not equal to 0, -- srcSubpass must not be equal to -- dstSubpass
If dependencyFlags does not include -- DEPENDENCY_VIEW_LOCAL_BIT, viewOffset must be -- 0
If viewOffset is not 0, srcSubpass -- must not be equal to dstSubpass
If the mesh shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- srcStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV
If the mesh shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_MESH_SHADER_BIT_NV
If the task shaders feature is not enabled, -- dstStageMask must not contain -- PIPELINE_STAGE_TASK_SHADER_BIT_NV

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2

-- --

srcStageMask must be a valid combination of -- PipelineStageFlagBits values
srcStageMask must not be 0
dstStageMask must be a valid combination of -- PipelineStageFlagBits values
dstStageMask must not be 0
srcAccessMask must be a valid combination of -- AccessFlagBits values
dstAccessMask must be a valid combination of -- AccessFlagBits values
dependencyFlags must be a valid combination of -- DependencyFlagBits values

-- --

Description

-- -- Parameters defined by this structure with the same name as those in -- RenderPassCreateInfo have the identical effect to those -- parameters; the child structures are variants of those used in -- RenderPassCreateInfo which add sType and -- pNext parameters, allowing them to be extended. -- -- If the SubpassDescription2::viewMask member of any -- element of pSubpasses is not zero, multiview -- functionality is considered to be enabled for this render pass. -- -- correlatedViewMaskCount and pCorrelatedViewMasks -- have the same effect as -- RenderPassMultiviewCreateInfo::correlationMaskCount -- and RenderPassMultiviewCreateInfo::pCorrelationMasks, -- respectively. -- --

Valid Usage

-- --

If any two subpasses operate on attachments with overlapping -- ranges of the same DeviceMemory object, and at least one -- subpass writes to that area of DeviceMemory, 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 given element of pSubpasses is bound to a range of a -- DeviceMemory object that overlaps with any other attachment in -- any subpass (including the same subpass), the -- AttachmentDescription2 structures describing them must -- include 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 given element of -- pSubpasses is not ATTACHMENT_UNUSED, it must be -- less than attachmentCount
For any member of pAttachments with a loadOp -- equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that -- attachment must not specify a layout equal to -- IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
For any member of pAttachments with a -- stencilLoadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the -- first use of that attachment must not specify a layout -- equal to IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, or -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
For any element of pDependencies, if the -- srcSubpass is not 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 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 destination -- subpass
The set of bits included in any element of -- pCorrelatedViewMasks must not overlap with the set of -- bits included in any other element of -- pCorrelatedViewMasks
If the SubpassDescription2::viewMask member of all -- elements of pSubpasses is 0, -- correlatedViewMaskCount must be 0
The SubpassDescription2::viewMask member of all -- elements of pSubpasses must either all be 0, -- or all not be 0
If the SubpassDescription2::viewMask member of all -- elements of pSubpasses is 0, the -- dependencyFlags member of any element of -- pDependencies must not include -- DEPENDENCY_VIEW_LOCAL_BIT
For any element of pDependencies where its -- srcSubpass member equals its dstSubpass member, if -- the viewMask member of the corresponding element of -- pSubpasses includes more than one bit, its -- dependencyFlags member must include -- DEPENDENCY_VIEW_LOCAL_BIT
The viewMask member must not have a bit set at an -- index greater than or equal to -- PhysicalDeviceLimits::maxFramebufferLayers
If the attachment member of any element of the -- pInputAttachments member of any element of -- pSubpasses is not ATTACHMENT_UNUSED, the -- aspectMask member of that element of -- pInputAttachments must only include aspects that are -- present in images of the format specified by the element of -- pAttachments specified by attachment
The srcSubpass member of each element of -- pDependencies must be less than -- subpassCount
The dstSubpass member of each element of -- pDependencies must be less than -- subpassCount

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2

-- --

pNext must be NULL or a pointer to a -- valid instance of -- RenderPassFragmentDensityMapCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- RenderPassCreateFlagBits values
If attachmentCount is not 0, -- pAttachments must be a valid pointer to an array of -- attachmentCount valid AttachmentDescription2 -- structures
pSubpasses must be a valid pointer to an array of -- subpassCount valid SubpassDescription2 structures
If dependencyCount is not 0, -- pDependencies must be a valid pointer to an array of -- dependencyCount valid SubpassDependency2 -- structures
If correlatedViewMaskCount is not 0, -- pCorrelatedViewMasks must be a valid pointer to an -- array of correlatedViewMaskCount uint32_t -- values
subpassCount must be greater than 0

-- --

Description

Members

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

Valid Usage (Implicit)

-- --

Description

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

Description

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

-- -- If deviceIndexCount is greater than zero, then on device -- index i the buffer is attached to the instance of memory on -- the physical device with device index pDeviceIndices[i]. -- -- If deviceIndexCount is zero and memory comes from a -- memory heap with the 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 memory. -- -- If deviceIndexCount is zero and memory comes from a -- memory heap without the 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

-- --

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

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 BindImageMemoryInfo includes a -- BindImageMemoryDeviceGroupInfo structure, then that structure -- determines how memory is bound to images across multiple devices in a -- device group. -- --

Description

-- -- The BindImageMemoryDeviceGroupInfo 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 -- Rect2D structures 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 -- 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 -- 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 -- (SparseImageFormatProperties::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 -- (SparseImageFormatProperties::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 -- 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 Rect2D -- structures

-- --

Description

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

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 -- PeerMemoryFeatureFlags bitmask indicating which types of memory -- accesses are supported for the combination of heap, local, and remote -- devices.

-- --

Valid Usage (Implicit)

-- --

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, except commands beginning a render pass instance, commands -- transitioning to the next subpass in the render pass instance, and -- commands ending a render pass instance, which always execute on the -- set of physical devices whose bit indices are included in the -- deviceMask member of the -- DeviceGroupRenderPassBeginInfo structure passed to the command -- beginning the corresponding render pass instance. -- --

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 -- DeviceGroupCommandBufferBeginInfo::deviceMask value -- when the command buffer began recording
If cmdSetDeviceMask is called inside a render pass -- instance, deviceMask must not include any set bits -- that were not in the -- DeviceGroupRenderPassBeginInfo::deviceMask value when -- the render pass instance began recording

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

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. cmdDispatch is -- equivalent to -- vkCmdDispatchBase(0,0,0,groupCountX,groupCountY,groupCountZ). -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
baseGroupX must be less than -- PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
baseGroupX must be less than -- PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
baseGroupZ must be less than -- PhysicalDeviceLimits::maxComputeWorkGroupCount[2]
groupCountX must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[0] -- minus baseGroupX
groupCountY must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[1] -- minus baseGroupY
groupCountZ must be less than or equal to -- PhysicalDeviceLimits::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 -- PIPELINE_CREATE_DISPATCH_BASE flag

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

sType must be -- STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO

-- --

flags must be a valid combination of -- MemoryAllocateFlagBits 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. In addition, commands transitioning to the next -- subpass in the render pass instance and commands ending the render -- pass instance, and, accordingly render pass attachment load, store, -- and resolve operations and subpass dependencies corresponding to the -- render pass instance, are executed on the physical devices included in -- the device mask provided here. -- -- If deviceRenderAreaCount is not zero, then the elements of -- pDeviceRenderAreas override the value of -- RenderPassBeginInfo::renderArea, and provide a render -- area specific to each physical device. These render areas serve the -- same purpose as RenderPassBeginInfo::renderArea, -- including controlling the region of attachments that are cleared by -- 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 -- DeviceGroupCommandBufferBeginInfo::deviceMask. If this -- structure is not present or if deviceRenderAreaCount is zero, -- RenderPassBeginInfo::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 -- STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO

-- --

If deviceRenderAreaCount is not 0, -- pDeviceRenderAreas must be a valid pointer to an array -- of deviceRenderAreaCount Rect2D structures

-- --

Description

-- --

sType must be -- 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 pointing 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 -- STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO

-- --

Description

-- --

PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT specifies that the -- created pipeline will not be optimized. Using this flag may -- reduce the time taken to create the pipeline.

-- --

PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT specifies that the -- pipeline to be created is allowed to be the parent of a pipeline that -- will be created in a subsequent pipeline creation call.
PIPELINE_CREATE_DERIVATIVE_BIT specifies that the pipeline -- to be created will be a child of a previously created parent -- pipeline.
PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT specifies -- that any shader input variables decorated as ViewIndex will -- be assigned values as if they were decorated as -- DeviceIndex.
PIPELINE_CREATE_DISPATCH_BASE specifies that a compute -- pipeline can be used with cmdDispatchBase with a -- non-zero base workgroup.
PIPELINE_CREATE_DEFER_COMPILE_BIT_NV specifies that a -- pipeline is created with all shaders in the deferred state. Before -- using the pipeline the application must call -- compileDeferredNV exactly once on each shader in the pipeline -- before using the pipeline.
PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR specifies that -- the shader compiler should capture statistics for the executables -- produced by the compile process which can later be retrieved by -- calling getPipelineExecutableStatisticsKHR. Enabling this flag -- must not affect the final compiled pipeline but may -- disable pipeline caching or otherwise affect pipeline creation -- time.
PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR -- specifies that the shader compiler should capture the internal -- representations of executables produced by the compile process which -- can later be retrieved by calling -- getPipelineExecutableInternalRepresentationsKHR. Enabling this -- flag must not affect the final compiled pipeline but may -- disable pipeline caching or otherwise affect pipeline creation -- time.
PIPELINE_CREATE_LIBRARY_BIT_KHR specifies that the pipeline -- cannot be used directly, and instead defines a pipeline -- library that can be combined with other pipelines using the -- PipelineLibraryCreateInfoKHR structure. This is available in -- raytracing pipelines.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR -- specifies that an any hit shader will always be present when an any -- hit shader would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR -- specifies that a closest hit shader will always be present when a -- closest hit shader would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR -- specifies that a miss shader will always be present when a miss shader -- would be executed.
PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR -- specifies that an intersection shader will always be present when an -- intersection shader would be executed.
PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR -- specifies that triangle primitives will be skipped during traversal -- using OpTraceKHR.
PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR specifies -- that AABB primitives will be skipped during traversal using -- OpTraceKHR.
PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV specifies that the -- pipeline can be used in combination with -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#device-generated-commands.
PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT -- specifies that pipeline creation will fail if a compile is required -- for creation of a valid Pipeline object; -- PIPELINE_COMPILE_REQUIRED_EXT will be returned by pipeline -- creation, and the Pipeline will be set to -- NULL_HANDLE.
When creating multiple pipelines, -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT specifies that -- control will be returned to the application on failure of the -- corresponding pipeline rather than continuing to create additional -- pipelines.

Description

Valid Usage (Implicit)

-- --

Description

Valid Usage

-- --

imageIndex must be less than the number of images -- in swapchain

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR

-- --

swapchain must be a valid SwapchainKHR -- handle

-- --

Host Synchronization

-- --

Host access to swapchain must be externally -- synchronized

-- --

Description

Valid Usage

-- --

swapchain must not be in the retired state

-- --

If semaphore is not NULL_HANDLE it must be -- unsignaled
If semaphore is not NULL_HANDLE it must not -- have any uncompleted signal or wait operations pending
If fence is not 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 NULL_HANDLE
deviceMask must be a valid device mask
deviceMask must not be zero
semaphore must have a SemaphoreType of -- SEMAPHORE_TYPE_BINARY

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR

-- --

pNext must be NULL
swapchain must be a valid SwapchainKHR -- handle
If semaphore is not NULL_HANDLE, -- semaphore must be a valid Semaphore handle
If fence is not NULL_HANDLE, fence -- must be a valid Fence handle
Each of fence, semaphore, and swapchain -- that are valid handles of non-ignored parameters must have been -- created, allocated, or retrieved from the same Instance

-- --

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

Valid Usage

-- --

swapchainCount must equal 0 or -- PresentInfoKHR::swapchainCount

-- --

If mode is -- DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of -- pDeviceMasks must have exactly one bit set, and the -- corresponding element of -- DeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
If mode is -- 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 -- DeviceGroupPresentCapabilitiesKHR::presentMask
If mode is 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 -- DeviceGroupPresentCapabilitiesKHR::presentMask
If mode is -- DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then for -- each bit set in each element of pDeviceMasks, the -- corresponding element of -- DeviceGroupPresentCapabilitiesKHR::presentMask -- must be non-zero
The value of each element of pDeviceMasks must be -- equal to the device mask passed in -- AcquireNextImageInfoKHR::deviceMask when the image -- index was last acquired
mode must have exactly one bit set, and that bit -- must have been included in -- DeviceGroupSwapchainCreateInfoKHR::modes

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- DeviceGroupPresentModeFlagBitsKHR value

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device.

-- --

surface is the surface.
pModes is a pointer to a -- DeviceGroupPresentModeFlagsKHR in which the supported device -- group present modes for the surface are returned.

-- --

Description

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

surface must be a valid SurfaceKHR -- handle
pModes must be a valid pointer to a -- DeviceGroupPresentModeFlagsKHR value
Both of device, and surface must have -- been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

Parameters

-- --

device is the device associated with -- swapchain.

-- --

pAcquireInfo is a pointer to a -- AcquireNextImageInfoKHR structure 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.

-- --

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 -- SurfaceCapabilitiesKHR::minImageCount as returned by a -- call to getPhysicalDeviceSurfaceCapabilities2KHR 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 Device handle

-- --

pAcquireInfo must be a valid pointer to a valid -- AcquireNextImageInfoKHR structure
pImageIndex must be a valid pointer to a -- uint32_t value

-- --

Return Codes

-- --

Success --

-- --

Failure --

-- --

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 Rect2D structures.

-- --

Description

Valid Usage (Implicit)

-- --

physicalDevice must be a valid -- PhysicalDevice handle

-- --

surface must be a valid SurfaceKHR -- 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 Rect2D -- structures
Both of physicalDevice, and surface must -- have been created, allocated, or retrieved from the same -- Instance

-- --

Host Synchronization

-- --

Host access to surface must be externally -- synchronized

-- --

Return Codes

-- --

Success --
- SUCCESS
- INCOMPLETE

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pipelineCache is either 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 a pointer to an array of -- GraphicsPipelineCreateInfo structures.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelines is a pointer to an array of Pipeline -- handles in which the resulting graphics pipeline objects are -- returned.

-- --

Description

-- -- The GraphicsPipelineCreateInfo structure includes an array of -- shader create info structures containing all the desired active shader -- stages, as well as creation info to define all relevant fixed-function -- stages, and a pipeline layout. -- --

Valid Usage

-- --

If the flags member of any element of -- pCreateInfos contains the -- 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 -- PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline -- must have been created with the -- PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
If pipelineCache was created with -- PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host -- access to pipelineCache must be externally -- synchronized

-- -- Note -- -- An implicit cache may be provided by the implementation or a layer. -- For this reason, it is still valid to set -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT on -- flags for any element of pCreateInfos while passing -- NULL_HANDLE for pipelineCache. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineCache is not NULL_HANDLE, -- pipelineCache must be a valid PipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid GraphicsPipelineCreateInfo -- structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelines must be a valid pointer to an array of -- createInfoCount Pipeline 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 --
- SUCCESS
- PIPELINE_COMPILE_REQUIRED_EXT

-- --

Failure --

-- --

Parameters

-- --

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

-- --

pipelineCache is either 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 a pointer to an array of -- ComputePipelineCreateInfo structures.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelines is a pointer to an array of Pipeline -- handles in which the resulting compute pipeline objects are -- returned.

-- --

Valid Usage

-- --

If the flags member of any element of -- pCreateInfos contains the -- 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 -- PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline -- must have been created with the -- PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
If pipelineCache was created with -- PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host -- access to pipelineCache must be externally -- synchronized

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineCache is not NULL_HANDLE, -- pipelineCache must be a valid PipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid ComputePipelineCreateInfo -- structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelines must be a valid pointer to an array of -- createInfoCount Pipeline 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 --
- SUCCESS
- PIPELINE_COMPILE_REQUIRED_EXT

-- --

Failure --

-- --

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.

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipeline is not NULL_HANDLE, pipeline -- must be a valid Pipeline handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --

If mapEntryCount is not 0, pMapEntries -- must be a valid pointer to an array of mapEntryCount -- valid SpecializationMapEntry structures

-- --

If dataSize is not 0, pData must -- be a valid pointer to an array of dataSize bytes

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- --

Valid Usage

-- --

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

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, basePipelineHandle -- must be NULL_HANDLE
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of stage must be -- 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 -- PhysicalDeviceLimits::maxPerStageResources
flags must not include -- PIPELINE_CREATE_LIBRARY_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
flags must not include -- PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
If the pipelineCreationCacheControl feature is not enabled, -- flags must not include -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_COMPUTE_PIPELINE_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 -- PipelineCompilerControlCreateInfoAMD or -- PipelineCreationFeedbackCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- PipelineCreateFlagBits values
stage must be a valid -- PipelineShaderStageCreateInfo structure
layout must be a valid PipelineLayout -- handle
Both of basePipelineHandle, and layout that are -- valid handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Device

-- --

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 PRIMITIVE_TOPOLOGY_POINT_LIST, -- PRIMITIVE_TOPOLOGY_LINE_LIST, -- PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, -- PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, -- PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY or -- PRIMITIVE_TOPOLOGY_PATCH_LIST, primitiveRestartEnable -- must be FALSE

-- --

If the geometry shaders feature is not enabled, -- topology must not be any of -- PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, -- PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY, -- PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY or -- PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY
If the tessellation shaders feature is not enabled, -- topology must not be -- PRIMITIVE_TOPOLOGY_PATCH_LIST

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO

-- --

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

-- --

Description

-- -- The application can also add a -- PipelineRasterizationStateRasterizationOrderAMD structure to -- the pNext chain of a -- PipelineRasterizationStateCreateInfo 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 FALSE

-- --

If the non-solid fill modes feature is not enabled, -- polygonMode must be POLYGON_MODE_FILL or -- POLYGON_MODE_FILL_RECTANGLE_NV
If the VK_NV_fill_rectangle extension is not enabled, -- polygonMode must not be -- POLYGON_MODE_FILL_RECTANGLE_NV

-- --

Valid Usage (Implicit)

-- --

sType must be -- 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 -- PipelineRasterizationConservativeStateCreateInfoEXT, -- PipelineRasterizationDepthClipStateCreateInfoEXT, -- PipelineRasterizationLineStateCreateInfoEXT, -- PipelineRasterizationStateRasterizationOrderAMD, or -- PipelineRasterizationStateStreamCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be 0
polygonMode must be a valid PolygonMode -- value
cullMode must be a valid combination of -- CullModeFlagBits values
frontFace must be a valid FrontFace -- value

-- --

Description

-- -- Each element of the pAttachments array is a -- PipelineColorBlendAttachmentState structure specifying -- per-target blending state for each individual color attachment. If the -- independent blending feature is not enabled on the device, all -- PipelineColorBlendAttachmentState 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 FALSE
If logicOpEnable is TRUE, logicOp -- must be a valid LogicOp value

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO

-- --

pNext must be NULL or a pointer to a -- valid instance of -- PipelineColorBlendAdvancedStateCreateInfoEXT
The sType value of each struct 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 -- PipelineColorBlendAttachmentState structures

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- -- If any shader stage fails to compile, the compile log will be reported -- back to the application, and ERROR_INVALID_SHADER_NV will be -- generated. -- --

Valid Usage

-- --

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

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, basePipelineHandle -- must be NULL_HANDLE
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of each element of pStages -- must be unique
The geometric shader stages provided in pStages -- must be either from the mesh shading pipeline (stage -- is SHADER_STAGE_TASK_BIT_NV or SHADER_STAGE_MESH_BIT_NV) -- or from the primitive shading pipeline (stage is -- SHADER_STAGE_VERTEX_BIT, -- SHADER_STAGE_TESSELLATION_CONTROL_BIT, -- SHADER_STAGE_TESSELLATION_EVALUATION_BIT, or -- SHADER_STAGE_GEOMETRY_BIT)
The stage member of one element of pStages -- must be either SHADER_STAGE_VERTEX_BIT or -- SHADER_STAGE_MESH_BIT_NV
The stage member of each element of pStages -- must not be 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 -- PipelineTessellationStateCreateInfo 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 -- PRIMITIVE_TOPOLOGY_PATCH_LIST
If the topology member of pInputAssembly is -- 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 -- 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 -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL in the -- AttachmentReference defined by subpass, the -- depthWriteEnable member of pDepthStencilState -- must be FALSE
If rasterization is not disabled and subpass uses a -- depth/stencil attachment in renderPass that has a layout of -- IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL or -- IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL in the -- AttachmentReference defined by subpass, the -- failOp, passOp and depthFailOp members of -- each of the front and back members of -- pDepthStencilState must be 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 FALSE if the attached image’s format features does -- not contain FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT
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 DYNAMIC_STATE_VIEWPORT, the -- pViewports member of pViewportState must be a -- valid pointer to an array of pViewportState->viewportCount -- valid Viewport structures
If no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_SCISSOR, the -- pScissors member of pViewportState must be a -- valid pointer to an array of pViewportState->scissorCount -- Rect2D structures
If the wide lines feature is not enabled, and no element of the -- pDynamicStates member of pDynamicState is -- DYNAMIC_STATE_LINE_WIDTH, the lineWidth member of -- pRasterizationState must be 1.0
If the rasterizerDiscardEnable member of -- pRasterizationState is FALSE, pViewportState -- must be a valid pointer to a valid -- PipelineViewportStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is FALSE, -- pMultisampleState must be a valid pointer to a valid -- PipelineMultisampleStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is FALSE, and subpass -- uses a depth/stencil attachment, pDepthStencilState -- must be a valid pointer to a valid -- PipelineDepthStencilStateCreateInfo structure
If the rasterizerDiscardEnable member of -- pRasterizationState is FALSE, and subpass -- uses color attachments, pColorBlendState must be a -- valid pointer to a valid PipelineColorBlendStateCreateInfo -- structure
If the depth bias clamping feature is not enabled, no element of -- the pDynamicStates member of pDynamicState is -- DYNAMIC_STATE_DEPTH_BIAS, and the depthBiasEnable -- member of pRasterizationState is TRUE, the -- depthBiasClamp member of pRasterizationState -- must be 0.0
If the VK_EXT_depth_range_unrestricted extension is not -- enabled and no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_DEPTH_BOUNDS, and the -- depthBoundsTestEnable member of pDepthStencilState -- is 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 DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, -- and the sampleLocationsEnable member of a -- PipelineSampleLocationsStateCreateInfoEXT structure included in -- the pNext chain of pMultisampleState is TRUE, -- sampleLocationsInfo.sampleLocationGridSize.width must -- evenly divide -- MultisamplePropertiesEXT::sampleLocationGridSize.width -- as returned by getPhysicalDeviceMultisamplePropertiesEXT with a -- samples parameter equaling rasterizationSamples
If no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, -- and the sampleLocationsEnable member of a -- PipelineSampleLocationsStateCreateInfoEXT structure included in -- the pNext chain of pMultisampleState is TRUE, -- sampleLocationsInfo.sampleLocationGridSize.height must -- evenly divide -- MultisamplePropertiesEXT::sampleLocationGridSize.height -- as returned by getPhysicalDeviceMultisamplePropertiesEXT with a -- samples parameter equaling rasterizationSamples
If no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT, -- and the sampleLocationsEnable member of a -- PipelineSampleLocationsStateCreateInfoEXT structure included in -- the pNext chain of pMultisampleState is TRUE, -- sampleLocationsInfo.sampleLocationsPerPixel must equal -- rasterizationSamples
If the sampleLocationsEnable member of a -- PipelineSampleLocationsStateCreateInfoEXT structure included in -- the pNext chain of pMultisampleState is TRUE, -- the fragment shader code must not statically use the extended -- instruction InterpolateAtSample
layout must be consistent with all shaders -- specified in pStages
If neither the VK_AMD_mixed_attachment_samples nor the -- VK_NV_framebuffer_mixed_samples extensions are enabled, and -- if subpass uses color and/or depth/stencil attachments, then -- the rasterizationSamples member of pMultisampleState -- must be the same as the sample count for those subpass -- attachments
If the VK_AMD_mixed_attachment_samples extension is -- enabled, and 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 the VK_NV_framebuffer_mixed_samples extension is -- enabled, and 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 the VK_NV_framebuffer_mixed_samples extension is -- enabled, and 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 the VK_NV_coverage_reduction_mode extension is -- enabled, the coverage reduction mode specified by -- PipelineCoverageReductionStateCreateInfoNV::coverageReductionMode, -- the rasterizationSamples member of pMultisampleState -- and the sample counts for the color and depth/stencil attachments (if -- the subpass has them) must be a valid combination returned by -- getPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV
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 -- PIPELINE_CREATE_DISPATCH_BASE flag
If pStages includes a fragment shader stage and an input -- attachment was referenced by an aspectMask at -- renderPass creation time, its shader code must only -- read from the aspects that were specified for that input -- attachment
The number of resources in layout accessible to each -- shader stage that is used by the pipeline must be less than or -- equal to -- PhysicalDeviceLimits::maxPerStageResources
If no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_VIEWPORT_W_SCALING_NV, -- and the viewportWScalingEnable member of a -- PipelineViewportWScalingStateCreateInfoNV structure, included -- in the pNext chain of pViewportState, is -- TRUE, the pViewportWScalings member of the -- PipelineViewportWScalingStateCreateInfoNV must be a -- pointer to an array of -- PipelineViewportWScalingStateCreateInfoNV::viewportCount -- valid ViewportWScalingNV structures
If pStages includes a vertex shader stage, -- pVertexInputState must be a valid pointer to a valid -- PipelineVertexInputStateCreateInfo structure
If pStages includes a vertex shader stage, -- pInputAssemblyState must be a valid pointer to a valid -- PipelineInputAssemblyStateCreateInfo structure
The Xfb execution mode can be specified by only -- one shader stage in pStages
If any shader stage in pStages specifies Xfb -- execution mode it must be the last vertex processing stage
If a -- PipelineRasterizationStateStreamCreateInfoEXT::rasterizationStream -- value other than zero is specified, all variables in the output -- interface of the entry point being compiled decorated with -- Position, PointSize, ClipDistance, or -- CullDistance must all be decorated with identical -- Stream values that match the -- rasterizationStream
If -- PipelineRasterizationStateStreamCreateInfoEXT::rasterizationStream -- is zero, or not specified, all variables in the output interface of -- the entry point being compiled decorated with Position, -- PointSize, ClipDistance, or CullDistance -- must all be decorated with a Stream value of zero, or -- must not specify the Stream decoration
If the last vertex processing stage is a geometry shader, and that -- geometry shader uses the GeometryStreams capability, then -- PhysicalDeviceTransformFeedbackFeaturesEXT::geometryStreams -- feature must be enabled
If there are any mesh shader stages in the pipeline there -- must not be any shader stage in the pipeline with a -- Xfb execution mode
If the lineRasterizationMode member of a -- PipelineRasterizationLineStateCreateInfoEXT structure included -- in the pNext chain of pRasterizationState is -- LINE_RASTERIZATION_MODE_BRESENHAM_EXT or -- LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT and if -- rasterization is enabled, then the alphaToCoverageEnable, -- alphaToOneEnable, and sampleShadingEnable members of -- pMultisampleState must all be FALSE
If the stippledLineEnable member of -- PipelineRasterizationLineStateCreateInfoEXT is TRUE and -- no element of the pDynamicStates member of -- pDynamicState is DYNAMIC_STATE_LINE_STIPPLE_EXT, then -- the lineStippleFactor member of -- PipelineRasterizationLineStateCreateInfoEXT must be in -- the range [1,256]
flags must not include -- PIPELINE_CREATE_LIBRARY_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
If flags includes -- PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV, then the -- ::deviceGeneratedCommands feature must be enabled
If flags includes -- PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV, then all stages -- must not specify Xfb execution mode
If the pipelineCreationCacheControl feature is not enabled, -- flags must not include -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_GRAPHICS_PIPELINE_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 -- GraphicsPipelineShaderGroupsCreateInfoNV, -- PipelineCompilerControlCreateInfoAMD, -- PipelineCreationFeedbackCreateInfoEXT, -- PipelineDiscardRectangleStateCreateInfoEXT, or -- PipelineRepresentativeFragmentTestStateCreateInfoNV
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- PipelineCreateFlagBits values
pStages must be a valid pointer to an array of -- stageCount valid PipelineShaderStageCreateInfo -- structures
pRasterizationState must be a valid pointer to a -- valid PipelineRasterizationStateCreateInfo structure
If pDynamicState is not NULL, -- pDynamicState must be a valid pointer to a valid -- PipelineDynamicStateCreateInfo structure
layout must be a valid PipelineLayout -- handle
renderPass must be a valid RenderPass -- handle
stageCount must be greater than 0
Each of basePipelineHandle, layout, and -- renderPass that are valid handles of non-ignored parameters -- must have been created, allocated, or retrieved from the same -- Device

-- --

Parameters

-- --

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

-- --

isPreprocessed represents whether the input data has -- already been preprocessed on the device. If it is FALSE this -- command will implicitly trigger the preprocessing step, otherwise -- not.
pGeneratedCommandsInfo is a pointer to an instance of the -- GeneratedCommandsInfoNV structure containing parameters -- affecting the generation of commands.

-- --

Valid Usage

-- --

[[VUID-{refpage}-None-02690]] If a ImageView is sampled -- with FILTER_LINEAR as a result of this command, then the image -- view’s format features must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

[[VUID-{refpage}-None-02691]] If a ImageView is accessed -- using atomic operations as a result of this command, then the image -- view’s format features must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
[[VUID-{refpage}-None-02692]] If a ImageView is sampled -- with FILTER_CUBIC_EXT as a result of this command, then the -- image view’s format features must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
[[VUID-{refpage}-filterCubic-02694]] Any ImageView being -- sampled with FILTER_CUBIC_EXT as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
[[VUID-{refpage}-filterCubicMinmax-02695]] Any ImageView -- being sampled with FILTER_CUBIC_EXT with a reduction mode of -- either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
[[VUID-{refpage}-flags-02696]] Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
[[VUID-{refpage}-None-02697]] For each set n that is -- statically used by the Pipeline bound to the pipeline bind -- point used by this command, a descriptor set must have been -- bound to n at the same pipeline bind point, with a -- PipelineLayout that is compatible for set n, with the -- PipelineLayout used to create the current Pipeline, as -- described in ???
[[VUID-{refpage}-None-02698]] For each push constant that is -- statically used by the Pipeline bound to the pipeline bind -- point used by this command, a push constant value must have -- been set for the same pipeline bind point, with a -- PipelineLayout that is compatible for push constants, with the -- PipelineLayout used to create the current Pipeline, as -- described in ???
[[VUID-{refpage}-None-02699]] Descriptors in each bound descriptor -- set, specified via cmdBindDescriptorSets, must be valid -- if they are statically used by the Pipeline bound to the -- pipeline bind point used by this command
[[VUID-{refpage}-None-02700]] A valid pipeline must be -- bound to the pipeline bind point used by this command
[[VUID-{refpage}-commandBuffer-02701]] If the Pipeline -- object bound to the pipeline bind point used by this command requires -- any dynamic state, that state must have been set for -- commandBuffer, and done so after any previously bound -- pipeline with the corresponding state not specified as dynamic
[[VUID-{refpage}-None-02859]] There must not have been any -- calls to dynamic state setting commands for any state not specified as -- dynamic in the Pipeline object bound to the pipeline bind point -- used by this command, since that pipeline was bound
[[VUID-{refpage}-None-02702]] If the Pipeline object bound -- to the pipeline bind point used by this command accesses a -- Sampler object that uses unnormalized coordinates, that sampler -- must not be used to sample from any Image with a -- ImageView of the type IMAGE_VIEW_TYPE_3D, -- IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, -- IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, -- in any shader stage
[[VUID-{refpage}-None-02703]] If the Pipeline object bound -- to the pipeline bind point used by this command accesses a -- Sampler object that uses unnormalized coordinates, that sampler -- 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
[[VUID-{refpage}-None-02704]] If the Pipeline object bound -- to the pipeline bind point used by this command accesses a -- Sampler object that uses unnormalized coordinates, that sampler -- 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
[[VUID-{refpage}-None-02705]] If the robust buffer access -- feature is not enabled, and if the Pipeline object bound to the -- pipeline bind point used by this command accesses a uniform buffer, it -- must not access values outside of the range of the buffer as -- specified in the descriptor set bound to the same pipeline bind -- point
[[VUID-{refpage}-None-02706]] If the robust buffer access -- feature is not enabled, and if the Pipeline object bound to the -- pipeline bind point used by this command accesses a storage buffer, it -- must not access values outside of the range of the buffer as -- specified in the descriptor set bound to the same pipeline bind -- point
[[VUID-{refpage}-commandBuffer-02707]] If commandBuffer -- is an unprotected command buffer, any resource accessed by the -- Pipeline object bound to the pipeline bind point used by this -- command must not be a protected resource
[[VUID-{refpage}-renderPass-02684]] The current render pass -- must be compatible with the renderPass member -- of the GraphicsPipelineCreateInfo structure specified when -- creating the Pipeline bound to -- PIPELINE_BIND_POINT_GRAPHICS
[[VUID-{refpage}-subpass-02685]] The subpass index of the current -- render pass must be equal to the subpass member of the -- GraphicsPipelineCreateInfo structure specified when creating -- the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
[[VUID-{refpage}-None-02686]] Every input attachment used by the -- current subpass must be bound to the pipeline via a descriptor -- set
[[VUID-{refpage}-None-02687]] 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
[[VUID-{refpage}-maxMultiviewInstanceIndex-02688]] If the draw is -- recorded in a render pass instance with multiview enabled, the maximum -- instance index must be less than or equal to -- PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
[[VUID-{refpage}-sampleLocationsEnable-02689]] If the bound -- graphics pipeline was created with -- PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable -- set to TRUE and the current subpass has a depth/stencil -- attachment, then that attachment must have been created with -- the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit -- set
[[VUID-{refpage}-None-04007]] All vertex input bindings accessed -- via vertex input variables declared in the vertex shader entry point’s -- interface must have either valid or NULL_HANDLE buffers -- bound
[[VUID-{refpage}-None-04008]] If the nullDescriptor feature -- is not enabled, all vertex input bindings accessed via vertex input -- variables declared in the vertex shader entry point’s interface -- must not be NULL_HANDLE
[[VUID-{refpage}-None-02721]] For a given vertex buffer binding, -- any attribute data fetched must be entirely contained within -- the corresponding vertex buffer binding, as described in -- ???
commandBuffer must not be a protected command -- buffer
If isPreprocessed is TRUE then -- cmdPreprocessGeneratedCommandsNV must have already been -- executed on the device, using the same pGeneratedCommandsInfo -- content as well as the content of the input buffers it references (all -- except GeneratedCommandsInfoNV::preprocessBuffer). -- Furthermore pGeneratedCommandsInfo`s -- indirectCommandsLayout must have been created with the -- INDIRECT_COMMANDS_LAYOUT_USAGE_EXPLICIT_PREPROCESS_BIT_NV bit -- set
GeneratedCommandsInfoNV::pipeline must -- match the current bound pipeline at -- GeneratedCommandsInfoNV::pipelineBindPoint
Transform feedback must not be active
The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pGeneratedCommandsInfo must be a valid pointer to -- a valid GeneratedCommandsInfoNV structure
commandBuffer must be in the recording -- state
The CommandPool 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer which does the -- preprocessing.

-- --

pGeneratedCommandsInfo is a pointer to an instance of the -- GeneratedCommandsInfoNV structure containing parameters -- affecting the preprocessing step.

-- --

Valid Usage

-- --

commandBuffer must not be a protected command -- buffer

-- --

pGeneratedCommandsInfo`s indirectCommandsLayout -- must have been created with the -- INDIRECT_COMMANDS_LAYOUT_USAGE_EXPLICIT_PREPROCESS_BIT_NV bit -- set
The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pGeneratedCommandsInfo must be a valid pointer to -- a valid GeneratedCommandsInfoNV structure
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support graphics, or 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 CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

commandBuffer is the command buffer that the pipeline -- will be bound to.

-- --

pipelineBindPoint is a PipelineBindPoint value -- specifying to which bind point the pipeline is bound.
pipeline is the pipeline to be bound.
groupIndex is the shader group to be bound.

-- --

Valid Usage

-- --

groupIndex must be 0 or less than the -- effective -- GraphicsPipelineShaderGroupsCreateInfoNV::groupCount -- including the referenced pipelines

-- --

The pipelineBindPoint must be -- PIPELINE_BIND_POINT_GRAPHICS
The same restrictions as cmdBindPipeline apply as if the -- bound pipeline was created only with the Shader Group from the -- groupIndex information
The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pipelineBindPoint must be a valid -- PipelineBindPoint value
pipeline must be a valid Pipeline -- handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the logical device that owns the buffer.

-- --

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

-- --

Valid Usage

-- --

The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- GeneratedCommandsMemoryRequirementsInfoNV structure
pMemoryRequirements must be a valid pointer to a -- MemoryRequirements2 structure

-- --

Parameters

-- --

device is the logical device that creates the indirect -- command layout.

-- --

pCreateInfo is a pointer to an instance of the -- IndirectCommandsLayoutCreateInfoNV 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 -- IndirectCommandsLayoutNV handle in which the resulting indirect -- command layout is returned.

-- --

Valid Usage

-- --

The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- IndirectCommandsLayoutCreateInfoNV structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pIndirectCommandsLayout must be a valid pointer to -- a IndirectCommandsLayoutNV handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage

-- --

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

-- --

If AllocationCallbacks were provided when -- indirectCommandsLayout was created, a compatible set of -- callbacks must be provided here
If no AllocationCallbacks were provided when -- indirectCommandsLayout was created, pAllocator -- must be NULL
The ::deviceGeneratedCommands feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

indirectCommandsLayout must be a valid -- IndirectCommandsLayoutNV handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
indirectCommandsLayout must have been created, -- allocated, or retrieved from device

-- --

sType must be -- STRUCTURE_TYPE_GRAPHICS_PIPELINE_SHADER_GROUPS_CREATE_INFO_NV

-- --

pGroups must be a valid pointer to an array of -- groupCount valid GraphicsShaderGroupCreateInfoNV -- structures
If pipelineCount is not 0, pPipelines -- must be a valid pointer to an array of pipelineCount -- valid Pipeline handles
groupCount must be greater than 0

-- --

Description

-- -- The following code illustrates some of the flags: -- --

--   void cmdProcessAllSequences(cmd, pipeline, indirectCommandsLayout, pIndirectCommandsTokens, sequencesCount, indexbuffer, indexbufferOffset)
--   {
--     for (s = 0; s < sequencesCount; s++)
--     {
--       sUsed = s;
--   
--       if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_INDEXED_SEQUENCES_BIT_NV) {
--         sUsed = indexbuffer.load_uint32( sUsed * sizeof(uint32_t) + indexbufferOffset);
--       }
--   
--       if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_NV) {
--         sUsed = incoherent_implementation_dependent_permutation[ sUsed ];
--       }
--   
--       cmdProcessSequence( cmd, pipeline, indirectCommandsLayout, pIndirectCommandsTokens, sUsed );
--     }
--   }
--

-- --

Valid Usage

-- --

The pipelineBindPoint must be -- PIPELINE_BIND_POINT_GRAPHICS

-- --

tokenCount must be greater than 0 and -- less than or equal to -- PhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsTokenCount
If pTokens contains an entry of -- INDIRECT_COMMANDS_TOKEN_TYPE_SHADER_GROUP_NV it must be -- the first element of the array and there must be only a single -- element of such token type
If pTokens contains an entry of -- INDIRECT_COMMANDS_TOKEN_TYPE_STATE_FLAGS_NV there must -- be only a single element of such token type
All state tokens in pTokens must occur prior work -- provoking tokens (INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NV, -- INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NV, -- INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_TASKS_NV)
The content of pTokens must include one single -- work provoking token that is compatible with the -- pipelineBindPoint
streamCount must be greater than 0 and -- less or equal to -- PhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsStreamCount
each element of pStreamStrides must be greater -- than `0`and less than or equal to -- PhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsStreamStride. -- Furthermore the alignment of each token input must be -- ensured

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NV

-- --

pNext must be NULL
flags must be a valid combination of -- IndirectCommandsLayoutUsageFlagBitsNV values
flags must not be 0
pipelineBindPoint must be a valid -- PipelineBindPoint value
pTokens must be a valid pointer to an array of -- tokenCount valid IndirectCommandsLayoutTokenNV -- structures
pStreamStrides must be a valid pointer to an array -- of streamCount uint32_t values
tokenCount must be greater than 0
streamCount must be greater than 0

-- --

Description

-- -- ' -- -- TODO: table -- -- Supported indirect command tokens -- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

accelerationStructure must be a valid -- AccelerationStructureKHR handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
accelerationStructure must have been created, -- allocated, or retrieved from device

-- --

Parameters

-- --

device is the logical device on which the acceleration -- structure was created.

-- --

pInfo specifies the acceleration structure to get memory -- requirements for.
pMemoryRequirements returns the requested acceleration -- structure memory requirements.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

device is the logical device that owns the acceleration -- structures and memory.

-- --

bindInfoCount is the number of elements in -- pBindInfos.
pBindInfos is a pointer to an array of -- BindAccelerationStructureMemoryInfoKHR structures describing -- acceleration structures and memory to bind.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pInfo is a pointer to a -- CopyAccelerationStructureInfoKHR structure defining the copy -- operation.

-- --

Valid Usage

-- --

All AccelerationStructureKHR objects referenced by this -- command must be bound to device memory

-- --

The DeferredOperationInfoKHR structure must not be -- included in the pNext chain of the -- CopyAccelerationStructureInfoKHR structure

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfo must be a valid pointer to a valid -- CopyAccelerationStructureInfoKHR structure
commandBuffer must be in the recording -- state
The CommandPool 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 the CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

All AccelerationStructureKHR objects referenced by this -- command must be bound to host-visible memory

-- --

the ::rayTracingHostAccelerationStructureCommands feature -- must be enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- CopyAccelerationStructureInfoKHR structure

-- --

Return Codes

-- --

Success --

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- -- This command produces the same results as -- copyAccelerationStructureToMemoryKHR, but writes its result to -- a device address, and is executed on the device rather than the host. -- The output may not necessarily be bit-for-bit identical, but it -- can be equally used by either -- cmdCopyMemoryToAccelerationStructureKHR or -- copyMemoryToAccelerationStructureKHR. -- --

Description

-- --

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

-- --

pInfo is an a pointer to a -- CopyAccelerationStructureToMemoryInfoKHR structure defining the -- copy operation.

-- -- The defined header structure for the serialized data consists of: -- --

UUID_SIZE bytes of data matching -- PhysicalDeviceIDProperties::driverUUID
UUID_SIZE bytes of data identifying the compatibility for -- comparison using -- getDeviceAccelerationStructureCompatibilityKHR
A 64-bit integer of the total size matching the value queried -- using -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
A 64-bit integer of the deserialized size to be passed in to -- AccelerationStructureCreateInfoKHR::compactedSize
A 64-bit integer of the count of the number of acceleration -- structure handles following. This will be zero for a bottom-level -- acceleration structure.

-- -- The corresponding handles matching the values returned by -- getAccelerationStructureDeviceAddressKHR or -- getAccelerationStructureHandleNV are tightly packed in the -- buffer following the count. The application is expected to store a -- mapping between those handles and the original application-generated -- bottom-level acceleration structures to provide when deserializing. -- --

Valid Usage

-- --

All DeviceOrHostAddressConstKHR referenced by this command -- must contain valid device addresses

-- --

All AccelerationStructureKHR objects referenced by this -- command must be bound to device memory
The DeferredOperationInfoKHR structure must not be -- included in the pNext chain of the -- CopyAccelerationStructureToMemoryInfoKHR structure
[[VUID-{refpage}-mode-03412]] mode must be -- COPY_ACCELERATION_STRUCTURE_MODE_SERIALIZE_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfo must be a valid pointer to a valid -- CopyAccelerationStructureToMemoryInfoKHR structure
commandBuffer must be in the recording -- state
The CommandPool 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 the CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- CopyAccelerationStructureToMemoryInfoKHR structure

-- --

Return Codes

-- --

Success --

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- -- This command can accept acceleration structures produced by either -- cmdCopyAccelerationStructureToMemoryKHR or -- copyAccelerationStructureToMemoryKHR. -- --

Description

-- --

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

-- --

pInfo is a pointer to a -- CopyMemoryToAccelerationStructureInfoKHR structure defining the -- copy operation.

-- -- The structure provided as input to deserialize is as described in -- cmdCopyAccelerationStructureToMemoryKHR, with any acceleration -- structure handles filled in with the newly-queried handles to bottom -- level acceleration structures created before deserialization. These do -- not need to be built at deserialize time, but must be created. -- --

Valid Usage

-- --

All DeviceOrHostAddressKHR referenced by this command -- must contain valid device addresses

-- --

All AccelerationStructureKHR objects referenced by this -- command must be bound to device memory
The DeferredOperationInfoKHR structure must not be -- included in the pNext chain of the -- CopyMemoryToAccelerationStructureInfoKHR structure
[[VUID-{refpage}-mode-03413]] mode must be -- COPY_ACCELERATION_STRUCTURE_MODE_DESERIALIZE_KHR
[[VUID-{refpage}-pInfo-03414]] The data in pInfo->src -- must have a format compatible with the destination physical -- device as returned by -- getDeviceAccelerationStructureCompatibilityKHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfo must be a valid pointer to a valid -- CopyMemoryToAccelerationStructureInfoKHR structure
commandBuffer must be in the recording -- state
The CommandPool 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 the CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- CopyMemoryToAccelerationStructureInfoKHR structure

-- --

Return Codes

-- --

Success --

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

accelerationStructureCount is the count of acceleration -- structures for which to query the property.
pAccelerationStructures is a pointer to an array of -- existing previously built acceleration structures.
queryType is a QueryType value specifying the type -- of queries managed by the pool.
queryPool is the query pool that will manage the results -- of the query.
firstQuery is the first query index within the query pool -- that will contain the accelerationStructureCount number of -- results.

-- --

Valid Usage

-- --

queryPool must have been created with a -- queryType matching queryType

-- --

The queries identified by queryPool and -- firstQuery must be unavailable
[[VUID-{refpage}-accelerationStructures-03431]] All acceleration -- structures in accelerationStructures must have been -- built with -- BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if -- queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
[[VUID-{refpage}-queryType-03432]] queryType must -- be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pAccelerationStructures must be a valid pointer to -- an array of accelerationStructureCount valid -- AccelerationStructureKHR handles
queryType must be a valid QueryType -- value
queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
accelerationStructureCount must be greater than -- 0
Each of commandBuffer, queryPool, and the -- elements of pAccelerationStructures must have been -- created, allocated, or retrieved from the same Device

-- --

Host Synchronization

-- --

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

-- --

If queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then -- stride must be a multiple of the size of -- DeviceSize

-- --

If queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR, then -- data must point to a DeviceSize
If queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then -- stride must be a multiple of the size of -- DeviceSize
If queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR, then -- data must point to a DeviceSize
dataSize must be greater than or equal to -- accelerationStructureCount*stride
The acceleration structures referenced by -- pAccelerationStructures must be bound to host-visible -- memory
[[VUID-{refpage}-accelerationStructures-03431]] All acceleration -- structures in accelerationStructures must have been -- built with -- BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if -- queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
[[VUID-{refpage}-queryType-03432]] queryType must -- be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR
the ::rayTracingHostAccelerationStructureCommands feature -- must be enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pAccelerationStructures must be a valid pointer to -- an array of accelerationStructureCount valid -- AccelerationStructureKHR handles
queryType must be a valid QueryType -- value
pData must be a valid pointer to an array of -- dataSize bytes
accelerationStructureCount must be greater than -- 0
dataSize must be greater than 0
Each element of pAccelerationStructures must have -- been created, allocated, or retrieved from device

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

pRaygenShaderBindingTable is the strided buffer range -- that holds the shader binding table data for the ray generation shader -- stage.
pMissShaderBindingTable is the strided buffer range that -- holds the shader binding table data for the miss shader stage.
pHitShaderBindingTable is the strided buffer range that -- holds the shader binding table data for the hit shader stage.
pCallableShaderBindingTable is the strided buffer range -- that holds the shader binding table data for the callable shader -- stage.
width is the width of the ray trace query -- dimensions.
height is height of the ray trace query dimensions.
depth is depth of the ray trace query dimensions.

-- --

Description

-- -- When the command is executed, a ray generation group of width -- × height × depth rays is assembled. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
raygenShaderBindingOffset must be less than the -- size of raygenShaderBindingTableBuffer
raygenShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingOffset must be less than the size -- of missShaderBindingTableBuffer
missShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
hitShaderBindingOffset must be less than the size -- of hitShaderBindingTableBuffer
hitShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
callableShaderBindingOffset must be less than the -- size of callableShaderBindingTableBuffer
callableShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
hitShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
callableShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
missShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
hitShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
callableShaderBindingStride must be less than or -- equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
Any shader group handle referenced by this call must have -- been queried from the currently bound ray tracing shader pipeline
This command must not cause a shader call instruction to be -- executed from a shader invocation with a recursion depth -- greater than the value of maxRecursionDepth used to create -- the bound ray tracing pipeline
If commandBuffer is a protected command buffer, any -- resource written to by the Pipeline object bound to the -- pipeline bind point used by this command must not be an -- unprotected resource
If commandBuffer is a protected command buffer, pipeline -- stages other than the framebuffer-space and compute stages in the -- Pipeline object bound to the pipeline bind point must -- not write to any resource
width must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
height must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
depth must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[2]
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, -- the buffer member of hitShaderBindingTable -- must not be NULL_HANDLE
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, -- the buffer member of hitShaderBindingTable -- must not be NULL_HANDLE
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, -- the buffer member of hitShaderBindingTable -- must not be NULL_HANDLE
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR, the -- shader group handle identified by missShaderBindingTable -- must contain a valid miss shader
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, -- entries in hitShaderBindingTable accessed as a result of this -- command in order to execute an any hit shader must not be set -- to zero
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, -- entries in hitShaderBindingTable accessed as a result of this -- command in order to execute a closest hit shader must not be -- set to zero
If the currently bound ray tracing pipeline was created with -- flags that included -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR, -- entries in hitShaderBindingTable accessed as a result of this -- command in order to execute an intersection shader must not be -- set to zero

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pRaygenShaderBindingTable must be a valid pointer -- to a valid StridedBufferRegionKHR structure
pMissShaderBindingTable must be a valid pointer to -- a valid StridedBufferRegionKHR structure
pHitShaderBindingTable must be a valid pointer to -- a valid StridedBufferRegionKHR structure
pCallableShaderBindingTable must be a valid -- pointer to a valid StridedBufferRegionKHR structure
commandBuffer must be in the recording -- state
The CommandPool 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 the CommandPool that commandBuffer -- was allocated from must be externally synchronized

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the logical device containing the ray tracing -- pipeline.

-- --

pipeline is the ray tracing pipeline object containing -- the shaders.
firstGroup is the index of the first group to retrieve a -- handle for from the -- RayTracingPipelineCreateInfoKHR::pGroups or -- RayTracingPipelineCreateInfoNV::pGroups array.
groupCount is the number of shader handles to -- retrieve.
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.

-- --

Valid Usage

-- --

The sum of firstGroup and groupCount must -- be less than the number of shader groups in pipeline

-- --

dataSize must be at least -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -- × groupCount
pipeline must have not been created with -- PIPELINE_CREATE_LIBRARY_BIT_KHR

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pipeline must be a valid Pipeline -- handle
pData must be a valid pointer to an array of -- dataSize bytes
dataSize must be greater than 0
pipeline must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device containing the ray tracing -- pipeline.

-- --

pipeline is the ray tracing pipeline object containing -- the shaders.
firstGroup is the index of the first group to retrieve a -- handle for from the -- RayTracingPipelineCreateInfoKHR::pGroups array.
groupCount is the number of shader handles to -- retrieve.
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.

-- --

Valid Usage

-- --

The sum of firstGroup and groupCount must -- be less than the number of shader groups in pipeline

-- --

dataSize must be at least -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleCaptureReplaySize -- × groupCount
PhysicalDeviceRayTracingFeaturesKHR::rayTracingShaderGroupHandleCaptureReplay -- must be enabled to call this function

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pipeline must be a valid Pipeline -- handle
pData must be a valid pointer to an array of -- dataSize bytes
dataSize must be greater than 0
pipeline must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the ray tracing -- pipelines.

-- --

pipelineCache is either 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 a pointer to an array of -- RayTracingPipelineCreateInfoKHR structures.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelines is a pointer to an array in which the -- resulting ray tracing pipeline objects are returned.

-- --

Description

-- -- The ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS error is returned if -- the implementation is unable to re-use the shader group handles -- provided in -- RayTracingShaderGroupCreateInfoKHR::pShaderGroupCaptureReplayHandle -- when -- PhysicalDeviceRayTracingFeaturesKHR::rayTracingShaderGroupHandleCaptureReplay -- is enabled. -- --

Valid Usage

-- --

If the flags member of any element of -- pCreateInfos contains the -- 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 -- PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline -- must have been created with the -- PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
If pipelineCache was created with -- PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host -- access to pipelineCache must be externally -- synchronized
The rayTracing feature must be enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineCache is not NULL_HANDLE, -- pipelineCache must be a valid PipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid -- RayTracingPipelineCreateInfoKHR structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelines must be a valid pointer to an array of -- createInfoCount Pipeline 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 --

-- --

Failure --

-- --

Parameters

-- --

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

-- --

pRaygenShaderBindingTable is the strided buffer range -- that holds the shader binding table data for the ray generation shader -- stage.
pMissShaderBindingTable is the strided buffer range that -- holds the shader binding table data for the miss shader stage.
pHitShaderBindingTable is the strided buffer range that -- holds the shader binding table data for the hit shader stage.
pCallableShaderBindingTable is the strided buffer range -- that holds the shader binding table data for the callable shader -- stage.
buffer is the buffer containing the trace ray -- parameters.
offset is the byte offset into buffer where -- parameters begin.

-- --

Description

-- -- cmdTraceRaysIndirectKHR behaves similarly to -- cmdTraceRaysKHR except that the ray trace query dimensions are -- read by the device from a buffer during execution. The parameters of -- trace ray are encoded in the TraceRaysIndirectCommandKHR -- structure. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
raygenShaderBindingOffset must be less than the -- size of raygenShaderBindingTableBuffer
raygenShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingOffset must be less than the size -- of missShaderBindingTableBuffer
missShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
hitShaderBindingOffset must be less than the size -- of hitShaderBindingTableBuffer
hitShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
callableShaderBindingOffset must be less than the -- size of callableShaderBindingTableBuffer
callableShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
hitShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
callableShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
missShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
hitShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
callableShaderBindingStride must be less than or -- equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
Any shader group handle referenced by this call must have -- been queried from the currently bound ray tracing shader pipeline
This command must not cause a shader call instruction to be -- executed from a shader invocation with a recursion depth -- greater than the value of maxRecursionDepth used to create -- the bound ray tracing pipeline
If buffer is non-sparse then it must be bound -- completely and contiguously to a single DeviceMemory -- object
buffer must have been created with the -- BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
offset must be a multiple of 4
commandBuffer must not be a protected command -- buffer
(offset + -- sizeof(TraceRaysIndirectCommandKHR)) must be -- less than or equal to the size of buffer
the ::rayTracingIndirectTraceRays feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pRaygenShaderBindingTable must be a valid pointer -- to a valid StridedBufferRegionKHR structure
pMissShaderBindingTable must be a valid pointer to -- a valid StridedBufferRegionKHR structure
pHitShaderBindingTable must be a valid pointer to -- a valid StridedBufferRegionKHR structure
pCallableShaderBindingTable must be a valid -- pointer to a valid StridedBufferRegionKHR structure
buffer must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool 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 -- Device

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the device to check the version against.

-- --

version points to the -- AccelerationStructureVersionKHR version information to check -- against the device.

-- --

Description

-- -- This possible return values for -- getDeviceAccelerationStructureCompatibilityKHR are: -- --

SUCCESS is returned if an acceleration structure serialized -- with version as the version information is compatible with -- device.
ERROR_INCOMPATIBLE_VERSION_KHR is returned if an -- acceleration structure serialized with version as the version -- information is not compatible with device.

-- --

Valid Usage

-- --

The rayTracing or rayQuery feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

version must be a valid pointer to a valid -- AccelerationStructureVersionKHR structure

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_INCOMPATIBLE_VERSION_KHR

-- --

Parameters

-- --

device is the logical device that creates the buffer -- object.

-- --

pCreateInfo is a pointer to a -- AccelerationStructureCreateInfoKHR structure containing -- parameters affecting creation of the acceleration structure.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pAccelerationStructure is a pointer to a -- AccelerationStructureKHR handle in which the resulting -- acceleration structure object is returned.

-- --

Description

-- -- Similar to other objects in Vulkan, the acceleration structure -- creation merely creates an object with a specific “shape”. The type -- and quantity of geometry that can be built into an acceleration -- structure is determined by the parameters of -- AccelerationStructureCreateInfoKHR. -- -- Populating the data in the object after allocating and binding memory -- is done with commands such as cmdBuildAccelerationStructureKHR, -- buildAccelerationStructureKHR, -- cmdCopyAccelerationStructureKHR, and -- copyAccelerationStructureKHR. -- --

Valid Usage

-- --

The rayTracing or rayQuery feature must be -- enabled

-- --

If -- AccelerationStructureCreateInfoKHR::deviceAddress is -- not zero, the rayTracingAccelerationStructureCaptureReplay -- feature must be enabled
If device was created with multiple physical devices, -- then the bufferDeviceAddressMultiDevice feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- AccelerationStructureCreateInfoKHR structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pAccelerationStructure must be a valid pointer to -- a AccelerationStructureKHR handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

-- --

Parameters

-- --

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

-- --

infoCount is the number of acceleration structures to -- build. It specifies the number of the pInfos structures and -- ppOffsetInfos pointers that must be provided.
pInfos is an array of infoCount -- AccelerationStructureBuildGeometryInfoKHR structures defining -- the geometry used to build each acceleration structure.
ppOffsetInfos is an array of infoCount pointers -- to arrays of AccelerationStructureBuildOffsetInfoKHR -- structures. Each ppOffsetInfos[i] is an array of -- pInfos[i].geometryCount -- AccelerationStructureBuildOffsetInfoKHR structures defining -- dynamic offsets to the addresses where geometry data is stored, as -- defined by pInfos[i].

-- --

Description

-- -- The cmdBuildAccelerationStructureKHR command provides the -- ability to initiate multiple acceleration structures builds, however -- there is no ordering or synchronization implied between any of the -- individual acceleration structure builds. -- -- Note -- -- This means that an application cannot build a top-level -- acceleration structure in the same -- cmdBuildAccelerationStructureKHR call as the associated -- bottom-level or instance acceleration structures are being built. -- There also cannot be any memory aliasing between any -- acceleration structure memories or scratch memories being used by any -- of the builds. -- --

Valid Usage

-- --

[[VUID-{refpage}-pOffsetInfos-03402]] Each element of -- ppOffsetInfos[i] must be a valid pointer to an array -- of pInfos[i].geometryCount -- AccelerationStructureBuildOffsetInfoKHR structures

-- --

[[VUID-{refpage}-pInfos-03403]] Each -- pInfos[i].srcAccelerationStructure must not -- refer to the same acceleration structure as any -- pInfos[i].dstAccelerationStructure that is provided -- to the same build command unless it is identical for an update
[[VUID-{refpage}-pInfos-03404]] For each pInfos[i], -- dstAccelerationStructure must have been created with -- compatible AccelerationStructureCreateInfoKHR where -- AccelerationStructureCreateInfoKHR::type and -- AccelerationStructureCreateInfoKHR::flags are -- identical to -- AccelerationStructureBuildGeometryInfoKHR::type and -- AccelerationStructureBuildGeometryInfoKHR::flags -- respectively, -- AccelerationStructureBuildGeometryInfoKHR::geometryCount -- for dstAccelerationStructure are greater than or equal to the -- build size, and each geometry in -- AccelerationStructureBuildGeometryInfoKHR::ppGeometries -- for dstAccelerationStructure has greater than or equal to the -- number of vertices, indices, and AABBs, -- AccelerationStructureGeometryTrianglesDataKHR::transformData -- is both 0 or both non-zero, and all other parameters are the same
[[VUID-{refpage}-pInfos-03405]] For each pInfos[i], if -- update is TRUE, then objects that were previously -- active for that acceleration structure must not be made -- inactive as per ???
[[VUID-{refpage}-pInfos-03406]] For each pInfos[i], if -- update is TRUE, then objects that were previously -- inactive for that acceleration structure must not be made -- active as per ???
[[VUID-{refpage}-None-03407]] Any acceleration structure instance -- in any top level build in this command must not reference any -- bottom level acceleration structure built by this command
[[VUID-{refpage}-pInfos-03408]] There must not be any -- memory aliasing between the scratch memories that are provided -- in all the pInfos[i].scratchData memories for the -- acceleration structure builds
[[VUID-{refpage}-None-03409]] There must not be any -- memory aliasing between memory bound to any top level, bottom -- level, or instance acceleration structure accessed by this -- command
If update is FALSE, all addresses between -- pInfos[i].scratchData and -- pInfos[i].scratchData + N - 1 must be in the -- buffer device address range of the same buffer, where N is given by -- the size member of the MemoryRequirements structure -- returned from a call to -- getAccelerationStructureMemoryRequirementsKHR with -- AccelerationStructureMemoryRequirementsInfoKHR::accelerationStructure -- set to pInfos[i].dstAccelerationStructure and -- AccelerationStructureMemoryRequirementsInfoKHR::type -- set to -- ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_KHR
If update is TRUE, all addresses between -- pInfos[i].scratchData and -- pInfos[i].scratchData + N
1 must be in the buffer device address range of the same -- buffer, where N is given by the size member of the -- MemoryRequirements structure returned from a call to -- getAccelerationStructureMemoryRequirementsKHR with -- AccelerationStructureMemoryRequirementsInfoKHR::accelerationStructure -- set to pInfos[i].dstAccelerationStructure and -- AccelerationStructureMemoryRequirementsInfoKHR::type -- set to -- ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_KHR
The buffer from which the buffer device address -- pInfos[i].scratchData is queried must have -- been created with BUFFER_USAGE_RAY_TRACING_BIT_KHR usage -- flag
All DeviceOrHostAddressKHR or -- DeviceOrHostAddressConstKHR referenced by this command -- must contain valid device addresses
All AccelerationStructureKHR objects referenced by this -- command must be bound to device memory
The DeferredOperationInfoKHR structure must not be -- included in the pNext chain of any of the provided -- AccelerationStructureBuildGeometryInfoKHR structures

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfos must be a valid pointer to an array of -- infoCount valid -- AccelerationStructureBuildGeometryInfoKHR structures
ppOffsetInfos must be a valid pointer to an array -- of infoCount AccelerationStructureBuildOffsetInfoKHR -- structures
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
infoCount must be greater than 0

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pInfo is a pointer to a -- AccelerationStructureBuildGeometryInfoKHR structure defining -- the geometry used to build the acceleration structure.
indirectBuffer is the Buffer containing -- pInfo->geometryCount -- AccelerationStructureBuildOffsetInfoKHR structures defining -- dynamic offsets to the addresses where geometry data is stored, as -- defined by pInfo.
indirectOffset is the byte offset into -- indirectBuffer where offset parameters begin.
stride is the byte stride between successive sets of -- offset parameters.

-- --

Valid Usage

-- --

All DeviceOrHostAddressKHR or -- DeviceOrHostAddressConstKHR referenced by this command -- must contain valid device addresses

-- --

All AccelerationStructureKHR objects referenced by this -- command must be bound to device memory
The ::rayTracingIndirectAccelerationStructureBuild feature -- must be enabled
The DeferredOperationInfoKHR structure must not be -- included in the pNext chain of any of the provided -- AccelerationStructureBuildGeometryInfoKHR structures

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfo must be a valid pointer to a valid -- AccelerationStructureBuildGeometryInfoKHR structure
indirectBuffer must be a valid Buffer -- handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
Both of commandBuffer, and indirectBuffer -- must have been created, allocated, or retrieved from the same -- Device

-- --

Host Synchronization

-- --

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

-- --

[[VUID-{refpage}-pOffsetInfos-03402]] Each element of -- ppOffsetInfos[i] must be a valid pointer to an array -- of pInfos[i].geometryCount -- AccelerationStructureBuildOffsetInfoKHR structures

-- --

[[VUID-{refpage}-pInfos-03403]] Each -- pInfos[i].srcAccelerationStructure must not -- refer to the same acceleration structure as any -- pInfos[i].dstAccelerationStructure that is provided -- to the same build command unless it is identical for an update
[[VUID-{refpage}-pInfos-03404]] For each pInfos[i], -- dstAccelerationStructure must have been created with -- compatible AccelerationStructureCreateInfoKHR where -- AccelerationStructureCreateInfoKHR::type and -- AccelerationStructureCreateInfoKHR::flags are -- identical to -- AccelerationStructureBuildGeometryInfoKHR::type and -- AccelerationStructureBuildGeometryInfoKHR::flags -- respectively, -- AccelerationStructureBuildGeometryInfoKHR::geometryCount -- for dstAccelerationStructure are greater than or equal to the -- build size, and each geometry in -- AccelerationStructureBuildGeometryInfoKHR::ppGeometries -- for dstAccelerationStructure has greater than or equal to the -- number of vertices, indices, and AABBs, -- AccelerationStructureGeometryTrianglesDataKHR::transformData -- is both 0 or both non-zero, and all other parameters are the same
[[VUID-{refpage}-pInfos-03405]] For each pInfos[i], if -- update is TRUE, then objects that were previously -- active for that acceleration structure must not be made -- inactive as per ???
[[VUID-{refpage}-pInfos-03406]] For each pInfos[i], if -- update is TRUE, then objects that were previously -- inactive for that acceleration structure must not be made -- active as per ???
[[VUID-{refpage}-None-03407]] Any acceleration structure instance -- in any top level build in this command must not reference any -- bottom level acceleration structure built by this command
[[VUID-{refpage}-pInfos-03408]] There must not be any -- memory aliasing between the scratch memories that are provided -- in all the pInfos[i].scratchData memories for the -- acceleration structure builds
[[VUID-{refpage}-None-03409]] There must not be any -- memory aliasing between memory bound to any top level, bottom -- level, or instance acceleration structure accessed by this -- command
All DeviceOrHostAddressKHR or -- DeviceOrHostAddressConstKHR referenced by this command -- must contain valid host addresses
All AccelerationStructureKHR objects referenced by this -- command must be bound to host-visible memory
The ::rayTracingHostAccelerationStructureCommands feature -- must be enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfos must be a valid pointer to an array of -- infoCount valid -- AccelerationStructureBuildGeometryInfoKHR structures
ppOffsetInfos must be a valid pointer to an array -- of infoCount AccelerationStructureBuildOffsetInfoKHR -- structures
infoCount must be greater than 0

-- --

Return Codes

-- --

Success --

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that the -- accelerationStructure was created on.

-- --

pInfo is a pointer to a -- AccelerationStructureDeviceAddressInfoKHR structure specifying -- the acceleration structure to retrieve an address for.

-- --

Description

-- -- The 64-bit return value is an address of the acceleration structure, -- which can be used for device and shader operations that involve -- acceleration structures, such as ray traversal and acceleration -- structure building. -- -- If the acceleration structure was created with a non-zero value of -- AccelerationStructureCreateInfoKHR::deviceAddress the -- return value will be the same address. -- --

Valid Usage

-- --

If device was created with multiple physical devices, -- then the bufferDeviceAddressMultiDevice feature must be -- enabled

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pInfo must be a valid pointer to a valid -- AccelerationStructureDeviceAddressInfoKHR structure

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- -- When PIPELINE_CREATE_LIBRARY_BIT_KHR is specified, this -- pipeline defines a pipeline library which cannot be -- bound as a ray tracing pipeline directly. Instead, pipeline libraries -- define common shaders and shader groups which can be included -- in future pipeline creation. -- -- If pipeline libraries are included in libraries, shaders -- defined in those libraries are treated as if they were defined as -- additional entries in pStages, appended in the order they -- appear in the pLibraries array and in the pStages -- array when those libraries were defined. -- -- When referencing shader groups in order to obtain a shader group -- handle, groups defined in those libraries are treated as if they were -- defined as additional entries in pGroups, appended in the -- order they appear in the pLibraries array and in the -- pGroups array when those libraries were defined. The shaders -- these groups reference are set when the pipeline library is created, -- referencing those specified in the pipeline library, not in the -- pipeline that includes it. -- -- If the DeferredOperationInfoKHR structure is included in the -- pNext chain of RayTracingPipelineCreateInfoKHR, the -- operation of this pipeline creation is deferred, as defined in -- the Deferred Host Operations chapter. -- --

Valid Usage

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is -1, basePipelineHandle -- must be a valid handle to a ray tracing Pipeline

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, -- basePipelineHandle must be NULL_HANDLE
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of at least one element of -- pStages must be -- SHADER_STAGE_RAYGEN_BIT_KHR
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
layout must be consistent with all shaders -- specified in pStages
The number of resources in layout accessible to each -- shader stage that is used by the pipeline must be less than or -- equal to -- PhysicalDeviceLimits::maxPerStageResources
flags must not include -- PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
If the pipelineCreationCacheControl feature is not enabled, -- flags must not include -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT
maxRecursionDepth must be less than or equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxRecursionDepth
If flags includes PIPELINE_CREATE_LIBRARY_BIT_KHR, -- pLibraryInterface must not be NULL
If the libraryCount member of libraries is -- greater than 0, pLibraryInterface must not be -- NULL
Each element of the pLibraries member of -- libraries must have been created with the value of -- maxRecursionDepth equal to that in this pipeline
Each element of the pLibraries member of -- libraries must have been created with a -- layout that is compatible with the layout in this -- pipeline
Each element of the pLibraries member of -- libraries must have been created with values of the -- maxPayloadSize, maxAttributeSize, and -- maxCallableSize members of pLibraryInterface equal -- to those in this pipeline
If flags includes -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR, -- for any element of pGroups with a type of -- RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or -- RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the -- anyHitShader of that element must not be -- SHADER_UNUSED_KHR
If flags includes -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR, -- for any element of pGroups with a type of -- RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_KHR or -- RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_KHR, the -- closestHitShader of that element must not be -- SHADER_UNUSED_KHR
If the rayTracingPrimitiveCulling feature is not enabled, -- flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
If the rayTracingPrimitiveCulling feature is not enabled, -- flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
If libraries.libraryCount is zero, then -- stageCount must not be zero
If libraries.libraryCount is zero, then -- groupCount must not be zero

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_RAY_TRACING_PIPELINE_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 DeferredOperationInfoKHR or -- PipelineCreationFeedbackCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- PipelineCreateFlagBits values
If stageCount is not 0, pStages -- must be a valid pointer to an array of stageCount -- valid PipelineShaderStageCreateInfo structures
If groupCount is not 0, pGroups -- must be a valid pointer to an array of groupCount -- valid RayTracingShaderGroupCreateInfoKHR structures
libraries must be a valid -- PipelineLibraryCreateInfoKHR structure
If pLibraryInterface is not NULL, -- pLibraryInterface must be a valid pointer to a valid -- RayTracingPipelineInterfaceCreateInfoKHR structure
layout must be a valid PipelineLayout -- handle
Both of basePipelineHandle, and layout that are -- valid handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Device

-- --

Members

-- -- The members of the PhysicalDeviceRayTracingFeaturesKHR -- structure describe the following features: -- --

Description

-- --

rayTracing indicates whether the implementation supports -- ray tracing functionality. See Ray Tracing.

-- --

rayTracingShaderGroupHandleCaptureReplay indicates -- whether the implementation supports saving and reusing shader group -- handles, e.g. for trace capture and replay.
rayTracingShaderGroupHandleCaptureReplayMixed indicates -- whether the implementation supports reuse of shader group handles -- being arbitrarily mixed with creation of non-reused shader group -- handles. If this is FALSE, all reused shader group handles -- must be specified before any non-reused handles may be -- created.
rayTracingAccelerationStructureCaptureReplay indicates -- whether the implementation supports saving and reusing acceleration -- structure device addresses, e.g. for trace capture and replay.
rayTracingIndirectTraceRays indicates whether the -- implementation supports indirect trace ray commands, e.g. -- cmdTraceRaysIndirectKHR.
rayTracingIndirectAccelerationStructureBuild indicates -- whether the implementation supports indirect acceleration structure -- build commands, e.g. -- cmdBuildAccelerationStructureIndirectKHR.
rayTracingHostAccelerationStructureCommands indicates -- whether the implementation supports host side acceleration structure -- commands, e.g. buildAccelerationStructureKHR, -- copyAccelerationStructureKHR, -- copyAccelerationStructureToMemoryKHR, -- copyMemoryToAccelerationStructureKHR, -- writeAccelerationStructuresPropertiesKHR.
rayQuery indicates whether the implementation supports -- ray query (OpRayQueryProceedKHR) functionality.
rayTracingPrimitiveCulling indicates whether the -- implementation supports primitive culling during ray -- traversal.

-- -- If the PhysicalDeviceRayTracingFeaturesKHR structure is -- included in the pNext chain of -- PhysicalDeviceFeatures2, it is filled with values indicating -- whether the feature is supported. -- PhysicalDeviceRayTracingFeaturesKHR can also be used in -- the pNext chain of DeviceCreateInfo to enable the -- features. -- --

Valid Usage

-- --

If rayTracingShaderGroupHandleCaptureReplayMixed is -- TRUE, rayTracingShaderGroupHandleCaptureReplay -- must also be TRUE

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_FEATURES_KHR

-- --

sType must be -- STRUCTURE_TYPE_ACCELERATION_STRUCTURE_BUILD_GEOMETRY_INFO_KHR

-- --

pNext must be NULL or a pointer to a -- valid instance of DeferredOperationInfoKHR
The sType value of each struct in the pNext -- chain must be unique
type must be a valid -- AccelerationStructureTypeKHR value
flags must be a valid combination of -- BuildAccelerationStructureFlagBitsKHR values
If srcAccelerationStructure is not NULL_HANDLE, -- srcAccelerationStructure must be a valid -- AccelerationStructureKHR handle
dstAccelerationStructure must be a valid -- AccelerationStructureKHR handle
scratchData must be a valid -- DeviceOrHostAddressKHR union
Both of dstAccelerationStructure, and -- srcAccelerationStructure that are valid handles of -- non-ignored parameters must have been created, allocated, or -- retrieved from the same Device

-- --

Description

-- -- The primitive count and primitive offset are interpreted differently -- depending on the GeometryTypeKHR used: -- --

For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, -- primitiveCount is the number of triangles to be built, where -- each triangle is treated as 3 vertices.
- If the geometry uses -- indices, primitiveCount × 3 indices are consumed from -- AccelerationStructureGeometryTrianglesDataKHR::indexData, -- starting at an offset of primitiveOffset. The value of -- firstVertex is added to the index values before fetching -- vertices.
- If the geometry does not use indices, -- primitiveCount × 3 vertices are consumed from -- AccelerationStructureGeometryTrianglesDataKHR::vertexData, -- starting at an offset of primitiveOffset + -- AccelerationStructureGeometryTrianglesDataKHR::vertexStride -- × firstVertex.
- A single TransformMatrixKHR -- structure is consumed from -- AccelerationStructureGeometryTrianglesDataKHR::transformData, -- at an offset of transformOffset. This transformation matrix -- is used by all triangles.
For geometries of type GEOMETRY_TYPE_AABBS_KHR, -- primitiveCount is the number of axis-aligned bounding boxes. -- primitiveCount AabbPositionsKHR structures are -- consumed from -- AccelerationStructureGeometryAabbsDataKHR::data, -- starting at an offset of primitiveOffset.
For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, -- primitiveCount is the number of acceleration structures. -- primitiveCount AccelerationStructureInstanceKHR -- structures are consumed from -- AccelerationStructureGeometryInstancesDataKHR::data, -- starting at an offset of primitiveOffset.

-- --

Valid Usage

-- --

For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the -- geometry uses indices, the offset primitiveOffset from -- AccelerationStructureGeometryTrianglesDataKHR::indexData -- must be a multiple of the element size of -- AccelerationStructureGeometryTrianglesDataKHR::indexType

-- --

For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, if the -- geometry doesn’t use indices, the offset primitiveOffset from -- AccelerationStructureGeometryTrianglesDataKHR::vertexData -- must be a multiple of the component size of -- AccelerationStructureGeometryTrianglesDataKHR::vertexType
For geometries of type GEOMETRY_TYPE_TRIANGLES_KHR, the -- offset transformOffset from -- AccelerationStructureGeometryTrianglesDataKHR::transformData -- must be a multiple of 16
For geometries of type GEOMETRY_TYPE_AABBS_KHR, the offset -- primitiveOffset from -- AccelerationStructureGeometryAabbsDataKHR::data -- must be a multiple of 8
For geometries of type GEOMETRY_TYPE_INSTANCES_KHR, the -- offset primitiveOffset from -- AccelerationStructureGeometryInstancesDataKHR::data -- must be a multiple of 16 // TODO - Almost certainly should be -- more here

-- --

Description

-- -- When geometryType is GEOMETRY_TYPE_TRIANGLES_KHR: -- --

if indexType is INDEX_TYPE_NONE_KHR, then this -- structure describes a set of triangles.
if indexType is not INDEX_TYPE_NONE_KHR, then this -- structure describes a set of indexed triangles.

-- --

Valid Usage

-- --

If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, -- vertexFormat must support the -- FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR in -- FormatProperties::bufferFeatures as returned by -- getPhysicalDeviceFormatProperties2

-- --

If geometryType is GEOMETRY_TYPE_TRIANGLES_KHR, -- indexType must be INDEX_TYPE_UINT16, -- INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_KHR

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_GEOMETRY_TYPE_INFO_KHR

-- --

pNext must be NULL
geometryType must be a valid -- GeometryTypeKHR value
indexType must be a valid IndexType -- value
If vertexFormat is not 0, vertexFormat -- must be a valid Format value

-- --

Description

-- -- If deviceAddress is zero, no specific address is requested. -- -- If deviceAddress is not zero, deviceAddress -- must be an address retrieved from an identically created -- acceleration structure on the same implementation. The acceleration -- structure must also be bound to an identically created -- DeviceMemory object. -- -- Apps should avoid creating acceleration structures with -- app-provided addresses and implementation-provided addresses in the -- same process, to reduce the likelihood of -- ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors. -- --

Valid Usage

-- --

If compactedSize is not 0 then -- maxGeometryCount must be 0

-- --

If compactedSize is 0 then -- maxGeometryCount must not be 0
If type is -- ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR then -- maxGeometryCount must be less than or equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxGeometryCount
If type is -- ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR then the -- maxPrimitiveCount member of each element of the -- pGeometryInfos array must be less than or equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxInstanceCount
The total number of triangles in all geometries must be -- less than or equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxPrimitiveCount
The total number of AABBs in all geometries must be less -- than or equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxPrimitiveCount
If type is -- ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR and -- compactedSize is 0, maxGeometryCount -- must be 1
If type is -- ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_KHR and -- compactedSize is 0, the geometryType member -- of elements of pGeometryInfos must be -- GEOMETRY_TYPE_INSTANCES_KHR
If type is -- ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR and -- compactedSize is 0, the geometryType member -- of elements of pGeometryInfos must not be -- GEOMETRY_TYPE_INSTANCES_KHR
If type is -- ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_KHR then the -- geometryType member of each geometry in -- pGeometryInfos must be the same
If flags has the -- BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR bit set, -- then it must not have the -- BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR bit -- set
If deviceAddress is not 0, -- PhysicalDeviceRayTracingFeaturesKHR::rayTracingAccelerationStructureCaptureReplay -- must be TRUE

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ACCELERATION_STRUCTURE_CREATE_INFO_KHR

-- --

pNext must be NULL
type must be a valid -- AccelerationStructureTypeKHR value
flags must be a valid combination of -- BuildAccelerationStructureFlagBitsKHR values
If maxGeometryCount is not 0, -- pGeometryInfos must be a valid pointer to an array of -- maxGeometryCount valid -- AccelerationStructureCreateGeometryTypeInfoKHR structures

Parameters

-- --

device is the logical device containing the ray tracing -- pipeline.

-- --

pipeline is the ray tracing pipeline object containing -- the shaders.
shader is the index of the shader to compile.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the buffer -- object.

-- --

pCreateInfo is a pointer to a -- AccelerationStructureCreateInfoNV structure containing -- parameters affecting creation of the acceleration structure.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pAccelerationStructure is a pointer to a -- AccelerationStructureNV handle in which the resulting -- acceleration structure object is returned.

-- --

Description

-- -- Similar to other objects in Vulkan, the acceleration structure -- creation merely creates an object with a specific “shape” as specified -- by the information in AccelerationStructureInfoNV and -- compactedSize in pCreateInfo. Populating the data in -- the object after allocating and binding memory is done with -- cmdBuildAccelerationStructureNV and -- cmdCopyAccelerationStructureNV. -- -- Acceleration structure creation uses the count and type information -- from the geometries, but does not use the data references in the -- structures. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- AccelerationStructureCreateInfoNV structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pAccelerationStructure must be a valid pointer to -- a AccelerationStructureNV handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY

-- --

Parameters

-- --

device is the logical device on which the acceleration -- structure was created.

-- --

pInfo specifies the acceleration structure to get memory -- requirements for.
pMemoryRequirements returns the requested acceleration -- structure memory requirements.

-- --

Valid Usage (Implicit)

-- --

Parameters

-- --

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

-- --

dst is a pointer to the target acceleration structure for -- the copy.
src is a pointer to the source acceleration structure for -- the copy.
mode is a CopyAccelerationStructureModeKHR value -- specifying additional operations to perform during the copy.

-- --

Valid Usage

-- --

[[VUID-{refpage}-mode-03410]] mode must be -- COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR or -- COPY_ACCELERATION_STRUCTURE_MODE_CLONE_KHR

-- --

[[VUID-{refpage}-src-03411]] src must have been -- built with -- BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if -- mode is -- COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

dst must be a valid -- AccelerationStructureKHR handle
src must be a valid -- AccelerationStructureKHR handle
mode must be a valid -- CopyAccelerationStructureModeKHR value
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
Each of commandBuffer, dst, and src -- must have been created, allocated, or retrieved from the same -- Device

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

pInfo contains the shared information for the -- acceleration structure’s structure.
instanceData is the buffer containing an array of -- AccelerationStructureInstanceKHR structures defining -- acceleration structures. This parameter must be NULL -- for bottom level acceleration structures.
instanceOffset is the offset in bytes (relative to the -- start of instanceData) at which the instance data is -- located.
update specifies whether to update the dst -- acceleration structure with the data in src.
dst is a pointer to the target acceleration structure for -- the build.
src is a pointer to an existing acceleration structure -- that is to be used to update the dst acceleration -- structure.
scratch is the Buffer that will be used as scratch -- memory for the build.
scratchOffset is the offset in bytes relative to the -- start of scratch that will be used as a scratch memory.

-- --

Valid Usage

-- --

geometryCount must be less than or equal to -- PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

-- --

dst must have been created with compatible -- AccelerationStructureInfoNV where -- AccelerationStructureInfoNV::type and -- AccelerationStructureInfoNV::flags are identical, -- AccelerationStructureInfoNV::instanceCount and -- AccelerationStructureInfoNV::geometryCount for -- dst are greater than or equal to the build size and each -- geometry in AccelerationStructureInfoNV::pGeometries -- for dst has greater than or equal to the number of vertices, -- indices, and AABBs
If update is TRUE, src must not be -- NULL_HANDLE
If update is TRUE, src must have -- been built before with -- BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_NV set in -- AccelerationStructureInfoNV::flags
If update is FALSE, the size member of -- the MemoryRequirements structure returned from a call to -- getAccelerationStructureMemoryRequirementsNV with -- AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure -- set to dst and -- AccelerationStructureMemoryRequirementsInfoNV::type -- set to -- ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_BUILD_SCRATCH_NV -- must be less than or equal to the size of scratch -- minus scratchOffset
If update is TRUE, the size member of the -- MemoryRequirements structure returned from a call to -- getAccelerationStructureMemoryRequirementsNV with -- AccelerationStructureMemoryRequirementsInfoNV::accelerationStructure -- set to dst and -- AccelerationStructureMemoryRequirementsInfoNV::type -- set to -- ACCELERATION_STRUCTURE_MEMORY_REQUIREMENTS_TYPE_UPDATE_SCRATCH_NV -- must be less than or equal to the size of scratch -- minus scratchOffset
scratch must have been created with -- BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
If instanceData is not NULL_HANDLE, -- instanceData must have been created with -- BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
If update is TRUE, then objects that were -- previously active must not be made inactive as per -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#acceleration-structure-inactive-prims
If update is TRUE, then objects that were -- previously inactive must not be made active as per -- https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#acceleration-structure-inactive-prims
If update is TRUE, the src and -- dst objects must either be the same object or not have -- any memory aliasing

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pInfo must be a valid pointer to a valid -- AccelerationStructureInfoNV structure
If instanceData is not NULL_HANDLE, -- instanceData must be a valid Buffer handle
dst must be a valid -- AccelerationStructureKHR handle
If src is not NULL_HANDLE, src -- must be a valid AccelerationStructureKHR handle
scratch must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
Each of commandBuffer, dst, -- instanceData, scratch, and src that are -- valid handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Device

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

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

-- --

raygenShaderBindingTableBuffer is the buffer object that -- holds the shader binding table data for the ray generation shader -- stage.
raygenShaderBindingOffset is the offset in bytes -- (relative to raygenShaderBindingTableBuffer) of the ray -- generation shader being used for the trace.
missShaderBindingTableBuffer is the buffer object that -- holds the shader binding table data for the miss shader stage.
missShaderBindingOffset is the offset in bytes (relative -- to missShaderBindingTableBuffer) of the miss shader being -- used for the trace.
missShaderBindingStride is the size in bytes of each -- shader binding table record in -- missShaderBindingTableBuffer.
hitShaderBindingTableBuffer is the buffer object that -- holds the shader binding table data for the hit shader stages.
hitShaderBindingOffset is the offset in bytes (relative -- to hitShaderBindingTableBuffer) of the hit shader group being -- used for the trace.
hitShaderBindingStride is the size in bytes of each -- shader binding table record in -- hitShaderBindingTableBuffer.
callableShaderBindingTableBuffer is the buffer object -- that holds the shader binding table data for the callable shader -- stage.
callableShaderBindingOffset is the offset in bytes -- (relative to callableShaderBindingTableBuffer) of the -- callable shader being used for the trace.
callableShaderBindingStride is the size in bytes of each -- shader binding table record in -- callableShaderBindingTableBuffer.
width is the width of the ray trace query -- dimensions.
height is height of the ray trace query dimensions.
depth is depth of the ray trace query dimensions.

-- --

Description

-- -- When the command is executed, a ray generation group of width -- × height × depth rays is assembled. -- --

Valid Usage

-- --

If a ImageView is sampled with FILTER_LINEAR as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

-- --

If a ImageView is accessed using atomic operations as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
If a ImageView is sampled with FILTER_CUBIC_EXT as a -- result of this command, then the image view’s format features -- must contain -- FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
Any ImageView being sampled with FILTER_CUBIC_EXT as -- a result of this command must have a ImageViewType and -- format that supports cubic filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubic -- returned by getPhysicalDeviceImageFormatProperties2
Any ImageView being sampled with FILTER_CUBIC_EXT -- with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or -- SAMPLER_REDUCTION_MODE_MAX as a result of this command -- must have a ImageViewType and format that supports cubic -- filtering together with minmax filtering, as specified by -- FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax -- returned by getPhysicalDeviceImageFormatProperties2
Any Image created with a -- ImageCreateInfo::flags containing -- IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this -- command must only be sampled using a SamplerAddressMode -- of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
For each set n that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a descriptor set must have been bound to n at the same -- pipeline bind point, with a PipelineLayout that is compatible -- for set n, with the PipelineLayout used to create the -- current Pipeline, as described in ???
For each push constant that is statically used by the -- Pipeline bound to the pipeline bind point used by this command, -- a push constant value must have been set for the same pipeline -- bind point, with a PipelineLayout that is compatible for push -- constants, with the PipelineLayout used to create the current -- Pipeline, as described in ???
Descriptors in each bound descriptor set, specified via -- cmdBindDescriptorSets, must be valid if they are -- statically used by the Pipeline bound to the pipeline bind -- point used by this command
A valid pipeline must be bound to the pipeline bind point -- used by this command
If the Pipeline object bound to the pipeline bind point -- used by this command requires any dynamic state, that state -- must have been set for commandBuffer, and done so -- after any previously bound pipeline with the corresponding state not -- specified as dynamic
There must not have been any calls to dynamic state setting -- commands for any state not specified as dynamic in the Pipeline -- object bound to the pipeline bind point used by this command, since -- that pipeline was bound
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler must not be used to -- sample from any Image with a ImageView of the type -- IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, -- IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or -- IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
If the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 the Pipeline object bound to the pipeline bind point -- used by this command accesses a Sampler object that uses -- unnormalized coordinates, that sampler 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 if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a uniform buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If the robust buffer access feature is not enabled, and if -- the Pipeline object bound to the pipeline bind point used by -- this command accesses a storage buffer, it must not access -- values outside of the range of the buffer as specified in the -- descriptor set bound to the same pipeline bind point
If commandBuffer is an unprotected command buffer, any -- resource accessed by the Pipeline object bound to the pipeline -- bind point used by this command must not be a protected -- resource
raygenShaderBindingOffset must be less than the -- size of raygenShaderBindingTableBuffer
raygenShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingOffset must be less than the size -- of missShaderBindingTableBuffer
missShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
hitShaderBindingOffset must be less than the size -- of hitShaderBindingTableBuffer
hitShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
callableShaderBindingOffset must be less than the -- size of callableShaderBindingTableBuffer
callableShaderBindingOffset must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupBaseAlignment
missShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
hitShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
callableShaderBindingStride must be a multiple of -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize
missShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
hitShaderBindingStride must be less than or equal -- to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
callableShaderBindingStride must be less than or -- equal to -- PhysicalDeviceRayTracingPropertiesKHR::maxShaderGroupStride
Any shader group handle referenced by this call must have -- been queried from the currently bound ray tracing shader pipeline
This command must not cause a shader call instruction to be -- executed from a shader invocation with a recursion depth -- greater than the value of maxRecursionDepth used to create -- the bound ray tracing pipeline
If commandBuffer is a protected command buffer, any -- resource written to by the Pipeline object bound to the -- pipeline bind point used by this command must not be an -- unprotected resource
If commandBuffer is a protected command buffer, pipeline -- stages other than the framebuffer-space and compute stages in the -- Pipeline object bound to the pipeline bind point must -- not write to any resource
width must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
height must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
depth must be less than or equal to -- PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

raygenShaderBindingTableBuffer must be a valid -- Buffer handle
If missShaderBindingTableBuffer is not -- NULL_HANDLE, missShaderBindingTableBuffer must -- be a valid Buffer handle
If hitShaderBindingTableBuffer is not NULL_HANDLE, -- hitShaderBindingTableBuffer must be a valid -- Buffer handle
If callableShaderBindingTableBuffer is not -- NULL_HANDLE, callableShaderBindingTableBuffer -- must be a valid Buffer handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
Each of callableShaderBindingTableBuffer, -- commandBuffer, hitShaderBindingTableBuffer, -- missShaderBindingTableBuffer, and -- raygenShaderBindingTableBuffer that are valid handles of -- non-ignored parameters must have been created, allocated, or -- retrieved from the same Device

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the logical device that owns the acceleration -- structures.

-- --

accelerationStructure is the acceleration structure.
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.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the ray tracing -- pipelines.

-- --

pipelineCache is either 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 a pointer to an array of -- RayTracingPipelineCreateInfoNV structures.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pPipelines is a pointer to an array in which the -- resulting ray tracing pipeline objects are returned.

-- --

Valid Usage

-- --

If the flags member of any element of -- pCreateInfos contains the -- 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 -- PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline -- must have been created with the -- PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
If pipelineCache was created with -- PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT_EXT, host -- access to pipelineCache must be externally -- synchronized

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If pipelineCache is not NULL_HANDLE, -- pipelineCache must be a valid PipelineCache -- handle
pCreateInfos must be a valid pointer to an array -- of createInfoCount valid -- RayTracingPipelineCreateInfoNV structures
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pPipelines must be a valid pointer to an array of -- createInfoCount Pipeline 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 --
- SUCCESS
- PIPELINE_COMPILE_REQUIRED_EXT

-- --

Failure --

-- --

Description

-- -- The parameters basePipelineHandle and -- basePipelineIndex are described in more detail in Pipeline -- Derivatives. -- --

Valid Usage

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is -1, basePipelineHandle -- must be a valid handle to a ray tracing Pipeline

-- --

If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is NULL_HANDLE, -- basePipelineIndex must be a valid index into the -- calling command’s pCreateInfos parameter
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineIndex is not -1, -- basePipelineHandle must be NULL_HANDLE
If flags contains the -- PIPELINE_CREATE_DERIVATIVE_BIT flag, and -- basePipelineHandle is not NULL_HANDLE, -- basePipelineIndex must be -1
The stage member of at least one element of -- pStages must be -- SHADER_STAGE_RAYGEN_BIT_KHR
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
layout must be consistent with all shaders -- specified in pStages
The number of resources in layout accessible to each -- shader stage that is used by the pipeline must be less than or -- equal to -- PhysicalDeviceLimits::maxPerStageResources
flags must not include -- PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
If the pipelineCreationCacheControl feature is not enabled, -- flags must not include -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT or -- PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT_EXT
flags must not include -- PIPELINE_CREATE_LIBRARY_BIT_KHR
maxRecursionDepth must be less than or equal to -- PhysicalDeviceRayTracingPropertiesNV::maxRecursionDepth
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR
flags must not include -- PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR
flags must not include both -- PIPELINE_CREATE_DEFER_COMPILE_BIT_NV and -- PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT at -- the same time

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV

-- --

pNext must be NULL or a pointer to a -- valid instance of PipelineCreationFeedbackCreateInfoEXT
The sType value of each struct in the pNext -- chain must be unique
flags must be a valid combination of -- PipelineCreateFlagBits values
pStages must be a valid pointer to an array of -- stageCount valid PipelineShaderStageCreateInfo -- structures
pGroups must be a valid pointer to an array of -- groupCount valid RayTracingShaderGroupCreateInfoNV -- structures
layout must be a valid PipelineLayout -- handle
stageCount must be greater than 0
groupCount must be greater than 0
Both of basePipelineHandle, and layout that are -- valid handles of non-ignored parameters must have been created, -- allocated, or retrieved from the same Device

-- --

Description

-- -- If indexType is INDEX_TYPE_NONE_NV, then this -- structure describes a set of triangles determined by -- vertexCount. Otherwise, this structure describes a set of -- indexed triangles determined by indexCount. -- --

Valid Usage

-- --

vertexOffset must be less than the size of -- vertexData

-- --

vertexOffset must be a multiple of the component -- size of vertexFormat
vertexFormat must be one of -- FORMAT_R32G32B32_SFLOAT, FORMAT_R32G32_SFLOAT, -- FORMAT_R16G16B16_SFLOAT, FORMAT_R16G16_SFLOAT, -- FORMAT_R16G16_SNORM, or FORMAT_R16G16B16_SNORM
indexOffset must be less than the size of -- indexData
indexOffset must be a multiple of the element size -- of indexType
indexType must be INDEX_TYPE_UINT16, -- INDEX_TYPE_UINT32, or INDEX_TYPE_NONE_NV
indexData must be NULL_HANDLE if -- indexType is INDEX_TYPE_NONE_NV
indexData must be a valid Buffer handle if -- indexType is not INDEX_TYPE_NONE_NV
indexCount must be 0 if -- indexType is INDEX_TYPE_NONE_NV
transformOffset must be less than the size of -- transformData
transformOffset must be a multiple of -- 16

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_GEOMETRY_TRIANGLES_NV

-- --

pNext must be NULL
If vertexData is not NULL_HANDLE, -- vertexData must be a valid Buffer handle
vertexFormat must be a valid Format -- value
If indexData is not NULL_HANDLE, -- indexData must be a valid Buffer handle
indexType must be a valid IndexType -- value
If transformData is not NULL_HANDLE, -- transformData must be a valid Buffer -- handle
Each of indexData, transformData, and -- vertexData that are valid handles of non-ignored parameters -- must have been created, allocated, or retrieved from the same -- Device

-- --

Description

-- -- The AABB data in memory is six 32-bit floats consisting of the minimum -- x, y, and z values followed by the maximum x, y, and z values. -- --

Valid Usage

-- --

offset must be less than the size of -- aabbData

-- --

offset must be a multiple of 8
stride must be a multiple of 8

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_GEOMETRY_AABB_NV

-- --

pNext must be NULL
If aabbData is not NULL_HANDLE, aabbData -- must be a valid Buffer handle

-- --

Description

-- -- AccelerationStructureInfoNV contains information that is used -- both for acceleration structure creation with -- createAccelerationStructureNV and in combination with the -- actual geometric data to build the acceleration structure with -- cmdBuildAccelerationStructureNV. -- --

Valid Usage

-- --

geometryCount must be less than or equal to -- PhysicalDeviceRayTracingPropertiesNV::maxGeometryCount

-- --

instanceCount must be less than or equal to -- PhysicalDeviceRayTracingPropertiesNV::maxInstanceCount
The total number of triangles in all geometries must be -- less than or equal to -- PhysicalDeviceRayTracingPropertiesNV::maxTriangleCount
If type is -- ACCELERATION_STRUCTURE_TYPE_TOP_LEVEL_NV then -- geometryCount must be 0
If type is -- ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then -- instanceCount must be 0
If type is -- ACCELERATION_STRUCTURE_TYPE_BOTTOM_LEVEL_NV then the -- geometryType member of each geometry in pGeometries -- must be the same
flags must be a valid combination of -- BuildAccelerationStructureFlagBitsNV values
If flags has the -- BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_NV bit set, -- then it must not have the -- BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_NV bit -- set
scratch must have been created with -- BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag
If instanceData is not NULL_HANDLE, -- instanceData must have been created with -- BUFFER_USAGE_RAY_TRACING_BIT_NV usage flag

-- --

Valid Usage (Implicit)

-- --

sType must be -- STRUCTURE_TYPE_ACCELERATION_STRUCTURE_INFO_NV

-- --

pNext must be NULL
type must be a valid -- AccelerationStructureTypeNV value
flags must be 0
If geometryCount is not 0, pGeometries -- must be a valid pointer to an array of geometryCount -- valid GeometryNV structures

-- --

Description

-- -- If the PhysicalDeviceRayTracingPropertiesNV structure is -- included in the pNext chain of -- PhysicalDeviceProperties2, it is filled with the -- implementation-dependent limits. -- -- Limits specified by this structure must match those specified -- with the same name in PhysicalDeviceRayTracingPropertiesKHR. -- --

Valid Usage (Implicit)

-- --

Description

Valid Usage (Implicit)

-- --

Parameters

-- --

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

-- --

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

-- --

Valid Usage

-- --

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

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

accelerationStructure must be a valid -- AccelerationStructureKHR handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
accelerationStructure must have been created, -- allocated, or retrieved from device

-- --

Parameters

-- --

device is the logical device that owns the acceleration -- structures and memory.

-- --

bindInfoCount is the number of elements in -- pBindInfos.
pBindInfos is a pointer to an array of -- BindAccelerationStructureMemoryInfoKHR structures describing -- acceleration structures and memory to bind.

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

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

-- --

accelerationStructureCount is the count of acceleration -- structures for which to query the property.
pAccelerationStructures is a pointer to an array of -- existing previously built acceleration structures.
queryType is a QueryType value specifying the type -- of queries managed by the pool.
queryPool is the query pool that will manage the results -- of the query.
firstQuery is the first query index within the query pool -- that will contain the accelerationStructureCount number of -- results.

-- --

Valid Usage

-- --

queryPool must have been created with a -- queryType matching queryType

-- --

The queries identified by queryPool and -- firstQuery must be unavailable
[[VUID-{refpage}-accelerationStructures-03431]] All acceleration -- structures in accelerationStructures must have been -- built with -- BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR if -- queryType is -- QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR
[[VUID-{refpage}-queryType-03432]] queryType must -- be QUERY_TYPE_ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR or -- QUERY_TYPE_ACCELERATION_STRUCTURE_SERIALIZATION_SIZE_KHR

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pAccelerationStructures must be a valid pointer to -- an array of accelerationStructureCount valid -- AccelerationStructureKHR handles
queryType must be a valid QueryType -- value
queryPool must be a valid QueryPool -- handle
commandBuffer must be in the recording -- state
The CommandPool that commandBuffer was allocated -- from must support compute operations
This command must only be called outside of a render pass -- instance
accelerationStructureCount must be greater than -- 0
Each of commandBuffer, queryPool, and the -- elements of pAccelerationStructures must have been -- created, allocated, or retrieved from the same Device

-- --

Host Synchronization

-- --

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

-- --

Command Properties

-- -- ' -- -- TODO: table -- --

Parameters

-- --

device is the logical device containing the ray tracing -- pipeline.

-- --

pipeline is the ray tracing pipeline object containing -- the shaders.
firstGroup is the index of the first group to retrieve a -- handle for from the -- RayTracingPipelineCreateInfoKHR::pGroups or -- RayTracingPipelineCreateInfoNV::pGroups array.
groupCount is the number of shader handles to -- retrieve.
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.

-- --

Valid Usage

-- --

The sum of firstGroup and groupCount must -- be less than the number of shader groups in pipeline

-- --

dataSize must be at least -- PhysicalDeviceRayTracingPropertiesKHR::shaderGroupHandleSize -- × groupCount
pipeline must have not been created with -- PIPELINE_CREATE_LIBRARY_BIT_KHR

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pipeline must be a valid Pipeline -- handle
pData must be a valid pointer to an array of -- dataSize bytes
dataSize must be greater than 0
pipeline must have been created, allocated, or -- retrieved from device

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Description

-- -- GEOMETRY_INSTANCE_FORCE_NO_OPAQUE_BIT_KHR and -- GEOMETRY_INSTANCE_FORCE_OPAQUE_BIT_KHR must not be used -- in the same flag. -- --

Description

Parameters

-- --

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

-- --

pAllocateInfo is a pointer to a -- CommandBufferAllocateInfo structure describing parameters of -- the allocation.
pCommandBuffers is a pointer to an array of -- CommandBuffer handles in which the resulting command buffer -- objects are returned. The array must be at least the length -- specified by the commandBufferCount member of -- pAllocateInfo. Each allocated command buffer begins in the -- initial state.

-- --

Description

-- -- allocateCommandBuffers can be used to create multiple -- command buffers. If the creation of any of those command buffers -- fails, the implementation must destroy all successfully created -- command buffer objects from this command, set all entries of the -- pCommandBuffers array to NULL and return the error. -- -- When command buffers are first allocated, they are in the initial -- state. -- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pAllocateInfo must be a valid pointer to a valid -- CommandBufferAllocateInfo structure
pCommandBuffers must be a valid pointer to an -- array of pAllocateInfo->commandBufferCount -- CommandBuffer handles
The value referenced by -- pAllocateInfo->commandBufferCount must be greater -- than 0

-- --

Host Synchronization

-- --

Host access to pAllocateInfo->commandPool must -- be externally synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 a pointer to 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 CommandBuffer handles, -- each element of which must either be a valid handle or -- NULL

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

commandPool must be a valid CommandPool -- 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 points to a CommandBufferBeginInfo -- structure defining additional information about how the command buffer -- begins recording.

-- --

Valid Usage

-- --

commandBuffer must not be in the recording or -- pending state

-- --

If commandBuffer was allocated from a CommandPool -- which did not have the -- 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 CommandBufferInheritanceInfo structure
If commandBuffer is a secondary command buffer and either -- the occlusionQueryEnable member of the -- pInheritanceInfo member of pBeginInfo is -- FALSE, or the precise occlusion queries feature is not enabled, -- the queryFlags member of the pInheritanceInfo member -- pBeginInfo must not contain -- QUERY_CONTROL_PRECISE_BIT
If commandBuffer is a primary command buffer, then -- pBeginInfo->flags must not set both the -- COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT and the -- COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT flags

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

pBeginInfo must be a valid pointer to a valid -- CommandBufferBeginInfo structure

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 -- endCommandBuffer. 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
Conditional rendering must not be active
If commandBuffer is a secondary command buffer, there -- must not be an outstanding cmdBeginDebugUtilsLabelEXT -- command recorded to commandBuffer that has not previously -- been ended by a call to cmdEndDebugUtilsLabelEXT
If commandBuffer is a secondary command buffer, there -- must not be an outstanding cmdDebugMarkerBeginEXT -- command recorded to commandBuffer that has not previously -- been ended by a call to cmdDebugMarkerEndEXT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

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

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- 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 CommandBufferResetFlagBits -- 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 -- COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

-- --

Valid Usage (Implicit)

-- --

commandBuffer must be a valid CommandBuffer -- handle

-- --

flags must be a valid combination of -- CommandBufferResetFlagBits values

-- --

Host Synchronization

-- --

Host access to commandBuffer must be externally -- synchronized

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --
- ERROR_OUT_OF_HOST_MEMORY
- ERROR_OUT_OF_DEVICE_MEMORY

-- --

Parameters

-- --

device is the logical device that creates the buffer -- object.

-- --

pCreateInfo is a pointer to a BufferCreateInfo -- structure containing parameters affecting creation of the buffer.
pAllocator controls host memory allocation as described -- in the Memory Allocation chapter.
pBuffer is a pointer to a Buffer handle in which -- the resulting buffer object is returned.

-- --

Valid Usage

-- --

If the flags member of pCreateInfo includes -- BUFFER_CREATE_SPARSE_BINDING_BIT, creating this Buffer -- must not cause the total required sparse memory for all -- currently valid sparse resources on the device to exceed -- PhysicalDeviceLimits::sparseAddressSpaceSize

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

pCreateInfo must be a valid pointer to a valid -- BufferCreateInfo structure
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- structure
pBuffer must be a valid pointer to a Buffer -- handle

-- --

Return Codes

-- --

Success
- SUCCESS

-- --

Failure --

-- --

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.

-- --

Valid Usage

-- --

All submitted commands that refer to buffer, either -- directly or via a BufferView, must have completed -- execution

-- --

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

-- --

Valid Usage (Implicit)

-- --

device must be a valid Device handle

-- --

If buffer is not NULL_HANDLE, buffer -- must be a valid Buffer handle
If pAllocator is not NULL, pAllocator -- must be a valid pointer to a valid AllocationCallbacks -- 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

-- --