DirectionalLightComponent Class

Definition

A light source that emits light globally into a fixed direction.

public ref class DirectionalLightComponent : Microsoft::Azure::RemoteRendering::LightComponentBase
public class DirectionalLightComponent : Microsoft.Azure.RemoteRendering.LightComponentBase
type DirectionalLightComponent = class
    inherit LightComponentBase
Public Class DirectionalLightComponent
Inherits LightComponentBase
Inheritance

Remarks

This component simulates a light source that is very far away, such as the sun or the moon. Consequently, the owner's position is ignored and only the orientation is used. The light shines into the direction of the negative z-axis of the owner Entity.

Properties

Color

The color of the light in Gamma color space.

(Inherited from LightComponentBase)
Enabled

Enabled state of this component.

(Inherited from ComponentBase)
Intensity

The overall brightness and range of the light.

(Inherited from LightComponentBase)
InteropId (Inherited from ObjectBase)
Owner

The Entity that this component is attached to.

(Inherited from ComponentBase)
Type

The exact type of this component.

(Inherited from ComponentBase)
Valid

Whether this component is still valid.

(Inherited from ComponentBase)

Methods

AsToolingObject<ToolingObject>() (Inherited from ObjectBase)
Destroy()

Destroys the component in the runtime.

(Inherited from ComponentBase)
Equals(Object) (Inherited from ObjectBase)
GetHashCode() (Inherited from ObjectBase)

Applies to

See also