godotengine
/
godot
mirror of https://github.com/godotengine/godot
1
0
Fork 0
Code

[DOCS] BackBufferCopy: Document members

This commit is contained in:
Dio 2017-10-07 16:40:33 +02:00 committed by mhilbrunner
parent bd10a00240
commit 1aef04a397
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/classes/BackBufferCopy.xml
View File

@ -15,7 +15,7 @@
<return type="int" enum="BackBufferCopy.CopyMode"> <return type="int" enum="BackBufferCopy.CopyMode">
</return> </return>
<description> <description>
Return the copy mode currently applied to the BackBufferCopy (refer to constants section). Return the copy mode currently applied to the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
</description> </description>
</method> </method>
<method name="get_rect" qualifiers="const"> <method name="get_rect" qualifiers="const">
@ -31,7 +31,7 @@
<argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode"> <argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode">
</argument> </argument>
<description> <description>
Set the copy mode of the BackBufferCopy (refer to constants section). Set the copy mode of the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
</description> </description>
</method> </method>
<method name="set_rect"> <method name="set_rect">
@ -46,8 +46,10 @@
</methods> </methods>
<members> <members>
<member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode"> <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>
<member name="rect" type="Rect2" setter="set_rect" getter="get_rect"> <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> </member>
</members> </members>
<constants> <constants>
@ -55,10 +57,10 @@
Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. 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. BackBufferCopy buffers a rectangular 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. BackBufferCopy buffers the entire screen.
</constant> </constant>
</constants> </constants>
</class> </class>