TextureProgress

Texture-based progress bar. Useful for loading screens and life or stamina bars.

TextureProgress works like ProgressBar but it uses up to 3 textures instead of Godot's Theme resource. Works horizontally, vertically, and radially.

@GodotBaseClass
struct TextureProgress {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

Constants
enum Constants
FillMode
enum FillMode

Functions

getFillDegrees
double getFillDegrees()
getFillMode
long getFillMode()
getNinePatchStretch
bool getNinePatchStretch()
getOverTexture
Ref!Texture getOverTexture()
getProgressTexture
Ref!Texture getProgressTexture()
getRadialCenterOffset
Vector2 getRadialCenterOffset()
getRadialInitialAngle
double getRadialInitialAngle()
getStretchMargin
long getStretchMargin(long margin)
getTintOver
Color getTintOver()
getTintProgress
Color getTintProgress()
getTintUnder
Color getTintUnder()
getUnderTexture
Ref!Texture getUnderTexture()
opAssign
TextureProgress opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(TextureProgress other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setFillDegrees
void setFillDegrees(double mode)
setFillMode
void setFillMode(long mode)
setNinePatchStretch
void setNinePatchStretch(bool stretch)
setOverTexture
void setOverTexture(Texture tex)
setProgressTexture
void setProgressTexture(Texture tex)
setRadialCenterOffset
void setRadialCenterOffset(Vector2 mode)
setRadialInitialAngle
void setRadialInitialAngle(double mode)
setStretchMargin
void setStretchMargin(long margin, long value)
setTintOver
void setTintOver(Color tint)
setTintProgress
void setTintProgress(Color tint)
setTintUnder
void setTintUnder(Color tint)
setUnderTexture
void setUnderTexture(Texture tex)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

fillMode
long fillMode [@property getter]
long fillMode [@property setter]

The fill direction. Uses FILL_* constants.

ninePatchStretch
bool ninePatchStretch [@property getter]
bool ninePatchStretch [@property setter]

If true Godot treats the bar's textures like NinePatchRect. Use stretch_margin_*, like stretchMarginBottom, to set up the nine patch's 3x3 grid. Default value: false.

radialCenterOffset
Vector2 radialCenterOffset [@property getter]
Vector2 radialCenterOffset [@property setter]

Offsets textureProgress if fillMode is FILL_CLOCKWISE or FILL_COUNTER_CLOCKWISE.

radialFillDegrees
double radialFillDegrees [@property getter]
double radialFillDegrees [@property setter]

Upper limit for the fill of textureProgress if fillMode is FILL_CLOCKWISE or FILL_COUNTER_CLOCKWISE. When the node's value is equal to its max_value, the texture fills up to this angle. See Range.value, Range.maxValue.

radialInitialAngle
double radialInitialAngle [@property getter]
double radialInitialAngle [@property setter]

Starting angle for the fill of textureProgress if fillMode is FILL_CLOCKWISE or FILL_COUNTER_CLOCKWISE. When the node's value is equal to its min_value, the texture doesn't show up at all. When the value increases, the texture fills and tends towards radialFillDegrees.

stretchMarginBottom
long stretchMarginBottom [@property getter]
long stretchMarginBottom [@property setter]

The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.

stretchMarginLeft
long stretchMarginLeft [@property getter]
long stretchMarginLeft [@property setter]

The width of the 9-patch's left column.

stretchMarginRight
long stretchMarginRight [@property getter]
long stretchMarginRight [@property setter]

The width of the 9-patch's right column.

stretchMarginTop
long stretchMarginTop [@property getter]
long stretchMarginTop [@property setter]

The height of the 9-patch's top row.

textureOver
Texture textureOver [@property getter]
Texture textureOver [@property setter]

Texture that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of textureProgress.

textureProgress
Texture textureProgress [@property getter]
Texture textureProgress [@property setter]

Texture that clips based on the node's value and fillMode. As value increased, the texture fills up. It shows entirely when value reaches max_value. It doesn't show at all if value is equal to min_value. The value property comes from Range. See Range.value, Range.minValue, Range.maxValue.

textureUnder
Texture textureUnder [@property getter]
Texture textureUnder [@property setter]

Texture that draws under the progress bar. The bar's background.

tintOver
Color tintOver [@property getter]
Color tintOver [@property setter]

Multiplies the color of the bar's texture_over texture. The effect is similar to CanvasItem.modulate, except it only affects this specific texture instead of the entire node.

tintProgress
Color tintProgress [@property getter]
Color tintProgress [@property setter]

Multiplies the color of the bar's texture_progress texture.

tintUnder
Color tintUnder [@property getter]
Color tintUnder [@property setter]

Multiplies the color of the bar's texture_under texture.

Static functions

_new
TextureProgress _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta