Struct CustomPass 

pub struct CustomPass<'a> {
    pub device: &'a Device,
    pub queue: &'a Queue,
    pub encoder: &'a mut CommandEncoder,
    /* private fields */
}

What a Painter::custom closure gets: the frame’s encoder and the painter’s render target at that point in the frame (the canvas, the window, or the MSAA texture resolving into either).

With indexed colour on (Self::is_indexed) the target holds palette indices: return index_out(i) from INDEX_WGSL (feature indexed) instead of a colour.

The easiest way to draw is Self::begin_render_pass, which attaches the target the same way the painter does (load, store, MSAA resolve, depth). Build the pipeline for it with Self::format, Self::multisample and Self::depth_stencil, so it matches the attachments whatever AppConfig::msaa_samples and depth_format are.

Fields

device: &'a Device

queue: &'a Queue

encoder: &'a mut CommandEncoder

Implementations

impl<'a> CustomPass<'a>

pub fn begin_render_pass(&mut self, label: &str) -> RenderPass<'_>

A render pass onto the painter’s target that keeps what is already there (the clear colour and lower layers), with the MSAA resolve and depth attachment the painter uses.

pub fn view(&self) -> &TextureView

The colour view drawn into: the MSAA texture when multisampling, else the canvas (or the window without one). For passes set up by hand; see Self::resolve_target.

pub fn resolve_target(&self) -> Option<&TextureView>

Some(view) when multisampling: the MSAA colour resolves into it.

pub fn depth_view(&self) -> Option<&TextureView>

The depth view, when AppConfig::depth_format is set.

pub fn format(&self) -> TextureFormat

The target’s colour format (always sRGB; see Graphics::surface_format).

pub fn multisample(&self) -> MultisampleState

Multisample state matching the target, for the pipeline.

pub fn depth_stencil(&self) -> Option<DepthStencilState>

Depth-stencil state matching the target, for the pipeline: None without a depth buffer, else one that neither tests nor writes depth (like the painter’s 2D layers).

pub fn is_indexed(&self) -> bool

Whether the target holds palette indices (indexed colour is on) rather than colours.

pub fn size(&self) -> [u32; 2]

Size of the target in pixels: the virtual resolution, else the window’s size.