Show / Hide Table of Contents

Class Light

Contains light information. If contained in a node, the node serves as a light object. If possible, avoid adding or removing these at runtime, instead create all you need and set active or inactive. The Position and Direction of a Light gets calculated internally, depending on the parent transform components, found in the scene graph.

Inheritance
System.Object
SceneComponent
Light
Implements
IComponent
Inherited Members
SceneComponent.Name
SceneComponent.Active
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fusee.Engine.Core.Scene
Assembly: Fusee.Engine.Core.dll
Syntax
public class Light : SceneComponent, IComponent

Constructors

Light(Single)

Creates a new instance of type LightComponent.

Declaration
public Light(float strength = 1F)
Parameters
Type Name Description
System.Single strength

Represents the strength of the light (non-physically representation of the brightness).

Fields

Bias

Bias for calculating shadows.

Declaration
public float Bias
Field Value
Type Description
System.Single

Color

Represents the light color.

Declaration
public float4 Color
Field Value
Type Description
float4

InnerConeAngle

Represents the spot inner angle of the light.

Declaration
public float InnerConeAngle
Field Value
Type Description
System.Single

IsCastingShadows

Defines if a shadow map is created for this light.

Declaration
public bool IsCastingShadows
Field Value
Type Description
System.Boolean

MaxDistance

Represents the attenuation of the light.

Declaration
public float MaxDistance
Field Value
Type Description
System.Single

OuterConeAngle

Represents the outer spot angle of the light.

Declaration
public float OuterConeAngle
Field Value
Type Description
System.Single

Strength

Represents the strength of the light (non-physically representation of the brightness). Needs be a value between 0 and 1.

Declaration
public float Strength
Field Value
Type Description
System.Single

Type

Represents the type of the light.

Declaration
public LightType Type
Field Value
Type Description
LightType

Implements

IComponent
Generated by DocFX
GitHub Repo
Back to top