Documentation
¶
Overview ¶
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 CopyMode. 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.
Index ¶
- type Advanced
- type Any
- type CopyMode
- type Extension
- type ID
- type Instance
- func (self Instance) AsBackBufferCopy() Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) CopyMode() CopyMode
- func (self Instance) ID() ID
- func (self Instance) Rect() Rect2.PositionSize
- func (self Instance) SetCopyMode(value CopyMode)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRect(value Rect2.PositionSize)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type CopyMode ¶
type CopyMode int //gd:BackBufferCopy.CopyMode
const ( // Disables the buffering mode. This means the [BackBufferCopy] node will directly use the portion of screen it covers. // // [BackBufferCopy]: https://pkg.go.dev/graphics.gd/classdb/BackBufferCopy CopyModeDisabled CopyMode = 0 // [BackBufferCopy] buffers a rectangular region. // // [BackBufferCopy]: https://pkg.go.dev/graphics.gd/classdb/BackBufferCopy CopyModeRect CopyMode = 1 // [BackBufferCopy] buffers the entire screen. // // [BackBufferCopy]: https://pkg.go.dev/graphics.gd/classdb/BackBufferCopy CopyModeViewport CopyMode = 2 )
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsBackBufferCopy ¶
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.BackBufferCopy
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsBackBufferCopy ¶
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) Rect ¶
func (self Instance) Rect() Rect2.PositionSize
func (Instance) SetCopyMode ¶
func (Instance) SetRect ¶
func (self Instance) SetRect(value Rect2.PositionSize)