godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9734 from tetrapod00/time-shader

Browse Source 
Update description of shader variable TIME and add description to Fog, Particle, Sky, and Spatial shader pages
This commit is contained in:
Matthew
2024-08-14 19:47:02 -04:00
committed by GitHub
parent 36630bc7ec 19dc2ff818
commit 603f4dcd1a
6 changed files with 74 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
tutorials/shaders/shader_reference/canvas_item_shader.rst
View File

@@ -50,24 +50,26 @@ Global built-ins
Global built-ins are available everywhere, including custom functions.
+-------------------+----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+========================================================================================+
| in float **TIME** | Global time since the engine has started, in seconds (always positive). |
| | It's subject to the rollover setting (which is 3,600 seconds by default). |
| | It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` |
| | or pausing, but you can define a global shader uniform to add a "scaled" |
| | ``TIME`` variable if desired. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). |
| | Euler's number and a base of the natural logarithm. |
+-------------------+----------------------------------------------------------------------------------------+
+-------------------+-----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+=========================================================================================+
| in float **TIME** | Global time since the engine has started, in seconds. It repeats after every 3,600 |
| | seconds (which can be changed with the |
| | :ref:`rollover<class_ProjectSettings_property_rendering/limits/time/time_rollover_secs>`|
| | setting). It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` or |
| | pausing. If you need a ``TIME`` variable that can be scaled or paused, add your own |
| | :ref:`global shader uniform<doc_shading_language_global_uniforms>` and update it each |
| | frame. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). |
| | Euler's number and a base of the natural logarithm. |
+-------------------+-----------------------------------------------------------------------------------------+
Vertex built-ins
^^^^^^^^^^^^^^^^

8
tutorials/shaders/shader_reference/fog_shader.rst
View File

@@ -35,7 +35,13 @@ Global built-ins are available everywhere, including in custom functions.
+---------------------------------+-----------------------------------------------------------------------------------------+
| Built-in | Description |
+=================================+=========================================================================================+
| in float **TIME** | Global time, in seconds. |
| in float **TIME** | Global time since the engine has started, in seconds. It repeats after every 3,600 |
| | seconds (which can be changed with the |
| | :ref:`rollover<class_ProjectSettings_property_rendering/limits/time/time_rollover_secs>`|
| | setting). It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` or |
| | pausing. If you need a ``TIME`` variable that can be scaled or paused, add your own |
| | :ref:`global shader uniform<doc_shading_language_global_uniforms>` and update it each |
| | frame. |
+---------------------------------+-----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ratio of a circle's circumference to its diameter and amount of radians in half turn. |

32
tutorials/shaders/shader_reference/particle_shader.rst
View File

@@ -55,19 +55,25 @@ Global built-ins
Global built-ins are available everywhere, including custom functions.
+-------------------+----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+========================================================================================+
| in float **TIME** | Global time, in seconds. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). Euler's number and a base of the natural logarithm. |
+-------------------+----------------------------------------------------------------------------------------+
+-------------------+-----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+=========================================================================================+
| in float **TIME** | Global time since the engine has started, in seconds. It repeats after every 3,600 |
| | seconds (which can be changed with the |
| | :ref:`rollover<class_ProjectSettings_property_rendering/limits/time/time_rollover_secs>`|
| | setting). It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` or |
| | pausing. If you need a ``TIME`` variable that can be scaled or paused, add your own |
| | :ref:`global shader uniform<doc_shading_language_global_uniforms>` and update it each |
| | frame. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). Euler's number and a base of the natural logarithm. |
+-------------------+-----------------------------------------------------------------------------------------+
Start and Process built-ins
^^^^^^^^^^^^^^^^^^^^^^^^^^^

2
tutorials/shaders/shader_reference/shading_language.rst
View File

@@ -968,6 +968,8 @@ The syntax also supports subgroups (it's not mandatory to declare the base group
group_uniforms MyGroup.MySubgroup;
.. _doc_shading_language_global_uniforms:
Global uniforms
~~~~~~~~~~~~~~~

8
tutorials/shaders/shader_reference/sky_shader.rst
View File

@@ -154,7 +154,13 @@ There are 4 ``LIGHTX`` lights, accessed as ``LIGHT0``, ``LIGHT1``, ``LIGHT2``, a
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Built-in | Description |
+=================================+==========================================================================================================================+
| in float **TIME** | Global time, in seconds. |
| in float **TIME** | Global time since the engine has started, in seconds. It repeats after every 3,600 |
| | seconds (which can be changed with the |
| | :ref:`rollover<class_ProjectSettings_property_rendering/limits/time/time_rollover_secs>` |
| | setting). It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` or |
| | pausing. If you need a ``TIME`` variable that can be scaled or paused, add your own |
| | :ref:`global shader uniform<doc_shading_language_global_uniforms>` and update it each |
| | frame. |
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| in vec3 **POSITION** | Camera position in world space |
+---------------------------------+--------------------------------------------------------------------------------------------------------------------------+

32
tutorials/shaders/shader_reference/spatial_shader.rst
View File

@@ -96,19 +96,25 @@ Global built-ins
Global built-ins are available everywhere, including custom functions.
+-------------------+----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+========================================================================================+
| in float **TIME** | Global time, in seconds. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). Euler's number and a base of the natural logarithm. |
+-------------------+----------------------------------------------------------------------------------------+
+-------------------+-----------------------------------------------------------------------------------------+
| Built-in | Description |
+===================+=========================================================================================+
| in float **TIME** | Global time since the engine has started, in seconds. It repeats after every 3,600 |
| | seconds (which can be changed with the |
| | :ref:`rollover<class_ProjectSettings_property_rendering/limits/time/time_rollover_secs>`|
| | setting). It's not affected by :ref:`time_scale<class_Engine_property_time_scale>` or |
| | pausing. If you need a ``TIME`` variable that can be scaled or paused, add your own |
| | :ref:`global shader uniform<doc_shading_language_global_uniforms>` and update it each |
| | frame. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **PI** | A ``PI`` constant (``3.141592``). |
| | A ration of circle's circumference to its diameter and amount of radians in half turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **TAU** | A ``TAU`` constant (``6.283185``). |
| | An equivalent of ``PI * 2`` and amount of radians in full turn. |
+-------------------+-----------------------------------------------------------------------------------------+
| in float **E** | An ``E`` constant (``2.718281``). Euler's number and a base of the natural logarithm. |
+-------------------+-----------------------------------------------------------------------------------------+
Vertex built-ins
^^^^^^^^^^^^^^^^