Ambient​Light Ambient​Light Ambient​Light Ambient​Light Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
A light that illuminates every targeted Visual equally.

public : sealed class AmbientLight : CompositionLight, IAmbientLight, IAmbientLight2public sealed class AmbientLight : CompositionLight, IAmbientLight, IAmbientLight2Public NotInheritable Class AmbientLight Inherits CompositionLight Implements IAmbientLight, IAmbientLight2// This API is not available in Javascript.
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Inherited Members

Inherited methods

Inherited properties

Examples


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

Remarks

AmbientLight 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

Color Color Color Color

Color of the light. Animatable.

public : Color Color { get; set; }public Color Color { get; set; }Public ReadWrite Property Color As Color// This API is not available in Javascript.
Value
Color Color Color Color

The color of the ambient light.

Intensity Intensity Intensity Intensity

Prerelease. Gets or sets the intensity of the light.

public : float Intensity { get; set; }public float Intensity { get; set; }Public ReadWrite Property Intensity As float// This API is not available in Javascript.
Value
float float float float

The intensity of the light.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16225.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

See Also