Skip to content

Commit

Permalink
Documentation|Console: Updated help for ‘postfx’
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Dec 25, 2013
1 parent 8d7aae8 commit d129eff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doomsday/client/data/cphelp.txt
Expand Up @@ -274,7 +274,7 @@ desc = Play a sound effect.

[postfx]
desc = Set or clear the frame post-processing shader.
inf = USAGE:\npostfx (console) (shader) [(time)]\nEvery player has their own frame post-processing effects. The first argument specifies which player will be affected.\nThe frame post-processing shader is changed to "fx.post. (shader) ". If (time) is specified, and there is no shader currently in use, the new shader is faded in in (time) seconds. Otherwise the new shader is taken immediately into use.\nAs a special case, if (shader) is "none", the post-processing shader is faded out and removed.\nEXAMPLES:\nFade in the "fx.post.monochrome" shader for player 0 in 2 seconds: 'postfx 0 monochrome 2'
inf = USAGE:\npostfx (console) (shader) [(time)]\nEvery player has their own frame post-processing effects. The first argument specifies which player will be affected.\nThe frame post-processing shader is changed to "fx.post. (shader) ". If (time) is specified, and there is no shader currently in use, the new shader is faded in in (time) seconds. Otherwise the new shader is taken immediately into use.\nAs a special case, if (shader) is "none", the post-processing shader is faded out and removed.\nAnother special case is when (shader) is "opacity". This will set the opacity of the effect to the value of (time). However, hote that the shader does not necessarily implement opacity as simple alpha blending.\nEXAMPLES:\nFade in the "fx.post.monochrome" shader for player 0 in 2 seconds: 'postfx 0 monochrome 2'

[quit!]
desc = Exit immediately and return to the OS.
Expand Down
5 changes: 5 additions & 0 deletions doomsday/doc/engine/command/postfx.ame
Expand Up @@ -17,6 +17,11 @@
As a special case, if @help_arg{shader} is "none", the post-processing
shader is faded out and removed.

Another special case is when @help_arg{shader} is "opacity". This will
set the opacity of the effect to the value of @help_arg{time}. However,
hote that the shader does not necessarily implement opacity as simple
alpha blending.

@examples
Fade in the "fx.post.monochrome" shader for player 0 in 2 seconds:
@code{postfx 0 monochrome 2}
Expand Down

0 comments on commit d129eff

Please sign in to comment.