vkCreateGraphicsPipelines - Create graphics pipelines

Description

The GraphicsPipelineCreateInfo structure includes an array of PipelineShaderStageCreateInfo structures for each of the desired active shader stages, as well as creation information for 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, 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 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

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, GraphicsPipelineCreateInfo, Pipeline, PipelineCache

A convenience wrapper to make a compatible pair of calls to createGraphicsPipelines and destroyPipeline

To ensure that destroyPipeline is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkCreateComputePipelines - Creates a new compute pipeline object

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

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

VK_VERSION_1_0, AllocationCallbacks, ComputePipelineCreateInfo, Device, Pipeline, PipelineCache

A convenience wrapper to make a compatible pair of calls to createComputePipelines and destroyPipeline

To ensure that destroyPipeline is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyPipeline - Destroy a pipeline object

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

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, Pipeline

VkViewport - Structure specifying a viewport

Description

Note

Despite their names, minDepth can be less than, equal to, or greater than maxDepth.

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 \(\frac{k}{2^m - 1}\), 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 (or (maxDepth + minDepth) / 2 if PipelineViewportDepthClipControlCreateInfoEXT::negativeOneToOne is TRUE)
• px = width
• py = height
• pz = maxDepth - minDepth (or (maxDepth - minDepth) / 2 if PipelineViewportDepthClipControlCreateInfoEXT::negativeOneToOne is TRUE)

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 pre-rasterization shader stage.

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]
• If the VK_KHR_maintenance1 extension is not enabled, the VK_AMD_negative_viewport_height extension is not enabled, and PhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, height must be greater than 0.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]
• If the VK_EXT_depth_range_unrestricted extension is not enabled, minDepth must be between 0.0 and 1.0, inclusive
• If the VK_EXT_depth_range_unrestricted extension is not enabled, maxDepth must be between 0.0 and 1.0, inclusive

See Also

VK_VERSION_1_0, CommandBufferInheritanceViewportScissorInfoNV, PipelineViewportStateCreateInfo, cmdSetViewport, cmdSetViewportWithCount, cmdSetViewportWithCountEXT

VkSpecializationMapEntry - Structure specifying a specialization map entry

Description

If a constantID value is not a specialization constant ID used in the shader, that map entry does not affect the behavior of the pipeline.

Valid Usage

• For a constantID specialization constant declared in a shader, size must match the byte size of the constantID. If the specialization constant is of type boolean, size must be the byte size of Bool32

See Also

VK_VERSION_1_0, SpecializationInfo

VkSpecializationInfo - Structure specifying specialization information

Valid Usage

• The offset member of each element of pMapEntries must be less than dataSize

• The size member of each element of pMapEntries must be less than or equal to dataSize minus offset
• The constantID value of each element of pMapEntries must be unique within pMapEntries

Valid Usage (Implicit)

• 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

See Also

VK_VERSION_1_0, PipelineShaderStageCreateInfo, ShaderCreateInfoEXT, SpecializationMapEntry

VkPipelineShaderStageCreateInfo - Structure specifying parameters of a newly created pipeline shader stage

Description

If module is not NULL_HANDLE, the shader code used by the pipeline is defined by module. If module is NULL_HANDLE, the shader code is defined by the chained ShaderModuleCreateInfo if present.

If the shaderModuleIdentifier feature is enabled, applications can omit shader code for stage and instead provide a module identifier. This is done by including a PipelineShaderStageModuleIdentifierCreateInfoEXT struct with identifierSize not equal to 0 in the pNext chain. A shader stage created in this way is equivalent to one created using a shader module with the same identifier. The identifier allows an implementation to look up a pipeline without consuming a valid SPIR-V module. If a pipeline is not found, pipeline compilation is not possible and the implementation must fail as specified by PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT.

When an identifier is used in lieu of a shader module, implementations may fail pipeline compilation with PIPELINE_COMPILE_REQUIRED for any reason.

Note

The rationale for the relaxed requirement on implementations to return a pipeline with PipelineShaderStageModuleIdentifierCreateInfoEXT is that layers or tools may intercept pipeline creation calls and require the full SPIR-V context to operate correctly. ICDs are not expected to fail pipeline compilation if the pipeline exists in a cache somewhere.

