Documentation / scene / OrthoCamera

Class: OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:10

Orthogonal camera class

Extends

Camera

Constructors

Constructor

new OrthoCamera(scene, left?, right?, bottom?, top?, near?, far?): OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:29

Creates an instance of OrthoCamera

Parameters

scene

Scene

The scene that the camera belongs to.

left?

number = -1

The left clip plane

right?

number = 1

The right clip plane

bottom?

number = -1

The bottom clip plane

top?

number = 1

The top clip plane

near?

number = -1

The near clip plane

far?

number = 1

The far clip plane

Returns

OrthoCamera

Overrides

Camera.constructor

Properties

_HiZNearest

protected _HiZNearest: boolean

Defined in: libs/scene/src/camera/camera.ts:274

Inherited from

Camera._HiZNearest

_skinSSSGlow

protected _skinSSSGlow: number

Defined in: libs/scene/src/camera/camera.ts:446

Inherited from

Camera._skinSSSGlow

_skinSSSProfilePreset

protected _skinSSSProfilePreset: SubsurfaceProfilePreset

Defined in: libs/scene/src/camera/camera.ts:447

Inherited from

Camera._skinSSSProfilePreset

_skinSSSProfile

protected _skinSSSProfile: SubsurfaceProfile

Defined in: libs/scene/src/camera/camera.ts:448

Inherited from

Camera._skinSSSProfile

_skinSSSScatterTint

protected readonly _skinSSSScatterTint: Vector4

Defined in: libs/scene/src/camera/camera.ts:449

Inherited from

Camera._skinSSSScatterTint

BBOXDRAW_INHERITED

readonly static BBOXDRAW_INHERITED: -1 = -1

Defined in: libs/scene/src/scene/scene_node.ts:168

Bounding-box draw mode inherited from nearest graph ancestor.

Inherited from

Camera.BBOXDRAW_INHERITED

BBOXDRAW_DISABLED

readonly static BBOXDRAW_DISABLED: 0 = 0

Defined in: libs/scene/src/scene/scene_node.ts:170

Disable bounding-box visualization.

Inherited from

Camera.BBOXDRAW_DISABLED

BBOXDRAW_LOCAL

readonly static BBOXDRAW_LOCAL: 1 = 1

Defined in: libs/scene/src/scene/scene_node.ts:172

Draw local-space bounding box.

Inherited from

Camera.BBOXDRAW_LOCAL

BBOXDRAW_WORLD

readonly static BBOXDRAW_WORLD: 2 = 2

Defined in: libs/scene/src/scene/scene_node.ts:174

Draw world-space bounding box.

Inherited from

Camera.BBOXDRAW_WORLD

Accessors

disposed

Get Signature

get disposed(): boolean

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

Returns

boolean

Inherited from

Camera.disposed

compositor

Get Signature

get compositor(): Compositor

Defined in: libs/scene/src/camera/camera.ts:662

The compositor that owns and runs the camera's post-processing chain.

Returns

Compositor

Inherited from

Camera.compositor

interactionRect

Get Signature

get interactionRect(): [number, number, number, number]

Defined in: libs/scene/src/camera/camera.ts:668

Pointer interaction rectangle in css pixels (relative to canvas)

Returns

[number, number, number, number]

Set Signature

set interactionRect(rect): void

Defined in: libs/scene/src/camera/camera.ts:671

Parameters

rect

[number, number, number, number]

Returns

void

Inherited from

Camera.interactionRect

clearColor

Get Signature

get clearColor(): Vector4

Defined in: libs/scene/src/camera/camera.ts:677

Framebuffer clear color, or null to disable.

Returns

Vector4

Set Signature

set clearColor(v): void

Defined in: libs/scene/src/camera/camera.ts:680

Parameters

v

Vector4

Returns

void

Inherited from

Camera.clearColor

clearDepth

Get Signature

get clearDepth(): number

Defined in: libs/scene/src/camera/camera.ts:686

Framebuffer stencil clear value, disabled when null. Default is 0.

Returns

number

Set Signature

set clearDepth(v): void

Defined in: libs/scene/src/camera/camera.ts:689

Parameters

v

number

Returns

void

Inherited from

Camera.clearDepth

clearStencil

Get Signature

get clearStencil(): number

Defined in: libs/scene/src/camera/camera.ts:695

Framebuffer stencil clear value, disabled when null. Default is 0.

Returns

number

Set Signature

set clearStencil(v): void

Defined in: libs/scene/src/camera/camera.ts:698

Parameters

v

number

Returns

void

Inherited from

Camera.clearStencil

HiZ

Get Signature

get HiZ(): boolean

Defined in: libs/scene/src/camera/camera.ts:706

Whether Hi-Z acceleration is enabled.

Often improves SSR performance with little quality impact when supported.

Returns

boolean

Set Signature

set HiZ(val): void

Defined in: libs/scene/src/camera/camera.ts:709

Parameters

val

boolean

Returns

void

Inherited from

Camera.HiZ

HiZNearest

Get Signature

get HiZNearest(): boolean

Defined in: libs/scene/src/camera/camera.ts:725

Whether the Hi-Z pyramid carries its nearest-depth channel.

The pyramid's own channel answers "what is the farthest thing in this screen region", which is what occlusion and ray marching want; this one answers "what is the nearest", which is what a proximity query wants. It doubles the pyramid's bandwidth, so it is off unless something asks for it.

Materials that query it - water's shoreline foam - turn it on by themselves, the way a transmissive material turns on the scene colour copy, so this only has to be set to force the channel on for something the renderer cannot see coming. Ignored on WebGL1, which has no pyramid at all.

Returns

boolean

Set Signature

set HiZNearest(val): void

Defined in: libs/scene/src/camera/camera.ts:728

Parameters

val

boolean

Returns

void

Inherited from

Camera.HiZNearest

screenSpaceShadowMask

Get Signature

get screenSpaceShadowMask(): boolean

Defined in: libs/scene/src/camera/camera.ts:739

Whether the screen-space shadow mask is enabled.

When enabled, shadow-casting lights are lit through the clustered pass and sample a pre-rendered screen-space shadow mask instead of each casting an additional full-scene additive light pass. Requires the depth prepass (always on in Forward+).

Returns

boolean

Set Signature

set screenSpaceShadowMask(val): void

Defined in: libs/scene/src/camera/camera.ts:742

Parameters

val

boolean

Returns

void

Inherited from

Camera.screenSpaceShadowMask

renderPath

Get Signature

get renderPath(): "forward"

Defined in: libs/scene/src/camera/camera.ts:748

Render path used by the scene renderer.

Returns

"forward"

Set Signature

set renderPath(_val): void

Defined in: libs/scene/src/camera/camera.ts:751

Parameters

_val

"forward"

Returns

void

Inherited from

Camera.renderPath

HDR

Get Signature

get HDR(): boolean

Defined in: libs/scene/src/camera/camera.ts:759

Whether HDR backbuffer is enabled.

Tonemap should be disabled when not using HDR backbuffer.

Returns

boolean

Set Signature

set HDR(val): void

Defined in: libs/scene/src/camera/camera.ts:762

Parameters

val

boolean

Returns

void

Inherited from

Camera.HDR

toneMap

Get Signature

get toneMap(): boolean

Defined in: libs/scene/src/camera/camera.ts:768

Whether tonemapping is enabled via the post effect.

Returns

boolean

Set Signature

set toneMap(val): void

Defined in: libs/scene/src/camera/camera.ts:771

Parameters

val

boolean

Returns

void

Inherited from

Camera.toneMap

motionBlur

Get Signature

get motionBlur(): boolean

Defined in: libs/scene/src/camera/camera.ts:777

Whether motion blur is enabled via the post effect.

Returns

boolean

Set Signature

set motionBlur(val): void

Defined in: libs/scene/src/camera/camera.ts:780

Parameters

val

boolean

Returns

void

Inherited from

Camera.motionBlur

motionBlurStrength

Get Signature

get motionBlurStrength(): number

Defined in: libs/scene/src/camera/camera.ts:784

Motion blur strength

Returns

number

Set Signature

set motionBlurStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:787

Parameters

val

number

Returns

void

Inherited from

Camera.motionBlurStrength

motionBlurShutterBias

Get Signature

get motionBlurShutterBias(): number

Defined in: libs/scene/src/camera/camera.ts:798

How much of the motion blur streak lies ahead of where an object is now, as a fraction of its length. 0 trails the streak fully behind the object, 0.5 (the default) centres it. See MotionBlur.shutterBias.

Returns

number

Set Signature

set motionBlurShutterBias(val): void

Defined in: libs/scene/src/camera/camera.ts:801

Parameters

val

number

Returns

void

Inherited from

Camera.motionBlurShutterBias

motionBlurMaxLength

Get Signature

get motionBlurMaxLength(): number

Defined in: libs/scene/src/camera/camera.ts:815

Longest motion blur streak, in pixels at render resolution. This is the ceiling Camera.motionBlurStrength runs into; raising it costs samples in proportion. See MotionBlur.maxBlurLength.

Returns

number

Set Signature

set motionBlurMaxLength(val): void

Defined in: libs/scene/src/camera/camera.ts:818

Parameters

val

number

Returns

void

Inherited from

Camera.motionBlurMaxLength

bloom

Get Signature

get bloom(): boolean

Defined in: libs/scene/src/camera/camera.ts:830

Gets whether Bloom is enabled.

Returns

boolean

Set Signature

set bloom(val): void

Defined in: libs/scene/src/camera/camera.ts:833

Parameters

val

boolean

Returns

void

Inherited from

Camera.bloom

bloomMaxDownsampleLevels

Get Signature

get bloomMaxDownsampleLevels(): number

Defined in: libs/scene/src/camera/camera.ts:839

Maximum bloom downsample levels

Returns

number

Set Signature

set bloomMaxDownsampleLevels(val): void

Defined in: libs/scene/src/camera/camera.ts:842

Parameters

val

number

Returns

void

Inherited from

Camera.bloomMaxDownsampleLevels

bloomDownsampleLimit

Get Signature

get bloomDownsampleLimit(): number

Defined in: libs/scene/src/camera/camera.ts:851

Bloom downsample limit

Returns

number

Set Signature

set bloomDownsampleLimit(val): void

Defined in: libs/scene/src/camera/camera.ts:854

Parameters

val

number

Returns

void

Inherited from

Camera.bloomDownsampleLimit

bloomThreshold

Get Signature

get bloomThreshold(): number

Defined in: libs/scene/src/camera/camera.ts:863

Bloom threshold

Returns

number

Set Signature

set bloomThreshold(val): void

