VkDynamicState - Indicate which dynamic state is taken from dynamic state commands

The source of different pieces of dynamic state is specified by theVkPipelineDynamicStateCreateInfo::pDynamicStates property of thecurrently active pipeline, each of whose elementsmust be one of thevalues:

• VK_DYNAMIC_STATE_VIEWPORT specifies that thepViewportsstate inVkPipelineViewportStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetViewport before any drawingcommands.The number of viewports used by a pipeline is still specified by theviewportCount member ofVkPipelineViewportStateCreateInfo.

• VK_DYNAMIC_STATE_SCISSOR specifies that thepScissors stateinVkPipelineViewportStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetScissor before any drawing commands.The number of scissor rectangles used by a pipeline is still specifiedby thescissorCount member ofVkPipelineViewportStateCreateInfo.

• VK_DYNAMIC_STATE_LINE_WIDTH specifies that thelineWidthstate inVkPipelineRasterizationStateCreateInfo will be ignoredandmust be set dynamically withvkCmdSetLineWidth before anydrawing commands that generate line primitives for the rasterizer.

• VK_DYNAMIC_STATE_DEPTH_BIAS specifies that any instance ofVkDepthBiasRepresentationInfoEXT included in thepNext chain ofVkPipelineRasterizationStateCreateInfo as well as thedepthBiasConstantFactor,depthBiasClamp anddepthBiasSlopeFactor states inVkPipelineRasterizationStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetDepthBiasorvkCmdSetDepthBias2EXT before any draws are performed withdepth bias enabled.

• VK_DYNAMIC_STATE_BLEND_CONSTANTS specifies that theblendConstants state inVkPipelineColorBlendStateCreateInfowill be ignored andmust be set dynamically withvkCmdSetBlendConstants before any draws are performed with apipeline state withVkPipelineColorBlendAttachmentState memberblendEnable set toVK_TRUE and any of the blend functionsusing a constant blend color.

• VK_DYNAMIC_STATE_DEPTH_BOUNDS specifies that theminDepthBounds andmaxDepthBounds states ofVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetDepthBounds before any draws areperformed with a pipeline state withVkPipelineDepthStencilStateCreateInfo memberdepthBoundsTestEnable set toVK_TRUE.

• VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK specifies that thecompareMask state inVkPipelineDepthStencilStateCreateInfofor bothfront andback will be ignored andmust be setdynamically withvkCmdSetStencilCompareMask before any draws areperformed with a pipeline state withVkPipelineDepthStencilStateCreateInfo memberstencilTestEnable set toVK_TRUE

• VK_DYNAMIC_STATE_STENCIL_WRITE_MASK specifies that thewriteMask state inVkPipelineDepthStencilStateCreateInfo forbothfront andback will be ignored andmust be setdynamically withvkCmdSetStencilWriteMask before any draws areperformed with a pipeline state withVkPipelineDepthStencilStateCreateInfo memberstencilTestEnable set toVK_TRUE

• VK_DYNAMIC_STATE_STENCIL_REFERENCE specifies that thereference state inVkPipelineDepthStencilStateCreateInfo forbothfront andback will be ignored andmust be setdynamically withvkCmdSetStencilReference before any draws areperformed with a pipeline state withVkPipelineDepthStencilStateCreateInfo memberstencilTestEnable set toVK_TRUE

• VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV specifies that thepViewportWScalings state inVkPipelineViewportWScalingStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetViewportWScalingNV beforeany draws are performed with a pipeline state withVkPipelineViewportWScalingStateCreateInfoNV memberviewportScalingEnable set toVK_TRUE

• VK_DYNAMIC_STATE_DISCARD_RECTANGLE_EXT specifies that thepDiscardRectangles state inVkPipelineDiscardRectangleStateCreateInfoEXT will be ignored andmust be set dynamically withvkCmdSetDiscardRectangleEXT beforeany draw or clear commands.

• VK_DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT specifies that thepresence of theVkPipelineDiscardRectangleStateCreateInfoEXTstructure in theVkGraphicsPipelineCreateInfo chain with adiscardRectangleCount greater than zero does not implicitly enablediscard rectangles and theymust be enabled dynamically withvkCmdSetDiscardRectangleEnableEXT before any draw commands.This is available on implementations that support at leastspecVersion2 of theVK_EXT_discard_rectanglesextension.

