CanvasLayer¶
Inherited By: ParallaxBackground
Category: Core
Brief Description¶
Canvas Item layer.
Member Functions¶
| Viewport | get_custom_viewport ( ) const |
| int | get_layer ( ) const |
| Vector2 | get_offset ( ) const |
| float | get_rotation ( ) const |
| float | get_rotationd ( ) const |
| Vector2 | get_scale ( ) const |
| Matrix32 | get_transform ( ) const |
| World2D | get_world_2d ( ) const |
| void | set_custom_viewport ( Viewport viewport ) |
| void | set_layer ( int layer ) |
| void | set_offset ( Vector2 offset ) |
| void | set_rotation ( float radians ) |
| void | set_rotationd ( float degrees ) |
| void | set_scale ( Vector2 scale ) |
| void | set_transform ( Matrix32 transform ) |
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¶
- Viewport get_custom_viewport ( ) const
Return the viewport RID for this layer.
- int get_layer ( ) const
Return the layer index, determines the draw order, a lower value will be below a higher one.
- Vector2 get_offset ( ) const
Return the base offset for this layer (helper).
- float get_rotation ( ) const
Return the base rotation for this layer in radians (helper).
- float get_rotationd ( ) const
Return the base rotation for this layer in degrees.
- Vector2 get_scale ( ) const
Return the base scale for this layer (helper).
- Transform2D get_transform ( ) const
Return the base transform for this layer.
- World2D get_world_2d ( ) const
Return the World2D used by this layer.
- void set_custom_viewport ( Viewport viewport )
- void set_layer ( int layer )
Set the layer index, determines the draw order, a lower value will be below a higher one.
- void set_offset ( Vector2 offset )
Set the base offset for this layer (helper).
- void set_rotation ( float radians )
Set the base rotation for this layer in radians (helper).
- void set_rotationd ( float degrees )
Set the base rotation for this layer in degrees (helper).
- void set_scale ( Vector2 scale )
Set the base scale for this layer (helper).
- void set_transform ( Transform2D transform )
Set the base transform for this layer.