#[non_exhaustive]pub struct WgpuCustomRenderCtx<'a> {
pub device: &'a Device,
pub queue: &'a Queue,
pub encoder: &'a mut CommandEncoder,
pub target_view: &'a TextureView,
pub target_size: (u32, u32),
pub surface_format: TextureFormat,
pub screen_rect: Rect,
pub parent_clip: Option<[i32; 4]>,
pub pipelines: &'a WgpuPipelines,
}Expand description
Inputs handed to a WgpuCustomRender implementor at execution time.
Field invariants:
encoderis borrowed for the duration ofrenderonly — record into it but don’t take ownership.target_viewis the surface or active layer texture view; the 2-D pass on either side of this call uses the same view.target_sizematches the active target’s full pixel dimensions.screen_rectis the widget’s logical-pixel rect in bottom-up Y-up coords (agg-gui convention). Convert to wgpu’s top-down Y-down convention as needed when computing scissor / viewport.pipelinesis the shared 2-D pipeline collection. Implementors that own ancrate::ssaa::SsaaFramebuffercan callcrate::ssaa::SsaaFramebuffer::blit_towith this to composite their offscreen output ontotarget_viewthrough the same textured-quad pipeline the 2-D path uses.
Only the renderer constructs this (from end_frame); implementors receive
one and read it. It is #[non_exhaustive] so further per-pass state can be
added without a breaking release.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.device: &'a Device§queue: &'a Queue§encoder: &'a mut CommandEncoder§target_view: &'a TextureView§target_size: (u32, u32)§surface_format: TextureFormat§screen_rect: Rect§parent_clip: Option<[i32; 4]>Active scissor inherited from the agg-gui clip stack (or None if
the parent pass had no clip). Format is [x, y, w, h] in wgpu
top-down pixel coords.
pipelines: &'a WgpuPipelinesShared 2-D pipeline collection — exposed so an offscreen-buffered
custom renderer can blit its resolved framebuffer onto the active
2-D render target without rebuilding the textured-quad pipeline
itself. See crate::ssaa::SsaaFramebuffer::blit_to.
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for WgpuCustomRenderCtx<'a>
impl<'a> !UnwindSafe for WgpuCustomRenderCtx<'a>
impl<'a> Freeze for WgpuCustomRenderCtx<'a>
impl<'a> Send for WgpuCustomRenderCtx<'a>
impl<'a> Sync for WgpuCustomRenderCtx<'a>
impl<'a> Unpin for WgpuCustomRenderCtx<'a>
impl<'a> UnsafeUnpin for WgpuCustomRenderCtx<'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
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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> ⓘ
Converts
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> ⓘ
Converts
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 more