Struct RenderFrame

pub struct RenderFrame {
    pub view: TextureView,
    pub size: PhysicalExtent,
    pub format: TextureFormat,
    /* private fields */
}

One acquired render destination from a host target.

Examples

use ailloli_ui_render_wgpu::RenderFrame;
fn inspect(frame: &RenderFrame) {
    let _: u32 = frame.size.width;
    let _: wgpu::TextureFormat = frame.format;
}

Fields

view: TextureView

Texture view bound to the target image.

size: PhysicalExtent

Active frame dimensions.

format: TextureFormat

Output format for this frame.

Implementations

impl RenderFrame

pub fn texture(&self) -> Option<&Texture>

Returns the backing texture for effects that require reads or copies.

View-only targets return None; surface and owned-texture frames return Some until the frame is consumed by Self::present.

Examples

use ailloli_ui_render_wgpu::RenderFrame;
fn can_capture(frame: &RenderFrame) -> bool { frame.texture().is_some() }

pub fn from_texture( view: TextureView, texture: Texture, size: PhysicalExtent, format: TextureFormat, present: Option<Box<dyn FnOnce()>>, ) -> Self

Wraps a host-owned texture and its view as a render frame.

present is an optional one-shot host callback invoked after consuming the texture source.

Examples

use ailloli_ui_render_wgpu::{PhysicalExtent, RenderFrame};
fn wrap(view: wgpu::TextureView, texture: wgpu::Texture) -> RenderFrame {
    RenderFrame::from_texture(view, texture, PhysicalExtent::new(64, 64),
        wgpu::TextureFormat::Rgba8Unorm, None)
}

pub fn present(self)

Present the acquired frame to its consumer.

Surface frames call SurfaceTexture::present first, then the optional host callback exactly once. Owned and view-only frames run only the callback.

Examples

use ailloli_ui_render_wgpu::RenderFrame;
fn finish(frame: RenderFrame) { frame.present(); }