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
Windows 10 requirements
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
Windows.Foundation.UniversalApiContract (introduced v3)
_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);
|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.|
A Visual cannot be targeted by more than two non-ambient lights (PointLight, SpotLight or DistantLight).
|Comment Comment Comment Comment||
A string to associate with the CompositionObject.(Inherited from CompositionObject)
|Compositor Compositor Compositor Compositor||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)
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.