Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
TransformFormat
MultiMesh.swift:24enum TransformFormatCases
case transform2dUse this when using 2D transforms.
case transform3dUse this when using 3D transforms.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (17) members.
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.
Citizens in SwiftGodot
Conformances
protocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
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 RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: StringA textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.