Defined in: libs/scene/src/camera/camera.ts:866

Parameters

val

number

Returns

void

Inherited from

Camera.bloomThreshold

bloomThresholdKnee

Get Signature

get bloomThresholdKnee(): number

Defined in: libs/scene/src/camera/camera.ts:875

Bloom threshold knee

Returns

number

Set Signature

set bloomThresholdKnee(val): void

Defined in: libs/scene/src/camera/camera.ts:878

Parameters

val

number

Returns

void

Inherited from

Camera.bloomThresholdKnee

bloomIntensity

Get Signature

get bloomIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:887

Bloom intensity

Returns

number

Set Signature

set bloomIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:890

Parameters

val

number

Returns

void

Inherited from

Camera.bloomIntensity

bloomFilterRadius

Get Signature

get bloomFilterRadius(): number

Defined in: libs/scene/src/camera/camera.ts:903

Radius of the tent filter used to upsample the bloom pyramid, in source texels.

Remarks

See Bloom.filterRadius. 1 is the natural width; raising it softens the halo but past ~2 the tent's taps stop overlapping and a grid pattern reappears.

Returns

number

Set Signature

set bloomFilterRadius(val): void

Defined in: libs/scene/src/camera/camera.ts:906

Parameters

val

number

Returns

void

Inherited from

Camera.bloomFilterRadius

bloomKarisAverage

Get Signature

get bloomKarisAverage(): boolean

Defined in: libs/scene/src/camera/camera.ts:919

Whether the first bloom downsample uses the Karis average to suppress fireflies.

Remarks

See Bloom.karisAverage. On by default; costs a little halo reach in exchange for stability on high-frequency speculars.

Returns

boolean

Set Signature

set bloomKarisAverage(val): void

Defined in: libs/scene/src/camera/camera.ts:922

Parameters

val

boolean

Returns

void

Inherited from

Camera.bloomKarisAverage

toneMapDither

Get Signature

get toneMapDither(): boolean

Defined in: libs/scene/src/camera/camera.ts:935

Whether tone mapping dithers its result before the 8-bit write.

Remarks

See Tonemap.dither. On by default; removes the banding shallow gradients such as bloom halos otherwise show once quantized. Turn it off for reproducible pixel captures.

Returns

boolean

Set Signature

set toneMapDither(val): void

Defined in: libs/scene/src/camera/camera.ts:938

Parameters

val

boolean

Returns

void

Inherited from

Camera.toneMapDither

colorAdjust

Get Signature

get colorAdjust(): boolean

Defined in: libs/scene/src/camera/camera.ts:942

Whether color adjustment is enabled.

Returns

boolean

Set Signature

set colorAdjust(val): void

Defined in: libs/scene/src/camera/camera.ts:945

Parameters

val

boolean

Returns

void

Inherited from

Camera.colorAdjust

colorAdjustSaturation

Get Signature

get colorAdjustSaturation(): number

Defined in: libs/scene/src/camera/camera.ts:949

Color adjustment saturation, 1 means unchanged.

Returns

number

Set Signature

set colorAdjustSaturation(val): void

Defined in: libs/scene/src/camera/camera.ts:952

Parameters

val

number

Returns

void

Inherited from

Camera.colorAdjustSaturation

colorAdjustContrast

Get Signature

get colorAdjustContrast(): number

Defined in: libs/scene/src/camera/camera.ts:959

Color adjustment contrast, 1 means unchanged.

Returns

number

Set Signature

set colorAdjustContrast(val): void

Defined in: libs/scene/src/camera/camera.ts:962

Parameters

val

number

Returns

void

Inherited from

Camera.colorAdjustContrast

colorAdjustHue

Get Signature

get colorAdjustHue(): number

Defined in: libs/scene/src/camera/camera.ts:969

Color adjustment hue in degrees.

Returns

number

Set Signature

set colorAdjustHue(val): void

Defined in: libs/scene/src/camera/camera.ts:972

Parameters

val

number

Returns

void

Inherited from

Camera.colorAdjustHue

colorAdjustSharpen

Get Signature

get colorAdjustSharpen(): number

Defined in: libs/scene/src/camera/camera.ts:979

Color adjustment sharpen amount, 0 means disabled.

Returns

number

Set Signature

set colorAdjustSharpen(val): void

Defined in: libs/scene/src/camera/camera.ts:982

Parameters

val

number

Returns

void

Inherited from

Camera.colorAdjustSharpen

FXAA

Get Signature

get FXAA(): boolean

Defined in: libs/scene/src/camera/camera.ts:991

Gets whether FXAA is enabled.

Returns

boolean

Set Signature

set FXAA(val): void

Defined in: libs/scene/src/camera/camera.ts:994

Parameters

val

boolean

Returns

void

Inherited from

Camera.FXAA

toneMapExposure

Get Signature

get toneMapExposure(): number

Defined in: libs/scene/src/camera/camera.ts:1000

Tonemap exposure

Returns

number

Set Signature

set toneMapExposure(val): void

Defined in: libs/scene/src/camera/camera.ts:1003

Parameters

val

number

Returns

void

Inherited from

Camera.toneMapExposure

aperture

Get Signature

get aperture(): number

Defined in: libs/scene/src/camera/camera.ts:1009

Lens aperture as an f-number.

Returns

number

Set Signature

set aperture(val): void

Defined in: libs/scene/src/camera/camera.ts:1012

Parameters

val

number

Returns

void

Inherited from

Camera.aperture

shutterSpeed

Get Signature

get shutterSpeed(): number

Defined in: libs/scene/src/camera/camera.ts:1016

Shutter-open time in seconds.

Returns

number

Set Signature

set shutterSpeed(val): void

Defined in: libs/scene/src/camera/camera.ts:1019

Parameters

val

number

Returns

void

Inherited from

Camera.shutterSpeed

ISO

Get Signature

get ISO(): number

Defined in: libs/scene/src/camera/camera.ts:1023

Sensor sensitivity in ISO units.

Returns

number

Set Signature

set ISO(val): void

Defined in: libs/scene/src/camera/camera.ts:1026

Parameters

val

number

Returns

void

Inherited from

Camera.ISO

exposureCompensation

Get Signature

get exposureCompensation(): number

Defined in: libs/scene/src/camera/camera.ts:1030

Exposure compensation in stops (EV).

Returns

number

Set Signature

set exposureCompensation(val): void

Defined in: libs/scene/src/camera/camera.ts:1033

Parameters

val

number

Returns

void

Inherited from

Camera.exposureCompensation

EV100

Get Signature

get EV100(): number

Defined in: libs/scene/src/camera/camera.ts:1037

Photographic EV100 calculated from aperture, shutter time and ISO.

Returns

number

Inherited from

Camera.EV100

exposure

Get Signature

get exposure(): number

Defined in: libs/scene/src/camera/camera.ts:1041

Scene-linear physical exposure multiplier, including exposure compensation.

Returns

number

Inherited from

Camera.exposure

TAA

Get Signature

get TAA(): boolean

Defined in: libs/scene/src/camera/camera.ts:1052

Gets whether TAA is enabled.

Returns

boolean

Set Signature

set TAA(val): void

Defined in: libs/scene/src/camera/camera.ts:1055

Parameters

val

boolean

Returns

void

Inherited from

Camera.TAA

TAADebug

Get Signature

get TAADebug(): number

Defined in: libs/scene/src/camera/camera.ts:1061

Gets the debug flag for TAA

Returns

number

Set Signature

set TAADebug(val): void

Defined in: libs/scene/src/camera/camera.ts:1064

Parameters

val

number

Returns

void

Inherited from

Camera.TAADebug

shadowDebugCascades

Get Signature

get shadowDebugCascades(): boolean

Defined in: libs/scene/src/camera/camera.ts:1070

Enables cascade debug visualization for directional shadows.

Returns

boolean

Set Signature

set shadowDebugCascades(val): void

Defined in: libs/scene/src/camera/camera.ts:1073

Parameters

val

boolean

Returns

void

Inherited from

Camera.shadowDebugCascades

SSR

Get Signature

get SSR(): boolean

Defined in: libs/scene/src/camera/camera.ts:1079

Gets whether Screen Space Reflections (SSR) is enabled.

Returns

boolean

Set Signature

set SSR(val): void

Defined in: libs/scene/src/camera/camera.ts:1082

Parameters

val

boolean

Returns

void

Inherited from

Camera.SSR

SSGI

Get Signature

get SSGI(): boolean

Defined in: libs/scene/src/camera/camera.ts:1086

Gets whether Screen Space Global Illumination is enabled for this camera.

Returns

boolean

Set Signature

set SSGI(val): void

Defined in: libs/scene/src/camera/camera.ts:1089

Parameters

val

boolean

Returns

void

Inherited from

Camera.SSGI

ssgiQualityPreset

Get Signature

get ssgiQualityPreset(): SSGIQualityPreset

Defined in: libs/scene/src/camera/camera.ts:1097

High-level SSGI trace and denoise quality preset.

Returns

SSGIQualityPreset

Set Signature

set ssgiQualityPreset(val): void

Defined in: libs/scene/src/camera/camera.ts:1100

Parameters

val

SSGIQualityPreset

Returns

void

Inherited from

Camera.ssgiQualityPreset

ssgiResolvedSettings

Get Signature

get ssgiResolvedSettings(): Readonly<SSGIResolvedSettings>

Defined in: libs/scene/src/camera/camera.ts:1111

Resolved trace and denoise settings for the current SSGI preset.

Returns

Readonly<SSGIResolvedSettings>

Inherited from

Camera.ssgiResolvedSettings

ssgiHalfResolution

Get Signature

get ssgiHalfResolution(): boolean

Defined in: libs/scene/src/camera/camera.ts:1115

Whether the custom SSGI trace runs at half resolution.

Returns

boolean

Set Signature

set ssgiHalfResolution(val): void

Defined in: libs/scene/src/camera/camera.ts:1118

Parameters

val

boolean

Returns

void

Inherited from

Camera.ssgiHalfResolution

ssgiRaysPerPixel

Get Signature

get ssgiRaysPerPixel(): number

Defined in: libs/scene/src/camera/camera.ts:1122

Number of diffuse rays traced per pixel by the custom SSGI preset.

Returns

number

Set Signature

set ssgiRaysPerPixel(val): void

Defined in: libs/scene/src/camera/camera.ts:1125

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiRaysPerPixel

ssgiMaxSteps

Get Signature

get ssgiMaxSteps(): number

Defined in: libs/scene/src/camera/camera.ts:1131

Maximum screen-space ray-march iterations used by the custom SSGI preset.

