MultiMesh
Provides high-performance drawing of a mesh multiple times using GPU instancing.
MultiMesh.swift:22class MultiMeshMultiMesh provides low-level mesh instancing. Drawing thousands of MeshInstance3D nodes can be slow, since each object is submitted to the GPU then drawn individually.
MultiMesh is much faster as it can draw thousands of instances with a single draw call, resulting in less API overhead.
As a drawback, if the instances are too far away from each other, performance may be reduced as every single instance will always render (they are spatially indexed as one, for the whole object).
Since instances may have any behavior, the AABB used for visibility must be provided by the user.
Superclasses
class ResourceBase class for serializable objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Types
Type members
Instance members
var buffer: PackedFloat32Arrayvar instanceCount: Int32Number of instances that will get drawn. This clears and (re)sizes the buffers. Setting data format or flags afterwards will have no effect.
var mesh: Mesh?Meshresource to be instanced.var transformFormat: MultiMesh.TransformFormatFormat of transform used to transform mesh, either 2D or 3D.
var useColors: BoolIf
true, theMultiMeshwill use color data (seesetInstanceColor(instance:color:)). Can only be set wheninstanceCountis0or less. This means that you need to call this method before setting the instance count, or temporarily reset it to0.var useCustomData: BoolIf
true, theMultiMeshwill use custom data (seesetInstanceCustomData(instance:customData:)). Can only be set wheninstanceCountis0or less. This means that you need to call this method before setting the instance count, or temporarily reset it to0.var visibleInstanceCount: Int32Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers.
func getAabb() -> AABB Returns the visibility axis-aligned bounding box in local space.
func getInstanceColor(instance: Int32) -> Color Gets a specific instance’s color multiplier.
func getInstanceCustomData(instance: Int32) -> Color Returns the custom data that has been set for a specific instance.
func getInstanceTransform(instance: Int32) -> Transform3D Returns the
Transform3Dof a specific instance.func getInstanceTransform2d(instance: Int32) -> Transform2D Returns the
Transform2Dof a specific instance.func setInstanceColor(instance: Int32, color: Color) Sets the color of a specific instance by multiplying the mesh’s existing vertex colors. This allows for different color tinting per instance.
func setInstanceCustomData(instance: Int32, customData: Color) Sets custom data for a specific instance. Although
Coloris used, it is just a container for 4 floating point numbers.func setInstanceTransform(instance: Int32, transform: Transform3D) Sets the
Transform3Dfor a specific instance.func setInstanceTransform2d(instance: Int32, transform: Transform2D) Sets the
Transform2Dfor a specific instance.