<!--
{
  "availability" : [
    "FxPlug: 4.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "professional_video_applications",
  "identifier" : "/documentation/professional_video_applications/FxLight",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Professional Video Applications"
    ],
    "preciseIdentifier" : "c:@S@FxLight"
  },
  "title" : "FxLight"
}
-->

# FxLight

A structure that contains lighting information.

```
struct FxLight
```

## Overview

Note that the FxLight structure uses <doc://com.apple.documentation/documentation/CoreMedia/CMTime> in FxPlug 4, and replaces `FxLightInfo` from `FxLightingAPI` and `FxLightInfo_V1` from `FxLightingAPI_v2`.

## Topics

### Properties

[`var version: Int`](/documentation/professional_video_applications/FxLight/version)

The version of a lighting information structure.

[`var time: CMTime`](/documentation/professional_video_applications/FxLight/time)

The time of the lighting information.

[`var lightType: FxLightType`](/documentation/professional_video_applications/FxLight/lightType)

The type of light, whether ambient, directional, point, or spot.

[`var color: Unmanaged<NSColor>!`](/documentation/professional_video_applications/FxLight/color)

The color of the light.

[`var intensity: Float`](/documentation/professional_video_applications/FxLight/intensity)

The brightness with which the light illuminates objects.

[`var constantAttenuation: Float`](/documentation/professional_video_applications/FxLight/constantAttenuation)

The constant term of the lighting falloff equation.

[`var linearAttenuation: Float`](/documentation/professional_video_applications/FxLight/linearAttenuation)

The linear component of the lighting falloff equation.

[`var quadraticAttenuation: Float`](/documentation/professional_video_applications/FxLight/quadraticAttenuation)

The quadratic component of the lighting falloff equation.

[`var castsShadows: ObjCBool`](/documentation/professional_video_applications/FxLight/castsShadows)

A Boolean value that indicates whether a light casts shadows.

[`var spotCutoff: Float`](/documentation/professional_video_applications/FxLight/spotCutoff)

The angle, in radians, of the cone cutoff for spotlights.

[`var spotPenumbraCutoff: Float`](/documentation/professional_video_applications/FxLight/spotPenumbraCutoff)

The angle, in radians, of the cone penumbra cutoff for spotlights.

[`var position: FxPoint3D`](/documentation/professional_video_applications/FxLight/position)

The location of the light.

[`var direction: FxPoint3D`](/documentation/professional_video_applications/FxLight/direction)

The direction in which the light points.

### Initializers

[`init()`](/documentation/professional_video_applications/FxLight/init())

Initializes an FxLight lighting information structure.

[`init(version: Int, time: CMTime, lightType: FxLightType, color: Unmanaged<NSColor>!, intensity: Float, constantAttenuation: Float, linearAttenuation: Float, quadraticAttenuation: Float, castsShadows: ObjCBool, spotCutoff: Float, spotPenumbraCutoff: Float, position: FxPoint3D, direction: FxPoint3D)`](/documentation/professional_video_applications/FxLight/init(version:time:lightType:color:intensity:constantAttenuation:linearAttenuation:quadraticAttenuation:castsShadows:spotCutoff:spotPenumbraCutoff:position:direction:))

Initializes an FxLight lighting information structure with parameters.

## Relationships

### Conforms To

[`Sendable`](/documentation/Swift/Sendable)

[`BitwiseCopyable`](/documentation/Swift/BitwiseCopyable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)