Returns

number

Set Signature

set ssgiMaxSteps(val): void

Defined in: libs/scene/src/camera/camera.ts:1134

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiMaxSteps

ssgiDenoisePasses

Get Signature

get ssgiDenoisePasses(): number

Defined in: libs/scene/src/camera/camera.ts:1140

Number of cross-bilateral a-trous passes used by the custom SSGI preset.

Returns

number

Set Signature

set ssgiDenoisePasses(val): void

Defined in: libs/scene/src/camera/camera.ts:1143

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiDenoisePasses

ssgiIntensity

Get Signature

get ssgiIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:1149

SSGI diffuse irradiance multiplier.

Returns

number

Set Signature

set ssgiIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:1152

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiIntensity

ssgiSkyOcclusion

Get Signature

get ssgiSkyOcclusion(): number

Defined in: libs/scene/src/camera/camera.ts:1171

How much environment irradiance an occluding hit removes, in [0, 1].

A screen-space ray that hits geometry blocks the sky for that direction. At 1 the environment contribution is removed in full, which is what produces sky occlusion in interiors and corners; lower values dim the sky less than the geometry implies, for art direction or to compensate for the hemisphere a screen-space trace cannot see. Only the removal is scaled — bounce light measured at the hit is always kept, so lowering this brightens without ever discarding indirect light. Camera.ssgiIntensity still bounds how dark the result can get, so full occlusion also needs an intensity of 1.

Returns

number

Set Signature

set ssgiSkyOcclusion(val): void

Defined in: libs/scene/src/camera/camera.ts:1174

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiSkyOcclusion

ssgiAOIntensity

Get Signature

get ssgiAOIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:1195

How strongly the ambient occlusion traced alongside SSGI darkens the scene, in [0, 1]. 0 disables the composite entirely.

The occlusion comes from the same rays that produce the irradiance, at no extra trace cost, and is multiplied into the final opaque color — the same semantics the standalone SAO post effect applies. Enabling both at once therefore darkens twice. Its range is the SSGI trace range (Camera.ssgiMaxDistance), so this is long-range occlusion rather than the small-radius contact darkening a dedicated AO pass produces.

Defaults to 0.8 rather than 1: SSGI irradiance already has sky occlusion subtracted, so diffuse is partly occluded before this multiply is applied.

Returns

number

Set Signature

set ssgiAOIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:1198

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiAOIntensity

ssgiAOPower

Get Signature

get ssgiAOPower(): number

Defined in: libs/scene/src/camera/camera.ts:1207

Contrast curve applied to the SSGI ambient occlusion before it is composited.

Values above 1 deepen the occluded regions, below 1 lift them. Purely an art direction control on an already-traced quantity.

Returns

number

Set Signature

set ssgiAOPower(val): void

Defined in: libs/scene/src/camera/camera.ts:1210

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiAOPower

ssgiMaxDistance

Get Signature

get ssgiMaxDistance(): number

Defined in: libs/scene/src/camera/camera.ts:1214

Maximum SSGI ray length in view-space units.

Returns

number

Set Signature

set ssgiMaxDistance(val): void

Defined in: libs/scene/src/camera/camera.ts:1217

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiMaxDistance

ssgiThickness

Get Signature

get ssgiThickness(): number

Defined in: libs/scene/src/camera/camera.ts:1225

Depth thickness used by screen-space ray intersection tests.

Returns

number

Set Signature

set ssgiThickness(val): void

Defined in: libs/scene/src/camera/camera.ts:1228

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiThickness

ssgiStride

Get Signature

get ssgiStride(): number

Defined in: libs/scene/src/camera/camera.ts:1236

Pixel stride used by the WebGL linear ray marcher.

Returns

number

Set Signature

set ssgiStride(val): void

Defined in: libs/scene/src/camera/camera.ts:1239

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiStride

ssgiMaxRayIntensity

Get Signature

get ssgiMaxRayIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:1247

Maximum per-ray radiance before temporal accumulation (firefly clamp).

Returns

number

Set Signature

set ssgiMaxRayIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:1250

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiMaxRayIntensity

ssgiTemporal

Get Signature

get ssgiTemporal(): boolean

Defined in: libs/scene/src/camera/camera.ts:1258

Whether SSGI temporal accumulation is enabled. Has no effect on WebGL1, which has no motion vectors.

Returns

boolean

Set Signature

set ssgiTemporal(val): void

Defined in: libs/scene/src/camera/camera.ts:1261

Parameters

val

boolean

Returns

void

Inherited from

Camera.ssgiTemporal

ssgiTemporalWeight

Get Signature

get ssgiTemporalWeight(): number

Defined in: libs/scene/src/camera/camera.ts:1269

Weight assigned to valid reprojected SSGI history.

Returns

number

Set Signature

set ssgiTemporalWeight(val): void

Defined in: libs/scene/src/camera/camera.ts:1272

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiTemporalWeight

ssgiDepthReject

Get Signature

get ssgiDepthReject(): number

Defined in: libs/scene/src/camera/camera.ts:1276

Relative linear-depth rejection threshold for SSGI reprojection.

Returns

number

Set Signature

set ssgiDepthReject(val): void

Defined in: libs/scene/src/camera/camera.ts:1279

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiDepthReject

ssgiNormalReject

Get Signature

get ssgiNormalReject(): number

Defined in: libs/scene/src/camera/camera.ts:1283

Minimum world-normal dot product accepted by SSGI reprojection.

Returns

number

Set Signature

set ssgiNormalReject(val): void

Defined in: libs/scene/src/camera/camera.ts:1286

Parameters

val

number

Returns

void

Inherited from

Camera.ssgiNormalReject

ssrMaxRoughness

Get Signature

get ssrMaxRoughness(): number

Defined in: libs/scene/src/camera/camera.ts:1293

Gets the maximum roughness value for screen space reflections. Controls the cutoff point where surfaces are considered too rough for SSR.

Returns

number

Set Signature

set ssrMaxRoughness(val): void

Defined in: libs/scene/src/camera/camera.ts:1296

Parameters

val

number

Returns

void

Inherited from

Camera.ssrMaxRoughness

ssrRoughnessFactor

Get Signature

get ssrRoughnessFactor(): number

Defined in: libs/scene/src/camera/camera.ts:1303

Gets the roughness factor for SSR calculations. Affects how surface roughness influences reflection clarity.

Returns

number

Set Signature

set ssrRoughnessFactor(val): void

Defined in: libs/scene/src/camera/camera.ts:1306

Parameters

val

number

Returns

void

Inherited from

Camera.ssrRoughnessFactor

ssrStride

Get Signature

get ssrStride(): number

Defined in: libs/scene/src/camera/camera.ts:1313

Gets the stride value for SSR ray marching. Controls the step size during ray marching. Larger values improve performance but may miss details.

Returns

number

Set Signature

set ssrStride(val): void

Defined in: libs/scene/src/camera/camera.ts:1316

Parameters

val

number

Returns

void

Inherited from

Camera.ssrStride

ssrMaxDistance

Get Signature

get ssrMaxDistance(): number

Defined in: libs/scene/src/camera/camera.ts:1323

Gets the maximum distance for SSR ray marching. Defines how far rays will travel when searching for reflection intersections.

Returns

number

Set Signature

set ssrMaxDistance(val): void

Defined in: libs/scene/src/camera/camera.ts:1326

Parameters

val

number

Returns

void

Inherited from

Camera.ssrMaxDistance

ssrIterations

Get Signature

get ssrIterations(): number

Defined in: libs/scene/src/camera/camera.ts:1333

Gets the number of iterations for SSR ray marching. Higher values provide more accurate reflections but impact performance.

Returns

number

Set Signature

set ssrIterations(val): void

Defined in: libs/scene/src/camera/camera.ts:1336

Parameters

val

number

Returns

void

Inherited from

Camera.ssrIterations

ssrThickness

Get Signature

get ssrThickness(): number

Defined in: libs/scene/src/camera/camera.ts:1343

Gets the thickness value for SSR calculations. Determines the thickness threshold for surfaces when calculating reflections.

Returns

number

Set Signature

set ssrThickness(val): void

Defined in: libs/scene/src/camera/camera.ts:1346

Parameters

val

number

Returns

void

Inherited from

Camera.ssrThickness

ssrCalcThickness

Get Signature

get ssrCalcThickness(): boolean

Defined in: libs/scene/src/camera/camera.ts:1353

Gets whether SSR should calculate thickness automatically. When enabled, the system will dynamically compute surface thickness for reflections.

Returns

boolean

Set Signature

set ssrCalcThickness(val): void

Defined in: libs/scene/src/camera/camera.ts:1356

Parameters

val

boolean

Returns

void

Inherited from

Camera.ssrCalcThickness

ssrBlurScale

Get Signature

get ssrBlurScale(): number

Defined in: libs/scene/src/camera/camera.ts:1363

Gets the blur scale factor for SSR. Controls the overall intensity of the blur effect applied to reflections.

Returns

number

Set Signature

set ssrBlurScale(val): void

Defined in: libs/scene/src/camera/camera.ts:1366

Parameters

val

number

Returns

void

Inherited from

Camera.ssrBlurScale

ssrBlurDepthCutoff

Get Signature

get ssrBlurDepthCutoff(): number

Defined in: libs/scene/src/camera/camera.ts:1373

Gets the depth cutoff value for SSR blur. Determines at what depth difference the blur effect should be reduced or eliminated.

Returns

number

Set Signature

set ssrBlurDepthCutoff(val): void

Defined in: libs/scene/src/camera/camera.ts:1376

Parameters

val

number

Returns

void

Inherited from

Camera.ssrBlurDepthCutoff

ssrBlurKernelSize

Get Signature

get ssrBlurKernelSize(): number

Defined in: libs/scene/src/camera/camera.ts:1383

Gets the kernel size for the SSR blur effect. Defines the size of the blur kernel. Larger values create softer, more spread-out blur.

Returns

number

Set Signature

set ssrBlurKernelSize(val): void

Defined in: libs/scene/src/camera/camera.ts:1386

Parameters

val

number

Returns

void

Inherited from

Camera.ssrBlurKernelSize

ssrBlurStdDev

Get Signature

get ssrBlurStdDev(): number

Defined in: libs/scene/src/camera/camera.ts:1393

Gets the standard deviation for the SSR Gaussian blur. Controls the distribution of the blur effect. Higher values create more pronounced blur.

Returns

number

Set Signature

set ssrBlurStdDev(val): void

Defined in: libs/scene/src/camera/camera.ts:1396

Parameters

val

number

Returns

void

Inherited from

