1 /*
2 * Copyright © 2022 Collabora, Ltd.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 */
23 #ifndef VK_BUFFER_H
24 #define VK_BUFFER_H
25
26 #include "vk_object.h"
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct vk_buffer {
33 struct vk_object_base base;
34
35 /** VkBufferCreateInfo::flags */
36 VkBufferCreateFlags create_flags;
37
38 /** VkBufferCreateInfo::size */
39 VkDeviceSize size;
40
41 /** VkBufferCreateInfo::usage or VkBufferUsageFlags2CreateInfoKHR::usage */
42 VkBufferUsageFlags2KHR usage;
43 };
44 VK_DEFINE_NONDISP_HANDLE_CASTS(vk_buffer, base, VkBuffer,
45 VK_OBJECT_TYPE_BUFFER);
46
47 void vk_buffer_init(struct vk_device *device,
48 struct vk_buffer *buffer,
49 const VkBufferCreateInfo *pCreateInfo);
50 void vk_buffer_finish(struct vk_buffer *buffer);
51
52 void *vk_buffer_create(struct vk_device *device,
53 const VkBufferCreateInfo *pCreateInfo,
54 const VkAllocationCallbacks *alloc,
55 size_t size);
56 void vk_buffer_destroy(struct vk_device *device,
57 const VkAllocationCallbacks *alloc,
58 struct vk_buffer *buffer);
59
60 static inline uint64_t
vk_buffer_range(const struct vk_buffer * buffer,uint64_t offset,uint64_t range)61 vk_buffer_range(const struct vk_buffer *buffer,
62 uint64_t offset, uint64_t range)
63 {
64 assert(offset <= buffer->size);
65 if (range == VK_WHOLE_SIZE) {
66 return buffer->size - offset;
67 } else {
68 assert(range + offset >= range);
69 assert(range + offset <= buffer->size);
70 return range;
71 }
72 }
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif /* VK_BUFFER_H */
79