Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

CanvasItem

Inherits: Node < Object

Inherited By: Control, Node2D

Abstract base class for everything in 2D space.

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, queue_redraw is called by the engine, then 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 draw_* functions). However, they can only be used inside _draw, its corresponding Object._notification or methods connected to the 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 be hidden, which will also hide its children. By adjusting various other properties of a CanvasItem, you can also modulate its color (via modulate or self_modulate), change its Z-index, blend mode, and more.

Tutorials

• Viewport and canvas transforms

• Custom drawing in 2D

• Audio Spectrum Demo

Properties

ClipChildrenMode	clip_children	0
int	light_mask	1
Material	material
Color	modulate	Color(1, 1, 1, 1)
Color	self_modulate	Color(1, 1, 1, 1)
bool	show_behind_parent	false
TextureFilter	texture_filter	0
TextureRepeat	texture_repeat	0
bool	top_level	false
bool	use_parent_material	false
int	visibility_layer	1
bool	visible	true
bool	y_sort_enabled	false
bool	z_as_relative	true
int	z_index	0

Methods

void	_draw ( ) virtual
void	draw_animation_slice ( float animation_length, float slice_begin, float slice_end, float offset=0.0 )
void	draw_arc ( Vector2 center, float radius, float start_angle, float end_angle, int point_count, Color color, float width=-1.0, bool antialiased=false )
void	draw_char ( Font font, Vector2 pos, String char, int font_size=16, Color modulate=Color(1, 1, 1, 1) ) const
void	draw_char_outline ( Font font, Vector2 pos, String char, int font_size=16, int size=-1, Color modulate=Color(1, 1, 1, 1) ) const
void	draw_circle ( Vector2 position, float radius, Color color )
void	draw_colored_polygon ( PackedVector2Array points, Color color, PackedVector2Array uvs=PackedVector2Array(), Texture2D texture=null )
void	draw_dashed_line ( Vector2 from, Vector2 to, Color color, float width=-1.0, float dash=2.0, bool aligned=true )
void	draw_end_animation ( )
void	draw_lcd_texture_rect_region ( Texture2D texture, Rect2 rect, Rect2 src_rect, Color modulate=Color(1, 1, 1, 1) )
void	draw_line ( Vector2 from, Vector2 to, Color color, float width=-1.0, bool antialiased=false )
void	draw_mesh ( Mesh mesh, Texture2D texture, Transform2D transform=Transform2D(1, 0, 0, 1, 0, 0), Color modulate=Color(1, 1, 1, 1) )
void	draw_msdf_texture_rect_region ( Texture2D texture, Rect2 rect, Rect2 src_rect, Color modulate=Color(1, 1, 1, 1), float outline=0.0, float pixel_range=4.0, float scale=1.0 )
void	draw_multiline ( PackedVector2Array points, Color color, float width=-1.0 )
void	draw_multiline_colors ( PackedVector2Array points, PackedColorArray colors, float width=-1.0 )
void	draw_multiline_string ( Font font, Vector2 pos, String text, HorizontalAlignment alignment=0, float width=-1, int font_size=16, int max_lines=-1, Color modulate=Color(1, 1, 1, 1), BitField<LineBreakFlag> brk_flags=3, BitField<JustificationFlag> justification_flags=3, Direction direction=0, Orientation orientation=0 ) const
void	draw_multiline_string_outline ( Font font, Vector2 pos, String text, HorizontalAlignment alignment=0, float width=-1, int font_size=16, int max_lines=-1, int size=1, Color modulate=Color(1, 1, 1, 1), BitField<LineBreakFlag> brk_flags=3, BitField<JustificationFlag> justification_flags=3, Direction direction=0, Orientation orientation=0 ) const
void	draw_multimesh ( MultiMesh multimesh, Texture2D texture )
void	draw_polygon ( PackedVector2Array points, PackedColorArray colors, PackedVector2Array uvs=PackedVector2Array(), Texture2D texture=null )
void	draw_polyline ( PackedVector2Array points, Color color, float width=-1.0, bool antialiased=false )
void	draw_polyline_colors ( PackedVector2Array points, PackedColorArray colors, float width=-1.0, bool antialiased=false )
void	draw_primitive ( PackedVector2Array points, PackedColorArray colors, PackedVector2Array uvs, Texture2D texture=null )
void	draw_rect ( Rect2 rect, Color color, bool filled=true, float width=-1.0 )
void	draw_set_transform ( Vector2 position, float rotation=0.0, Vector2 scale=Vector2(1, 1) )
void	draw_set_transform_matrix ( Transform2D xform )
void	draw_string ( Font font, Vector2 pos, String text, HorizontalAlignment alignment=0, float width=-1, int font_size=16, Color modulate=Color(1, 1, 1, 1), BitField<JustificationFlag> justification_flags=3, Direction direction=0, Orientation orientation=0 ) const
void	draw_string_outline ( Font font, Vector2 pos, String text, HorizontalAlignment alignment=0, float width=-1, int font_size=16, int size=1, Color modulate=Color(1, 1, 1, 1), BitField<JustificationFlag> justification_flags=3, Direction direction=0, Orientation orientation=0 ) const
void	draw_style_box ( StyleBox style_box, Rect2 rect )
void	draw_texture ( Texture2D texture, Vector2 position, Color modulate=Color(1, 1, 1, 1) )
void	draw_texture_rect ( Texture2D texture, Rect2 rect, bool tile, Color modulate=Color(1, 1, 1, 1), bool transpose=false )
void	draw_texture_rect_region ( Texture2D texture, Rect2 rect, Rect2 src_rect, Color modulate=Color(1, 1, 1, 1), bool transpose=false, bool clip_uv=true )
void	force_update_transform ( )
RID	get_canvas ( ) const
RID	get_canvas_item ( ) const
Transform2D	get_canvas_transform ( ) const
Vector2	get_global_mouse_position ( ) const
Transform2D	get_global_transform ( )