Mesh¶

Description¶

Mesh is the base class for all renderable 3D objects. It exposes the material system (color, texture, PBR material), shadow casting and receiving, transparency control, face culling, and GPU instancing for drawing thousands of objects in a single draw call.

Inherits: Object → EntityHandle

#include "Doriax.h"
using namespace doriax;

Mesh mesh(&scene);
mesh.setTexture("textures/crate.png");
mesh.setColor(1.0f, 1.0f, 1.0f, 1.0f);
mesh.setCastShadows(true);

local mesh = Mesh(scene)
mesh:setTexture("textures/crate.png")
mesh:setColor(1, 1, 1, 1)
mesh.castShadows = true

Properties¶

Methods¶

Enumerations¶

PrimitiveType¶

• TRIANGLES — Solid triangle meshes (default).
• TRIANGLE_STRIP — Triangle strip.
• POINTS — Renders each vertex as a point.
• LINES — Renders edges as lines.

CullingMode¶

• BACK — Culls back faces (default, outward-facing normals).
• FRONT — Culls front faces (useful for inside-out rendering).

WindingOrder¶

• CCW — Counter-clockwise winding defines the front face (OpenGL convention, default).
• CW — Clockwise winding defines the front face.

Property details¶

color¶

• Setter: void setColor(Vector4 color)
• Setter: void setColor(float red, float green, float blue, float alpha)
• Setter: void setColor(float red, float green, float blue)
• Getter: Vector4 getColor() const

Tint color multiplied with the material texture. (1,1,1,1) means no tint.

alpha¶

• Setter: void setAlpha(float alpha)
• Getter: float getAlpha() const

Shorthand for the alpha channel of color. Values below 1.0 require transparent to be enabled for correct rendering order.

material¶

• Setter: void setMaterial(const Material& material) (all submeshes)
• Setter: void setMaterial(unsigned int submesh, const Material& material) (per submesh)
• Getter: Material getMaterial() const
• Getter: Material getMaterial(unsigned int submesh) const

PBR material descriptor. Contains base color, metallic/roughness factors, normal map, emissive settings, and shader overrides.

primitiveType¶

• Setter: void setPrimitiveType(PrimitiveType primitiveType)
• Getter: PrimitiveType getPrimitiveType() const

GPU draw mode. Overloads are available per submesh.

faceCulling¶

• Setter: void setFaceCulling(bool faceCulling)
• Getter: bool isFaceCulling() const

Enables or disables back-face culling globally for this mesh. Disable for double-sided geometry (e.g. leaves, cards).

castShadows / receiveShadows¶

• Setter: void setCastShadows(bool castShadows) / void setReceiveShadows(bool receiveShadows)
• Getter: bool isCastShadows() const / bool isReceiveShadows() const

Shadow participation flags. Enabling both adds depth-map cost; disable on distant or small objects for performance.

transparent / autoTransparency¶

• transparent Setter: void setTransparent(bool transparent)
• autoTransparency Setter: void setAutoTransparency(bool autoTransparency)

transparent marks the mesh for the transparent render pass (sorted back-to-front). autoTransparency detects transparency from the material and enables the transparent pass automatically.

Method details¶

load¶

• bool load()

Uploads geometry and material resources to the GPU. Must be called after building or modifying geometry programmatically. Subclasses like Sprite call this internally when needed.

setTexture¶

• void setTexture(const std::string& path)
• void setTexture(const std::string& id, TextureData data)
• void setTexture(Framebuffer* framebuffer)

Assigns the diffuse/base-color texture. Accepts a file path, raw TextureData, or a framebuffer render target.

mesh.setTexture("textures/stone.png");
// or use a render-to-texture framebuffer:
Camera cam(&scene);
cam.setRenderToTexture(true);
mesh.setTexture(cam.getFramebuffer());

mesh:setTexture("textures/stone.png")

getAABB / getVerticesAABB / getWorldAABB¶

• AABB getAABB() const — Axis-aligned bounding box of the mesh in local space.
• AABB getVerticesAABB() const — AABB computed from raw vertex positions, ignoring the transform.
• AABB getWorldAABB() const — AABB in world space after applying the full transform chain.

Useful for frustum culling, click picking, and physics proxy fitting.

getNumSubmeshes¶

• unsigned int getNumSubmeshes() const

Returns the number of submeshes. Each submesh can have its own material, primitive type, and culling settings.

createInstancedMesh¶

• void createInstancedMesh()

Enables GPU instancing for this mesh. After calling this, use addInstance / updateInstance to populate the instance list, then updateInstances to flush changes to the GPU.

Mesh tree(&scene);
tree.setTexture("textures/tree.png");
tree.createInstancedMesh();
tree.setMaxInstances(500);

for (int i = 0; i < 500; i++) {
    tree.addInstance(Vector3(i * 2.0f, 0.0f, 0.0f));
}
tree.updateInstances();

local tree = Mesh(scene)
tree:setTexture("textures/tree.png")
tree:createInstancedMesh()
tree:setMaxInstances(500)

for i = 0, 499 do
    tree:addInstance(Vector3(i * 2, 0, 0))
end
tree:updateInstances()

addInstance¶

• void addInstance(InstanceData instance)
• void addInstance(Vector3 position)
• void addInstance(float x, float y, float z)
• void addInstance(Vector3 position, Quaternion rotation, Vector3 scale)
• void addInstance(Vector3 position, Quaternion rotation, Vector3 scale, Vector4 color)
• void addInstance(Vector3 position, Quaternion rotation, Vector3 scale, Vector4 color, Rect textureRect)

Appends a new instance with the specified transform. Requires createInstancedMesh to have been called first.

updateInstance¶

• void updateInstance(size_t index, InstanceData instance) (and overloads)

Replaces the data for an existing instance at index. Call updateInstances afterwards to sync changes to the GPU.

updateInstances¶

• void updateInstances()

Uploads all pending instance data changes to the GPU vertex buffer. Must be called after any addInstance or updateInstance calls.

clearInstances¶

• void clearInstances()

Removes all instances from the instance list. The mesh geometry is preserved; call updateInstances afterwards.