vkCreateGraphicsPipelines - Create graphics pipelines

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

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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

AllocationCallbacks, Device, GraphicsPipelineCreateInfo, Pipeline, PipelineCache

A safe wrapper for createGraphicsPipelines and destroyPipeline using bracket

The allocated value must not be returned from the provided computation

vkCreateComputePipelines - Creates a new compute pipeline object

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

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

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

AllocationCallbacks, ComputePipelineCreateInfo, Device, Pipeline, PipelineCache

A safe wrapper for createComputePipelines and destroyPipeline using bracket

The allocated value must not be returned from the provided computation

vkDestroyPipeline - Destroy a pipeline object

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

See Also

AllocationCallbacks, Device, Pipeline

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

SpecializationInfo

VkSpecializationInfo - Structure specifying specialization info

Description

pMapEntries is a pointer to a SpecializationMapEntry structure.

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

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

PipelineShaderStageCreateInfo, SpecializationMapEntry

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

Valid Usage

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

• If the tessellation shaders feature is not enabled, stage must not be SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT
• If the mesh shader feature is not enabled, stage must not be SHADER_STAGE_MESH_BIT_NV
• If the task shader feature is not enabled, stage must not be SHADER_STAGE_TASK_BIT_NV
• 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_VERTEX_BIT, the identified entry point must not include any input variable in its interface that is decorated with CullDistance
• If stage is SHADER_STAGE_TESSELLATION_CONTROL_BIT or SHADER_STAGE_TESSELLATION_EVALUATION_BIT, and the identified entry point has an OpExecutionMode instruction that specifies 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 that specifies 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 that specifies an invocation count that is greater than 0 and less than or equal to PhysicalDeviceLimits::maxGeometryShaderInvocations
• If stage is a vertex processing stage, 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 a vertex processing stage, 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, the identified entry point must not include any output variables in its interface decorated with CullDistance
• If stage is SHADER_STAGE_FRAGMENT_BIT, and the identified entry point writes to FragDepth in any execution path, it must write to FragDepth in all execution paths
• If stage is SHADER_STAGE_FRAGMENT_BIT, and the identified entry point writes to FragStencilRefEXT in any execution path, it must write to FragStencilRefEXT in all execution paths
• If stage is SHADER_STAGE_MESH_BIT_NV, the identified entry point must have an OpExecutionMode instruction that specifies a maximum output vertex count, OutputVertices, that is greater than 0 and less than or equal to PhysicalDeviceMeshShaderPropertiesNV::maxMeshOutputVertices.
• If stage is SHADER_STAGE_MESH_BIT_NV, the identified entry point must have an OpExecutionMode instruction that specifies a maximum output primitive count, OutputPrimitivesNV, that is greater than 0 and less than or equal to PhysicalDeviceMeshShaderPropertiesNV::maxMeshOutputPrimitives.
• If flags has the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT flag set, the subgroupSizeControl feature must be enabled.
• If flags has the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT flag set, the computeFullSubgroups feature must be enabled.
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT structure is included in the pNext chain, flags must not have the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT flag set.
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT 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 PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT structure is included in the pNext chain and stage is SHADER_STAGE_COMPUTE_BIT, the local workgroup size of the shader must be less than or equal to the product of PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT::requiredSubgroupSize and maxComputeWorkgroupSubgroups.
• If a PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT structure is included in the pNext chain, and flags has the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT flag set, the local workgroup size in the X dimension of the pipeline must be a multiple of PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT::requiredSubgroupSize.
• If flags has both the PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT and PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT 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_EXT flag set and flags does not have the PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT flag set and no PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT structure is included in the pNext chain, the local workgroup size in the X dimension of the pipeline must be a multiple of subgroupSize.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT
• 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
• 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

ComputePipelineCreateInfo, GraphicsPipelineCreateInfo, PipelineShaderStageCreateFlags, 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.

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

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

See Also

Pipeline, PipelineCreateFlags, PipelineLayout, PipelineShaderStageCreateInfo, StructureType, createComputePipelines

VkVertexInputBindingDescription - Structure specifying vertex input binding description

Valid Usage (Implicit)

See Also

PipelineVertexInputStateCreateInfo, VertexInputRate

VkVertexInputAttributeDescription - Structure specifying vertex input attribute description

