ScreenCrossFadeFilter Class Reference

Fades between 2 different rendered frames. More...

#include <W3DShaderManager.h>

Inherits W3DFilterInterface.

Public Member Functions
virtual Int	init (void)
	perform any one time initialization and validation
virtual Int	shutdown (void)
	release resources used by shader
virtual Bool	preRender (Bool &skipRender, CustomScenePassModes &scenePassMode)
	Set up at start of render. Only applies to screen filter shaders.
virtual Bool	postRender (enum FilterModes mode, Coord2D &scrollDelta, Bool &doExtraRender)
	Called after render. Only applies to screen filter shaders.
virtual Bool	setup (enum FilterModes mode)
	Called when the filter is started, one time before the first prerender.

Static Public Member Functions
static void	setFadeParameters (Int fadeFrames, Int direction)
static Real	getCurrentFadeValue (void)
static TextureClass *	getCurrentMaskTexture (void)

Protected Member Functions
virtual Int	set (enum FilterModes mode)
	setup shader for the specified rendering pass.
virtual void	reset (void)
	do any custom resetting necessary to bring W3D in sync.
Bool	updateFadeLevel (void)
	updated current state of fade and return true if not finished.

Static Protected Attributes
static Int	m_fadeFrames
	Fades screen between 2 different views of the scene with both being visible at once.
static Int	m_fadeDirection
static Int	m_curFadeFrame
static Real	m_curFadeValue
static Bool	m_skipRender = FALSE
static TextureClass *	m_fadePatternTexture =NULL
	shape/pattern of the fade

Detailed Description

Fades between 2 different rendered frames.

Definition at line 227 of file W3DShaderManager.h.

Member Function Documentation

getCurrentFadeValue()

static Real ScreenCrossFadeFilter::getCurrentFadeValue ( void )

inlinestatic

Definition at line 241 of file W3DShaderManager.h.

getCurrentMaskTexture()

static TextureClass * ScreenCrossFadeFilter::getCurrentMaskTexture ( void )

inlinestatic

Definition at line 242 of file W3DShaderManager.h.

init()

Int ScreenCrossFadeFilter::init ( void )

virtual

perform any one time initialization and validation

Implements W3DFilterInterface.

Definition at line 690 of file W3DShaderManager.cpp.

postRender()

Bool ScreenCrossFadeFilter::postRender ( enum FilterModes mode, Coord2D & scrollDelta, Bool & doExtraRender )

virtual

Called after render. Only applies to screen filter shaders.

Reimplemented from W3DFilterInterface.

Definition at line 768 of file W3DShaderManager.cpp.

preRender()

Bool ScreenCrossFadeFilter::preRender ( Bool & skipRender, CustomScenePassModes & scenePassMode )

virtual

Set up at start of render. Only applies to screen filter shaders.

Reimplemented from W3DFilterInterface.

Definition at line 754 of file W3DShaderManager.cpp.

reset()

void ScreenCrossFadeFilter::reset ( void )

protectedvirtual

do any custom resetting necessary to bring W3D in sync.

Implements W3DFilterInterface.

Definition at line 896 of file W3DShaderManager.cpp.

set()

Int ScreenCrossFadeFilter::set ( enum FilterModes mode )

protectedvirtual

setup shader for the specified rendering pass.

Implements W3DFilterInterface.

Definition at line 859 of file W3DShaderManager.cpp.

setFadeParameters()

static void ScreenCrossFadeFilter::setFadeParameters ( Int fadeFrames, Int direction )

inlinestatic

Definition at line 235 of file W3DShaderManager.h.

setup()

virtual Bool ScreenCrossFadeFilter::setup ( enum FilterModes mode )

inlinevirtual

Called when the filter is started, one time before the first prerender.

Reimplemented from W3DFilterInterface.

Definition at line 234 of file W3DShaderManager.h.

shutdown()

Int ScreenCrossFadeFilter::shutdown ( void )

virtual

release resources used by shader

Reimplemented from W3DFilterInterface.

Definition at line 904 of file W3DShaderManager.cpp.

updateFadeLevel()

Bool ScreenCrossFadeFilter::updateFadeLevel ( void )

protected

updated current state of fade and return true if not finished.

Definition at line 714 of file W3DShaderManager.cpp.

Member Data Documentation

m_curFadeFrame

Int ScreenCrossFadeFilter::m_curFadeFrame

staticprotected

Definition at line 249 of file W3DShaderManager.h.

m_curFadeValue

Real ScreenCrossFadeFilter::m_curFadeValue

staticprotected

Definition at line 250 of file W3DShaderManager.h.

m_fadeDirection

Int ScreenCrossFadeFilter::m_fadeDirection

staticprotected

Definition at line 248 of file W3DShaderManager.h.

m_fadeFrames

Int ScreenCrossFadeFilter::m_fadeFrames

staticprotected

Fades screen between 2 different views of the scene with both being visible at once.

Definition at line 247 of file W3DShaderManager.h.

m_fadePatternTexture

TextureClass * ScreenCrossFadeFilter::m_fadePatternTexture =NULL

staticprotected

shape/pattern of the fade

Definition at line 252 of file W3DShaderManager.h.

m_skipRender

Bool ScreenCrossFadeFilter::m_skipRender = FALSE

staticprotected

Definition at line 251 of file W3DShaderManager.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DShaderManager.h
• Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DShaderManager.cpp