#[non_exhaustive]pub struct GpuFrameContext<'a> {
pub camera: &'a Camera,
pub viewport_size: Vec2,
pub dt: f32,
pub frame_index: u64,
pub viewport_id: Option<ViewportId>,
}Expand description
Per-frame, read-only context passed to a GpuPlugin.
Mirrors the render-relevant fields of RuntimeFrameContext
without the input or pick state, which GPU plugins do not consume.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.camera: &'a CameraActive camera for this frame.
viewport_size: Vec2Viewport size in physical pixels.
dt: f32Wall-clock seconds since the previous frame.
frame_index: u64Monotonically increasing frame counter, supplied by the host.
viewport_id: Option<ViewportId>Viewport this invocation is associated with, if the host renders
multiple viewports per frame and calls pre_prepare / post_paint
once per viewport. None for single-viewport hosts.
Plugins registered via
ViewportRuntime::with_gpu_plugin_for_viewport
only execute when this field matches the viewport they were scoped
to. Unscoped plugins run on every call regardless of this field.
Implementations§
Source§impl<'a> GpuFrameContext<'a>
impl<'a> GpuFrameContext<'a>
Sourcepub fn new(
camera: &'a Camera,
viewport_size: Vec2,
dt: f32,
frame_index: u64,
) -> Self
pub fn new( camera: &'a Camera, viewport_size: Vec2, dt: f32, frame_index: u64, ) -> Self
Construct a context for a single-viewport host. Multi-viewport hosts that
call pre_prepare / post_paint once per viewport chain
with_viewport to scope the call.
Sourcepub fn with_viewport(self, viewport_id: ViewportId) -> Self
pub fn with_viewport(self, viewport_id: ViewportId) -> Self
Associate this context with a specific viewport. Plugins registered via
ViewportRuntime::with_gpu_plugin_for_viewport
run only when this id matches the one they were scoped to.
Auto Trait Implementations§
impl<'a> Freeze for GpuFrameContext<'a>
impl<'a> RefUnwindSafe for GpuFrameContext<'a>
impl<'a> Send for GpuFrameContext<'a>
impl<'a> Sync for GpuFrameContext<'a>
impl<'a> Unpin for GpuFrameContext<'a>
impl<'a> UnsafeUnpin for GpuFrameContext<'a>
impl<'a> UnwindSafe for GpuFrameContext<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.