IRenderer Interface
Definition
Section titled “Definition”Draws a surface.
public interface IRenderer : IDisposableProperties
Section titled “Properties”The name used to create the renderer from the host.
string Name { get; set; }Output
Section titled “Output”The output texture created by the renderer.
ITexture Output { get; }Opacity
Section titled “Opacity”A 0 to 255 value represening how transparent the surface is when drawn to the screen. 255 represents full visibility.
byte Opacity { get; set; }IsForced
Section titled “IsForced”true when the renderer is being forced to be redrawn this frame; otherwise false.
bool IsForced { get; set; }The render steps for the renderer.
List<IRenderStep> Steps { get; set; }Methods
Section titled “Methods”Refresh(IScreenSurface, bool)
Section titled “Refresh(IScreenSurface, bool)”Refreshes a cached drawing state.
void Refresh(IScreenSurface surface, bool force = false)Parameters
Section titled “Parameters”surface IScreenSurface
Target surface.
force bool
When true, indicates the refresh should happen even if a surface isn’t dirty.
Render(IScreenSurface)
Section titled “Render(IScreenSurface)”Creates a drawcall in the drawing pipeline.
void Render(IScreenSurface surface)Parameters
Section titled “Parameters”surface IScreenSurface
Target surface.
OnHostUpdated(IScreenObject)
Section titled “OnHostUpdated(IScreenObject)”Called when various states in the host change.
void OnHostUpdated(IScreenObject host)Parameters
Section titled “Parameters”host IScreenObject
The host that uses this component.