Improve the CanvasItem class documentation
(cherry picked from commit ccd8cdc363)
This commit is contained in:
Hugo Locurcio
Rémi Verschelde
parent
56e06648ab
commit
08256e0e16
|
|
@ -34,7 +34,7 @@
|
|||
<argument index="6" name="width" type="float" default="1.0" />
|
||||
<argument index="7" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws an arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve.
|
||||
Draws a unfilled arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve. See also [method draw_circle].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_char">
|
||||
|
|
@ -54,7 +54,7 @@
|
|||
<argument index="1" name="radius" type="float" />
|
||||
<argument index="2" name="color" type="Color" />
|
||||
<description>
|
||||
Draws a colored circle.
|
||||
Draws a colored, unfilled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_colored_polygon">
|
||||
|
|
@ -66,7 +66,7 @@
|
|||
<argument index="4" name="normal_map" type="Texture" default="null" />
|
||||
<argument index="5" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws a colored polygon of any amount of points, convex or concave.
|
||||
Draws a colored polygon of any amount of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_line">
|
||||
|
|
@ -77,7 +77,7 @@
|
|||
<argument index="3" name="width" type="float" default="1.0" />
|
||||
<argument index="4" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also [method draw_multiline] and [method draw_polyline].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_mesh">
|
||||
|
|
@ -98,7 +98,7 @@
|
|||
<argument index="2" name="width" type="float" default="1.0" />
|
||||
<argument index="3" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws multiple, parallel lines with a uniform [code]color[/code].
|
||||
Draws multiple disconnected lines with a uniform [code]color[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline] instead.
|
||||
[b]Note:[/b] [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect.
|
||||
</description>
|
||||
</method>
|
||||
|
|
@ -109,7 +109,7 @@
|
|||
<argument index="2" name="width" type="float" default="1.0" />
|
||||
<argument index="3" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws multiple, parallel lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
|
||||
Draws multiple disconnected lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline_colors] instead.
|
||||
[b]Note:[/b] [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect.
|
||||
</description>
|
||||
</method>
|
||||
|
|
@ -131,7 +131,7 @@
|
|||
<argument index="4" name="normal_map" type="Texture" default="null" />
|
||||
<argument index="5" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws a polygon of any amount of points, convex or concave.
|
||||
Draws a solid polygon of any amount of points, convex or concave. Unlike [method draw_colored_polygon], each point's color can be changed individually. See also [method draw_polyline] and [method draw_polyline_colors].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_polyline">
|
||||
|
|
@ -141,7 +141,7 @@
|
|||
<argument index="2" name="width" type="float" default="1.0" />
|
||||
<argument index="3" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
|
||||
Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline] instead. See also [method draw_polygon].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_polyline_colors">
|
||||
|
|
@ -151,7 +151,7 @@
|
|||
<argument index="2" name="width" type="float" default="1.0" />
|
||||
<argument index="3" name="antialiased" type="bool" default="false" />
|
||||
<description>
|
||||
Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
|
||||
Draws interconnected line segments with a uniform [code]width[/code] and segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline_colors] instead. See also [method draw_polygon].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_primitive">
|
||||
|
|
@ -163,7 +163,7 @@
|
|||
<argument index="4" name="width" type="float" default="1.0" />
|
||||
<argument index="5" name="normal_map" type="Texture" default="null" />
|
||||
<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. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also [method draw_line], [method draw_polyline], [method draw_polygon], and [method draw_rect].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_rect">
|
||||
|
|
@ -332,7 +332,7 @@
|
|||
<method name="hide">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Hide the [CanvasItem] if it's currently visible.
|
||||
Hide the [CanvasItem] if it's currently visible. This is equivalent to setting [member visible] to [code]false[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_local_transform_notification_enabled" qualifiers="const">
|
||||
|
|
@ -397,7 +397,7 @@
|
|||
<method name="show">
|
||||
<return type="void" />
|
||||
<description>
|
||||
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.
|
||||
Show the [CanvasItem] if it's currently hidden. This is equivalent to setting [member visible] to [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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="update">
|
||||
|
|
|
|||
Loading…
Reference in New Issue