Struct gdnative_bindings::Theme

pub struct Theme { /* fields omitted */ }

core class Theme inherits Resource (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

Theme inherits methods from:

• 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 Theme

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 clear(&self)

Clears all values on the theme.

pub fn clear_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
)

Clears the [Color] at [code]name[/code] if the theme has [code]type[/code].

pub fn clear_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
)

Clears the constant at [code]name[/code] if the theme has [code]type[/code].

pub fn clear_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
)

Clears the [Font] at [code]name[/code] if the theme has [code]type[/code].

pub fn clear_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
)

Clears the icon at [code]name[/code] if the theme has [code]type[/code].

pub fn clear_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
)

Clears [StyleBox] at [code]name[/code] if the theme has [code]type[/code].

pub fn copy_default_theme(&self)

Sets the theme's values to a copy of the default theme values.

pub fn copy_theme(&self, other: impl AsArg<Theme>)

Sets the theme's values to a copy of a given theme.

pub fn get_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Color

Returns the [Color] at [code]name[/code] if the theme has [code]type[/code].

pub fn get_color_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].

pub fn get_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> i64

Returns the constant at [code]name[/code] if the theme has [code]type[/code].

pub fn get_constant_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].

pub fn default_font(&self) -> Option<Ref<Font, Shared>>

The theme's default font.

pub fn get_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<Font, Shared>>

Returns the [Font] at [code]name[/code] if the theme has [code]type[/code].

pub fn get_font_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].

pub fn get_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<Texture, Shared>>

Returns the icon [Texture] at [code]name[/code] if the theme has [code]type[/code].

pub fn get_icon_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]type[/code].

pub fn get_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<StyleBox, Shared>>

Returns the icon [StyleBox] at [code]name[/code] if the theme has [code]type[/code].

pub fn get_stylebox_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].

pub fn get_stylebox_types(&self) -> StringArray

Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].

pub fn get_type_list(&self, _type: impl Into<GodotString>) -> StringArray

Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].

pub fn has_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
				Returns [code]false[/code] if the theme does not have [code]type[/code].

pub fn has_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
				Returns [code]false[/code] if the theme does not have [code]type[/code].

pub fn has_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
				Returns [code]false[/code] if the theme does not have [code]type[/code].

pub fn has_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code].
				Returns [code]false[/code] if the theme does not have [code]type[/code].

pub fn has_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
				Returns [code]false[/code] if the theme does not have [code]type[/code].

pub fn set_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>,
    color: Color
)

Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
				Does nothing if the theme does not have [code]type[/code].

pub fn set_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>,
    constant: i64
)

Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
				Does nothing if the theme does not have [code]type[/code].

pub fn set_default_font(&self, font: impl AsArg<Font>)

The theme's default font.

pub fn set_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>,
    font: impl AsArg<Font>
)

Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
				Does nothing if the theme does not have [code]type[/code].

pub fn set_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>,
    texture: impl AsArg<Texture>
)

Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
				Does nothing if the theme does not have [code]type[/code].

pub fn set_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>,
    texture: impl AsArg<StyleBox>
)

Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
				Does nothing if the theme does not have [code]type[/code].

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
				[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.

Default Arguments

• subresources - false

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code].

pub fn name(&self) -> GodotString

The name of the resource. This is an optional identifier.

pub fn path(&self) -> GodotString

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn get_rid(&self) -> Rid

Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID.

pub fn is_local_to_scene(&self) -> bool

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_local_to_scene(&self, enable: bool)

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_name(&self, name: impl Into<GodotString>)

The name of the resource. This is an optional identifier.

pub fn set_path(&self, path: impl Into<GodotString>)

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn setup_local_to_scene(&self)

This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script.
				For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport.

pub fn take_over_path(&self, path: impl Into<GodotString>)

Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.

Trait Implementations

impl Debug for Theme

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

Formats the value using the given formatter.

impl Deref for Theme

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Theme

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

Mutably dereferences the value.

impl GodotObject for Theme

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 Theme

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

impl Sealed for Theme

impl SubClass<Object> for Theme

impl SubClass<Reference> for Theme

impl SubClass<Resource> for Theme