Camera.ssrBlurStdDev

ssrTemporal

Get Signature

get ssrTemporal(): boolean

Defined in: libs/scene/src/camera/camera.ts:1402

Gets whether SSR temporal accumulation is enabled.

Returns

boolean

Set Signature

set ssrTemporal(val): void

Defined in: libs/scene/src/camera/camera.ts:1405

Parameters

val

boolean

Returns

void

Inherited from

Camera.ssrTemporal

ssrTemporalWeight

Get Signature

get ssrTemporalWeight(): number

Defined in: libs/scene/src/camera/camera.ts:1412

Gets SSR temporal blending weight in [0, 1]. Higher values rely more on reprojected history.

Returns

number

Set Signature

set ssrTemporalWeight(val): void

Defined in: libs/scene/src/camera/camera.ts:1415

Parameters

val

number

Returns

void

Inherited from

Camera.ssrTemporalWeight

SSS

Get Signature

get SSS(): boolean

Defined in: libs/scene/src/camera/camera.ts:1421

Gets whether Screen Space Subsurface Scattering (SSS) is enabled.

Returns

boolean

Set Signature

set SSS(val): void

Defined in: libs/scene/src/camera/camera.ts:1424

Parameters

val

boolean

Returns

void

Inherited from

Camera.SSS

sssBlurScale

Get Signature

get sssBlurScale(): number

Defined in: libs/scene/src/camera/camera.ts:1428

Global blur scale for screen-space SSS.

Returns

number

Set Signature

set sssBlurScale(val): void

Defined in: libs/scene/src/camera/camera.ts:1431

Parameters

val

number

Returns

void

Inherited from

Camera.sssBlurScale

sssQualityPreset

Get Signature

get sssQualityPreset(): SSSQualityPreset

Defined in: libs/scene/src/camera/camera.ts:1440

High-level quality preset for SSS blur controls.

This is the primary user-facing SSS quality control and only affects the blur sampling quality/performance tradeoff, not the authored look.

Returns

SSSQualityPreset

Set Signature

set sssQualityPreset(val): void

Defined in: libs/scene/src/camera/camera.ts:1443

Parameters

val

SSSQualityPreset

Returns

void

Inherited from

Camera.sssQualityPreset

sssStrength

Get Signature

get sssStrength(): number

Defined in: libs/scene/src/camera/camera.ts:1451

Final SSS composite strength.

Returns

number

Set Signature

set sssStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:1454

Parameters

val

number

Returns

void

Inherited from

Camera.sssStrength

sssTransmissionStrength

Get Signature

get sssTransmissionStrength(): number

Defined in: libs/scene/src/camera/camera.ts:1458

Thin-shell transmission strength.

Returns

number

Set Signature

set sssTransmissionStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:1461

Parameters

val

number

Returns

void

Inherited from

Camera.sssTransmissionStrength

sssTransmissionPower

Get Signature

get sssTransmissionPower(): number

Defined in: libs/scene/src/camera/camera.ts:1465

Thin-shell transmission exponent.

Returns

number

Set Signature

set sssTransmissionPower(val): void

Defined in: libs/scene/src/camera/camera.ts:1468

Parameters

val

number

Returns

void

Inherited from

Camera.sssTransmissionPower

sssMultiScatter

Get Signature

get sssMultiScatter(): number

Defined in: libs/scene/src/camera/camera.ts:1472

Multi-scatter energy compensation factor.

Returns

number

Set Signature

set sssMultiScatter(val): void

Defined in: libs/scene/src/camera/camera.ts:1475

Parameters

val

number

Returns

void

Inherited from

Camera.sssMultiScatter

sssResolvedSettings

Get Signature

get sssResolvedSettings(): Readonly<SSSResolvedSettings>

Defined in: libs/scene/src/camera/camera.ts:1479

Resolved SSS blur settings after applying the quality preset.

Returns

Readonly<SSSResolvedSettings>

Inherited from

Camera.sssResolvedSettings

sssDebugView

Get Signature

get sssDebugView(): SSSDebugView

Defined in: libs/scene/src/camera/camera.ts:1483

Debug visualization for screen-space SSS buffers.

Returns

SSSDebugView

Set Signature

set sssDebugView(val): void

Defined in: libs/scene/src/camera/camera.ts:1486

Parameters

val

SSSDebugView

Returns

void

Inherited from

Camera.sssDebugView

skinSSS

Get Signature

get skinSSS(): boolean

Defined in: libs/scene/src/camera/camera.ts:1490

Gets whether the dedicated Skin SSS post effect is enabled.

Returns

boolean

Set Signature

set skinSSS(val): void

Defined in: libs/scene/src/camera/camera.ts:1493

Parameters

val

boolean

Returns

void

Inherited from

Camera.skinSSS

skinSSSStrength

Get Signature

get skinSSSStrength(): number

Defined in: libs/scene/src/camera/camera.ts:1497

Final blend strength for the dedicated Skin SSS post effect.

Returns

number

Set Signature

set skinSSSStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:1500

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSStrength

skinSSSOpacity

Get Signature

get skinSSSOpacity(): number

Defined in: libs/scene/src/camera/camera.ts:1507

Bias subtracted from the blurred skin mask before compositing.

Returns

number

Set Signature

set skinSSSOpacity(val): void

Defined in: libs/scene/src/camera/camera.ts:1510

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSOpacity

skinSSSSampleStep

Get Signature

get skinSSSSampleStep(): number

Defined in: libs/scene/src/camera/camera.ts:1517

Maximum pixel spacing between blur taps. Caps the projected scatter radius for close-ups.

Returns

number

Set Signature

set skinSSSSampleStep(val): void

Defined in: libs/scene/src/camera/camera.ts:1520

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSSampleStep

skinSSSScatterRadius

Get Signature

get skinSSSScatterRadius(): number

Defined in: libs/scene/src/camera/camera.ts:1527

World-space scatter radius. The blur width shrinks with distance to keep this constant.

Returns

number

Set Signature

set skinSSSScatterRadius(val): void

Defined in: libs/scene/src/camera/camera.ts:1530

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSScatterRadius

skinSSSSmoothness

Get Signature

get skinSSSSmoothness(): number

Defined in: libs/scene/src/camera/camera.ts:1537

Skin smoothing ("beauty filter") amount for the dedicated Skin SSS post effect.

Returns

number

Set Signature

set skinSSSSmoothness(val): void

Defined in: libs/scene/src/camera/camera.ts:1540

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSSmoothness

skinSSSDepthScale

Get Signature

get skinSSSDepthScale(): number

Defined in: libs/scene/src/camera/camera.ts:1547

Depth rejection scale. The reference shader uses 80.

Returns

number

Set Signature

set skinSSSDepthScale(val): void

Defined in: libs/scene/src/camera/camera.ts:1550

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSDepthScale

skinSSSColorBoost

Get Signature

get skinSSSColorBoost(): number

Defined in: libs/scene/src/camera/camera.ts:1557

Multiplier applied to the blurred skin lighting multiplier before compositing.

Returns

number

Set Signature

set skinSSSColorBoost(val): void

Defined in: libs/scene/src/camera/camera.ts:1560

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSColorBoost

skinSSSGlow

Get Signature

get skinSSSGlow(): number

Defined in: libs/scene/src/camera/camera.ts:1576

Additive, deliberately non-conserving bleed for the Skin SSS post effect.

Remarks

0 (the default) keeps the effect energy conserving: light added to the dark side of the terminator is light removed from the lit side. Raising it adds the diffused term again without subtracting anything, for skin that reads as lit from within; around 1 approximates the look the effect had before it conserved energy.

Returns

number

Set Signature

set skinSSSGlow(val): void

Defined in: libs/scene/src/camera/camera.ts:1579

Parameters

val

number

Returns

void

Inherited from

Camera.skinSSSGlow

skinSSSProfilePreset

Get Signature

get skinSSSProfilePreset(): SubsurfaceProfilePreset

Defined in: libs/scene/src/camera/camera.ts:1598

Subsurface profile preset driving the Skin SSS per-channel scatter radii.

Remarks

The ratio between the red, green and blue radii is what gives a scattering surface its character - red travels furthest in skin, which is the red-to-yellow gradient at the terminator. Switching presets changes that ratio, so wax and jade are the same code path rather than special cases; Camera.skinSSSScatterRadius still sets how far the light reaches.

Applies to the whole pass. Per-material profiles need the profile-slot path used by SSS instead.

Returns

SubsurfaceProfilePreset

Set Signature

set skinSSSProfilePreset(val): void

Defined in: libs/scene/src/camera/camera.ts:1601

Parameters

val

SubsurfaceProfilePreset

Returns

void

Inherited from

Camera.skinSSSProfilePreset

skinSSSScatterTint

Get Signature

get skinSSSScatterTint(): Vector4

Defined in: libs/scene/src/camera/camera.ts:1631

Tint applied to the light the Skin SSS post effect redistributes.

Remarks

White (the default) leaves the effect energy conserving. Because it multiplies only the difference between the diffused and original diffuse, a warm tint colors the terminator without washing the whole surface.

Returns

Vector4

Set Signature

set skinSSSScatterTint(val): void

Defined in: libs/scene/src/camera/camera.ts:1634

Parameters

val

Vector4

Returns

void

Inherited from

Camera.skinSSSScatterTint

SSAO

Get Signature

get SSAO(): boolean

Defined in: libs/scene/src/camera/camera.ts:1647

Gets whether SSAO is enabled.

Returns

boolean

Set Signature

set SSAO(val): void

Defined in: libs/scene/src/camera/camera.ts:1650

Parameters

val

boolean

Returns

void

Inherited from

Camera.SSAO

SSAOOcclusionRadius

Get Signature

get SSAOOcclusionRadius(): number

Defined in: libs/scene/src/camera/camera.ts:1660

SSAO occlusion radius, in world units (metres).

Remarks

Replaces the old SSAOScale, which was a far-plane-relative multiplier and carried no physical meaning.

Returns

number

Set Signature

set SSAOOcclusionRadius(val): void

Defined in: libs/scene/src/camera/camera.ts:1663

Parameters

val

number

Returns

void

Inherited from

Camera.SSAOOcclusionRadius

SSAOBias

Get Signature

get SSAOBias(): number

Defined in: libs/scene/src/camera/camera.ts:1670

SSAO bias

Returns

number

Set Signature

set SSAOBias(val): void

Defined in: libs/scene/src/camera/camera.ts:1673

Parameters

val

number

Returns

void

Inherited from

Camera.SSAOBias

SSAOIntensity

Get Signature

get SSAOIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:1680

