BackBufferCopy | Godot Docs 4.5

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

BackBufferCopy

A node that copies a region of the screen to a buffer for access in shader code.

Node for back-buffering the currently-displayed screen. The region defined in the BackBufferCopy node is buffered with the content of the screen it covers, or the entire screen according to the copy_mode. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with hint_screen_texture).
Note: Since this node inherits from Node2D (and not Control), anchors and margins won't apply to child Control-derived nodes. This can be problematic when resizing the window. To avoid this, add Control-derived nodes as siblings to the BackBufferCopy node instead of adding them as children.

Enum

CopyMode

()

:Enum

COPY_MODE_DISABLED:null = 0
Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.

COPY_MODE_RECT:null = 1
BackBufferCopy buffers a rectangular region.

COPY_MODE_VIEWPORT:null = 2
BackBufferCopy buffers the entire screen.

set get

int

copy_mode

()

:int

set get

Buffer mode.

set get

Rect2

rect

()

:Rect2