Interface IRenderPipeline

The render pipeline is responsible for collecting all of the rendering information and passing it on to the render loop. It allows entities to subscribe their own renderers and pass on custom drawing instructions.

Namespace: AGS.API
Assembly: AGS.API.dll
Syntax
public interface IRenderPipeline

Properties

| Improve this Doc View Source

OnBeforeProcessingDisplayList

An event that fires on each tick before processing the display list for rendering. This allows viewing (and even modifying) the display list prior to rendering it.

Declaration
IBlockingEvent<DisplayListEventArgs> OnBeforeProcessingDisplayList { get; }
Property Value
Type Description
IBlockingEvent<DisplayListEventArgs>

The event.

Methods

| Improve this Doc View Source

Subscribe(String, IRenderer, Int32)

Subscribe the specified renderer to the specified entity. If the entity is part of the display list (i.e if it's in the current room or a GUI), all subscribed renderers will be called to submit their drawing instructions.

Declaration
void Subscribe(string entityID, IRenderer renderer, int z = 0)
Parameters
Type Name Description
System.String entityID

Entity identifier.
IRenderer renderer

Renderer.
System.Int32 z

Gets the z index for deciding which renderer will be in front of the other renderer (in case there are multiple renderers per entity). The smaller the Z, the more in front a renderer is.

| Improve this Doc View Source

Unsubscribe(String, IRenderer)

Unsubscribe the specified renderer and entity.

Declaration
void Unsubscribe(string entityID, IRenderer renderer)
Parameters
Type Name Description
System.String entityID

Entity identifier.
IRenderer renderer

Renderer.

See Also