Provide an example on how to use ImmediateMesh #76470
Conversation
doc/classes/ImmediateMesh.xml
Outdated
| @@ -4,9 +4,19 @@ | |||
| Mesh optimized for creating geometry manually. | |||
| </brief_description> | |||
| <description> | |||
| Mesh optimized for creating geometry manually, similar to OpenGL1.x immediate mode. | |||
| A mesh type optimized for creating geometry manually, similar to OpenGL1.x immediate mode. | |||
There was a problem hiding this comment.
I wonder if we can mention that this is similar to ImmediateGeometry from Godot 3. That would make this class show up in the docs search results if people are looking for the old node. Though I can understand if references to old equivalents aren't wanted in the docs.
There was a problem hiding this comment.
Any other opinions? We don't have this for any classes currently, so I haven't added it - but I could. Personally I think it would be better to have some sort of mechanism for helping people find renamed classes, than to add it to the raw text everyone will read.
There was a problem hiding this comment.
I'm fine with not adding it for now, I think this is worth more discussion and shouldn't block this PR
There was a problem hiding this comment.
Yeah we thought about adding a system to use the renames from the Godot 3 to 4 project converter to work as aliases when searching the docs.
There was a problem hiding this comment.
Sounds like a good idea, is that tracked somewhere so this can be added to the list? It's not really a rename though, it also changed from being it's own Node to being a resource for MeshInstances
MewPurPur
force-pushed
the
add-immediate-mesh-example
branch
from
8cf6691
to
4eabad6
Compare
|
Thanks! |
|
Cherry-picked for 4.0.3. |
Adds a small code snippet on how to use ImmediateMesh and links to our tutorial for further information. Also links the Expression class to its tutorial.