2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 12:33:56 +02:00
<class name= "BackBufferCopy" inherits= "Node2D" category= "Core" version= "3.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-08-12 01:49:52 +02:00
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2019-06-22 01:04:47 +02:00
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. Use [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function to access the buffer.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "copy_mode" type= "int" setter= "set_copy_mode" getter= "get_copy_mode" enum= "BackBufferCopy.CopyMode" >
2019-06-27 12:34:26 +02:00
Buffer mode. See [enum CopyMode] constants.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "rect" type= "Rect2" setter= "set_rect" getter= "get_rect" >
2019-06-27 12:34:26 +02:00
The area covered by the BackBufferCopy. Only used if [member copy_mode] is [constant COPY_MODE_RECT].
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "COPY_MODE_DISABLED" value= "0" enum= "CopyMode" >
2017-09-12 22:42:36 +02:00
Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "COPY_MODE_RECT" value= "1" enum= "CopyMode" >
2017-10-07 16:40:33 +02:00
BackBufferCopy buffers a rectangular region.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "COPY_MODE_VIEWPORT" value= "2" enum= "CopyMode" >
2017-10-07 16:40:33 +02:00
BackBufferCopy buffers the entire screen.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>