virtualx-engine/doc/classes/CanvasLayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasLayer" inherits="Node" category="Core" version="3.2">
	<brief_description>
		Canvas drawing layer.
	</brief_description>
	<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).
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link>
		<link>https://docs.godotengine.org/en/latest/tutorials/2d/canvas_layers.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_canvas" qualifiers="const">
			<return type="RID">
			</return>
			<description>
				Returns the RID of the canvas used by this layer.
			</description>
		</method>
	</methods>
	<members>
		<member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">
			The custom [Viewport] node assigned to the [CanvasLayer]. If null, uses the default viewport instead.
		</member>
		<member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport">
		</member>
		<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale">
		</member>
		<member name="layer" type="int" setter="set_layer" getter="get_layer">
			Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
		</member>
		<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
			The layer's base offset.
		</member>
		<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">
			The layer's rotation in degrees.
		</member>
		<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
			The layer's scale.
		</member>
		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
			The layer's transform.
		</member>
	</members>
	<constants>
	</constants>
</class>