Compositor Compositor Compositor Compositor Class

Definition

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 : sealed class Compositor : IClosable
struct winrt::Windows::UI::Composition::Compositor : IClosable
public sealed class Compositor : IDisposable
Public NotInheritable Class Compositor Implements IDisposable
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Version history

Windows version SDK version Value added
1607 14393 CreateAmbientLight
1607 14393 CreateAnimationGroup
1607 14393 CreateBackdropBrush
1607 14393 CreateDistantLight
1607 14393 CreateDropShadow
1607 14393 CreateImplicitAnimationCollection
1607 14393 CreateLayerVisual
1607 14393 CreateMaskBrush
1607 14393 CreateNineGridBrush
1607 14393 CreatePointLight
1607 14393 CreateSpotLight
1607 14393 CreateStepEasingFunction
1607 14393 CreateStepEasingFunction(Int32)
1703 15063 CreateHostBackdropBrush
1709 16299 CreateColorGradientStop
1709 16299 CreateColorGradientStop(Single,Color)
1709 16299 CreateLinearGradientBrush
1709 16299 CreateSpringScalarAnimation
1709 16299 CreateSpringVector2Animation
1709 16299 CreateSpringVector3Animation
1803 17134 Comment
1803 17134 CreateBounceScalarAnimation
1803 17134 CreateBounceVector2Animation
1803 17134 CreateBounceVector3Animation
1803 17134 CreateContainerShape
1803 17134 CreateEllipseGeometry
1803 17134 CreateLineGeometry
1803 17134 CreatePathGeometry
1803 17134 CreatePathGeometry(CompositionPath)
1803 17134 CreatePathKeyFrameAnimation
1803 17134 CreateRectangleGeometry
1803 17134 CreateRoundedRectangleGeometry
1803 17134 CreateShapeVisual
1803 17134 CreateSpriteShape
1803 17134 CreateSpriteShape(CompositionGeometry)
1803 17134 CreateViewBox
1803 17134 GlobalPlaybackRate
1803 17134 MaxGlobalPlaybackRate
1803 17134 MinGlobalPlaybackRate
1803 17134 RequestCommitAsync
1809 17763 CreateBooleanKeyFrameAnimation
1809 17763 CreateGeometricClip
1809 17763 CreateGeometricClip(CompositionGeometry)
1809 17763 CreateRedirectVisual
1809 17763 CreateRedirectVisual(Visual)
1903 18362 CreateProjectedShadow
1903 18362 CreateProjectedShadowCaster
1903 18362 CreateProjectedShadowReceiver
1903 18362 CreateRadialGradientBrush
1903 18362 CreateVisualSurface

Constructors

Compositor() Compositor() Compositor() Compositor()

Creates an instance of Compositor.

Properties

Comment Comment Comment Comment

Gets or sets a string to associate with the Compositor.

GlobalPlaybackRate GlobalPlaybackRate GlobalPlaybackRate GlobalPlaybackRate

Gets or sets the rate at which animation plays for all KeyFrame animations created by this compositor.

MaxGlobalPlaybackRate MaxGlobalPlaybackRate MaxGlobalPlaybackRate MaxGlobalPlaybackRate

Gets the maximum allowed playback rate for all KeyFrame animations created by this compositor..

MinGlobalPlaybackRate MinGlobalPlaybackRate MinGlobalPlaybackRate MinGlobalPlaybackRate

Gets the minimum allowed playback rate for all KeyFrame animations created by this compositor.

Methods

Close() Close() Close() Close()

Closes the Compositor object and releases system resources.

CreateAmbientLight() CreateAmbientLight() CreateAmbientLight() CreateAmbientLight()

Creates an instance of AmbientLight.

CreateAnimationGroup() CreateAnimationGroup() CreateAnimationGroup() CreateAnimationGroup()

Creates an instance of CompositionAnimationGroup.

CreateBackdropBrush() CreateBackdropBrush() CreateBackdropBrush() CreateBackdropBrush()

Creates an instance of CompositionBackdropBrush.

CreateBooleanKeyFrameAnimation() CreateBooleanKeyFrameAnimation() CreateBooleanKeyFrameAnimation() CreateBooleanKeyFrameAnimation()

Creates an instance of BooleanKeyFrameAnimation.

