diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-03-28 17:32:29 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-05-12 12:31:19 +0200 |
| commit | 2d7228251d59c67c40843b34250ee6392eb10faa (patch) | |
| tree | 79f7c0c9d66d44f886b9b60666a51768fbdeca83 /doc/classes/ShaderGlobalsOverride.xml | |
| parent | 9a5af8e7936ed5cfd4664455a88a3ecdae197783 (diff) | |
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation
This brings the overall class reference completion percentage from 87% to 92%.
(cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
Diffstat (limited to 'doc/classes/ShaderGlobalsOverride.xml')
| -rw-r--r-- | doc/classes/ShaderGlobalsOverride.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/ShaderGlobalsOverride.xml b/doc/classes/ShaderGlobalsOverride.xml index 4c49d104bb..255fc122b9 100644 --- a/doc/classes/ShaderGlobalsOverride.xml +++ b/doc/classes/ShaderGlobalsOverride.xml @@ -1,8 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ShaderGlobalsOverride" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Overrides global shader parameters' values in a specific scene. </brief_description> <description> + Similar to how a [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 [RenderingServer] [code]global_shader_parameter_*[/code] methods for more information. + [b]Note:[/b] 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. + [b]Note:[/b] All [ShaderGlobalsOverride] nodes are made part of a [code]"shader_overrides_group"[/code] group when they are added to the scene tree. The currently active [ShaderGlobalsOverride] node also has a [code]"shader_overrides_group_active"[/code] group added to it. You can use this to check which [ShaderGlobalsOverride] node is currently active. </description> <tutorials> </tutorials> |