Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation|Console: Help for “postfx”
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} | ||
} |