Add support for custom 0-1 attributes to ImmediateMesh

BlackShift · BlackShift · commit 094fa88672f9 · 2025-10-08T17:45:50.000-04:00
diff --git a/doc/classes/ImmediateMesh.xml b/doc/classes/ImmediateMesh.xml
@@ -25,6 +25,7 @@
 		[/csharp]
 		[/codeblocks]
 		[b]Note:[/b] Generating complex geometries with [ImmediateMesh] is highly inefficient. Instead, it is designed to generate simple geometry that changes often.
+		[b]Note:[/b] The custom data attributes will use the [constant Mesh.ARRAY_CUSTOM_RGBA_FLOAT] format.
 	</description>
 	<tutorials>
 		<link title="Using ImmediateMesh">$DOCS_URL/tutorials/3d/procedural_geometry/immediatemesh.html</link>
@@ -71,6 +72,20 @@
 				Set the color attribute that will be pushed with the next vertex.
 			</description>
 		</method>
+		<method name="surface_set_custom0">
+			<return type="void" />
+			<param index="0" name="custom0" type="Vector4" />
+			<description>
+				Set the CUSTOM0 attribute that will be pushed with the next vertex.
+			</description>
+		</method>
+		<method name="surface_set_custom1">
+			<return type="void" />
+			<param index="0" name="custom1" type="Vector4" />
+			<description>
+				Set the CUSTOM1 attribute that will be pushed with the next vertex.
+			</description>
+		</method>
 		<method name="surface_set_normal">
 			<return type="void" />
 			<param index="0" name="normal" type="Vector3" />
diff --git a/scene/resources/immediate_mesh.cpp b/scene/resources/immediate_mesh.cpp
@@ -98,6 +98,30 @@ void ImmediateMesh::surface_set_uv2(const Vector2 &p_uv2) {
 
 	current_uv2 = p_uv2;
 }
+void ImmediateMesh::surface_set_custom0(const Vector4 &p_custom0) {
+	ERR_FAIL_COND_MSG(!surface_active, "Not creating any surface. Use surface_begin() to do it.");
+	if (!uses_custom0) {
+		custom0s.resize(vertices.size());
+		for (Vector4 &custom0 : custom0s) {
+			custom0 = p_custom0;
+		}
+		uses_custom0 = true;
+	}
+
+	current_custom0 = p_custom0;
+}
+void ImmediateMesh::surface_set_custom1(const Vector4 &p_custom1) {
+	ERR_FAIL_COND_MSG(!surface_active, "Not creating any surface. Use surface_begin() to do it.");
+	if (!uses_custom1) {
+		custom1s.resize(vertices.size());
+		for (Vector4 &custom1 : custom1s) {
+			custom1 = p_custom1;
+		}
+		uses_custom1 = true;
+	}
+
+	current_custom1 = p_custom1;
+}
 void ImmediateMesh::surface_add_vertex(const Vector3 &p_vertex) {
 	ERR_FAIL_COND_MSG(!surface_active, "Not creating any surface. Use surface_begin() to do it.");
 	ERR_FAIL_COND_MSG(vertices.size() && active_surface_data.vertex_2d, "Can't mix 2D and 3D vertices in a surface.");
@@ -117,6 +141,12 @@ void ImmediateMesh::surface_add_vertex(const Vector3 &p_vertex) {
 	if (uses_uv2s) {
 		uv2s.push_back(current_uv2);
 	}
+	if (uses_custom0) {
+		custom0s.push_back(current_custom0);
+	}
+	if (uses_custom1) {
+		custom1s.push_back(current_custom1);
+	}
 	vertices.push_back(p_vertex);
 }
 
@@ -139,6 +169,12 @@ void ImmediateMesh::surface_add_vertex_2d(const Vector2 &p_vertex) {
 	if (uses_uv2s) {
 		uv2s.push_back(current_uv2);
 	}
+	if (uses_custom0) {
+		custom0s.push_back(current_custom0);
+	}
+	if (uses_custom1) {
+		custom1s.push_back(current_custom1);
+	}
 	Vector3 v(p_vertex.x, p_vertex.y, 0);
 	vertices.push_back(v);
 
@@ -245,6 +281,18 @@ void ImmediateMesh::surface_end() {
 			uv2_offset = attribute_stride;
 			attribute_stride += sizeof(float) * 2;
 		}
+		uint32_t custom0_offset = 0;
+		if (uses_custom0) {
+			format |= ARRAY_FORMAT_CUSTOM0 | (ARRAY_CUSTOM_RGBA_FLOAT << ARRAY_FORMAT_CUSTOM0_SHIFT);
+			custom0_offset = attribute_stride;
+			attribute_stride += sizeof(float) * 4;
+		}
+		uint32_t custom1_offset = 0;
+		if (uses_custom1) {
+			format |= ARRAY_FORMAT_CUSTOM1 | (ARRAY_CUSTOM_RGBA_FLOAT << ARRAY_FORMAT_CUSTOM1_SHIFT);
+			custom1_offset = attribute_stride;
+			attribute_stride += sizeof(float) * 4;
+		}
 
 		surface_attribute_create_cache.resize(vertices.size() * attribute_stride);
 
@@ -272,6 +320,23 @@ void ImmediateMesh::surface_end() {
 				uv2[0] = uv2s[i].x;
 				uv2[1] = uv2s[i].y;
 			}
+
+			if (uses_custom0) {
+				float *custom0 = (float *)&surface_attribute_ptr[i * attribute_stride + custom0_offset];
+
+				custom0[0] = custom0s[i].x;
+				custom0[1] = custom0s[i].y;
+				custom0[2] = custom0s[i].z;
+				custom0[3] = custom0s[i].w;
+			}
+			if (uses_custom1) {
+				float *custom1 = (float *)&surface_attribute_ptr[i * attribute_stride + custom1_offset];
+
+				custom1[0] = custom1s[i].x;
+				custom1[1] = custom1s[i].y;
+				custom1[2] = custom1s[i].z;
+				custom1[3] = custom1s[i].w;
+			}
 		}
 	}
 
