SpotLightComponent Class

  • Reference

Definition

Namespace:
Microsoft.Azure.RemoteRendering
Assembly:
RemoteRenderingClientCS.dll

A light source that emits light within a directed cone.

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

Remarks

In contrast to the PointLightComponent, this component only emits light within a cone shape. The main direction of the cone is along the owner's negative z-axis. Typical use cases for spotlights are flashlights. However, they can also be used to emulate the shadow of point lights that are encased in a hull.

Properties

AttenuationCutoff

Custom interval of min/max distances over which the light's attenuated intensity is scaled down to zero.
Color

The color of the light in Gamma color space.

(Inherited from LightComponentBase)
Enabled

Enabled state of this component.

(Inherited from ComponentBase)
FalloffExponent

The strength of the light falloff between the inner and outer cone angle.
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)
Projected2dTexture

Optional 2D Texture to be projected onto geometry.
Radius

The radius of the light emitting shape.
SpotAngleDeg

The inner and outer angle (in degree) of the spot light cone.
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