Skip to content
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

Jump to bottom

Improve Mesh class description #92380

Merged
merged 1 commit into from
May 28, 2024
Merged

Improve Mesh class description #92380

merged 1 commit into from
May 28, 2024

Conversation

mateuseap
Copy link
Contributor

@mateuseap mateuseap commented May 26, 2024 •
edited
Loading

What I did

  • Bind MAX_MESH_SURFACES constant in RenderingServer::_bind_methods()
  • Add MAX_MESH_SURFACES constant to RenderingServer class documentation
  • Reference the constant RenderingServer.MAX_MESH_SURFACES in the description of Mesh class documentation

Closes: godotengine/godot-docs#8720

@mateuseap mateuseap requested a review from a team as a code owner May 26, 2024 08:25
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels May 26, 2024
@AThousandShips AThousandShips added this to the 4.x milestone May 26, 2024
@timothyqiu
Copy link
Member

I think 256 is an implementation detail currently.

Instead of hard-coding "256" in the documentation, a better option is to expose the RenderingServer.MAX_MESH_SURFACES constant and refer to this constant instead.

@mateuseap mateuseap force-pushed the feat/mesh branch 2 times, most recently from 71b63c4 to 8ffa842 Compare May 26, 2024 22:18
@mateuseap mateuseap requested a review from a team as a code owner May 26, 2024 22:18
@mateuseap
Copy link
Contributor Author

@timothyqiu I have bound the constant MAX_MESH_SURFACES in the RenderingServer::_bind_methods() method. Additionally, I have added documentation for this constant in the RenderingServer class and referenced it in the Mesh class documentation, instead of leaving the value 256 hard-coded in the description.

@mateuseap
Improve Mesh class description
ce10a66 
- Bind MAX_MESH_SURFACES constant in RenderingServer::_bind_methods()
- Add MAX_MESH_SURFACES constant to RenderingServer class documentation
- Reference the constant RenderingServer.MAX_MESH_SURFACES in the description of Mesh class documentation
@mateuseap mateuseap requested a review from timothyqiu May 27, 2024 00:54
@akien-mga akien-mga modified the milestones: 4.x, 4.3 May 28, 2024
@akien-mga akien-mga merged commit 3ebc2ed into godotengine:master May 28, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timothyqiu timothyqiu timothyqiu approved these changes

Assignees
No one assigned
Labels
cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release documentation enhancement
Projects
None yet
Milestone
4.3
Development

Successfully merging this pull request may close these issues.

Add description of MAX_MESH_SURFACES to Mesh class
4 participants
@mateuseap @timothyqiu @akien-mga @AThousandShips