BackBufferCopy¶
Inherits: Node2D < CanvasItem < Node < Object
Category: Core
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.
Member Functions¶
| int | get_copy_mode ( ) const |
| Rect2 | get_rect ( ) const |
| void | set_copy_mode ( int copy_mode ) |
| void | set_rect ( Rect2 rect ) |
Numeric Constants¶
- 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 — Sets the copy mode to a region.
- COPY_MODE_VIEWPORT = 2 — Sets the copy mode to 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. Accessing this buffer is done with the texscreen() shader instruction.
Member Function Description¶
- int get_copy_mode ( ) const
Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
- Rect2 get_rect ( ) const
Return the area covered by the BackBufferCopy.
- void set_copy_mode ( int copy_mode )
Set the copy mode of the BackBufferCopy (refer to constants section).
- void set_rect ( Rect2 rect )
Defines the area covered by the BackBufferCopy.