Struct gdnative::api::StyleBoxTexture

pub struct StyleBoxTexture { /* fields omitted */ }

core class StyleBoxTexture inherits StyleBox (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

StyleBoxTexture inherits methods from:

• StyleBox
• Resource
• Reference
• 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 StyleBoxTexture

Constants

pub const AXIS_STRETCH_MODE_STRETCH: i64

pub const AXIS_STRETCH_MODE_TILE: i64

pub const AXIS_STRETCH_MODE_TILE_FIT: i64

impl StyleBoxTexture

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

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

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

pub fn h_axis_stretch_mode(&self) -> AxisStretchMode

Controls how the stylebox's texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.

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

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 [member StyleBox.content_margin_top] if it is negative.

pub fn modulate(&self) -> Color

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

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

The normal map to use when drawing this style box.
			[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.

pub fn region_rect(&self) -> Rect<f32, UnknownUnit>

Species a sub-region of the texture to use.
			This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.

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

The texture to use when drawing this style box.

pub fn v_axis_stretch_mode(&self) -> AxisStretchMode

Controls how the stylebox's texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.

pub fn is_draw_center_enabled(&self) -> bool

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

pub fn set_draw_center(&self, enable: bool)

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

pub fn set_expand_margin_all(&self, size: f64)

Sets the expand margin to [code]size[/code] pixels for all margins.

pub fn set_expand_margin_individual(
    &self,
    size_left: f64,
    size_top: f64,
    size_right: f64,
    size_bottom: f64
)

Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels.

pub fn set_expand_margin_size(&self, margin: i64, size: f64)

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

pub fn set_h_axis_stretch_mode(&self, mode: i64)

Controls how the stylebox's texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.

pub fn set_margin_size(&self, margin: i64, size: f64)

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 [member StyleBox.content_margin_top] if it is negative.

pub fn set_modulate(&self, color: Color)

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

pub fn set_normal_map(&self, normal_map: impl AsArg<Texture>)

The normal map to use when drawing this style box.
			[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.

pub fn set_region_rect(&self, region: Rect<f32, UnknownUnit>)

Species a sub-region of the texture to use.
			This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.

pub fn set_texture(&self, texture: impl AsArg<Texture>)

The texture to use when drawing this style box.

pub fn set_v_axis_stretch_mode(&self, mode: i64)

Controls how the stylebox's texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.

Methods from Deref<Target = StyleBox>

pub fn draw(&self, canvas_item: Rid, rect: Rect<f32, UnknownUnit>)

Draws this stylebox using a [CanvasItem] with given [RID].
				You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node.

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

Returns the size of this [StyleBox] without the margins.

pub fn get_current_item_drawn(&self) -> Option<Ref<CanvasItem, Shared>>

Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.

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

The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top.
			Refer to [member content_margin_bottom] for extra considerations.

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

Returns the content margin offset for the specified [enum Margin].
				Positive values reduce size inwards, unlike [Control]'s margin values.

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

Returns the minimum size that this stylebox can be shrunk to.

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

Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].

pub fn set_default_margin(&self, margin: i64, offset: f64)

The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top.
			Refer to [member content_margin_bottom] for extra considerations.

pub fn test_mask(
    &self,
    point: Vector2D<f32, UnknownUnit>,
    rect: Rect<f32, UnknownUnit>
) -> bool

Test a position in a rectangle, return whether it passes the mask test.

Trait Implementations

impl Debug for StyleBoxTexture

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

Formats the value using the given formatter.

impl Deref for StyleBoxTexture

type Target = StyleBox

The resulting type after dereferencing.

fn deref(&self) -> &StyleBox

Dereferences the value.

impl DerefMut for StyleBoxTexture

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

Mutably dereferences the value.

impl GodotObject for StyleBoxTexture

type RefKind = RefCounted

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 StyleBoxTexture

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

impl SubClass<Object> for StyleBoxTexture

impl SubClass<Reference> for StyleBoxTexture

impl SubClass<Resource> for StyleBoxTexture

impl SubClass<StyleBox> for StyleBoxTexture