CanvasLayer¶
Inherited By: ParallaxBackground
Category: Core
Brief Description¶
Canvas drawing layer.
Properties¶
| Node | custom_viewport |
| int | layer |
| Vector2 | offset |
| float | rotation |
| float | rotation_degrees |
| Vector2 | scale |
| Transform2D | transform |
Methods¶
| RID | get_canvas ( ) const |
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¶
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.
- int layer
| Setter | set_layer(value) |
| Getter | get_layer() |
Layer index for draw order. Lower values are drawn first. Default value: 1.
- Vector2 offset
| Setter | set_offset(value) |
| Getter | get_offset() |
The layer’s base offset.
- float rotation
| Setter | set_rotation(value) |
| Getter | get_rotation() |
The layer’s rotation in radians.
- float rotation_degrees
| Setter | set_rotation_degrees(value) |
| Getter | get_rotation_degrees() |
The layer’s rotation in degrees.
- Vector2 scale
| Setter | set_scale(value) |
| Getter | get_scale() |
The layer’s scale.
- Transform2D transform
| Setter | set_transform(value) |
| Getter | get_transform() |
The layer’s transform.