Applications can use identifiers when creating pipelines with PIPELINE_CREATE_LIBRARY_BIT_KHR. When creating such pipelines, SUCCESS may be returned, but subsequently fail when referencing the pipeline in a PipelineLibraryCreateInfoKHR struct. Applications must allow pipeline compilation to fail during link steps with PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT as it may not be possible to determine if a pipeline can be created from identifiers until the link step.

Valid Usage

• If the geometryShader feature is not enabled, stage must not be SHADER_STAGE_GEOMETRY_BIT

• If the tessellationShader feature is not enabled, stage must not be SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT
• If the meshShaders feature is not enabled, stage must not be SHADER_STAGE_MESH_BIT_EXT
• If the taskShaders feature is not enabled, stage must not be SHADER_STAGE_TASK_BIT_EXT
• If the clustercullingShader feature is not enabled, stage must not be SHADER_STAGE_CLUSTER_CULLING_BIT_HUAWEI
• stage must not be SHADER_STAGE_ALL_GRAPHICS, or SHADER_STAGE_ALL
• pName must be the name of an OpEntryPoint in module with an execution model that matches stage
• If the identified entry point includes any variable in its interface that is declared with the ClipDistance BuiltIn decoration, that variable must not have an array size greater than PhysicalDeviceLimits::maxClipDistances
• If the identified entry point includes any variable in its interface that is declared with the CullDistance BuiltIn decoration, that variable must not have an array size greater than PhysicalDeviceLimits::maxCullDistances
• If the identified entry point includes any variables in its interface that are declared with the ClipDistance or CullDistance BuiltIn decoration, those variables must not have array sizes which sum to more than PhysicalDeviceLimits::maxCombinedClipAndCullDistances
• If the identified entry point includes any variable in its interface that is declared with the SampleMask BuiltIn decoration, that variable must not have an array size greater than PhysicalDeviceLimits::maxSampleMaskWords
• If stage is SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT, and the identified entry point has an OpExecutionMode instruction specifying a patch size with OutputVertices, the patch size must be greater than 0 and less than or equal to PhysicalDeviceLimits::maxTessellationPatchSize
• If stage is SHADER_STAGE_GEOMETRY_BIT, the identified entry point must have an OpExecutionMode instruction specifying a maximum output vertex count that is greater than 0 and less than or equal to PhysicalDeviceLimits::maxGeometryOutputVertices
• If stage is SHADER_STAGE_GEOMETRY_BIT, the identified entry point must have an OpExecutionMode instruction specifying an invocation count that is greater than 0 and less than or equal to PhysicalDeviceLimits::maxGeometryShaderInvocations
• If stage is either SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_TESSELLATION_CONTROL_BIT, SHADER_STAGE_TESSELLATION_EVALUATION_BIT, or SHADER_STAGE_GEOMETRY_BIT, and the identified entry point writes to Layer for any primitive, it must write the same value to Layer for all vertices of a given primitive
• If stage is either SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_TESSELLATION_CONTROL_BIT, SHADER_STAGE_TESSELLATION_EVALUATION_BIT, or SHADER_STAGE_GEOMETRY_BIT, and the identified entry point writes to ViewportIndex for any primitive, it must write the same value to ViewportIndex for all vertices of a given primitive
• If stage is SHADER_STAGE_FRAGMENT_BIT, and the identified entry point writes to FragDepth in any execution path, all execution paths that are not exclusive to helper invocations must either discard the fragment, or write or initialize the value of FragDepth
• If stage is SHADER_STAGE_FRAGMENT_BIT, and the identified entry point writes to FragStencilRefEXT in any execution path, all execution paths that are not exclusive to helper invocations must either discard the fragment, or write or initialize the value of FragStencilRefEXT
• If flags has the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT flag set, the subgroupSizeControl feature must be enabled
• If flags has the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT flag set, the computeFullSubgroups feature must be enabled
• If flags includes PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT, stage must be one of SHADER_STAGE_MESH_BIT_EXT, SHADER_STAGE_TASK_BIT_EXT, or SHADER_STAGE_COMPUTE_BIT
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfo structure is included in the pNext chain, flags must not have the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT flag set
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfo structure is included in the pNext chain, the subgroupSizeControl feature must be enabled, and stage must be a valid bit specified in requiredSubgroupSizeStages
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfo structure is included in the pNext chain and stage is SHADER_STAGE_COMPUTE_BIT, SHADER_STAGE_MESH_BIT_EXT, or SHADER_STAGE_TASK_BIT_EXT, the local workgroup size of the shader must be less than or equal to the product of PipelineShaderStageRequiredSubgroupSizeCreateInfo::requiredSubgroupSize and maxComputeWorkgroupSubgroups
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfo structure is included in the pNext chain, and flags has the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT flag set, the local workgroup size in the X dimension of the pipeline must be a multiple of PipelineShaderStageRequiredSubgroupSizeCreateInfo::requiredSubgroupSize
• If flags has both the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT and PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT flags set, the local workgroup size in the X dimension of the pipeline must be a multiple of maxSubgroupSize
• If flags has the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT flag set and flags does not have the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT flag set and no PipelineShaderStageRequiredSubgroupSizeCreateInfo structure is included in the pNext chain, the local workgroup size in the X dimension of the pipeline must be a multiple of subgroupSize
• If module uses the OpTypeCooperativeMatrixKHR instruction with a Scope equal to Subgroup, then the local workgroup size in the X dimension of the pipeline must be a multiple of subgroupSize.

