Skip to main content

CompositionBatch Class

Definition

Assembly:Avalonia.Base
Package:Avalonia
Source:Batch.cs

Represents a group of serialized changes from the UI thread to be atomically applied at the render thread

public class CompositionBatch

Inheritance: object -> CompositionBatch

Properties

NameDescription
ProcessedIndicates that batch got deserialized on the render thread and will soon be rendered. It's generally a good time to start producing the next one
RenderedIndicates that batch got rendered on the render thread. It's generally a good time to start producing the next one

Processed Property

Indicates that batch got deserialized on the render thread and will soon be rendered. It's generally a good time to start producing the next one

public System.Threading.Tasks.Task Processed { get; set; }

Remarks

To allow timing-sensitive code to receive the notification in time, the TaskCompletionSource is configured to invoke continuations synchronously, so your await could happen from the render loop if it happens to run on the UI thread. It's recommended to use Dispatcher.AwaitOnPriority when consuming from the UI thread

Rendered Property

Indicates that batch got rendered on the render thread. It's generally a good time to start producing the next one

public System.Threading.Tasks.Task Rendered { get; set; }

Remarks

To allow timing-sensitive code to receive the notification in time, the TaskCompletionSource is configured to invoke continuations synchronously, so your await could happen from the render loop if it happens to run on the UI thread. It's recommended to use Dispatcher.AwaitOnPriority when consuming from the UI thread