Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
ScreenBWFilter Class Reference

converts viewport to black & white. More...

#include <W3DShaderManager.h>

Inherits W3DFilterInterface.

Inherited by ScreenBWFilterDOT3.

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)
 

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.
 

Static Protected Attributes

static Int m_fadeFrames
 converts viewport to black & white.
 
static Int m_fadeDirection
 
static Int m_curFadeFrame
 
static Real m_curFadeValue
 

Detailed Description

converts viewport to black & white.

Definition at line 188 of file W3DShaderManager.h.

Member Function Documentation

◆ init()

Int ScreenBWFilter::init ( void )
virtual

perform any one time initialization and validation

Implements W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 282 of file W3DShaderManager.cpp.

◆ postRender()

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

Called after render. Only applies to screen filter shaders.

Reimplemented from W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 330 of file W3DShaderManager.cpp.

◆ preRender()

Bool ScreenBWFilter::preRender ( Bool & skipRender,
CustomScenePassModes & scenePassMode )
virtual

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

Reimplemented from W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 323 of file W3DShaderManager.cpp.

◆ reset()

void ScreenBWFilter::reset ( void )
protectedvirtual

do any custom resetting necessary to bring W3D in sync.

Implements W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 475 of file W3DShaderManager.cpp.

◆ set()

Int ScreenBWFilter::set ( enum FilterModes mode)
protectedvirtual

setup shader for the specified rendering pass.

Implements W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 380 of file W3DShaderManager.cpp.

◆ setFadeParameters()

static void ScreenBWFilter::setFadeParameters ( Int fadeFrames,
Int direction )
inlinestatic

Definition at line 197 of file W3DShaderManager.h.

◆ setup()

virtual Bool ScreenBWFilter::setup ( enum FilterModes mode)
inlinevirtual

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

Reimplemented from W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 196 of file W3DShaderManager.h.

◆ shutdown()

Int ScreenBWFilter::shutdown ( void )
virtual

release resources used by shader

Reimplemented from W3DFilterInterface.

Reimplemented in ScreenBWFilterDOT3.

Definition at line 482 of file W3DShaderManager.cpp.

Member Data Documentation

◆ m_curFadeFrame

Int ScreenBWFilter::m_curFadeFrame
staticprotected

Definition at line 208 of file W3DShaderManager.h.

◆ m_curFadeValue

Real ScreenBWFilter::m_curFadeValue
staticprotected

Definition at line 209 of file W3DShaderManager.h.

◆ m_fadeDirection

Int ScreenBWFilter::m_fadeDirection
staticprotected

Definition at line 207 of file W3DShaderManager.h.

◆ m_fadeFrames

Int ScreenBWFilter::m_fadeFrames
staticprotected

converts viewport to black & white.

Definition at line 206 of file W3DShaderManager.h.


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