Struct gdnative_bindings::MultiMesh

pub struct MultiMesh { /* fields omitted */ }

core class MultiMesh 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

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

Constants

pub const COLOR_8BIT: i64

pub const COLOR_FLOAT: i64

pub const COLOR_NONE: i64

pub const CUSTOM_DATA_8BIT: i64

pub const CUSTOM_DATA_FLOAT: i64

pub const CUSTOM_DATA_NONE: i64

pub const TRANSFORM_2D: i64

pub const TRANSFORM_3D: i64

impl MultiMesh

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

Returns the visibility axis-aligned bounding box in local space. See also [method VisualInstance.get_transformed_aabb].

pub fn color_format(&self) -> ColorFormat

Format of colors in color array that gets passed to shader.

pub fn custom_data_format(&self) -> CustomDataFormat

Format of custom data in custom data array that gets passed to shader.

pub fn get_instance_color(&self, instance: i64) -> Color

Gets a specific instance's color.

pub fn instance_count(&self) -> i64

Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with [member visible_instance_count].

pub fn get_instance_custom_data(&self, instance: i64) -> Color

Returns the custom data that has been set for a specific instance.

pub fn get_instance_transform(&self, instance: i64) -> Transform

Returns the [Transform] of a specific instance.

pub fn get_instance_transform_2d(&self, instance: i64) -> Transform2D

Returns the [Transform2D] of a specific instance.

pub fn mesh(&self) -> Option<Ref<Mesh, Shared>>

Mesh to be drawn.

pub fn transform_format(&self) -> TransformFormat

Format of transform used to transform mesh, either 2D or 3D.

pub fn visible_instance_count(&self) -> i64

Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers.

pub fn set_as_bulk_array(&self, array: Float32Array)

Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
				All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc...
				[Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, [code]COLOR_8BIT[/code] / [code]CUSTOM_DATA_8BIT[/code] is stored as 1 float (4 bytes as is) and [code]COLOR_FLOAT[/code] / [code]CUSTOM_DATA_FLOAT[/code] is stored as 4 floats.

pub fn set_color_format(&self, format: i64)

Format of colors in color array that gets passed to shader.

pub fn set_custom_data_format(&self, format: i64)

Format of custom data in custom data array that gets passed to shader.

pub fn set_instance_color(&self, instance: i64, color: Color)

Sets the color of a specific instance.
				For the color to take effect, ensure that [member color_format] is non-[code]null[/code] on the [MultiMesh] and [member SpatialMaterial.vertex_color_use_as_albedo] is [code]true[/code] on the material.

pub fn set_instance_count(&self, count: i64)

Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with [member visible_instance_count].

pub fn set_instance_custom_data(&self, instance: i64, custom_data: Color)

Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. The format of the number can change depending on the [enum CustomDataFormat] used.

pub fn set_instance_transform(&self, instance: i64, transform: Transform)

Sets the [Transform] for a specific instance.

pub fn set_instance_transform_2d(&self, instance: i64, transform: Transform2D)

Sets the [Transform2D] for a specific instance.

pub fn set_mesh(&self, mesh: impl AsArg<Mesh>)

Mesh to be drawn.

pub fn set_transform_format(&self, format: i64)

Format of transform used to transform mesh, either 2D or 3D.

pub fn set_visible_instance_count(&self, count: i64)

Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers.

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 MultiMesh

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

Formats the value using the given formatter.

impl Deref for MultiMesh

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for MultiMesh

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

Mutably dereferences the value.

impl GodotObject for MultiMesh

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 MultiMesh

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

impl Sealed for MultiMesh

impl SubClass<Object> for MultiMesh

impl SubClass<Reference> for MultiMesh

impl SubClass<Resource> for MultiMesh