Skip to content

mention extendedmaterial in the stdmat docs#23247

Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom
ChristopherBiscardi:stdmat-ext-docs
Mar 10, 2026
Merged

mention extendedmaterial in the stdmat docs#23247
alice-i-cecile merged 2 commits intobevyengine:mainfrom
ChristopherBiscardi:stdmat-ext-docs

Conversation

@ChristopherBiscardi
Copy link
Copy Markdown
Contributor

Objective

Some people don't know ExtendedMaterial exists and that it can be used to extend the StandardMaterial with custom data and shaders.

Solution

We can mention it on the StandardMaterial docs.

@ChristopherBiscardi ChristopherBiscardi added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 6, 2026
@github-project-automation github-project-automation bot moved this to Needs SME Triage in Rendering Mar 6, 2026
///
/// The `StandardMaterial` can be extended with more data and custom
/// shaders using [`ExtendedMaterial`]. Examples of how to do this can
/// be found in the Bevy examples.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not possible to link to examples in docs comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure actually, and can't find a simple reference for how it would be written. Neither StandardMaterial nor ExtendedMaterial seems to have scraped examples, etc at the moment. The specific example files exist in the docs, but not at their "original filepaths" (ex: examples/3d/vertex_colors.rs vs src/vertex_colors/vertex_colors.rs, and if we used a direct link I'm not sure it would fail loudly if we ever moved the example files in the repo?

I can play around a bit later to figure it out, but don't have that much time to fit it in over the next day or two.

Copy link
Copy Markdown
Contributor

@IceSentry IceSentry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to have a link to the example if possible, but other than that LGTM

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 9, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Mar 10, 2026
Merged via the queue into bevyengine:main with commit 5916c19 Mar 10, 2026
40 checks passed
@github-project-automation github-project-automation bot moved this from Needs SME Triage to Done in Rendering Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants