CompositorController Class

Definition

Namespace:

Windows.UI.Composition.Core

Represents a compositor on which intended composition changes must be explicitly committed.

public ref class CompositorController sealed : IClosable

/// [Windows.Foundation.Metadata.Activatable(393216, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompositorController final : IClosable

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

Public NotInheritable Class CompositorController
Implements IDisposable

Inheritance

Object Platform::Object IInspectable CompositorController

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IClosable IDisposable

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)

Remarks

The CompositorController lets you create and control a compositor on which you must explicitly commit your intended composition changes. This is in contrast to the compositor you obtain from a visual returned by a call to ElementCompositionPreview.GetElementVisual, for which commits occur implicitly without requiring a direct call.

Constructors

CompositorController()

Initializes a new instance of the CompositorController class.

Properties

Compositor

Gets the compositor associated with this composition controller.

Methods

Close()	Releases system resources that are used by the CompositorController.
Commit()	Calls commit on the compositor associated with this CompositorController.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
EnsurePreviousCommitCompletedAsync()	Ensures the previous commit was completed.

Events

CommitNeeded

Occurs when the framework needs to call Commit in order for changes to Composition objects to be reflected onscreen.