Refactor the render instance logic in #9903 so that it's easier for other components to adopt.#10002
Merged
superdump merged 7 commits intobevyengine:mainfrom Oct 8, 2023
Merged
Conversation
alice-i-cecile
added
A-Rendering
IceSentry
reviewed
Oct 3, 2023
Contributor
Author
|
This is kind of a prerequisite to GI, as that adds a whole bunch of components that need to be mirrored into the render world and I think it'd be ugly to be constantly reinventing this logic. |
pcwalton
force-pushed
the
generic-render-instances
branch
from
89fae8d to
21e0dae
Compare
…sier for other components to adopt. Currently, the only way for custom components that participate in rendering to opt into the higher-performance extraction method in bevyengine#9903 is to implement the `RenderInstances` data structure and the extraction logic manually. This is inconvenient compared to the `ExtractComponent` API. This commit creates a new `ExtractToRenderInstance` trait that mirrors the existing `ExtractComponent` method but uses the higher-performance approach that bevyengine#9903 uses. This makes high-performance rendering components essentially as easy to write as the existing ones based on component extraction.
pcwalton
force-pushed
the
generic-render-instances
branch
from
21e0dae to
ce8d88d
Compare
Contributor
|
I also want this for gpu driven rendering. |
superdump
requested changes
Oct 7, 2023
Contributor
superdump
left a comment
superdump
left a comment
There was a problem hiding this comment.
If the symlink mistakes are fixed then I’ll approve and merge this.
alice-i-cecile
approved these changes
Oct 7, 2023
JMS55
approved these changes
Oct 8, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
superdump
reviewed
Oct 8, 2023
| /// This is essentially the same as | ||
| /// [`ExtractComponent`](crate::extract_component::ExtractComponent), but | ||
| /// higher-performance because it avoids the ECS overhead. | ||
| pub trait ExtractToRenderInstance: Component { |
Contributor
There was a problem hiding this comment.
I’m wondering if there is a case for a more flexible version where you give it a query, filter, and instance, and a method as a way of mapping from the query to the instance but it isn’t implemented for a single Component. I’m a bit concerned that doing this per component one wants to extract will be detrimental to performance because it will result in more, independent lookups.
auto-merge was automatically disabled
October 8, 2023 08:59
Pull request was closed
Contributor
Author
|
Ok, I'll close this. |
superdump
approved these changes
Oct 8, 2023
superdump
approved these changes
Oct 8, 2023
auto-merge was automatically disabled
October 8, 2023 10:14
Head branch was pushed to by a user without write access
superdump
approved these changes
Oct 8, 2023
Contributor
|
Hi, I wanted to try refactor some usage |
Contributor
|
Yeah, that's unfortunate. Modern graphics APIs call one of the handles on a particular GPU an 'instance'. We'll have to think about this a bit and rename something. |
regnarock
pushed a commit
to regnarock/bevy
that referenced
this pull request
Oct 13, 2023
…sier for other components to adopt. (bevyengine#10002) # Objective Currently, the only way for custom components that participate in rendering to opt into the higher-performance extraction method in bevyengine#9903 is to implement the `RenderInstances` data structure and the extraction logic manually. This is inconvenient compared to the `ExtractComponent` API. ## Solution This commit creates a new `RenderInstance` trait that mirrors the existing `ExtractComponent` method but uses the higher-performance approach that bevyengine#9903 uses. Additionally, `RenderInstance` is more flexible than `ExtractComponent`, because it can extract multiple components at once. This makes high-performance rendering components essentially as easy to write as the existing ones based on component extraction. --- ## Changelog ### Added A new `RenderInstance` trait is available mirroring `ExtractComponent`, but using a higher-performance method to extract one or more components to the render world. If you have custom components that rendering takes into account, you may consider migration from `ExtractComponent` to `RenderInstance` for higher performance.
ameknite
pushed a commit
to ameknite/bevy
that referenced
this pull request
Nov 6, 2023
…sier for other components to adopt. (bevyengine#10002) # Objective Currently, the only way for custom components that participate in rendering to opt into the higher-performance extraction method in bevyengine#9903 is to implement the `RenderInstances` data structure and the extraction logic manually. This is inconvenient compared to the `ExtractComponent` API. ## Solution This commit creates a new `RenderInstance` trait that mirrors the existing `ExtractComponent` method but uses the higher-performance approach that bevyengine#9903 uses. Additionally, `RenderInstance` is more flexible than `ExtractComponent`, because it can extract multiple components at once. This makes high-performance rendering components essentially as easy to write as the existing ones based on component extraction. --- ## Changelog ### Added A new `RenderInstance` trait is available mirroring `ExtractComponent`, but using a higher-performance method to extract one or more components to the render world. If you have custom components that rendering takes into account, you may consider migration from `ExtractComponent` to `RenderInstance` for higher performance.
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
…sier for other components to adopt. (bevyengine#10002) # Objective Currently, the only way for custom components that participate in rendering to opt into the higher-performance extraction method in bevyengine#9903 is to implement the `RenderInstances` data structure and the extraction logic manually. This is inconvenient compared to the `ExtractComponent` API. ## Solution This commit creates a new `RenderInstance` trait that mirrors the existing `ExtractComponent` method but uses the higher-performance approach that bevyengine#9903 uses. Additionally, `RenderInstance` is more flexible than `ExtractComponent`, because it can extract multiple components at once. This makes high-performance rendering components essentially as easy to write as the existing ones based on component extraction. --- ## Changelog ### Added A new `RenderInstance` trait is available mirroring `ExtractComponent`, but using a higher-performance method to extract one or more components to the render world. If you have custom components that rendering takes into account, you may consider migration from `ExtractComponent` to `RenderInstance` for higher performance.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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
Currently, the only way for custom components that participate in rendering to opt into the higher-performance extraction method in #9903 is to implement the
RenderInstancesdata structure and the extraction logic manually. This is inconvenient compared to theExtractComponentAPI.Solution
This commit creates a new
RenderInstancetrait that mirrors the existingExtractComponentmethod but uses the higher-performance approach that #9903 uses. Additionally,RenderInstanceis more flexible thanExtractComponent, because it can extract multiple components at once. This makes high-performance rendering components essentially as easy to write as the existing ones based on component extraction.Changelog
Added
A new
RenderInstancetrait is available mirroringExtractComponent, but using a higher-performance method to extract one or more components to the render world. If you have custom components that rendering takes into account, you may consider migration fromExtractComponenttoRenderInstancefor higher performance.