Documentation / scene / DepthPass

Class: DepthPass

Defined in: libs/scene/src/render/depthpass.ts:15

Depth render pass

Scene depth render pass

Extends

• RenderPass

Constructors

Constructor

new DepthPass(): DepthPass

Defined in: libs/scene/src/render/depthpass.ts:23

Creates an instance of DepthRenderPass

Returns

DepthPass

Overrides

RenderPass.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6107

Returns

boolean

Inherited from

RenderPass.disposed

---

motionVectorOnly

Get Signature

get motionVectorOnly(): boolean

Defined in: libs/scene/src/render/depthpass.ts:48

Draws the transparent queue for its motion vectors alone.

Remarks

Blended geometry is absent from the ordinary prepass, so it contributes no velocity and a temporal filter reprojects it with whatever is behind it - which for hair swinging in front of a still background means reprojecting it as if it were still. This mode fills that in: same pass, same shaders, but the framebuffer carries the motion vector attachment only, nothing writes depth, and materials that have not opted in discard.

It cannot be exact. One velocity per pixel cannot describe several blended layers, so the value that survives is whichever fragment landed last rather than the nearest. For hair that is the same approximation the dithered path already makes - dither keeps one arbitrary strand per pixel - which is why it holds up there and why it stays opt-in rather than applying to every transparent material.

Returns

boolean

Set Signature

set motionVectorOnly(val): void

Defined in: libs/scene/src/render/depthpass.ts:51

Parameters

val

boolean

Returns

void

---

transmission

Get Signature

get transmission(): boolean

Defined in: libs/scene/src/render/depthpass.ts:54

Returns

boolean

Set Signature

set transmission(val): void

Defined in: libs/scene/src/render/depthpass.ts:57

Parameters

val

boolean

Returns

void

---

renderBackface

Get Signature

get renderBackface(): boolean

Defined in: libs/scene/src/render/depthpass.ts:60

Returns

boolean

Set Signature

set renderBackface(val): void

Defined in: libs/scene/src/render/depthpass.ts:63

Parameters

val

boolean

Returns

void

---

encodeDepth

Get Signature

get encodeDepth(): boolean

Defined in: libs/scene/src/render/depthpass.ts:66

Returns

boolean

Set Signature

set encodeDepth(val): void

Defined in: libs/scene/src/render/depthpass.ts:69

Parameters

val

boolean

Returns

void

---

clearColor

Get Signature

get clearColor(): Nullable<Immutable<Vector4>>

Defined in: libs/scene/src/render/renderpass.ts:44

Color value that is used to clear the frame buffer

Returns

Nullable<Immutable<Vector4>>

Set Signature

set clearColor(color): void

Defined in: libs/scene/src/render/renderpass.ts:47

Parameters

color

Nullable<Immutable<Vector4>>

Returns

void

Inherited from

RenderPass.clearColor

---

clearColors

Get Signature

get clearColors(): readonly Readonly<{[key: number]: number; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; clone: Vector4; x: number; y: number; z: number; w: number; magnitude: number; magnitudeSq: number; xy: Vector2; xyz: Vector3; setXYZW: this; setAndNormalize: this; subBy: this; addBy: this; combineBy: this; mulBy: this; divBy: this; scaleBy: this; inplaceNormalize: this; inplaceInverse: this; inplaceMin: this; inplaceMax: this; }>[]

Defined in: libs/scene/src/render/renderpass.ts:52

Per-target color values that are used to clear the frame buffer

Returns

readonly Readonly<{[key: number]: number; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; clone: Vector4; x: number; y: number; z: number; w: number; magnitude: number; magnitudeSq: number; xy: Vector2; xyz: Vector3; setXYZW: this; setAndNormalize: this; subBy: this; addBy: this; combineBy: this; mulBy: this; divBy: this; scaleBy: this; inplaceNormalize: this; inplaceInverse: this; inplaceMin: this; inplaceMax: this; }>[]

Set Signature

set clearColors(colors): void

Defined in: libs/scene/src/render/renderpass.ts:55

Parameters

colors

readonly Readonly<{[key: number]: number; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; clone: Vector4; x: number; y: number; z: number; w: number; magnitude: number; magnitudeSq: number; xy: Vector2; xyz: Vector3; setXYZW: this; setAndNormalize: this; subBy: this; addBy: this; combineBy: this; mulBy: this; divBy: this; scaleBy: this; inplaceNormalize: this; inplaceInverse: this; inplaceMin: this; inplaceMax: this; }>[]

Returns

void

Inherited from

RenderPass.clearColors

---

clearDepth

Get Signature

get clearDepth(): number

Defined in: libs/scene/src/render/renderpass.ts:59

Depth value that is used to clear the frame buffer

Returns

number

Set Signature

set clearDepth(depth): void

Defined in: libs/scene/src/render/renderpass.ts:62

Parameters

depth

number

Returns

void

Inherited from

RenderPass.clearDepth

---

clearStencil

Get Signature

get clearStencil(): number

Defined in: libs/scene/src/render/renderpass.ts:66

Stencil value that is used to clear the frame buffer

Returns

number

Set Signature

set clearStencil(stencil): void

Defined in: libs/scene/src/render/renderpass.ts:69

Parameters

stencil

number

Returns

void

Inherited from

RenderPass.clearStencil

---

type

Get Signature

get type(): number

Defined in: libs/scene/src/render/renderpass.ts:75

The render pass type

Returns

number

Inherited from

RenderPass.type

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:630

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

RenderPass.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:634

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

RenderPass.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:638

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

RenderPass.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:642

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

RenderPass.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6108

Returns

void

Inherited from

RenderPass.dispose

---

render()

render(ctx, renderCamera?, cullCamera?, renderQueue?): void

Defined in: libs/scene/src/render/renderpass.ts:86

Renders a scene

Parameters

ctx

DrawContext

Drawing context

renderCamera?

Camera

cullCamera?

Camera

renderQueue?

RenderQueue

Returns

void

Inherited from

RenderPass.render

---

cullScene()

cullScene(ctx, cullCamera): RenderQueue

Defined in: libs/scene/src/render/renderpass.ts:124

Culls a scene by a given camera

Parameters

ctx

DrawContext

The draw context

cullCamera

Camera

The camera that will be used to cull the scene

Returns

RenderQueue

The cull result

Inherited from

RenderPass.cullScene

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/render/renderpass.ts:271

Disposes the render pass

Returns

void

Inherited from

RenderPass.onDispose