Documentation / scene / DepthPass
Class: DepthPass
Defined in: libs/scene/src/render/depthpass.ts:15
Depth render pass
Scene depth render pass
Extends
Constructors
Constructor
new DepthPass():
DepthPass
Defined in: libs/scene/src/render/depthpass.ts:22
Creates an instance of DepthRenderPass
Returns
DepthPass
Overrides
Accessors
disposed
Get Signature
get disposed():
boolean
Defined in: libs/base/dist/index.d.ts:6065
Returns
boolean
Inherited from
transmission
Get Signature
get transmission():
boolean
Defined in: libs/scene/src/render/depthpass.ts:28
Returns
boolean
Set Signature
set transmission(
val):void
Defined in: libs/scene/src/render/depthpass.ts:31
Parameters
val
boolean
Returns
void
renderBackface
Get Signature
get renderBackface():
boolean
Defined in: libs/scene/src/render/depthpass.ts:34
Returns
boolean
Set Signature
set renderBackface(
val):void
Defined in: libs/scene/src/render/depthpass.ts:37
Parameters
val
boolean
Returns
void
encodeDepth
Get Signature
get encodeDepth():
boolean
Defined in: libs/scene/src/render/depthpass.ts:40
Returns
boolean
Set Signature
set encodeDepth(
val):void
Defined in: libs/scene/src/render/depthpass.ts:43
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
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
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
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
type
Get Signature
get type():
number
Defined in: libs/scene/src/render/renderpass.ts:75
The render pass type
Returns
number
Inherited from
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
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
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
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
dispose()
dispose():
void
Defined in: libs/base/dist/index.d.ts:6066
Returns
void
Inherited from
render()
render(
ctx,renderCamera?,cullCamera?,renderQueue?):void
Defined in: libs/scene/src/render/renderpass.ts:86
Renders a scene
Parameters
ctx
Drawing context
renderCamera?
cullCamera?
renderQueue?
Returns
void
Inherited from
cullScene()
cullScene(
ctx,cullCamera):RenderQueue
Defined in: libs/scene/src/render/renderpass.ts:124
Culls a scene by a given camera
Parameters
ctx
The draw context
cullCamera
The camera that will be used to cull the scene
Returns
The cull result
Inherited from
onDispose()
protectedonDispose():void
Defined in: libs/scene/src/render/renderpass.ts:271
Disposes the render pass
Returns
void