AmbientLight Class

Definition

Namespace:

Microsoft.UI.Composition

A light that illuminates every targeted Visual equally .

public ref class AmbientLight sealed : CompositionLight

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class AmbientLight final : CompositionLight

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class AmbientLight : CompositionLight

Public NotInheritable Class AmbientLight
Inherits CompositionLight

Inheritance

Object Platform::Object IInspectable CompositionObject CompositionLight AmbientLight

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

_ambientLight = _compositor.CreateAmbientLight(); 
_ambientLight.Color = Colors.Yellow; 
_ambientLight.Targets.Add(root);          

Remarks

AmbientLight 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).

Properties

Color	Color of the light. Animatable.
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 CompositionObject. (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)
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)

See also

• CompositionLight
• Targets
• CreateAmbientLight()