Contents

EnvironmentLightingConfigurationComponent

A component that scales the amount of light that an entity receives from its environment.

Declaration

struct EnvironmentLightingConfigurationComponent

Overview

When rendering a RealityKit scene, you can control how much the environment’s lighting affects the virtual objects in your scene, such as the lighting from your real-world surroundings, a virtual environment, or both. Use an EnvironmentLightingConfigurationComponent to configure this amount for an entity.

For example, create an entity that receives no lighting from its environment by setting the weight to 0.0.

let spaceship = try await Entity(named: "spaceship")
spaceship.components.set(EnvironmentLightingConfigurationComponent(
    environmentLightingWeight: 0.0))

Topics

Creating an environment-lighting configuration component

Scaling the environment-lighting contribution

Operators

See Also

Environment