Share via


LightComponentBase Class

Definition

Base class for all light components.

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

Remarks

Attaching a light component to an Entity turns it into a dynamic light source that illuminates the geometry in addition to the global sky light. The position and orientation of the entity determines the location and direction of the light.

Only geometry that uses a PbrMaterial will be affected by this light. Geometry that has a ColorMaterial assigned generally receives no lighting.

Properties

Color

The color of the light in Gamma color space.

Enabled

Enabled state of this component.

(Inherited from ComponentBase)
Intensity

The overall brightness and range of the light.

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