One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

RenderLayerComponent

struct · iOS 27.0+ · SDK 27.1

struct RenderLayerComponent

A component that defines which layers an entity participates in. Add a ``RenderLayerComponent`` to an entity to control which lights illuminate it and which lights it casts shadows from. A light affects this entity when the entity's ``RenderLayerComponent/layers`` intersect with the light's layers, for example ``DirectionalLightComponent/layers``, ``PointLightComponent/layers``, or ``SpotLightComponent/layers``. Entities without a ``RenderLayerComponent`` are treated as members of ``RenderLayer/defaultLayer``.

Members (5)

get · iOS 27.0+

defaultLayer

TypeScript
static get defaultLayer(): RenderLayerComponent
Swift declaration
static let defaultLayer: RenderLayerComponent

A render layer component that contains only ``RenderLayer/defaultLayer``. RealityKit treats entities without an explicit ``RenderLayerComponent`` as if they had this component.

init · iOS 27.0+

init

TypeScript
static initLayer(layer: RenderLayer): RenderLayerComponent
Swift declaration
init(layer: RenderLayer)

Creates a layer component with a single layer. - Parameter layer: The layer this entity participates in

get · iOS 27.0+

layers

TypeScript
get layers(): RenderLayer_Set
Swift declaration
var layers: RenderLayer.Set

The layers this entity participates in. A layer is either a custom layer you define in an extension to ``RenderLayer`` or ``RenderLayer/defaultLayer``. Common conventions include: - ``RenderLayer/defaultLayer`` for general entities - `RenderLayer("com.myapp.hero")` for main character objects - `RenderLayer("com.myapp.background")` for background elements - `RenderLayer("com.myapp.props")` for scene props

set · iOS 27.0+

layers

TypeScript
set layers(value: RenderLayer_Set)
Swift declaration
var layers: RenderLayer.Set

The layers this entity participates in. A layer is either a custom layer you define in an extension to ``RenderLayer`` or ``RenderLayer/defaultLayer``. Common conventions include: - ``RenderLayer/defaultLayer`` for general entities - `RenderLayer("com.myapp.hero")` for main character objects - `RenderLayer("com.myapp.background")` for background elements - `RenderLayer("com.myapp.props")` for scene props

init · iOS 27.0+

init

TypeScript
static initLayers(layers: RenderLayer_Set): RenderLayerComponent
Swift declaration
init(layers: RenderLayer.Set)

Creates a layer component with the specified layers. - Parameter layers: The layers this entity participates in

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

RenderLayerComponent.init(_:)

A variable number of Swift arguments is not supported.

All RealityFoundation types →