SSAO intensity

Returns

number

Set Signature

set SSAOIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:1683

Parameters

val

number

Returns

void

Inherited from

Camera.SSAOIntensity

SSAOBlurDepthCutoff

Get Signature

get SSAOBlurDepthCutoff(): number

Defined in: libs/scene/src/camera/camera.ts:1690

SSAO depth cutoff

Returns

number

Set Signature

set SSAOBlurDepthCutoff(val): void

Defined in: libs/scene/src/camera/camera.ts:1693

Parameters

val

number

Returns

void

Inherited from

Camera.SSAOBlurDepthCutoff

depthPrePass

Get Signature

get depthPrePass(): boolean

Defined in: libs/scene/src/camera/camera.ts:1700

Whether to perform a depth pass

Returns

boolean

Set Signature

set depthPrePass(val): void

Defined in: libs/scene/src/camera/camera.ts:1703

Parameters

val

boolean

Returns

void

Inherited from

Camera.depthPrePass

commandBufferReuse

Get Signature

get commandBufferReuse(): boolean

Defined in: libs/scene/src/camera/camera.ts:1707

Whether to allow command buffer reuse optimization

Returns

boolean

Set Signature

set commandBufferReuse(val): void

Defined in: libs/scene/src/camera/camera.ts:1710

Parameters

val

boolean

Returns

void

Inherited from

Camera.commandBufferReuse

adapted

Get Signature

get adapted(): boolean

Defined in: libs/scene/src/camera/camera.ts:1714

Whether this camera is adapted to screen settins

Returns

boolean

Set Signature

set adapted(val): void

Defined in: libs/scene/src/camera/camera.ts:1717

Parameters

val

boolean

Returns

void

Inherited from

Camera.adapted

oit

Get Signature

get oit(): OIT

Defined in: libs/scene/src/camera/camera.ts:1726

OIT

Returns

OIT

Set Signature

set oit(val): void

Defined in: libs/scene/src/camera/camera.ts:1729

Parameters

val

OIT

Returns

void

Inherited from

Camera.oit

oitMode

Get Signature

get oitMode(): CameraOITMode

Defined in: libs/scene/src/camera/camera.ts:1737

OIT mode

Returns

CameraOITMode

Set Signature

set oitMode(val): void

Defined in: libs/scene/src/camera/camera.ts:1740

Parameters

val

CameraOITMode

Returns

void

Inherited from

Camera.oitMode

oitABufferLayers

Get Signature

get oitABufferLayers(): number

Defined in: libs/scene/src/camera/camera.ts:1748

ABuffer OIT layer budget.

Returns

number

Set Signature

set oitABufferLayers(val): void

Defined in: libs/scene/src/camera/camera.ts:1751

Parameters

val

number

Returns

void

Inherited from

Camera.oitABufferLayers

oitDualDepthPeels

Get Signature

get oitDualDepthPeels(): number

Defined in: libs/scene/src/camera/camera.ts:1761

Dual depth peeling OIT peel iteration count.

Returns

number

Set Signature

set oitDualDepthPeels(val): void

Defined in: libs/scene/src/camera/camera.ts:1764

Parameters

val

number

Returns

void

Inherited from

Camera.oitDualDepthPeels

clipMask

Get Signature

get clipMask(): number

Defined in: libs/scene/src/camera/camera.ts:1777

Clip plane mask

Returns

number

Set Signature

set clipMask(val): void

Defined in: libs/scene/src/camera/camera.ts:1780

Parameters

val

number

Returns

void

Inherited from

Camera.clipMask

viewport

Get Signature

get viewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1784

Viewport used for rendering, if null, use full framebuffer size

Returns

readonly number[]

Set Signature

set viewport(rect): void

Defined in: libs/scene/src/camera/camera.ts:1793

Parameters

rect

readonly number[]

Returns

void

Inherited from

Camera.viewport

scissor

Get Signature

