StyleBoxTexture

package
v0.0.0-...-357ca8a Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2025 License: MIT Imports: 28 Imported by: 0

Documentation

Overview

A texture-based nine-patch StyleBox, in a way similar to NinePatchRect. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size.

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

type AxisStretchMode 

type AxisStretchMode int //gd:StyleBoxTexture.AxisStretchMode

const (
	// Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly.
	AxisStretchModeStretch AxisStretchMode = 0
	// Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system.
	AxisStretchModeTile AxisStretchMode = 1
	// Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike [AxisStretchModeTile], the texture may be slightly stretched to make the nine-patch texture tile seamlessly.
	AxisStretchModeTileFit AxisStretchMode = 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]) AsObject 

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

func (*Extension[T]) AsRefCounted 

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource 

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsStyleBox 

func (self *Extension[T]) AsStyleBox() StyleBox.Instance

func (*Extension[T]) AsStyleBoxTexture 

func (self *Extension[T]) AsStyleBoxTexture() Instance

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.StyleBoxTexture

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) AsObject 

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

func (Instance) AsRefCounted 

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource 

func (self Instance) AsResource() Resource.Instance

func (Instance) AsStyleBox 

func (self Instance) AsStyleBox() StyleBox.Instance

func (Instance) AsStyleBoxTexture 

func (self Instance) AsStyleBoxTexture() Instance

func (Instance) AxisStretchHorizontal 

func (self Instance) AxisStretchHorizontal() AxisStretchMode

Controls how the stylebox's texture will be stretched or tiled horizontally.

func (Instance) AxisStretchVertical 

func (self Instance) AxisStretchVertical() AxisStretchMode

Controls how the stylebox's texture will be stretched or tiled vertically.

func (Instance) DrawCenter 

func (self Instance) DrawCenter() bool

If true, the nine-patch texture's center tile will be drawn.

func (Instance) ExpandMarginBottom 

func (self Instance) ExpandMarginBottom() Float.X

Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested.

func (Instance) ExpandMarginLeft 

func (self Instance) ExpandMarginLeft() Float.X

Expands the left margin of this style box when drawing, causing it to be drawn larger than requested.

func (Instance) ExpandMarginRight 

func (self Instance) ExpandMarginRight() Float.X

Expands the right margin of this style box when drawing, causing it to be drawn larger than requested.

func (Instance) ExpandMarginTop 

func (self Instance) ExpandMarginTop() Float.X

Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) ModulateColor 

func (self Instance) ModulateColor() Color.RGBA

Modulates the color of the texture when this style box is drawn.

func (Instance) RegionRect 

func (self Instance) RegionRect() Rect2.PositionSize

The region to use from the Texture.

This is equivalent to first wrapping the Texture in an AtlasTexture with the same region.

If empty (Rect2(0, 0, 0, 0)), the whole Texture is used.

func (Instance) SetAxisStretchHorizontal 

func (self Instance) SetAxisStretchHorizontal(value AxisStretchMode)

SetAxisStretchHorizontal sets the property returned by [GetHAxisStretchMode].

func (Instance) SetAxisStretchVertical 

func (self Instance) SetAxisStretchVertical(value AxisStretchMode)

SetAxisStretchVertical sets the property returned by [GetVAxisStretchMode].

func (Instance) SetDrawCenter 

func (self Instance) SetDrawCenter(value bool)

SetDrawCenter sets the property returned by [IsDrawCenterEnabled].

func (Instance) SetExpandMarginAll 

func (self Instance) SetExpandMarginAll(size Float.X)

Sets the expand margin to 'size' pixels for all sides.

func (Instance) SetExpandMarginBottom 

func (self Instance) SetExpandMarginBottom(value Float.X)

SetExpandMarginBottom sets the property returned by [GetExpandMargin].

func (Instance) SetExpandMarginLeft 

func (self Instance) SetExpandMarginLeft(value Float.X)

SetExpandMarginLeft sets the property returned by [GetExpandMargin].

func (Instance) SetExpandMarginRight 

func (self Instance) SetExpandMarginRight(value Float.X)

SetExpandMarginRight sets the property returned by [GetExpandMargin].

func (Instance) SetExpandMarginTop 

func (self Instance) SetExpandMarginTop(value Float.X)

SetExpandMarginTop sets the property returned by [GetExpandMargin].

func (Instance) SetModulateColor 

func (self Instance) SetModulateColor(value Color.RGBA)

SetModulateColor sets the property returned by [GetModulate].

func (*Instance) SetObject 

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

func (Instance) SetRegionRect 

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

SetRegionRect sets the property returned by [GetRegionRect].

func (Instance) SetTexture 

func (self Instance) SetTexture(value Texture2D.Instance)

SetTexture sets the property returned by [GetTexture].

func (Instance) SetTextureMarginAll 

func (self Instance) SetTextureMarginAll(size Float.X)

Sets the margin to 'size' pixels for all sides.

func (Instance) SetTextureMarginBottom 

func (self Instance) SetTextureMarginBottom(value Float.X)

SetTextureMarginBottom sets the property returned by [GetTextureMargin].

func (Instance) SetTextureMarginLeft 

func (self Instance) SetTextureMarginLeft(value Float.X)

SetTextureMarginLeft sets the property returned by [GetTextureMargin].

func (Instance) SetTextureMarginRight 

func (self Instance) SetTextureMarginRight(value Float.X)

SetTextureMarginRight sets the property returned by [GetTextureMargin].

func (Instance) SetTextureMarginTop 

func (self Instance) SetTextureMarginTop(value Float.X)

SetTextureMarginTop sets the property returned by [GetTextureMargin].

func (Instance) Texture 

func (self Instance) Texture() Texture2D.Instance

The texture to use when drawing this style box.

func (Instance) TextureMarginBottom 

func (self Instance) TextureMarginBottom() Float.X

Increases the bottom margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box.

This is also the value used as fallback for StyleBox.ContentMarginBottom if it is negative.

func (Instance) TextureMarginLeft 

func (self Instance) TextureMarginLeft() Float.X

Increases the left margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the left border of the 3×3 box.

This is also the value used as fallback for StyleBox.ContentMarginLeft if it is negative.

func (Instance) TextureMarginRight 

func (self Instance) TextureMarginRight() Float.X

Increases the right margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the right border of the 3×3 box.

This is also the value used as fallback for StyleBox.ContentMarginRight if it is negative.

func (Instance) TextureMarginTop 

func (self Instance) TextureMarginTop() Float.X

Increases the top margin of the 3×3 texture box.

A higher value means more of the source texture is considered to be part of the top border of the 3×3 box.

This is also the value used as fallback for StyleBox.ContentMarginTop if it is negative.

func (Instance) Virtual 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.