Enum RenderTarget 

pub enum RenderTarget<'a> {
    Surface,
    SurfaceWithDepth {
        depth_view: &'a TextureView,
        clear_value: Option<f32>,
    },
    Framebuffer(&'a Framebuffer),
}

A render target that can be either a window surface or an offscreen framebuffer.

This enum simplifies render pass setup by providing a unified interface for different rendering destinations.

Variants

Surface

Render to the window surface.

The surface view is obtained from the FrameContext during render pass creation.

SurfaceWithDepth

Render to the window surface with an attached depth buffer.

This variant allows rendering to the surface while using a depth texture for z-ordering, which is essential for UI systems and 3D overlays.

Example

let depth_view = frame.window_depth_view().expect("Window has depth");
frame.clear_and_render(
    RenderTarget::surface_with_depth_clear(&depth_view, 0.0),
    Color::BLACK,
    |pass| { /* rendering */ },
);

Fields

depth_view: &'a TextureView

The depth texture view to attach.

clear_value: Option<f32>

How to handle the depth buffer: None = load, Some(v) = clear to v.

Framebuffer(&'a Framebuffer)

Render to an offscreen framebuffer.

The framebuffer manages its own color, depth, and MSAA textures.

Implementations

impl<'a> RenderTarget<'a>

pub fn surface() -> Self

Create a surface target (no depth).

pub fn surface_with_depth(depth: &'a TextureView) -> Self

Create a surface target with a depth buffer that loads existing values.

pub fn surface_with_depth_clear(depth: &'a TextureView, clear: f32) -> Self

Create a surface target with a depth buffer that clears to the specified value.

For reverse-Z depth (recommended), use 0.0 as the clear value. For standard depth, use 1.0 as the clear value.

pub fn framebuffer(fb: &'a Framebuffer) -> Self

Create a framebuffer target.

pub fn is_surface(&self) -> bool

Check if this target is a surface (with or without depth).

pub fn is_framebuffer(&self) -> bool

Check if this target is a framebuffer.

pub fn framebuffer_ref(&self) -> Option<&'a Framebuffer>

Get the framebuffer if this is a framebuffer target.

pub fn format(&self) -> Option<TextureFormat>

Get the texture format for this target.

For framebuffers, returns the framebuffer’s format. For surfaces, returns None (format must be obtained from surface config).

pub fn sample_count(&self) -> u32

Get the sample count for this target.

For framebuffers, returns the framebuffer’s sample count. For surfaces, returns 1 (surfaces don’t support MSAA directly).

pub fn has_msaa(&self) -> bool

Check if this target has MSAA enabled.

pub fn has_depth(&self) -> bool

Check if this target has a depth buffer.

pub fn depth_view(&self) -> Option<&'a TextureView>

Get the depth view if available.

pub fn depth_clear_value(&self) -> Option<f32>

Get the depth clear value if this target clears depth.

Trait Implementations

impl<'a> Clone for RenderTarget<'a>

fn clone(&self) -> RenderTarget<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RenderTarget<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RenderTarget<'a>

fn default() -> RenderTarget<'a>

Returns the “default value” for a type.

impl<'a> From<&'a Framebuffer> for RenderTarget<'a>

fn from(fb: &'a Framebuffer) -> Self

Converts to this type from the input type.

impl<'a> Copy for RenderTarget<'a>