PfxVis Class Reference
[GFX]

Singleton class that exposes ConsoleStaticFunctions for debug visualizing PostEffects. More...

List of all members.

Public Member Functions
void	clear ()
	Close all visualization windows.
void	hide ()
	Hide all visualization windows (they are not destroyed).
void	onWindowClosed (GuiWindowCtrl *ctrl)
	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.

Example:

// 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()

---

Member Function Documentation

void PfxVis::clear

(

)

Close all visualization windows.

Example:

PfxVis::clear();

void PfxVis::hide

(

)

Hide all visualization windows (they are not destroyed).

Example:

PfxVis::hide();

void PfxVis::onWindowClosed

(

GuiWindowCtrl *

ctrl

)

Callback when a visualization window is closed.

Parameters:

ctrl

Name of the GUI control being closed

Example:

PfxVis::onWindowClosed( VisWindow )

void PfxVis::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

Example:

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

void PfxVis::show

(

)

Show all visualization windows.

Example:

PfxVis::show();