Documented BackBufferCopy. Need validation for the different copy modes (constants)

(cherry picked from commit defe7f18c2)
This commit is contained in:
Julian Murgia - StraToN 2016-05-28 22:02:21 +02:00 committed by Rémi Verschelde
parent 24e5755e72
commit e8b1744325
1 changed files with 9 additions and 0 deletions

View File

@ -5048,41 +5048,50 @@
</class> </class>
<class name="BackBufferCopy" inherits="Node2D" category="Core"> <class name="BackBufferCopy" inherits="Node2D" category="Core">
<brief_description> <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> </brief_description>
<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> </description>
<methods> <methods>
<method name="set_rect"> <method name="set_rect">
<argument index="0" name="rect" type="Rect2"> <argument index="0" name="rect" type="Rect2">
</argument> </argument>
<description> <description>
Defines the area covered by the BackBufferCopy.
</description> </description>
</method> </method>
<method name="get_rect" qualifiers="const"> <method name="get_rect" qualifiers="const">
<return type="Rect2"> <return type="Rect2">
</return> </return>
<description> <description>
Return the area covered by the BackBufferCopy.
</description> </description>
</method> </method>
<method name="set_copy_mode"> <method name="set_copy_mode">
<argument index="0" name="copy_mode" type="int"> <argument index="0" name="copy_mode" type="int">
</argument> </argument>
<description> <description>
Set the copy mode of the BackBufferCopy (refer to constants section).
</description> </description>
</method> </method>
<method name="get_copy_mode" qualifiers="const"> <method name="get_copy_mode" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
</description> </description>
</method> </method>
</methods> </methods>
<constants> <constants>
<constant name="COPY_MODE_DISABLED" value="0"> <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>
<constant name="COPY_MODE_RECT" value="1"> <constant name="COPY_MODE_RECT" value="1">
Sets the copy mode to a region.
</constant> </constant>
<constant name="COPY_MODE_VIEWPORT" value="2"> <constant name="COPY_MODE_VIEWPORT" value="2">
Sets the copy mode to the entire screen.
</constant> </constant>
</constants> </constants>
</class> </class>