Artenus 2D Framework
Artenus Reference
Interface for post-processing filters. These filters are applied to the rendered frame after the rendering is complete, and before the frame is displayed on the screen. Color tinting and frame blurring are examples of post-processing filters.
public interface PostProcessingFilter

Method Summary

Modifier and TypeMethod and Description
public voidrender(int pass, RenderingContext context, RenderTarget renderedFrame)
Renders the frame for the current pass.
public booleansetup(int pass, FilterPassSetup setup)
Sets up the current rendering pass for this filter.

Method Detail

render
public void render(
    int pass,
    RenderingContext context,
    RenderTarget renderedFrame
)
Renders the frame for the current pass. On pass 0 the raw rendering output is given to the function, and subsequent passes receive output from their predecessor. The rendering context can be used to draw elements for the next pass (if there is one), or for the final output of this filter. Note that the result of the final pass might still be processed by other post-processing filters before actually being displayed on the screen.
Parameters:
passCurrent pass number (starting at 0)
contextRendering context
renderedFrameRaw rendered frame if pass is 0, or the result of the previous pass
setup
public boolean setup(
    int pass,
    FilterPassSetup setup
)
Sets up the current rendering pass for this filter. A filter can process the render output in several passes, and each pass will have access to the result of the previous. Pass 0 is where the raw render output is given to the filter for processing. The frame setup for the previous pass (or for the render output) is given to this function, which can be modified for the next pass. Width and height specified for the next pass cannot exceed raw output dimensions.
Parameters:
passCurrent pass number (starting at 0)
setupFrame setup for the previous pass
Returns:
A value indicating whether another pass is required to complete this filter (other than the current pass that is being set up)