Navigation Menu

Skip to content

Commit

Permalink
Renderer|FX: Added some API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Nov 15, 2013
1 parent b1a0552 commit 9ee0af2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions doomsday/client/include/render/fx/postprocessing.h
Expand Up @@ -34,9 +34,24 @@ class PostProcessing : public ConsoleEffect
public:
PostProcessing(int console);

/**
* Determines whether the effect is active. If it isn't, it can be skipped
* altogether when post processing a frame.
*/
bool isActive() const;

/**
* Fades in, or immediately takes into use, a new post-processing shader.
* Only shaders in the "fx.post" namespace can be used.
*
* If a shader is already in use, it will simply be swapped immediately
* with the new shader rather than crossfaded.
*
* @param fxPostShader Name of the shader under "fx.post".
* @param span Duration of the fade in animation.
*/
void fadeInShader(de::String const &fxPostShader, de::TimeDelta const &span);

void fadeOut(de::TimeDelta const &span);

void glInit();
Expand Down

0 comments on commit 9ee0af2

Please sign in to comment.