filament/io.github.erkko68.filament/Skybox

Skybox

actual class Skybox

Skybox renders a background environment cube around the camera.

When added to a Scene, the Skybox fills all untouched pixels. The Skybox is rendered as though the camera is inside an infinitely large cube with the cubemap mapped to its exterior. This allows rendering a background environment that follows the camera's orientation.

Creation and destruction: Create a Skybox with the Builder and destroy with Engine.destroy(skybox).

val skybox = Skybox.Builder()
    .environment(cubemap)
    .build(engine)
// later:
engine.destroy(skybox)

Note: The Skybox and IndirectLight both render backgrounds. Currently, only Texture-based skyboxes are supported. The Skybox typically uses lower-resolution cubemaps for visual appearance, while IndirectLight provides the high-quality irradiance for lighting calculations.

See also

Scene.setSkybox

expect class Skybox

Skybox renders a background environment cube around the camera.

When added to a Scene, the Skybox fills all untouched pixels. The Skybox is rendered as though the camera is inside an infinitely large cube with the cubemap mapped to its exterior. This allows rendering a background environment that follows the camera's orientation.

Creation and destruction: Create a Skybox with the Builder and destroy with Engine.destroy(skybox).

val skybox = Skybox.Builder()
    .environment(cubemap)
    .build(engine)
// later:
engine.destroy(skybox)

Note: The Skybox and IndirectLight both render backgrounds. Currently, only Texture-based skyboxes are supported. The Skybox typically uses lower-resolution cubemaps for visual appearance, while IndirectLight provides the high-quality irradiance for lighting calculations.

See also

Scene.setSkybox

actual class Skybox

Skybox renders a background environment cube around the camera.

When added to a Scene, the Skybox fills all untouched pixels. The Skybox is rendered as though the camera is inside an infinitely large cube with the cubemap mapped to its exterior. This allows rendering a background environment that follows the camera's orientation.

Creation and destruction: Create a Skybox with the Builder and destroy with Engine.destroy(skybox).

val skybox = Skybox.Builder()
    .environment(cubemap)
    .build(engine)
// later:
engine.destroy(skybox)

Note: The Skybox and IndirectLight both render backgrounds. Currently, only Texture-based skyboxes are supported. The Skybox typically uses lower-resolution cubemaps for visual appearance, while IndirectLight provides the high-quality irradiance for lighting calculations.

See also

Scene.setSkybox

actual class Skybox

Skybox renders a background environment cube around the camera.

When added to a Scene, the Skybox fills all untouched pixels. The Skybox is rendered as though the camera is inside an infinitely large cube with the cubemap mapped to its exterior. This allows rendering a background environment that follows the camera's orientation.

Creation and destruction: Create a Skybox with the Builder and destroy with Engine.destroy(skybox).

val skybox = Skybox.Builder()
    .environment(cubemap)
    .build(engine)
// later:
engine.destroy(skybox)

Note: The Skybox and IndirectLight both render backgrounds. Currently, only Texture-based skyboxes are supported. The Skybox typically uses lower-resolution cubemaps for visual appearance, while IndirectLight provides the high-quality irradiance for lighting calculations.

See also

Scene.setSkybox

actual class Skybox

Skybox renders a background environment cube around the camera.

When added to a Scene, the Skybox fills all untouched pixels. The Skybox is rendered as though the camera is inside an infinitely large cube with the cubemap mapped to its exterior. This allows rendering a background environment that follows the camera's orientation.

Creation and destruction: Create a Skybox with the Builder and destroy with Engine.destroy(skybox).

val skybox = Skybox.Builder()
    .environment(cubemap)
    .build(engine)
// later:
engine.destroy(skybox)

Note: The Skybox and IndirectLight both render backgrounds. Currently, only Texture-based skyboxes are supported. The Skybox typically uses lower-resolution cubemaps for visual appearance, while IndirectLight provides the high-quality irradiance for lighting calculations.

See also

Scene.setSkybox

Constructors

constructor(nativeSkybox: Skybox)

constructor(jsSkybox: Skybox, builderIntensity: Float? = null)

constructor(nativeHandle: MemorySegment?)

constructor(nativeHandle: CPointer<FilaSkybox>?)

Types

actual class Builder

Builder for creating Skybox instances.

expect class Builder

Builder for creating Skybox instances.

actual class Builder

Builder for creating Skybox instances.

actual class Builder

Builder for creating Skybox instances.

actual class Builder

Builder for creating Skybox instances.

Properties

actual val intensity: Float

Returns the Skybox's intensity in lux, or lumen/m².

expect val intensity: Float

Returns the Skybox's intensity in lux, or lumen/m².

actual val intensity: Float

Returns the Skybox's intensity in lux, or lumen/m².

actual val intensity: Float

Returns the Skybox's intensity in lux, or lumen/m².

actual val intensity: Float

Returns the Skybox's intensity in lux, or lumen/m².

val jsSkybox: Skybox

actual val layerMask: Int

Returns the visibility mask bits (layer mask).

expect val layerMask: Int

Returns the visibility mask bits (layer mask).

actual val layerMask: Int

Returns the visibility mask bits (layer mask).

actual val layerMask: Int

Returns the visibility mask bits (layer mask).

actual val layerMask: Int

Returns the visibility mask bits (layer mask).

val nativeSkybox: Skybox

actual val texture: Texture?

Returns the associated environment cubemap Texture.

expect val texture: Texture?

Returns the associated environment cubemap Texture.

actual val texture: Texture?

Returns the associated environment cubemap Texture.

actual val texture: Texture?

Returns the associated environment cubemap Texture.

actual val texture: Texture?

Returns the associated environment cubemap Texture.

Functions

actual fun setColor(r: Float, g: Float, b: Float, a: Float)

Dynamically update the Skybox's constant color.

expect fun setColor(r: Float, g: Float, b: Float, a: Float)

Dynamically update the Skybox's constant color.

actual fun setColor(r: Float, g: Float, b: Float, a: Float)

Dynamically update the Skybox's constant color.

actual fun setColor(r: Float, g: Float, b: Float, a: Float)

Dynamically update the Skybox's constant color.

actual fun setColor(r: Float, g: Float, b: Float, a: Float)

Dynamically update the Skybox's constant color.

actual fun setLayerMask(select: Int, value: Int)

Set bits in the visibility mask.

expect fun setLayerMask(select: Int, value: Int)

Set bits in the visibility mask.

actual fun setLayerMask(select: Int, value: Int)

Set bits in the visibility mask.

actual fun setLayerMask(select: Int, value: Int)

Set bits in the visibility mask.

actual fun setLayerMask(select: Int, value: Int)

Set bits in the visibility mask.