CanvasLayer

Inherits: Node < Object

Inherited By: ParallaxBackground

Canvas drawing layer.

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).

Tutorials

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 )

bool

visible

true

Methods

RID

get_canvas ( ) const

void

hide ( )

void

show ( )

Signals

  • visibility_changed ( )

Emitted when visibility of the layer is changed. See visible.

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()

Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.


  • float follow_viewport_scale

Default

1.0

Setter

set_follow_viewport_scale(value)

Getter

get_follow_viewport_scale()

Scales the layer when using follow_viewport_enable. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.


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.


Default

true

Setter

set_visible(value)

Getter

is_visible()

If false, any CanvasItem under this CanvasLayer will be hidden.

Unlike CanvasItem.visible, visibility of a CanvasLayer isn't propagated to underlying layers.

Method Descriptions

  • RID get_canvas ( ) const

Returns the RID of the canvas used by this layer.


  • void hide ( )

Hides any CanvasItem under this CanvasLayer. This is equivalent to setting visible to false.


  • void show ( )

Shows any CanvasItem under this CanvasLayer. This is equivalent to setting visible to true.