Documentation / scene / RenderPass

Abstract Class: RenderPass

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

Base class for any kind of render passes

Extends

• Disposable

Extended by

• ShadowMapPass
• DepthPass

Constructors

Constructor

new RenderPass(type): RenderPass

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

Creates an instanceof RenderPass

Parameters

type

number

Render pass type

Returns

RenderPass

Overrides

Disposable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

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

Returns

boolean

Inherited from

Disposable.disposed

---

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

---

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

---

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

---

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

---

type

Get Signature

get type(): number

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

The render pass type

Returns

number

Methods

on()

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

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

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

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

context?

unknown

Returns

void

Inherited from

Disposable.on

---

once()

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

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

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

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

context?

unknown

Returns

void

Inherited from

Disposable.once

---

off()

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

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

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

Disposable.off

---

dispatchEvent()

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

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

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

Disposable.dispatchEvent

---

dispose()

dispose(): void

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

Returns

void

Inherited from

Disposable.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

---

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

---

onDispose()

protected onDispose(): void

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

Disposes the render pass

Returns

void

Overrides

Disposable.onDispose