Struct DefaultPostProcessor

pub struct DefaultPostProcessor<const PRESERVE_ASPECT: bool = false> { /* private fields */ }

The default post-processor. Used when you don’t want to perform any custom shading on the output. This just blits the composited text to the surface. This will stretch characters if the render area size falls between multiples of the character size. Use AspectPreservingDefaultPostProcessor if you don’t want this behavior.

Trait Implementations

impl<const PRESERVE_ASPECT: bool> PostProcessor for DefaultPostProcessor<PRESERVE_ASPECT>

type UserData = ()

Custom user data which will be supplied during creation of the post processor. Use this to pass in any external state your processor requires.

fn compile( device: &Device, text_view: &TextureView, surface_config: &SurfaceConfiguration, _user_data: Self::UserData, ) -> Self

Called during initialization of the backend. This should fully initialize the post processor for rendering. Note that you are expected to render to the final surface during PostProcessor::process.

fn resize( &mut self, device: &Device, text_view: &TextureView, surface_config: &SurfaceConfiguration, )

Called after the drawing dimensions have changed (e.g. the surface was resized).

fn process( &mut self, encoder: &mut CommandEncoder, queue: &Queue, _text_view: &TextureView, surface_config: &SurfaceConfiguration, surface_view: &TextureView, )

Called after text has finished compositing. The provided text_view is the composited text. The final output of your implementation should render to the provided surface_view.

fn needs_update(&self) -> bool

Called to see if this post processor wants to update the screen. By default, the backend only runs the compositor and post processor when the text changes. Returning true from this will override that behavior and cause the processor to be invoked after a call to flush, even if no text changes occurred.