PointLight Class

Definition

A point source of light that emanates light in all directions.

public ref class PointLight sealed : CompositionLight
/// [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 PointLight final : CompositionLight
[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 sealed class PointLight : CompositionLight
Public NotInheritable Class PointLight
Inherits CompositionLight
Inheritance
Attributes
Windows.Foundation.Metadata.ContractVersionAttribute Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.WebHostHiddenAttribute

Remarks

A PointLight gives off light equally in all directions.

PointLight is one of the four light types derived from CompositionLight.

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.
PointLightA 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

Color

Color of the light.

Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
ConstantAttenuation

The constant coefficient in the light's attenuation equation. Controls light intensity.

CoordinateSpace

The Visual used to determine the light's offset. The light's offset property is relative to this Visual's coordinate space. PointLight.CoordinateSpace is a required property. If PointLight.CoordinateSpace is not set, the PointLight will not render.

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

The linear coefficient in the light's attenuation equation that determines how the light falls-off with distance.

MaxAttenuationCutoff

Gets or sets the maximum range at which this light is effective.

MinAttenuationCutoff

Gets or sets the minimum range at which this light is effective.

Offset

Offset of the light source relative to its coordinate space Visual.

Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
QuadraticAttenuation

The quadratic portion of the attenuation equation that determines how the light falls off with distance.

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)

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