src/Vulkan/VkImage.hpp

   1 // Copyright 2018 The SwiftShader Authors. All Rights Reserved.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //    http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 #ifndef VK_IMAGE_HPP_
  16 #define VK_IMAGE_HPP_
  17
  18 #include "VkObject.hpp"
  19 #include "VkFormat.h"
  20
  21 namespace vk
  22 {
  23
  24 class Device;
  25 class DeviceMemory;
  26
  27 class Image : public Object<Image, VkImage>
  28 {
  29 public:
  30         struct CreateInfo
  31         {
  32                 const VkImageCreateInfo* pCreateInfo;
  33                 const VkDevice device;
  34         };
  35
  36         Image(const CreateInfo* pCreateInfo, void* mem);
  37         ~Image() = delete;
  38         void destroy(const VkAllocationCallbacks* pAllocator);
  39
  40         static size_t ComputeRequiredAllocationSize(const CreateInfo* pCreateInfo);
  41
  42         const VkMemoryRequirements getMemoryRequirements() const;
  43         void getSubresourceLayout(const VkImageSubresource* pSubresource, VkSubresourceLayout* pLayout) const;
  44         void bind(VkDeviceMemory pDeviceMemory, VkDeviceSize pMemoryOffset);
  45         void copyTo(VkImage dstImage, const VkImageCopy& pRegion);
  46         void copyTo(VkBuffer dstBuffer, const VkBufferImageCopy& region);
  47         void copyFrom(VkBuffer srcBuffer, const VkBufferImageCopy& region);
  48
  49         void blit(VkImage dstImage, const VkImageBlit& region, VkFilter filter);
  50         void clear(const VkClearValue& clearValue, const VkRect2D& renderArea, const VkImageSubresourceRange& subresourceRange);
  51         void clear(const VkClearColorValue& color, const VkImageSubresourceRange& subresourceRange);
  52         void clear(const VkClearDepthStencilValue& color, const VkImageSubresourceRange& subresourceRange);
  53
  54         VkImageType              getImageType() const { return imageType; }
  55         const Format&            getFormat() const { return format; }
  56         Format                   getFormat(VkImageAspectFlagBits aspect) const;
  57         uint32_t                 getArrayLayers() const { return arrayLayers; }
  58         uint32_t                 getMipLevels() const { return mipLevels; }
  59         uint32_t                 getLastLayerIndex(const VkImageSubresourceRange& subresourceRange) const;
  60         uint32_t                 getLastMipLevel(const VkImageSubresourceRange& subresourceRange) const;
  61         VkSampleCountFlagBits    getSampleCountFlagBits() const { return samples; }
  62         VkExtent3D               getMipLevelExtent(uint32_t mipLevel) const;
  63         int                      rowPitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel) const;
  64         int                      slicePitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel) const;
  65         void*                    getTexelPointer(const VkOffset3D& offset, const VkImageSubresourceLayers& subresource) const;
  66         bool                     isCube() const;
  67         uint8_t*                 end() const;
  68
  69 private:
  70         void copy(VkBuffer buffer, const VkBufferImageCopy& region, bool bufferIsSource);
  71         VkDeviceSize getStorageSize(VkImageAspectFlags flags) const;
  72         VkDeviceSize getMipLevelSize(VkImageAspectFlagBits aspect, uint32_t mipLevel) const;
  73         VkDeviceSize getMultiSampledLevelSize(VkImageAspectFlagBits aspect, uint32_t mipLevel) const;
  74         VkDeviceSize getLayerSize(VkImageAspectFlagBits aspect) const;
  75         VkDeviceSize getMemoryOffset(VkImageAspectFlagBits aspect, uint32_t mipLevel) const;
  76         VkDeviceSize getMemoryOffset(VkImageAspectFlagBits aspect, uint32_t mipLevel, uint32_t layer) const;
  77         VkDeviceSize texelOffsetBytesInStorage(const VkOffset3D& offset, const VkImageSubresourceLayers& subresource) const;
  78         VkDeviceSize getMemoryOffset(VkImageAspectFlagBits aspect) const;
  79         VkExtent3D imageExtentInBlocks(const VkExtent3D& extent, VkImageAspectFlagBits aspect) const;
  80         VkOffset3D imageOffsetInBlocks(const VkOffset3D& offset, VkImageAspectFlagBits aspect) const;
  81         VkExtent2D bufferExtentInBlocks(const VkExtent2D& extent, const VkBufferImageCopy& region) const;
  82         int bytesPerTexel(VkImageAspectFlagBits flags) const;
  83         VkFormat getClearFormat() const;
  84         void clear(void* pixelData, VkFormat format, const VkImageSubresourceRange& subresourceRange, const VkRect2D& renderArea);
  85
  86         const Device *const      device = nullptr;
  87         DeviceMemory*            deviceMemory = nullptr;
  88         VkDeviceSize             memoryOffset = 0;
  89         VkImageCreateFlags       flags = 0;
  90         VkImageType              imageType = VK_IMAGE_TYPE_2D;
  91         Format                   format;
  92         VkExtent3D               extent = {0, 0, 0};
  93         uint32_t                 mipLevels = 0;
  94         uint32_t                 arrayLayers = 0;
  95         VkSampleCountFlagBits    samples = VK_SAMPLE_COUNT_1_BIT;
  96         VkImageTiling            tiling = VK_IMAGE_TILING_OPTIMAL;
  97 };
  98
  99 static inline Image* Cast(VkImage object)
 100 {
 101         return reinterpret_cast<Image*>(object);
 102 }
 103
 104 } // namespace vk
 105
 106 #endif // VK_IMAGE_HPP_