godot/doc/classes/CanvasLayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasLayer" inherits="Node" version="3.5">
	<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 title="Viewport and canvas transforms">https://docs.godotengine.org/en/3.4/tutorials/2d/2d_transforms.html</link>
		<link title="Canvas layers">https://docs.godotengine.org/en/3.4/tutorials/2d/canvas_layers.html</link>
		<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
	</tutorials>
	<methods>
		<method name="get_canvas" qualifiers="const">
			<return type="RID" />
			<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 [code]null[/code], uses the default viewport instead.
		</member>
		<member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport" default="false">
			Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.
		</member>
		<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale" default="1.0">
			Scales the layer when using [member follow_viewport_enable]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
		</member>
		<member name="layer" type="int" setter="set_layer" getter="get_layer" default="1">
			Layer index for draw order. Lower values are drawn first.
		</member>
		<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )">
			The layer's base offset.
		</member>
		<member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0">
			The layer's rotation in radians.
		</member>
		<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees" default="0.0">
			The layer's rotation in degrees.
		</member>
		<member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2( 1, 1 )">
			The layer's scale.
		</member>
		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
			The layer's transform.
		</member>
	</members>
	<constants>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 3.5-beta 2021-11-05 14:02:42 +00:00			`<class name="CanvasLayer" inherits="Node" version="3.5">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
[DOCS] CanvasLayer member descriptions 2017-09-17 02:14:03 +00:00			`Canvas drawing layer.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 22:37:35 +00:00			`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).`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
doc: Point URLs to 3.4 version of the online docs 2021-08-12 14:58:38 +00:00			`<link title="Viewport and canvas transforms">https://docs.godotengine.org/en/3.4/tutorials/2d/2d_transforms.html</link>`
			`<link title="Canvas layers">https://docs.godotengine.org/en/3.4/tutorials/2d/canvas_layers.html</link>`
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f) 2020-10-01 08:34:47 +00:00			`<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</tutorials>`
			`<methods>`
doc: Sync classref with current source 2018-04-10 08:12:42 +00:00			`<method name="get_canvas" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 13:28:05 +00:00			`<return type="RID" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<description>`
doc: Sync classref with current source 2018-04-10 08:12:42 +00:00			`Returns the RID of the canvas used by this layer.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 19:22:15 +00:00			`<member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport" default="false">`
Complete various class references 2020-01-26 05:59:51 +00:00			`Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.`
doc: Sync classref with current source 2019-04-15 12:49:41 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale" default="1.0">`
Complete various class references 2020-01-26 05:59:51 +00:00			`Scales the layer when using [member follow_viewport_enable]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.`
doc: Sync classref with current source 2019-04-15 12:49:41 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="layer" type="int" setter="set_layer" getter="get_layer" default="1">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`Layer index for draw order. Lower values are drawn first.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )">`
[DOCS] CanvasLayer member descriptions 2017-09-17 02:14:03 +00:00			`The layer's base offset.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0">`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`The layer's rotation in radians.`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees" default="0.0">`
[DOCS] CanvasLayer member descriptions 2017-09-17 02:14:03 +00:00			`The layer's rotation in degrees.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2( 1, 1 )">`
[DOCS] CanvasLayer member descriptions 2017-09-17 02:14:03 +00:00			`The layer's scale.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, 1, 0, 0 )">`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`The layer's transform.`
			`</member>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</members>`
			`<constants>`
			`</constants>`
			`</class>`