KarmaEngine
Game Engine for practical learning and research purposes
Loading...
Searching...
No Matches
Karma::KarmaGui_ImplVulkan_Image_TextureData Struct Reference

Data structure containing the Mesa image texture relevant data. For instance, file and folder icons of Content Browser. More...

#include <KarmaGuiVulkanHandler.h>

Public Member Functions

 KarmaGui_ImplVulkan_Image_TextureData ()
 A constructor.
 

Public Attributes

std::string TextureLable
 The name of the image texture for Mesa.
 
uint32_t width
 2D width of the texture.
 
uint32_t height
 2D height of the texture.
 
uint32_t channels
 The number of image components in image texture.
 
size_t size
 The size, in bytes, of the image texture.
 
VkSampler TextureSampler
 This is a sampler handle, and is used in descriptor updates for types VK_DESCRIPTOR_TYPE_SAMPLER and VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being updated does not use immutable samplers.
 
VkDeviceMemory TextureMemory
 A VkDeviceMemory object describing the device memory, relevant to the image, to attach.
 
VkImage TextureImage
 The actual vulkan's image object.
 
VkImageView TextureView
 The image view representing contiguous ranges of the image subresources and containing additional metadata which are used by pipeline shaders for reading or writing image data.
 
VkDescriptorSet TextureDescriptorSet
 Container for uploading image texture relevant data, TextureView for instance, from CPU to GPU.
 
VkDeviceMemory UploadBufferMemory
 Device allocated memory for image pixels' buffer.
 
VkBuffer UploadBuffer
 Vulkan buffer containing texture pixels.
 

Detailed Description

Data structure containing the Mesa image texture relevant data. For instance, file and folder icons of Content Browser.

Similar to MesaDecalData in KarmaGuiOpenGLHandler.

Since
Karma 1.0.0

Constructor & Destructor Documentation

◆ KarmaGui_ImplVulkan_Image_TextureData()

Karma::KarmaGui_ImplVulkan_Image_TextureData::KarmaGui_ImplVulkan_Image_TextureData ( )
inline

A constructor.

Since
Karma 1.0.0

Member Data Documentation

◆ channels

uint32_t Karma::KarmaGui_ImplVulkan_Image_TextureData::channels

The number of image components in image texture.

See also
KarmaUtilities::GetImagePixelData
Since
Karma 1.0.0

◆ height

uint32_t Karma::KarmaGui_ImplVulkan_Image_TextureData::height

2D height of the texture.

Since
Karma 1.0.0

◆ size

size_t Karma::KarmaGui_ImplVulkan_Image_TextureData::size

The size, in bytes, of the image texture.

Formula:

width * height * 4 * sizeof(char)
uint32_t width
2D width of the texture.
Definition KarmaGuiVulkanHandler.h:612
uint32_t height
2D height of the texture.
Definition KarmaGuiVulkanHandler.h:619
Since
Karma 1.0.0

◆ TextureDescriptorSet

VkDescriptorSet Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureDescriptorSet

Container for uploading image texture relevant data, TextureView for instance, from CPU to GPU.

Since
Karma 1.0.0

◆ TextureImage

VkImage Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureImage

The actual vulkan's image object.

Since
Karma 1.0.0

◆ TextureLable

std::string Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureLable

The name of the image texture for Mesa.

Note
Ponder over similar member in MesaDecalData.
Since
Karma 1.0.0

◆ TextureMemory

VkDeviceMemory Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureMemory

A VkDeviceMemory object describing the device memory, relevant to the image, to attach.

Since
Karma 1.0.0

◆ TextureSampler

VkSampler Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureSampler

This is a sampler handle, and is used in descriptor updates for types VK_DESCRIPTOR_TYPE_SAMPLER and VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being updated does not use immutable samplers.

Since
Karma 1.0.0

◆ TextureView

VkImageView Karma::KarmaGui_ImplVulkan_Image_TextureData::TextureView

The image view representing contiguous ranges of the image subresources and containing additional metadata which are used by pipeline shaders for reading or writing image data.

Since
Karma 1.0.0

◆ UploadBuffer

VkBuffer Karma::KarmaGui_ImplVulkan_Image_TextureData::UploadBuffer

Vulkan buffer containing texture pixels.

Since
Karma 1.0.0

◆ UploadBufferMemory

VkDeviceMemory Karma::KarmaGui_ImplVulkan_Image_TextureData::UploadBufferMemory

Device allocated memory for image pixels' buffer.

Since
Karma 1.0.0

◆ width

uint32_t Karma::KarmaGui_ImplVulkan_Image_TextureData::width

2D width of the texture.

Since
Karma 1.0.0

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