CanvasLayer

    Inherited By: ParallaxBackground

    Canvas drawing layer.

    Canvas drawing layer. CanvasItem nodes that are direct or indirect children of a 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

    Methods

    RID

    ( ) const

    hide ( )

    void

    ( )

    • visibility_changed ( )

    Emitted when visibility of the layer is changed. See .

    Property Descriptions

    • 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.

    • follow_viewport_enable

    Default

    false

    Setter

    set_follow_viewport(value)

    Getter

    is_following_viewport()

    Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.

    • float follow_viewport_scale

    Scales the layer when using . Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.

    Default

    1

    Setter

    set_layer(value)

    Getter

    get_layer()

    Layer index for draw order. Lower values are drawn first.

    Default

    Vector2( 0, 0 )

    Setter

    set_offset(value)

    Getter

    get_offset()

    The layer’s base offset.

    • rotation

    0.0

    Setter

    set_rotation(value)

    Getter

    get_rotation()

    The layer’s rotation in radians.

    The layer’s rotation in degrees.

    • scale

    Default

    Vector2( 1, 1 )

    Setter

    set_scale(value)

    Getter

    get_scale()

    The layer’s scale.

    Default

    Transform2D( 1, 0, 0, 1, 0, 0 )

    Setter

    set_transform(value)

    Getter

    get_transform()

    The layer’s transform.

    • visible

    Default

    true

    Setter

    set_visible(value)

    Getter

    is_visible()

    If false, any CanvasItem under this CanvasLayer will be hidden.

    Unlike , visibility of a CanvasLayer isn’t propagated to underlying layers.

    • get_canvas ( ) const

    Returns the RID of the canvas used by this layer.

    • void hide ( )

    Hides any CanvasItem under this CanvasLayer. This is equivalent to setting to false.