Compositor Class

Definition

Namespace:

Microsoft.UI.Composition

Manages the session between an application and the system compositor process.

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.

public ref class Compositor sealed : IClosable

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class Compositor final : IClosable

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Foundation.WindowsAppSDKContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class Compositor : System.IDisposable

function Compositor()

Public NotInheritable Class Compositor
Implements IDisposable

Inheritance

Object Platform::Object IInspectable Compositor

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IClosable IDisposable

Remarks

The Compositor implicitly synchronizes changes made to associated visuals to ensure they get applied in a transactional manner.

See the Composition UI Overview and Composition Visual Tree Overview for more information.

New instances of Compositor must be created on a thread that has a CoreDispatcher.

Constructors

Compositor()

Creates an instance of Compositor.

Properties

Comment	Gets or sets a string to associate with the Compositor.
DispatcherQueue	Gets the dispatcher queue for this compositor.
GlobalPlaybackRate	Gets or sets the rate at which animation plays for all KeyFrame animations created by this compositor.
MaxGlobalPlaybackRate	Gets the maximum allowed playback rate for all KeyFrame animations created by this compositor..
MinGlobalPlaybackRate	Gets the minimum allowed playback rate for all KeyFrame animations created by this compositor.

Methods

Close()	Closes the Compositor object and releases system resources.
CreateAmbientLight()	Creates an instance of AmbientLight.
CreateAnimationController()	Creates an instance of AnimationController.
CreateAnimationGroup()	Creates an instance of CompositionAnimationGroup.
CreateAnimationPropertyInfo()	Creates an instance of AnimationPropertyInfo.
CreateBackdropBrush()	Creates an instance of CompositionBackdropBrush.
CreateBooleanKeyFrameAnimation()	Creates an instance of BooleanKeyFrameAnimation.
CreateBounceScalarAnimation()	Creates an instance of BounceScalarNaturalMotionAnimation.
CreateBounceVector2Animation()	Creates an instance of BounceVector2NaturalMotionAnimation.
CreateBounceVector3Animation()	Creates an instance of BounceVector3NaturalMotionAnimation.
CreateColorBrush()	Creates an instance of CompositionColorBrush.
CreateColorBrush(Color)	Creates an instance of CompositionColorBrush using the specified color.
CreateColorGradientStop()	Creates an instance of CompositionColorGradientStop.
CreateColorGradientStop(Single, Color)	Creates an instance of CompositionColorGradientStop with the specified offset and color.
CreateColorKeyFrameAnimation()	Creates an instance of ColorKeyFrameAnimation.
CreateContainerShape()	Creates an instance of CompositionContainerShape.
CreateContainerVisual()	Creates an instance of ContainerVisual.
CreateCubicBezierEasingFunction(Vector2, Vector2)	Creates an instance of CubicBezierEasingFunction.
CreateDistantLight()	Creates an instance of DistantLight.
CreateDropShadow()	Creates an instance of DropShadow.
CreateEffectFactory(IGraphicsEffect)	Creates an instance of CompositionEffectFactory.
CreateEffectFactory(IGraphicsEffect, IIterable<String>)	Creates an instance of CompositionEffectFactory specifying effect parameters that should be animatable.
CreateEllipseGeometry()	Creates an instance of CompositionEllipseGeometry.
CreateExpressionAnimation()	Creates an instance of ExpressionAnimation.
CreateExpressionAnimation(String)	Creates an instance of ExpressionAnimation.
CreateGeometricClip()	Creates an instance of CompositionGeometricClip.
CreateGeometricClip(CompositionGeometry)	Creates an instance of CompositionGeometricClip using the specified geometry.
CreateImplicitAnimationCollection()	Creates an instance of ImplicitAnimationCollection.
CreateInsetClip()	Creates an instance of InsetClip.
CreateInsetClip(Single, Single, Single, Single)	Creates an instance of InsetClip.
CreateLayerVisual()	Creates an instance of LayerVisual.
CreateLinearEasingFunction()	Creates an instance of LinearEasingFunction.
CreateLinearGradientBrush()	Creates an instance of CompositionLinearGradientBrush.
CreateLineGeometry()	Creates an instance of CompositionLineGeometry.
CreateMaskBrush()	Creates an instance of CompositionMaskBrush.
CreateNineGridBrush()	Creates an instance of CompositionNineGridBrush.
CreatePathGeometry()	Creates an instance of CompositionPathGeometry.
CreatePathGeometry(CompositionPath)	Creates an instance of CompositionPathGeometry using the specified path.
CreatePathKeyFrameAnimation()	Creates an instance of PathKeyFrameAnimation.
CreatePointLight()	Creates an instance of PointLight.
CreateProjectedShadow()	Creates an instance of CompositionProjectedShadow.
CreateProjectedShadowCaster()	Creates an instance of CompositionProjectedShadowCaster.
CreateProjectedShadowReceiver()	Creates an instance of CompositionProjectedShadowReceiver.
CreatePropertySet()	Creates an instance of CompositionPropertySet.
CreateQuaternionKeyFrameAnimation()	Creates an instance of QuaternionKeyFrameAnimation.
CreateRadialGradientBrush()	Creates an instance of CompositionRadialGradientBrush.
CreateRectangleClip()	Creates an instance of RectangleClip with default values.
CreateRectangleClip(Single, Single, Single, Single)	Creates an instance of RectangleClip with the specified edge values.
CreateRectangleClip(Single, Single, Single, Single, Vector2, Vector2, Vector2, Vector2)	Creates an instance of RectangleClip with the specified edge and corner radius values.
CreateRectangleGeometry()	Creates an instance of CompositionRectangleGeometry.
CreateRedirectVisual()	Creates an instance of RedirectVisual.
CreateRedirectVisual(Visual)	Creates an instance of RedirectVisual using the specified source.
CreateRoundedRectangleGeometry()	Creates an instance of CompositionRoundedRectangleGeometry.
CreateScalarKeyFrameAnimation()	Creates an instance of ScalarKeyFrameAnimation.
CreateScopedBatch(CompositionBatchTypes)	Creates an instance of CompositionScopedBatch.
CreateShapeVisual()	Creates an instance of ShapeVisual.
CreateSpotLight()	Creates an instance of SpotLight.
CreateSpringScalarAnimation()	Creates an instance of SpringScalarNaturalMotionAnimation.
CreateSpringVector2Animation()	Creates an instance of SpringVector2NaturalMotionAnimation.
CreateSpringVector3Animation()	Creates an instance of SpringVector3NaturalMotionAnimation.
CreateSpriteShape()	Creates an instance of CompositionSpriteShape.
CreateSpriteShape(CompositionGeometry)	Creates an instance of CompositionSpriteShape using the specified geometry.
CreateSpriteVisual()	Creates an instance of SpriteVisual.
CreateStepEasingFunction()	Creates an instance of StepEasingFunction.
CreateStepEasingFunction(Int32)	Creates an instance of StepEasingFunction with the specified step count.
CreateSurfaceBrush()	Creates an instance of CompositionSurfaceBrush.
CreateSurfaceBrush(ICompositionSurface)	Creates an instance of CompositionSurfaceBrush using the specified composition surface.
CreateVector2KeyFrameAnimation()	Creates an instance of Vector2KeyFrameAnimation.
CreateVector3KeyFrameAnimation()	Creates an instance of Vector3KeyFrameAnimation.
CreateVector4KeyFrameAnimation()	Creates an instance of Vector4KeyFrameAnimation.
CreateViewBox()	Creates an instance of CompositionViewBox.
CreateVisualSurface()	Creates an instance of CompositionVisualSurface.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetCommitBatch(CompositionBatchTypes)	Retrieves a commit batch for the current commit cycle.
RequestCommitAsync()	Attempts to initiate a commit cycle ansynchronously.

See also

• Composition UI Overview
• Composition Visual Tree Overview
• IClosable
• Composition visual without framework sample (Windows 10)
• Version adaptive code sample