Structure

PointLightComponent

A component that defines a point light source.

Declaration

struct PointLightComponent

Topics

Creating a Point Light Component

init(color: PointLightComponent.Color, intensity: Float, attenuationRadius: Float)

Creates a point light component with the given configuration.

init(color: PointLightComponent.Color, intensity: Float, attenuationRadius: Float)

Creates a point light component with the given configuration.

Setting Color

var color: PointLightComponent.Color

A color for the point light.

var color: PointLightComponent.Color

A color for the point light.

typealias PointLightComponent.Color

A platform-specific type used to define color for a point light.

Configuring the Light

var attenuationRadius: Float

The point light attenuation radius in meters, beyond which the light intensity is zero.

var intensity: Float

The intensity of the point light, measured in lumen.

Registering a Component Type

static func registerComponent()

Registers a new component type.

Comparing Point Light Components

static func == (PointLightComponent, PointLightComponent) -> Bool

Indicates whether two point light components are equal.

static func != (PointLightComponent, PointLightComponent) -> Bool

Indicates whether two point light components are not equal.

Relationships

Conforms To

See Also

Configuring the Point Light

var light: PointLightComponent

A point light component for the entity.

Beta
protocol HasPointLight

An interface that defines a point light source component.

Beta

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software