• If a shader module identifier is not specified for this stage, module must be a valid ShaderModule if none of the following features are enabled:

  • graphicsPipelineLibrary
  • maintenance5
• If a shader module identifier is not specified for this stage, module must be a valid ShaderModule, or there must be a valid ShaderModuleCreateInfo structure in the pNext chain
• If a shader module identifier is specified for this stage, a ShaderModuleCreateInfo structure must not be present in the pNext chain
• If a shader module identifier is specified for this stage, module must be NULL_HANDLE
• If a shader module identifier is not specified, the shader code used by the pipeline must be valid as described by the Khronos SPIR-V Specification after applying the specializations provided in pSpecializationInfo, if any, and then converting all specialization constants into fixed constants

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_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 DebugUtilsObjectNameInfoEXT, PipelineRobustnessCreateInfoEXT, PipelineShaderStageModuleIdentifierCreateInfoEXT, PipelineShaderStageNodeCreateInfoAMDX, PipelineShaderStageRequiredSubgroupSizeCreateInfo, ShaderModuleCreateInfo, or ShaderModuleValidationCacheCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of PipelineShaderStageCreateFlagBits values
• stage must be a valid ShaderStageFlagBits value
• If module is not NULL_HANDLE, module must be a valid ShaderModule handle
• pName must be a null-terminated UTF-8 string
• If pSpecializationInfo is not NULL, pSpecializationInfo must be a valid pointer to a valid SpecializationInfo structure

See Also

VK_VERSION_1_0, ComputePipelineCreateInfo, ExecutionGraphPipelineCreateInfoAMDX, GraphicsPipelineCreateInfo, GraphicsShaderGroupCreateInfoNV, PipelineShaderStageCreateFlags, RayTracingPipelineCreateInfoKHR, RayTracingPipelineCreateInfoNV, ShaderModule, ShaderStageFlagBits, SpecializationInfo, StructureType

VkComputePipelineCreateInfo - Structure specifying parameters of a newly created compute pipeline

Description

The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

If a PipelineCreateFlags2CreateInfoKHR structure is present in the pNext chain, PipelineCreateFlags2CreateInfoKHR::flags from that structure is used instead of flags from this structure.

Valid Usage

• If flags contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is -1, basePipelineHandle must be a valid compute Pipeline handle

