diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2023-08-22 09:09:35 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-08-22 09:09:35 +0200 |
commit | 6758a7f8c07d1f4c8ec4f052ded6d26402967ebe (patch) | |
tree | f96e74080e63ab44b53fa0032dc87125656cfa94 | |
parent | b195b0a7d4b09c40c85514ab515d5432fb5a9b9a (diff) | |
parent | 765da0a365b63cef3e3459467e14e5206d7164e4 (diff) | |
download | redot-engine-6758a7f8c07d1f4c8ec4f052ded6d26402967ebe.tar.gz |
Merge pull request #80875 from Sauermann/fix-picking-doc
Document mouse-picking limit of 64 objects
-rw-r--r-- | doc/classes/Viewport.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 101717966e..43640916f4 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -298,10 +298,12 @@ </member> <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. + [b]Note:[/b] The number of simultaneously pickable objects is limited to 64 and they are selected in a non-deterministic order, which can be different in each picking process. </member> <member name="physics_object_picking_sort" type="bool" setter="set_physics_object_picking_sort" getter="get_physics_object_picking_sort" default="false"> If [code]true[/code], objects receive mouse picking events sorted primarily by their [member CanvasItem.z_index] and secondarily by their position in the scene tree. If [code]false[/code], the order is undetermined. [b]Note:[/b] This setting is disabled by default because of its potential expensive computational cost. + [b]Note:[/b] Sorting happens after selecting the pickable objects. Because of the limitation of 64 simultaneously pickable objects, it is not guaranteed that the object with the highest [member CanvasItem.z_index] receives the picking event. </member> <member name="positional_shadow_atlas_16_bits" type="bool" setter="set_positional_shadow_atlas_16_bits" getter="get_positional_shadow_atlas_16_bits" default="true"> Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. |