pub struct Extract<'w, 's, P> where
P: 'static + SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch, { /* private fields */ }Expand description
A helper for accessing MainWorld content using a system parameter.
A SystemParam adapter which applies the contained SystemParam to the World
contained in MainWorld. This parameter only works for systems run
during RenderStage::Extract.
This requires that the contained SystemParam does not mutate the world, as it
uses a read-only reference to MainWorld internally.
Context
RenderStage::Extract is used to extract (move) data from the simulation world (MainWorld) to the
render world. The render world drives rendering each frame (generally to a Window).
This design is used to allow performing calculations related to rendering a prior frame at the same
time as the next frame is simulated, which increases throughput (FPS).
Extract is used to get data from the main world during RenderStage::Extract.
Examples
use bevy_ecs::prelude::*;
use bevy_render::Extract;
fn extract_clouds(mut commands: Commands, clouds: Extract<Query<Entity, With<Cloud>>>) {
for cloud in clouds.iter() {
commands.get_or_spawn(cloud).insert(Cloud);
}
}Trait Implementations
impl<'w, 's, P> Deref for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
impl<'w, 's, P> Deref for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
type Target = <<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item
type Target = <<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item
The resulting type after dereferencing.
impl<'w, 's, P> DerefMut for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
impl<'w, 's, P> DerefMut for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
impl<'w, 's, P> SystemParam for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
impl<'w, 's, P> SystemParam for Extract<'w, 's, P> where
P: SystemParam,
<P as SystemParam>::Fetch: ReadOnlySystemParamFetch,
type Fetch = ExtractState<P>
Auto Trait Implementations
impl<'w, 's, P> RefUnwindSafe for Extract<'w, 's, P> where
<<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item: RefUnwindSafe,
impl<'w, 's, P> Send for Extract<'w, 's, P> where
<<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item: Send,
impl<'w, 's, P> Sync for Extract<'w, 's, P> where
<<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item: Sync,
impl<'w, 's, P> Unpin for Extract<'w, 's, P> where
<<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item: Unpin,
impl<'w, 's, P> UnwindSafe for Extract<'w, 's, P> where
<<P as SystemParam>::Fetch as SystemParamFetch<'w, 's>>::Item: UnwindSafe,
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
Return the T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output; where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output; where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more