Skip to content

ludus::graphics::rhi::RasterPassDescription

Ludus Wiki · API overview · Browse API

Struct

One raster pass: explicit color views or the legacy color/private-depth pair. With empty Colors, null Color selects the single-sample acquired surface. Explicit offscreen views select one mip/layer per attachment and optional color resolves.

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

#include <ludus/graphics/rhi/graph.h>
struct ludus::graphics::rhi::RasterPassDescription final

Fields

Color

TextureHandle ludus::graphics::rhi::RasterPassDescription::Color {}
Owned attachment texture, or null for the acquired surface.

Related types: TextureHandle

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

ColorLoad

RasterLoad ludus::graphics::rhi::RasterPassDescription::ColorLoad = RasterLoad::Clear
Full-color initialization contract.

Related types: RasterLoad

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

ColorStore

RasterStore ludus::graphics::rhi::RasterPassDescription::ColorStore = RasterStore::Store
Whether initialized color survives the pass.

Related types: RasterStore

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

Clear

ludus::foundation::float32 ludus::graphics::rhi::RasterPassDescription::Clear[4][4] {0, 0, 0, 1}
Linear clear RGBA values, each finite and in [0,1].

Related types: ludus::foundation::float32

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

DepthLoad

RasterLoad ludus::graphics::rhi::RasterPassDescription::DepthLoad = RasterLoad::Clear
Full-depth initialization using ClearDepth; independent of viewport/scissor.

Related types: RasterLoad

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

DepthStore

RasterStore ludus::graphics::rhi::RasterPassDescription::DepthStore = RasterStore::Discard
Whether initialized depth survives for a later pass on this attachment.

Related types: RasterStore

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

DepthReadOnly

bool ludus::graphics::rhi::RasterPassDescription::DepthReadOnly = false
Reject depth-writing pipelines; Load is required for read-only depth.

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

ClearDepth

ludus::foundation::float32 ludus::graphics::rhi::RasterPassDescription::ClearDepth = 1
Finite canonical clear depth in [0,1]; zero pairs with reverse-Z comparisons.

Related types: ludus::foundation::float32

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

Viewport

RasterRectangle ludus::graphics::rhi::RasterPassDescription::Viewport {}
Explicit viewport when UseViewport is true; must fit the actual attachment.

Related types: RasterRectangle

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

Scissor

RasterRectangle ludus::graphics::rhi::RasterPassDescription::Scissor {}
Explicit scissor when UseScissor is true; intersected with attachment bounds.

Related types: RasterRectangle

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

UseViewport

bool ludus::graphics::rhi::RasterPassDescription::UseViewport = false
False selects the complete actual attachment, including after resize.

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

UseScissor

bool ludus::graphics::rhi::RasterPassDescription::UseScissor = false
False clips only against attachment bounds. An enabled empty scissor is a no-op.

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

Colors

const RasterColorAttachment* ludus::graphics::rhi::RasterPassDescription::Colors = nullptr
Borrowed offscreen color entries, consumed by BeginRasterPass or copied by AddGraphPass. Non-null when ColorCount is positive; zero count uses Color. Nonempty requires null Color. Depth/stencil belongs to the first view's selected mip/layer. All sources have matching extents/sample counts; allocations must be distinct (including resolves) under conservative whole-allocation hazards.

Related types: RasterColorAttachment

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

ColorCount

ludus::foundation::usize ludus::graphics::rhi::RasterPassDescription::ColorCount = 0
Number of borrowed Colors entries; zero selects the legacy Color attachment.

Related types: ludus::foundation::usize

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

StencilLoad

RasterLoad ludus::graphics::rhi::RasterPassDescription::StencilLoad = RasterLoad::Clear
Private stencil initialization; ignored for a depth-only allocation.

Related types: RasterLoad

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

StencilStore

RasterStore ludus::graphics::rhi::RasterPassDescription::StencilStore = RasterStore::Discard
Stencil validity after the pass; independent of color and depth.

Related types: RasterStore

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

StencilReadOnly

bool ludus::graphics::rhi::RasterPassDescription::StencilReadOnly = false
Read-only stencil requires Load and rejects nonzero pipeline stencil writes.

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h

ClearStencil

ludus::foundation::uint32 ludus::graphics::rhi::RasterPassDescription::ClearStencil = 0
Eight-bit clear stencil value.

Related types: ludus::foundation::uint32

Declared in modules/graphics/rhi/include/ludus/graphics/rhi/graph.h