• 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, basePipelineIndex must be -1 or basePipelineHandle must be NULL_HANDLE
• If a push constant block is declared in a shader, a push constant range in layout must match both the shader stage and range
• If a resource variables is declared in a shader, a descriptor slot in layout must match the shader stage
• If a resource variables is declared in a shader, and the descriptor type is not DESCRIPTOR_TYPE_MUTABLE_EXT, a descriptor slot in layout must match the descriptor type
• If a resource variables is declared in a shader as an array, a descriptor slot in layout must match the descriptor count
• 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_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR
• flags must not include PIPELINE_CREATE_RAY_TRACING_ALLOW_MOTION_BIT_NV
• If flags includes PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV, then the ::deviceGeneratedComputePipelines feature must be enabled
• If flags includes PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV, then the pNext chain must include a pointer to a valid instance of ComputePipelineIndirectBufferInfoNV specifying the address where the pipeline’s metadata will be saved
• If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT or PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT
• 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
• The number of resources in layout accessible to the compute shader stage must be less than or equal to PhysicalDeviceLimits::maxPerStageResources
• If shaderEnqueue is not enabled, flags must not include PIPELINE_CREATE_LIBRARY_BIT_KHR
• If flags does not include PIPELINE_CREATE_LIBRARY_BIT_KHR, the shader specified by stage must not declare the ShaderEnqueueAMDX capability
• If PipelineCreationFeedbackCreateInfo::pipelineStageCreationFeedbackCount is not 0, it must be 1
• flags must not include PIPELINE_CREATE_RAY_TRACING_OPACITY_MICROMAP_BIT_EXT
• flags must not include PIPELINE_CREATE_RAY_TRACING_DISPLACEMENT_MICROMAP_BIT_NV

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, PipelineCreateFlags2CreateInfoKHR, PipelineCreationFeedbackCreateInfo, PipelineRobustnessCreateInfoEXT, or SubpassShadingPipelineCreateInfoHUAWEI
• 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

See Also

VK_VERSION_1_0, Pipeline, PipelineCreateFlags, PipelineLayout, PipelineShaderStageCreateInfo, StructureType, createComputePipelines, getPipelineIndirectMemoryRequirementsNV

VkVertexInputBindingDescription - Structure specifying vertex input binding description

Valid Usage

• binding must be less than PhysicalDeviceLimits::maxVertexInputBindings

• stride must be less than or equal to PhysicalDeviceLimits::maxVertexInputBindingStride
• If the VK_KHR_portability_subset extension is enabled, stride must be a multiple of, and at least as large as, PhysicalDevicePortabilitySubsetPropertiesKHR::minVertexInputBindingStrideAlignment

Valid Usage (Implicit)

• inputRate must be a valid VertexInputRate value

See Also

VK_VERSION_1_0, PipelineVertexInputStateCreateInfo, VertexInputRate

VkVertexInputAttributeDescription - Structure specifying vertex input attribute description

Valid Usage

• location must be less than PhysicalDeviceLimits::maxVertexInputAttributes

• binding must be less than PhysicalDeviceLimits::maxVertexInputBindings
• offset must be less than or equal to PhysicalDeviceLimits::maxVertexInputAttributeOffset
• The format features of format must contain FORMAT_FEATURE_VERTEX_BUFFER_BIT
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::vertexAttributeAccessBeyondStride is FALSE, the sum of offset plus the size of the vertex attribute data described by format must not be greater than stride in the VertexInputBindingDescription referenced in binding

Valid Usage (Implicit)

• format must be a valid Format value

See Also

VK_VERSION_1_0, Format, PipelineVertexInputStateCreateInfo

VkPipelineVertexInputStateCreateInfo - Structure specifying parameters of a newly created pipeline vertex input state

Valid Usage

• vertexBindingDescriptionCount must be less than or equal to PhysicalDeviceLimits::maxVertexInputBindings

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of PipelineVertexInputDivisorStateCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be 0
• If vertexBindingDescriptionCount is not 0, pVertexBindingDescriptions must be a valid pointer to an array of vertexBindingDescriptionCount valid VertexInputBindingDescription structures
• If vertexAttributeDescriptionCount is not 0, pVertexAttributeDescriptions must be a valid pointer to an array of vertexAttributeDescriptionCount valid VertexInputAttributeDescription structures

See Also

VK_VERSION_1_0, GraphicsPipelineCreateInfo, GraphicsShaderGroupCreateInfoNV, PipelineVertexInputStateCreateFlags, StructureType, VertexInputAttributeDescription, VertexInputBindingDescription

VkPipelineInputAssemblyStateCreateInfo - Structure specifying parameters of a newly created pipeline input assembly state

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 the primitiveTopologyListRestart feature is not enabled, and topology is PRIMITIVE_TOPOLOGY_POINT_LIST, PRIMITIVE_TOPOLOGY_LINE_LIST, PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, or PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY, primitiveRestartEnable must be FALSE

• If the primitiveTopologyPatchListRestart feature is not enabled, and topology is PRIMITIVE_TOPOLOGY_PATCH_LIST, primitiveRestartEnable must be FALSE
• If the geometryShader 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 tessellationShader feature is not enabled, topology must not be PRIMITIVE_TOPOLOGY_PATCH_LIST
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::triangleFans is FALSE, topology must not be PRIMITIVE_TOPOLOGY_TRIANGLE_FAN

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

