CanvasItem

Inherits: Node < Object

Inherited By: Control, Node2D

There is currently no description for this class. Please help us by contributing one!

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, bool filled=true, float width=-1.0, bool antialiased=false )
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, bool antialiased=false )
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, bool antialiased=false )
void	draw_multiline_colors ( PackedVector2Array points, PackedColorArray colors, float width=-1.0, bool antialiased=false )
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, bool antialiased=false )
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
CanvasLayer	get_canvas_layer_node ( ) const
Transform2D	get_canvas_transform ( ) const
Vector2	get_global_mouse_position ( ) const
Transform2D	get_global_transform ( ) const
Transform2D	get_global_transform_with_canvas ( ) const
Vector2	get_local_mouse_position ( ) const
Transform2D	get_screen_transform ( ) const
Transform2D	get_transform ( ) const
Rect2	get_viewport_rect ( ) const
Transform2D	get_viewport_transform ( ) const
bool	get_visibility_layer_bit ( int layer ) const
World2D	get_world_2d ( ) const
void	hide ( )
bool	is_local_transform_notification_enabled ( ) const
bool	is_transform_notification_enabled ( ) const
bool	is_visible_in_tree ( ) const
Vector2	make_canvas_position_local ( Vector2 screen_point ) const
InputEvent	make_input_local ( InputEvent event ) const
void	move_to_front ( )
void	queue_redraw ( )
void	set_notify_local_transform ( bool enable )
void	set_notify_transform ( bool enable )
void	set_visibility_layer_bit ( int layer, bool enabled )
void	show ( )

Signals

draw ( )

There is currently no description for this signal. Please help us by contributing one!

hidden ( )

There is currently no description for this signal. Please help us by contributing one!

item_rect_changed ( )

There is currently no description for this signal. Please help us by contributing one!

visibility_changed ( )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum TextureFilter:

TextureFilter TEXTURE_FILTER_PARENT_NODE = 0

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_NEAREST = 1

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_LINEAR = 2

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_NEAREST_WITH_MIPMAPS = 3

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_LINEAR_WITH_MIPMAPS = 4

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC = 5

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC = 6

There is currently no description for this enum. Please help us by contributing one!

TextureFilter TEXTURE_FILTER_MAX = 7

There is currently no description for this enum. Please help us by contributing one!

enum TextureRepeat:

TextureRepeat TEXTURE_REPEAT_PARENT_NODE = 0

There is currently no description for this enum. Please help us by contributing one!

TextureRepeat TEXTURE_REPEAT_DISABLED = 1

There is currently no description for this enum. Please help us by contributing one!

TextureRepeat TEXTURE_REPEAT_ENABLED = 2

There is currently no description for this enum. Please help us by contributing one!

TextureRepeat TEXTURE_REPEAT_MIRROR = 3

There is currently no description for this enum. Please help us by contributing one!

TextureRepeat TEXTURE_REPEAT_MAX = 4

There is currently no description for this enum. Please help us by contributing one!

enum ClipChildrenMode:

ClipChildrenMode CLIP_CHILDREN_DISABLED = 0

There is currently no description for this enum. Please help us by contributing one!

ClipChildrenMode CLIP_CHILDREN_ONLY = 1

There is currently no description for this enum. Please help us by contributing one!

ClipChildrenMode CLIP_CHILDREN_AND_DRAW = 2

There is currently no description for this enum. Please help us by contributing one!

ClipChildrenMode CLIP_CHILDREN_MAX = 3

There is currently no description for this enum. Please help us by contributing one!

Constants

NOTIFICATION_TRANSFORM_CHANGED = 2000

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_LOCAL_TRANSFORM_CHANGED = 35

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_DRAW = 30

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_VISIBILITY_CHANGED = 31

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_ENTER_CANVAS = 32

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_EXIT_CANVAS = 33

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_WORLD_2D_CHANGED = 36

There is currently no description for this constant. Please help us by contributing one!

Property Descriptions

ClipChildrenMode clip_children = 0

void set_clip_children_mode ( ClipChildrenMode value )
ClipChildrenMode get_clip_children_mode ( )

There is currently no description for this property. Please help us by contributing one!

int light_mask = 1

void set_light_mask ( int value )
int get_light_mask ( )

There is currently no description for this property. Please help us by contributing one!

Material material

void set_material ( Material value )
Material get_material ( )

There is currently no description for this property. Please help us by contributing one!

Color modulate = Color(1, 1, 1, 1)

void set_modulate ( Color value )
Color get_modulate ( )

There is currently no description for this property. Please help us by contributing one!

Color self_modulate = Color(1, 1, 1, 1)

void set_self_modulate ( Color value )
Color get_self_modulate ( )

There is currently no description for this property. Please help us by contributing one!

bool show_behind_parent = false

void set_draw_behind_parent ( bool value )
bool is_draw_behind_parent_enabled ( )

There is currently no description for this property. Please help us by contributing one!

TextureFilter texture_filter = 0

void set_texture_filter ( TextureFilter value )
TextureFilter get_texture_filter ( )

There is currently no description for this property. Please help us by contributing one!

TextureRepeat texture_repeat = 0

void set_texture_repeat ( TextureRepeat value )
TextureRepeat get_texture_repeat ( )

There is currently no description for this property. Please help us by contributing one!

bool top_level = false

void set_as_top_level ( bool value )
bool is_set_as_top_level ( )

There is currently no description for this property. Please help us by contributing one!

bool use_parent_material = false

void set_use_parent_material ( bool value )
bool get_use_parent_material ( )

There is currently no description for this property. Please help us by contributing one!

int visibility_layer = 1

void set_visibility_layer ( int value )
int get_visibility_layer ( )

There is currently no description for this property. Please help us by contributing one!

bool visible = true

void set_visible ( bool value )
bool is_visible ( )

There is currently no description for this property. Please help us by contributing one!

bool y_sort_enabled = false

void set_y_sort_enabled ( bool value )
bool is_y_sort_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool z_as_relative = true

void set_z_as_relative ( bool value )
bool is_z_relative ( )

There is currently no description for this property. Please help us by contributing one!

int z_index = 0

void set_z_index ( int value )
int get_z_index ( )

There is currently no description for this property. Please help us by contributing one!