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

#include <W3DShaderManager.h>

Inherited by ScreenBWFilter, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

Public Member Functions

virtual Int init (void)=0
 perform any one time initialization and validation
 
virtual Int shutdown (void)
 
virtual Bool preRender (Bool &skipRender, CustomScenePassModes &scenePassMode)
 release resources used by shader
 
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.
 

Protected Member Functions

virtual Int set (enum FilterModes mode)=0
 
virtual void reset (void)=0
 do any custom resetting necessary to bring W3D in sync.
 

Detailed Description

Definition at line 136 of file W3DShaderManager.h.

Member Function Documentation

◆ init()

virtual Int W3DFilterInterface::init ( void )
pure virtual

perform any one time initialization and validation

Implemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

◆ postRender()

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

Called after render. Only applies to screen filter shaders.

Reimplemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

Definition at line 142 of file W3DShaderManager.h.

◆ preRender()

virtual Bool W3DFilterInterface::preRender ( Bool & skipRender,
CustomScenePassModes & scenePassMode )
inlinevirtual

release resources used by shader

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

Reimplemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

Definition at line 141 of file W3DShaderManager.h.

◆ reset()

virtual void W3DFilterInterface::reset ( void )
protectedpure virtual

do any custom resetting necessary to bring W3D in sync.

Implemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

◆ set()

virtual Int W3DFilterInterface::set ( enum FilterModes mode)
protectedpure virtual

setup shader for the specified rendering pass.

Implemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

◆ setup()

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

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

Reimplemented in ScreenBWFilter, ScreenBWFilterDOT3, ScreenCrossFadeFilter, ScreenDefaultFilter, and ScreenMotionBlurFilter.

Definition at line 143 of file W3DShaderManager.h.

◆ shutdown()

virtual Int W3DFilterInterface::shutdown ( void )
inlinevirtual

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