Improve the CanvasItem documentation
This makes it clear that line width and antialiasing in
`draw_multiline()` aren't implemented yet (see #16448).
(cherry picked from commit 1cfa74bf92)
This commit is contained in:
Hugo Locurcio
Rémi Verschelde
parent
2dd7121841
commit
8b8a9049b7
|
|
@ -4,10 +4,10 @@
|
|||
Base class of anything 2D.
|
||||
</brief_description>
|
||||
<description>
|
||||
Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related.
|
||||
Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though.
|
||||
Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though).
|
||||
Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode.
|
||||
Base class of anything 2D. Canvas items are laid out in a tree; children inherit and extend their parent's transform. CanvasItem is extended by [Control] for anything GUI-related, and by [Node2D] for anything related to the 2D engine.
|
||||
Any CanvasItem can draw. For this, [method update] must be called, then [constant NOTIFICATION_DRAW] will be received on idle time to request 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 the [method Object._notification], signal or [method _draw] virtual functions.
|
||||
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.
|
||||
A CanvasItem can also be hidden, which will also hide its children. It provides many ways to change parameters such as modulation (for itself and its children) and self modulation (only for itself), as well as its blend mode.
|
||||
Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.
|
||||
</description>
|
||||
<tutorials>
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
|
||||
</argument>
|
||||
<description>
|
||||
Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
|
||||
Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_circle">
|
||||
|
|
@ -112,7 +112,7 @@
|
|||
<argument index="3" name="antialiased" type="bool" default="false">
|
||||
</argument>
|
||||
<description>
|
||||
Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
|
||||
Draws multiple, parallel lines with a uniform [code]color[/code]. [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_multiline_colors">
|
||||
|
|
@ -207,7 +207,7 @@
|
|||
<argument index="5" name="normal_map" type="Texture" default="null">
|
||||
</argument>
|
||||
<description>
|
||||
Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
|
||||
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_rect">
|
||||
|
|
@ -304,7 +304,7 @@
|
|||
<argument index="5" name="normal_map" type="Texture" default="null">
|
||||
</argument>
|
||||
<description>
|
||||
Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||
Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_texture_rect_region">
|
||||
|
|
@ -325,7 +325,7 @@
|
|||
<argument index="6" name="clip_uv" type="bool" default="true">
|
||||
</argument>
|
||||
<description>
|
||||
Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||
Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
|
||||
</description>
|
||||
</method>
|
||||
<method name="force_update_transform">
|
||||
|
|
@ -415,7 +415,7 @@
|
|||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
Hide the CanvasItem currently visible.
|
||||
Hide the CanvasItem if it's currently visible.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_local_transform_notification_enabled" qualifiers="const">
|
||||
|
|
@ -429,7 +429,7 @@
|
|||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Return if set as toplevel. See [method set_as_toplevel].
|
||||
Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_transform_notification_enabled" qualifiers="const">
|
||||
|
|
@ -470,7 +470,7 @@
|
|||
<argument index="0" name="enable" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
Sets as top level. This means that it will not inherit transform from parent canvas items.
|
||||
If [code]enable[/code] is [code]true[/code], the node won't inherit its transform from parent canvas items.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_notify_local_transform">
|
||||
|
|
@ -495,14 +495,14 @@
|
|||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
Show the CanvasItem currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead.
|
||||
Show the CanvasItem if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="update">
|
||||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw.
|
||||
Queue the CanvasItem for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -529,7 +529,7 @@
|
|||
If [code]true[/code], the parent [code]CanvasItem[/code]'s [member material] property is used as this one's material. Default value: [code]false[/code].
|
||||
</member>
|
||||
<member name="visible" type="bool" setter="set_visible" getter="is_visible">
|
||||
If [code]true[/code], this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead.
|
||||
If [code]true[/code], this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
|
||||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
|
|
@ -571,22 +571,22 @@
|
|||
Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
|
||||
</constant>
|
||||
<constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode">
|
||||
Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.
|
||||
Disable blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied.
|
||||
</constant>
|
||||
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29">
|
||||
Canvas item transform has changed. Notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform].
|
||||
The CanvasItem's transform has changed. This notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform].
|
||||
</constant>
|
||||
<constant name="NOTIFICATION_DRAW" value="30">
|
||||
CanvasItem is requested to draw.
|
||||
The CanvasItem is requested to draw.
|
||||
</constant>
|
||||
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31">
|
||||
Canvas item visibility has changed.
|
||||
The CanvasItem's visibility has changed.
|
||||
</constant>
|
||||
<constant name="NOTIFICATION_ENTER_CANVAS" value="32">
|
||||
Canvas item has entered the canvas.
|
||||
The CanvasItem has entered the canvas.
|
||||
</constant>
|
||||
<constant name="NOTIFICATION_EXIT_CANVAS" value="33">
|
||||
Canvas item has exited the canvas.
|
||||
The CanvasItem has exited the canvas.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
|
|||
Loading…
Reference in New Issue