Skip to content

Clarify SurfaceTool example with index #11529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zommerfelds wants to merge 2 commits into
base: master
Choose a base branch
from
+17 −8
Open

Clarify SurfaceTool example with index #11529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fd53d2
Clarify SurfaceTool example with index
zommerfelds Dec 11, 2025
a8a01fd
Apply suggestions from code review
zommerfelds Dec 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions tutorials/3d/procedural_geometry/surfacetool.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,18 +121,12 @@ shrinks the vertex array to remove duplicate vertices.
st.add_vertex(Vector3(1, -1, 0))
st.add_vertex(Vector3(-1, -1, 0))

# We can make the quad more efficient by using an index array and only utilizing 4 vertices
# We can make the quad more efficient by using an index array and only utilizing 4 vertices:

# Suppose we have a quad defined by 6 vertices as follows
st.add_vertex(Vector3(-1, 1, 0))
st.add_vertex(Vector3(1, 1, 0))
st.add_vertex(Vector3(-1, -1, 0))

st.add_vertex(Vector3(1, 1, 0))
st.add_vertex(Vector3(1, -1, 0))
st.add_vertex(Vector3(-1, -1, 0))

# We can make the quad more efficient by using an index array and only utilizing 4 vertices

# Creates a quad from four corner vertices.
# add_index() can be called before or after add_vertex()
Expand All @@ -150,6 +144,21 @@ shrinks the vertex array to remove duplicate vertices.

.. code-tab:: csharp

// Suppose we have a quad defined by 6 vertices as follows.
st.AddVertex(new Vector3(-1, 1, 0));
st.AddVertex(new Vector3(1, 1, 0));
st.AddVertex(new Vector3(-1, -1, 0));

st.AddVertex(new Vector3(1, 1, 0));
st.AddVertex(new Vector3(1, -1, 0));
st.AddVertex(new Vector3(-1, -1, 0));

// We can make the quad more efficient by using an index array and only utilizing 4 vertices:
st.AddVertex(new Vector3(-1, -1, 0));
st.AddVertex(new Vector3(1, 1, 0));
st.AddVertex(new Vector3(-1, -1, 0));
st.AddVertex(new Vector3(1, 1, 0));

// Creates a quad from four corner vertices.
// AddIndex does not need to be called before AddVertex.
st.AddIndex(0);
Expand All @@ -160,7 +169,7 @@ shrinks the vertex array to remove duplicate vertices.
st.AddIndex(3);
st.AddIndex(2);

// Alternatively:
// Alternatively we can use `st.Index()` which will create the quad for us and remove the duplicate vertices.
st.Index();

Similarly, if you have an index array, but you want each vertex to be unique (e.g. because
Expand Down
Loading