Class: RTFrame
Defined in: src/gfx/renderJob/frame/RTFrame.ts:13
A render-target frame: the set of color attachments (with their per-attachment RTDescriptors) plus the depth/z textures and depth load behaviour that define one render pass's output. Subclasses such as GBufferFrame and ProbeGBufferFrame populate specific attachment layouts.
Extended by
Constructors
Constructor
new RTFrame(
attachments,rtDescriptors,depthTexture?,zPreTexture?,isOutTarget?):RTFrame
Defined in: src/gfx/renderJob/frame/RTFrame.ts:42
Parameters
attachments
RenderTexture[]
rtDescriptors
depthTexture?
RenderTexture
zPreTexture?
RenderTexture
isOutTarget?
boolean = true
Returns
RTFrame
Properties
label
label:
string
Defined in: src/gfx/renderJob/frame/RTFrame.ts:15
Optional debug label for this frame.
customSize
customSize:
boolean=false
Defined in: src/gfx/renderJob/frame/RTFrame.ts:17
When true the attachments are a fixed custom size rather than tracking the canvas.
renderTargets
renderTargets:
RenderTexture[]
Defined in: src/gfx/renderJob/frame/RTFrame.ts:19
The color attachments rendered into by this frame.
rtDescriptors
rtDescriptors:
RTDescriptor[]
Defined in: src/gfx/renderJob/frame/RTFrame.ts:21
Per-attachment load/store/clear descriptors, parallel to renderTargets.
zPreTexture
zPreTexture:
RenderTexture
Defined in: src/gfx/renderJob/frame/RTFrame.ts:24
Optional z-prepass depth texture sampled by this frame.
depthTexture
depthTexture:
RenderTexture
Defined in: src/gfx/renderJob/frame/RTFrame.ts:26
The depth (or depth+stencil) attachment for this frame.
depthViewIndex
depthViewIndex:
number=0
Defined in: src/gfx/renderJob/frame/RTFrame.ts:29
Array-layer / face index of the depth view to attach.
depthCleanValue
depthCleanValue:
number=1
Defined in: src/gfx/renderJob/frame/RTFrame.ts:31
Clear value used when the depth load op is clear.
depthLoadOp
depthLoadOp:
GPULoadOp
Defined in: src/gfx/renderJob/frame/RTFrame.ts:33
Load op for the depth attachment (clear by default).
isOutTarget
isOutTarget:
boolean=true
Defined in: src/gfx/renderJob/frame/RTFrame.ts:35
Whether this frame writes the final output target (vs. an intermediate).
sampleCount
sampleCount:
number=0
Defined in: src/gfx/renderJob/frame/RTFrame.ts:40
MSAA sample count — 0 disables MSAA (default). When non-zero, WebGPUDescriptorCreator allocates side-band multisample textures and flags the pass state so pipelines compile with the matching sample count.
Methods
clone2Frame()
clone2Frame(
rtFrame):void
Defined in: src/gfx/renderJob/frame/RTFrame.ts:51
Copy this frame's attachments, descriptors and depth/z textures into rtFrame.
Parameters
rtFrame
RTFrame
Returns
void
clone()
clone():
RTFrame
Defined in: src/gfx/renderJob/frame/RTFrame.ts:67
Return a new RTFrame copied from this one via clone2Frame.
Returns
RTFrame