virtualx-engine/doc/classes/BackBufferCopy.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0-alpha">
	<brief_description>
		Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction.
	</brief_description>
	<description>
		Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_copy_mode" qualifiers="const">
			<return type="int" enum="BackBufferCopy.CopyMode">
			</return>
			<description>
				Return the copy mode currently applied to the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
			</description>
		</method>
		<method name="get_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Return the area covered by the BackBufferCopy.
			</description>
		</method>
		<method name="set_copy_mode">
			<return type="void">
			</return>
			<argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode">
			</argument>
			<description>
				Set the copy mode of the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
			</description>
		</method>
		<method name="set_rect">
			<return type="void">
			</return>
			<argument index="0" name="rect" type="Rect2">
			</argument>
			<description>
				Defines the area covered by the BackBufferCopy.
			</description>
		</method>
	</methods>
	<members>
		<member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode">
			Buffer mode. See [code]COPY_MODE_*[/code] constants.
		</member>
		<member name="rect" type="Rect2" setter="set_rect" getter="get_rect">
			The area covered by the BackBufferCopy. Only used if [code]copy_mode[/code] is [code]COPY_MODE_RECT[/code].
		</member>
	</members>
	<constants>
		<constant name="COPY_MODE_DISABLED" value="0">
			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">
			BackBufferCopy buffers a rectangular region.
		</constant>
		<constant name="COPY_MODE_VIEWPORT" value="2">
			BackBufferCopy buffers the entire screen.
		</constant>
	</constants>
</class>