Skip to content

Commit

Permalink
Documentation|Console: Help for “postfx”
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Nov 15, 2013
1 parent 46f4f84 commit 03ce79a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doomsday/client/data/cphelp.txt
Expand Up @@ -269,6 +269,10 @@ desc = Play a music track, music lump, external file or a CD track.
[playsound]
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'

[quit!]
desc = Exit immediately and return to the OS.

Expand Down
23 changes: 23 additions & 0 deletions doomsday/doc/engine/command/postfx.ame
@@ -0,0 +1,23 @@
@summary{
Set or clear the frame post-processing shader.
}
@description{
@usage
@ident{postfx} @help_arg{console} @help_arg{shader} @help_optionalarg{time}

Every player has their own frame post-processing effects. The first
argument specifies which player will be affected.

The frame post-processing shader is changed to
"fx.post.@help_arg{shader}". If @help_arg{time} is specified,
and there is no shader currently in use, the new shader is faded in
in @help_arg{time} seconds. Otherwise the new shader is taken
immediately into use.

As a special case, if @help_arg{shader} is "none", the post-processing
shader is faded out and removed.

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

0 comments on commit 03ce79a

Please sign in to comment.