Documentation
¶
Overview ¶
A container that displays the contents of underlying SubViewport child nodes. It uses the combined size of the SubViewports as minimum size, unless Stretch is enabled.
Note: Changing a SubViewportContainer's Control.Scale will cause its contents to appear distorted. To change its visual size without causing distortion, adjust the node's margins instead (if it's not already in a container).
Note: The SubViewportContainer forwards mouse-enter and mouse-exit notifications to its sub-viewports.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
- func (self *Extension[T]) AsContainer() Container.Instance
- func (self *Extension[T]) AsControl() Control.Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsSubViewportContainer() Instance
- type ID
- type Implementation
- type Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsContainer() Container.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsSubViewportContainer() Instance
- func (self Instance) ID() ID
- func (self Instance) MouseTarget() bool
- func (self Instance) SetMouseTarget(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetStretch(value bool)
- func (self Instance) SetStretchShrink(value int)
- func (self Instance) Stretch() bool
- func (self Instance) StretchShrink() int
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
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 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]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsContainer ¶
func (*Extension[T]) AsSubViewportContainer ¶
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 Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.SubViewportContainer
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) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsContainer ¶
func (Instance) AsSubViewportContainer ¶
func (Instance) MouseTarget ¶
Configure, if either the SubViewportContainer or alternatively the Control nodes of its SubViewport children should be available as targets of mouse-related functionalities, like identifying the drop target in drag-and-drop operations or cursor shape of hovered Control node.
If false, the Control nodes inside its SubViewport children are considered as targets.
If true, the SubViewportContainer itself will be considered as a target.
func (Instance) SetMouseTarget ¶
SetMouseTarget sets the property returned by [IsMouseTargetEnabled].
func (Instance) SetStretch ¶
SetStretch sets the property returned by [IsStretchEnabled].
func (Instance) SetStretchShrink ¶
SetStretchShrink sets the property returned by [GetStretchShrink].
func (Instance) Stretch ¶
If true, the sub-viewport will be automatically resized to the control's size.
Note: If true, this will prohibit changing SubViewport.Size of its children manually.
func (Instance) StretchShrink ¶
Divides the sub-viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.
For example, a 1280×720 sub-viewport with StretchShrink set to 2 will be rendered at 640×360 while occupying the same size in the container.
Note: Stretch must be true for this property to work.
type Interface ¶
type Interface interface {
// Virtual method to be implemented by the user. If it returns true, the 'event' is propagated to [SubViewport] children. Propagation doesn't happen if it returns false. If the function is not implemented, all events are propagated to SubViewports.
//
// [SubViewport]: https://pkg.go.dev/graphics.gd/classdb/SubViewport
PropagateInputEvent(event InputEvent.Instance) bool
}
Source Files