Struct gfx::render::target::Frame [−] [src]

pub struct Frame<R: Resources> {
    pub width: Size,
    pub height: Size,
    pub colors: Vec<Plane<R>>,
    pub depth: Option<Plane<R>>,
    pub stencil: Option<Plane<R>>,
    pub gamma: Gamma,
}

A complete Frame, which is the result of rendering.

Fields

width: Size

The width of the viewport.

height: Size

The height of the viewport.

colors: Vec<Plane<R>>

Each color component has its own buffer.

depth: Option<Plane<R>>

The depth buffer for this frame.

stencil: Option<Plane<R>>

The stencil buffer for this frame.

gamma: Gamma

Color space.

Methods

impl<R: Resources> Frame<R>
[src]

fn empty(width: Size, height: Size) -> Frame<R>

Create an empty Frame.

Trait Implementations

impl<R: Debug + Resources> Debug for Frame<R>
[src]

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<R: PartialEq + Resources> PartialEq for Frame<R>
[src]

fn eq(&self, __arg_0: &Frame<R>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, __arg_0: &Frame<R>) -> bool

This method tests for !=.

impl<R: Clone + Resources> Clone for Frame<R>
[src]

fn clone(&self) -> Frame<R>

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl<R: Resources> Output<R> for Frame<R>
[src]

fn get_size(&self) -> (Size, Size)

Get canvas dimensions.

fn get_colors(&self) -> &[Plane<R>]

Get array of color planes.

fn get_depth(&self) -> Option<&Plane<R>>

Get depth plane, if any.

fn get_stencil(&self) -> Option<&Plane<R>>

Get stencil plane, if any.

fn get_gamma(&self) -> Gamma

Check if it converts gamma of the output colors.

fn get_handle(&self) -> Option<&FrameBuffer<R>>

Get an associated device handle, if any.

fn get_mask(&self) -> Mask

Get the output surface mask.