Struct vulkano::render_pass::Framebuffer

pub struct Framebuffer { /* private fields */ }

The image views that are attached to a render pass during drawing.

A framebuffer is a collection of images, and supplies the actual inputs and outputs of each attachment within a render pass. Each attachment point in the render pass must have a matching image in the framebuffer.

use vulkano::render_pass::{Framebuffer, FramebufferCreateInfo};

// let render_pass: Arc<_> = ...;
let framebuffer = Framebuffer::new(
    render_pass.clone(),
    FramebufferCreateInfo {
        attachments: vec![view],
        ..Default::default()
    },
).unwrap();

Implementations

impl Framebuffer

pub fn new(
    render_pass: Arc<RenderPass>,
    create_info: FramebufferCreateInfo
) -> Result<Arc<Framebuffer>, FramebufferCreationError>

Creates a new Framebuffer.

pub unsafe fn from_handle(
    render_pass: Arc<RenderPass>,
    handle: Framebuffer,
    create_info: FramebufferCreateInfo
) -> Arc<Framebuffer>

Creates a new Framebuffer from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from render_pass.
• create_info must match the info used to create the object.

pub fn render_pass(&self) -> &Arc<RenderPass>

Returns the renderpass that was used to create this framebuffer.

pub fn attachments(&self) -> &[Arc<dyn ImageViewAbstract>]

Returns the attachments of the framebuffer.

pub fn extent(&self) -> [u32; 2]

Returns the extent (width and height) of the framebuffer.

pub fn layers(&self) -> u32

Returns the number of layers of the framebuffer.

pub fn attached_layers_ranges(&self) -> SmallVec<[Range<u32>; 4]>

Returns the layer ranges for all attachments.

Trait Implementations

impl Debug for Framebuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceOwned for Framebuffer

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Drop for Framebuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Framebuffer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Framebuffer> for Framebuffer

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for Framebuffer

type Object = Framebuffer

The type of the object.

fn internal_object(&self) -> Framebuffer

Returns a reference to the object.

impl Eq for Framebuffer