CompositionTarget Class

Definition

Represents the composited display surface for an app. This class provides application-wide rendering events.

Equivalent WinUI class: Microsoft.UI.Xaml.Media.CompositionTarget.

public ref class CompositionTarget sealed
/// [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 CompositionTarget final
[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 CompositionTarget
Public NotInheritable Class CompositionTarget
Inheritance
CompositionTarget
Attributes

Windows 10 requirements

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

Remarks

CompositionTarget events are useful for rendering scenarios like:

For scenarios that don't involve custom rendering or frame time measurement you probably won't need CompositionTarget and can just rely on the XAML rendering system running and performing all your composition and layout.

Version history

Windows version SDK version Value added
1803 17134 Rendered

Events

Rendered

Occurs immediately after the core rendering process renders a frame. This event lets you determine how long each frame takes to render.

Equivalent WinUI event: Microsoft.UI.Xaml.Media.CompositionTarget.Rendered.

Rendering

Occurs when the core rendering process renders a frame.

Equivalent WinUI event: Microsoft.UI.Xaml.Media.CompositionTarget.Rendering.

SurfaceContentsLost

Occurs when an underlying major change occurs, such as a DirectX device change. Typically the application must regenerate its surface contents when notified of this event.

Equivalent WinUI event: Microsoft.UI.Xaml.Media.CompositionTarget.SurfaceContentsLost.

Applies to

See also