BackBufferCopy

Inherits: Node2D < CanvasItem < Node < Object

Copies a region of the screen (or the whole screen) to a buffer so it can be accessed in your shader scripts through the texture(SCREEN_TEXTURE, ...) function.

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 the texture(SCREEN_TEXTURE, ...) function in your shader scripts to access the buffer.

Properties

CopyModecopy_mode1
Rect2rectRect2( -100, -100, 200, 200 )

Enumerations

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.

Property Descriptions

Default1
Setterset_copy_mode(value)
Getterget_copy_mode()

Buffer mode. See CopyMode constants.


DefaultRect2( -100, -100, 200, 200 )
Setterset_rect(value)
Getterget_rect()

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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.