2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "CanvasLayer" inherits= "Node" category= "Core" version= "3.0.alpha.custom_build" >
<brief_description >
2017-09-17 04:14:03 +02:00
Canvas drawing layer.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-10-22 12:56:11 +02:00
Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [code]CanvasLayer[/code] 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 [code]CanvasLayer[/code] 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).
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_custom_viewport" qualifiers= "const" >
<return type= "Node" >
</return>
<description >
</description>
</method>
<method name= "get_layer" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the layer index, determines the draw order, a lower value will be below a higher one.
</description>
</method>
<method name= "get_offset" qualifiers= "const" >
<return type= "Vector2" >
</return>
<description >
Return the base offset for this layer (helper).
</description>
</method>
<method name= "get_rotation" qualifiers= "const" >
<return type= "float" >
</return>
<description >
Return the base rotation for this layer in radians (helper).
</description>
</method>
2017-11-10 11:07:52 +01:00
<method name= "get_rotation_degrees" qualifiers= "const" >
2017-09-12 22:42:36 +02:00
<return type= "float" >
</return>
<description >
Return the base rotation for this layer in degrees.
</description>
</method>
<method name= "get_scale" qualifiers= "const" >
<return type= "Vector2" >
</return>
<description >
Return the base scale for this layer (helper).
</description>
</method>
<method name= "get_transform" qualifiers= "const" >
<return type= "Transform2D" >
</return>
<description >
Return the base transform for this layer.
</description>
</method>
<method name= "get_world_2d" qualifiers= "const" >
<return type= "World2D" >
</return>
<description >
Return the [World2D] used by this layer.
</description>
</method>
<method name= "set_custom_viewport" >
<return type= "void" >
</return>
<argument index= "0" name= "viewport" type= "Node" >
</argument>
<description >
</description>
</method>
<method name= "set_layer" >
<return type= "void" >
</return>
<argument index= "0" name= "layer" type= "int" >
</argument>
<description >
Set the layer index, determines the draw order, a lower value will be below a higher one.
</description>
</method>
<method name= "set_offset" >
<return type= "void" >
</return>
<argument index= "0" name= "offset" type= "Vector2" >
</argument>
<description >
Set the base offset for this layer (helper).
</description>
</method>
<method name= "set_rotation" >
<return type= "void" >
</return>
<argument index= "0" name= "radians" type= "float" >
</argument>
<description >
Set the base rotation for this layer in radians (helper).
</description>
</method>
2017-11-10 11:07:52 +01:00
<method name= "set_rotation_degrees" >
2017-09-12 22:42:36 +02:00
<return type= "void" >
</return>
<argument index= "0" name= "degrees" type= "float" >
</argument>
<description >
Set the base rotation for this layer in degrees (helper).
</description>
</method>
<method name= "set_scale" >
<return type= "void" >
</return>
<argument index= "0" name= "scale" type= "Vector2" >
</argument>
<description >
Set the base scale for this layer (helper).
</description>
</method>
<method name= "set_transform" >
<return type= "void" >
</return>
<argument index= "0" name= "transform" type= "Transform2D" >
</argument>
<description >
Set the base transform for this layer.
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "layer" type= "int" setter= "set_layer" getter= "get_layer" >
2017-09-17 04:14:03 +02:00
Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "offset" type= "Vector2" setter= "set_offset" getter= "get_offset" >
2017-09-17 04:14:03 +02:00
The layer's base offset.
2017-09-12 22:42:36 +02:00
</member>
2017-11-10 11:07:52 +01:00
<member name= "rotation" type= "float" setter= "set_rotation_degrees" getter= "get_rotation_degrees" >
2017-09-17 04:14:03 +02:00
The layer's rotation in degrees.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "scale" type= "Vector2" setter= "set_scale" getter= "get_scale" >
2017-09-17 04:14:03 +02:00
The layer's scale.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>