tp::ImageSetup struct

Used as configuration for creating a new tp::Image object object.

Constructors, destructors, conversion operators

ImageSetup(ImageType type, ImageUsageMask usage, Format format, Extent3D extent, uint32_t mipLevelCount = 1, uint32_t arrayLayerCount = 1, MultisampleLevel sampleLevel = MultisampleLevel::x1, ArrayView<Format> compatibleFormats = {}, ImageFlagMask flags = ImageFlagMask::None(), VkBufferUsageFlags vkAdditionalUsage = 0, VmaAllocationCreateFlags vmaAdditionalFlags = 0)

Function documentation

tp::ImageSetup::ImageSetup(ImageType type, ImageUsageMask usage, Format format, Extent3D extent, uint32_t mipLevelCount = 1, uint32_t arrayLayerCount = 1, MultisampleLevel sampleLevel = MultisampleLevel::x1, ArrayView<Format> compatibleFormats = {}, ImageFlagMask flags = ImageFlagMask::None(), VkBufferUsageFlags vkAdditionalUsage = 0, VmaAllocationCreateFlags vmaAdditionalFlags = 0)

Parameters
type The type and dimensionality of the image.
usage A mask of tp::ImageUsage specifying the permitted set of usages of the new image.
format The format the data will be interpreted as.
extent The extent of the image in three dimensions.
mipLevelCount The number of mip levels the image should have.
arrayLayerCount The number of array layers the image should have.
sampleLevel The multisampling level of the image.
compatibleFormats The list of additional compatible formats that the tp::ImageView objects viewing this image are permitted to have.
flags Additional flags for creation of the image.
vkAdditionalUsage A mask of additional Vulkan usage flags that will be passed to VkImageCreateInfo.
vmaAdditionalFlags A mask of additional VMA allocation create flags that will be passed to <a href='https://gpuopen-librariesandsdks.github.io/VulkanMemoryAllocator/html/struct_vma_allocation_create_info.html">VmaAllocationCreateInfo