class_shaderglobalsoverride.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShaderGlobalsOverride.xml.
  6. .. _class_ShaderGlobalsOverride:
  7. ShaderGlobalsOverride
  8. =====================
  9. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A node used to override global shader parameters' values in a scene.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. 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.
  15. \ **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.
  16. \ **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.
  17. .. rst-class:: classref-introduction-group
  18. Tutorials
  19. ---------
  20. - :doc:`Shading language <../tutorials/shaders/shader_reference/shading_language>`
  21. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  22. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  23. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  24. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  25. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  26. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  27. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`