Header menu logo Mibo

SpriteHelpers Module

Provides low-level functional helpers for creating Sprite3D primitives without using computation expressions.

Functions and values

Function or value Description

billboard3D position size

Full Usage: billboard3D position size

Parameters:
Returns: Billboard3D
Modifiers: inline

Creates a Billboard3D that will automatically face the active camera. Common uses include particle effects, glow maps, and distance-scaled icons.

position : Vector3
size : Vector2
Returns: Billboard3D

cylindrical upAxis b

Full Usage: cylindrical upAxis b

Parameters:
Returns: Billboard3D
Modifiers: inline

Configures the billboard to only rotate around a fixed world-space up axis. Essential for "cylindrical" objects like trees or grass that should face the camera but remain planted on the ground.

upAxis : Vector3
b : Billboard3D
Returns: Billboard3D

quad3D center right up

Full Usage: quad3D center right up

Parameters:
    center : Vector3 - World-space center of the quad.
    right : Vector3 - Vector representing half-width orientation.
    up : Vector3 - Vector representing half-height orientation.

Returns: Quad3D
Modifiers: inline

Creates a raw Quad3D definition from basis vectors.

center : Vector3

World-space center of the quad.

right : Vector3

Vector representing half-width orientation.

up : Vector3

Vector representing half-height orientation.

Returns: Quad3D

quadOnXY center size

Full Usage: quadOnXY center size

Parameters:
Returns: Quad3D
Modifiers: inline

Creates a Quad3D standing on the XY plane. Ideal for in-world signs, nameplates, or simple wall-mounted elements.

center : Vector3
size : Vector2
Returns: Quad3D

quadOnXZ center size

Full Usage: quadOnXZ center size

Parameters:
Returns: Quad3D
Modifiers: inline

Creates a Quad3D lying flat on the XZ plane. Ideal for ground decals, floor markers, or flat environmental details.

center : Vector3
size : Vector2
Returns: Quad3D

withBillboardColor color b

Full Usage: withBillboardColor color b

Parameters:
Returns: Billboard3D
Modifiers: inline

Applies a multiplicative color tint to the billboard.

color : Color
b : Billboard3D
Returns: Billboard3D

withBillboardRotation rotation b

Full Usage: withBillboardRotation rotation b

Parameters:
Returns: Billboard3D
Modifiers: inline

Sets the roll rotation of the billboard around its forward-facing axis.

rotation : float32
b : Billboard3D
Returns: Billboard3D

withBillboardUv uv b

Full Usage: withBillboardUv uv b

Parameters:
Returns: Billboard3D
Modifiers: inline

Assigns specific UV coordinates to the billboard.

uv : UvRect
b : Billboard3D
Returns: Billboard3D

withQuadColor color q

Full Usage: withQuadColor color q

Parameters:
Returns: Quad3D
Modifiers: inline

Applies a multiplicative color tint to the quad's vertices.

color : Color
q : Quad3D
Returns: Quad3D

withQuadUv uv q

Full Usage: withQuadUv uv q

Parameters:
Returns: Quad3D
Modifiers: inline

Sets specific UV coordinates for the quad, allowing the use of texture atlases.

uv : UvRect
q : Quad3D
Returns: Quad3D

Type something to start searching.