Add basic docs explaining what asset processing is and where to look #15058
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alice-i-cecile
added
C-Docs
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
JMS55
reviewed
Sep 5, 2024
NotAFile
approved these changes
Sep 6, 2024
MScottMcBee
reviewed
Sep 6, 2024
cart
approved these changes
Sep 6, 2024
Co-authored-by: Carter Anderson <[email protected]>
alice-i-cecile
commented
Sep 9, 2024
| //! To set the default asset processor for a given extension, use [`AssetProcessor::set_default_processor`]. | ||
| //! In most cases, these methods will be called directly on [`App`](bevy_app::App) using the [`AssetApp`](crate::AssetApp) extension trait. | ||
| //! | ||
| //! If a default asset processor is set, assets with a matching extension will be processed using that processor before loading. |
There was a problem hiding this comment.
No, I couldn't figure out how to load an asset with an arbitrary processor :(
There was a problem hiding this comment.
From code? Not possible afaik. You have to use meta files.
alice-i-cecile
added
S-Waiting-on-Author
JMS55
approved these changes
Sep 11, 2024
| //! To set the default asset processor for a given extension, use [`AssetProcessor::set_default_processor`]. | ||
| //! In most cases, these methods will be called directly on [`App`](bevy_app::App) using the [`AssetApp`](crate::AssetApp) extension trait. | ||
| //! | ||
| //! If a default asset processor is set, assets with a matching extension will be processed using that processor before loading. |
There was a problem hiding this comment.
From code? Not possible afaik. You have to use meta files.
alice-i-cecile
added
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Asset processing (added as part of #8624) is a powerful, high-impact feature, but has been widely underused (and underdeveloped) due to poor developer understanding.
Solution
In this PR, I've documented what asset processing is, why it's useful, and pointed users to the two primary entry points.
While I would like substantially more involved practical examples for how to perform common asset-processing tasks, I've split them out from this PR for ease of review (and actually submitting this for review before the weekend).
We should add bread crumbs from the module docs to these docs, but whether we add that here or in #15056 depends on which gets merged first.