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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
// 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_DESCRIPTOR_H_
#define SRC_VULKAN_DESCRIPTOR_H_
#include <memory>
#include <vector>
#include "amber/result.h"
#include "amber/vulkan_header.h"
#include "src/datum_type.h"
#include "src/engine.h"
#include "src/vulkan/resource.h"
namespace amber {
namespace vulkan {
enum class DescriptorType : uint8_t {
kStorageBuffer = 0,
kUniformBuffer,
};
class CommandBuffer;
class Device;
VkDescriptorType ToVkDescriptorType(DescriptorType type);
class Descriptor {
public:
Descriptor(DescriptorType type,
Device* device,
uint32_t desc_set,
uint32_t binding);
virtual ~Descriptor();
uint32_t GetDescriptorSet() const { return descriptor_set_; }
uint32_t GetBinding() const { return binding_; }
DescriptorType GetType() const { return type_; }
bool IsStorageBuffer() const {
return type_ == DescriptorType::kStorageBuffer;
}
bool IsUniformBuffer() const {
return type_ == DescriptorType::kUniformBuffer;
}
// Call vkUpdateDescriptorSets() to update the backing resource
// for this descriptor only when the backing resource was newly
// created or changed.
virtual Result UpdateDescriptorSetIfNeeded(VkDescriptorSet) = 0;
// Create vulkan resource e.g., buffer or image used for this
// descriptor if needed. This method assumes that the resource is empty when
// it is called that means the resource must be created only when it is
// actually needed i.e., compute or draw command and destroyed right after
// those commands.
virtual Result CreateResourceIfNeeded(
const VkPhysicalDeviceMemoryProperties& properties) = 0;
// Record a command for copying buffer data to the resource in device. After
// the copy it clears the internal buffer data. Note that
// it only records the command and the actual submission must be
// done later.
virtual Result RecordCopyDataToResourceIfNeeded(CommandBuffer* command) = 0;
// Only record the copy command for copying the resource data to
// the host accessible memory. The actual submission of the command
// must be done later.
virtual Result RecordCopyDataToHost(CommandBuffer* command) = 0;
// Copy contents of resource e.g., VkBuffer to host buffer.
// This method assumes that we already copy the resource data to the host
// accessible memory by calling RecordCopyDataToHost() method and submitting
// the command buffer. After copying the contents, it destroys |buffer_|.
virtual Result MoveResourceToBufferOutput() = 0;
protected:
Result UpdateDescriptorSetForBuffer(
VkDescriptorSet descriptor_set,
VkDescriptorType descriptor_type,
const VkDescriptorBufferInfo& buffer_info);
void SetUpdateDescriptorSetNeeded() {
is_descriptor_set_update_needed_ = true;
}
bool IsDescriptorSetUpdateNeeded() {
return is_descriptor_set_update_needed_;
}
uint32_t descriptor_set_ = 0;
uint32_t binding_ = 0;
Device* device_ = nullptr;
private:
VkWriteDescriptorSet GetWriteDescriptorSet(
VkDescriptorSet descriptor_set,
VkDescriptorType descriptor_type) const;
void UpdateVkDescriptorSet(const VkWriteDescriptorSet& write);
DescriptorType type_ = DescriptorType::kStorageBuffer;
bool is_descriptor_set_update_needed_ = false;
};
} // namespace vulkan
} // namespace amber
#endif // SRC_VULKAN_DESCRIPTOR_H_
|
