Struct gpu::ClearProgram

pub struct ClearProgram { /* fields omitted */ }

A program that clears colors, depth and stencil of a framebuffer.

Implementations

impl ClearProgram

pub const COLOR: u32

Color buffer bit.

pub const DEPTH: u32

Depth buffer bit.

pub const STENCIL: u32

Stencil buffer bit.

pub fn new(context: &Context) -> Self

Creates a new ClearProgram.

pub fn set_color(&mut self, color: (f32, f32, f32, f32))

Sets the color clear value.

pub fn color(&self) -> (f32, f32, f32, f32)

Gets the color clear value.

pub fn set_depth(&mut self, depth: f32)

Sets the depth clear value.

pub fn depth(&self) -> f32

Gets the depth clear value.

pub fn set_stencil(&mut self, stencil: i32)

Sets the stencil clear value.

pub fn stencil(&self) -> i32

Gets the stencil clear value.

pub fn clear(&self, framebuffer: &mut Framebuffer, clear_mask: u32)

Clear the target Framebuffer using the buffer bit mask. Here is an example that clears color, depth and stencil in a single call:

clear(framebuffer, ClearProgram::COLOR | ClearProgram::DEPTH | ClearProgram::STENCIL)