get scissor(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1797

Scissor rectangle used for rendering, if null, use viewport value

Returns

readonly number[]

Set Signature

set scissor(rect): void

Defined in: libs/scene/src/camera/camera.ts:1800

Parameters

rect

readonly number[]

Returns

void

Inherited from

Camera.scissor

relativeViewport

Get Signature

get relativeViewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1803

Returns

readonly number[]

Inherited from

Camera.relativeViewport

screenConfig

Get Signature

get screenConfig(): Immutable<ScreenConfig>

Defined in: libs/scene/src/camera/camera.ts:1815

Screen configuration used for adapting the camera viewport

Returns

Immutable<ScreenConfig>

Set Signature

set screenConfig(config): void

Defined in: libs/scene/src/camera/camera.ts:1818

Parameters

config

Immutable<ScreenConfig>

Returns

void

Inherited from

Camera.screenConfig

screenViewport

Get Signature

get screenViewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1824

Screen viewport used for adapting the camera viewport

Returns

readonly number[]

Set Signature

set screenViewport(viewport): void

Defined in: libs/scene/src/camera/camera.ts:1827

Parameters

viewport

readonly number[]

Returns

void

Inherited from

Camera.screenViewport

viewMatrix

Get Signature

get viewMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1993

View matrix of the camera

Remarks

Camera's view matrix will transform a point from the world space to the camera space

Returns

Immutable<Matrix4x4>

Inherited from

Camera.viewMatrix

viewProjectionMatrix

Get Signature

get viewProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1999

Returns

Immutable<Matrix4x4>

Inherited from

Camera.viewProjectionMatrix

invViewProjectionMatrix

Get Signature

get invViewProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:2011

The inverse-view-projection matrix of the camera

Remarks

The inverse-view-projection matrix transforms a point from the clip space to the camera space

Returns

Immutable<Matrix4x4>

Inherited from

Camera.invViewProjectionMatrix

frustum

Get Signature

get frustum(): Immutable<Frustum>

Defined in: libs/scene/src/camera/camera.ts:2018

Gets the frustum of the camera

Returns

Immutable<Frustum>

Inherited from

Camera.frustum

frustumViewSpace

Get Signature

get frustumViewSpace(): Immutable<Frustum>

Defined in: libs/scene/src/camera/camera.ts:2024

Returns

Immutable<Frustum>

Inherited from

Camera.frustumViewSpace

controller

Get Signature

get controller(): BaseCameraController

Defined in: libs/scene/src/camera/camera.ts:2034

The camera controller

Returns

BaseCameraController

Set Signature

set controller(controller): void

Defined in: libs/scene/src/camera/camera.ts:2037

Parameters

controller

BaseCameraController

Returns

void

Inherited from

Camera.controller

renderPipeline

Get Signature

get renderPipeline(): RenderPipeline<FrameGraphContext>

Defined in: libs/scene/src/camera/camera.ts:2461

The render pipeline that assembles this camera's frame graph. When null (the default), the shared default Forward+ pipeline is used. Assign a customized pipeline to override rendering for this camera only, e.g. camera.renderPipeline = createForwardPlusPipeline().insertAfter('SkyPass', myModule).

Returns

RenderPipeline<FrameGraphContext>

Set Signature

set renderPipeline(pipeline): void

Defined in: libs/scene/src/camera/camera.ts:2464

Parameters

pipeline

RenderPipeline<FrameGraphContext>

Returns

void

Inherited from

Camera.renderPipeline

window

Get Signature

get window(): readonly number[]

Defined in: libs/scene/src/camera/orthocamera.ts:41

Sub-window of the frustum

Returns

readonly number[]

Set Signature

set window(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:44

Parameters

val

readonly number[]

Returns

void

near

Get Signature

get near(): number

Defined in: libs/scene/src/camera/orthocamera.ts:49

The near clip plane

Returns

number

Set Signature

set near(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:52

Parameters

val

number

Returns

void

far

Get Signature

get far(): number

Defined in: libs/scene/src/camera/orthocamera.ts:59

The far clip plane

Returns

number

Set Signature

set far(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:62

Parameters

val

number

Returns

void

left

Get Signature

get left(): number

Defined in: libs/scene/src/camera/orthocamera.ts:69

The left clip plane

Returns

number

Set Signature

set left(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:72

Parameters

val

number

Returns

void

right

Get Signature

get right(): number

Defined in: libs/scene/src/camera/orthocamera.ts:79

The right clip plane

Returns

number

Set Signature

set right(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:82

Parameters

val

number

Returns

void

top

Get Signature

get top(): number

Defined in: libs/scene/src/camera/orthocamera.ts:89

The top clip plane

Returns

number

Set Signature

set top(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:92

Parameters

val

number

Returns

void

bottom

Get Signature

get bottom(): number

Defined in: libs/scene/src/camera/orthocamera.ts:99

The bottom clip plane

Returns

number

Set Signature

set bottom(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:102

Parameters

val

number

Returns

void

placeToOctree

Get Signature

get placeToOctree(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:317

Whether the node should be inserted into the scene's spatial structure.

Remarks

Toggling this hints the scene to (re)place the node in octree/acceleration structures.

Returns

boolean

Set Signature

set placeToOctree(val): void

Defined in: libs/scene/src/scene/scene_node.ts:320

Parameters

val

boolean

Returns

void

Inherited from

Camera.placeToOctree

runtimeId

Get Signature

get runtimeId(): number

Defined in: libs/scene/src/scene/scene_node.ts:331

Node's runtime unique identifier

Returns

number

Inherited from

Camera.runtimeId

persistentId

Get Signature

get persistentId(): string

Defined in: libs/scene/src/scene/scene_node.ts:340

Node's persistent identifier.

Remarks

Changing this affects serialization and registry lookup; ensure uniqueness.

Returns

string

Set Signature

set persistentId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:343

Parameters

id

string

Returns

void

Inherited from

Camera.persistentId

prefabId

Get Signature

get prefabId(): string

Defined in: libs/scene/src/scene/scene_node.ts:352

If not empty, this node was loaded from a prefab

Remarks

Internal used for serialization

Returns

string

Set Signature

set prefabId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:355

Parameters

id

string

Returns

void

Inherited from

Camera.prefabId

jointTypeT

Get Signature

get jointTypeT(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:371

Translation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeT(val): void

Defined in: libs/scene/src/scene/scene_node.ts:374

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeT

jointTypeS

Get Signature

get jointTypeS(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:383

Scale type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeS(val): void

Defined in: libs/scene/src/scene/scene_node.ts:386

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeS

jointTypeR

Get Signature

get jointTypeR(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:395

Rotation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeR(val): void

Defined in: libs/scene/src/scene/scene_node.ts:398

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeR

metaData

Get Signature

get metaData(): Metadata

Defined in: libs/scene/src/scene/scene_node.ts:407

Arbitrary metadata associated with this node.

Remarks

Stored and transported with the node; format is application-defined.

Returns

Metadata

Set Signature

set metaData(val): void

Defined in: libs/scene/src/scene/scene_node.ts:410

Parameters

val

Metadata

Returns

void

Inherited from

Camera.metaData

script

Get Signature

get script(): string

Defined in: libs/scene/src/scene/scene_node.ts:419

Attached script filename or identifier (engine-specific).

Remarks

Integrates with the engine’s scripting system if available.

Returns

string

Set Signature

set script(fileName): void

Defined in: libs/scene/src/scene/scene_node.ts:422

Parameters

fileName

string

Returns

void

Inherited from

Camera.script

scriptConfig

Get Signature

get scriptConfig(): object | unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:435

Script component configuration payload used by editor/runtime script components.

Returns

object | unknown[]

Set Signature

set scriptConfig(value): void

Defined in: libs/scene/src/scene/scene_node.ts:438

Parameters

value

object | unknown[]

Returns

void

Inherited from

Camera.scriptConfig

scripts

Get Signature

get scripts(): ScriptAttachment[]

Defined in: libs/scene/src/scene/scene_node.ts:452

All script attachments on this node.

Returns

ScriptAttachment[]

Set Signature

set scripts(value): void

Defined in: libs/scene/src/scene/scene_node.ts:455

Parameters

value

ScriptAttachment[]

Returns

void

Inherited from

Camera.scripts

scriptConfigs

Get Signature

get scriptConfigs(): unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:461

Script configs for all script attachments.

Returns

unknown[]

Set Signature

set scriptConfigs(value): void

Defined in: libs/scene/src/scene/scene_node.ts:464

Parameters

value

unknown[]

Returns

void

Inherited from

Camera.scriptConfigs

gpuClothComponents

Get Signature

get gpuClothComponents(): GPUClothComponent[]

Defined in: libs/scene/src/scene/scene_node.ts:477

GPU cloth simulations owned by this node.

Returns

GPUClothComponent[]

Set Signature

set gpuClothComponents(value): void

Defined in: libs/scene/src/scene/scene_node.ts:480

Parameters

value

GPUClothComponent[]

Returns

void

Inherited from

Camera.gpuClothComponents

name

Get Signature

get name(): string

Defined in: libs/scene/src/scene/scene_node.ts:516

Display name of the node (for UI/debugging).

Returns

string

Set Signature

set name(val): void

Defined in: libs/scene/src/scene/scene_node.ts:519

Parameters

val

string

Returns

void

Inherited from

Camera.name

scene

Get Signature

get scene(): Scene

Defined in: libs/scene/src/scene/scene_node.ts:523

The owning scene.

Returns

Scene

Inherited from

Camera.scene

attached

Get Signature

get attached(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:529

Whether this node is currently attached under the scene's root.

Returns

boolean

Inherited from

Camera.attached

sealed

Get Signature

get sealed(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:543

If true, the node is logically sealed; some operations (like cloning as child) may be restricted by engine policies.

Returns

boolean

Set Signature

set sealed(val): void

Defined in: libs/scene/src/scene/scene_node.ts:546

Parameters

val

boolean

Returns

void

Inherited from

Camera.sealed

animationSet

Get Signature

get animationSet(): AnimationSet

Defined in: libs/scene/src/scene/scene_node.ts:555

Lazily created animation set for this node.

Remarks

Accessing this schedules the node for update in the scene.

Returns

AnimationSet

Inherited from

Camera.animationSet

sharedModel

Get Signature

get sharedModel(): SharedModel

Defined in: libs/scene/src/scene/scene_node.ts:565

Shared model reference for instancing/streaming systems.

Returns

SharedModel

Set Signature

set sharedModel(model): void

Defined in: libs/scene/src/scene/scene_node.ts:568

Parameters

model

SharedModel

Returns

void

Inherited from

Camera.sharedModel

morphTargetGroups

Get Signature

get morphTargetGroups(): SceneMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:572

Runtime morph target groups bound to this model instance.

Returns

SceneMorphTargetGroup[]

Set Signature

set morphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:575

Parameters

groups

SceneMorphTargetGroup[]

Returns

void

Inherited from

Camera.morphTargetGroups

clipTestEnabled

Get Signature

get clipTestEnabled(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:820

Clip mode

Returns

boolean

Set Signature

set clipTestEnabled(val): void

Defined in: libs/scene/src/scene/scene_node.ts:823

Parameters

val

boolean

Returns

void

Inherited from

Camera.clipTestEnabled

hidden

Get Signature

get hidden(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:827

Computed value of show state

Returns

boolean

Inherited from

Camera.hidden

showState

Get Signature

get showState(): SceneNodeVisible

Defined in: libs/scene/src/scene/scene_node.ts:835

Show state

Returns

SceneNodeVisible

Set Signature

set showState(val): void

Defined in: libs/scene/src/scene/scene_node.ts:838

Parameters

val

SceneNodeVisible

Returns

void

Inherited from

Camera.showState

pickable

Get Signature

get pickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:856

Whether this node is enabled for CPU picking

Returns

boolean

Set Signature

set pickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:859

Parameters

val

boolean

Returns

void

Inherited from

Camera.pickable

gpuPickable

Get Signature

get gpuPickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:863

Whether this node is enabled for GPU picking

Returns

boolean

Set Signature

set gpuPickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:866

Parameters

val

boolean

Returns

void

Inherited from

Camera.gpuPickable

computedBoundingBoxDrawMode

Get Signature

get computedBoundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:948

Computed value for bounding box draw mode

Returns

number

Inherited from

Camera.computedBoundingBoxDrawMode

boundingBoxDrawMode

Get Signature

get boundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:959

Bounding box draw mode

Returns

number

Set Signature

set boundingBoxDrawMode(mode): void

Defined in: libs/scene/src/scene/scene_node.ts:962

Parameters

mode

number

Returns

void

Inherited from

Camera.boundingBoxDrawMode

parent

Get Signature

get parent(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:1262

Parent of the xform

Returns

SceneNode

Set Signature

set parent(p): void

Defined in: libs/scene/src/scene/scene_node.ts:1265

Parameters

p

SceneNode

Returns

void

Inherited from

Camera.parent

children

Get Signature

get children(): SceneNode[]

Defined in: libs/scene/src/scene/scene_node.ts:1271

Children of this xform

Returns

SceneNode[]

Inherited from

Camera.children

position

Get Signature

get position(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1277

Position of the xform relative to it's parent

Returns

Vector3

Set Signature

set position(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1280

Parameters

val

Vector3

Returns

void

Inherited from

Camera.position

scale

Get Signature

get scale(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1286

Scaling of the xform

Returns

Vector3

Set Signature

set scale(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1289

Parameters

val

Vector3

Returns

void

Inherited from

Camera.scale

rotation

Get Signature

get rotation(): Quaternion

Defined in: libs/scene/src/scene/scene_node.ts:1295

Rotation of the xform

Returns

Quaternion

Set Signature

set rotation(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1298

Parameters

val

Quaternion

Returns

void

Inherited from

Camera.rotation

localMatrix

Get Signature

get localMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1404

Local transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Set Signature

set localMatrix(matrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1411

Parameters

matrix

Immutable<Matrix4x4>

Returns

void

Inherited from

Camera.localMatrix

worldMatrix

Get Signature

get worldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1415

World transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

Camera.worldMatrix

worldMatrixDet

Get Signature

get worldMatrixDet(): number

Defined in: libs/scene/src/scene/scene_node.ts:1420

The determinant of world matrix

Returns

number

Inherited from

Camera.worldMatrixDet

invWorldMatrix

Get Signature

get invWorldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1425

Inverse of the world transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

Camera.invWorldMatrix

Methods

on()

Call Signature

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

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

IEventTarget.on

Type Parameters

K

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.on

Call Signature

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

Camera.on

once()

Call Signature

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

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

IEventTarget.once

Type Parameters

K

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.once

Call Signature

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

Camera.once

off()

Call Signature

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

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

IEventTarget.off

Type Parameters

K

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.off

Call Signature

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

Camera.off

dispatchEvent()

Call Signature

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

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

IEventTarget.dispatchEvent

Type Parameters

K

Parameters

type

K

args

...object & object[K]

Returns

void

Inherited from

Camera.dispatchEvent

Call Signature

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

Camera.dispatchEvent

dispose()

dispose(): void

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

Returns

void

Inherited from

Camera.dispose

handleEvent()

handleEvent<T>(ev, type?): boolean

Defined in: libs/scene/src/camera/camera.ts:1836

Handle input events

Type Parameters

T

T extends IBaseEvent<any>

Parameters

ev

T

input event object

type?

string

event type, default to ev.type

Returns

boolean

Boolean value indicates whether the event was handled.

Inherited from

Camera.handleEvent

constructRay()

constructRay(x, y): Ray

Defined in: libs/scene/src/camera/camera.ts:1879

Constructs a ray based on the given screen coordinates.

Parameters

x

number

The x-component of the screen coordinates, relative to the top-left corner of the viewport.

y

number

The y-component of the screen coordinates, relative to the top-left corner of the viewport.

Returns

Ray

The ray originating from the camera position and passing through the given screen coordinates.

Inherited from

Camera.constructRay

lookAt()

lookAt(eye, target, up): OrthoCamera

Defined in: libs/scene/src/camera/camera.ts:1903

Place the camera by specifying the camera position and the target point

Parameters

eye

Vector3

The camera position

target

Vector3

The target point to look at

up

Vector3

The up vector

Returns

OrthoCamera

self

Inherited from

Camera.lookAt

lookAtCubeFace()

lookAtCubeFace(face, position?): OrthoCamera

Defined in: libs/scene/src/camera/camera.ts:1912

Place the camera to look at a given cube face at a given camera position

Parameters

face

CubeFace

The cube face to look at

position?

Vector3

The camera position

Returns

OrthoCamera

self

Inherited from

Camera.lookAtCubeFace

getProjectionMatrix()

getProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1960

Gets the projection matrix of the camera

Returns

Immutable<Matrix4x4>

The projection matrix

Inherited from

Camera.getProjectionMatrix

getInvProjectionMatrix()

getInvProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1970

Gets the inverse projection matrix of the camera

Returns

Immutable<Matrix4x4>

The projection matrix

Inherited from

Camera.getInvProjectionMatrix

getRotationMatrix()

getRotationMatrix(): Matrix4x4

Defined in: libs/scene/src/camera/camera.ts:1976

Returns

Matrix4x4

Inherited from

Camera.getRotationMatrix

isCamera()

isCamera(): this is Camera

Defined in: libs/scene/src/camera/camera.ts:2041

true if this is a camera node, false otherwise

Returns

this is Camera

Inherited from

Camera.isCamera

getNearPlane()

getNearPlane(): number

Defined in: libs/scene/src/camera/camera.ts:2045

Gets the near clip plane of the camera

Returns

number

Inherited from

Camera.getNearPlane

getFarPlane()

getFarPlane(): number

Defined in: libs/scene/src/camera/camera.ts:2049

Gets the far clip plane of the camera

Returns

number

Inherited from

Camera.getFarPlane

getFOV()

getFOV(): number

Defined in: libs/scene/src/camera/camera.ts:2053

Gets the vertical field of view of the camera

Returns

number

Inherited from

Camera.getFOV

getTanHalfFovy()

getTanHalfFovy(): number

Defined in: libs/scene/src/camera/camera.ts:2057

Gets the tangent of half of the vertical field of view

Returns

number

Inherited from

Camera.getTanHalfFovy

getAspect()

getAspect(): number

Defined in: libs/scene/src/camera/camera.ts:2061

Gets the aspect ratio

Returns

number

Inherited from

Camera.getAspect

isPerspective()

isPerspective(): boolean

Defined in: libs/scene/src/camera/camera.ts:2065

Returns true if the camera is perspective

Returns

boolean

Inherited from

Camera.isPerspective

isOrtho()

isOrtho(): boolean

Defined in: libs/scene/src/camera/camera.ts:2069

Returns true if the camera is orthographic

Returns

boolean

Inherited from

Camera.isOrtho

getHistoryData()

getHistoryData(): CameraHistoryData

Defined in: libs/scene/src/camera/camera.ts:2076

Gets the camera history data which is used in temporal reprojection

Returns

CameraHistoryData

Camera history data

Inherited from

Camera.getHistoryData

clearHistoryData()

clearHistoryData(): void

Defined in: libs/scene/src/camera/camera.ts:2092

Clears the camera history data which is used in temporal reprojection

Returns

void

Inherited from

Camera.clearHistoryData

render()

render(scene): void

Defined in: libs/scene/src/camera/camera.ts:2318

Renders a scene

Parameters

scene

Scene

The scene to be rendered

Returns

void

Inherited from

Camera.render

pickAsync()

pickAsync(posX, posY): Promise<PickResult>

Defined in: libs/scene/src/camera/camera.ts:2369

Parameters

posX

number

posY

number

Returns

Promise<PickResult>

Inherited from

Camera.pickAsync

updateController()

updateController(): void

Defined in: libs/scene/src/camera/camera.ts:2398

Updates the controller state

Returns

void

Inherited from

Camera.updateController

resetController()

resetController(): void

Defined in: libs/scene/src/camera/camera.ts:2404

Reset the controller

Returns

void

Inherited from

Camera.resetController

getHistoryResourceManager()

getHistoryResourceManager(): HistoryResourceManager<Texture2D<unknown>>

Defined in: libs/scene/src/camera/camera.ts:2438

Gets the camera history resource manager for temporal effects.

Returns

HistoryResourceManager<Texture2D<unknown>>

Inherited from

Camera.getHistoryResourceManager

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/camera/camera.ts:2508

Returns

void

Inherited from

Camera.onDispose

setPerspective()

setPerspective(): this

Defined in: libs/scene/src/camera/orthocamera.ts:114

Not valid for OrthoCamera

Returns

this

Remarks

This method is only valid for Camera class or PerspectiveCamera class.

Overrides

Camera.setPerspective

setOrtho()

setOrtho(left, right, bottom, top, near, far): OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:120

Setup a orthogonal projection matrix for the camera

Parameters

left

number

Left bound of the frustum

right

number

Right bound of the frustum

bottom

number

Bottom bound of the frustum

top

number

Top bound of the frustum

near

number

Near bound of the frustum.

far

number

Far bound of the frustum.

Returns

OrthoCamera

self

Overrides

Camera.setOrtho

setProjectionMatrix()

setProjectionMatrix(matrix): void

Defined in: libs/scene/src/camera/orthocamera.ts:134

Setup a projection matrix for the camera

Parameters

matrix

Matrix4x4

The projection matrix

Returns

void

Overrides

Camera.setProjectionMatrix

getPrefabNode()

getPrefabNode(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:362

Get prefab node this node belongs to, or null if this node does not belongs to any prefab

Returns

SceneNode

prefab node this node belongs to

Inherited from

Camera.getPrefabNode

addGPUClothComponent()

addGPUClothComponent(component): GPUClothComponent

Defined in: libs/scene/src/scene/scene_node.ts:501

Adds a GPU cloth component to this node.

Parameters

removeGPUClothComponent()

removeGPUClothComponent(component): boolean

Defined in: libs/scene/src/scene/scene_node.ts:506

Removes and disposes a GPU cloth component from this node.

Parameters

component

GPUClothComponent

Returns

boolean

Inherited from

Camera.removeGPUClothComponent

clone()

clone(): Promise<OrthoCamera>

Defined in: libs/scene/src/scene/scene_node.ts:589

Clone this node.

Returns

Promise<OrthoCamera>

New node instance

Remarks

If a shared model exists, it may create an instanced node. The clone is attached under the same parent; children are cloned based on method and recursive.

Inherited from

Camera.clone

hasChild()

hasChild(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:619

Whether the given node is a direct child of this node.

Parameters

child

SceneNode

The node to be checked

Returns

boolean

true if the given node is a direct child of this node, false otherwise

Inherited from

Camera.hasChild

removeChildren()

removeChildren(): void

Defined in: libs/scene/src/scene/scene_node.ts:625

Remove all children from this node.

Returns

void

Inherited from

Camera.removeChildren

isParentOf()

isParentOf(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:633

Whether this node is an ancestor (direct or indirect) of the given node.

Parameters

child

SceneNode

Returns

boolean

Inherited from

Camera.isParentOf

remove()

remove(): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:644

Detach this node from its parent.

Returns

OrthoCamera

this

Inherited from

Camera.remove

traverse()

traverse(v): void

Defined in: libs/scene/src/scene/scene_node.ts:653

Depth-first traversal of this node's subtree (pre-order).

Parameters

v

Visitor<SceneNode>

Visitor invoked on each node.

Returns

void

Inherited from

Camera.traverse

iterate()

iterate(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:667

Iterate self and descendants in pre-order.

Warning: Do not remove children during this iteration. To allow removal, use iterateBottomToTop.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

Camera.iterate

iterateBottomToTop()

iterateBottomToTop(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:686

Iterate self and descendants in reverse post-order (bottom-to-top).

Child nodes can be safely removed during this iteration.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

Camera.iterateBottomToTop

isGraphNode()

isGraphNode(): this is GraphNode

Defined in: libs/scene/src/scene/scene_node.ts:699

Type guard: true if this node is a graph node.

Returns

this is GraphNode

Inherited from

Camera.isGraphNode

isLight()

isLight(): this is BaseLight

Defined in: libs/scene/src/scene/scene_node.ts:703

Type guard: true if this node is a light.

Returns

this is BaseLight

Inherited from

Camera.isLight

isMesh()

isMesh(): this is Mesh

Defined in: libs/scene/src/scene/scene_node.ts:707

Type guard: true if this node is a mesh.

Returns

this is Mesh

Inherited from

Camera.isMesh

isSprite()

isSprite(): this is Sprite

Defined in: libs/scene/src/scene/scene_node.ts:711

Type guard: true if this node is a sprite

Returns

this is Sprite

Inherited from

Camera.isSprite

isMSDFTextSprite()

isMSDFTextSprite(): this is MSDFTextSprite

Defined in: libs/scene/src/scene/scene_node.ts:715

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFTextSprite

Inherited from

Camera.isMSDFTextSprite

isMSDFText()

isMSDFText(): this is MSDFText

Defined in: libs/scene/src/scene/scene_node.ts:719

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFText

Inherited from

Camera.isMSDFText

isWater()

isWater(): this is Water

Defined in: libs/scene/src/scene/scene_node.ts:723

Type guard: true if this node is a water node.

Returns

this is Water

Inherited from

Camera.isWater

isHair()

isHair(): this is HairNode

Defined in: libs/scene/src/scene/scene_node.ts:727

Type guard: true if this node is a hair node.

Returns

this is HairNode

Inherited from

Camera.isHair

isParticleSystem()

isParticleSystem(): this is ParticleSystem

Defined in: libs/scene/src/scene/scene_node.ts:731

Type guard: true if this node is a particle system.

Returns

this is ParticleSystem

Inherited from

Camera.isParticleSystem

isBatchGroup()

isBatchGroup(): this is BatchGroup

Defined in: libs/scene/src/scene/scene_node.ts:735

Type guard: true if this node is a batch group.

Returns

this is BatchGroup

Inherited from

Camera.isBatchGroup

isClipmapTerrain()

isClipmapTerrain(): this is ClipmapTerrain

Defined in: libs/scene/src/scene/scene_node.ts:739

Type guard: true if this node is a clipmap terrain.

Returns

this is ClipmapTerrain

Inherited from

Camera.isClipmapTerrain

isPunctualLight()

isPunctualLight(): this is PunctualLight

Defined in: libs/scene/src/scene/scene_node.ts:747

true if this is a punctual light node, false otherwise

Returns

this is PunctualLight

Inherited from

Camera.isPunctualLight

computeBoundingVolume()

computeBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:754

Computes the bounding volume of the node

Returns

BoundingVolume

The output bounding volume

Inherited from

Camera.computeBoundingVolume

getBoundingVolume()

getBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:761

Gets the bounding volume of the node

Returns

BoundingVolume

The bounding volume of the node

Inherited from

Camera.getBoundingVolume

setBoundingVolume()

setBoundingVolume(bv): void

Defined in: libs/scene/src/scene/scene_node.ts:772

Sets the bounding volume of the node

Parameters

bv

BoundingVolume

The bounding volume to set

Returns

void

Inherited from

Camera.setBoundingVolume

getWorldBoundingVolume()

getWorldBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:783

Gets the world space bounding volume of the node

Returns

BoundingVolume

The world space bounding volume of the node

Inherited from

Camera.getWorldBoundingVolume

computeWorldBoundingVolume()

computeWorldBoundingVolume(localBV): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:793

Computes the world space bounding volume of the node

Parameters

localBV

BoundingVolume

Returns

BoundingVolume

The output bounding volume

Inherited from

Camera.computeWorldBoundingVolume

invalidateBoundingVolume()

invalidateBoundingVolume(): void

Defined in: libs/scene/src/scene/scene_node.ts:799

Force the bounding volume to be recalculated

Returns

void

Inherited from

Camera.invalidateBoundingVolume

invalidateWorldBoundingVolume()

invalidateWorldBoundingVolume(transformChanged): void

Defined in: libs/scene/src/scene/scene_node.ts:804

Force the world space bounding volume to be recalculated

Parameters

transformChanged

boolean

Returns

void

Inherited from

Camera.invalidateWorldBoundingVolume

findNodeById()

findNodeById<T>(id): T

Defined in: libs/scene/src/scene/scene_node.ts:876

Finds a scene node by its persistent ID.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

id

string

Persistent identifier to match against SceneNode.persistentId.

Returns

T

The first matching node, or null if not found.

Inherited from

Camera.findNodeById

findSkeletonById()

findSkeletonById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:891

Finds a skeleton object by its persistent ID.

Parameters

id

string

Persistent identifier to match against Skeleton.persistentId.

Returns

SkinBinding

The first matchign node, or null if not found.

Inherited from

Camera.findSkeletonById

findSkinBindingById()

findSkinBindingById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:899

Finds a skin binding by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkinBinding.persistentId.

Returns

SkinBinding

The first matching binding, or null if not found.

Inherited from

Camera.findSkinBindingById

findSkeletonRigById()

findSkeletonRigById(id): SkeletonRig

Defined in: libs/scene/src/scene/scene_node.ts:914

Finds a shared skeleton rig by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkeletonRig.persistentId.

Returns

SkeletonRig

The first matching rig, or null if not found.

Inherited from

Camera.findSkeletonRigById

findNodeByName()

findNodeByName<T>(name): T

Defined in: libs/scene/src/scene/scene_node.ts:936

Finds a scene node by name.

If multiple nodes share the same name, returns the first match encountered during traversal.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

name

string

Node name to match.

Returns

T

The first matching node, or null if not found.

Remarks

Names are not guaranteed unique. Prefer IDs for stable references.

Inherited from

Camera.findNodeByName

getSerializedMorphTargetGroups()

getSerializedMorphTargetGroups(): SerializedMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:1019

Returns serialized morph target groups for this node.

Returns

SerializedMorphTargetGroup[]

Inherited from

Camera.getSerializedMorphTargetGroups

setSerializedMorphTargetGroups()

setSerializedMorphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:1037

Restores serialized morph target groups for this node.

Parameters

groups

SerializedMorphTargetGroup[]

Returns

void

Inherited from

Camera.setSerializedMorphTargetGroups

invalidateTransform()

invalidateTransform(invalidateLocal?): void

Defined in: libs/scene/src/scene/scene_node.ts:1073

Force transform update and notify descendants.

Parameters

invalidateLocal?

boolean = true

If true, also invalidate local matrix; otherwise only invalidate world matrix.

Returns

void

Inherited from

Camera.invalidateTransform

setMorphTargetWeight()

setMorphTargetWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1081

Set morph target weight by name for all meshes in the subtree.

Parameters

name

string

Morph target name

weight

number

Morph target weight

Returns

void

Inherited from

Camera.setMorphTargetWeight

setMorphTargetGroupWeight()

setMorphTargetGroupWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1097

Set morph target group weight for the model instance.

Parameters

name

string

Morph target group name

weight

number

Group weight

Returns

void

Inherited from

Camera.setMorphTargetGroupWeight

getMorphTargetGroupWeight()

getMorphTargetGroupWeight(name): number

Defined in: libs/scene/src/scene/scene_node.ts:1119

Get morph target group weight.

Parameters

name

string

Morph target group name

Returns

number

The group weight, or 0 if no group was found

Inherited from

Camera.getMorphTargetGroupWeight

collectMorphTargetNames()

collectMorphTargetNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1127

Collect all morph target names from meshes in the subtree.

Returns

string[]

Array of unique morph target names

Inherited from

Camera.collectMorphTargetNames

collectMorphTargetGroupNames()

collectMorphTargetGroupNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1143

Collect all model-level morph target group names.

Returns

string[]

Array of morph target group names

Inherited from

Camera.collectMorphTargetGroupNames

onPostClone()

protected onPostClone(): void | Promise<void>

Defined in: libs/scene/src/scene/scene_node.ts:1152

Get called when the node was just created by cloning from other node

Returns

void | Promise<void>

Inherited from

Camera.onPostClone

_onAttached()

protected _onAttached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1226

Get called when this node is attached to scene

Returns

void

Inherited from

Camera._onAttached

_onDetached()

protected _onDetached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1230

Get called when this node is detached from scene

Returns

void

Inherited from

Camera._onDetached

worldToThis()

Call Signature

worldToThis(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1307

Transform world coordinate to local space

Parameters

v

Vector3

point or vector in world space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

Camera.worldToThis

Call Signature

worldToThis(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1308

Transform world coordinate to local space

Parameters

v

Vector4

point or vector in world space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

Camera.worldToThis

otherToThis()

Call Signature

otherToThis(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1327

Transform coordinate in other coordinate space to local space

Parameters

other

SceneNode

The other coordinate space

v

Vector3

point or vector in other coordinate space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

Camera.otherToThis

Call Signature

otherToThis(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1328

Transform coordinate in other coordinate space to local space

Parameters

other

SceneNode

The other coordinate space

v

Vector4

point or vector in other coordinate space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

Camera.otherToThis

thisToWorld()

Call Signature

thisToWorld(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1338

Transform local coordinate to world space

Parameters

v

Vector3

point or vector in local space

result?

Vector3

The output result

Returns

Vector3

The transformed world space coordinate

Inherited from

Camera.thisToWorld

Call Signature

thisToWorld(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1339

Transform local coordinate to world space

Parameters

v

Vector4

point or vector in local space

result?

Vector4

The output result

Returns

Vector4

The transformed world space coordinate

Inherited from

Camera.thisToWorld

thisToOther()

Call Signature

thisToOther(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1358

Transform local space coordinate to other coordinate space

Parameters

other

SceneNode

The other coordinate space

v

Vector3

point or vector in localspace

result?

Vector3

The output result

Returns

Vector3

The transformed coordinate in other coordinate space

Inherited from

Camera.thisToOther

Call Signature

thisToOther(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1359

Transform local space coordinate to other coordinate space

Parameters

other

SceneNode

The other coordinate space

v

Vector4

point or vector in localspace

result?

Vector4

The output result

Returns

Vector4

The transformed coordinate in other coordinate space

Inherited from

Camera.thisToOther

getWorldPosition()

getWorldPosition(outPos?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1367

Gets the position of the xform in world space

Parameters

outPos?

Vector3

Returns

Vector3

position of the xform in world space

Inherited from

Camera.getWorldPosition

moveBy()

moveBy(delta): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1378

Moves the xform by an offset vector

Parameters

delta

Vector3

The offset vector

Returns

OrthoCamera

self

Inherited from

Camera.moveBy

scaleBy()

scaleBy(factor): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1387

Scales the xform by a given scale factor

Parameters

factor

Vector3

The scale factor

Returns

OrthoCamera

self

Inherited from

Camera.scaleBy

setLocalTransform()

setLocalTransform(matrix): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1396

Sets the local transform matrix of the xform

Parameters

matrix

Matrix4x4

The transform matrix to set

Returns

OrthoCamera

self

Inherited from

Camera.setLocalTransform

calculateLocalTransform()

calculateLocalTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1433

Calculate local transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

Camera.calculateLocalTransform

calculateWorldTransform()

calculateWorldTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1440

Calculate world transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

Camera.calculateWorldTransform

update()

update(frameId, elapsedInSeconds, deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1464

Update node state once per-frame

Parameters

frameId

number

Current frame id

elapsedInSeconds

number

Elapsed time from game start in seconds

deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

Camera.update

updatePerCamera()

updatePerCamera(_camera, _elapsedInSeconds, _deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1484

Update node state once per-camera

Parameters

_camera

Camera

Updates according to which camera

_elapsedInSeconds

number

Elapsed time from game start in seconds

_deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

Camera.updatePerCamera

reparent()

reparent(p?): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1490

Removes this node from it's parent and add this node to another parent node if required

Parameters

p?

SceneNode

The new parent node that this node should be added to or null

Returns

OrthoCamera

self

Inherited from

Camera.reparent

Class: OrthoCamera ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

scene ​

left? ​

right? ​

bottom? ​

top? ​

near? ​

far? ​

Returns ​

Overrides ​

Properties ​

_HiZNearest ​

Inherited from ​

_skinSSSGlow ​

Inherited from ​

_skinSSSProfilePreset ​

Inherited from ​

_skinSSSProfile ​

Inherited from ​

_skinSSSScatterTint ​

Inherited from ​

BBOXDRAW_INHERITED ​

Inherited from ​

BBOXDRAW_DISABLED ​

Inherited from ​

BBOXDRAW_LOCAL ​

Inherited from ​

BBOXDRAW_WORLD ​

Inherited from ​

Accessors ​

disposed ​

Get Signature ​

Returns ​

Inherited from ​

compositor ​

Get Signature ​

Returns ​

Inherited from ​

interactionRect ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

rect ​

Returns ​

Inherited from ​

clearColor ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

v ​

Returns ​

Inherited from ​

clearDepth ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

v ​

Returns ​

Inherited from ​

clearStencil ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

v ​

Returns ​

Inherited from ​

HiZ ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

val ​

Class: OrthoCamera

Extends

Constructors

Constructor

Parameters

scene

left?

right?

bottom?

top?

near?

far?

Returns

Overrides

Properties

_HiZNearest

Inherited from

_skinSSSGlow

Inherited from

_skinSSSProfilePreset

Inherited from

_skinSSSProfile

Inherited from

_skinSSSScatterTint

Inherited from

BBOXDRAW_INHERITED

Inherited from

BBOXDRAW_DISABLED

Inherited from

BBOXDRAW_LOCAL

Inherited from

BBOXDRAW_WORLD

Inherited from

Accessors

disposed

Get Signature

Returns

Inherited from

compositor

Get Signature

Returns

Inherited from

interactionRect

Get Signature

Returns

Set Signature

Parameters

rect

Returns

Inherited from

clearColor

Get Signature

Returns

Set Signature

Parameters

v

Returns

Inherited from

clearDepth

Get Signature

Returns

Set Signature

Parameters

v

Returns

Inherited from

clearStencil

Get Signature

Returns

Set Signature

Parameters

v

Returns

Inherited from

HiZ

Get Signature

Returns

Set Signature

Parameters

val