@@ -280,7 +345,7 @@ void ImmediateMesh::surface_end() {
 	sd.primitive = RS::PrimitiveType(active_surface_data.primitive);
 	sd.format = format;
 	sd.vertex_data = surface_vertex_create_cache;
-	if (uses_colors || uses_uvs || uses_uv2s) {
+	if (uses_colors || uses_uvs || uses_uv2s || uses_custom0 || uses_custom1) {
 		sd.attribute_data = surface_attribute_create_cache;
 	}
 	sd.vertex_count = vertices.size();
@@ -303,13 +368,17 @@ void ImmediateMesh::surface_end() {
 	tangents.clear();
 	uvs.clear();
 	uv2s.clear();
+	custom0s.clear();
+	custom1s.clear();
 	vertices.clear();
 
 	uses_colors = false;
 	uses_normals = false;
 	uses_tangents = false;
 	uses_uvs = false;
 	uses_uv2s = false;
+	uses_custom0 = false;
+	uses_custom1 = false;
 
 	surface_active = false;
 
@@ -326,13 +395,17 @@ void ImmediateMesh::clear_surfaces() {
 	tangents.clear();
 	uvs.clear();
 	uv2s.clear();
+	custom0s.clear();
+	custom1s.clear();
 	vertices.clear();
 
 	uses_colors = false;
 	uses_normals = false;
 	uses_tangents = false;
 	uses_uvs = false;
 	uses_uv2s = false;
+	uses_custom0 = false;
+	uses_custom1 = false;
 }
 
 int ImmediateMesh::get_surface_count() const {
@@ -404,6 +477,8 @@ void ImmediateMesh::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("surface_set_tangent", "tangent"), &ImmediateMesh::surface_set_tangent);
 	ClassDB::bind_method(D_METHOD("surface_set_uv", "uv"), &ImmediateMesh::surface_set_uv);
 	ClassDB::bind_method(D_METHOD("surface_set_uv2", "uv2"), &ImmediateMesh::surface_set_uv2);
+	ClassDB::bind_method(D_METHOD("surface_set_custom0", "custom0"), &ImmediateMesh::surface_set_custom0);
+	ClassDB::bind_method(D_METHOD("surface_set_custom1", "custom1"), &ImmediateMesh::surface_set_custom1);
 	ClassDB::bind_method(D_METHOD("surface_add_vertex", "vertex"), &ImmediateMesh::surface_add_vertex);
 	ClassDB::bind_method(D_METHOD("surface_add_vertex_2d", "vertex"), &ImmediateMesh::surface_add_vertex_2d);
 	ClassDB::bind_method(D_METHOD("surface_end"), &ImmediateMesh::surface_end);
diff --git a/scene/resources/immediate_mesh.h b/scene/resources/immediate_mesh.h
@@ -43,18 +43,24 @@ class ImmediateMesh : public Mesh {
 	bool uses_tangents = false;
 	bool uses_uvs = false;
 	bool uses_uv2s = false;
+	bool uses_custom0 = false;
+	bool uses_custom1 = false;
 
 	Color current_color;
 	Vector3 current_normal;
 	Plane current_tangent;
 	Vector2 current_uv;
 	Vector2 current_uv2;
+	Vector4 current_custom0;
+	Vector4 current_custom1;
 
 	LocalVector<Color> colors;
 	LocalVector<Vector3> normals;
 	LocalVector<Plane> tangents;
 	LocalVector<Vector2> uvs;
 	LocalVector<Vector2> uv2s;
+	LocalVector<Vector4> custom0s;
+	LocalVector<Vector4> custom1s;
 	LocalVector<Vector3> vertices;
 
 	struct Surface {
@@ -86,6 +92,8 @@ class ImmediateMesh : public Mesh {
 	void surface_set_tangent(const Plane &p_tangent);
 	void surface_set_uv(const Vector2 &p_uv);
 	void surface_set_uv2(const Vector2 &p_uv2);
+	void surface_set_custom0(const Vector4 &p_custom0);
+	void surface_set_custom1(const Vector4 &p_custom1);
 	void surface_add_vertex(const Vector3 &p_vertex);
 	void surface_add_vertex_2d(const Vector2 &p_vertex);
 	void surface_end();
