Difference between revisions of "ShaderHue (CMS)"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type |- | shaderHue(hue, delay) || Execution |} Allows the user to adjust t...") |
m (Text replacement - "{{toc}}" to "") |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 3: | Line 3: | ||
! style="text-align:left" | Name !! style="text-align:left" | Type | ! style="text-align:left" | Name !! style="text-align:left" | Type | ||
|- | |- | ||
| − | | shaderHue( | + | | shaderHue(value, delay) || Execution |
|} | |} | ||
| − | Allows the user to adjust the | + | Allows the user to adjust the hue value of the screen over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is required for this function to work''. |
| Line 30: | Line 30: | ||
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description | ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description | ||
|- | |- | ||
| − | | | + | | value || float (decimal) || Define the hue value of the screen; recommended value somewhere between 0 & 1. |
|- | |- | ||
| delay || integer (number) || The amount of time to adjust the hue value of the screen over; in milliseconds (ms). | | delay || integer (number) || The amount of time to adjust the hue value of the screen over; in milliseconds (ms). | ||
|} | |} | ||
| − | |||
Latest revision as of 00:49, 4 November 2014
| Name | Type |
|---|---|
| shaderHue(value, delay) | Execution |
Allows the user to adjust the hue value of the screen over a specified amount of time. The shader toolkit is required for this function to work.
Examples
Enable
Set hue amount
shaderHue(0.1, 3000) -- adjust the hue value of the screen over 3 seconds
shaderHue(0.1, 0) -- adjust the hue value of the screen instantlyDisable
Restore hue back to default value
shaderHue(0, 3000) -- adjust the hue value of the screen back to default over 3 seconds
shaderHue(0, 0) -- adjust the hue value of the screen back to default instantly
Syntax Breakdown
| Name | Type | Description |
|---|---|---|
| value | float (decimal) | Define the hue value of the screen; recommended value somewhere between 0 & 1. |
| delay | integer (number) | The amount of time to adjust the hue value of the screen over; in milliseconds (ms). |
