Skip to content

@orillusion/core


Class: ProbeGBufferFrame

Defined in: src/gfx/renderJob/frame/ProbeGBufferFrame.ts:15

G-buffer RTFrame used when rendering reflection / GI probes. Allocates position, normal and color attachments (all rgba16float) plus a depth texture, with load op so probe faces accumulate rather than clear.

Extends

Constructors

Constructor

new ProbeGBufferFrame(rtWidth, rtHeight, autoResize?, ctx?): ProbeGBufferFrame

Defined in: src/gfx/renderJob/frame/ProbeGBufferFrame.ts:17

Parameters

rtWidth

number

rtHeight

number

autoResize?

boolean = true

ctx?

Context3D

Returns

ProbeGBufferFrame

Overrides

RTFrame.constructor

Properties

label

label: string

Defined in: src/gfx/renderJob/frame/RTFrame.ts:15

Optional debug label for this frame.

Inherited from

RTFrame.label


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.

Inherited from

RTFrame.customSize


renderTargets

renderTargets: RenderTexture[]

Defined in: src/gfx/renderJob/frame/RTFrame.ts:19

The color attachments rendered into by this frame.

Inherited from

RTFrame.renderTargets


rtDescriptors

rtDescriptors: RTDescriptor[]

Defined in: src/gfx/renderJob/frame/RTFrame.ts:21

Per-attachment load/store/clear descriptors, parallel to renderTargets.

Inherited from

RTFrame.rtDescriptors


zPreTexture

zPreTexture: RenderTexture

Defined in: src/gfx/renderJob/frame/RTFrame.ts:24

Optional z-prepass depth texture sampled by this frame.

Inherited from

RTFrame.zPreTexture


depthTexture

depthTexture: RenderTexture

Defined in: src/gfx/renderJob/frame/RTFrame.ts:26

The depth (or depth+stencil) attachment for this frame.

Inherited from

RTFrame.depthTexture


depthViewIndex

depthViewIndex: number = 0

Defined in: src/gfx/renderJob/frame/RTFrame.ts:29

Array-layer / face index of the depth view to attach.

Inherited from

RTFrame.depthViewIndex


depthCleanValue

depthCleanValue: number = 1

Defined in: src/gfx/renderJob/frame/RTFrame.ts:31

Clear value used when the depth load op is clear.

Inherited from

RTFrame.depthCleanValue


depthLoadOp

depthLoadOp: GPULoadOp

Defined in: src/gfx/renderJob/frame/RTFrame.ts:33

Load op for the depth attachment (clear by default).

Inherited from

RTFrame.depthLoadOp


isOutTarget

isOutTarget: boolean = true

Defined in: src/gfx/renderJob/frame/RTFrame.ts:35

Whether this frame writes the final output target (vs. an intermediate).

Inherited from

RTFrame.isOutTarget


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.

Inherited from

RTFrame.sampleCount

Methods

crateGBuffer()

crateGBuffer(rtWidth, rtHeight, autoResize, ctx?): void

Defined in: src/gfx/renderJob/frame/ProbeGBufferFrame.ts:23

Allocate the probe G-buffer's position/normal/color attachments and depth texture.

Parameters

rtWidth

number

rtHeight

number

autoResize

boolean

ctx?

Context3D

Returns

void


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

Inherited from

RTFrame.clone2Frame


clone()

clone(): RTFrame

Defined in: src/gfx/renderJob/frame/RTFrame.ts:67

Return a new RTFrame copied from this one via clone2Frame.

Returns

RTFrame

Inherited from

RTFrame.clone

Released under the MIT License