Struct gdnative_bindings_lily::StyleBoxTexture [−][src]
pub struct StyleBoxTexture { /* fields omitted */ }
Expand description
core class StyleBoxTexture
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
StyleBoxTexture inherits methods from:
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
Constants
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.
Controls how the stylebox’s texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.
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.
Modulates the color of the texture when this style box is drawn.
The normal map to use when drawing this style box. Note: 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.
Species a sub-region of the texture to use. This is equivalent to first wrapping the texture in an AtlasTexture with the same region.
The texture to use when drawing this style box.
Controls how the stylebox’s texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.
If true
, the nine-patch texture’s center tile will be drawn.
If true
, the nine-patch texture’s center tile will be drawn.
Sets the expand margin to size
pixels for all margins.
Sets the expand margin for each margin to size_left
, size_top
, size_right
, and size_bottom
pixels.
Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.
Controls how the stylebox’s texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.
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.
Modulates the color of the texture when this style box is drawn.
The normal map to use when drawing this style box. Note: 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.
Species a sub-region of the texture to use. This is equivalent to first wrapping the texture in an AtlasTexture with the same region.
The texture to use when drawing this style box.
Controls how the stylebox’s texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.
Methods from Deref<Target = StyleBox>
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.
Returns the size of this StyleBox without the margins.
Returns the CanvasItem that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.
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.
Returns the content margin offset for the specified [enum Margin]. Positive values reduce size inwards, unlike Control’s margin values.
Returns the minimum size that this stylebox can be shrunk to.
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))
.
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.
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for StyleBoxTexture
impl !Send for StyleBoxTexture
impl !Sync for StyleBoxTexture
impl Unpin for StyleBoxTexture
impl UnwindSafe for StyleBoxTexture