Class Sky

Readonlyview

applied

• get applied(): boolean

  Gets whether the sky pass will run.

  Returns boolean

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

groundColor

• get groundColor(): [number, number, number]

  Returns [number, number, number]

• set groundColor(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

horizonBlend

• get horizonBlend(): number

  Returns number

• set horizonBlend(v: number): void

  Parameters

  • v: number

  Returns void

horizonColor

• get horizonColor(): [number, number, number]

  Returns [number, number, number]

• set horizonColor(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

skyColor

• get skyColor(): [number, number, number]

  Returns [number, number, number]

• set skyColor(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

sunAngularSize

• get sunAngularSize(): number

  Returns number

• set sunAngularSize(v: number): void

  Parameters

  • v: number

  Returns void

sunColor

• get sunColor(): [number, number, number]

  Returns [number, number, number]

• set sunColor(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

sunDirection

• get sunDirection(): [number, number, number]

  World-space direction toward the sun (need not be normalized — the renderer normalizes per frame). To sync with a DirLight, negate the light's dir (the light's dir is the way photons travel, the opposite sign).

  Returns [number, number, number]
• set sunDirection(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

sunEnabled

• get sunEnabled(): boolean

  Whether to draw the sun disc + glow. Default true.

  Returns boolean
• set sunEnabled(v: boolean): void

  Parameters

  • v: boolean

  Returns void

sunGlowIntensity

• get sunGlowIntensity(): number

  Returns number

• set sunGlowIntensity(v: number): void

  Parameters

  • v: number

  Returns void

sunGlowSize

• get sunGlowSize(): number

  Returns number

• set sunGlowSize(v: number): void

  Parameters

  • v: number

  Returns void

worldUp

• get worldUp(): [number, number, number]

  Returns [number, number, number]

• set worldUp(v: FloatArrayParam): void

  Parameters

  • v: FloatArrayParam

  Returns void

fromParams

• fromParams(params: SkyParams): SDKResult<void>

  Configures this Sky.

  Parameters

  • params: SkyParams

  Returns SDKResult<void>

toParams

• toParams(): SDKResult<SkyParams>

  Gets this Sky as JSON.

  Returns SDKResult<SkyParams>