Difference between revisions of "ShaderColorize (CMS)"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Function History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since...") |
|||
| Line 1: | Line 1: | ||
| − | + | {| class="ts" style="width:100%" | |
| − | + | |- | |
| − | + | ! style="text-align:left" | Name !! style="text-align:left" | Type | |
| − | + | |- | |
| − | + | | shaderColorize(hue, strength, delay) || Execution | |
| + | |} | ||
Allows the user to colorize the screen over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is needed for this function to work''. | Allows the user to colorize the screen over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is needed for this function to work''. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | == Examples == | |
| + | === Enable === | ||
| + | Set colorize amount | ||
<syntaxhighlight> | <syntaxhighlight> | ||
shaderColorize(0, 1, 3000) -- colorize screen red over 3000 milliseconds | shaderColorize(0, 1, 3000) -- colorize screen red over 3000 milliseconds | ||
shaderColorize(0, 1, 0) -- colorize screen red instantly | shaderColorize(0, 1, 0) -- colorize screen red instantly | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | === Disable === | |
| − | + | Turn colorize off | |
| − | |||
<syntaxhighlight> | <syntaxhighlight> | ||
shaderColorize(0, 0, 3000) -- restore colorize value back to default over 3000 milliseconds | shaderColorize(0, 0, 3000) -- restore colorize value back to default over 3000 milliseconds | ||
| Line 34: | Line 25: | ||
| − | + | == Syntax Breakdown == | |
| − | + | {| class="ts" style="width:100%" | |
| − | + | |- | |
| − | + | ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description | |
| − | Define the hue target; number between 0 & 1 (red > yellow > green > blue > pink > red) | + | |- |
| − | + | | hue || float (decimal) || Define the hue target; number between 0 & 1 (red > yellow > green > blue > pink > red). | |
| − | + | |- | |
| − | The amount to colorize the screen by; recommended value between 0 & 1 (possible to go over 1, but might generate strange artifacts) | + | | strength || float (decimal) || The amount to colorize the screen by; recommended value between 0 & 1 (possible to go over 1, but might generate strange artifacts). |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | | | + | | delay || integer (number) || The amount of time to colorize the screen over; in milliseconds (ms). |
|} | |} | ||
| + | {{toc}} | ||
Revision as of 15:58, 30 September 2014
| Name | Type |
|---|---|
| shaderColorize(hue, strength, delay) | Execution |
Allows the user to colorize the screen over a specified amount of time. The shader toolkit is needed for this function to work.
Examples
Enable
Set colorize amount
shaderColorize(0, 1, 3000) -- colorize screen red over 3000 milliseconds
shaderColorize(0, 1, 0) -- colorize screen red instantlyDisable
Turn colorize off
shaderColorize(0, 0, 3000) -- restore colorize value back to default over 3000 milliseconds
shaderColorize(0, 0, 0) -- restore colorize value back to default instantly
Syntax Breakdown
| Name | Type | Description |
|---|---|---|
| hue | float (decimal) | Define the hue target; number between 0 & 1 (red > yellow > green > blue > pink > red). |
| strength | float (decimal) | The amount to colorize the screen by; recommended value between 0 & 1 (possible to go over 1, but might generate strange artifacts). |
| delay | integer (number) | The amount of time to colorize the screen over; in milliseconds (ms). |