CreateBounceScalarAnimation() CreateBounceScalarAnimation() CreateBounceScalarAnimation() CreateBounceScalarAnimation()

Creates an instance of BounceScalarNaturalMotionAnimation.

CreateBounceVector2Animation() CreateBounceVector2Animation() CreateBounceVector2Animation() CreateBounceVector2Animation()

Creates an instance of BounceVector2NaturalMotionAnimation.

CreateBounceVector3Animation() CreateBounceVector3Animation() CreateBounceVector3Animation() CreateBounceVector3Animation()

Creates an instance of BounceVector3NaturalMotionAnimation.

CreateColorBrush() CreateColorBrush() CreateColorBrush() CreateColorBrush()

Creates an instance of CompositionColorBrush.

CreateColorBrush(Color) CreateColorBrush(Color) CreateColorBrush(Color) CreateColorBrush(Color)

Creates an instance of CompositionColorBrush using the specified color.

CreateColorGradientStop() CreateColorGradientStop() CreateColorGradientStop() CreateColorGradientStop()

Creates an instance of CompositionColorGradientStop.

CreateColorGradientStop(Single, Color) CreateColorGradientStop(Single, Color) CreateColorGradientStop(Single, Color) CreateColorGradientStop(Single, Color)

Creates an instance of CompositionColorGradientStop with the specified offset and color.

CreateColorKeyFrameAnimation() CreateColorKeyFrameAnimation() CreateColorKeyFrameAnimation() CreateColorKeyFrameAnimation()

Creates an instance of ColorKeyFrameAnimation.

CreateContainerShape() CreateContainerShape() CreateContainerShape() CreateContainerShape()

Creates an instance of CompositionContainerShape.

CreateContainerVisual() CreateContainerVisual() CreateContainerVisual() CreateContainerVisual()

Creates an instance of ContainerVisual.

CreateCubicBezierEasingFunction(Vector2, Vector2) CreateCubicBezierEasingFunction(Vector2, Vector2) CreateCubicBezierEasingFunction(Vector2, Vector2) CreateCubicBezierEasingFunction(Vector2, Vector2)

Creates an instance of CubicBezierEasingFunction.

CreateDistantLight() CreateDistantLight() CreateDistantLight() CreateDistantLight()

Creates an instance of DistantLight.

CreateDropShadow() CreateDropShadow() CreateDropShadow() CreateDropShadow()

Creates an instance of DropShadow.

CreateEffectFactory(IGraphicsEffect) CreateEffectFactory(IGraphicsEffect) CreateEffectFactory(IGraphicsEffect) CreateEffectFactory(IGraphicsEffect)

Creates an instance of CompositionEffectFactory.

CreateEffectFactory(IGraphicsEffect, IIterable<String>) CreateEffectFactory(IGraphicsEffect, IIterable<String>) CreateEffectFactory(IGraphicsEffect, IIterable<String>) CreateEffectFactory(IGraphicsEffect, IIterable<String>)

Creates an instance of CompositionEffectFactory specifying effect parameters that should be animatable.

CreateEllipseGeometry() CreateEllipseGeometry() CreateEllipseGeometry() CreateEllipseGeometry()

Creates an instance of CompositionEllipseGeometry.

CreateExpressionAnimation() CreateExpressionAnimation() CreateExpressionAnimation() CreateExpressionAnimation()

Creates an instance of ExpressionAnimation.

CreateExpressionAnimation(String) CreateExpressionAnimation(String) CreateExpressionAnimation(String) CreateExpressionAnimation(String)

Creates an instance of ExpressionAnimation.

CreateGeometricClip() CreateGeometricClip() CreateGeometricClip() CreateGeometricClip()

Creates an instance of CompositionGeometricClip.

CreateGeometricClip(CompositionGeometry) CreateGeometricClip(CompositionGeometry) CreateGeometricClip(CompositionGeometry) CreateGeometricClip(CompositionGeometry)

Creates an instance of CompositionGeometricClip using the specified geometry.

CreateHostBackdropBrush() CreateHostBackdropBrush() CreateHostBackdropBrush() CreateHostBackdropBrush()

Creates an instance of CompositionBackdropBrush that samples from the area behind the visual, before the window is drawn.