See Also

VK_VERSION_1_0, Bool32, GraphicsPipelineCreateInfo, PipelineInputAssemblyStateCreateFlags, PrimitiveTopology, StructureType

VkPipelineTessellationStateCreateInfo - Structure specifying parameters of a newly created pipeline tessellation state

Valid Usage

• patchControlPoints must be greater than zero and less than or equal to PhysicalDeviceLimits::maxTessellationPatchSize

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of PipelineTessellationDomainOriginStateCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be 0

See Also

VK_VERSION_1_0, GraphicsPipelineCreateInfo, GraphicsShaderGroupCreateInfoNV, PipelineTessellationStateCreateFlags, StructureType

VkPipelineViewportStateCreateInfo - Structure specifying parameters of a newly created pipeline viewport state

Valid Usage

• If the multiViewport feature is not enabled, viewportCount must not be greater than 1

• If the multiViewport feature is not enabled, scissorCount must not be greater than 1
• viewportCount must be less than or equal to PhysicalDeviceLimits::maxViewports
• scissorCount must be less than or equal to PhysicalDeviceLimits::maxViewports
• 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
• If scissorCount and viewportCount are both not dynamic, then scissorCount and viewportCount must be identical
• If the graphics pipeline is being created with DYNAMIC_STATE_VIEWPORT_WITH_COUNT set then viewportCount must be 0, otherwise it must be greater than 0
• If the graphics pipeline is being created with DYNAMIC_STATE_SCISSOR_WITH_COUNT set then scissorCount must be 0, otherwise it must be greater than 0
• If the viewportWScalingEnable member of a PipelineViewportWScalingStateCreateInfoNV structure included in the pNext chain is TRUE, the viewportCount member of the PipelineViewportWScalingStateCreateInfoNV structure must be greater than or equal to PipelineViewportStateCreateInfo::viewportCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of PipelineViewportCoarseSampleOrderStateCreateInfoNV, PipelineViewportDepthClipControlCreateInfoEXT, PipelineViewportExclusiveScissorStateCreateInfoNV, PipelineViewportShadingRateImageStateCreateInfoNV, PipelineViewportSwizzleStateCreateInfoNV, or PipelineViewportWScalingStateCreateInfoNV
• The sType value of each struct in the pNext chain must be unique
• flags must be 0

See Also

VK_VERSION_1_0, GraphicsPipelineCreateInfo, PipelineViewportStateCreateFlags, Rect2D, StructureType, Viewport

VkPipelineRasterizationStateCreateInfo - Structure specifying parameters of a newly created pipeline rasterization state

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 depthClamp feature is not enabled, depthClampEnable must be FALSE

• If the fillModeNonSolid 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
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::pointPolygons is FALSE, and rasterizerDiscardEnable is FALSE, polygonMode must not be POLYGON_MODE_POINT

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 DepthBiasRepresentationInfoEXT, PipelineRasterizationConservativeStateCreateInfoEXT, PipelineRasterizationDepthClipStateCreateInfoEXT, PipelineRasterizationLineStateCreateInfoEXT, PipelineRasterizationProvokingVertexStateCreateInfoEXT, 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

See Also

VK_VERSION_1_0, Bool32, CullModeFlags, FrontFace, GraphicsPipelineCreateInfo, PipelineRasterizationStateCreateFlags, PolygonMode, StructureType

VkPipelineMultisampleStateCreateInfo - Structure specifying parameters of a newly created pipeline multisample state

Description

Each bit in the sample mask is associated with a unique sample index as defined for the coverage mask. Each bit b for mask word w in the sample mask corresponds to sample index i, where i = 32 × w + b. pSampleMask has a length equal to ⌈ rasterizationSamples / 32 ⌉ words.

If pSampleMask is NULL, it is treated as if the mask has all bits set to 1.

Valid Usage

• If the sampleRateShading feature is not enabled, sampleShadingEnable must be FALSE