Valid Usage (Implicit)

See Also

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

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

See Also

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

GraphicsPipelineCreateInfo, PipelineTessellationStateCreateFlags, StructureType

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

Valid Usage

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

• If the multiple viewports feature is not enabled, scissorCount must be 1
• viewportCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive
• scissorCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive
• scissorCount and viewportCount must be identical
• 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 the viewportWScalingEnable member of a PipelineViewportWScalingStateCreateInfoNV structure included in the pNext chain is TRUE, the viewportCount member of the PipelineViewportWScalingStateCreateInfoNV structure must be equal to 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, PipelineViewportExclusiveScissorStateCreateInfoNV, PipelineViewportShadingRateImageStateCreateInfoNV, PipelineViewportSwizzleStateCreateInfoNV, or PipelineViewportWScalingStateCreateInfoNV
• The sType value of each struct in the pNext chain must be unique
• flags must be 0
• viewportCount must be greater than 0
• scissorCount must be greater than 0

See Also

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

See Also

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

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

Valid Usage

• If the sample rate shading feature is not enabled, sampleShadingEnable must be FALSE

• If the alpha to one 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

Bool32, GraphicsPipelineCreateInfo, PipelineMultisampleStateCreateFlags, SampleCountFlagBits, SampleMask, StructureType

VkPipelineColorBlendAttachmentState - Structure specifying a pipeline color blend attachment state

Valid Usage

• If the dual source blending 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 dual source blending 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 dual source blending 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 dual source blending 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 SubpassDescription::colorAttachmentCount of the subpass this pipeline is compiled against must be less than or equal to PhysicalDeviceBlendOperationAdvancedPropertiesEXT::advancedBlendMaxColorAttachments

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

BlendFactor, BlendOp, Bool32, ColorComponentFlags, PipelineColorBlendStateCreateInfo

VkPipelineColorBlendStateCreateInfo - Structure specifying parameters of a newly created pipeline color blend state

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

See Also

Bool32, GraphicsPipelineCreateInfo, LogicOp, PipelineColorBlendAttachmentState, PipelineColorBlendStateCreateFlags, StructureType

VkPipelineDynamicStateCreateInfo - Structure specifying parameters of a newly created pipeline dynamic state

Valid Usage

• Each element of pDynamicStates must be unique

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO

• pNext must be NULL
• flags must be 0
• If dynamicStateCount is not 0, pDynamicStates must be a valid pointer to an array of dynamicStateCount valid DynamicState values

See Also

DynamicState, GraphicsPipelineCreateInfo, PipelineDynamicStateCreateFlags, StructureType

VkStencilOpState - Structure specifying stencil operation state

Valid Usage (Implicit)

See Also

CompareOp, PipelineDepthStencilStateCreateInfo, StencilOp

VkPipelineDepthStencilStateCreateInfo - Structure specifying parameters of a newly created pipeline depth stencil state

Valid Usage

• If the depth bounds testing feature is not enabled, depthBoundsTestEnable must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO

• pNext must be NULL
• flags must be 0
• depthCompareOp must be a valid CompareOp value
• front must be a valid StencilOpState structure
• back must be a valid StencilOpState structure

See Also

Bool32, CompareOp, GraphicsPipelineCreateInfo, PipelineDepthStencilStateCreateFlags, StencilOpState, StructureType

VkGraphicsPipelineCreateInfo - Structure specifying parameters of a newly created graphics pipeline

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 https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#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 the RenderPassInputAttachmentAspectCreateInfo at renderPass create time, its shader code must not read from any aspect that was not specified in the aspectMask of the corresponding InputAttachmentAspectReference structure.
• The number of resources in layout accessible to each shader stage that is used by the pipeline must be less than or equal to 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]

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

See Also

Pipeline, PipelineColorBlendStateCreateInfo, PipelineCreateFlags, PipelineDepthStencilStateCreateInfo, PipelineDynamicStateCreateInfo, PipelineInputAssemblyStateCreateInfo, PipelineLayout, PipelineMultisampleStateCreateInfo, PipelineRasterizationStateCreateInfo, PipelineShaderStageCreateInfo, PipelineTessellationStateCreateInfo, PipelineVertexInputStateCreateInfo, PipelineViewportStateCreateInfo, RenderPass, StructureType, createGraphicsPipelines