Skip to main content

WgpuCustomRenderCtx

Struct WgpuCustomRenderCtx 

Source
#[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:

  • encoder is borrowed for the duration of render only — record into it but don’t take ownership.
  • target_view is the surface or active layer texture view; the 2-D pass on either side of this call uses the same view.
  • target_size matches the active target’s full pixel dimensions.
  • screen_rect is 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.
  • pipelines is the shared 2-D pipeline collection. Implementors that own an crate::ssaa::SsaaFramebuffer can call crate::ssaa::SsaaFramebuffer::blit_to with this to composite their offscreen output onto target_view through 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 WgpuPipelines

Shared 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§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,