BackBufferCopy

Documentation

Overview

Package BackBufferCopy provides methods for working with BackBufferCopy object instances.

Index

• type Advanced
• type Any
• type CopyMode
• type Instance
  • func New() 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() gdclass.BackBufferCopyCopyMode
  • func (self Instance) Rect() Rect2.PositionSize
  • func (self Instance) SetCopyMode(value gdclass.BackBufferCopyCopyMode)
  • func (self Instance) SetRect(value Rect2.PositionSize)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 = gdclass.BackBufferCopyCopyMode //gd:BackBufferCopy.CopyMode

const (
	/*Disables the buffering mode. This means the [BackBufferCopy] node will directly use the portion of screen it covers.*/
	CopyModeDisabled CopyMode = 0
	/*[BackBufferCopy] buffers a rectangular region.*/
	CopyModeRect CopyMode = 1
	/*[BackBufferCopy] buffers the entire screen.*/
	CopyModeViewport CopyMode = 2
)

type Instance

type Instance [1]gdclass.BackBufferCopy

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 [member copy_mode]. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with [code]hint_screen_texture[/code]). [b]Note:[/b] 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 [i]siblings[/i] to the [BackBufferCopy] node instead of adding them as children.

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() gdclass.BackBufferCopyCopyMode

func (Instance) Rect

func (self Instance) Rect() Rect2.PositionSize

func (Instance) SetCopyMode

func (self Instance) SetCopyMode(value gdclass.BackBufferCopyCopyMode)

func (Instance) SetRect

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

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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