Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
Inherited By: ParallaxBackground
Canvas drawing layer.
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).
Embedded Windows are placed in layer 1024. CanvasItems in layer 1025 or above appear in front of embedded windows, CanvasItems in layer 1023 or below appear behind embedded windows.
get_canvas ( ) const
get_final_transform ( ) const
hide ( )
show ( )
visibility_changed ( )
Emitted when visibility of the layer is changed. See visible.
The custom Viewport node assigned to the CanvasLayer. If
null, uses the default viewport instead.
bool follow_viewport_enabled =
If enabled, the CanvasLayer will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen.
Together with follow_viewport_scale it can be used for a pseudo 3D effect.
float follow_viewport_scale =
Scales the layer when using follow_viewport_enabled. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
int layer =
Layer index for draw order. Lower values are drawn behind higher values.
Vector2 offset =
The layer's base offset.
float rotation =
The layer's rotation in radians.
Vector2 scale =
The layer's scale.
Transform2D transform =
Transform2D(1, 0, 0, 1, 0, 0)
void set_transform ( Transform2D value )
Transform2D get_transform ( )
The layer's transform.
bool visible =
false, any CanvasItem under this CanvasLayer will be hidden.
Unlike CanvasItem.visible, visibility of a CanvasLayer isn't propagated to underlying layers.
RID get_canvas ( ) const
Returns the RID of the canvas used by this layer.
Transform2D get_final_transform ( ) const
Returns the transform from the CanvasLayers coordinate system to the Viewports coordinate system.
void hide ( )
Hides any CanvasItem under this CanvasLayer. This is equivalent to setting visible to
void show ( )
Shows any CanvasItem under this CanvasLayer. This is equivalent to setting visible to