From f24ef75de77160872e636c9bb425f98ae64358a4 Mon Sep 17 00:00:00 2001 From: Ninni Pipping Date: Tue, 9 May 2023 21:04:01 +0200 Subject: [PATCH] Add missing shader debug documentation --- doc/classes/ProjectSettings.xml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 90ff260130f..ef335bd526d 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -546,6 +546,39 @@ Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. This can also be enabled using the [code]--verbose[/code] or [code]-v[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url], even on an exported project. See also [method OS.is_stdout_verbose] and [method @GlobalScope.print_verbose]. + + When set to [code]true[/code], produces a warning when the shader exceeds certain device limits. Currently, the only device limit checked is the limit on uniform buffer size. More device limits will be added in the future. + + + If [code]true[/code], enables specific shader warnings (see [code]debug/shader_language/warnings/*[/code] settings). If [code]false[/code], disables all shader warnings. + + + When set to [code]true[/code], produces a warning when two floating point numbers are compared directly with the [code]==[/code] operator or the [code]!=[/code] operator. + + + When set to [code]true[/code], produces a warning upon encountering certain formatting errors. Currently this only checks for empty statements. More formatting errors may be added over time. + + + When set to [code]true[/code], warnings are treated as errors. + + + When set to [code]true[/code], produces a warning when a constant is never used. + + + When set to [code]true[/code], produces a warning when a function is never used. + + + When set to [code]true[/code], produces a warning when a local variable is never used. + + + When set to [code]true[/code], produces a warning when a struct is never used. + + + When set to [code]true[/code], produces a warning when a uniform is never used. + + + When set to [code]true[/code], produces a warning when a varying is never used. + Color of the contact points between collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu.