godot/doc/classes/BackBufferCopy.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BackBufferCopy" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A node that copies a region of the screen to a buffer for access in shader code.
	</brief_description>
	<description>
		Node for back-buffering the currently-displayed screen. The region defined in the [BackBufferCopy] node is buffered with the content of the screen it covers, or the entire screen according to the [member copy_mode]. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with [code]hint_screen_texture[/code]).
		[b]Note:[/b] Since this node inherits from [Node2D] (and not [Control]), anchors and margins won't apply to child [Control]-derived nodes. This can be problematic when resizing the window. To avoid this, add [Control]-derived nodes as [i]siblings[/i] to the [BackBufferCopy] node instead of adding them as children.
	</description>
	<tutorials>
		<link title="Screen-reading shaders">$DOCS_URL/tutorials/shaders/screen-reading_shaders.html</link>
	</tutorials>
	<members>
		<member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode" default="1">
			Buffer mode. See [enum CopyMode] constants.
		</member>
		<member name="rect" type="Rect2" setter="set_rect" getter="get_rect" default="Rect2(-100, -100, 200, 200)">
			The area covered by the [BackBufferCopy]. Only used if [member copy_mode] is [constant COPY_MODE_RECT].
		</member>
	</members>
	<constants>
		<constant name="COPY_MODE_DISABLED" value="0" enum="CopyMode">
			Disables the buffering mode. This means the [BackBufferCopy] node will directly use the portion of screen it covers.
		</constant>
		<constant name="COPY_MODE_RECT" value="1" enum="CopyMode">
			[BackBufferCopy] buffers a rectangular region.
		</constant>
		<constant name="COPY_MODE_VIEWPORT" value="2" enum="CopyMode">
			[BackBufferCopy] buffers the entire screen.
		</constant>
	</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" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="BackBufferCopy" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
Improve the top docs sections of VFX classes 2023-06-24 11:19:58 +00:00			`A node that copies a region of the screen to a buffer for access in shader code.`
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>`
Improve the top docs sections of VFX classes 2023-06-24 11:19:58 +00:00			`Node for back-buffering the currently-displayed screen. The region defined in the [BackBufferCopy] node is buffered with the content of the screen it covers, or the entire screen according to the [member copy_mode]. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with [code]hint_screen_texture[/code]).`
Fix BackBufferCopy `rect` property appearing when not relevant in inspector The `rect` property is only effective if `copy_mode` is Rect. 2022-12-08 18:50:59 +00:00			`[b]Note:[/b] Since this node inherits from [Node2D] (and not [Control]), anchors and margins won't apply to child [Control]-derived nodes. This can be problematic when resizing the window. To avoid this, add [Control]-derived nodes as [i]siblings[/i] to the [BackBufferCopy] node instead of adding them as children.`
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>`
Link to Screen-reading shaders tutorial in BackBufferCopy documentation 2024-10-22 14:38:24 +00:00			`<link title="Screen-reading shaders">$DOCS_URL/tutorials/shaders/screen-reading_shaders.html</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>`
			`<members>`
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="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode" default="1">`
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 10:34:26 +00:00			`Buffer mode. See [enum CopyMode] constants.`
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>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="rect" type="Rect2" setter="set_rect" getter="get_rect" default="Rect2(-100, -100, 200, 200)">`
Fix BackBufferCopy `rect` property appearing when not relevant in inspector The `rect` property is only effective if `copy_mode` is Rect. 2022-12-08 18:50:59 +00:00			`The area covered by the [BackBufferCopy]. Only used if [member copy_mode] is [constant COPY_MODE_RECT].`
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>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="COPY_MODE_DISABLED" value="0" enum="CopyMode">`
Fix BackBufferCopy `rect` property appearing when not relevant in inspector The `rect` property is only effective if `copy_mode` is Rect. 2022-12-08 18:50:59 +00:00			`Disables the buffering mode. This means the [BackBufferCopy] node will directly use the portion of screen it covers.`
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			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="COPY_MODE_RECT" value="1" enum="CopyMode">`
Fix BackBufferCopy `rect` property appearing when not relevant in inspector The `rect` property is only effective if `copy_mode` is Rect. 2022-12-08 18:50:59 +00:00			`[BackBufferCopy] buffers a rectangular region.`
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			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="COPY_MODE_VIEWPORT" value="2" enum="CopyMode">`
Fix BackBufferCopy `rect` property appearing when not relevant in inspector The `rect` property is only effective if `copy_mode` is Rect. 2022-12-08 18:50:59 +00:00			`[BackBufferCopy] buffers the entire screen.`
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			`</constant>`
			`</constants>`
			`</class>`