• VK_DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT specifies that thediscardRectangleMode state inVkPipelineDiscardRectangleStateCreateInfoEXT will be ignored andmust be set dynamically withvkCmdSetDiscardRectangleModeEXTbefore any draw commands.This is available on implementations that support at leastspecVersion2 of theVK_EXT_discard_rectanglesextension.

• VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT specifies that thesampleLocationsInfo state inVkPipelineSampleLocationsStateCreateInfoEXT will be ignored andmust be set dynamically withvkCmdSetSampleLocationsEXT beforeany draw or clear commands.Enabling custom sample locations is still indicated by thesampleLocationsEnable member ofVkPipelineSampleLocationsStateCreateInfoEXT.

• VK_DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV specifies that thepExclusiveScissors state inVkPipelineViewportExclusiveScissorStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetExclusiveScissorNV before any drawing commands.

• VK_DYNAMIC_STATE_EXCLUSIVE_SCISSOR_ENABLE_NV specifies that theexclusive scissorsmust be explicitly enabled withvkCmdSetExclusiveScissorEnableNV and theexclusiveScissorCount value inVkPipelineViewportExclusiveScissorStateCreateInfoNV will notimplicitly enable them.This is available on implementations that support at leastspecVersion2 of theVK_NV_scissor_exclusive extension.

• VK_DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV specifies thatthepShadingRatePalettes state inVkPipelineViewportShadingRateImageStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetViewportShadingRatePaletteNV before any drawing commands.

• VK_DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV specifies thatthe coarse sample order state inVkPipelineViewportCoarseSampleOrderStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetCoarseSampleOrderNV before any drawing commands.

• VK_DYNAMIC_STATE_LINE_STIPPLE specifies that thelineStippleFactor andlineStipplePattern state inVkPipelineRasterizationLineStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetLineStipple before any drawsare performed with a pipeline state withVkPipelineRasterizationLineStateCreateInfo memberstippledLineEnable set toVK_TRUE.

• VK_DYNAMIC_STATE_CULL_MODE specifies that thecullMode stateinVkPipelineRasterizationStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetCullMode before any drawingcommands.

• VK_DYNAMIC_STATE_FRONT_FACE specifies that thefrontFacestate inVkPipelineRasterizationStateCreateInfo will be ignoredandmust be set dynamically withvkCmdSetFrontFace before anydrawing commands.

• VK_DYNAMIC_STATE_PRIMITIVE_TOPOLOGY specifies that thetopology state inVkPipelineInputAssemblyStateCreateInfoonly specifies thetopology class,and the specific topology order and adjacencymust be set dynamicallywithvkCmdSetPrimitiveTopology before any drawing commands.

• VK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT specifies that theviewportCount andpViewports state inVkPipelineViewportStateCreateInfo will be ignored andmust be setdynamically withvkCmdSetViewportWithCount before any draw call.

• VK_DYNAMIC_STATE_SCISSOR_WITH_COUNT specifies that thescissorCount andpScissors state inVkPipelineViewportStateCreateInfo will be ignored andmust be setdynamically withvkCmdSetScissorWithCount before any draw call.

• VK_DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE specifies that thestride state inVkVertexInputBindingDescription will beignored andmust be set dynamically withvkCmdBindVertexBuffers2before any draw call.

• VK_DYNAMIC_STATE_DEPTH_TEST_ENABLE specifies that thedepthTestEnable state inVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetDepthTestEnable before any draw call.

• VK_DYNAMIC_STATE_DEPTH_WRITE_ENABLE specifies that thedepthWriteEnable state inVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetDepthWriteEnable before any drawcall.

• VK_DYNAMIC_STATE_DEPTH_COMPARE_OP specifies that thedepthCompareOp state inVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetDepthCompareOp before any draw call.

• VK_DYNAMIC_STATE_DEPTH_BOUNDS_TEST_ENABLE specifies that thedepthBoundsTestEnable state inVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetDepthBoundsTestEnable before any drawcall.

