Artenus 2D Framework
Artenus Reference
Holds information about the pass that is going to be rendered. Post-processing filters can modify the frame size or other information about the frame for each pass. This class is used to keep track of these changes, and pass it along the subsequent passes and filters.
public class FilterPassSetup
extends Viewport

Field Summary

Fields inherited from com.annahid.libs.artenus.graphics.rendering.Viewport

Constructor Summary

Modifier and TypeConstructor and Description
public FilterPassSetup(Viewport viewport)
Creates a new instance of FilterPassSetup based on a previous setup.

Method Summary

Modifier and TypeMethod and Description
public booleanisInPlace()
Indicates whether the next pass is in-place.
public voidsetHeight(int height)
Sets the frame height for this setup.
public voidsetInPlace()
Instructs the renderer that the next pass is going to be in-place.
public voidsetWidth(int width)
Sets the frame width for this setup.

Methods inherited from com.annahid.libs.artenus.graphics.rendering.Viewport

Methods inherited from java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterPassSetup
public  FilterPassSetup(
    Viewport viewport
)
Creates a new instance of FilterPassSetup based on a previous setup.
Parameters:
viewportViewport to copy dimensions from

Method Detail

isInPlace
public boolean isInPlace()
Indicates whether the next pass is in-place.
Returns:
true if in-place, false otherwise
setHeight
public void setHeight(
    int height
)
Sets the frame height for this setup.
Parameters:
heightFrame height
setInPlace
public void setInPlace()
Instructs the renderer that the next pass is going to be in-place. An in-place pass does not redraw the whole frame, but rather overlays something on top of it. The normal rendering behavior for post-processors is that the result of each pass is given to the next pass, and the new pass draws on a fresh render target (at least theoretically). By calling this method, both input and output targets are carried forward from the previous pass, and the output target will still contain the previous results. In-place filters can greatly improve their performance by notifying the renderer using this method.
setWidth
public void setWidth(
    int width
)
Sets the frame width for this setup.
Parameters:
widthFrame width