diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Control.xml | 9 | ||||
| -rw-r--r-- | doc/classes/EditorInspector.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Image.xml | 8 | ||||
| -rw-r--r-- | doc/classes/ImporterMeshInstance3D.xml | 14 | ||||
| -rw-r--r-- | doc/classes/PopupMenu.xml | 3 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 6 | ||||
| -rw-r--r-- | doc/classes/RenderSceneBuffersRD.xml | 13 | ||||
| -rw-r--r-- | doc/classes/RenderingDevice.xml | 15 | ||||
| -rw-r--r-- | doc/classes/RenderingServer.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Script.xml | 6 | ||||
| -rw-r--r-- | doc/classes/ScriptExtension.xml | 6 | ||||
| -rw-r--r-- | doc/classes/ScriptLanguageExtension.xml | 3 | ||||
| -rw-r--r-- | doc/classes/TabBar.xml | 16 | ||||
| -rw-r--r-- | doc/classes/TabContainer.xml | 25 | ||||
| -rw-r--r-- | doc/classes/Viewport.xml | 8 |
16 files changed, 139 insertions, 9 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 1b43f13e37..4ae3f96287 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -2719,7 +2719,7 @@ <constant name="PROPERTY_HINT_RANGE" value="1" enum="PropertyHint"> Hints that an [int] or [float] property should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_less"[/code] to allow manual input going respectively above the max or below the min values. [b]Example:[/b] [code]"-360,360,1,or_greater,or_less"[/code]. - Additionally, other keywords can be included: [code]"exp"[/code] for exponential range editing, [code]"radians"[/code] for editing radian angles in degrees, [code]"degrees"[/code] to hint at an angle and [code]"hide_slider"[/code] to hide the slider. + Additionally, other keywords can be included: [code]"exp"[/code] for exponential range editing, [code]"radians_as_degrees"[/code] for editing radian angles in degrees (the range values are also in degrees), [code]"degrees"[/code] to hint at an angle and [code]"hide_slider"[/code] to hide the slider. </constant> <constant name="PROPERTY_HINT_ENUM" value="2" enum="PropertyHint"> Hints that an [int] or [String] property is an enumerated value to pick in a list specified via a hint string. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index a870aa129a..d665084469 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -343,6 +343,14 @@ Finds the previous (above in the tree) [Control] that can receive the focus. </description> </method> + <method name="find_valid_focus_neighbor" qualifiers="const"> + <return type="Control" /> + <param index="0" name="side" type="int" enum="Side" /> + <description> + Finds the next [Control] that can receive the focus on the specified [enum Side]. + [b]Note:[/b] This is different from [method get_focus_neighbor], which returns the path of a specified focus neighbor. + </description> + </method> <method name="force_drag"> <return type="void" /> <param index="0" name="data" type="Variant" /> @@ -389,6 +397,7 @@ <param index="0" name="side" type="int" enum="Side" /> <description> Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. + [b]Note:[/b] To find the next [Control] on the specific [enum Side], even if a neighbor is not assigned, use [method find_valid_focus_neighbor]. </description> </method> <method name="get_global_rect" qualifiers="const"> diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index d55c1847e4..cfdc172fd1 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -14,6 +14,12 @@ <tutorials> </tutorials> <methods> + <method name="get_edited_object"> + <return type="Object" /> + <description> + Returns the object currently selected in this inspector. + </description> + </method> <method name="get_selected_path" qualifiers="const"> <return type="String" /> <description> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 2782e877a9..fabe6fe4bd 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -619,16 +619,16 @@ OpenGL texture format [code]GL_RGBA32F[/code] where there are four components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RH" value="12" enum="Format"> - OpenGL texture format [code]GL_R32F[/code] where there's one component, a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_R16F[/code] where there's one component, a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGH" value="13" enum="Format"> - OpenGL texture format [code]GL_RG32F[/code] where there are two components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RG16F[/code] where there are two components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBH" value="14" enum="Format"> - OpenGL texture format [code]GL_RGB32F[/code] where there are three components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RGB16F[/code] where there are three components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBAH" value="15" enum="Format"> - OpenGL texture format [code]GL_RGBA32F[/code] where there are four components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format [code]GL_RGBA16F[/code] where there are four components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBE9995" value="16" enum="Format"> A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single 5-bit exponent. diff --git a/doc/classes/ImporterMeshInstance3D.xml b/doc/classes/ImporterMeshInstance3D.xml index 87b3635454..9ace454036 100644 --- a/doc/classes/ImporterMeshInstance3D.xml +++ b/doc/classes/ImporterMeshInstance3D.xml @@ -7,11 +7,25 @@ <tutorials> </tutorials> <members> + <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance3D.ShadowCastingSetting" default="1"> + </member> + <member name="layer_mask" type="int" setter="set_layer_mask" getter="get_layer_mask" default="1"> + </member> <member name="mesh" type="ImporterMesh" setter="set_mesh" getter="get_mesh"> </member> <member name="skeleton_path" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath("")"> </member> <member name="skin" type="Skin" setter="set_skin" getter="get_skin"> </member> + <member name="visibility_range_begin" type="float" setter="set_visibility_range_begin" getter="get_visibility_range_begin" default="0.0"> + </member> + <member name="visibility_range_begin_margin" type="float" setter="set_visibility_range_begin_margin" getter="get_visibility_range_begin_margin" default="0.0"> + </member> + <member name="visibility_range_end" type="float" setter="set_visibility_range_end" getter="get_visibility_range_end" default="0.0"> + </member> + <member name="visibility_range_end_margin" type="float" setter="set_visibility_range_end_margin" getter="get_visibility_range_end_margin" default="0.0"> + </member> + <member name="visibility_range_fade_mode" type="int" setter="set_visibility_range_fade_mode" getter="get_visibility_range_fade_mode" enum="GeometryInstance3D.VisibilityRangeFadeMode" default="0"> + </member> </members> </class> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index c31416b823..d1c1304509 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -192,8 +192,9 @@ </method> <method name="clear"> <return type="void" /> + <param index="0" name="free_submenus" type="bool" default="false" /> <description> - Removes all items from the [PopupMenu]. + Removes all items from the [PopupMenu]. If [param free_submenus] is [code]true[/code], the submenu nodes are automatically freed. </description> </method> <method name="get_focused_item" qualifiers="const"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index b1189eeada..16d4bbd5c2 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -2717,6 +2717,12 @@ <member name="xr/openxr/form_factor" type="int" setter="" getter="" default=""0""> Specify whether OpenXR should be configured for an HMD or a hand held device. </member> + <member name="xr/openxr/foveation_dynamic" type="bool" setter="" getter="" default="false"> + If true and foveation is supported, will automatically adjust foveation level based on framerate up to the level set on [code]xr/openxr/foveation_level[/code]. + </member> + <member name="xr/openxr/foveation_level" type="int" setter="" getter="" default=""0""> + Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high. + </member> <member name="xr/openxr/reference_space" type="int" setter="" getter="" default=""1""> Specify the default reference space. </member> diff --git a/doc/classes/RenderSceneBuffersRD.xml b/doc/classes/RenderSceneBuffersRD.xml index d40d835d26..6ab1e6bbbd 100644 --- a/doc/classes/RenderSceneBuffersRD.xml +++ b/doc/classes/RenderSceneBuffersRD.xml @@ -130,6 +130,19 @@ Returns the texture size of a given slice of a cached texture. </description> </method> + <method name="get_texture_slice_view"> + <return type="RID" /> + <param index="0" name="context" type="StringName" /> + <param index="1" name="name" type="StringName" /> + <param index="2" name="layer" type="int" /> + <param index="3" name="mipmap" type="int" /> + <param index="4" name="layers" type="int" /> + <param index="5" name="mipmaps" type="int" /> + <param index="6" name="view" type="RDTextureView" /> + <description> + Returns a specific view of a slice (layer or mipmap) for a cached texture. + </description> + </method> <method name="get_use_taa" qualifiers="const"> <return type="bool" /> <description> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 8984c54253..b35eb89d19 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -742,6 +742,21 @@ [b]Note:[/b] Not to be confused with [method RenderingServer.texture_2d_create], which creates the Godot-specific [Texture2D] resource as opposed to the graphics API's own texture type. </description> </method> + <method name="texture_create_from_extension"> + <return type="RID" /> + <param index="0" name="type" type="int" enum="RenderingDevice.TextureType" /> + <param index="1" name="format" type="int" enum="RenderingDevice.DataFormat" /> + <param index="2" name="samples" type="int" enum="RenderingDevice.TextureSamples" /> + <param index="3" name="usage_flags" type="int" enum="RenderingDevice.TextureUsageBits" is_bitfield="true" /> + <param index="4" name="image" type="int" /> + <param index="5" name="width" type="int" /> + <param index="6" name="height" type="int" /> + <param index="7" name="depth" type="int" /> + <param index="8" name="layers" type="int" /> + <description> + Returns an RID for an existing [param image] ([code]VkImage[/code]) with the given [param type], [param format], [param samples], [param usage_flags], [param width], [param height], [param depth], and [param layers]. This can be used to allow Godot to render onto foreign images. + </description> + </method> <method name="texture_create_shared"> <return type="RID" /> <param index="0" name="view" type="RDTextureView" /> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 7331a7fe32..9f64cbf610 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -4507,7 +4507,10 @@ <constant name="VIEWPORT_SCALING_3D_MODE_FSR" value="1" enum="ViewportScaling3DMode"> Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling. </constant> - <constant name="VIEWPORT_SCALING_3D_MODE_MAX" value="2" enum="ViewportScaling3DMode"> + <constant name="VIEWPORT_SCALING_3D_MODE_FSR2" value="2" enum="ViewportScaling3DMode"> + Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR2. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use FSR2 at native resolution as a TAA solution. + </constant> + <constant name="VIEWPORT_SCALING_3D_MODE_MAX" value="3" enum="ViewportScaling3DMode"> Represents the size of the [enum ViewportScaling3DMode] enum. </constant> <constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode"> @@ -4708,6 +4711,9 @@ <constant name="VIEWPORT_DEBUG_DRAW_MOTION_VECTORS" value="25" enum="ViewportDebugDraw"> Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay. </constant> + <constant name="VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER" value="26" enum="ViewportDebugDraw"> + Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects. + </constant> <constant name="VIEWPORT_VRS_DISABLED" value="0" enum="ViewportVRSMode"> Variable rate shading is disabled. </constant> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 054399f989..28d763585d 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -81,6 +81,12 @@ Returns [code]true[/code] if [param base_object] is an instance of this script. </description> </method> + <method name="is_abstract" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. + </description> + </method> <method name="is_tool" qualifiers="const"> <return type="bool" /> <description> diff --git a/doc/classes/ScriptExtension.xml b/doc/classes/ScriptExtension.xml index f7c8ecb3fb..9e96a81f7b 100644 --- a/doc/classes/ScriptExtension.xml +++ b/doc/classes/ScriptExtension.xml @@ -141,6 +141,12 @@ <description> </description> </method> + <method name="_is_abstract" qualifiers="virtual const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. + </description> + </method> <method name="_is_placeholder_fallback_enabled" qualifiers="virtual const"> <return type="bool" /> <description> diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml index a05d243b0a..e10cb89e20 100644 --- a/doc/classes/ScriptLanguageExtension.xml +++ b/doc/classes/ScriptLanguageExtension.xml @@ -197,9 +197,10 @@ <description> </description> </method> - <method name="_has_named_classes" qualifiers="virtual const"> + <method name="_has_named_classes" qualifiers="virtual const" is_deprecated="true"> <return type="bool" /> <description> + [i]Deprecated.[/i] This method is not called by the engine. </description> </method> <method name="_init" qualifiers="virtual"> diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml index 8b3bac456a..bfcb1a0e69 100644 --- a/doc/classes/TabBar.xml +++ b/doc/classes/TabBar.xml @@ -140,6 +140,18 @@ Removes the tab at index [param tab_idx]. </description> </method> + <method name="select_next_available"> + <return type="bool" /> + <description> + Selects the first available tab with greater index than the currently selected. Returns [code]true[/code] if tab selection changed. + </description> + </method> + <method name="select_previous_available"> + <return type="bool" /> + <description> + Selects the first available tab with lower index than the currently selected. Returns [code]true[/code] if tab selection changed. + </description> + </method> <method name="set_tab_button_icon"> <return type="void" /> <param index="0" name="tab_idx" type="int" /> @@ -223,6 +235,7 @@ <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled" default="false"> If [code]true[/code], tabs can be rearranged with mouse drag. </member> + <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" /> <member name="max_tab_width" type="int" setter="set_max_tab_width" getter="get_max_tab_width" default="0"> Sets the maximum width which all tabs should be limited to. Unlimited if set to [code]0[/code]. </member> @@ -396,6 +409,9 @@ <theme_item name="tab_disabled" data_type="style" type="StyleBox"> The style of disabled tabs. </theme_item> + <theme_item name="tab_focus" data_type="style" type="StyleBox"> + [StyleBox] used when the [TabBar] is focused. The [theme_item tab_focus] [StyleBox] is displayed [i]over[/i] the base [StyleBox] of the selected tab, so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + </theme_item> <theme_item name="tab_hovered" data_type="style" type="StyleBox"> The style of the currently hovered tab. Does not apply to the selected tab. </theme_item> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 940eb89dab..07f6dbd8c5 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -30,6 +30,13 @@ Returns the previously active tab index. </description> </method> + <method name="get_tab_bar" qualifiers="const"> + <return type="TabBar" /> + <description> + Returns the [TabBar] contained in this container. + [b]Warning:[/b] This is a required internal node, removing and freeing it or editing its tabs may cause a crash. If you wish to edit the tabs, use the methods provided in [TabContainer]. + </description> + </method> <method name="get_tab_button_icon" qualifiers="const"> <return type="Texture2D" /> <param index="0" name="tab_idx" type="int" /> @@ -99,6 +106,18 @@ Returns [code]true[/code] if the tab at index [param tab_idx] is hidden. </description> </method> + <method name="select_next_available"> + <return type="bool" /> + <description> + Selects the first available tab with greater index than the currently selected. Returns [code]true[/code] if tab selection changed. + </description> + </method> + <method name="select_previous_available"> + <return type="bool" /> + <description> + Selects the first available tab with lower index than the currently selected. Returns [code]true[/code] if tab selection changed. + </description> + </method> <method name="set_popup"> <return type="void" /> <param index="0" name="popup" type="Node" /> @@ -171,6 +190,9 @@ <member name="tab_alignment" type="int" setter="set_tab_alignment" getter="get_tab_alignment" enum="TabBar.AlignmentMode" default="0"> Sets the position at which tabs will be placed. See [enum TabBar.AlignmentMode] for details. </member> + <member name="tab_focus_mode" type="int" setter="set_tab_focus_mode" getter="get_tab_focus_mode" enum="Control.FocusMode" default="2"> + The focus access mode for the internal [TabBar] node. + </member> <member name="tabs_rearrange_group" type="int" setter="set_tabs_rearrange_group" getter="get_tabs_rearrange_group" default="-1"> [TabContainer]s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with [member drag_to_rearrange_enabled]. Setting this to [code]-1[/code] will disable rearranging between [TabContainer]s. @@ -291,6 +313,9 @@ <theme_item name="tab_disabled" data_type="style" type="StyleBox"> The style of disabled tabs. </theme_item> + <theme_item name="tab_focus" data_type="style" type="StyleBox"> + [StyleBox] used when the [TabBar] is focused. The [theme_item tab_focus] [StyleBox] is displayed [i]over[/i] the base [StyleBox] of the selected tab, so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + </theme_item> <theme_item name="tab_hovered" data_type="style" type="StyleBox"> The style of the currently hovered tab. </theme_item> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 413d9462fe..1b5f7148ac 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -443,7 +443,10 @@ <constant name="SCALING_3D_MODE_FSR" value="1" enum="Scaling3DMode"> Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling. </constant> - <constant name="SCALING_3D_MODE_MAX" value="2" enum="Scaling3DMode"> + <constant name="SCALING_3D_MODE_FSR2" value="2" enum="Scaling3DMode"> + Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR2. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use FSR2 at native resolution as a TAA solution. + </constant> + <constant name="SCALING_3D_MODE_MAX" value="3" enum="Scaling3DMode"> Represents the size of the [enum Scaling3DMode] enum. </constant> <constant name="MSAA_DISABLED" value="0" enum="MSAA"> @@ -553,6 +556,9 @@ </constant> <constant name="DEBUG_DRAW_MOTION_VECTORS" value="25" enum="DebugDraw"> </constant> + <constant name="DEBUG_DRAW_INTERNAL_BUFFER" value="26" enum="DebugDraw"> + Draws the internal resolution buffer of the scene before post-processing is applied. + </constant> <constant name="DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST" value="0" enum="DefaultCanvasItemTextureFilter"> The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. </constant> |