Struct Pass

pub struct Pass {
    pub pass_id: Option<usize>,
}

A rendering context e.g. for doing 3d rendering.

Useful if you need:

• A different set of top-level uniforms (see [PassUniforms]).
• To render into a Texture, which you can then manipulate to your liking.

Passes are nested, with each [CxWindow] having a [CxWindow::main_pass_id] that renders directly to the screen.

Fields

pass_id: Option<usize>

Implementations

impl Pass

pub fn begin_pass(&mut self, cx: &mut Cx, background_color: Vec4)

This starts a Pass.

This will automatically add color and depth Textures, since most of the time that is what you’d want. If not, then please use Pass::begin_pass_without_textures.

Note that if you don’t call this at all during a draw cycle, then the Pass will stick around and you can still e.g. change its camera using Pass::set_matrix_mode, which will cause a repaint. Similarly you can still write to shaders within this Pass using Area::get_slice_mut, which will also cause a repaint.

TODO(JP): Decide whether this is a bug or a feature. At the very least there currently no way to clean up a Pass, so that is definitely a bug. We might want to make that the default behavior, and have an explicit method to keep a cached Pass around?

pub fn begin_pass_without_textures(&mut self, cx: &mut Cx)

Same as Pass::begin_pass, but doesn’t add Textures automatically.

pub fn override_dpi_factor(&mut self, cx: &mut Cx, dpi_factor: f32)

pub fn set_size(&mut self, cx: &mut Cx, pass_size: Vec2)

pub fn add_color_texture( &mut self, cx: &mut Cx, texture_handle: TextureHandle, clear_color: ClearColor, )

pub fn set_depth_texture( &mut self, cx: &mut Cx, texture_handle: TextureHandle, clear_depth: ClearDepth, )

pub fn set_matrix_mode(&mut self, cx: &mut Cx, pmm: PassMatrixMode)

pub fn end_pass(&mut self, cx: &mut Cx)

Trait Implementations

impl Clone for Pass

fn clone(&self) -> Pass

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Pass

fn default() -> Pass

Returns the “default value” for a type.