Compositor Class

Reference

Definition

Namespace:: Windows.UI.Composition

Important

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

Edit

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.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
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(131072, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class Compositor final : IClosable

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

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

Public NotInheritable Class Compositor
Implements IDisposable

Inheritance: Object Platform::Object IInspectable Compositor

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IClosable IDisposable

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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

Creates an instance of Compositor.

Properties

Comment	Gets or sets a string to associate with the Compositor.
DefaultGraphicsDevice	Gets the default graphics device.
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, IIterable<String>)	Creates an instance of CompositionEffectFactory specifying effect parameters that should be animatable.
CreateEffectFactory(IGraphicsEffect)	Creates an instance of CompositionEffectFactory.
CreateEffectVisual()	Creates an instance of EffectVisual.
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.
CreateHostBackdropBrush()	Creates an instance of CompositionBackdropBrush that samples from the area behind the visual, before the window is drawn.
CreateImageVisual()	Creates an instance of ImageVisual.
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, Vector2, Vector2, Vector2, Vector2)	Creates an instance of RectangleClip with the specified edge and corner radius values.
CreateRectangleClip(Single, Single, Single, Single)	Creates an instance of RectangleClip with the specified edge 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.
CreateSolidColorVisual()	Creates an instance of SolidColorVisual.
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.
CreateTargetForCurrentView()	Creates a CompositionTarget for the current view.
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.
TryCreateBlurredWallpaperBackdropBrush()	Creates an instance of `CompositionBackdropBrush` that draws the blurred wallpaper behind the current visual.

Applies to

Dela via