Foray Library
rapid prototyping framework for crossplatform development of vulkan hardware ray tracing applications
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
foray::core::ManagedImage::CreateInfo Struct Reference

Combines all structs used for initialization. More...

#include <foray_managedimage.hpp>

Public Member Functions

 CreateInfo ()
 Initiliazes .sType fields, chooses common defaults for everything else.
 
 CreateInfo (VkImageUsageFlags usage, VkFormat format, const VkExtent2D &extent, std::string_view name="Unnamed Image")
 Shorthand for initializing commonly set values.
 

Public Attributes

VkImageCreateInfo ImageCI {}
 Vulkan Image CreateInfo.
 
bool CreateImageView = true
 If set to true, image view is created.
 
VkImageViewCreateInfo ImageViewCI {}
 Vulkan ImageView CreateInfo.
 
VmaAllocationCreateInfo AllocCI {}
 Vma Allocation CreateInfo.
 
std::string Name {"Unnamed Image"}
 Debug object name.
 

Detailed Description

Combines all structs used for initialization.

Constructor & Destructor Documentation

◆ CreateInfo() [1/2]

foray::core::ManagedImage::CreateInfo::CreateInfo ( )

Initiliazes .sType fields, chooses common defaults for everything else.

◆ CreateInfo() [2/2]

foray::core::ManagedImage::CreateInfo::CreateInfo ( VkImageUsageFlags  usage,
VkFormat  format,
const VkExtent2D &  extent,
std::string_view  name = "Unnamed Image" 
)

Shorthand for initializing commonly set values.

Parameters
usageImage usage determines how vulkan can utilize/access the image
formatPixel format
extent2D Size (depth = 1)
nameDebug object name

Member Data Documentation

◆ AllocCI

VmaAllocationCreateInfo foray::core::ManagedImage::CreateInfo::AllocCI {}

Vma Allocation CreateInfo.

◆ CreateImageView

bool foray::core::ManagedImage::CreateInfo::CreateImageView = true

If set to true, image view is created.

◆ ImageCI

VkImageCreateInfo foray::core::ManagedImage::CreateInfo::ImageCI {}

Vulkan Image CreateInfo.

◆ ImageViewCI

VkImageViewCreateInfo foray::core::ManagedImage::CreateInfo::ImageViewCI {}

Vulkan ImageView CreateInfo.

◆ Name

std::string foray::core::ManagedImage::CreateInfo::Name {"Unnamed Image"}

Debug object name.


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