CreateImplicitAnimationCollection() CreateImplicitAnimationCollection() CreateImplicitAnimationCollection() CreateImplicitAnimationCollection()

Creates an instance of ImplicitAnimationCollection.

CreateInsetClip() CreateInsetClip() CreateInsetClip() CreateInsetClip()

Creates an instance of InsetClip.

CreateInsetClip(Single, Single, Single, Single) CreateInsetClip(Single, Single, Single, Single) CreateInsetClip(Single, Single, Single, Single) CreateInsetClip(Single, Single, Single, Single)

Creates an instance of InsetClip.

CreateLayerVisual() CreateLayerVisual() CreateLayerVisual() CreateLayerVisual()

Creates an instance of LayerVisual.

CreateLinearEasingFunction() CreateLinearEasingFunction() CreateLinearEasingFunction() CreateLinearEasingFunction()

Creates an instance of LinearEasingFunction.

CreateLinearGradientBrush() CreateLinearGradientBrush() CreateLinearGradientBrush() CreateLinearGradientBrush()

Creates an instance of CompositionLinearGradientBrush.

CreateLineGeometry() CreateLineGeometry() CreateLineGeometry() CreateLineGeometry()

Creates an instance of CompositionLineGeometry.

CreateMaskBrush() CreateMaskBrush() CreateMaskBrush() CreateMaskBrush()

Creates an instance of CompositionMaskBrush.

CreateNineGridBrush() CreateNineGridBrush() CreateNineGridBrush() CreateNineGridBrush()

Creates an instance of CompositionNineGridBrush.

CreatePathGeometry() CreatePathGeometry() CreatePathGeometry() CreatePathGeometry()

Creates an instance of CompositionPathGeometry.

CreatePathGeometry(CompositionPath) CreatePathGeometry(CompositionPath) CreatePathGeometry(CompositionPath) CreatePathGeometry(CompositionPath)

Creates an instance of CompositionPathGeometry using the specified path.

CreatePathKeyFrameAnimation() CreatePathKeyFrameAnimation() CreatePathKeyFrameAnimation() CreatePathKeyFrameAnimation()

Creates an instance of PathKeyFrameAnimation.

CreatePointLight() CreatePointLight() CreatePointLight() CreatePointLight()

Creates an instance of PointLight.

CreateProjectedShadow() CreateProjectedShadow() CreateProjectedShadow() CreateProjectedShadow()

Creates an instance of CompositionProjectedShadow.

CreateProjectedShadowCaster() CreateProjectedShadowCaster() CreateProjectedShadowCaster() CreateProjectedShadowCaster()

Creates an instance of CompositionProjectedShadowCaster.

CreateProjectedShadowReceiver() CreateProjectedShadowReceiver() CreateProjectedShadowReceiver() CreateProjectedShadowReceiver()

Creates an instance of CompositionProjectedShadowReceiver.

CreatePropertySet() CreatePropertySet() CreatePropertySet() CreatePropertySet()

Creates an instance of CompositionPropertySet.

CreateQuaternionKeyFrameAnimation() CreateQuaternionKeyFrameAnimation() CreateQuaternionKeyFrameAnimation() CreateQuaternionKeyFrameAnimation()

Creates an instance of QuaternionKeyFrameAnimation.

CreateRadialGradientBrush() CreateRadialGradientBrush() CreateRadialGradientBrush() CreateRadialGradientBrush()

Creates an instance of CompositionRadialGradientBrush.

CreateRectangleGeometry() CreateRectangleGeometry() CreateRectangleGeometry() CreateRectangleGeometry()

Creates an instance of CompositionRectangleGeometry.

CreateRedirectVisual() CreateRedirectVisual() CreateRedirectVisual() CreateRedirectVisual()

Creates an instance of RedirectVisual.

CreateRedirectVisual(Visual) CreateRedirectVisual(Visual) CreateRedirectVisual(Visual) CreateRedirectVisual(Visual)

Creates an instance of RedirectVisual using the specified source.

CreateRoundedRectangleGeometry() CreateRoundedRectangleGeometry() CreateRoundedRectangleGeometry() CreateRoundedRectangleGeometry()

Creates an instance of CompositionRoundedRectangleGeometry.

CreateScalarKeyFrameAnimation() CreateScalarKeyFrameAnimation() CreateScalarKeyFrameAnimation() CreateScalarKeyFrameAnimation()

