CanvasLayer

Inherits: Node < Object

Inherited By: ParallaxBackground

Category: Core

Brief Description

Canvas drawing layer.

Properties

Node custom_viewport  
bool follow_viewport_enable false
float follow_viewport_scale 1.0
int layer 1
Vector2 offset Vector2( 0, 0 )
float rotation 0.0
float rotation_degrees 0.0
Vector2 scale Vector2( 1, 1 )
Transform2D transform Transform2D( 1, 0, 0, 1, 0, 0 )

Methods

RID get_canvas ( ) const

Description

Canvas drawing layer. CanvasItem nodes that are direct or indirect children of a CanvasLayer will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a CanvasLayer with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).

Property Descriptions

  • Node custom_viewport
Setter set_custom_viewport(value)
Getter get_custom_viewport()

The custom Viewport node assigned to the CanvasLayer. If null, uses the default viewport instead.


  • bool follow_viewport_enable
Default false
Setter set_follow_viewport(value)
Getter is_following_viewport()

  • float follow_viewport_scale
Default 1.0
Setter set_follow_viewport_scale(value)
Getter get_follow_viewport_scale()

Default 1
Setter set_layer(value)
Getter get_layer()

Layer index for draw order. Lower values are drawn first.


Default Vector2( 0, 0 )
Setter set_offset(value)
Getter get_offset()

The layer’s base offset.


Default 0.0
Setter set_rotation(value)
Getter get_rotation()

The layer’s rotation in radians.


Default 0.0
Setter set_rotation_degrees(value)
Getter get_rotation_degrees()

The layer’s rotation in degrees.


Default Vector2( 1, 1 )
Setter set_scale(value)
Getter get_scale()

The layer’s scale.


Default Transform2D( 1, 0, 0, 1, 0, 0 )
Setter set_transform(value)
Getter get_transform()

The layer’s transform.

Method Descriptions

  • RID get_canvas ( ) const

Returns the RID of the canvas used by this layer.