Struct SimpleFrameBuffer

pub struct SimpleFrameBuffer<'a> { /* private fields */ }

A framebuffer which has only one color attachment.

Implementations

impl<'a> SimpleFrameBuffer<'a>

pub fn new<F, C>( facade: &F, color: C, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where C: ToColorAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a single color attachment and no depth nor stencil buffer.

pub fn with_depth_buffer<F, C, D>( facade: &F, color: C, depth: D, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where C: ToColorAttachment<'a>, D: ToDepthAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a single color attachment and a depth buffer, but no stencil buffer.

pub fn depth_only<F, D>( facade: &F, depth: D, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where D: ToDepthAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a depth buffer and no color attachment nor stencil buffer.

pub fn with_depth_and_stencil_buffer<F, C, D, S>( facade: &F, color: C, depth: D, stencil: S, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where C: ToColorAttachment<'a>, D: ToDepthAttachment<'a>, S: ToStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a single color attachment, a depth buffer, and a stencil buffer.

pub fn depth_and_stencil_only<F, D, S>( facade: &F, depth: D, stencil: S, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where D: ToDepthAttachment<'a>, S: ToStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a depth buffer and a stencil buffer, but no color attachment.

pub fn with_stencil_buffer<F, C, S>( facade: &F, color: C, stencil: S, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where C: ToColorAttachment<'a>, S: ToStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a single color attachment and a stencil buffer, but no depth buffer.

pub fn stencil_only<F, S>( facade: &F, stencil: S, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where S: ToStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a stencil buffer and no color attachment nor depth buffer.

pub fn with_depth_stencil_buffer<F, C, D>( facade: &F, color: C, depthstencil: D, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where C: ToColorAttachment<'a>, D: ToDepthStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a single color attachment and a depth-stencil buffer.

pub fn depth_stencil_only<F, D>( facade: &F, depthstencil: D, ) -> Result<SimpleFrameBuffer<'a>, ValidationError>

where D: ToDepthStencilAttachment<'a>, F: Facade + ?Sized,

Creates a SimpleFrameBuffer with a depth-stencil buffer and no color attachment.

Trait Implementations

impl<'a> Surface for SimpleFrameBuffer<'a>

fn clear( &mut self, rect: Option<&Rect>, color: Option<(f32, f32, f32, f32)>, color_srgb: bool, depth: Option<f32>, stencil: Option<i32>, )

Clears some attachments of the target.

fn get_dimensions(&self) -> (u32, u32)

Returns the dimensions in pixels of the target.

fn get_depth_buffer_bits(&self) -> Option<u16>

Returns the number of bits of each pixel of the depth buffer.

fn get_stencil_buffer_bits(&self) -> Option<u16>

Returns the number of bits of each pixel of the stencil buffer.

fn draw<'b, 'v, V, I, U>( &mut self, vb: V, ib: I, program: &Program, uniforms: &U, draw_parameters: &DrawParameters<'_>, ) -> Result<(), DrawError>

where I: Into<IndicesSource<'b>>, U: Uniforms, V: MultiVerticesSource<'v>,

Draws.

fn blit_color<S>( &self, source_rect: &Rect, target: &S, target_rect: &BlitTarget, filter: MagnifySamplerFilter, )

where S: Surface,

Copies a rectangle of pixels from this surface to another surface.

fn blit_buffers_from_frame( &self, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, mask: BlitMask, )

Blits from the default framebuffer.

fn blit_buffers_from_simple_framebuffer( &self, source: &SimpleFrameBuffer<'_>, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, mask: BlitMask, )

Blits from a simple framebuffer.

fn blit_buffers_from_multioutput_framebuffer( &self, source: &MultiOutputFrameBuffer<'_>, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, mask: BlitMask, )

Blits from a multi-output framebuffer.

fn clear_color(&mut self, red: f32, green: f32, blue: f32, alpha: f32)

Clears the color attachment of the target. The color is converted to sRGB when the target has sRGB format.

fn clear_color_srgb(&mut self, red: f32, green: f32, blue: f32, alpha: f32)

Clears the color attachment of the target. The color is in sRGB format and is not converted in the target.

fn clear_depth(&mut self, value: f32)

Clears the depth attachment of the target.

fn clear_stencil(&mut self, value: i32)

Clears the stencil attachment of the target.

fn clear_color_and_depth(&mut self, color: (f32, f32, f32, f32), depth: f32)

Clears the color and depth attachments of the target.

fn clear_color_srgb_and_depth( &mut self, color: (f32, f32, f32, f32), depth: f32, )

Clears the color and depth attachments of the target. The color is in sRGB format.

fn clear_color_and_stencil(&mut self, color: (f32, f32, f32, f32), stencil: i32)

Clears the color and stencil attachments of the target.

fn clear_color_srgb_and_stencil( &mut self, color: (f32, f32, f32, f32), stencil: i32, )

Clears the color and stencil attachments of the target. The color is in sRGB format.

fn clear_depth_and_stencil(&mut self, depth: f32, stencil: i32)

Clears the depth and stencil attachments of the target.

fn clear_all(&mut self, color: (f32, f32, f32, f32), depth: f32, stencil: i32)

Clears the color, depth and stencil attachments of the target.

fn clear_all_srgb( &mut self, color: (f32, f32, f32, f32), depth: f32, stencil: i32, )

Clears the color, depth and stencil attachments of the target. The color is in sRGB format.

fn has_depth_buffer(&self) -> bool

Returns true if the surface has a depth buffer available.

fn has_stencil_buffer(&self) -> bool

Returns true if the surface has a stencil buffer available.

fn blit_from_frame( &self, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, )

Blits from the default framebuffer.

fn blit_from_simple_framebuffer( &self, source: &SimpleFrameBuffer<'_>, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, )

Blits from a simple framebuffer.

fn blit_from_multioutput_framebuffer( &self, source: &MultiOutputFrameBuffer<'_>, source_rect: &Rect, target_rect: &BlitTarget, filter: MagnifySamplerFilter, )

Blits from a multi-output framebuffer.

fn blit_whole_color_to<S>( &self, target: &S, target_rect: &BlitTarget, filter: MagnifySamplerFilter, )

where S: Surface,

Copies the entire surface to a target surface. See blit_color.

fn fill<S>(&self, target: &S, filter: MagnifySamplerFilter)

where S: Surface,

Copies the entire surface to the entire target. See blit_color.