Modulevulkan-utils-0.5.11.0Haskell2010

Vulkan.Utils.DynamicState

The Vulkan-1.3-core "always-on" dynamic state: the set of pipeline state that can be made dynamic without any vendor or experimental extension, so a single pipeline object serves every combination instead of permuting into one Pipeline per variation. See allocatePipeline and allocatePipeline.

Because these states are declared dynamic, the matching cmdSet* MUST be issued before each draw (an unset dynamic state is undefined behaviour). The DynamicState record carries the whole set with safe defaults; amend it with the per-frame situation (the swapchain extent via dynamicStateFor) and emit the lot in one go with applyDynamicStates over allDynamicStates.

Defaults mirror Vulkan's zero-initialized values, deviating only where a non-zero is required for validity (lineWidth = 1) or to match the pipeline's baked topology class (topology = TRIANGLE_LIST). They are feature-free (no wideLines, no depthBounds) and valid with a colour-only attachment (all depth/stencil tests disabled).

1 type
13 values

Packagevulkan-utils-0.5.11.0
Exports14
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDynamicState.hs

The dynamic-state record

3 declarations

datadata DynamicState

Every Vulkan-1.3-core always-on dynamic state, as plain values. Field types match the cmdSet* argument shapes. The stencil ops apply to STENCIL_FACE_FRONT_AND_BACK.

Constructors

DynamicState
- viewports :: Vector Viewport
- scissors :: Vector Rect2D
- topology :: PrimitiveTopology
- primitiveRestart :: Bool
- cullMode :: CullModeFlags
- frontFace :: FrontFace
- rasterizerDiscard :: Bool
- lineWidth :: Float
  /= 1 requires the wideLines feature.
- depthBiasEnable :: Bool
- depthBias :: (Float, Float, Float)
  (constantFactor, clamp, slopeFactor).
- depthTest :: Bool
- depthWrite :: Bool
- depthCompareOp :: CompareOp
- depthBoundsTest :: Bool
  Requires the depthBounds feature.
- depthBounds :: (Float, Float)
  (min, max).
- stencilTest :: Bool
- stencilFailOp :: StencilOp
- stencilPassOp :: StencilOp
- stencilDepthFailOp :: StencilOp
- stencilCompareOp :: CompareOp
- stencilCompareMask :: Word32
- stencilWriteMask :: Word32
- stencilReference :: Word32
- blendConstants :: (Float, Float, Float, Float)

valuedefaultDynamicState :: DynamicState

Safe, feature-free defaults (see module header). viewports and scissors are empty — supply them with dynamicStateFor or by record update before applying.

valuedynamicStateFor :: Extent2D -> DynamicState

defaultDynamicState with the whole-extent viewport and scissor filled in. The common entry point; amend further by record update, e.g.

applyDynamicStates allDynamicStates cb (dynamicStateFor ext){ cullMode = Vk.CULL_MODE_BACK_BIT }

Applying it

1 declaration

valueapplyDynamicStates

:: MonadIO m
=> Vector DynamicState
-> CommandBuffer
-> DynamicState
-> m ()

Issue the cmdSet* for exactly the given states, pulling values from the record. Use the same set passed to the pipeline builder for exact lockstep. States not modelled by DynamicState are skipped (the caller must set those themselves).

The state set (pipeline `dynamicStates` ⇆ apply, single source of truth)

8 declarations

valueallDynamicStates :: Vector DynamicState

The whole always-on set: pass this (or Nothing, which resolves to it) to a full-dynamic pipeline builder, and feed the same set to applyDynamicStates so the pipeline's dynamicStates and the per-frame applies stay in lockstep.

valuedepthOnlyDynamicStates :: Vector DynamicState

The set for a depth-only pipeline (no colour attachment): everything in allDynamicStates except fragmentOutputStates (DYNAMIC_STATE_BLEND_CONSTANTS), which has no colour attachment to act on. Pair it with a depth-only pipeline and feed the same set to applyDynamicStates.

valuedefaultDynamicStatesFor

:: Bool
Whether the pipeline has any colour attachment.
-> Vector DynamicState

The default dynamic-state set for an attachment shape: allDynamicStates when there is at least one colour attachment, otherwise depthOnlyDynamicStates. The default a pipeline builder resolves Nothing to.

valueminimalDynamicStates :: Vector DynamicState

Just the (fixed-count) viewport and scissor. For pipelines that want only those dynamic and set them with cmdSetViewport / cmdSetScissor (not the with-count variants applyDynamicStates issues for allDynamicStates).

valuenoDynamicStates :: Maybe (Vector DynamicState)

Declare nothing dynamic: every state is baked into the pipeline, so no cmdSet* need be issued (skip applyDynamicStates entirely). Pass it where a builder takes Maybe (Vector Vk.DynamicState).

The pipeline must then carry a complete static state — crucially a baked viewport and scissor — so this suits a builder that bakes those (typically a fixed-size offscreen target). The colour-pipeline builders here instead leave viewport and scissor dynamic, so they pair with Nothing / allDynamicStates, not this.

valuepreRasterizationStates :: Vector DynamicState

valuefragmentTestStates :: Vector DynamicState

Fragment-shader depth/stencil dynamic states.

valuefragmentOutputStates :: Vector DynamicState

Whole-extent viewport/scissor

2 declarations

valuefullViewport :: Extent2D -> Viewport

A viewport covering the whole extent, with depth range 0 to 1.

valuefullScissor :: Extent2D -> Rect2D

A scissor rectangle covering the whole extent (offset at the origin).