Struct gdnative_bindings_lily::MultiMeshInstance[][src]

pub struct MultiMeshInstance { /* fields omitted */ }
Expand description

core class MultiMeshInstance inherits GeometryInstance (unsafe).

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

Non reference counted objects such as the ones of this type are usually owned by the engine.

MultiMeshInstance is a reference-only type. Persistent references can only exist in the unsafe Ref<MultiMeshInstance> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

MultiMeshInstance 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

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

The MultiMesh resource that will be used and shared among all instances of the MultiMeshInstance.

The MultiMesh resource that will be used and shared among all instances of the MultiMeshInstance.

Methods from Deref<Target = GeometryInstance>

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

The extra distance added to the GeometryInstance’s bounding box ([AABB]) to increase its cull box.

If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap.

The GeometryInstance’s max LOD distance. Note: This property currently has no effect.

The GeometryInstance’s max LOD margin. Note: This property currently has no effect.

The GeometryInstance’s min LOD distance. Note: This property currently has no effect.

The GeometryInstance’s min LOD margin. Note: This property currently has no effect.

The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.

The extra distance added to the GeometryInstance’s bounding box ([AABB]) to increase its cull box.

If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap.

The GeometryInstance’s max LOD distance. Note: This property currently has no effect.

The GeometryInstance’s max LOD margin. Note: This property currently has no effect.

The GeometryInstance’s min LOD distance. Note: This property currently has no effect.

The GeometryInstance’s min LOD margin. Note: This property currently has no effect.

The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

Trait Implementations

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information. Read more

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

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

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. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.