Struct VulkanFrameTarget

pub struct VulkanFrameTarget {
    pub image: Image,
    pub view: ImageView,
    pub format: Format,
    pub extent: Extent2D,
    pub initial_layout: ImageLayout,
    pub final_layout: ImageLayout,
}

One host-owned Vulkan image target for an Ailloli UI render pass.

Immersive hosts will usually wrap the currently acquired presented image and its image view. The host remains responsible for acquire/release/composition.

Examples

use ailloli_ui_render_vulkan::VulkanFrameTarget;
use ash::vk;
let target = VulkanFrameTarget::new(
    vk::Image::null(),
    vk::ImageView::null(),
    vk::Format::R8G8B8A8_UNORM,
    vk::Extent2D { width: 1280, height: 720 },
);
assert_eq!(target.extent.width, 1280);

Fields

image: Image

Host-owned target image; null is rejected at render time.

view: ImageView

Host-owned 2D image view; null is rejected at render time.

format: Format

Pixel format used to build compatible render passes and pipelines.

extent: Extent2D

Non-zero target extent in physical pixels.

initial_layout: ImageLayout

Layout expected before the renderer’s transition.

final_layout: ImageLayout

Layout produced after rendering completes.

Implementations

impl VulkanFrameTarget

Constructors for host-owned frame targets.

pub fn new( image: Image, view: ImageView, format: Format, extent: Extent2D, ) -> Self

Creates a target transitioning from UNDEFINED to COLOR_ATTACHMENT_OPTIMAL.

Handle and extent validation is deferred to rendering so constructing a target does not call Vulkan.

Examples

use ailloli_ui_render_vulkan::VulkanFrameTarget;
use ash::vk;
let target = VulkanFrameTarget::new(
    vk::Image::null(), vk::ImageView::null(), vk::Format::B8G8R8A8_SRGB,
    vk::Extent2D { width: 640, height: 480 },
);
assert!(target.initial_layout == vk::ImageLayout::UNDEFINED);
assert!(target.final_layout == vk::ImageLayout::COLOR_ATTACHMENT_OPTIMAL);

pub fn with_layouts( self, initial_layout: ImageLayout, final_layout: ImageLayout, ) -> Self

Replaces the layouts consumed and produced by the render pass.

Examples

use ailloli_ui_render_vulkan::VulkanFrameTarget;
use ash::vk;
let target = VulkanFrameTarget::new(
    vk::Image::null(), vk::ImageView::null(), vk::Format::B8G8R8A8_SRGB,
    vk::Extent2D { width: 1, height: 1 },
).with_layouts(vk::ImageLayout::PRESENT_SRC_KHR, vk::ImageLayout::PRESENT_SRC_KHR);
assert!(target.initial_layout == vk::ImageLayout::PRESENT_SRC_KHR);

Trait Implementations

impl Clone for VulkanFrameTarget

fn clone(&self) -> VulkanFrameTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VulkanFrameTarget