Interface IRenderer
Draws a surface.
Inherited Members
Namespace: SadConsole.Renderers
Assembly: SadConsole.dll
Syntax
public interface IRenderer : IDisposableProperties
IsForced
Declaration
bool IsForced { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Name
The name used to create the renderer from the host.
Declaration
string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Opacity
A 0 to 255 value represening how transparent the surface is when drawn to the screen. 255 represents full visibility.
Declaration
byte Opacity { get; set; }Property Value
| Type | Description |
|---|---|
| byte |
Output
The output texture created by the renderer.
Declaration
ITexture Output { get; }Property Value
| Type | Description |
|---|---|
| ITexture |
Steps
The render steps for the renderer.
Declaration
List<IRenderStep> Steps { get; set; }Property Value
| Type | Description |
|---|---|
| List<IRenderStep> |
Methods
OnHostUpdated(IScreenObject)
Called when various states in the host change.
Declaration
void OnHostUpdated(IScreenObject host)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | host | The host that uses this component. |
Refresh(IScreenSurface, bool)
Refreshes a cached drawing state.
Declaration
void Refresh(IScreenSurface surface, bool force = false)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenSurface | surface | Target surface. |
| bool | force | When true, indicates the refresh should happen even if a surface isn't dirty. |
Render(IScreenSurface)
Creates a drawcall in the drawing pipeline.
Declaration
void Render(IScreenSurface surface)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenSurface | surface | Target surface. |