Struct web_glitz::image::renderbuffer::Renderbuffer

pub struct Renderbuffer<F> { /* fields omitted */ }

Stores a single 2-dimensional image, optimized for use as a [RenderTarget] attachment.

Unlike a [Texture2D], which can also hold a single 2-dimensional image, a Renderbuffer cannot be sampled. However, a Renderbuffer is optimized for use as a render target attachment, whereas a [Texture2D] may not be. A Renderbuffer is therefor the best choice for a [RenderTarget] attachment that never needs to be sampled.

See RenderingContext::create_renderbuffer and [RenderingContext::create_multisample_renderbuffer] for details on how a Renderbuffer is created for single-sample and multisample image data respectively.

Example

The following example creates a Renderbuffer and uses it as the color attachment in a render pass, which clears a central square to blue pixels:

use web_glitz::image::Region2D;
use web_glitz::image::format::RGB8;
use web_glitz::image::renderbuffer::RenderbufferDescriptor;
use web_glitz::rendering::{LoadOp, RenderTargetDescriptor, StoreOp};

let mut renderbuffer = context.create_renderbuffer(&RenderbufferDescriptor {
    format: RGB8,
    width: 256,
    height: 256
});

let mut render_target = context.create_render_target(
    RenderTargetDescriptor::new()
        .attach_color_float(
            &mut renderbuffer,
            LoadOp::Load,
            StoreOp::Store
        )
);

let render_pass = render_target.create_render_pass(|framebuffer| {
    framebuffer.color.0.clear_command([0.0, 0.0, 1.0, 0.0], Region2D::Area((64, 64), 128, 128))
});

context.submit(render_pass);

Implementations

impl<F> Renderbuffer<F>

pub fn width(&self) -> u32

The width of this Renderbuffer.

pub fn height(&self) -> u32

The height of this Renderbuffer.

impl<F> Renderbuffer<Multisample<F>> where
    F: Multisamplable, 

pub fn samples(&self) -> u8

Returns the number of samples this Renderbuffer stores for its image data.

Trait Implementations

impl<F> AsAttachment for Renderbuffer<F> where
    F: RenderbufferFormat + 'static, 

type Format = F

The type of image storage format the image is stored in.

fn as_attachment(&mut self) -> Attachment<'_, Self::Format>

Converts the image reference into a render target attachment.

impl<F> AsMultisampleAttachment for Renderbuffer<Multisample<F>> where
    F: RenderbufferFormat + Multisamplable + 'static, 

type SampleFormat = F

The type of image storage format the image is stored in.

fn as_multisample_attachment(
    &mut self
) -> MultisampleAttachment<'_, Self::SampleFormat>

Converts the image reference into a render target attachment.

impl<F> AttachColorFloat for Renderbuffer<F> where
    F: RenderbufferFormat + FloatRenderable + 'static, 

impl<F> AttachColorInteger for Renderbuffer<F> where
    F: RenderbufferFormat + IntegerRenderable + 'static, 

impl<F> AttachColorUnsignedInteger for Renderbuffer<F> where
    F: RenderbufferFormat + UnsignedIntegerRenderable + 'static, 

impl<F> AttachDepth for Renderbuffer<F> where
    F: RenderbufferFormat + DepthRenderable + 'static, 

impl<F> AttachDepthStencil for Renderbuffer<F> where
    F: RenderbufferFormat + DepthStencilRenderable + 'static, 

impl<F> AttachMultisampleColorFloat for Renderbuffer<Multisample<F>> where
    F: RenderbufferFormat + Multisamplable + FloatRenderable + 'static, 

impl<F> AttachMultisampleDepth for Renderbuffer<Multisample<F>> where
    F: RenderbufferFormat + Multisamplable + DepthRenderable + 'static, 

impl<F> AttachMultisampleDepthStencil for Renderbuffer<Multisample<F>> where
    F: RenderbufferFormat + Multisamplable + DepthStencilRenderable + 'static, 

impl<F> AttachStencil for Renderbuffer<F> where
    F: RenderbufferFormat + StencilRenderable + 'static, 

impl<F> BlitSource for Renderbuffer<F> where
    F: RenderbufferFormat + 'static, 

type Format = F

The image storage format used by the source image.

fn descriptor(&self) -> BlitSourceDescriptor

Encapsulates the information about the blit source required by the BlitCommand.

impl<F> Hash for Renderbuffer<F>

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<F> PartialEq<Renderbuffer<F>> for Renderbuffer<F>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F> ResolveSource for Renderbuffer<Multisample<F>> where
    F: RenderbufferFormat + Multisamplable + 'static, 

type Format = F

The image storage format used by the source image.

fn descriptor(&self) -> ResolveSourceDescriptor

Encapsulates the information about the multisample blit source required by the BlitCommand.