SpotLight SpotLight SpotLight SpotLight Class

Definition

A light source that casts inner and outer cones of light. For example, a flashlight.

public : sealed class SpotLight : CompositionLight, ISpotLight, ISpotLight2, ISpotLight3
struct winrt::Windows::UI::Composition::SpotLight : CompositionLight, ISpotLight, ISpotLight2, ISpotLight3
public sealed class SpotLight : CompositionLight, ISpotLight, ISpotLight2, ISpotLight3
Public NotInheritable Class SpotLight Inherits CompositionLight Implements ISpotLight, ISpotLight2, ISpotLight3
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Examples


_spotLight = _compositor.CreateSpotLight(); 
_spotLight.CoordinateSpace = root; 
_spotLight.InnerConeAngleInDegrees = 30; 
_spotLight.InnerConeColor = Colors.Red; 
_spotLight.OuterConeAngleInDegrees = 45; 
_spotLight.OuterConeColor = Colors.Yellow; 
_spotLight.Offset = new Vector3(30, 30, 200); 
_spotLight.Targets.Add(root); 

Remarks

SpotLight is one of the four light types derived from CompositionLight.

LightDescription
AmbientLight A light source that emits non directional light that appears to have been reflected by everything in the scene.
DistantLight An infinitely large distant light source that emits light in a single direction.
PointLight A point source of light that emits light in all directions.
SpotLight A light source that emits inner and outer cones of light.

Note

A Visual cannot be targeted by more than two non-ambient lights (PointLight, SpotLight or DistantLight).

Properties

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
ConstantAttenuation ConstantAttenuation ConstantAttenuation ConstantAttenuation

The constant coefficient in the light's attenuation equation. Controls light intensity. Animatable.

CoordinateSpace CoordinateSpace CoordinateSpace CoordinateSpace

The Visual used to determine the light's direction and offset. The light's offset and direction properties are relative to this Visual's coordinate space. SpotLight.CoordinateSpace is a required property. If SpotLight.CoordinateSpace is not set, the SpotLight will not render.

Direction Direction Direction Direction

The direction in which the light is pointing, specified relative to its CoordinateSpace Visual.

Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ExclusionsFromTargets ExclusionsFromTargets ExclusionsFromTargets ExclusionsFromTargets

Gets a collection of Visuals that are not targeted by the light.

(Inherited from CompositionLight)
ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
InnerConeAngle InnerConeAngle InnerConeAngle InnerConeAngle

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in radians. Animatable.

InnerConeAngleInDegrees InnerConeAngleInDegrees InnerConeAngleInDegrees InnerConeAngleInDegrees

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in degrees. Animatable.

InnerConeColor InnerConeColor InnerConeColor InnerConeColor

Color of the spotlight's inner cone. Animatable.

InnerConeIntensity InnerConeIntensity InnerConeIntensity InnerConeIntensity

Gets or sets the intensity of the light in the spotlight's inner cone.

IsEnabled IsEnabled IsEnabled IsEnabled

Gets or sets a value that determines whether the composition light is on.

(Inherited from CompositionLight)
LinearAttenuation LinearAttenuation LinearAttenuation LinearAttenuation

The linear coefficient in the light's attenuation equation that determines how the light falls off with distance. Animatable.

MaxAttenuationCutoff MaxAttenuationCutoff MaxAttenuationCutoff MaxAttenuationCutoff

Gets or sets the maximum range at which this light is effective.

MinAttenuationCutoff MinAttenuationCutoff MinAttenuationCutoff MinAttenuationCutoff

Gets or sets the minimum range at which this light is effective.

Offset Offset Offset Offset

Offset of the light source relative to its CoordinateSpace Visual. Animatable.

OuterConeAngle OuterConeAngle OuterConeAngle OuterConeAngle

The SpotLight’s outer cone angle, expressed as a semi-vertical angle in radians. Animatable.

OuterConeAngleInDegrees OuterConeAngleInDegrees OuterConeAngleInDegrees OuterConeAngleInDegrees

The semi-vertical angle, in degrees, of the SpotLight's outer cone. Animatable.

OuterConeColor OuterConeColor OuterConeColor OuterConeColor

The color of the spotlight's outer cone. Animatable.

OuterConeIntensity OuterConeIntensity OuterConeIntensity OuterConeIntensity

Gets or sets the intensity of the light in the spotlight's outer cone.

Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
QuadraticAttenuation QuadraticAttenuation QuadraticAttenuation QuadraticAttenuation

The quadratic portion of the attenuation equation that determines how the light falls off with distance. Animatable.

Targets Targets Targets Targets

The collection of Visuals targeted by the light.

(Inherited from CompositionLight)

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from CompositionObject)
StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Starts an animation group.

The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

(Inherited from CompositionObject)
StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase)

Starts an animation group on the specified target.

(Inherited from CompositionObject)
StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation)

Connects an animation with the specified property of the target object and starts the animation.

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

(Inherited from CompositionObject)

See Also