Creates an instance of ScalarKeyFrameAnimation.

CreateScopedBatch(CompositionBatchTypes) CreateScopedBatch(CompositionBatchTypes) CreateScopedBatch(CompositionBatchTypes) CreateScopedBatch(CompositionBatchTypes)

Creates an instance of CompositionScopedBatch.

CreateShapeVisual() CreateShapeVisual() CreateShapeVisual() CreateShapeVisual()

Creates an instance of ShapeVisual.

CreateSpotLight() CreateSpotLight() CreateSpotLight() CreateSpotLight()

Creates an instance of SpotLight.

CreateSpringScalarAnimation() CreateSpringScalarAnimation() CreateSpringScalarAnimation() CreateSpringScalarAnimation()

Creates an instance of SpringScalarNaturalMotionAnimation.

CreateSpringVector2Animation() CreateSpringVector2Animation() CreateSpringVector2Animation() CreateSpringVector2Animation()

Creates an instance of SpringVector2NaturalMotionAnimation.

CreateSpringVector3Animation() CreateSpringVector3Animation() CreateSpringVector3Animation() CreateSpringVector3Animation()

Creates an instance of SpringVector3NaturalMotionAnimation.

CreateSpriteShape() CreateSpriteShape() CreateSpriteShape() CreateSpriteShape()

Creates an instance of CompositionSpriteShape.

CreateSpriteShape(CompositionGeometry) CreateSpriteShape(CompositionGeometry) CreateSpriteShape(CompositionGeometry) CreateSpriteShape(CompositionGeometry)

Creates an instance of CompositionSpriteShape using the specified geometry.

CreateSpriteVisual() CreateSpriteVisual() CreateSpriteVisual() CreateSpriteVisual()

Creates an instance of SpriteVisual.

CreateStepEasingFunction() CreateStepEasingFunction() CreateStepEasingFunction() CreateStepEasingFunction()

Creates an instance of StepEasingFunction.

CreateStepEasingFunction(Int32) CreateStepEasingFunction(Int32) CreateStepEasingFunction(Int32) CreateStepEasingFunction(Int32)

Creates an instance of StepEasingFunction with the specified step count.

CreateSurfaceBrush() CreateSurfaceBrush() CreateSurfaceBrush() CreateSurfaceBrush()

Creates an instance of CompositionSurfaceBrush.

CreateSurfaceBrush(ICompositionSurface) CreateSurfaceBrush(ICompositionSurface) CreateSurfaceBrush(ICompositionSurface) CreateSurfaceBrush(ICompositionSurface)

Creates an instance of CompositionSurfaceBrush using the specified composition surface.

CreateTargetForCurrentView() CreateTargetForCurrentView() CreateTargetForCurrentView() CreateTargetForCurrentView()

Creates a CompositionTarget for the current view.

CreateVector2KeyFrameAnimation() CreateVector2KeyFrameAnimation() CreateVector2KeyFrameAnimation() CreateVector2KeyFrameAnimation()

Creates an instance of Vector2KeyFrameAnimation.

CreateVector3KeyFrameAnimation() CreateVector3KeyFrameAnimation() CreateVector3KeyFrameAnimation() CreateVector3KeyFrameAnimation()

Creates an instance of Vector3KeyFrameAnimation.

CreateVector4KeyFrameAnimation() CreateVector4KeyFrameAnimation() CreateVector4KeyFrameAnimation() CreateVector4KeyFrameAnimation()

Creates an instance of Vector4KeyFrameAnimation.

CreateViewBox() CreateViewBox() CreateViewBox() CreateViewBox()

Creates an instance of CompositionViewBox.

CreateVisualSurface() CreateVisualSurface() CreateVisualSurface() CreateVisualSurface()

Creates an instance of CompositionVisualSurface.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

GetCommitBatch(CompositionBatchTypes) GetCommitBatch(CompositionBatchTypes) GetCommitBatch(CompositionBatchTypes) GetCommitBatch(CompositionBatchTypes)

Retrieves a commit batch for the current commit cycle.

RequestCommitAsync() RequestCommitAsync() RequestCommitAsync() RequestCommitAsync()

Attempts to initiate a commit cycle ansynchronously.

See also