650 lines
36 KiB
XML
650 lines
36 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CanvasItem" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Base class of anything 2D.
|
|
</brief_description>
|
|
<description>
|
|
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 queue_redraw] is called by the engine, 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 [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.
|
|
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.
|
|
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg_to_rad].
|
|
</description>
|
|
<tutorials>
|
|
<link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link>
|
|
<link title="Custom drawing in 2D">$DOCS_URL/tutorials/2d/custom_drawing_in_2d.html</link>
|
|
<link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="_draw" qualifiers="virtual">
|
|
<return type="void" />
|
|
<description>
|
|
Called when [CanvasItem] has been requested to redraw (after [method queue_redraw] is called, either manually or by the engine).
|
|
Corresponds to the [constant NOTIFICATION_DRAW] notification in [method Object._notification].
|
|
</description>
|
|
</method>
|
|
<method name="draw_animation_slice">
|
|
<return type="void" />
|
|
<param index="0" name="animation_length" type="float" />
|
|
<param index="1" name="slice_begin" type="float" />
|
|
<param index="2" name="slice_end" type="float" />
|
|
<param index="3" name="offset" type="float" default="0.0" />
|
|
<description>
|
|
Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
|
|
</description>
|
|
</method>
|
|
<method name="draw_arc">
|
|
<return type="void" />
|
|
<param index="0" name="center" type="Vector2" />
|
|
<param index="1" name="radius" type="float" />
|
|
<param index="2" name="start_angle" type="float" />
|
|
<param index="3" name="end_angle" type="float" />
|
|
<param index="4" name="point_count" type="int" />
|
|
<param index="5" name="color" type="Color" />
|
|
<param index="6" name="width" type="float" default="1.0" />
|
|
<param index="7" name="antialiased" type="bool" default="false" />
|
|
<description>
|
|
Draws a unfilled arc between the given angles. The larger the value of [param point_count], the smoother the curve. See also [method draw_circle].
|
|
</description>
|
|
</method>
|
|
<method name="draw_char" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="char" type="String" />
|
|
<param index="3" name="font_size" type="int" default="16" />
|
|
<param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<description>
|
|
Draws a string first character using a custom font.
|
|
</description>
|
|
</method>
|
|
<method name="draw_char_outline" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="char" type="String" />
|
|
<param index="3" name="font_size" type="int" default="16" />
|
|
<param index="4" name="size" type="int" default="-1" />
|
|
<param index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<description>
|
|
Draws a string first character outline using a custom font.
|
|
</description>
|
|
</method>
|
|
<method name="draw_circle">
|
|
<return type="void" />
|
|
<param index="0" name="position" type="Vector2" />
|
|
<param index="1" name="radius" type="float" />
|
|
<param index="2" name="color" type="Color" />
|
|
<description>
|
|
Draws a colored, filled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon].
|
|
</description>
|
|
</method>
|
|
<method name="draw_colored_polygon">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="color" type="Color" />
|
|
<param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
|
|
<param index="3" name="texture" type="Texture2D" default="null" />
|
|
<description>
|
|
Draws a colored polygon of any number of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon.
|
|
</description>
|
|
</method>
|
|
<method name="draw_dashed_line">
|
|
<return type="void" />
|
|
<param index="0" name="from" type="Vector2" />
|
|
<param index="1" name="to" type="Vector2" />
|
|
<param index="2" name="color" type="Color" />
|
|
<param index="3" name="width" type="float" default="1.0" />
|
|
<param index="4" name="dash" type="float" default="2.0" />
|
|
<description>
|
|
Draws a dashed line from a 2D point to another, with a given color and width. See also [method draw_multiline] and [method draw_polyline].
|
|
</description>
|
|
</method>
|
|
<method name="draw_end_animation">
|
|
<return type="void" />
|
|
<description>
|
|
After submitting all animations slices via [method draw_animation_slice], this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required.
|
|
</description>
|
|
</method>
|
|
<method name="draw_lcd_texture_rect_region">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="rect" type="Rect2" />
|
|
<param index="2" name="src_rect" type="Rect2" />
|
|
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<description>
|
|
Draws a textured rectangle region of the font texture with LCD sub-pixel anti-aliasing at a given position, optionally modulated by a color.
|
|
Texture is drawn using the following blend operation, blend mode of the [CanvasItemMaterial] is ignored:
|
|
[codeblock]
|
|
dst.r = texture.r * modulate.r * modulate.a + dst.r * (1.0 - texture.r * modulate.a);
|
|
dst.g = texture.g * modulate.g * modulate.a + dst.g * (1.0 - texture.g * modulate.a);
|
|
dst.b = texture.b * modulate.b * modulate.a + dst.b * (1.0 - texture.b * modulate.a);
|
|
dst.a = modulate.a + dst.a * (1.0 - modulate.a);
|
|
[/codeblock]
|
|
</description>
|
|
</method>
|
|
<method name="draw_line">
|
|
<return type="void" />
|
|
<param index="0" name="from" type="Vector2" />
|
|
<param index="1" name="to" type="Vector2" />
|
|
<param index="2" name="color" type="Color" />
|
|
<param index="3" name="width" type="float" default="1.0" />
|
|
<param 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. See also [method draw_multiline] and [method draw_polyline].
|
|
</description>
|
|
</method>
|
|
<method name="draw_mesh">
|
|
<return type="void" />
|
|
<param index="0" name="mesh" type="Mesh" />
|
|
<param index="1" name="texture" type="Texture2D" />
|
|
<param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
|
|
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<description>
|
|
Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation.
|
|
</description>
|
|
</method>
|
|
<method name="draw_msdf_texture_rect_region">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="rect" type="Rect2" />
|
|
<param index="2" name="src_rect" type="Rect2" />
|
|
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="4" name="outline" type="float" default="0.0" />
|
|
<param index="5" name="pixel_range" type="float" default="4.0" />
|
|
<description>
|
|
Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See [member FontFile.multichannel_signed_distance_field] for more information and caveats about MSDF font rendering.
|
|
If [param outline] is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the [param outline] radius.
|
|
Value of the [param pixel_range] should the same that was used during distance field texture generation.
|
|
</description>
|
|
</method>
|
|
<method name="draw_multiline">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="color" type="Color" />
|
|
<param index="2" name="width" type="float" default="1.0" />
|
|
<description>
|
|
Draws multiple disconnected lines with a uniform [param color]. 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.
|
|
</description>
|
|
</method>
|
|
<method name="draw_multiline_colors">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="colors" type="PackedColorArray" />
|
|
<param index="2" name="width" type="float" default="1.0" />
|
|
<description>
|
|
Draws multiple disconnected lines with a uniform [param width] and segment-by-segment coloring. Colors assigned to line segments match by index between [param points] and [param colors]. 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.
|
|
</description>
|
|
</method>
|
|
<method name="draw_multiline_string" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="text" type="String" />
|
|
<param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" />
|
|
<param index="4" name="width" type="float" default="-1" />
|
|
<param index="5" name="font_size" type="int" default="16" />
|
|
<param index="6" name="max_lines" type="int" default="-1" />
|
|
<param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="8" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" />
|
|
<param index="9" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" />
|
|
<param index="10" name="direction" type="int" enum="TextServer.Direction" default="0" />
|
|
<param index="11" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
|
|
<description>
|
|
Breaks [param text] into lines and draws it using the specified [param font] at the [param pos] (top-left corner). The text will have its color multiplied by [param modulate]. If [param width] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
|
|
</description>
|
|
</method>
|
|
<method name="draw_multiline_string_outline" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="text" type="String" />
|
|
<param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" />
|
|
<param index="4" name="width" type="float" default="-1" />
|
|
<param index="5" name="font_size" type="int" default="16" />
|
|
<param index="6" name="max_lines" type="int" default="-1" />
|
|
<param index="7" name="size" type="int" default="1" />
|
|
<param index="8" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="9" name="brk_flags" type="int" enum="TextServer.LineBreakFlag" default="3" />
|
|
<param index="10" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" />
|
|
<param index="11" name="direction" type="int" enum="TextServer.Direction" default="0" />
|
|
<param index="12" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
|
|
<description>
|
|
Breaks [param text] to the lines and draws text outline using the specified [param font] at the [param pos] (top-left corner). The text will have its color multiplied by [param modulate]. If [param width] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
|
|
</description>
|
|
</method>
|
|
<method name="draw_multimesh">
|
|
<return type="void" />
|
|
<param index="0" name="multimesh" type="MultiMesh" />
|
|
<param index="1" name="texture" type="Texture2D" />
|
|
<description>
|
|
Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation.
|
|
</description>
|
|
</method>
|
|
<method name="draw_polygon">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="colors" type="PackedColorArray" />
|
|
<param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
|
|
<param index="3" name="texture" type="Texture2D" default="null" />
|
|
<description>
|
|
Draws a solid polygon of any number 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">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="color" type="Color" />
|
|
<param index="2" name="width" type="float" default="1.0" />
|
|
<param index="3" name="antialiased" type="bool" default="false" />
|
|
<description>
|
|
Draws interconnected line segments with a uniform [param color] and [param width] 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">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="colors" type="PackedColorArray" />
|
|
<param index="2" name="width" type="float" default="1.0" />
|
|
<param index="3" name="antialiased" type="bool" default="false" />
|
|
<description>
|
|
Draws interconnected line segments with a uniform [param width] and segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [param points] and [param colors]. 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">
|
|
<return type="void" />
|
|
<param index="0" name="points" type="PackedVector2Array" />
|
|
<param index="1" name="colors" type="PackedColorArray" />
|
|
<param index="2" name="uvs" type="PackedVector2Array" />
|
|
<param index="3" name="texture" type="Texture2D" default="null" />
|
|
<param index="4" name="width" type="float" default="1.0" />
|
|
<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. 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">
|
|
<return type="void" />
|
|
<param index="0" name="rect" type="Rect2" />
|
|
<param index="1" name="color" type="Color" />
|
|
<param index="2" name="filled" type="bool" default="true" />
|
|
<param index="3" name="width" type="float" default="1.0" />
|
|
<description>
|
|
Draws a rectangle. If [param filled] is [code]true[/code], the rectangle will be filled with the [param color] specified. If [param filled] is [code]false[/code], the rectangle will be drawn as a stroke with the [param color] and [param width] specified.
|
|
[b]Note:[/b] [param width] is only effective if [param filled] is [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="draw_set_transform">
|
|
<return type="void" />
|
|
<param index="0" name="position" type="Vector2" />
|
|
<param index="1" name="rotation" type="float" default="0.0" />
|
|
<param index="2" name="scale" type="Vector2" default="Vector2(1, 1)" />
|
|
<description>
|
|
Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
|
|
</description>
|
|
</method>
|
|
<method name="draw_set_transform_matrix">
|
|
<return type="void" />
|
|
<param index="0" name="xform" type="Transform2D" />
|
|
<description>
|
|
Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
|
|
</description>
|
|
</method>
|
|
<method name="draw_string" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="text" type="String" />
|
|
<param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" />
|
|
<param index="4" name="width" type="float" default="-1" />
|
|
<param index="5" name="font_size" type="int" default="16" />
|
|
<param index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="7" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" />
|
|
<param index="8" name="direction" type="int" enum="TextServer.Direction" default="0" />
|
|
<param index="9" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
|
|
<description>
|
|
Draws [param text] using the specified [param font] at the [param pos] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [param modulate]. If [param width] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
|
|
[b]Example using the default project font:[/b]
|
|
[codeblocks]
|
|
[gdscript]
|
|
# If using this method in a script that redraws constantly, move the
|
|
# `default_font` declaration to a member variable assigned in `_ready()`
|
|
# so the Control is only created once.
|
|
var default_font = Control.new().get_font("font")
|
|
var default_font_size = Control.new().get_font_size("font_size")
|
|
draw_string(default_font, Vector2(64, 64), "Hello world", HORIZONTAL_ALIGNMENT_LEFT, -1, font_size)
|
|
[/gdscript]
|
|
[csharp]
|
|
// If using this method in a script that redraws constantly, move the
|
|
// `default_font` declaration to a member variable assigned in `_ready()`
|
|
// so the Control is only created once.
|
|
Font defaultFont = new Control().GetFont("font");
|
|
int defaultFontSize = new Control().GetFontSize("font_size");
|
|
DrawString(defaultFont, new Vector2(64, 64), "Hello world", HORIZONTAL_ALIGNMENT_LEFT, -1, defaultFontSize);
|
|
[/csharp]
|
|
[/codeblocks]
|
|
See also [method Font.draw_string].
|
|
</description>
|
|
</method>
|
|
<method name="draw_string_outline" qualifiers="const">
|
|
<return type="void" />
|
|
<param index="0" name="font" type="Font" />
|
|
<param index="1" name="pos" type="Vector2" />
|
|
<param index="2" name="text" type="String" />
|
|
<param index="3" name="alignment" type="int" enum="HorizontalAlignment" default="0" />
|
|
<param index="4" name="width" type="float" default="-1" />
|
|
<param index="5" name="font_size" type="int" default="16" />
|
|
<param index="6" name="size" type="int" default="1" />
|
|
<param index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="8" name="jst_flags" type="int" enum="TextServer.JustificationFlag" default="3" />
|
|
<param index="9" name="direction" type="int" enum="TextServer.Direction" default="0" />
|
|
<param index="10" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
|
|
<description>
|
|
Draws [param text] outline using the specified [param font] at the [param pos] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [param modulate]. If [param width] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
|
|
</description>
|
|
</method>
|
|
<method name="draw_style_box">
|
|
<return type="void" />
|
|
<param index="0" name="style_box" type="StyleBox" />
|
|
<param index="1" name="rect" type="Rect2" />
|
|
<description>
|
|
Draws a styled rectangle.
|
|
</description>
|
|
</method>
|
|
<method name="draw_texture">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="position" type="Vector2" />
|
|
<param index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<description>
|
|
Draws a texture at a given position.
|
|
</description>
|
|
</method>
|
|
<method name="draw_texture_rect">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="rect" type="Rect2" />
|
|
<param index="2" name="tile" type="bool" />
|
|
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="4" name="transpose" type="bool" default="false" />
|
|
<description>
|
|
Draws a textured rectangle at a given position, optionally modulated by a color. If [param transpose] is [code]true[/code], the texture will have its X and Y coordinates swapped.
|
|
</description>
|
|
</method>
|
|
<method name="draw_texture_rect_region">
|
|
<return type="void" />
|
|
<param index="0" name="texture" type="Texture2D" />
|
|
<param index="1" name="rect" type="Rect2" />
|
|
<param index="2" name="src_rect" type="Rect2" />
|
|
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
|
<param index="4" name="transpose" type="bool" default="false" />
|
|
<param index="5" name="clip_uv" type="bool" default="true" />
|
|
<description>
|
|
Draws a textured rectangle region at a given position, optionally modulated by a color. If [param transpose] is [code]true[/code], the texture will have its X and Y coordinates swapped.
|
|
</description>
|
|
</method>
|
|
<method name="force_update_transform">
|
|
<return type="void" />
|
|
<description>
|
|
Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.
|
|
</description>
|
|
</method>
|
|
<method name="get_canvas" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the [RID] of the [World2D] canvas where this item is in.
|
|
</description>
|
|
</method>
|
|
<method name="get_canvas_item" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the canvas item RID used by [RenderingServer] for this item.
|
|
</description>
|
|
</method>
|
|
<method name="get_canvas_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns the transform matrix of this item's canvas.
|
|
</description>
|
|
</method>
|
|
<method name="get_global_mouse_position" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the mouse's position in the [CanvasLayer] that this [CanvasItem] is in using the coordinate system of the [CanvasLayer].
|
|
</description>
|
|
</method>
|
|
<method name="get_global_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns the global transform matrix of this item.
|
|
</description>
|
|
</method>
|
|
<method name="get_global_transform_with_canvas" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns the global transform matrix of this item in relation to the canvas.
|
|
</description>
|
|
</method>
|
|
<method name="get_local_mouse_position" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the mouse's position in this [CanvasItem] using the local coordinate system of this [CanvasItem].
|
|
</description>
|
|
</method>
|
|
<method name="get_screen_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns the transform of this [CanvasItem] in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins.
|
|
Equals to [method get_global_transform] if the window is embedded (see [member Viewport.gui_embed_subwindows]).
|
|
</description>
|
|
</method>
|
|
<method name="get_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns the transform matrix of this item.
|
|
</description>
|
|
</method>
|
|
<method name="get_viewport_rect" qualifiers="const">
|
|
<return type="Rect2" />
|
|
<description>
|
|
Returns the viewport's boundaries as a [Rect2].
|
|
</description>
|
|
</method>
|
|
<method name="get_viewport_transform" qualifiers="const">
|
|
<return type="Transform2D" />
|
|
<description>
|
|
Returns this item's transform in relation to the viewport.
|
|
</description>
|
|
</method>
|
|
<method name="get_world_2d" qualifiers="const">
|
|
<return type="World2D" />
|
|
<description>
|
|
Returns the [World2D] where this item is in.
|
|
</description>
|
|
</method>
|
|
<method name="hide">
|
|
<return type="void" />
|
|
<description>
|
|
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">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if local transform notifications are communicated to children.
|
|
</description>
|
|
</method>
|
|
<method name="is_transform_notification_enabled" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if global transform notifications are communicated to children.
|
|
</description>
|
|
</method>
|
|
<method name="is_visible_in_tree" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree, and is consequently not drawn (see [method _draw]).
|
|
</description>
|
|
</method>
|
|
<method name="make_canvas_position_local" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="screen_point" type="Vector2" />
|
|
<description>
|
|
Assigns [param screen_point] as this node's new local transform.
|
|
</description>
|
|
</method>
|
|
<method name="make_input_local" qualifiers="const">
|
|
<return type="InputEvent" />
|
|
<param index="0" name="event" type="InputEvent" />
|
|
<description>
|
|
Transformations issued by [param event]'s inputs are applied in local space instead of global space.
|
|
</description>
|
|
</method>
|
|
<method name="queue_redraw">
|
|
<return type="void" />
|
|
<description>
|
|
Queues the [CanvasItem] to redraw. During idle time, if [CanvasItem] is visible, [constant NOTIFICATION_DRAW] is sent and [method _draw] is called. This only occurs [b]once[/b] per frame, even if this method has been called multiple times.
|
|
</description>
|
|
</method>
|
|
<method name="set_notify_local_transform">
|
|
<return type="void" />
|
|
<param index="0" name="enable" type="bool" />
|
|
<description>
|
|
If [param enable] is [code]true[/code], this node will receive [constant NOTIFICATION_LOCAL_TRANSFORM_CHANGED] when its local transform changes.
|
|
</description>
|
|
</method>
|
|
<method name="set_notify_transform">
|
|
<return type="void" />
|
|
<param index="0" name="enable" type="bool" />
|
|
<description>
|
|
If [param enable] is [code]true[/code], this node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] when its global transform changes.
|
|
</description>
|
|
</method>
|
|
<method name="show">
|
|
<return type="void" />
|
|
<description>
|
|
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>
|
|
</methods>
|
|
<members>
|
|
<member name="clip_children" type="bool" setter="set_clip_children" getter="is_clipping_children" default="false">
|
|
</member>
|
|
<member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask" default="1">
|
|
The rendering layers in which this [CanvasItem] responds to [Light2D] nodes.
|
|
</member>
|
|
<member name="material" type="Material" setter="set_material" getter="get_material">
|
|
The material applied to textures on this [CanvasItem].
|
|
</member>
|
|
<member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)">
|
|
The color applied to textures on this [CanvasItem].
|
|
</member>
|
|
<member name="self_modulate" type="Color" setter="set_self_modulate" getter="get_self_modulate" default="Color(1, 1, 1, 1)">
|
|
The color applied to textures on this [CanvasItem]. This is not inherited by children [CanvasItem]s.
|
|
</member>
|
|
<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false">
|
|
If [code]true[/code], the object draws behind its parent.
|
|
</member>
|
|
<member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="CanvasItem.TextureFilter" default="0">
|
|
The texture filtering mode to use on this [CanvasItem].
|
|
</member>
|
|
<member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0">
|
|
The texture repeating mode to use on this [CanvasItem].
|
|
</member>
|
|
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
|
|
If [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that do not have [member top_level] set to [code]true[/code]. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node].
|
|
</member>
|
|
<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false">
|
|
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
|
|
</member>
|
|
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
|
|
If [code]true[/code], this [CanvasItem] is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).
|
|
[b]Note:[/b] 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>
|
|
<signal name="draw">
|
|
<description>
|
|
Emitted when the [CanvasItem] must redraw, [i]after[/i] the related [constant NOTIFICATION_DRAW] notification, and [i]before[/i] [method _draw] is called.
|
|
[b]Note:[/b] Deferred connections do not allow drawing through the [code]draw_*[/code] methods.
|
|
</description>
|
|
</signal>
|
|
<signal name="hidden">
|
|
<description>
|
|
Emitted when becoming hidden.
|
|
</description>
|
|
</signal>
|
|
<signal name="item_rect_changed">
|
|
<description>
|
|
Emitted when the item's [Rect2] boundaries (position or size) have changed, or when an action is taking place that may have impacted these boundaries (e.g. changing [member Sprite2D.texture]).
|
|
</description>
|
|
</signal>
|
|
<signal name="visibility_changed">
|
|
<description>
|
|
Emitted when the visibility (hidden/visible) changes.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000">
|
|
The [CanvasItem]'s global transform has changed. This notification is only received if enabled by [method set_notify_transform].
|
|
</constant>
|
|
<constant name="NOTIFICATION_LOCAL_TRANSFORM_CHANGED" value="35">
|
|
The [CanvasItem]'s local transform has changed. This notification is only received if enabled by [method set_notify_local_transform].
|
|
</constant>
|
|
<constant name="NOTIFICATION_DRAW" value="30">
|
|
The [CanvasItem] is requested to draw (see [method _draw]).
|
|
</constant>
|
|
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31">
|
|
The [CanvasItem]'s visibility has changed.
|
|
</constant>
|
|
<constant name="NOTIFICATION_ENTER_CANVAS" value="32">
|
|
The [CanvasItem] has entered the canvas.
|
|
</constant>
|
|
<constant name="NOTIFICATION_EXIT_CANVAS" value="33">
|
|
The [CanvasItem] has exited the canvas.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_PARENT_NODE" value="0" enum="TextureFilter">
|
|
The [CanvasItem] will inherit the filter from its parent.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_NEAREST" value="1" enum="TextureFilter">
|
|
The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering. Useful for pixel art.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_LINEAR" value="2" enum="TextureFilter">
|
|
The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS" value="3" enum="TextureFilter">
|
|
The texture filter reads from the nearest pixel in the nearest mipmap. This is the fastest way to read from textures with mipmaps.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="4" enum="TextureFilter">
|
|
The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to [Camera2D] zoom), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="TextureFilter">
|
|
The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. The anisotropic filtering level can be changed by adjusting [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
|
|
[b]Note:[/b] This texture filter is rarely useful in 2D projects. [constant TEXTURE_FILTER_NEAREST_WITH_MIPMAPS] is usually more appropriate.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC" value="6" enum="TextureFilter">
|
|
The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. The anisotropic filtering level can be changed by adjusting [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
|
|
[b]Note:[/b] This texture filter is rarely useful in 2D projects. [constant TEXTURE_FILTER_LINEAR_WITH_MIPMAPS] is usually more appropriate.
|
|
</constant>
|
|
<constant name="TEXTURE_FILTER_MAX" value="7" enum="TextureFilter">
|
|
Represents the size of the [enum TextureFilter] enum.
|
|
</constant>
|
|
<constant name="TEXTURE_REPEAT_PARENT_NODE" value="0" enum="TextureRepeat">
|
|
The [CanvasItem] will inherit the filter from its parent.
|
|
</constant>
|
|
<constant name="TEXTURE_REPEAT_DISABLED" value="1" enum="TextureRepeat">
|
|
Texture will not repeat.
|
|
</constant>
|
|
<constant name="TEXTURE_REPEAT_ENABLED" value="2" enum="TextureRepeat">
|
|
Texture will repeat normally.
|
|
</constant>
|
|
<constant name="TEXTURE_REPEAT_MIRROR" value="3" enum="TextureRepeat">
|
|
Texture will repeat in a 2x2 tiled mode, where elements at even positions are mirrored.
|
|
</constant>
|
|
<constant name="TEXTURE_REPEAT_MAX" value="4" enum="TextureRepeat">
|
|
Represents the size of the [enum TextureRepeat] enum.
|
|
</constant>
|
|
</constants>
|
|
</class>
|