Difference between revisions of "ShaderBlur (CMS)"

From The Official Visionaire Studio: Adventure Game Engine Wiki
m
m
Line 6: Line 6:
  
  
Allows the user to blur or focus the camera/screen over a specified amount of time.
+
Allows the user to blur or focus the camera/screen over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is needed for this function to work''.
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 
<span class="bold">Additional Info</span>
 
<span class="bold">Additional Info</span>

Revision as of 13:28, 16 August 2014

Function History

Available since v4.0


Allows the user to blur or focus the camera/screen over a specified amount of time. The shader toolkit is needed for this function to work.

Additional Info

Any values below 0.8 and above 2 tend to have some trippy side effects. Recommended values are between 0.8 & 1.4.


Syntax:

shaderBlur(active, value, delay)


Example 1: set blur amount

shaderBlur(1, 0.8, 3000) -- blur the screen over 3000 milliseconds
shaderBlur(1, 0.8, 0) -- blur screen instantly


Example 2: turn blur off

shaderBlur(0, 0, 3000) -- focus screen back to default over 3000 milliseconds
shaderBlur(0, 0, 0) -- focus screen back to default instantly


Arguments

active: integer (number)
Render blur active or inactive; 0 = off, 1 = on

value: float (number)
The amount to blur the screen by; recommended value somewhere between 0.8 & 1.4

delay: integer (number)
The amount of time to colorize the screen over in milliseconds (ms)


Flags

none


Return

none


Relevant Pages: to add...