Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.59 KB

class_canvaslayer.md

File metadata and controls

85 lines (57 loc) · 3.59 KB

CanvasLayer

####Inherits: Node ####Category: Core

Brief Description

Canvas Item layer.

Member Functions

Description

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

Member Function Description

  • void set_layer ( int layer )

Set the layer index, determines the draw order, a lower value will be below a higher one.

  • int get_layer ( ) const

Return the layer index, determines the draw order, a lower value will be below a higher one.

  • void set_transform ( Matrix32 transform )

Set the base transform for this layer.

Return the base transform for this layer.

  • void set_offset ( Vector2 offset )

Set the base offset for this layer (helper).

Return the base offset for this layer (helper).

  • void set_rotation ( real rotation )

Set the base rotation for this layer (helper).

  • real get_rotation ( ) const

Return the base rotation for this layer (helper).

Set the base scale for this layer (helper).

Return the base scale for this layer (helper).

  • Canvas get_world_2d ( ) const

Return the World2D used by this layer.

  • RID get_viewport ( ) const

Return the viewport RID for this layer.