Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_shaderglobalsoverride.rst

class_shaderglobalsoverride.rst 2.5 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderGlobalsOverride.xml.
    7. 

  7. 

  8. .. _class_ShaderGlobalsOverride:
    9. 

  9. 

  10. ShaderGlobalsOverride
    11. 

  11. =====================
    12. 

  12. 

  13. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A node used to override global shader parameters' values in a scene.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. Similar to how a :ref:`WorldEnvironment<class_WorldEnvironment>` node can be used to override the environment while a specific scene is loaded, **ShaderGlobalsOverride** can be used to override global shader parameters temporarily. Once the node is removed, the project-wide values for the global shader parameters are restored. See the :ref:`RenderingServer<class_RenderingServer>` ``global_shader_parameter_*`` methods for more information.
    23. 

  23. 

  24. \ **Note:** Only one **ShaderGlobalsOverride** can be used per scene. If there is more than one **ShaderGlobalsOverride** node in the scene tree, only the first node (in tree order) will be taken into account.
    25. 

  25. 

  26. \ **Note:** All **ShaderGlobalsOverride** nodes are made part of a ``"shader_overrides_group"`` group when they are added to the scene tree. The currently active **ShaderGlobalsOverride** node also has a ``"shader_overrides_group_active"`` group added to it. You can use this to check which **ShaderGlobalsOverride** node is currently active.
    27. 

  27. 

  28. .. rst-class:: classref-introduction-group
    29. 

  29. 

  30. Tutorials
    31. 

  31. ---------
    32. 

  32. 

  33. - :doc:`Shading language <../tutorials/shaders/shader_reference/shading_language>`
    34. 

  34. 

  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    36. 

  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    37. 

  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    38. 

  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    39. 

  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    40. 

  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    41. 

  41. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    42. 

  42. .. |void| replace:: :abbr:`void (No return value.)`
    43. 

  43.