IRenderer Interface

Summary

Defines the interface for a renderer.
Namespace
Avalonia.Rendering
Interfaces
  • IDisposable
Implementing Types
graph BT Type-.->Interface0["IDisposable"] Type["IRenderer"] class Type type-node Implementing0["ImmediateRenderer"]-.->Type click Implementing0 "/api/Avalonia.Rendering/ImmediateRenderer" Implementing1["DeferredRenderer"]-.->Type click Implementing1 "/api/Avalonia.Rendering/DeferredRenderer"

Syntax

public interface IRenderer : IDisposable

Events

Name Type Summary
SceneInvalidated EventHandler<SceneInvalidatedEventArgs>
Raised when a portion of the scene has been invalidated.

Properties

Name Value Summary
DrawDirtyRects bool
Gets or sets a value indicating whether the renderer should draw a visual representation of its dirty rectangles.
DrawFps bool
Gets or sets a value indicating whether the renderer should draw an FPS counter.

Methods

Name Value Summary
AddDirty(IVisual) void
Mark a visual as dirty and needing re-rendering.
HitTest(Point, IVisual, Func<IVisual, bool>) IEnumerable<IVisual>
Hit tests a location to find the visuals at the specified point.
HitTestFirst(Point, IVisual, Func<IVisual, bool>) IVisual
Hit tests a location to find first visual at the specified point.
Paint(Rect) void
Called when a paint notification is received by the control being rendered.
RecalculateChildren(IVisual) void
Informs the renderer that the z-ordering of a visual's children has changed.
Resized(Size) void
Called when a resize notification is received by the control being rendered.
Start() void
Starts the renderer.
Stop() void
Stops the renderer.