PfxVis

consoledoc.h

Singleton class that exposes ConsoleStaticFunctions for debug visualizing PostEffects.

More...

Public Functions

void

Close all visualization windows.

void
hide()

Hide all visualization windows (they are not destroyed).

void

Callback when a visualization window is closed.

void
open(PostEffect effect, bool clear)

Open visualization windows for all input and target textures.

void
show()

Show all visualization windows.

Detailed Description

Singleton class that exposes ConsoleStaticFunctions for debug visualizing PostEffects.

// Script interface...
PfxVis::open( PostEffect ) // Multiple PostEffects can be visualized at the same time
PfxVis::clear()      // Clear all visualizer windows
PfxVis::hide()       // Hide all windows (are not destroyed)
PfxVis::show()

Public Functions

clear()

Close all visualization windows.

PfxVis::clear();

hide()

Hide all visualization windows (they are not destroyed).

PfxVis::hide();

onWindowClosed(GuiWindowCtrl * ctrl)

Callback when a visualization window is closed.

Parameters:

ctrl

Name of the GUI control being closed

PfxVis::onWindowClosed( VisWindow )

open(PostEffect effect, bool clear)

Open visualization windows for all input and target textures.

Parameters:

effect

Name of the PostEffect to open

clear

True to close all visualization windows before opening the effect

// Multiple PostEffects can be visualized at the same time
PfxVis::open( PostEffect )

show()

Show all visualization windows.

PfxVis::show();