mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
79 lines
2.8 KiB
ReStructuredText
79 lines
2.8 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the BackBufferCopy.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_BackBufferCopy:
|
|
|
|
BackBufferCopy
|
|
==============
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with ``SCREEN_TEXTURE`` in the ``texture()`` function.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------+-----------------------------------------------------------+
|
|
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` |
|
|
+-----------------------------------------------+-----------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_property_rect>` |
|
|
+-----------------------------------------------+-----------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_BackBufferCopy_CopyMode:
|
|
|
|
.. _class_BackBufferCopy_constant_COPY_MODE_DISABLED:
|
|
|
|
.. _class_BackBufferCopy_constant_COPY_MODE_RECT:
|
|
|
|
.. _class_BackBufferCopy_constant_COPY_MODE_VIEWPORT:
|
|
|
|
enum **CopyMode**:
|
|
|
|
- **COPY_MODE_DISABLED** = **0** --- Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
|
|
|
|
- **COPY_MODE_RECT** = **1** --- BackBufferCopy buffers a rectangular region.
|
|
|
|
- **COPY_MODE_VIEWPORT** = **2** --- BackBufferCopy buffers the entire screen.
|
|
|
|
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. Use ``SCREEN_TEXTURE`` in the ``texture()`` function to access the buffer.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_BackBufferCopy_property_copy_mode:
|
|
|
|
- :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` **copy_mode**
|
|
|
|
+----------+----------------------+
|
|
| *Setter* | set_copy_mode(value) |
|
|
+----------+----------------------+
|
|
| *Getter* | get_copy_mode() |
|
|
+----------+----------------------+
|
|
|
|
Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants.
|
|
|
|
.. _class_BackBufferCopy_property_rect:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **rect**
|
|
|
|
+----------+-----------------+
|
|
| *Setter* | set_rect(value) |
|
|
+----------+-----------------+
|
|
| *Getter* | get_rect() |
|
|
+----------+-----------------+
|
|
|
|
The area covered by the BackBufferCopy. Only used if :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` is :ref:`COPY_MODE_RECT<class_BackBufferCopy_constant_COPY_MODE_RECT>`.
|
|
|