Difference between revisions of "ShaderContrast (CMS)"

Revision as of 18:02, 30 September 2014

Name	Type
shaderContrast(value, delay)	Execution

Allows the user to adjust the screen contrast over a specified amount of time. The shader toolkit is required 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 instantly

Disable

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
value	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).

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type
 |-
-| shaderContrast(contrast, delay) || Execution
+| shaderContrast(value, delay) || Execution
 |}
-Allows the user to adjust the screen contrast over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is needed for this function to work''.
+Allows the user to adjust the screen contrast 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
 |-
-| contrast || float (decimal) || Define the contrast value; number between 0 & 2 (''1 = default'').
+| value || 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}}