Class BackBufferCopy

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

Inheritance

Node2D

CanvasItem

Node

Object

BackBufferCopy

Remarks

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.

See Also

Screen-reading shaders

Properties

copy_mode

Buffer mode. See CopyMode constants.

var copy_mode : int = 1

Property Value

int

Remarks

• void set_copy_mode(int value)
• int get_copy_mode

rect

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

var rect : Rect2 = Rect2(-100, -100, 200, 200)

Property Value

Rect2

Remarks

• void set_rect(Rect2 value)
• Rect2 get_rect