diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Control.xml | 2 | ||||
| -rw-r--r-- | doc/classes/EditorNode3DGizmoPlugin.xml | 4 | ||||
| -rw-r--r-- | doc/classes/RDShaderFile.xml | 6 | ||||
| -rw-r--r-- | doc/classes/RDShaderSPIRV.xml (renamed from doc/classes/RDShaderBytecode.xml) | 2 | ||||
| -rw-r--r-- | doc/classes/RenderingDevice.xml | 24 |
5 files changed, 28 insertions, 10 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 79b3788449..5c0856cb6a 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1229,11 +1229,13 @@ <signal name="mouse_entered"> <description> Emitted when the mouse enters the control's [code]Rect[/code] area, provided its [member mouse_filter] lets the event reach it. + [b]Note:[/b] [signal mouse_entered] will not be emitted if the mouse enters a child [Control] node before entering the parent's [code]Rect[/code] area, at least until the mouse is moved to reach the parent's [code]Rect[/code] area. </description> </signal> <signal name="mouse_exited"> <description> Emitted when the mouse leaves the control's [code]Rect[/code] area, provided its [member mouse_filter] lets the event reach it. + [b]Note:[/b] [signal mouse_exited] will be emitted if the mouse enters a child [Control] node, even if the mouse cursor is still inside the parent's [code]Rect[/code] area. </description> </signal> <signal name="resized"> diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index 10d6bd8bc8..6152487eaf 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -46,7 +46,7 @@ </argument> <description> Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". - If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. Called for this plugin's active gizmos. + If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos. </description> </method> <method name="_create_gizmo" qualifiers="virtual"> @@ -103,7 +103,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. + Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. </description> </method> <method name="_has_gizmo" qualifiers="virtual"> diff --git a/doc/classes/RDShaderFile.xml b/doc/classes/RDShaderFile.xml index 346a97a1c0..dab2b9822f 100644 --- a/doc/classes/RDShaderFile.xml +++ b/doc/classes/RDShaderFile.xml @@ -7,8 +7,8 @@ <tutorials> </tutorials> <methods> - <method name="get_bytecode" qualifiers="const"> - <return type="RDShaderBytecode"> + <method name="get_spirv" qualifiers="const"> + <return type="RDShaderSPIRV"> </return> <argument index="0" name="version" type="StringName" default="&"""> </argument> @@ -24,7 +24,7 @@ <method name="set_bytecode"> <return type="void"> </return> - <argument index="0" name="bytecode" type="RDShaderBytecode"> + <argument index="0" name="bytecode" type="RDShaderSPIRV"> </argument> <argument index="1" name="version" type="StringName" default="&"""> </argument> diff --git a/doc/classes/RDShaderBytecode.xml b/doc/classes/RDShaderSPIRV.xml index 20bf9bdd72..c9aefe31dc 100644 --- a/doc/classes/RDShaderBytecode.xml +++ b/doc/classes/RDShaderSPIRV.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDShaderBytecode" inherits="Resource" version="4.0"> +<class name="RDShaderSPIRV" inherits="Resource" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 901a985961..c73c2ddfd7 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -635,8 +635,16 @@ <description> </description> </method> - <method name="shader_compile_from_source"> - <return type="RDShaderBytecode"> + <method name="shader_compile_binary_from_spirv"> + <return type="PackedByteArray"> + </return> + <argument index="0" name="spirv_data" type="RDShaderSPIRV"> + </argument> + <description> + </description> + </method> + <method name="shader_compile_spirv_from_source"> + <return type="RDShaderSPIRV"> </return> <argument index="0" name="shader_source" type="RDShaderSource"> </argument> @@ -645,10 +653,18 @@ <description> </description> </method> - <method name="shader_create"> + <method name="shader_create_from_bytecode"> <return type="RID"> </return> - <argument index="0" name="shader_data" type="RDShaderBytecode"> + <argument index="0" name="binary_data" type="PackedByteArray"> + </argument> + <description> + </description> + </method> + <method name="shader_create_from_spirv"> + <return type="PackedByteArray"> + </return> + <argument index="0" name="spirv_data" type="RDShaderSPIRV"> </argument> <description> </description> |