Windows.UI.Composition
Windows.UI.Composition
Windows.UI.Composition
Windows.UI.Composition
Namespace
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.
[This namespace contains one or more prerelease APIs.]
Provides APIs for user interface composition.
Classes
| AmbientLight AmbientLight AmbientLight AmbientLight |
[Contains prerelease APIs.] |
| ColorKeyFrameAnimation ColorKeyFrameAnimation ColorKeyFrameAnimation ColorKeyFrameAnimation |
A time-based animation that targets the Color property with one or more color key frames. The ColorKeyFrameAnimation class is one of the supported types of KeyFrameAnimation s that is used to animate the Color property off of the Brush property on a SpriteVisual. When working with ColorKeyFrameAnimation s, utilize Windows.UI.Color objects for the values of keyframes. Utilize the InterpolationColorSpace property to define which color space the system will interpolate through for the animation. |
| CompositionAnimation CompositionAnimation CompositionAnimation CompositionAnimation |
[Contains prerelease APIs.] |
| CompositionAnimationGroup CompositionAnimationGroup CompositionAnimationGroup CompositionAnimationGroup |
Defines a group of animations. CompositionAnimationGroup provides a way to group CompositionAnimation s in a list which will be started at the same time when StartAnimationGroup is called on CompositionObject. All ComositionAnimation in CompositionAnimationGroup need to assign a value to the Target property in the animation itself. CompositionAnimationGroup can also be associated with ImplicitAnimationCollection as an animation that gets executed as a result of a trigger. |
| CompositionBackdropBrush CompositionBackdropBrush CompositionBackdropBrush CompositionBackdropBrush |
A brush that applies an effect (or a chain of effects) to the region behind a SpriteVisual. |
| CompositionBatchCompletedEventArgs CompositionBatchCompletedEventArgs CompositionBatchCompletedEventArgs CompositionBatchCompletedEventArgs |
Arguments for the CompositionCommitBatch.Completed or CompositionScopedBatch.Completed events. |
| CompositionBrush CompositionBrush CompositionBrush CompositionBrush |
Base class for brushes used to paint a SpriteVisual. |
| CompositionCapabilities CompositionCapabilities CompositionCapabilities CompositionCapabilities |
Provides the ability to check system hardware capabilities so that Visual Layer Effects may be scaled accordingly. This allows you to ensure that your application's use of rendering-intensive operations is tailored to match the device's capabilities, providing optimum performance and pleasant visual results. |
| CompositionClip CompositionClip CompositionClip CompositionClip |
Base class for clipping objects such as InsetClip. |
| CompositionColorBrush CompositionColorBrush CompositionColorBrush CompositionColorBrush |
Paints a SpriteVisual with a solid color. |
| CompositionColorGradientStop CompositionColorGradientStop CompositionColorGradientStop CompositionColorGradientStop |
[Contains prerelease APIs.] |
| CompositionColorGradientStopCollection CompositionColorGradientStopCollection CompositionColorGradientStopCollection CompositionColorGradientStopCollection |
[Contains prerelease APIs.] |
| CompositionCommitBatch CompositionCommitBatch CompositionCommitBatch CompositionCommitBatch |
A group of active animations or effects. |
| CompositionDrawingSurface CompositionDrawingSurface CompositionDrawingSurface CompositionDrawingSurface |
A drawing surface for interoperation with Direct2D or Direct3D. |
| CompositionEasingFunction CompositionEasingFunction CompositionEasingFunction CompositionEasingFunction |
Base class for interpolator functions to use with KeyFrameAnimations. The CompositionEasingFunction class is the base class for easing functions that are used with KeyFrameAnimation s. Easing functions are used to describe how the system interpolates between two different keyframes. Currently, there are three supported easing functions: Linear, Cubic Bezier and Step. |
| CompositionEffectBrush CompositionEffectBrush CompositionEffectBrush CompositionEffectBrush |
A brush contianing an effect created with the CompositionEffectFactory.CreateBrush method. |
| CompositionEffectFactory CompositionEffectFactory CompositionEffectFactory CompositionEffectFactory |
Creates a composition object that contains a Win2D effect description format in the Microsoft.Graphics.Canvas.Effects namespace. NoteEffects that are not supported are marked as [NoComposition] in the Win2D API Reference for effects namespace. |
| CompositionEffectSourceParameter CompositionEffectSourceParameter CompositionEffectSourceParameter CompositionEffectSourceParameter |
Used to declare an arbitrary name (a String) to be associated with a CompositionBrush (the “effect source”). The association of the given name and the effect source occurs when the SetSourceParameter method of a CompositionEffectBrush is called. |
| CompositionGradientBrush CompositionGradientBrush CompositionGradientBrush CompositionGradientBrush |
[Contains prerelease APIs.] |
| CompositionGraphicsDevice CompositionGraphicsDevice CompositionGraphicsDevice CompositionGraphicsDevice |
Used to create all hardware bound resources for a given DirectX device on a compositor session. CompositionGraphicsDevice contains a DirectX device that is used to perform the GPU operations. Developers can obtain a Graphics device from the compositor top level object. |
| CompositionLight CompositionLight CompositionLight CompositionLight |
[Contains prerelease APIs.] The CompositionLight.Targets property determines which Visuals are lit. |
| CompositionLinearGradientBrush CompositionLinearGradientBrush CompositionLinearGradientBrush CompositionLinearGradientBrush |
[Contains prerelease APIs.] |
| CompositionMaskBrush CompositionMaskBrush CompositionMaskBrush CompositionMaskBrush |
A brush that paints a SpriteVisual with masked content. CompositionMaskBrush provides an optimized method for masking surfaces or solid color rectangles with opacity mask surfaces. |
| CompositionNineGridBrush CompositionNineGridBrush CompositionNineGridBrush CompositionNineGridBrush |
Paints a SpriteVisual after applying Nine-Grid Stretching to the contents of its Source brush. |
| CompositionObject CompositionObject CompositionObject CompositionObject |
[Contains prerelease APIs.] Composition objects are the visual tree structure on which all other features of the composition API use and build on. The API allows developers to define and create one or many Visual objects each representing a single node in a Visual tree. |
| CompositionPropertySet CompositionPropertySet CompositionPropertySet CompositionPropertySet |
Stores values as key-value pairs. CompositionPropertySet s are CompositionObject s that allow storage of key values pairs that can be shared across the application and are not tied to the lifetime of another composition object. CompositionPropertySet s are most commonly used with animations, where they maintain key-value pairs that are referenced to drive portions of composition animations. CompositionPropertySet s provide the ability to insert key-value pairs or retrieve a value for a given key. For more information on using CompositionPropertySet with animations, see the Animations Overview page. |
| CompositionScopedBatch CompositionScopedBatch CompositionScopedBatch CompositionScopedBatch |
An explicitly created group of active animations or effects. |
| CompositionShadow CompositionShadow CompositionShadow CompositionShadow |
Base class for shadows that can be applied to a SpriteVisual. |
| CompositionSurfaceBrush CompositionSurfaceBrush CompositionSurfaceBrush CompositionSurfaceBrush |
Paints a SpriteVisual with pixels from an ICompositionSurface. |
| CompositionTarget CompositionTarget CompositionTarget CompositionTarget |
Represents the window on which to display the composition tree. |
| CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface |
Represents sparsely allocated bitmaps that can be associated with visuals for composition in a visual tree. |
| Compositor Compositor Compositor Compositor |
[Contains prerelease APIs.] The Compositor class creates an instance of the Compositor for the application that can be used as a factory for a variety of types in the Windows.UI.Composition namespace spanning the visual layer, effects system and animation system. The Compositor class also manages the lifetime of objects created from the factory. |
| ContainerVisual ContainerVisual ContainerVisual ContainerVisual |
A node in the visual tree that can have children. |
| CubicBezierEasingFunction CubicBezierEasingFunction CubicBezierEasingFunction CubicBezierEasingFunction |
Represents a cubic-bezier function for interpolating between animation key frames. The cubic-bezier function is one of the more common easing functions used with KeyFrameAnimation s and are used frequently to describe smooth curves that can be scaled. Cubic-bezier functions are defined by two “control points” of type Vector2 that define the shape of the curve. When used, the animating property will change in between two keyframes based on the defined curve. |
| DistantLight DistantLight DistantLight DistantLight |
[Contains prerelease APIs.] |
| DropShadow DropShadow DropShadow DropShadow |
[Contains prerelease APIs.] |
| ExpressionAnimation ExpressionAnimation ExpressionAnimation ExpressionAnimation |
A Composition Animation that uses a mathematical equation to calculate the value for an animating property every frame. |
| ImplicitAnimationCollection ImplicitAnimationCollection ImplicitAnimationCollection ImplicitAnimationCollection |
A collection of animations triggered when a condition is met. |
| InitialValueExpressionCollection InitialValueExpressionCollection InitialValueExpressionCollection InitialValueExpressionCollection |
[Contains prerelease APIs.] |
| InsetClip InsetClip InsetClip InsetClip |
Clips a portion of a visual. The visible portion of the visual is a rectangle defined as inset values from the edges of the visual. The portion of the visual outside the rectangle is clipped. InsetClips are defined using offsets from the bottom, left, right and top of the Visual to be clipped in pixels. It is possible to fully clip the entire Visual. Negative values are allowed. InsetClips support all the same transforms as Visuals except the 4x4 matrix. Unlike Visuals, InsetClips are 2D and are defined, instead, with a 3x2 matrix. InsetClip properties are fully animatible. |
| KeyFrameAnimation KeyFrameAnimation KeyFrameAnimation KeyFrameAnimation |
A time-based animation with one or more key frames. These frames are markers, allowing developers to specify values at specific times for the animating property. KeyFrame animations can be further customized by specifying how the animation interpolates between keyframes. |
| LayerVisual LayerVisual LayerVisual LayerVisual |
[Contains prerelease APIs.] |
| LinearEasingFunction LinearEasingFunction LinearEasingFunction LinearEasingFunction |
Represents a linear function for interpolating between animation key frames. The linear function of another supported easing function that can be used with KeyFrame Animations. When used, the animating property will change in between two KeyFrames linearly over time. |
| NaturalMotionAnimation NaturalMotionAnimation NaturalMotionAnimation NaturalMotionAnimation |
[Contains prerelease APIs.] |
| PointLight PointLight PointLight PointLight |
[Contains prerelease APIs.] |
| QuaternionKeyFrameAnimation QuaternionKeyFrameAnimation QuaternionKeyFrameAnimation QuaternionKeyFrameAnimation |
A time-based animation that targets the Orientation property with one or more key frames. The QuaternionKeyFrameAnimation class is one of the supported types of KeyFrameAnimation s that is used to animate the Orientation property on a Visual. Quaternions are a useful and sometimes simpler way to think about rotations – Quaternions take the shortest path between angles and avoid issues like Gimbal Lock that rotation angle/axis and rotation matrices run into. A Quaternion is made up of two components: a scalar and vector part. |
| RenderingDeviceReplacedEventArgs RenderingDeviceReplacedEventArgs RenderingDeviceReplacedEventArgs RenderingDeviceReplacedEventArgs |
Arguments for the RenderingDeviceReplaced event. |
| ScalarKeyFrameAnimation ScalarKeyFrameAnimation ScalarKeyFrameAnimation ScalarKeyFrameAnimation |
A time-based animation that targets any Scalar-based property with one or more key frames. |
| ScalarNaturalMotionAnimation ScalarNaturalMotionAnimation ScalarNaturalMotionAnimation ScalarNaturalMotionAnimation |
[Contains prerelease APIs.] |
| SpotLight SpotLight SpotLight SpotLight |
[Contains prerelease APIs.] |
| SpringScalarNaturalMotionAnimation SpringScalarNaturalMotionAnimation SpringScalarNaturalMotionAnimation SpringScalarNaturalMotionAnimation |
[Contains prerelease APIs.] |
| SpringVector2NaturalMotionAnimation SpringVector2NaturalMotionAnimation SpringVector2NaturalMotionAnimation SpringVector2NaturalMotionAnimation |
[Contains prerelease APIs.] |
| SpringVector3NaturalMotionAnimation SpringVector3NaturalMotionAnimation SpringVector3NaturalMotionAnimation SpringVector3NaturalMotionAnimation |
[Contains prerelease APIs.] |
| SpriteVisual SpriteVisual SpriteVisual SpriteVisual |
Hosts 2D boxed content of type CompositionBrush. Any part of the visual not covered by pixels from the brush are rendered as transparent pixels. CompositionBrush can be either a CompositionBackdropBrush, CompositionColorBrush, a CompositionSurfaceBrush or a CompositionEffectBrush. |
| StepEasingFunction StepEasingFunction StepEasingFunction StepEasingFunction |
A step function for interpolating between animation key frames. Advances animations in increments like steps which can be can be defined. Behaviors for initial and final steps can be customized. |
| Vector2KeyFrameAnimation Vector2KeyFrameAnimation Vector2KeyFrameAnimation Vector2KeyFrameAnimation |
A time-based animation that targets any Vector2-based property with one or more key frames. |
| Vector2NaturalMotionAnimation Vector2NaturalMotionAnimation Vector2NaturalMotionAnimation Vector2NaturalMotionAnimation |
[Contains prerelease APIs.] |
| Vector3KeyFrameAnimation Vector3KeyFrameAnimation Vector3KeyFrameAnimation Vector3KeyFrameAnimation |
A time-based animation that targets any Vector3-based property with one or more keyframes. |
| Vector3NaturalMotionAnimation Vector3NaturalMotionAnimation Vector3NaturalMotionAnimation Vector3NaturalMotionAnimation |
[Contains prerelease APIs.] |
| Vector4KeyFrameAnimation Vector4KeyFrameAnimation Vector4KeyFrameAnimation Vector4KeyFrameAnimation |
A time-based animation that targets any Vector4-based property with one or more keyframes. |
| Visual Visual Visual Visual |
[Contains prerelease APIs.] |
| VisualCollection VisualCollection VisualCollection VisualCollection |
Represents a collection of visual instances. |
| VisualUnorderedCollection VisualUnorderedCollection VisualUnorderedCollection VisualUnorderedCollection |
An unordered collection of visuals. |
Interfaces
| ICompositionAnimationBase ICompositionAnimationBase ICompositionAnimationBase ICompositionAnimationBase |
Base class for composition animations. |
| ICompositionSurface ICompositionSurface ICompositionSurface ICompositionSurface |
Represents the content of a SpriteVisual. All object types that can be set as content of a SpriteVisual must implement this interface. For example, CompositionImage is one of the content types that implements ICompositionSurface. A single ICompositionSurface can be set as content for multiple SpriteVisual(s). |
Enums
Remarks
Windows.UI.Composition Overviews, Samples, and Known Issues
| Item | Description |
|---|---|
| Windows.UI.Composition Overview | Overview and architecture of the API |
| Windows.UI.Composition Samples | API samples in the official Github |
| Known Issues and Latest Information | Latest updates on the API in the MSDN Forums |