• VK_DYNAMIC_STATE_STENCIL_TEST_ENABLE specifies that thestencilTestEnable state inVkPipelineDepthStencilStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetStencilTestEnable before any drawcall.

• VK_DYNAMIC_STATE_STENCIL_OP specifies that thefailOp,passOp,depthFailOp, andcompareOp states inVkPipelineDepthStencilStateCreateInfo for bothfront andback will be ignored andmust be set dynamically withvkCmdSetStencilOp before any draws are performed with a pipelinestate withVkPipelineDepthStencilStateCreateInfo memberstencilTestEnable set toVK_TRUE

• VK_DYNAMIC_STATE_PATCH_CONTROL_POINTS_EXT specifies that thepatchControlPoints state inVkPipelineTessellationStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetPatchControlPointsEXT before anydrawing commands.

• VK_DYNAMIC_STATE_RASTERIZER_DISCARD_ENABLE specifies that therasterizerDiscardEnable state inVkPipelineRasterizationStateCreateInfo will be ignored andmustbe set dynamically withvkCmdSetRasterizerDiscardEnable before anydrawing commands.

• VK_DYNAMIC_STATE_DEPTH_BIAS_ENABLE specifies that thedepthBiasEnable state inVkPipelineRasterizationStateCreateInfo will be ignored andmustbe set dynamically withvkCmdSetDepthBiasEnable before any drawingcommands.

• VK_DYNAMIC_STATE_LOGIC_OP_EXT specifies that thelogicOpstate inVkPipelineColorBlendStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetLogicOpEXT before anydrawing commands.

• VK_DYNAMIC_STATE_PRIMITIVE_RESTART_ENABLE specifies that theprimitiveRestartEnable state inVkPipelineInputAssemblyStateCreateInfo will be ignored andmustbe set dynamically withvkCmdSetPrimitiveRestartEnable before anydrawing commands.

• VK_DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR specifies that state inVkPipelineFragmentShadingRateStateCreateInfoKHRandVkPipelineFragmentShadingRateEnumStateCreateInfoNVwill be ignored andmust be set dynamically withvkCmdSetFragmentShadingRateKHRorvkCmdSetFragmentShadingRateEnumNVbefore any drawing commands.

• VK_DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR specifiesthat the default stack size computation for the pipeline will be ignoredandmust be set dynamically withvkCmdSetRayTracingPipelineStackSizeKHR before any ray tracingcalls are performed.

• VK_DYNAMIC_STATE_VERTEX_INPUT_EXT specifies that thepVertexInputState state will be ignored andmust be setdynamically withvkCmdSetVertexInputEXT before any drawingcommands

• VK_DYNAMIC_STATE_COLOR_WRITE_ENABLE_EXT specifies that thepColorWriteEnables state inVkPipelineColorWriteCreateInfoEXT will be ignored andmust be setdynamically withvkCmdSetColorWriteEnableEXT before any draw call.

• VK_DYNAMIC_STATE_TESSELLATION_DOMAIN_ORIGIN_EXT specifies that thedomainOrigin state inVkPipelineTessellationDomainOriginStateCreateInfo will be ignoredandmust be set dynamically withvkCmdSetTessellationDomainOriginEXT before any draw call.

• VK_DYNAMIC_STATE_DEPTH_CLAMP_ENABLE_EXT specifies that thedepthClampEnable state inVkPipelineRasterizationStateCreateInfo will be ignored andmustbe set dynamically withvkCmdSetDepthClampEnableEXT before anydraw call.

• VK_DYNAMIC_STATE_POLYGON_MODE_EXT specifies that thepolygonMode state inVkPipelineRasterizationStateCreateInfowill be ignored andmust be set dynamically withvkCmdSetPolygonModeEXT before any draw call.

• VK_DYNAMIC_STATE_RASTERIZATION_SAMPLES_EXT specifies that therasterizationSamples state inVkPipelineMultisampleStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetRasterizationSamplesEXT before anydraw call.

• VK_DYNAMIC_STATE_SAMPLE_MASK_EXT specifies that thepSampleMask state inVkPipelineMultisampleStateCreateInfowill be ignored andmust be set dynamically withvkCmdSetSampleMaskEXT before any draw call.

