CompositionLight Class

Definition

Base class for a light source that can target a UI scene.

The CompositionLight.Targets property determines which Visuals are lit.

[WebHostHidden]
public ref class CompositionLight : CompositionObject
public ref class CompositionLight : CompositionObject
/// [Windows.Foundation.Metadata.Composable(Microsoft.UI.Composition.ICompositionLightFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Microsoft.Foundation.LiftedContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[WebHostHidden]
class CompositionLight : CompositionObject
/// [Windows.Foundation.Metadata.Composable(Microsoft.UI.Composition.ICompositionLightFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Microsoft.Foundation.LiftedContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class CompositionLight : CompositionObject
[Windows.Foundation.Metadata.Composable(typeof(Microsoft.UI.Composition.ICompositionLightFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Microsoft.Foundation.LiftedContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.LiftedContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class CompositionLight : CompositionObject
[Windows.Foundation.Metadata.Composable(typeof(Microsoft.UI.Composition.ICompositionLightFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Microsoft.Foundation.LiftedContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.LiftedContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class CompositionLight : CompositionObject
Public Class CompositionLight
Inherits CompositionObject
Inheritance
CompositionLight
Derived
Attributes
Windows.Foundation.Metadata.ComposableAttribute Windows.Foundation.Metadata.ContractVersionAttribute Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.WebHostHiddenAttribute

Remarks

CompositionLight is the base class for four light types.

LightDescription
@"Microsoft.UI.Composition.AmbientLight?text=AmbientLight" A light source that emits non directional light that appears to have been reflected by everything in the scene.
@"Microsoft.UI.Composition.DistantLight?text=DistantLight" An infinitely large distant light source that emits light in a single direction.
@"Microsoft.UI.Composition.PointLight?text=PointLight" A point source of light that emits light in all directions.
@"Microsoft.UI.Composition.SpotLight?text=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

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor

The Compositor used to create this 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.

ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
IsEnabled

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

Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
Targets

The collection of Visuals targeted by the light.

Methods

Close()

Closes the CompositionObject and releases system resources.

(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)

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)

Applies to

See also