Struct gdnative::api::TextureProgress

pub struct TextureProgress { /* fields omitted */ }

core class TextureProgress inherits Range (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

TextureProgress is a reference-only type. Persistent references can only exist in the unsafe Ref<TextureProgress> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

TextureProgress inherits methods from:

• Range
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl TextureProgress

Constants

pub const FILL_BILINEAR_LEFT_AND_RIGHT: i64

pub const FILL_BILINEAR_TOP_AND_BOTTOM: i64

pub const FILL_BOTTOM_TO_TOP: i64

pub const FILL_CLOCKWISE: i64

pub const FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE: i64

pub const FILL_COUNTER_CLOCKWISE: i64

pub const FILL_LEFT_TO_RIGHT: i64

pub const FILL_RIGHT_TO_LEFT: i64

pub const FILL_TOP_TO_BOTTOM: i64

impl TextureProgress

pub fn new() -> Ref<TextureProgress, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn fill_degrees(&self) -> f64

Upper limit for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]max_value[/code], the texture fills up to this angle.
			See [member Range.value], [member Range.max_value].

pub fn fill_mode(&self) -> i64

The fill direction. See [enum FillMode] for possible values.

pub fn nine_patch_stretch(&self) -> bool

If [code]true[/code], Godot treats the bar's textures like in [NinePatchRect]. Use the [code]stretch_margin_*[/code] properties like [member stretch_margin_bottom] to set up the nine patch's 3×3 grid. When using a radial [member fill_mode], this setting will enable stretching.

pub fn over_texture(&self) -> Option<Ref<Texture, Shared>>

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

pub fn progress_texture(&self) -> Option<Ref<Texture, Shared>>

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

pub fn radial_center_offset(&self) -> Vector2D<f32, UnknownUnit>

Offsets [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE].

pub fn radial_initial_angle(&self) -> f64

Starting angle for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]min_value[/code], the texture doesn't show up at all. When the [code]value[/code] increases, the texture fills and tends towards [member radial_fill_degrees].

pub fn stretch_margin(&self, margin: i64) -> i64

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

pub fn tint_over(&self) -> Color

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

pub fn tint_progress(&self) -> Color

Multiplies the color of the bar's [code]texture_progress[/code] texture.

pub fn tint_under(&self) -> Color

Multiplies the color of the bar's [code]texture_under[/code] texture.

pub fn under_texture(&self) -> Option<Ref<Texture, Shared>>

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

pub fn set_fill_degrees(&self, mode: f64)

Upper limit for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]max_value[/code], the texture fills up to this angle.
			See [member Range.value], [member Range.max_value].

pub fn set_fill_mode(&self, mode: i64)

The fill direction. See [enum FillMode] for possible values.

pub fn set_nine_patch_stretch(&self, stretch: bool)

If [code]true[/code], Godot treats the bar's textures like in [NinePatchRect]. Use the [code]stretch_margin_*[/code] properties like [member stretch_margin_bottom] to set up the nine patch's 3×3 grid. When using a radial [member fill_mode], this setting will enable stretching.

pub fn set_over_texture(&self, tex: impl AsArg<Texture>)

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

pub fn set_progress_texture(&self, tex: impl AsArg<Texture>)

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

pub fn set_radial_center_offset(&self, mode: Vector2D<f32, UnknownUnit>)

Offsets [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE].

pub fn set_radial_initial_angle(&self, mode: f64)

Starting angle for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]min_value[/code], the texture doesn't show up at all. When the [code]value[/code] increases, the texture fills and tends towards [member radial_fill_degrees].

pub fn set_stretch_margin(&self, margin: i64, value: i64)

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

pub fn set_tint_over(&self, tint: Color)

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

pub fn set_tint_progress(&self, tint: Color)

Multiplies the color of the bar's [code]texture_progress[/code] texture.

pub fn set_tint_under(&self, tint: Color)

Multiplies the color of the bar's [code]texture_under[/code] texture.

pub fn set_under_texture(&self, tex: impl AsArg<Texture>)

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

Methods from Deref<Target = Range>

pub fn as_ratio(&self) -> f64

The value mapped between 0 and 1.

pub fn max(&self) -> f64

Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].

pub fn min(&self) -> f64

Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].

pub fn page(&self) -> f64

Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].

pub fn step(&self) -> f64

If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.

pub fn value(&self) -> f64

Range's current value.

pub fn is_greater_allowed(&self) -> bool

If [code]true[/code], [member value] may be greater than [member max_value].

pub fn is_lesser_allowed(&self) -> bool

If [code]true[/code], [member value] may be less than [member min_value].

pub fn is_ratio_exp(&self) -> bool

If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.

pub fn is_using_rounded_values(&self) -> bool

If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.

pub fn set_allow_greater(&self, allow: bool)

If [code]true[/code], [member value] may be greater than [member max_value].

pub fn set_allow_lesser(&self, allow: bool)

If [code]true[/code], [member value] may be less than [member min_value].

pub fn set_as_ratio(&self, value: f64)

The value mapped between 0 and 1.

pub fn set_exp_ratio(&self, enabled: bool)

If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.

pub fn set_max(&self, maximum: f64)

Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].

pub fn set_min(&self, minimum: f64)

Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].

pub fn set_page(&self, pagesize: f64)

Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].

pub fn set_step(&self, step: f64)

If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.

pub fn set_use_rounded_values(&self, enabled: bool)

If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.

pub fn set_value(&self, value: f64)

Range's current value.

pub fn share(&self, with: impl AsArg<Node>)

Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group.

pub fn unshare(&self)

Stops range from sharing its member variables with any other.

Trait Implementations

impl Debug for TextureProgress

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TextureProgress

type Target = Range

The resulting type after dereferencing.

fn deref(&self) -> &Range

Dereferences the value.

impl DerefMut for TextureProgress

fn deref_mut(&mut self) -> &mut Range

Mutably dereferences the value.

impl GodotObject for TextureProgress

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for TextureProgress

fn construct() -> Ref<TextureProgress, Unique>

impl QueueFree for TextureProgress

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for TextureProgress

impl SubClass<Control> for TextureProgress

impl SubClass<Node> for TextureProgress

impl SubClass<Object> for TextureProgress

impl SubClass<Range> for TextureProgress