evan 2026.1.4
Evan
Loading...
Searching...
No Matches
evan::XrSwapchainImage::CreateXrSwapchainImageProperties Struct Reference

Encapsulates properties for creating an XrSwapchainImage instance. More...

#include <headers/evan/openxr/XrSwapchainImage.hpp>

Collaboration diagram for evan::XrSwapchainImage::CreateXrSwapchainImageProperties:

Public Attributes

XrSwapchain swapchain
 The OpenXR swapchain handle associated with the swapchain images.
 
XrSwapchainCreateInfo createInfo
 The swapchain creation info structure containing parameters for creating the swapchain images, such as format, dimensions, sample count, and usage flags.
 
VkRenderPass renderPass
 The Vulkan render pass used for rendering operations with the swapchain images. It defines the rendering pipeline and how the images will be used during rendering.
 
const DeviceContext & deviceContext
 A reference to the device context, which provides access to Vulkan device resources and operations needed for managing the swapchain images, such as creating image views, allocating memory, and performing layout transitions.
 
VkSampleCountFlagBits msaaSamples = VK_SAMPLE_COUNT_1_BIT
 The MSAA sample count to use for the color and depth resources created for this swapchain image.
 
ColorAttachmentMode colorAttachmentMode
 How the render pass obtains its single-sampled color attachment.
 

Detailed Description

Encapsulates properties for creating an XrSwapchainImage instance.

This structure holds all necessary parameters for initializing an XrSwapchainImage, including the OpenXR swapchain handle, swapchain creation info, Vulkan render pass, and a reference to the device context. It serves as a convenient way to pass multiple parameters to the XrSwapchainImage constructor while ensuring that all required information is provided for proper initialization of the swapchain image.

Definition at line 55 of file XrSwapchainImage.hpp.

Member Data Documentation

◆ colorAttachmentMode

ColorAttachmentMode evan::XrSwapchainImage::CreateXrSwapchainImageProperties::colorAttachmentMode
Initial value:
=
ColorAttachmentMode::SwapchainImageAttachment

How the render pass obtains its single-sampled color attachment.

The runtime owns the swapchain images, so either a multisampled color image is created and resolved into the swapchain image (ColorAttachmentMode::ResolveToSwapchain), or the swapchain image is rendered into directly, whether or not it is multisampled (ColorAttachmentMode::SwapchainImageAttachment).

Definition at line 95 of file XrSwapchainImage.hpp.

◆ createInfo

XrSwapchainCreateInfo evan::XrSwapchainImage::CreateXrSwapchainImageProperties::createInfo

The swapchain creation info structure containing parameters for creating the swapchain images, such as format, dimensions, sample count, and usage flags.

Definition at line 66 of file XrSwapchainImage.hpp.

◆ deviceContext

const DeviceContext& evan::XrSwapchainImage::CreateXrSwapchainImageProperties::deviceContext

A reference to the device context, which provides access to Vulkan device resources and operations needed for managing the swapchain images, such as creating image views, allocating memory, and performing layout transitions.

Definition at line 79 of file XrSwapchainImage.hpp.

◆ msaaSamples

VkSampleCountFlagBits evan::XrSwapchainImage::CreateXrSwapchainImageProperties::msaaSamples = VK_SAMPLE_COUNT_1_BIT

The MSAA sample count to use for the color and depth resources created for this swapchain image.

Definition at line 84 of file XrSwapchainImage.hpp.

◆ renderPass

VkRenderPass evan::XrSwapchainImage::CreateXrSwapchainImageProperties::renderPass

The Vulkan render pass used for rendering operations with the swapchain images. It defines the rendering pipeline and how the images will be used during rendering.

Definition at line 72 of file XrSwapchainImage.hpp.

◆ swapchain

XrSwapchain evan::XrSwapchainImage::CreateXrSwapchainImageProperties::swapchain

The OpenXR swapchain handle associated with the swapchain images.

Definition at line 60 of file XrSwapchainImage.hpp.


The documentation for this struct was generated from the following file: