Struct gdnative_bindings_lily::StyleBoxFlat

pub struct StyleBoxFlat { /* fields omitted */ }

core class StyleBoxFlat inherits StyleBox (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

Class hierarchy

StyleBoxFlat 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 StyleBoxFlat

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

Creates a new instance of this object.

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

pub fn aa_size(&self) -> i64

This changes the size of the faded ring. Higher values can be used to achieve a “blurry” effect.

pub fn bg_color(&self) -> Color

The background color of the stylebox.

pub fn border_blend(&self) -> bool

If true, the border will fade into the background color.

pub fn border_color(&self) -> Color

Sets the color of the border.

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

Border width for the top border.

pub fn get_border_width_min(&self) -> i64

Returns the smallest border width out of all four borders.

pub fn corner_detail(&self) -> i64

This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius ([method set_corner_radius_all]) into account. For corner radii smaller than 10, 4 or 5 should be enough. For corner radii smaller than 30, values between 8 and 12 should be enough. A corner detail of 1 will result in chamfered corners instead of rounded corners, which is useful for some artistic effects.

pub fn corner_radius(&self, corner: i64) -> i64

The top-right corner’s radius. If 0, the corner is not rounded.

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

Expands the stylebox outside of the control rect on the top edge. Useful in combination with [member border_width_top] to draw a border outside the control rect.

pub fn shadow_color(&self) -> Color

The color of the shadow. This has no effect if [member shadow_size] is lower than 1.

pub fn shadow_offset(&self) -> Vector2

The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox.

pub fn shadow_size(&self) -> i64

The shadow size in pixels.

pub fn is_anti_aliased(&self) -> bool

Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners.

pub fn is_draw_center_enabled(&self) -> bool

Toggles drawing of the inner part of the stylebox.

pub fn set_aa_size(&self, size: i64)

This changes the size of the faded ring. Higher values can be used to achieve a “blurry” effect.

pub fn set_anti_aliased(&self, anti_aliased: bool)

Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners.

pub fn set_bg_color(&self, color: Color)

The background color of the stylebox.

pub fn set_border_blend(&self, blend: bool)

If true, the border will fade into the background color.

pub fn set_border_color(&self, color: Color)

Sets the color of the border.

pub fn set_border_width(&self, margin: i64, width: i64)

Border width for the top border.

pub fn set_border_width_all(&self, width: i64)

Sets the border width to width pixels for all margins.

pub fn set_corner_detail(&self, detail: i64)

This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius ([method set_corner_radius_all]) into account. For corner radii smaller than 10, 4 or 5 should be enough. For corner radii smaller than 30, values between 8 and 12 should be enough. A corner detail of 1 will result in chamfered corners instead of rounded corners, which is useful for some artistic effects.

pub fn set_corner_radius(&self, corner: i64, radius: i64)

The top-right corner’s radius. If 0, the corner is not rounded.

pub fn set_corner_radius_all(&self, radius: i64)

Sets the corner radius to radius pixels for all corners.

pub fn set_corner_radius_individual(
    &self,
    radius_top_left: i64,
    radius_top_right: i64,
    radius_bottom_right: i64,
    radius_bottom_left: i64
)

Sets the corner radius for each corner to radius_top_left, radius_top_right, radius_bottom_right, and radius_bottom_left pixels.

pub fn set_draw_center(&self, draw_center: bool)

Toggles drawing of the inner part of the stylebox.

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

Expands the stylebox outside of the control rect on the top edge. Useful in combination with [member border_width_top] to draw a border outside the control rect.

pub fn set_expand_margin_all(&self, size: f64)

Sets the expand margin to size 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 size_left, size_top, size_right, and size_bottom pixels.

pub fn set_shadow_color(&self, color: Color)

The color of the shadow. This has no effect if [member shadow_size] is lower than 1.

pub fn set_shadow_offset(&self, offset: Vector2)

The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox.

pub fn set_shadow_size(&self, size: i64)

The shadow size in pixels.

Methods from Deref<Target = StyleBox>

pub fn draw(&self, canvas_item: Rid, rect: Rect2)

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) -> Vector2

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) -> Vector2

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

pub fn get_offset(&self) -> Vector2

Returns the “offset” of a stylebox. This helper function returns a value equivalent to Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP)).

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: Vector2, rect: Rect2) -> bool

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

Trait Implementations

impl Debug for StyleBoxFlat

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

Formats the value using the given formatter.

impl Deref for StyleBoxFlat

type Target = StyleBox

The resulting type after dereferencing.

fn deref(&self) -> &StyleBox

Dereferences the value.

impl DerefMut for StyleBoxFlat

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

Mutably dereferences the value.

impl GodotObject for StyleBoxFlat

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for StyleBoxFlat

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

impl Sealed for StyleBoxFlat

impl SubClass<Object> for StyleBoxFlat

impl SubClass<Reference> for StyleBoxFlat

impl SubClass<Resource> for StyleBoxFlat

impl SubClass<StyleBox> for StyleBoxFlat