Interface IFrameBuffer

Allows rendering into a texture instead of rendering to screen

Inherited Members

System.IDisposable.Dispose()

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IFrameBuffer : IDisposable

Properties

Texture

Gets the texture that was rendered (will be valid after End() was called).

Declaration

ITexture Texture { get; }

Property Value

Type	Description
ITexture	The texture.

Methods

Begin()

Signals that all following renders will be performed into the buffer instead of into the screen. 'Begin' must be called from the rendering thread. Note: for room transition implementations, the frame buffer is already rendered with the room data, prepared to be used, so calling Begin + End is not needed. Returns true if the frame buffer was correctly initialized, false if some error has occured.

Declaration

bool Begin()

Returns

Type	Description
System.Boolean

End()

Signals that all following renders will no longer be performed into the buffer, they will return to render into the screen (as usual). 'End' must be called from the rendering thread (and after 'Begin' or it has no value). Note: for room transition implementations, the frame buffer is already rendered with the room data, prepared to be used, so calling Begin + End is not needed.

Declaration

void End()