Struct CanvasLayer
Canvas drawing layer.
struct CanvasLayer
;
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).
Properties
| Name | Type | Description |
|---|---|---|
customViewport[get, set]
|
Node | The custom Viewport node assigned to the CanvasLayer. If null, uses the default viewport instead.
|
followViewportEnable[get, set]
|
bool | Sets the layer to follow the viewport in order to simulate a pseudo 3D effect. |
followViewportScale[get, set]
|
double | Scales the layer when using followViewportEnable. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
|
layer[get, set]
|
long | Layer index for draw order. Lower values are drawn first. |
offset[get, set]
|
Vector2 | The layer's base offset. |
rotation[get, set]
|
double | The layer's rotation in radians. |
rotationDegrees[get, set]
|
double | The layer's rotation in degrees. |
scale[get, set]
|
Vector2 | The layer's scale. |
transform[get, set]
|
Transform2D | The layer's transform. |
Methods
| Name | Description |
|---|---|
getCanvas
|
Returns the RID of the canvas used by this layer. |
getCustomViewport
|
|
getFollowViewportScale
|
|
getLayer
|
|
getOffset
|
|
getRotation
|
|
getRotationDegrees
|
|
getScale
|
|
getTransform
|
|
isFollowingViewport
|
|
setCustomViewport
|
|
setFollowViewport
|
|
setFollowViewportScale
|
|
setLayer
|
|
setOffset
|
|
setRotation
|
|
setRotationDegrees
|
|
setScale
|
|
setTransform
|