diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/EditorNode3DGizmo.xml | 2 | ||||
| -rw-r--r-- | doc/classes/FontData.xml | 12 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 5 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 7 | ||||
| -rw-r--r-- | doc/classes/RefCounted.xml | 4 | ||||
| -rw-r--r-- | doc/classes/RenderingDevice.xml | 2 | ||||
| -rw-r--r-- | doc/classes/RenderingServer.xml | 12 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Viewport.xml | 17 |
9 files changed, 23 insertions, 40 deletions
diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index a2eac01ae8..c804bb70e0 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -178,7 +178,7 @@ </method> <method name="is_subgizmo_selected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="arg0" type="int" /> + <argument index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. </description> diff --git a/doc/classes/FontData.xml b/doc/classes/FontData.xml index 7b1fc2ab42..04932ddd2d 100644 --- a/doc/classes/FontData.xml +++ b/doc/classes/FontData.xml @@ -105,9 +105,9 @@ </method> <method name="get_glyph_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="char" type="int" /> - <argument index="1" name="variation_selector" type="int" /> - <argument index="2" name="arg2" type="int" /> + <argument index="0" name="size" type="int" /> + <argument index="1" name="char" type="int" /> + <argument index="2" name="variation_selector" type="int" /> <description> Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. </description> @@ -242,7 +242,7 @@ <return type="int" /> <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="int" /> - <argument index="2" name="arg2" type="int" enum="TextServer.SpacingType" /> + <argument index="2" name="spacing_type" type="int" enum="TextServer.SpacingType" /> <description> Returns extra spacing added between glyphs in pixels. </description> @@ -596,8 +596,8 @@ <return type="void" /> <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="int" /> - <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> - <argument index="3" name="arg3" type="int" /> + <argument index="2" name="spacing_type" type="int" enum="TextServer.SpacingType" /> + <argument index="3" name="value" type="int" /> <description> Sets extra spacing added between glyphs in pixels. </description> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 11c42fbd4a..cae74ca553 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -587,8 +587,9 @@ <return type="int" /> <argument index="0" name="method" type="StringName" /> <argument index="1" name="rpc_mode" type="int" enum="RPCMode" /> - <argument index="2" name="transfer_mode" type="int" enum="TransferMode" default="2" /> - <argument index="3" name="channel" type="int" default="0" /> + <argument index="2" name="call_local" type="bool" default="false" /> + <argument index="3" name="transfer_mode" type="int" enum="TransferMode" default="2" /> + <argument index="4" name="channel" type="int" default="0" /> <description> Changes the RPC mode for the given [code]method[/code] to the given [code]rpc_mode[/code], optionally specifying the [code]transfer_mode[/code] and [code]channel[/code] (on supported peers). See [enum RPCMode] and [enum TransferMode]. An alternative is annotating methods and properties with the corresponding annotation ([code]@rpc(any)[/code], [code]@rpc(auth)[/code]). By default, methods are not exposed to networking (and RPCs). </description> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index b3872121bf..5403bd48d5 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1479,11 +1479,12 @@ </member> <member name="rendering/2d/snap/snap_2d_vertices_to_pixel" type="bool" setter="" getter="" default="false"> </member> - <member name="rendering/3d/viewport/scale" type="int" setter="" getter="" default="0"> - Scale the 3D render buffer based on the viewport size. The smaller the faster 3D rendering is performed but at the cost of quality. + <member name="rendering/3d/viewport/scale" type="float" setter="" getter="" default="1.0"> + Scales the 3D render buffer based on the viewport size and displays the result with linear filtering. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [member rendering/anti_aliasing/quality/msaa] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + [b]Note:[/b] This property is only read when the project starts. To change the 3D rendering resolution scale at runtime, set [member Viewport.scale_3d] instead. </member> <member name="rendering/anti_aliasing/quality/msaa" type="int" setter="" getter="" default="0"> - Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. + Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. See also [member rendering/3d/viewport/scale] for supersampling, which provides higher quality but is much more expensive. </member> <member name="rendering/anti_aliasing/quality/screen_space_aa" type="int" setter="" getter="" default="0"> Sets the screen-space antialiasing mode for the default screen [Viewport]. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. diff --git a/doc/classes/RefCounted.xml b/doc/classes/RefCounted.xml index d965d2ea10..de314fbcb7 100644 --- a/doc/classes/RefCounted.xml +++ b/doc/classes/RefCounted.xml @@ -5,9 +5,9 @@ </brief_description> <description> Base class for any object that keeps a reference count. [Resource] and many other helper objects inherit this class. - Unlike other [Object] types, References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with [method Object.free]. + Unlike other [Object] types, [RefCounted]s keep an internal reference counter so that they are automatically released when no longer in use, and only then. [RefCounted]s therefore do not need to be freed manually with [method Object.free]. In the vast majority of use cases, instantiating and using [RefCounted]-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. - [b]Note:[/b] In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed. + [b]Note:[/b] In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will linger on for a while before being removed. </description> <tutorials> <link title="When and how to avoid using nodes for everything">https://docs.godotengine.org/en/latest/tutorials/best_practices/node_alternatives.html</link> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 428fa2575c..442dcc7d18 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -374,7 +374,7 @@ </method> <method name="get_memory_usage" qualifiers="const"> <return type="int" /> - <argument index="0" name="arg0" type="int" enum="RenderingDevice.MemoryType" /> + <argument index="0" name="type" type="int" enum="RenderingDevice.MemoryType" /> <description> </description> </method> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 65b7e53ecd..6f19114c16 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -3102,7 +3102,7 @@ <method name="viewport_set_scale_3d"> <return type="void" /> <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="scale" type="int" enum="RenderingServer.ViewportScale3D" /> + <argument index="1" name="scale" type="float" /> <description> Sets the scale at which we render 3D contents. </description> @@ -3918,16 +3918,6 @@ </constant> <constant name="VIEWPORT_DEBUG_DRAW_OCCLUDERS" value="23" enum="ViewportDebugDraw"> </constant> - <constant name="VIEWPORT_SCALE_3D_DISABLED" value="0" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_75_PERCENT" value="1" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_50_PERCENT" value="2" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_33_PERCENT" value="3" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_25_PERCENT" value="4" enum="ViewportScale3D"> - </constant> <constant name="SKY_MODE_AUTOMATIC" value="0" enum="SkyMode"> </constant> <constant name="SKY_MODE_QUALITY" value="1" enum="SkyMode"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 0e39381991..3667dbf578 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -936,7 +936,7 @@ <member name="language" type="String" setter="set_language" getter="get_language" default=""""> Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </member> - <member name="minimap_draw" type="bool" setter="draw_minimap" getter="is_drawing_minimap" default="false"> + <member name="minimap_draw" type="bool" setter="set_draw_minimap" getter="is_drawing_minimap" default="false"> If [code]true[/code], a minimap is shown, providing an outline of your source code. </member> <member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index cdb9e7632b..e79cf0d233 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -204,7 +204,7 @@ <member name="lod_threshold" type="float" setter="set_lod_threshold" getter="get_lod_threshold" default="1.0"> </member> <member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA" default="0"> - The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems. + The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. See also [member scale_3d] for supersampling, which provides higher quality but is much more expensive. </member> <member name="own_world_3d" type="bool" setter="set_use_own_world_3d" getter="is_using_own_world_3d" default="false"> If [code]true[/code], the viewport will use the [World3D] defined in [member world_3d]. @@ -212,8 +212,9 @@ <member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking" default="false"> If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. </member> - <member name="scale_3d" type="int" setter="set_scale_3d" getter="get_scale_3d" enum="Viewport.Scale3D" default="0"> - The scale at which 3D content is rendered. + <member name="scale_3d" type="float" setter="set_scale_3d" getter="get_scale_3d" default="1.0"> + Scales the 3D render buffer based on the viewport size and displays the result with linear filtering. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [member msaa] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + To control this property on the root viewport, set the [member ProjectSettings.rendering/3d/viewport/scale] project setting. </member> <member name="screen_space_aa" type="int" setter="set_screen_space_aa" getter="get_screen_space_aa" enum="Viewport.ScreenSpaceAA" default="0"> Sets the screen-space antialiasing method used. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. @@ -275,16 +276,6 @@ </signal> </signals> <constants> - <constant name="SCALE_3D_DISABLED" value="0" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_75_PERCENT" value="1" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_50_PERCENT" value="2" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_33_PERCENT" value="3" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_25_PERCENT" value="4" enum="Scale3D"> - </constant> <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv"> This quadrant will not be used. </constant> |