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.
    public class BackBufferCopy : Node2D

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.

Inheritance Chain


    public BackBufferCopy()


    public CopyModeEnum CopyMode { get; set; }

Buffer mode. See COPY_MODE_* constants.

    public Rect2 Rect { get; set; }

The area covered by the BackBufferCopy. Only used if copy_mode is COPY_MODE_RECT.


    public CopyModeEnum GetCopyMode()

Getter for CopyMode

    public Rect2 GetRect()

Getter for CopyModeEnum.Rect

    public void SetCopyMode(CopyModeEnum copyMode)

Setter for CopyMode

    public void SetRect(Rect2 rect)

Setter for CopyModeEnum.Rect

Inner Types


Name Value Description
Disabled 0 Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
Rect 1 BackBufferCopy buffers a rectangular region.
Viewport 2 BackBufferCopy buffers the entire screen.