2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-19 09:46:33 +00:00
<class name= "CanvasLayer" inherits= "Node" category= "Core" version= "3.1-dev" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-09-17 02:14:03 +00:00
Canvas drawing layer.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-10-22 10:56:11 +00: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 20:42:36 +00:00
</description>
<tutorials >
2018-01-25 08:03:59 +00:00
http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html
http://docs.godotengine.org/en/3.0/tutorials/2d/canvas_layers.html
2017-09-12 20:42:36 +00:00
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_world_2d" qualifiers= "const" >
<return type= "World2D" >
</return>
<description >
Return the [World2D] used by this layer.
</description>
</method>
</methods>
<members >
2018-01-11 22:38:35 +00:00
<member name= "custom_viewport" type= "Node" setter= "set_custom_viewport" getter= "get_custom_viewport" >
The custom [Viewport] node assigned to the [code]CanvasLayer[/code]. If null, uses the default viewport instead.
</member>
2017-09-13 06:49:40 +00:00
<member name= "layer" type= "int" setter= "set_layer" getter= "get_layer" >
2017-09-17 02:14:03 +00:00
Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "offset" type= "Vector2" setter= "set_offset" getter= "get_offset" >
2017-09-17 02:14:03 +00:00
The layer's base offset.
2017-09-12 20:42:36 +00:00
</member>
2018-01-11 22:38:35 +00:00
<member name= "rotation" type= "float" setter= "set_rotation" getter= "get_rotation" >
The layer's rotation in radians.
</member>
<member name= "rotation_degrees" type= "float" setter= "set_rotation_degrees" getter= "get_rotation_degrees" >
2017-09-17 02:14:03 +00:00
The layer's rotation in degrees.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "scale" type= "Vector2" setter= "set_scale" getter= "get_scale" >
2017-09-17 02:14:03 +00:00
The layer's scale.
2017-09-12 20:42:36 +00:00
</member>
2018-01-11 22:38:35 +00:00
<member name= "transform" type= "Transform2D" setter= "set_transform" getter= "get_transform" >
The layer's transform.
</member>
2017-09-12 20:42:36 +00:00
</members>
<constants >
</constants>
</class>
