Class SkyBackground

Sky background

Export

SkyBackground

Date

2024.3.7

Author

yisky

Hierarchy (view full)

Background
- SkyBackground

Index

Constructors

Properties

Accessors

atmosphereThickness exposure groundTint skyTint sunlightColor sunlightDirection sunMode sunSize sunSizeConvergence

Methods

Constructors

constructor

new SkyBackground(scene, options?): SkyBackground
Parameters
- scene: Scene
- options: SkyOptions = {}
Returns SkyBackground
Overrides Background.constructor

Properties

`Readonly`scene

scene: Scene

Accessors

atmosphereThickness

set atmosphereThickness(value): void
Set atmosphere thickness
Parameters
- value: number
Returns void
Memberof
SkyBackground

exposure

set exposure(value): void
Set exposure
Parameters
- value: number
Returns void
Memberof
SkyBackground

groundTint

set groundTint(value): void
Set ground tint
Parameters
- value: ColorRepresentation
Returns void
Memberof
SkyBackground

skyTint

set skyTint(value): void
Set sky tint
Parameters
- value: ColorRepresentation
Returns void
Memberof
SkyBackground

sunlightColor

set sunlightColor(value): void
Set sunlight color
Parameters
- value: ColorRepresentation
Returns void
Memberof
SkyBackground

sunlightDirection

set sunlightDirection(value): void
Set sunlight direction
Parameters
- value: Vector3
Returns void
Memberof
SkyBackground

sunMode

set sunMode(value): void
Set sun mode
Parameters
- value: SunMode
Returns void
Memberof
SkyBackground

sunSize

set sunSize(value): void
Set sun size
Parameters
- value: number
Returns void
Memberof
SkyBackground

sunSizeConvergence

set sunSizeConvergence(value): void
Set sun size convergence
Parameters
- value: number
Returns void
Memberof
SkyBackground

Methods

dispose

dispose(): void
Dispose

Returns void
Memberof
SkyBackground

Overrides Background.dispose

update

update(options?): void
Update
Parameters
- Optionaloptions: SkyOptions = {}
Returns void
Memberof
SkyBackground