BackBufferCopy

package
v0.0.0-...-e10d1cd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2025 License: MIT Imports: 26 Imported by: 0

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

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 Any

type Any interface {
	gd.IsClass
	AsBackBufferCopy() Instance
}

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

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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 (self *Extension[T]) AsBackBufferCopy() Instance

func (*Extension[T]) AsCanvasItem

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

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 New

func New() Instance

func (Instance) AsBackBufferCopy

func (self Instance) AsBackBufferCopy() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) CopyMode

func (self Instance) CopyMode() CopyMode

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Rect

func (self Instance) Rect() Rect2.PositionSize

func (Instance) SetCopyMode

func (self Instance) SetCopyMode(value CopyMode)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetRect

func (self Instance) SetRect(value Rect2.PositionSize)

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL