SubViewport

Documentation

Overview

Package SubViewport provides methods for working with SubViewport object instances.

Index

• type Advanced
• type Any
• type ClearMode
• type Instance
  • func New() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSubViewport() Instance
  • func (self Instance) AsViewport() Viewport.Instance
  • func (self Instance) RenderTargetClearMode() gdclass.SubViewportClearMode
  • func (self Instance) RenderTargetUpdateMode() gdclass.SubViewportUpdateMode
  • func (self Instance) SetRenderTargetClearMode(value gdclass.SubViewportClearMode)
  • func (self Instance) SetRenderTargetUpdateMode(value gdclass.SubViewportUpdateMode)
  • func (self Instance) SetSize(value Vector2i.XY)
  • func (self Instance) SetSize2dOverride(value Vector2i.XY)
  • func (self Instance) SetSize2dOverrideStretch(value bool)
  • func (self Instance) Size() Vector2i.XY
  • func (self Instance) Size2dOverride() Vector2i.XY
  • func (self Instance) Size2dOverrideStretch() bool
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type UpdateMode

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
	AsSubViewport() Instance
}

type ClearMode

type ClearMode = gdclass.SubViewportClearMode //gd:SubViewport.ClearMode

const (
	/*Always clear the render target before drawing.*/
	ClearModeAlways ClearMode = 0
	/*Never clear the render target.*/
	ClearModeNever ClearMode = 1
	/*Clear the render target on the next frame, then switch to [constant CLEAR_MODE_NEVER].*/
	ClearModeOnce ClearMode = 2
)

type Instance

type Instance [1]gdclass.SubViewport

[SubViewport] Isolates a rectangular region of a scene to be displayed independently. This can be used, for example, to display UI in 3D space. [b]Note:[/b] [SubViewport] is a [Viewport] that isn't a [Window], i.e. it doesn't draw anything by itself. To display anything, [SubViewport] must have a non-zero size and be either put inside a [SubViewportContainer] or assigned to a [ViewportTexture].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

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

func (Instance) AsSubViewport

func (self Instance) AsSubViewport() Instance

func (Instance) AsViewport

func (self Instance) AsViewport() Viewport.Instance

func (Instance) RenderTargetClearMode

func (self Instance) RenderTargetClearMode() gdclass.SubViewportClearMode

func (Instance) RenderTargetUpdateMode

func (self Instance) RenderTargetUpdateMode() gdclass.SubViewportUpdateMode

func (Instance) SetRenderTargetClearMode

func (self Instance) SetRenderTargetClearMode(value gdclass.SubViewportClearMode)

func (Instance) SetRenderTargetUpdateMode

func (self Instance) SetRenderTargetUpdateMode(value gdclass.SubViewportUpdateMode)

func (Instance) SetSize

func (self Instance) SetSize(value Vector2i.XY)

func (Instance) SetSize2dOverride

func (self Instance) SetSize2dOverride(value Vector2i.XY)

func (Instance) SetSize2dOverrideStretch

func (self Instance) SetSize2dOverrideStretch(value bool)

func (Instance) Size

func (self Instance) Size() Vector2i.XY

func (Instance) Size2dOverride

func (self Instance) Size2dOverride() Vector2i.XY

func (Instance) Size2dOverrideStretch

func (self Instance) Size2dOverrideStretch() bool

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

type UpdateMode

type UpdateMode = gdclass.SubViewportUpdateMode //gd:SubViewport.UpdateMode

const (
	/*Do not update the render target.*/
	UpdateDisabled UpdateMode = 0
	/*Update the render target once, then switch to [constant UPDATE_DISABLED].*/
	UpdateOnce UpdateMode = 1
	/*Update the render target only when it is visible. This is the default value.*/
	UpdateWhenVisible UpdateMode = 2
	/*Update the render target only when its parent is visible.*/
	UpdateWhenParentVisible UpdateMode = 3
	/*Always update the render target.*/
	UpdateAlways UpdateMode = 4
)