CanvasLayer

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

Brief Description

Canvas Item layer.

Member Functions

• void set_layer ( int layer )
• int get_layer ( ) const
• void set_transform ( Matrix32 transform )
• Matrix32 get_transform ( ) const
• void set_offset ( Vector2 offset )
• Vector2 get_offset ( ) const
• void set_rotation ( float rotation )
• float get_rotation ( ) const
• void set_scale ( Vector2 scale )
• Vector2 get_scale ( ) const
• Canvas get_world_2d ( ) const
• RID get_viewport ( ) const

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

set_layer

• void set_layer ( int layer )

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

get_layer

• int get_layer ( ) const

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

set_transform

• void set_transform ( Matrix32 transform )

Set the base transform for this layer.

get_transform

• Matrix32 get_transform ( ) const

Return the base transform for this layer.

set_offset

• void set_offset ( Vector2 offset )

Set the base offset for this layer (helper).

get_offset

• Vector2 get_offset ( ) const

Return the base offset for this layer (helper).

set_rotation

• void set_rotation ( float rotation )

Set the base rotation for this layer (helper).

get_rotation

• float get_rotation ( ) const

Return the base rotation for this layer (helper).

set_scale

• void set_scale ( Vector2 scale )

Set the base scale for this layer (helper).

get_scale

• Vector2 get_scale ( ) const

Return the base scale for this layer (helper).

get_world_2d

• Canvas get_world_2d ( ) const

Return the World2D used by this layer.

get_viewport

• RID get_viewport ( ) const

Return the viewport RID for this layer.