Modulevulkan-utils-0.5.11.0Haskell2010

Vulkan.Utils.DynamicRendering

The VK_KHR_dynamic_rendering (Vulkan 1.3 core) drawing path: no RenderPass and no framebuffers. The swapchain image's layout transitions are handled by explicit pipeline barriers, and the rendering region is opened with cmdUseRendering against a RenderingInfo pointing straight at an image view. The pipeline carries a PipelineRenderingCreateInfo instead of a render pass.

This is one of two self-contained alternatives — see Vulkan.Utils.RenderPass for the classic path. Pick one and import only it. Callers must have enabled the dynamicRendering feature on the device.

1 type
6 values

Packagevulkan-utils-0.5.11.0
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDynamicRendering.hs

Pipeline

3 declarations

datadata PipelineConfig

Attachment + fixed-function knobs for a dynamic-rendering pipeline.

Construct with zero and override what differs, e.g. zero { Dynamic.colorFormats = [fmt], Dynamic.depthFormat = Just d }.

Constructors

PipelineConfig
- colorFormats :: [Format]
  Colour attachment formats (0..N); [] for a depth-only pipeline.
- depthFormat :: Maybe Format
- vertexInput :: PipelineVertexInputStateCreateInfo '[]
  Vertex input (bindings + attributes); zero for none.
- dynamicStates :: Maybe (Vector DynamicState)
  Dynamic states; Nothing defaults layout-aware to depthOnlyDynamicStates (no colour) or allDynamicStates. Drive with applyDynamicStates.
- layout :: Maybe PipelineLayout
  Pipeline layout for descriptor sets / push constants; Nothing uses a transient empty layout (shaders take no resources). A supplied layout stays owned by the caller, who must keep it alive for the pipeline's lifetime.

Instances1Zero

Zero PipelineConfigDefined in vulkan-utils-0.5.11.0 · Vulkan.Utils.DynamicRendering

valueallocatePipeline

:: (MonadResource m, MonadFail m)
=> Device
-> PipelineConfig
-> Vector (SomeStruct PipelineShaderStageCreateInfo)
-> m (ReleaseKey, Pipeline)

Build a graphics pipeline for the dynamic-rendering path: no render pass, the attachment formats carried in a PipelineRenderingCreateInfo on the pNext chain. The attachment shape — colorFormats and depthFormat — selects the pipeline kind:

[fmt] + Nothing — a single-colour pipeline (as the classic path).
[fmt] + Just d — colour + depth (depth driven dynamically).
[] + Just d — depth-only (e.g. a shadow map / z-prepass).
[f0, f1, …] — multiple colour attachments (MRT / G-buffer).

Stencil is out of scope: no stencilAttachmentFormat is declared, matching renderingInfo, which never supplies a stencil attachment (declaring one without supplying it is invalid at draw time). For stencil, build the PipelineRenderingCreateInfo and RenderingInfo by hand. The formats MUST match the views passed to cmdUseRendering at draw time (see renderingInfo). Intended to be used qualified, e.g. Dynamic.allocatePipeline.

valueallocatePipelineFromShaders

:: (MonadResource m, MonadUnliftIO m, MonadFail m, Specialization spec)
=> Device
-> PipelineConfig
-> spec
Specialization shared by every stage (see Vulkan.Utils.Pipeline.Specialization); () for none.
-> [(ShaderStageFlagBits, ByteString)]
-> m (ReleaseKey, Pipeline)

allocatePipeline from (stage, SPIR-V) pairs: compile each into a shader module, build the pipeline, then release the now-redundant module handles.

Device requirements

1 declaration

valuedynamicRenderingRequirements :: [DeviceRequirement]

The device requirements for this path: the VK_KHR_dynamic_rendering extension (core since Vulkan 1.3) and the dynamicRendering feature it gates. Use it directly as — or append it to — a consumer's device requirements (e.g. WindowedBoot's wcDeviceReqs) so callers need not spell out the feature.

Rendering

3 declarations

valuecolorAttachmentRenderingInfo

:: Rect2D
Render area (typically the full swapchain extent).
-> ImageView
Target color attachment view.
-> ClearColorValue
Clear color applied by the LOAD_OP_CLEAR.
-> RenderingInfo '[]

A RenderingInfo targeting a single color attachment that is cleared on load and stored on completion. The attachment is expected to already be in IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL (e.g. via transitionColorAttachment). The single-colour special case of renderingInfo.

valuerenderingInfo

:: Rect2D
Render area (typically the full swapchain extent).
-> Vector (ImageView, ClearColorValue)
Colour attachment views with the clear colour applied by LOAD_OP_CLEAR.
-> Maybe (ImageView, Float)
Optional depth attachment view with the clear depth applied by LOAD_OP_CLEAR.
-> RenderingInfo '[]

A RenderingInfo over any number of colour attachments plus an optional depth attachment, each cleared on load and stored on completion. Colour attachments are expected in IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth attachment in IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL (e.g. via transitionColorAttachment / transitionDepthAttachment). The attachment shape MUST match the pipeline (allocatePipeline). No stencil attachment is supplied, matching allocatePipeline never declaring one.

valueloadRenderingInfo

:: Rect2D
Render area (typically the full swapchain extent).
-> Vector ImageView
Colour attachment views, loaded.
-> Maybe ImageView
Optional depth attachment view, loaded.
-> RenderingInfo '[]

Continue over stored contents.

renderingInfo with LOAD_OP_LOAD on every attachment — e.g. a second geometry pass into the same targets. Layout expectations as in renderingInfo.