source/backends/vulkan/texture_backend.cpp

   1 #include <msp/strings/format.h>
   2 #include "device.h"
   3 #include "error.h"
   4 #include "synchronizer.h"
   5 #include "texture.h"
   6 #include "texture_backend.h"
   7 #include "vulkan.h"
   8
   9 using namespace std;
  10
  11 namespace Msp {
  12 namespace GL {
  13
  14 VulkanTexture::VulkanTexture(unsigned t):
  15         device(Device::get_current()),
  16         view_type(t)
  17 { }
  18
  19 VulkanTexture::VulkanTexture(VulkanTexture &&other):
  20         device(other.device),
  21         handle(other.handle),
  22         view_handle(other.view_handle),
  23         memory_id(other.memory_id),
  24         view_type(other.view_type),
  25         debug_name(move(other.debug_name))
  26 {
  27         other.handle = 0;
  28         other.view_handle = 0;
  29         other.memory_id = 0;
  30 }
  31
  32 VulkanTexture::~VulkanTexture()
  33 {
  34         DestroyQueue &dq = device.get_destroy_queue();
  35
  36         if(view_handle)
  37                 dq.destroy(view_handle);
  38         if(mip_view_handles.size()>1)
  39         {
  40                 for(VkImageView i: mip_view_handles)
  41                         dq.destroy(i);
  42         }
  43         if(handle)
  44                 dq.destroy(handle, memory_id);
  45 }
  46
  47 void VulkanTexture::allocate()
  48 {
  49         const Texture &self = *static_cast<const Texture *>(this);
  50         const VulkanFunctions &vk = device.get_functions();
  51
  52         VkFormat vk_format = static_cast<VkFormat>(get_vulkan_pixelformat(self.storage_fmt));
  53         VkFormatProperties props;
  54         vk.GetPhysicalDeviceFormatProperties(vk_format, props);
  55
  56         VkImageCreateInfo image_info = { };
  57         image_info.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
  58         image_info.format = vk_format;
  59         image_info.extent.width = 1;
  60         image_info.extent.height = 1;
  61         image_info.extent.depth = 1;
  62         image_info.mipLevels = self.n_levels;
  63         image_info.arrayLayers = 1;
  64         image_info.samples = VK_SAMPLE_COUNT_1_BIT;
  65         image_info.tiling = VK_IMAGE_TILING_OPTIMAL;
  66         image_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  67         image_info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  68
  69         image_info.usage = VK_IMAGE_USAGE_TRANSFER_SRC_BIT|VK_IMAGE_USAGE_TRANSFER_DST_BIT|VK_IMAGE_USAGE_SAMPLED_BIT;
  70         if(props.optimalTilingFeatures&VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)
  71                 image_info.usage |= VK_IMAGE_USAGE_STORAGE_BIT;
  72
  73         PixelComponents comp = get_components(self.storage_fmt);
  74         if(comp==DEPTH_COMPONENT || comp==STENCIL_INDEX)
  75                 image_info.usage |= VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
  76         else
  77                 image_info.usage |= VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  78
  79         fill_image_info(&image_info);
  80
  81         /* SwapChainTexture may have already provided the image.  Create_info is
  82         filled anyway because some of its fields are used for view_info. */
  83         if(!handle)
  84         {
  85                 vk.CreateImage(image_info, handle);
  86                 memory_id = device.get_allocator().allocate(handle, DEVICE_MEMORY);
  87
  88                 // Trigger a layout transition if the image is used before uploading data.
  89                 change_layout(-1, VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, true);
  90         }
  91
  92         view_handle = create_view(-1);
  93
  94         if(!debug_name.empty())
  95                 set_vulkan_object_names();
  96 }
  97
  98 VkImageView VulkanTexture::create_view(int level) const
  99 {
 100         const Texture &self = *static_cast<const Texture *>(this);
 101         const VulkanFunctions &vk = device.get_functions();
 102
 103         VkImageViewCreateInfo view_info = { };
 104         view_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
 105         view_info.image = handle_cast<::VkImage>(handle);
 106         view_info.viewType = static_cast<VkImageViewType>(view_type);
 107         view_info.format = static_cast<VkFormat>(get_vulkan_pixelformat(self.storage_fmt));
 108
 109         const unsigned *swizzle_order = get_vulkan_swizzle(self.swizzle);
 110         view_info.components.r = static_cast<VkComponentSwizzle>(swizzle_order[0]);
 111         view_info.components.g = static_cast<VkComponentSwizzle>(swizzle_order[1]);
 112         view_info.components.b = static_cast<VkComponentSwizzle>(swizzle_order[2]);
 113         view_info.components.a = static_cast<VkComponentSwizzle>(swizzle_order[3]);
 114
 115         view_info.subresourceRange.aspectMask = get_vulkan_aspect(get_components(self.storage_fmt));
 116         view_info.subresourceRange.baseMipLevel = max(level, 0);
 117         view_info.subresourceRange.levelCount = (level<0 ? VK_REMAINING_MIP_LEVELS : 1);
 118         view_info.subresourceRange.baseArrayLayer = 0;
 119         view_info.subresourceRange.layerCount = VK_REMAINING_ARRAY_LAYERS;
 120
 121         VkImageView view;
 122         vk.CreateImageView(view_info, view);
 123
 124         return view;
 125 }
 126
 127 void VulkanTexture::create_mip_views() const
 128 {
 129         const Texture &self = *static_cast<const Texture *>(this);
 130
 131         if(!mip_view_handles.empty())
 132                 return;
 133
 134         mip_view_handles.resize(self.n_levels);
 135         if(self.n_levels==1)
 136                 mip_view_handles[0] = view_handle;
 137         else
 138         {
 139                 for(unsigned i=0; i<self.n_levels; ++i)
 140                         mip_view_handles[i] = create_view(i);
 141         }
 142 }
 143
 144 void VulkanTexture::generate_mipmap()
 145 {
 146         unsigned n_levels = static_cast<const Texture *>(this)->n_levels;
 147
 148         TransferQueue &tq = device.get_transfer_queue();
 149         for(unsigned i=0; i+1<n_levels; ++i)
 150         {
 151                 tq.prepare_transfer(this, true,
 152                         [this, i](){
 153                                 change_layout(i, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, false);
 154                                 change_layout(i+1, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, true);
 155                         },
 156                         [this, i](const VulkanCommandRecorder &vkCmd, VkBuffer, size_t){
 157                                 const Texture &self = *static_cast<const Texture *>(this);
 158
 159                                 VkImageBlit region = { };
 160                                 region.srcSubresource.aspectMask = get_vulkan_aspect(get_components(self.storage_fmt));
 161                                 region.srcSubresource.mipLevel = i;
 162                                 region.srcSubresource.baseArrayLayer = 0;
 163                                 region.srcSubresource.layerCount = 1;
 164                                 region.dstSubresource = region.srcSubresource;
 165                                 ++region.dstSubresource.mipLevel;
 166
 167                                 fill_mipmap_blit(i, &region);
 168
 169                                 vkCmd.BlitImage(handle, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, handle, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL,
 170                                         1, &region, VK_FILTER_LINEAR);
 171                         });
 172         }
 173 }
 174
 175 void VulkanTexture::change_layout(int level, unsigned layout, bool discard) const
 176 {
 177         const Texture &self = *static_cast<const Texture *>(this);
 178
 179         unsigned aspect = get_vulkan_aspect(get_components(self.storage_fmt));
 180         if(level>=0)
 181                 device.get_synchronizer().split_image_mipmap(handle, aspect, self.n_levels);
 182         device.get_synchronizer().change_image_layout(handle, aspect, level, layout, discard);
 183 }
 184
 185 void VulkanTexture::set_debug_name(const string &name)
 186 {
 187 #ifdef DEBUG
 188         debug_name = name;
 189         if(handle)
 190                 set_vulkan_object_names();
 191 #else
 192         (void)name;
 193 #endif
 194 }
 195
 196 void VulkanTexture::set_vulkan_object_names() const
 197 {
 198 #ifdef DEBUG
 199         const VulkanFunctions &vk = device.get_functions();
 200
 201         VkDebugUtilsObjectNameInfoEXT name_info = { };
 202         name_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
 203         name_info.objectType = VK_OBJECT_TYPE_IMAGE;
 204         name_info.objectHandle = reinterpret_cast<uint64_t>(handle);
 205         name_info.pObjectName = debug_name.c_str();
 206         vk.SetDebugUtilsObjectName(name_info);
 207
 208         string view_name = debug_name+"/view";
 209         name_info.objectType = VK_OBJECT_TYPE_IMAGE_VIEW;
 210         name_info.objectHandle = reinterpret_cast<uint64_t>(view_handle);
 211         name_info.pObjectName = view_name.c_str();
 212         vk.SetDebugUtilsObjectName(name_info);
 213
 214         if(mip_view_handles.size()>1)
 215         {
 216                 for(unsigned i=0; i<mip_view_handles.size(); ++i)
 217                 {
 218                         view_name = format("%s/mip%d.view", debug_name, i);
 219                         name_info.objectHandle = reinterpret_cast<uint64_t>(mip_view_handles[i]);
 220                         name_info.pObjectName = view_name.c_str();
 221                         vk.SetDebugUtilsObjectName(name_info);
 222                 }
 223         }
 224 #endif
 225 }
 226
 227 } // namespace GL
 228 } // namespace Msp