aboutsummaryrefslogtreecommitdiff
path: root/src/vulkan/transfer_buffer.h
blob: 61ea89b2fba273fbc5a414bbe7fce7080661d2cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright 2018 The Amber Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_VULKAN_TRANSFER_BUFFER_H_
#define SRC_VULKAN_TRANSFER_BUFFER_H_

#include <vector>

#include "amber/result.h"
#include "amber/vulkan_header.h"
#include "src/vulkan/resource.h"

namespace amber {
namespace vulkan {

class CommandBuffer;
class Device;

// Class managing Vulkan Buffer i.e., VkBuffer |buffer_|. |memory_|
// has VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT and
// VK_MEMORY_PROPERTY_HOST_COHERENT_BIT properties and it is mapped
// to |buffer_|.
class TransferBuffer : public Resource {
 public:
  TransferBuffer(Device* device,
                 uint32_t size_in_bytes,
                 const VkPhysicalDeviceMemoryProperties& properties);
  ~TransferBuffer() override;

  // Create |buffer_| whose usage is |usage| and allocate |memory_|
  // with VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT and
  // VK_MEMORY_PROPERTY_HOST_COHERENT_BIT properties. It also maps
  // |memory_| to |buffer_|
  Result Initialize(const VkBufferUsageFlags usage);

  VkBuffer GetVkBuffer() const { return buffer_; }
  Result CreateVkBufferView(VkFormat format);
  VkBufferView GetVkBufferView() const { return view_; }

  // Since |buffer_| is mapped to host accessible and host coherent
  // memory |memory_|, this method only conducts memory barrier to
  // make it available to device domain.
  virtual Result CopyToDevice(CommandBuffer* command);

  // Fill memory from 0 to |raw_data.size()| with |raw_data|.
  void UpdateMemoryWithRawData(const std::vector<uint8_t>& raw_data);

  // Since |buffer_| is mapped to host accessible and host coherent
  // memory |memory_|, this method only conducts memory barrier to
  // make it available to host domain.
  Result CopyToHost(CommandBuffer* command) override;

 private:
  VkBuffer buffer_ = VK_NULL_HANDLE;
  VkBufferView view_ = VK_NULL_HANDLE;
  VkDeviceMemory memory_ = VK_NULL_HANDLE;
};

}  // namespace vulkan
}  // namespace amber

#endif  // SRC_VULKAN_TRANSFER_BUFFER_H_