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_VIEW_H
24 #define VK_BUFFER_VIEW_H
25 
26 #include "vk_object.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 struct vk_buffer_view {
33    struct vk_object_base base;
34 
35    /** VkBufferViewCreateInfo::buffer */
36    struct vk_buffer *buffer;
37 
38    /** VkBufferViewCreateInfo::format */
39    VkFormat format;
40 
41    /** VkBufferViewCreateInfo::offset */
42    VkDeviceSize offset;
43 
44    /** VkBufferViewCreateInfo::range
45     *
46     * This is asserted to be in-range for the attached buffer and will never
47     * be VK_WHOLE_SIZE.
48     */
49    VkDeviceSize range;
50 
51    /* Number of elements in the buffer.  This is range divided by the size of
52     * format, rounded down.
53     */
54    VkDeviceSize elements;
55 };
56 VK_DEFINE_NONDISP_HANDLE_CASTS(vk_buffer_view, base, VkBufferView,
57                                VK_OBJECT_TYPE_BUFFER_VIEW);
58 
59 void vk_buffer_view_init(struct vk_device *device,
60                          struct vk_buffer_view *buffer_view,
61                          const VkBufferViewCreateInfo *pCreateInfo);
62 void vk_buffer_view_finish(struct vk_buffer_view *buffer_view);
63 void *vk_buffer_view_create(struct vk_device *device,
64                             const VkBufferViewCreateInfo *pCreateInfo,
65                             const VkAllocationCallbacks *alloc,
66                             size_t size);
67 void vk_buffer_view_destroy(struct vk_device *device,
68                             const VkAllocationCallbacks *alloc,
69                             struct vk_buffer_view *buffer_view);
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif /* VK_BUFFER_VIEW_H */
76