diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AABB.xml | 2 | ||||
| -rw-r--r-- | doc/classes/CanvasTexture.xml | 1 | ||||
| -rw-r--r-- | doc/classes/DisplayServer.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Image.xml | 9 | ||||
| -rw-r--r-- | doc/classes/PhysicsServer3DRenderingServerHandler.xml | 32 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 8 |
6 files changed, 46 insertions, 10 deletions
diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 0aa493361d..a803e4f106 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -126,7 +126,7 @@ <return type="Vector3" /> <param index="0" name="dir" type="Vector3" /> <description> - Returns the support point in a given direction. This is useful for collision detection algorithms. + Returns the vertex of the AABB that's the farthest in a given direction. This point is commonly known as the support point in collision detection algorithms. </description> </method> <method name="get_volume" qualifiers="const"> diff --git a/doc/classes/CanvasTexture.xml b/doc/classes/CanvasTexture.xml index df3f8e8125..1b22adb723 100644 --- a/doc/classes/CanvasTexture.xml +++ b/doc/classes/CanvasTexture.xml @@ -8,6 +8,7 @@ [b]Note:[/b] [CanvasTexture] cannot be used in 3D rendering. For physically-based materials in 3D, use [BaseMaterial3D] instead. </description> <tutorials> + <link title="2D Lights and Shadows">$DOCS_URL/tutorials/2d/2d_lights_and_shadows.html</link> </tutorials> <members> <member name="diffuse_texture" type="Texture2D" setter="set_diffuse_texture" getter="get_diffuse_texture"> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index e1035a55c8..579d38666d 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -1891,9 +1891,9 @@ </constant> <constant name="OPENGL_CONTEXT" value="3" enum="HandleType"> OpenGL context (only with the GL Compatibility renderer): - - Windows: [code]HGLRC[/code] for the window. + - Windows: [code]HGLRC[/code] for the window (native GL), or [code]EGLContext[/code] for the window (ANGLE). - Linux: [code]GLXContext*[/code] for the window. - - macOS: [code]NSOpenGLContext*[/code] for the window. + - macOS: [code]NSOpenGLContext*[/code] for the window (native GL), or [code]EGLContext[/code] for the window (ANGLE). - Android: [code]EGLContext[/code] for the window. </constant> <constant name="TTS_UTTERANCE_STARTED" value="0" enum="TTSUtteranceEvent"> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 5f1f9e6c18..2782e877a9 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -201,7 +201,8 @@ <return type="int" enum="Error" /> <param index="0" name="renormalize" type="bool" default="false" /> <description> - Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code]. + Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code]. Enabling [param renormalize] when generating mipmaps for normal textures will make sure all resulting vector values are normalized. + It is possible to check if the image has mipmaps by calling [method has_mipmaps] or [method get_mipmap_count]. </description> </method> <method name="get_data" qualifiers="const"> @@ -222,6 +223,12 @@ Returns the image's height. </description> </method> + <method name="get_mipmap_count" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count. + </description> + </method> <method name="get_mipmap_offset" qualifiers="const"> <return type="int" /> <param index="0" name="mipmap" type="int" /> diff --git a/doc/classes/PhysicsServer3DRenderingServerHandler.xml b/doc/classes/PhysicsServer3DRenderingServerHandler.xml index da04cd918c..c04dbf2bd7 100644 --- a/doc/classes/PhysicsServer3DRenderingServerHandler.xml +++ b/doc/classes/PhysicsServer3DRenderingServerHandler.xml @@ -12,20 +12,48 @@ <return type="void" /> <param index="0" name="aabb" type="AABB" /> <description> + Called by the [PhysicsServer3D] to set the bounding box for the [SoftBody3D]. </description> </method> <method name="_set_normal" qualifiers="virtual"> <return type="void" /> <param index="0" name="vertex_id" type="int" /> - <param index="1" name="normals" type="const void*" /> + <param index="1" name="normal" type="Vector3" /> <description> + Called by the [PhysicsServer3D] to set the normal for the [SoftBody3D] vertex at the index specified by [param vertex_id]. + [b]Note:[/b] The [param normal] parameter used to be of type [code]const void*[/code] prior to Godot 4.2. </description> </method> <method name="_set_vertex" qualifiers="virtual"> <return type="void" /> <param index="0" name="vertex_id" type="int" /> - <param index="1" name="vertices" type="const void*" /> + <param index="1" name="vertex" type="Vector3" /> <description> + Called by the [PhysicsServer3D] to set the position for the [SoftBody3D] vertex at the index specified by [param vertex_id]. + [b]Note:[/b] The [param vertex] parameter used to be of type [code]const void*[/code] prior to Godot 4.2. + </description> + </method> + <method name="set_aabb"> + <return type="void" /> + <param index="0" name="aabb" type="AABB" /> + <description> + Sets the bounding box for the [SoftBody3D]. + </description> + </method> + <method name="set_normal"> + <return type="void" /> + <param index="0" name="vertex_id" type="int" /> + <param index="1" name="normal" type="Vector3" /> + <description> + Sets the normal for the [SoftBody3D] vertex at the index specified by [param vertex_id]. + </description> + </method> + <method name="set_vertex"> + <return type="void" /> + <param index="0" name="vertex_id" type="int" /> + <param index="1" name="vertex" type="Vector3" /> + <description> + Sets the position for the [SoftBody3D] vertex at the index specified by [param vertex_id]. </description> </method> </methods> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 87c642c6d3..fe5269e95d 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -2117,11 +2117,11 @@ [codeblocks] [gdscript] # Set the default gravity strength to 9.8. - PhysicsServer3D.area_set_param(get_viewport().find_world().space, PhysicsServer3D.AREA_PARAM_GRAVITY, 9.8) + PhysicsServer3D.area_set_param(get_viewport().find_world_3d().space, PhysicsServer3D.AREA_PARAM_GRAVITY, 9.8) [/gdscript] [csharp] // Set the default gravity strength to 9.8. - PhysicsServer3D.AreaSetParam(GetViewport().FindWorld().Space, PhysicsServer3D.AreaParameter.Gravity, 9.8); + PhysicsServer3D.AreaSetParam(GetViewport().FindWorld3D().Space, PhysicsServer3D.AreaParameter.Gravity, 9.8); [/csharp] [/codeblocks] </member> @@ -2131,11 +2131,11 @@ [codeblocks] [gdscript] # Set the default gravity direction to `Vector3(0, -1, 0)`. - PhysicsServer3D.area_set_param(get_viewport().find_world().get_space(), PhysicsServer3D.AREA_PARAM_GRAVITY_VECTOR, Vector3.DOWN) + PhysicsServer3D.area_set_param(get_viewport().find_world_3d().space, PhysicsServer3D.AREA_PARAM_GRAVITY_VECTOR, Vector3.DOWN) [/gdscript] [csharp] // Set the default gravity direction to `Vector3(0, -1, 0)`. - PhysicsServer3D.AreaSetParam(GetViewport().FindWorld().Space, PhysicsServer3D.AreaParameter.GravityVector, Vector3.Down) + PhysicsServer3D.AreaSetParam(GetViewport().FindWorld3D().Space, PhysicsServer3D.AreaParameter.GravityVector, Vector3.Down) [/csharp] [/codeblocks] </member> |
