Difference between revisions of "ShaderContrast (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 | |
| − | + | |- | |
| − | + | | shaderContrast(contrast, delay) || Execution | |
| + | |} | ||
| Line 9: | Line 10: | ||
| − | + | == Examples == | |
| − | + | === Enable === | |
| − | + | Adjust screen contrast value | |
| − | |||
| − | |||
| − | |||
| − | |||
<syntaxhighlight> | <syntaxhighlight> | ||
shaderContrast(1.1, 3000) -- adjust screen contrast over 3000 milliseconds | shaderContrast(1.1, 3000) -- adjust screen contrast over 3000 milliseconds | ||
shaderContrast(1.1, 0) -- adjust screen contrast instantly | shaderContrast(1.1, 0) -- adjust screen contrast instantly | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | === Disable === | |
| − | + | Restore default screen contrast value | |
| − | |||
<syntaxhighlight> | <syntaxhighlight> | ||
shaderContrast(1, 3000) -- restore screen contrast over 3000 milliseconds | shaderContrast(1, 3000) -- restore screen contrast over 3000 milliseconds | ||
| Line 29: | 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 contrast value; number between 0 & 2 (''1 = default'') | + | |- |
| − | + | | contrast || float (decimal) || Define the contrast value; number between 0 & 2 (''1 = default''). | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | | | + | | delay || integer (number) || The amount of time to adjust the screen contrast value over; in milliseconds (ms). |
|} | |} | ||
| + | {{toc}} | ||
Revision as of 15:03, 30 September 2014
| Name | Type |
|---|---|
| shaderContrast(contrast, delay) | Execution |
Allows the user to adjust the screen contrast over a specified amount of time. The shader toolkit is needed for this function to work.
Examples
Enable
Adjust screen contrast value
shaderContrast(1.1, 3000) -- adjust screen contrast over 3000 milliseconds
shaderContrast(1.1, 0) -- adjust screen contrast instantlyDisable
Restore default screen contrast value
shaderContrast(1, 3000) -- restore screen contrast over 3000 milliseconds
shaderContrast(1, 0) -- restore screen contrast value back to default instantly
Syntax Breakdown
| Name | Type | Description |
|---|---|---|
| contrast | float (decimal) | Define the contrast value; number between 0 & 2 (1 = default). |
| delay | integer (number) | The amount of time to adjust the screen contrast value over; in milliseconds (ms). |
