[][src]Struct vulkano::framebuffer::Framebuffer

pub struct Framebuffer<Rp, A> { /* fields omitted */ }

Contains a render pass and the image views that are attached to it.

Creating a framebuffer is done by calling Framebuffer::start, which returns a FramebufferBuilder object. You can then add the framebuffer attachments one by one by calling add(image). When you are done, call build().

Both the add and the build functions perform various checks to make sure that the number of images is correct and that each image is compatible with the attachment definition in the render pass.

use vulkano::framebuffer::Framebuffer;

// let render_pass: Arc<_> = ...;
let framebuffer = Framebuffer::start(render_pass.clone())
    .add(my_image).unwrap()
    .build().unwrap();

Just like render pass objects implement the RenderPassAbstract trait, all framebuffer objects implement the FramebufferAbstract trait. This means that you can cast any Arc<Framebuffer<..>> into an Arc<FramebufferAbstract + Send + Sync> for easier storage.

Framebuffer dimensions

If you use Framebuffer::start() to create a framebuffer then vulkano will automatically make sure that all the attachments have the same dimensions, as this is the most common situation.

Alternatively you can also use with_intersecting_dimensions, in which case the dimensions of the framebuffer will be the intersection of the dimensions of all attachments, or with_dimensions if you want to specify exact dimensions. If you use with_dimensions, you are allowed to attach images that are larger than these dimensions.

If the dimensions of the framebuffer don't match the dimensions of one of its attachment, then only the top-left hand corner of the image will be drawn to.

Implementations

impl<Rp> Framebuffer<Rp, ()>[src]

pub fn start(render_pass: Rp) -> FramebufferBuilder<Rp, ()>[src]

Starts building a framebuffer.

pub fn with_intersecting_dimensions(
    render_pass: Rp
) -> FramebufferBuilder<Rp, ()>
[src]

Starts building a framebuffer. The dimensions of the framebuffer will automatically be the intersection of the dimensions of all the attachments.

pub fn with_dimensions(
    render_pass: Rp,
    dimensions: [u32; 3]
) -> FramebufferBuilder<Rp, ()>
[src]

Starts building a framebuffer.

impl<Rp, A> Framebuffer<Rp, A>[src]

pub fn dimensions(&self) -> [u32; 3][src]

Returns the width, height and layers of this framebuffer.

pub fn width(&self) -> u32[src]

Returns the width of the framebuffer in pixels.

pub fn height(&self) -> u32[src]

Returns the height of the framebuffer in pixels.

pub fn layers(&self) -> u32[src]

Returns the number of layers (or depth) of the framebuffer.

pub fn device(&self) -> &Arc<Device>[src]

Returns the device that was used to create this framebuffer.

pub fn render_pass(&self) -> &Rp[src]

Returns the renderpass that was used to create this framebuffer.

Trait Implementations

impl<Rp: Debug, A: Debug> Debug for Framebuffer<Rp, A>[src]

impl<Rp, A> DeviceOwned for Framebuffer<Rp, A>[src]

impl<Rp, A> Drop for Framebuffer<Rp, A>[src]

impl<Rp, A> FramebufferAbstract for Framebuffer<Rp, A> where
    Rp: RenderPassAbstract,
    A: AttachmentsList
[src]

impl<Rp, A> RenderPassAbstract for Framebuffer<Rp, A> where
    Rp: RenderPassAbstract
[src]

impl<Rp, A> RenderPassDesc for Framebuffer<Rp, A> where
    Rp: RenderPassDesc
[src]

impl<C, Rp, A> RenderPassDescClearValues<C> for Framebuffer<Rp, A> where
    Rp: RenderPassDescClearValues<C>, 
[src]

Auto Trait Implementations

impl<Rp, A> RefUnwindSafe for Framebuffer<Rp, A> where
    A: RefUnwindSafe,
    Rp: RefUnwindSafe

impl<Rp, A> Send for Framebuffer<Rp, A> where
    A: Send,
    Rp: Send

impl<Rp, A> Sync for Framebuffer<Rp, A> where
    A: Sync,
    Rp: Sync

impl<Rp, A> Unpin for Framebuffer<Rp, A> where
    A: Unpin,
    Rp: Unpin

impl<Rp, A> UnwindSafe for Framebuffer<Rp, A> where
    A: UnwindSafe,
    Rp: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Content for T[src]

impl<T> DeviceOwned for T where
    T: Deref,
    <T as Deref>::Target: DeviceOwned
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.