DistantLight Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An infinitely large distant light source that emits light in a single direction. For example, a distant light could be used to represent sunlight.
public ref class DistantLight sealed : CompositionLight/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DistantLight final : CompositionLight[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DistantLight : CompositionLightPublic NotInheritable Class DistantLight
Inherits CompositionLight- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v3.0)
|
Examples
_distantLight = _compositor.CreateDistantLight();
_distantLight.Color = Colors.Yellow;
_distantLight.Direction = new Vector3(0,-1, 0);
_distantLight.CoordinateSpace = root;
_distantLight.Targets.Add(root);
Remarks
DistantLights and SpotLights support direction.
DistantLight is one of the four light types derived from CompositionLight.
| Light | Description |
|---|---|
| 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).
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1709 | 16299 | Intensity |
Properties
| Color |
Color of the emitted DistantLight. |
| Comment |
A string to associate with the CompositionObject. (Inherited from CompositionObject) |
| Compositor |
The Compositor used to create this CompositionObject. (Inherited from CompositionObject) |
| CoordinateSpace |
The Visual used to determine the light’s direction. The light's Direction property is relative to this Visual’s coordinate space. is a required property. If CoordinateSpace is not set, the DistantLight will not render. |
| Direction |
The direction in which the light is pointing, specified relative to its CoordinateSpace Visual. |
| Dispatcher |
The dispatcher for the CompositionObject. (Inherited from CompositionObject) |
| DispatcherQueue |
Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject) |
| ExclusionsFromTargets |
Gets a collection of Visuals that are not targeted by the light. (Inherited from CompositionLight) |
| ImplicitAnimations |
The collection of implicit animations attached to this object. (Inherited from CompositionObject) |
| Intensity |
Gets or sets the intensity of the light. |
| IsEnabled |
Gets or sets a value that determines whether the composition light is on. (Inherited from CompositionLight) |
| Properties |
The collection of properties associated with the CompositionObject. (Inherited from CompositionObject) |
| Targets |
The collection of Visuals targeted by the light. (Inherited from CompositionLight) |
Methods
| Close() |
Closes the CompositionObject and releases system resources. (Inherited from CompositionObject) |
| ConnectAnimation(String, CompositionAnimation) |
Connects and animation. (Inherited from CompositionObject) |
| DisconnectAnimation(String) |
Disconnects an animation. (Inherited from CompositionObject) |
| Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject) |
| PopulatePropertyInfo(String, AnimationPropertyInfo) |
Defines a property that can be animated. (Inherited from CompositionObject) |
| StartAnimation(String, CompositionAnimation, AnimationController) |
Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject) |
| StartAnimation(String, CompositionAnimation) |
Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject) |
| 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) |
| StopAnimation(String) |
Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject) |
| StopAnimationGroup(ICompositionAnimationBase) |
Stops an animation group. (Inherited from CompositionObject) |
| TryGetAnimationController(String) |
Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject) |