BackBufferCopy

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.

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

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

Constants
enum Constants
CopyMode
enum CopyMode

Functions

getCopyMode
BackBufferCopy.CopyMode getCopyMode()
getRect
Rect2 getRect()
opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(BackBufferCopy other)
opEquals
bool opEquals(typeof(null) n)
setCopyMode
void setCopyMode(long copy_mode)
setRect
void setRect(Rect2 rect)
toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

copyMode
BackBufferCopy.CopyMode copyMode [@property getter]
long copyMode [@property setter]

Buffer mode. See copymode constants.

rect
Rect2 rect [@property getter]
Rect2 rect [@property setter]

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

Static functions

_new
BackBufferCopy _new()

Construct a new instance of BackBufferCopy. Note: use memnew!BackBufferCopy instead.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

GDNativeClassBinding
struct GDNativeClassBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(ToRef) as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta