diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/BaseMaterial3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Color.xml | 6 | ||||
| -rw-r--r-- | doc/classes/MultiplayerAPI.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 4 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 6 | ||||
| -rw-r--r-- | doc/classes/PacketPeer.xml | 9 | ||||
| -rw-r--r-- | doc/classes/Performance.xml | 2 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 16 | ||||
| -rw-r--r-- | doc/classes/VisualServer.xml | 2 | ||||
| -rw-r--r-- | doc/classes/VisualShaderNodeCustom.xml | 8 |
10 files changed, 28 insertions, 35 deletions
diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index f0730a0f58..46a96020d0 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -534,7 +534,7 @@ Set [code]ALBEDO[/code] to the per-vertex color specified in the mesh. </constant> <constant name="FLAG_SRGB_VERTEX_COLOR" value="2" enum="Flags"> - Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer. + Vertex color is in sRGB space and needs to be converted to linear. Only applies in the Vulkan renderer. </constant> <constant name="FLAG_USE_POINT_SIZE" value="3" enum="Flags"> Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use [code]POINT_COORD[/code] instead of [code]UV[/code]. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 5529251b5a..7335ff5a2e 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -295,9 +295,6 @@ </member> </members> <constants> - <constant name="gray" value="Color( 0.75, 0.75, 0.75, 1 )"> - Gray color. - </constant> <constant name="aliceblue" value="Color( 0.94, 0.97, 1, 1 )"> Alice blue color. </constant> @@ -448,6 +445,9 @@ <constant name="goldenrod" value="Color( 0.85, 0.65, 0.13, 1 )"> Goldenrod color. </constant> + <constant name="gray" value="Color( 0.75, 0.75, 0.75, 1 )"> + Gray color. + </constant> <constant name="green" value="Color( 0, 1, 0, 1 )"> Green color. </constant> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index f34d3c5da4..b82214b246 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -88,7 +88,7 @@ </methods> <members> <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed" default="false"> - If [code]true[/code] (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to [code]true[/code]), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. + If [code]true[/code], the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> @@ -151,15 +151,9 @@ <constant name="RPC_MODE_PUPPET" value="3" enum="RPCMode"> Used with [method Node.rpc_config] or [method Node.rset_config] to set a method to be called or a property to be changed only on puppets for this node. Analogous to the [code]puppet[/code] keyword. Only accepts calls or property changes from the node's network master, see [method Node.set_network_master]. </constant> - <constant name="RPC_MODE_SLAVE" value="3" enum="RPCMode"> - [i]Deprecated.[/i] Use [constant RPC_MODE_PUPPET] instead. Analogous to the [code]slave[/code] keyword. - </constant> <constant name="RPC_MODE_REMOTESYNC" value="4" enum="RPCMode"> Behave like [constant RPC_MODE_REMOTE] but also make the call or property change locally. Analogous to the [code]remotesync[/code] keyword. </constant> - <constant name="RPC_MODE_SYNC" value="4" enum="RPCMode"> - [i]Deprecated.[/i] Use [constant RPC_MODE_REMOTESYNC] instead. Analogous to the [code]sync[/code] keyword. - </constant> <constant name="RPC_MODE_MASTERSYNC" value="5" enum="RPCMode"> Behave like [constant RPC_MODE_MASTER] but also make the call or property change locally. Analogous to the [code]mastersync[/code] keyword. </constant> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 1847954b67..5fd0da7452 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -619,7 +619,7 @@ </description> </method> <method name="rpc_config"> - <return type="void"> + <return type="int"> </return> <argument index="0" name="method" type="String"> </argument> @@ -672,7 +672,7 @@ </description> </method> <method name="rset_config"> - <return type="void"> + <return type="int"> </return> <argument index="0" name="property" type="String"> </argument> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e0f73df1bf..b3b77b0b26 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -973,11 +973,11 @@ </member> </members> <constants> - <constant name="VIDEO_DRIVER_GLES2" value="1" enum="VideoDriver"> + <constant name="VIDEO_DRIVER_GLES2" value="0" enum="VideoDriver"> The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. </constant> - <constant name="VIDEO_DRIVER_GLES3" value="0" enum="VideoDriver"> - The GLES3 rendering backend. It uses OpenGL ES 3.0 on mobile devices, OpenGL 3.3 on desktop platforms and WebGL 2.0 on the web. + <constant name="VIDEO_DRIVER_VULKAN" value="1" enum="VideoDriver"> + The Vulkan rendering backend. </constant> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> Sunday. diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 39da9d1548..b721bc9df4 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -36,7 +36,7 @@ <argument index="0" name="allow_objects" type="bool" default="false"> </argument> <description> - Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed. + Gets a Variant. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> @@ -57,16 +57,11 @@ <argument index="1" name="full_objects" type="bool" default="false"> </argument> <description> - Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code). + Sends a [Variant] as a packet. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> <members> - <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed" default="false"> - [i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead. - If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. - [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - </member> <member name="encode_buffer_max_size" type="int" setter="set_encode_buffer_max_size" getter="get_encode_buffer_max_size" default="8388608"> Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations. The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY]. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index e992f25836..a7bf947011 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -89,7 +89,7 @@ The amount of vertex memory used. </constant> <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="21" enum="Monitor"> - Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. + Unimplemented in the GLES2 rendering backend, always returns 0. </constant> <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="22" enum="Monitor"> Number of active [RigidBody2D] nodes in the game. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 517c68221e..0bedb3afe3 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -284,7 +284,7 @@ If [code]true[/code], enables warnings when a constant is used as a function. </member> <member name="debug/gdscript/warnings/deprecated_keyword" type="bool" setter="" getter="" default="true"> - If [code]true[/code], enables warnings when deprecated keywords such as [code]slave[/code] are used. + If [code]true[/code], enables warnings when deprecated keywords are used. </member> <member name="debug/gdscript/warnings/enable" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings. @@ -972,7 +972,7 @@ </member> <member name="rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround" type="bool" setter="" getter="" default="false"> Some NVIDIA GPU drivers have a bug which produces flickering issues for the [code]draw_rect[/code] method, especially as used in [TileMap]. Refer to [url=https://github.com/godotengine/godot/issues/9913]GitHub issue 9913[/url] for details. - If [code]true[/code], this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. + If [code]true[/code], this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend, and only desktop platforms. It is not necessary when using the Vulkan backend. </member> <member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter="" default="false"> If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. @@ -990,12 +990,8 @@ Lower-end override for [member rendering/quality/directional_shadow/size] on mobile devices, due to performance concerns or driver support. </member> <member name="rendering/quality/driver/driver_name" type="String" setter="" getter="" default=""Vulkan""> - The video driver to use ("GLES2" or "GLES3"). - [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. - </member> - <member name="rendering/quality/driver/fallback_to_gles2" type="bool" setter="" getter="" default="false"> - If [code]true[/code], allows falling back to the GLES2 driver if the GLES3 driver is not supported. - [b]Note:[/b] The two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. + The video driver to use ("GLES2" or "Vulkan"). + [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. </member> <member name="rendering/quality/filters/depth_of_field_bokeh_quality" type="int" setter="" getter="" default="2"> </member> @@ -1101,13 +1097,13 @@ Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. </member> <member name="rendering/vram_compression/import_bptc" type="bool" setter="" getter="" default="false"> - If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer. </member> <member name="rendering/vram_compression/import_etc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. </member> <member name="rendering/vram_compression/import_etc2" type="bool" setter="" getter="" default="true"> - If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the Vulkan renderer. </member> <member name="rendering/vram_compression/import_pvrtc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index f6b24c2391..9de10d12a8 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -3706,7 +3706,7 @@ The amount of draw calls in frame. </constant> <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6" enum="RenderInfo"> - Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. + Unimplemented in the GLES2 rendering backend, always returns 0. </constant> <constant name="INFO_VIDEO_MEM_USED" value="7" enum="RenderInfo"> The amount of video memory used, i.e. texture and vertex memory combined. diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index 9ccdf0d3c4..0d1bcc754f 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -143,6 +143,14 @@ Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the root of the main category (see [method _get_category]). </description> </method> + <method name="_is_highend" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Override this method to enable high-end mark in the Visual Shader Editor's members dialog. + Defining this method is [b]optional[/b]. If not overridden, it's false. + </description> + </method> </methods> <constants> </constants> |