• VK_DYNAMIC_STATE_ALPHA_TO_COVERAGE_ENABLE_EXT specifies that thealphaToCoverageEnable state inVkPipelineMultisampleStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetAlphaToCoverageEnableEXT before anydraw call.

• VK_DYNAMIC_STATE_ALPHA_TO_ONE_ENABLE_EXT specifies that thealphaToOneEnable state inVkPipelineMultisampleStateCreateInfo will be ignored andmust beset dynamically withvkCmdSetAlphaToOneEnableEXT before any drawcall.

• VK_DYNAMIC_STATE_LOGIC_OP_ENABLE_EXT specifies that thelogicOpEnable state inVkPipelineColorBlendStateCreateInfowill be ignored andmust be set dynamically withvkCmdSetLogicOpEnableEXT before any draw call.

• VK_DYNAMIC_STATE_COLOR_BLEND_ENABLE_EXT specifies that theblendEnable state inVkPipelineColorBlendAttachmentStatewill be ignored andmust be set dynamically withvkCmdSetColorBlendEnableEXT before any draw call.

• VK_DYNAMIC_STATE_COLOR_BLEND_EQUATION_EXT specifies that thesrcColorBlendFactor,dstColorBlendFactor,colorBlendOp,srcAlphaBlendFactor,dstAlphaBlendFactor, andalphaBlendOp states inVkPipelineColorBlendAttachmentState will be ignored andmust beset dynamically withvkCmdSetColorBlendEquationEXT before any drawcall.

• VK_DYNAMIC_STATE_COLOR_WRITE_MASK_EXT specifies that thecolorWriteMask state inVkPipelineColorBlendAttachmentStatewill be ignored andmust be set dynamically withvkCmdSetColorWriteMaskEXT before any draw call.

• VK_DYNAMIC_STATE_RASTERIZATION_STREAM_EXT specifies that therasterizationStream state inVkPipelineRasterizationStateStreamCreateInfoEXT will be ignoredandmust be set dynamically withvkCmdSetRasterizationStreamEXTbefore any draw call.

• VK_DYNAMIC_STATE_CONSERVATIVE_RASTERIZATION_MODE_EXT specifiesthat theconservativeRasterizationMode state inVkPipelineRasterizationConservativeStateCreateInfoEXT will beignored andmust be set dynamically withvkCmdSetConservativeRasterizationModeEXT before any draw call.

• VK_DYNAMIC_STATE_EXTRA_PRIMITIVE_OVERESTIMATION_SIZE_EXT specifiesthat theextraPrimitiveOverestimationSize state inVkPipelineRasterizationConservativeStateCreateInfoEXT will beignored andmust be set dynamically withvkCmdSetExtraPrimitiveOverestimationSizeEXT before any draw call.

• VK_DYNAMIC_STATE_DEPTH_CLIP_ENABLE_EXT specifies that thedepthClipEnable state inVkPipelineRasterizationDepthClipStateCreateInfoEXT will be ignoredandmust be set dynamically withvkCmdSetDepthClipEnableEXTbefore any draw call.

• VK_DYNAMIC_STATE_SAMPLE_LOCATIONS_ENABLE_EXT specifies that thesampleLocationsEnable state inVkPipelineSampleLocationsStateCreateInfoEXT will be ignored andmust be set dynamically withvkCmdSetSampleLocationsEnableEXTbefore any draw call.

• VK_DYNAMIC_STATE_COLOR_BLEND_ADVANCED_EXT specifies that thecolorBlendOp state inVkPipelineColorBlendAttachmentState,andsrcPremultiplied,dstPremultiplied, andblendOverlap states inVkPipelineColorBlendAdvancedStateCreateInfoEXT will be ignored andmust be set dynamically withvkCmdSetColorBlendAdvancedEXT beforeany draw call.

• VK_DYNAMIC_STATE_PROVOKING_VERTEX_MODE_EXT specifies that theprovokingVertexMode state inVkPipelineRasterizationProvokingVertexStateCreateInfoEXT will beignored andmust be set dynamically withvkCmdSetProvokingVertexModeEXT before any draw call.

• VK_DYNAMIC_STATE_LINE_RASTERIZATION_MODE_EXT specifies that thelineRasterizationMode state inVkPipelineRasterizationLineStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetLineRasterizationModeEXTbefore any draw call.

• VK_DYNAMIC_STATE_LINE_STIPPLE_ENABLE_EXT specifies that thestippledLineEnable state inVkPipelineRasterizationLineStateCreateInfo will be ignored andmust be set dynamically withvkCmdSetLineStippleEnableEXT beforeany draw call.

• VK_DYNAMIC_STATE_DEPTH_CLIP_NEGATIVE_ONE_TO_ONE_EXT specifies thatthenegativeOneToOne state inVkPipelineViewportDepthClipControlCreateInfoEXT will be ignoredandmust be set dynamically withvkCmdSetDepthClipNegativeOneToOneEXT before any draw call.

• VK_DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT specifies that thedepthClampMode andpDepthClampRange state inVkPipelineViewportDepthClampControlCreateInfoEXT will be ignoredandmust be set dynamically withvkCmdSetDepthClampRangeEXTbefore any draw call.

• VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_ENABLE_NV specifies that theviewportWScalingEnable state inVkPipelineViewportWScalingStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetViewportWScalingEnableNVbefore any draw call.

• VK_DYNAMIC_STATE_VIEWPORT_SWIZZLE_NV specifies that theviewportCount, andpViewportSwizzles states inVkPipelineViewportSwizzleStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetViewportSwizzleNV before anydraw call.

• VK_DYNAMIC_STATE_COVERAGE_TO_COLOR_ENABLE_NV specifies that thecoverageToColorEnable state inVkPipelineCoverageToColorStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetCoverageToColorEnableNVbefore any draw call.

• VK_DYNAMIC_STATE_COVERAGE_TO_COLOR_LOCATION_NV specifies that thecoverageToColorLocation state inVkPipelineCoverageToColorStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetCoverageToColorLocationNVbefore any draw call.

• VK_DYNAMIC_STATE_COVERAGE_MODULATION_MODE_NV specifies that thecoverageModulationMode state inVkPipelineCoverageModulationStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetCoverageModulationModeNVbefore any draw call.

• VK_DYNAMIC_STATE_COVERAGE_MODULATION_TABLE_ENABLE_NV specifiesthat thecoverageModulationTableEnable state inVkPipelineCoverageModulationStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetCoverageModulationTableEnableNV before any draw call.

• VK_DYNAMIC_STATE_COVERAGE_MODULATION_TABLE_NV specifies that thecoverageModulationTableCount, andpCoverageModulationTablestates inVkPipelineCoverageModulationStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetCoverageModulationTableNV before any draw call.

• VK_DYNAMIC_STATE_SHADING_RATE_IMAGE_ENABLE_NV specifies that theshadingRateImageEnable state inVkPipelineViewportShadingRateImageStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetShadingRateImageEnableNV before any draw call.

• VK_DYNAMIC_STATE_REPRESENTATIVE_FRAGMENT_TEST_ENABLE_NV specifiesthat therepresentativeFragmentTestEnable state inVkPipelineRepresentativeFragmentTestStateCreateInfoNV will beignored andmust be set dynamically withvkCmdSetRepresentativeFragmentTestEnableNV before any draw call.

• VK_DYNAMIC_STATE_COVERAGE_REDUCTION_MODE_NV specifies that thecoverageReductionMode state inVkPipelineCoverageReductionStateCreateInfoNV will be ignored andmust be set dynamically withvkCmdSetCoverageReductionModeNVbefore any draw call.

• VK_DYNAMIC_STATE_ATTACHMENT_FEEDBACK_LOOP_ENABLE_EXT specifiesthat theVK_PIPELINE_CREATE_COLOR_ATTACHMENT_FEEDBACK_LOOP_BIT_EXTandVK_PIPELINE_CREATE_DEPTH_STENCIL_ATTACHMENT_FEEDBACK_LOOP_BIT_EXTflags will be ignored andmust be set dynamically withvkCmdSetAttachmentFeedbackLoopEnableEXT before any draw call.

VK_VERSION_1_0,VkPipelineDynamicStateCreateInfo

For more information, see theVulkan Specification.

This page is extracted from the Vulkan Specification.Fixes and changes should be made to the Specification, not directly.