TextureProgress

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

TextureProgress works like ProgressBar, but uses up to 3 textures instead of Godot's Theme resource. It can be used to create horizontal, vertical and radial progress bars.

@GodotBaseClass

struct TextureProgress {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(TextureProgress other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static TextureProgress _new();

enum Constants;

double getFillDegrees();

long getFillMode();

bool getNinePatchStretch();

Ref!Texture getOverTexture();

Ref!Texture getProgressTexture();

Vector2 getRadialCenterOffset();

double getRadialInitialAngle();

long getStretchMargin(long margin);

Color getTintOver();

Color getTintProgress();

Color getTintUnder();

Ref!Texture getUnderTexture();

void setFillDegrees(double mode);

void setFillMode(long mode);

void setNinePatchStretch(bool stretch);

void setOverTexture(Texture tex);

void setProgressTexture(Texture tex);

void setRadialCenterOffset(Vector2 mode);

void setRadialInitialAngle(double mode);

void setStretchMargin(long margin, long value);

void setTintOver(Color tint);

void setTintProgress(Color tint);

void setTintUnder(Color tint);

void setUnderTexture(Texture tex);

long fillMode [@property getter];

long fillMode [@property setter];

bool ninePatchStretch [@property getter];

bool ninePatchStretch [@property setter];

Vector2 radialCenterOffset [@property getter];

Vector2 radialCenterOffset [@property setter];

double radialFillDegrees [@property getter];

double radialFillDegrees [@property setter];

double radialInitialAngle [@property getter];

double radialInitialAngle [@property setter];

long stretchMarginBottom [@property getter];

long stretchMarginBottom [@property setter];

long stretchMarginLeft [@property getter];

long stretchMarginLeft [@property setter];

long stretchMarginRight [@property getter];

long stretchMarginRight [@property setter];

long stretchMarginTop [@property getter];

long stretchMarginTop [@property setter];

Texture textureOver [@property getter];

Texture textureOver [@property setter];

Texture textureProgress [@property getter];

Texture textureProgress [@property setter];

Texture textureUnder [@property getter];

Texture textureUnder [@property setter];

Color tintOver [@property getter];

Color tintOver [@property setter];

Color tintProgress [@property getter];

Color tintProgress [@property setter];

Color tintUnder [@property getter];

Color tintUnder [@property setter];

}

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 typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(TextureProgress other)
opEquals bool opEquals(typeof(null) n)
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)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

fillMode long fillMode [@property getter]
long fillMode [@property setter]: The fill direction. See fillmode for possible values.
ninePatchStretch bool ninePatchStretch [@property getter]
bool ninePatchStretch [@property setter]: If true, Godot treats the bar's textures like in NinePatchRect. Use the stretch_margin_* properties like stretchMarginBottom to set up the nine patch's 3×3 grid. When using a radial fillMode, this setting will enable stretching.
radialCenterOffset Vector2 radialCenterOffset [@property getter]
Vector2 radialCenterOffset [@property setter]: Offsets textureProgress if fillMode is constant FILL_CLOCKWISE or constant FILL_COUNTER_CLOCKWISE.
radialFillDegrees double radialFillDegrees [@property getter]
double radialFillDegrees [@property setter]: Upper limit for the fill of textureProgress if fillMode is constant FILL_CLOCKWISE or constant 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 constant FILL_CLOCKWISE or constant 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(): Construct a new instance of TextureProgress. Note: use memnew!TextureProgress instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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

Source

See Implementation

godot textureprogress structs

TextureProgress