diff options
| author | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2023-09-03 14:27:02 +0200 |
|---|---|---|
| committer | Markus Sauermann <6299227+Sauermann@users.noreply.github.com> | 2023-09-18 21:33:31 +0200 |
| commit | fffbb42a24b00a72ca3cb796412adee3ec6719ee (patch) | |
| tree | e1d8df4044de3c931198fd615764af30331449bf | |
| parent | fa3428ff25bc577d2a3433090478a6d615567056 (diff) | |
| download | redot-engine-fffbb42a24b00a72ca3cb796412adee3ec6719ee.tar.gz | |
Improve canvas layer index documentation
Document special case of identical canvas layer index.
| -rw-r--r-- | doc/classes/CanvasItem.xml | 2 | ||||
| -rw-r--r-- | doc/classes/CanvasLayer.xml | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 33f6a02c52..84efd11b43 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -6,7 +6,7 @@ <description> Abstract base class for everything in 2D space. Canvas items are laid out in a tree; children inherit and extend their parent's transform. [CanvasItem] is extended by [Control] for GUI-related nodes, and by [Node2D] for 2D game objects. Any [CanvasItem] can draw. For this, [method queue_redraw] is called by the engine, then [constant NOTIFICATION_DRAW] will be received on idle time to request a redraw. Because of this, canvas items don't need to be redrawn on every frame, improving the performance significantly. Several functions for drawing on the [CanvasItem] are provided (see [code]draw_*[/code] functions). However, they can only be used inside [method _draw], its corresponding [method Object._notification] or methods connected to the [signal draw] signal. - Canvas items are drawn in tree order. By default, children are on top of their parents, so a root [CanvasItem] will be drawn behind everything. This behavior can be changed on a per-item basis. + Canvas items are drawn in tree order on their canvas layer. By default, children are on top of their parents, so a root [CanvasItem] will be drawn behind everything. This behavior can be changed on a per-item basis. A [CanvasItem] can be hidden, which will also hide its children. By adjusting various other properties of a [CanvasItem], you can also modulate its color (via [member modulate] or [member self_modulate]), change its Z-index, blend mode, and more. </description> <tutorials> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 2b155d869d..a91b003d79 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -53,6 +53,7 @@ </member> <member name="layer" type="int" setter="set_layer" getter="get_layer" default="1"> Layer index for draw order. Lower values are drawn behind higher values. + [b]Note:[/b] If multiple CanvasLayers have the same layer index, [CanvasItem] children of one CanvasLayer are drawn behind the [CanvasItem] children of the other CanvasLayer. Which CanvasLayer is drawn in front is non-deterministic. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2(0, 0)"> The layer's base offset. |