Contents

PointLight

An entity that produces an omnidirectional light for virtual objects.

Declaration

@MainActor @preconcurrency class PointLight

Overview

During an AR session, RealityKit automatically lights your virtual objects to match real-world lighting. You can also explicitly add virtual lights that act upon your virtual content. This is typically most useful outside of an AR session on iOS or macOS, where your RealityViewCameraContent camera property is set to virtual.

The point light is an omnidirectional light that illuminates all the virtual content within a configurable radius from the light. This is equivalent to creating an Entity, and then adding a PointLightComponent to its components set.

A RealityKit scene can contain up to eight dynamic lights, which are entities that contain a SpotLightComponent, PointLightComponent, or a DirectionalLightComponent. This limit doesn’t include light from image-based lighting.

Topics

Creating a point light

See Also

Entity compliance