Documentation
¶
Overview ¶
An automatically scalable Texture2D based on an SVG image. DPITextures are used to automatically re-rasterize icons and other texture based UI theme elements to match viewport scale and font oversampling. See also ProjectSettings "display/window/stretch/mode" ("canvas_items" mode) and Viewport.OversamplingOverride.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsDPITexture() Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- func (self *Extension[T]) AsTexture() Texture.Instance
- func (self *Extension[T]) AsTexture2D() Texture2D.Instance
- type ID
- type Instance
- func (self Instance) AsDPITexture() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTexture() Texture.Instance
- func (self Instance) AsTexture2D() Texture2D.Instance
- func (self Instance) BaseScale() Float.X
- func (self Instance) ColorMap() map[struct{ ... }]struct{ ... }
- func (self Instance) GetScaledRid() RID.Texture
- func (self Instance) GetSource() string
- func (self Instance) ID() ID
- func (self Instance) Saturation() Float.X
- func (self Instance) SetBaseScale(value Float.X)
- func (self Instance) SetColorMap(value map[struct{ ... }]struct{ ... })
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSaturation(value Float.X)
- func (self Instance) SetSizeOverride(size Vector2i.XY)
- func (self Instance) SetSource(source string)
- func (self Instance) Virtual(name string) reflect.Value
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
func (*Extension[T]) AsDPITexture ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsTexture2D ¶
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 Instance ¶
type Instance [1]gdclass.DPITexture
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 CreateFromString ¶
func CreateFromString(source string, color_map map[struct { R float32 G float32 B float32 A float32 }]struct { R float32 G float32 B float32 A float32 }) Instance
Creates a new DPITexture and initializes it by allocating and setting the SVG data from string.
func CreateFromStringOptions ¶
func CreateFromStringOptions(source string, scale Float.X, saturation Float.X, color_map map[struct { R float32 G float32 B float32 A float32 }]struct { R float32 G float32 B float32 A float32 }) Instance
Creates a new DPITexture and initializes it by allocating and setting the SVG data from string.
func (Instance) AsDPITexture ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTexture2D ¶
func (Instance) BaseScale ¶
Texture scale. 1.0 is the original SVG size. Higher values result in a larger image.
func (Instance) ColorMap ¶
func (self Instance) ColorMap() map[struct { R float32 G float32 B float32 A float32 }]struct { R float32 G float32 B float32 A float32 }
If set, remaps texture colors according to Color.RGBA-Color.RGBA map.
func (Instance) GetScaledRid ¶
Returns the Resource.ID of the texture rasterized to match the oversampling of the currently drawn canvas item.
func (Instance) Saturation ¶
Overrides texture saturation.
func (Instance) SetBaseScale ¶
SetBaseScale sets the property returned by [GetBaseScale].
func (Instance) SetColorMap ¶
func (self Instance) SetColorMap(value map[struct { R float32 G float32 B float32 A float32 }]struct { R float32 G float32 B float32 A float32 })
SetColorMap sets the property returned by [GetColorMap].
func (Instance) SetSaturation ¶
SetSaturation sets the property returned by [GetSaturation].
func (Instance) SetSizeOverride ¶
Resizes the texture to the specified dimensions.
Source Files