src/Vulkan/VkBuffer.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_BUFFER_HPP_
  16 #define VK_BUFFER_HPP_
  17
  18 #include "VkObject.hpp"
  19
  20 namespace vk
  21 {
  22
  23 class Buffer : public Object<Buffer, VkBuffer>
  24 {
  25 public:
  26         Buffer(const VkBufferCreateInfo* pCreateInfo, void* mem);
  27         ~Buffer() = delete;
  28         void destroy(const VkAllocationCallbacks* pAllocator);
  29
  30         static size_t ComputeRequiredAllocationSize(const VkBufferCreateInfo* pCreateInfo);
  31
  32         const VkMemoryRequirements getMemoryRequirements() const;
  33         void bind(VkDeviceMemory pDeviceMemory, VkDeviceSize pMemoryOffset);
  34         void copyFrom(const void* srcMemory, VkDeviceSize size, VkDeviceSize offset);
  35         void copyTo(void* dstMemory, VkDeviceSize size, VkDeviceSize offset) const;
  36         void copyTo(Buffer* dstBuffer, const VkBufferCopy& pRegion) const;
  37         void fill(VkDeviceSize dstOffset, VkDeviceSize fillSize, uint32_t data);
  38         void update(VkDeviceSize dstOffset, VkDeviceSize dataSize, const void* pData);
  39         void* getOffsetPointer(VkDeviceSize offset) const;
  40
  41 private:
  42         void*                 memory = nullptr;
  43         VkBufferCreateFlags   flags = 0;
  44         VkDeviceSize          size = 0;
  45         VkBufferUsageFlags    usage = 0;
  46         VkSharingMode         sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  47         uint32_t              queueFamilyIndexCount = 0;
  48         uint32_t*             queueFamilyIndices = nullptr;
  49 };
  50
  51 static inline Buffer* Cast(VkBuffer object)
  52 {
  53         return reinterpret_cast<Buffer*>(object);
  54 }
  55
  56 } // namespace vk
  57
  58 #endif // VK_BUFFER_HPP_