diff options
| author | Chris Bradfield <cb@scribe.net> | 2017-10-07 16:35:14 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-07 16:35:14 -0700 |
| commit | da94eab3ea488c7bbd93de8c1eeafca41524348f (patch) | |
| tree | 292727ed52878e077a6fc6f70c9f368067565626 /doc/classes/BackBufferCopy.xml | |
| parent | 96a5aeeea6753e62354efa7d701eecbc3c21730e (diff) | |
| parent | 1aef04a397665daf374bb030d07319332a971dda (diff) | |
Merge pull request #11914 from diowonderland/docs-backbuffercopy
[DOCS] BackBufferCopy: Document members
Diffstat (limited to 'doc/classes/BackBufferCopy.xml')
| -rw-r--r-- | doc/classes/BackBufferCopy.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index 091bd3fa73..6c44430949 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -15,7 +15,7 @@ <return type="int" enum="BackBufferCopy.CopyMode"> </return> <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> </method> <method name="get_rect" qualifiers="const"> @@ -31,7 +31,7 @@ <argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode"> </argument> <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> </method> <method name="set_rect"> @@ -46,8 +46,10 @@ </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> @@ -55,10 +57,10 @@ 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"> - Sets the copy mode to a region. + BackBufferCopy buffers a rectangular region. </constant> <constant name="COPY_MODE_VIEWPORT" value="2"> - Sets the copy mode to the entire screen. + BackBufferCopy buffers the entire screen. </constant> </constants> </class> |