Struct luminance::framebuffer::Framebuffer

pub struct Framebuffer<B, D, CS, DS> where
    B: ?Sized + FramebufferBackend<D>,
    D: Dimensionable,
    CS: ColorSlot<B, D>,
    DS: DepthStencilSlot<B, D>,  { /* private fields */ }

Typed framebuffers.

Parametricity

• B is the backend type. It must implement backend::framebuffer::Framebuffer.
• D is the dimension type. It must implement Dimensionable.
• CS is the color slot type. It must implement ColorSlot.
• DS is the depth slot type. It must implement DepthStencilSlot.

Implementations

impl<B, D, CS, DS> Framebuffer<B, D, CS, DS> where
    B: ?Sized + FramebufferBackend<D>,
    D: Dimensionable,
    CS: ColorSlot<B, D>,
    DS: DepthStencilSlot<B, D>, 

pub fn new<C>(
    ctx: &mut C,
    size: D::Size,
    mipmaps: usize,
    sampler: Sampler
) -> Result<Self, FramebufferError> where
    C: GraphicsContext<Backend = B>, 

Create a new Framebuffer.

The mipmaps argument allows to pass the number of extra precision layers the texture will be created with. A precision layer contains the same image as the base layer but in a lower resolution. Currently, the way the resolution is computed depends on the backend, but it is safe to assume that it’s logarithmic in base 2 — i.e. at each layer depth, the resolution is divided by 2 on each axis.

Errors

It is possible that the Framebuffer cannot be created. The FramebufferError provides the reason why.

Notes

You might be interested in the GraphicsContext::new_framebuffer function instead, which is the exact same function, but benefits from more type inference (based on &mut C).

pub fn size(&self) -> D::Size

Get the size of the framebuffer.

pub fn color_slot(&mut self) -> &mut CS::ColorTextures

Access the carried color slot’s texture(s).

pub fn depth_stencil_slot(&mut self) -> &mut DS::DepthStencilTexture

Access the carried depth/stencil slot’s texture.

pub fn into_slots(self) -> (CS::ColorTextures, DS::DepthStencilTexture)

Consume this framebuffer and return the carried slots’ texture(s).

pub fn into_color_slot(self) -> CS::ColorTextures

Consume this framebuffer and return the carried ColorSlot::ColorTextures.

pub fn into_depth_stencil_slot(self) -> DS::DepthStencilTexture

Consume this framebuffer and return the carried DepthStencilSlot::DepthStencilTexture.

impl<B> Framebuffer<B, Dim2, (), ()> where
    B: ?Sized + FramebufferBackend<Dim2> + FramebufferBackBuffer, 

pub fn back_buffer<C>(
    ctx: &mut C,
    size: <Dim2 as Dimensionable>::Size
) -> Result<Self, FramebufferError> where
    C: GraphicsContext<Backend = B>, 

Get the back buffer from the input context and the required resolution.