• If the alphaToOne feature is not enabled, alphaToOneEnable must be FALSE
• minSampleShading must be in the range [0,1]
• If the VK_NV_framebuffer_mixed_samples extension is enabled, and if the subpass has any color attachments and rasterizationSamples is greater than the number of color samples, then sampleShadingEnable must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of PipelineCoverageModulationStateCreateInfoNV, PipelineCoverageReductionStateCreateInfoNV, PipelineCoverageToColorStateCreateInfoNV, or PipelineSampleLocationsStateCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be 0
• rasterizationSamples must be a valid SampleCountFlagBits value
• If pSampleMask is not NULL, pSampleMask must be a valid pointer to an array of \(\lceil{\mathit{rasterizationSamples} \over 32}\rceil\) SampleMask values

See Also

VK_VERSION_1_0, Bool32, GraphicsPipelineCreateInfo, PipelineMultisampleStateCreateFlags, SampleCountFlagBits, SampleMask, StructureType

VkPipelineColorBlendAttachmentState - Structure specifying a pipeline color blend attachment state

Valid Usage

• If the dualSrcBlend feature is not enabled, srcColorBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

• If the dualSrcBlend feature is not enabled, dstColorBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
• If the dualSrcBlend feature is not enabled, srcAlphaBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
• If the dualSrcBlend feature is not enabled, dstAlphaBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
• If either of colorBlendOp or alphaBlendOp is an advanced blend operation, then colorBlendOp must equal alphaBlendOp
• If PhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendIndependentBlend is FALSE and colorBlendOp is an advanced blend operation, then colorBlendOp must be the same for all attachments
• If PhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendIndependentBlend is FALSE and alphaBlendOp is an advanced blend operation, then alphaBlendOp must be the same for all attachments
• If PhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendAllOperations is FALSE, then colorBlendOp must not be BLEND_OP_ZERO_EXT, BLEND_OP_SRC_EXT, BLEND_OP_DST_EXT, BLEND_OP_SRC_OVER_EXT, BLEND_OP_DST_OVER_EXT, BLEND_OP_SRC_IN_EXT, BLEND_OP_DST_IN_EXT, BLEND_OP_SRC_OUT_EXT, BLEND_OP_DST_OUT_EXT, BLEND_OP_SRC_ATOP_EXT, BLEND_OP_DST_ATOP_EXT, BLEND_OP_XOR_EXT, BLEND_OP_INVERT_EXT, BLEND_OP_INVERT_RGB_EXT, BLEND_OP_LINEARDODGE_EXT, BLEND_OP_LINEARBURN_EXT, BLEND_OP_VIVIDLIGHT_EXT, BLEND_OP_LINEARLIGHT_EXT, BLEND_OP_PINLIGHT_EXT, BLEND_OP_HARDMIX_EXT, BLEND_OP_PLUS_EXT, BLEND_OP_PLUS_CLAMPED_EXT, BLEND_OP_PLUS_CLAMPED_ALPHA_EXT, BLEND_OP_PLUS_DARKER_EXT, BLEND_OP_MINUS_EXT, BLEND_OP_MINUS_CLAMPED_EXT, BLEND_OP_CONTRAST_EXT, BLEND_OP_INVERT_OVG_EXT, BLEND_OP_RED_EXT, BLEND_OP_GREEN_EXT, or BLEND_OP_BLUE_EXT
• If colorBlendOp or alphaBlendOp is an advanced blend operation, then colorAttachmentCount of the subpass this pipeline is compiled against must be less than or equal to PhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendMaxColorAttachments
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::constantAlphaColorBlendFactors is FALSE, srcColorBlendFactor must not be BLEND_FACTOR_CONSTANT_ALPHA or BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA
• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::constantAlphaColorBlendFactors is FALSE, dstColorBlendFactor must not be BLEND_FACTOR_CONSTANT_ALPHA or BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA

Valid Usage (Implicit)

• srcColorBlendFactor must be a valid BlendFactor value

• dstColorBlendFactor must be a valid BlendFactor value
• colorBlendOp must be a valid BlendOp value
• srcAlphaBlendFactor must be a valid BlendFactor value
• dstAlphaBlendFactor must be a valid BlendFactor value
• alphaBlendOp must be a valid BlendOp value
• colorWriteMask must be a valid combination of ColorComponentFlagBits values

See Also

VK_VERSION_1_0, BlendFactor, BlendOp, Bool32, ColorComponentFlags, PipelineColorBlendStateCreateInfo