Documentation / scene / SkyRenderer
Class: SkyRenderer
Defined in: libs/scene/src/render/sky.ts:84
The sky renderer
Extends
Disposable
Constructors
Constructor
new SkyRenderer():
SkyRenderer
Defined in: libs/scene/src/render/sky.ts:146
Creates an instance of SkyRenderer
Returns
SkyRenderer
Overrides
Disposable.constructor
Accessors
disposed
Get Signature
get disposed():
boolean
Defined in: libs/base/dist/index.d.ts:6065
Returns
boolean
Inherited from
Disposable.disposed
envTextureFormat
Get Signature
get envTextureFormat():
TextureFormat
Defined in: libs/scene/src/render/sky.ts:194
Gets the preferred environment texture format.
Returns
TextureFormat
skyType
Get Signature
get skyType():
SkyType
Defined in: libs/scene/src/render/sky.ts:206
Which type of the sky should be rendered
Returns
Set Signature
set skyType(
val):void
Defined in: libs/scene/src/render/sky.ts:209
Parameters
val
Returns
void
skyColor
Get Signature
get skyColor():
Immutable<Vector4>
Defined in: libs/scene/src/render/sky.ts:251
The color used when sky type is image
Returns
Immutable<Vector4>
Set Signature
set skyColor(
val):void
Defined in: libs/scene/src/render/sky.ts:254
Parameters
val
Immutable<Vector4>
Returns
void
skyImage
Get Signature
get skyImage():
Texture2D<unknown>
Defined in: libs/scene/src/render/sky.ts:263
The image used when sky type is image
Returns
Texture2D<unknown>
Set Signature
set skyImage(
texture):void
Defined in: libs/scene/src/render/sky.ts:266
Parameters
texture
Texture2D<unknown>
Returns
void
shWindowWeights
Get Signature
get shWindowWeights():
Immutable<Vector3>
Defined in: libs/scene/src/render/sky.ts:275
Window weights for SH projection
Returns
Immutable<Vector3>
Set Signature
set shWindowWeights(
weights):void
Defined in: libs/scene/src/render/sky.ts:278
Parameters
weights
Immutable<Vector3>
Returns
void
radianceConvSamples
Get Signature
get radianceConvSamples():
number
Defined in: libs/scene/src/render/sky.ts:285
Sample count for radiance convolution
Returns
number
Set Signature
set radianceConvSamples(
val):void
Defined in: libs/scene/src/render/sky.ts:288
Parameters
val
number
Returns
void
irradianceConvSamples
Get Signature
get irradianceConvSamples():
number
Defined in: libs/scene/src/render/sky.ts:297
Sample count for irradiance convolution
Returns
number
Set Signature
set irradianceConvSamples(
val):void
Defined in: libs/scene/src/render/sky.ts:300
Parameters
val
number
Returns
void
aerialPerspectiveDistance
Get Signature
get aerialPerspectiveDistance():
number
Defined in: libs/scene/src/render/sky.ts:307
Aerial perspective density
Returns
number
Set Signature
set aerialPerspectiveDistance(
val):void
Defined in: libs/scene/src/render/sky.ts:310
Parameters
val
number
Returns
void
atmosphereExposure
Get Signature
get atmosphereExposure():
number
Defined in: libs/scene/src/render/sky.ts:317
Atmosphere exposure
Returns
number
Set Signature
set atmosphereExposure(
val):void
Defined in: libs/scene/src/render/sky.ts:320
Parameters
val
number
Returns
void
cameraHeightScale
Get Signature
get cameraHeightScale():
number
Defined in: libs/scene/src/render/sky.ts:327
Aerial perspective density
Returns
number
Set Signature
set cameraHeightScale(
val):void
Defined in: libs/scene/src/render/sky.ts:330
Parameters
val
number
Returns
void
heightFogColor
Get Signature
get heightFogColor():
Immutable<Vector3>
Defined in: libs/scene/src/render/sky.ts:337
Height fog color
Returns
Immutable<Vector3>
Set Signature
set heightFogColor(
val):void
Defined in: libs/scene/src/render/sky.ts:340
Parameters
val
Immutable<Vector3>
Returns
void
heightFogDensity
Get Signature
get heightFogDensity():
number
Defined in: libs/scene/src/render/sky.ts:347
Height fog density
Returns
number
Set Signature
set heightFogDensity(
val):void
Defined in: libs/scene/src/render/sky.ts:350
Parameters
val
number
Returns
void
heightFogFalloff
Get Signature
get heightFogFalloff():
number
Defined in: libs/scene/src/render/sky.ts:357
Height fog falloff
Returns
number
Set Signature
set heightFogFalloff(
val):void
Defined in: libs/scene/src/render/sky.ts:360
Parameters
val
number
Returns
void
heightFogStartHeight
Get Signature
get heightFogStartHeight():
number
Defined in: libs/scene/src/render/sky.ts:367
Height fog start height
Returns
number
Set Signature
set heightFogStartHeight(
val):void
Defined in: libs/scene/src/render/sky.ts:370
Parameters
val
number
Returns
void
heightFogStartDistance
Get Signature
get heightFogStartDistance():
number
Defined in: libs/scene/src/render/sky.ts:377
Height fog start distance
Returns
number
Set Signature
set heightFogStartDistance(
val):void
Defined in: libs/scene/src/render/sky.ts:380
Parameters
val
number
Returns
void
heightFogEndDistance
Get Signature
get heightFogEndDistance():
number
Defined in: libs/scene/src/render/sky.ts:387
Height fog end distance
Returns
number
Set Signature
set heightFogEndDistance(
val):void
Defined in: libs/scene/src/render/sky.ts:390
Parameters
val
number
Returns
void
heightFogMaxOpacity
Get Signature
get heightFogMaxOpacity():
number
Defined in: libs/scene/src/render/sky.ts:397
Height fog maximum opacity
Returns
number
Set Signature
set heightFogMaxOpacity(
val):void
Defined in: libs/scene/src/render/sky.ts:400
Parameters
val
number
Returns
void
heightFogAtmosphereContribution
Get Signature
get heightFogAtmosphereContribution():
number
Defined in: libs/scene/src/render/sky.ts:407
Height fog atmosphere contribution strength
Returns
number
Set Signature
set heightFogAtmosphereContribution(
val):void
Defined in: libs/scene/src/render/sky.ts:410
Parameters
val
number
Returns
void
heightFogDirExponent
Get Signature
get heightFogDirExponent():
number
Defined in: libs/scene/src/render/sky.ts:417
Height fog directional exponent
Returns
number
Set Signature
set heightFogDirExponent(
val):void
Defined in: libs/scene/src/render/sky.ts:420
Parameters
val
number
Returns
void
heightFogDirColor
Get Signature
get heightFogDirColor():
Immutable<Vector3>
Defined in: libs/scene/src/render/sky.ts:427
Height fog directional inscattering color
Returns
Immutable<Vector3>
Set Signature
set heightFogDirColor(
val):void
Defined in: libs/scene/src/render/sky.ts:430
Parameters
val
Immutable<Vector3>
Returns
void
cloudy
Get Signature
get cloudy():
number
Defined in: libs/scene/src/render/sky.ts:443
Light density of the sky.
Remarks
This value controls how much cloud should be rendered when the sky type is scatter. Typically, the value should be in the range of 0 to 1.
Returns
number
Set Signature
set cloudy(
val):void
Defined in: libs/scene/src/render/sky.ts:446
Parameters
val
number
Returns
void
cloudIntensity
Get Signature
get cloudIntensity():
number
Defined in: libs/scene/src/render/sky.ts:455
Intensity of the sky color
Returns
number
Set Signature
set cloudIntensity(
val):void
Defined in: libs/scene/src/render/sky.ts:458
Parameters
val
number
Returns
void
wind
Get Signature
get wind():
Immutable<Vector2>
Defined in: libs/scene/src/render/sky.ts:470
Wind velocity
Remarks
This value affects the movement of the cloud
Returns
Immutable<Vector2>
Set Signature
set wind(
val):void
Defined in: libs/scene/src/render/sky.ts:473
Parameters
val
Immutable<Vector2>
Returns
void
radianceMap
Get Signature
get radianceMap():
TextureCube<unknown>
Defined in: libs/scene/src/render/sky.ts:479
Radiance map of the sky.
Returns
TextureCube<unknown>
sheenRadianceMap
Get Signature
get sheenRadianceMap():
TextureCube<unknown>
Defined in: libs/scene/src/render/sky.ts:492
Radiance map of the sky reused for sheen.
Remarks
Dynamic sky is smooth enough that the GGX-prefiltered radiance map is a practical approximation for sheen.
Returns
TextureCube<unknown>
irradianceSH
Get Signature
get irradianceSH():
GPUDataBuffer<unknown>
Defined in: libs/scene/src/render/sky.ts:513
Irradiance SH coeffecients buffer
Returns
GPUDataBuffer<unknown>
irradianceSHFB
Get Signature
get irradianceSHFB():
FrameBuffer<unknown>
Defined in: libs/scene/src/render/sky.ts:523
Irradiance SH coeffecients texture
Returns
FrameBuffer<unknown>
skyboxTexture
Get Signature
get skyboxTexture():
TextureCube<unknown>
Defined in: libs/scene/src/render/sky.ts:541
Cube texture for skybox.
Returns
TextureCube<unknown>
Set Signature
set skyboxTexture(
tex):void
Defined in: libs/scene/src/render/sky.ts:544
Parameters
tex
TextureCube<unknown>
Returns
void
skyboxRotation
Get Signature
get skyboxRotation():
Immutable<Vector3>
Defined in: libs/scene/src/render/sky.ts:555
Additional euler rotation (in degrees) applied to skybox.
Returns
Immutable<Vector3>
Set Signature
set skyboxRotation(
val):void
Defined in: libs/scene/src/render/sky.ts:558
Parameters
val
Immutable<Vector3>
Returns
void
fogType
Get Signature
get fogType():
FogType
Defined in: libs/scene/src/render/sky.ts:583
Current fog type
Returns
Set Signature
set fogType(
val):void
Defined in: libs/scene/src/render/sky.ts:586
Parameters
val
Returns
void
Methods
on()
on<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:594
IEventTarget.on
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.on
once()
once<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:598
IEventTarget.once
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.once
off()
off<
K>(type,listener?,context?):void
Defined in: libs/base/dist/index.d.ts:602
IEventTarget.off
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener?
EventListener<{ dispose: []; }>
context?
unknown
Returns
void
Inherited from
Disposable.off
dispatchEvent()
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/dist/index.d.ts:606
IEventTarget.dispatchEvent
Type Parameters
K
K extends "dispose"
Parameters
type
K
args
...object[K]
Returns
void
Inherited from
Disposable.dispatchEvent
dispose()
dispose():
void
Defined in: libs/base/dist/index.d.ts:6066
Returns
void
Inherited from
Disposable.dispose
getBakedSkyTexture()
getBakedSkyTexture(
ctx):TextureCube<unknown>
Defined in: libs/scene/src/render/sky.ts:242
Baked sky texture
Parameters
ctx
Returns
TextureCube<unknown>
invalidate()
invalidate():
void
Defined in: libs/scene/src/render/sky.ts:607
Force the radiance map and irradiance map to be regenerated.
Returns
void
update()
update(
ctx):Vector4
Defined in: libs/scene/src/render/sky.ts:622
Parameters
ctx
Returns
Vector4
renderAtmosphereLUTs()
renderAtmosphereLUTs(
ctx):void
Defined in: libs/scene/src/render/sky.ts:689
Parameters
ctx
Returns
void
renderSkyDistantLut()
renderSkyDistantLut(
ctx,skybox):void
Defined in: libs/scene/src/render/sky.ts:697
Parameters
ctx
skybox
TextureCube
Returns
void
updateBakedSkyMap()
updateBakedSkyMap(
ctx):void
Defined in: libs/scene/src/render/sky.ts:709
Parameters
ctx
Returns
void
renderUberFog()
renderUberFog(
camera,depthTexture):void
Defined in: libs/scene/src/render/sky.ts:746
Parameters
camera
depthTexture
BaseTexture<unknown>
Returns
void
onDispose()
protectedonDispose():void
Defined in: libs/scene/src/render/sky.ts:854
Disposes resources of this SkyRenderer
Returns
void
Overrides
Disposable.onDispose