blob: f5b52d5c57f73058ea6312251693627d74e13a34 [file] [log] [blame]
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001//
2// File: vulkan.h
3//
4/*
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06005** Copyright (c) 2014-2015 The Khronos Group Inc.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06006**
7** Permission is hereby granted, free of charge, to any person obtaining a
8** copy of this software and/or associated documentation files (the
9** "Materials"), to deal in the Materials without restriction, including
10** without limitation the rights to use, copy, modify, merge, publish,
11** distribute, sublicense, and/or sell copies of the Materials, and to
12** permit persons to whom the Materials are furnished to do so, subject to
13** the following conditions:
14**
15** The above copyright notice and this permission notice shall be included
16** in all copies or substantial portions of the Materials.
17**
18** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
25*/
26
27#ifndef __VULKAN_H__
28#define __VULKAN_H__
29
30#define VK_MAKE_VERSION(major, minor, patch) \
31 ((major << 22) | (minor << 12) | patch)
32
Courtney Goeltzenleuchter2040b432015-04-09 11:52:55 -060033#include "vk_platform.h"
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060034
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -060035// Vulkan API version supported by this file
Mark Lobodzinski4e97c452015-07-01 15:18:26 -060036#define VK_API_VERSION VK_MAKE_VERSION(0, 116, 0)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060037
38#ifdef __cplusplus
39extern "C"
40{
41#endif // __cplusplus
42
43/*
44***************************************************************************************************
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -060045* Core Vulkan API
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060046***************************************************************************************************
47*/
48
Mike Stroyan230e6252015-04-17 12:36:38 -060049#if defined (__cplusplus) && (VK_UINTPTRLEAST64_MAX == UINTPTR_MAX)
50 #define VK_TYPE_SAFE_COMPATIBLE_HANDLES 1
51#endif
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060052
Mike Stroyan230e6252015-04-17 12:36:38 -060053#if defined(VK_TYPE_SAFE_COMPATIBLE_HANDLES) && !defined(VK_DISABLE_TYPE_SAFE_HANDLES)
54 #define VK_DEFINE_PTR_HANDLE(_obj) struct _obj##_T { char _dummy; }; typedef _obj##_T* _obj;
55 #define VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base) struct _obj##_T : public _base##_T {}; typedef _obj##_T* _obj;
56
57 #define VK_DEFINE_BASE_HANDLE(_obj) VK_DEFINE_PTR_HANDLE(_obj)
58 #define VK_DEFINE_DISP_SUBCLASS_HANDLE(_obj, _base) VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base)
59 #define VK_DEFINE_NONDISP_SUBCLASS_HANDLE(_obj, _base) VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base)
60#else
61 #define VK_DEFINE_BASE_HANDLE(_obj) typedef VkUintPtrLeast64 _obj;
62 #define VK_DEFINE_DISP_SUBCLASS_HANDLE(_obj, _base) typedef uintptr_t _obj;
63 #define VK_DEFINE_NONDISP_SUBCLASS_HANDLE(_obj, _base) typedef VkUintPtrLeast64 _obj;
64#endif
65
66VK_DEFINE_BASE_HANDLE(VkObject)
67
68VK_DEFINE_DISP_SUBCLASS_HANDLE(VkInstance, VkObject)
69VK_DEFINE_DISP_SUBCLASS_HANDLE(VkPhysicalDevice, VkObject)
70VK_DEFINE_DISP_SUBCLASS_HANDLE(VkDevice, VkObject)
71VK_DEFINE_DISP_SUBCLASS_HANDLE(VkQueue, VkObject)
72VK_DEFINE_DISP_SUBCLASS_HANDLE(VkCmdBuffer, VkObject)
73
74VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkNonDispatchable, VkObject)
75VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDeviceMemory, VkNonDispatchable)
76VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkBuffer, VkNonDispatchable)
77VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkBufferView, VkNonDispatchable)
78VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkImage, VkNonDispatchable)
79VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkImageView, VkNonDispatchable)
80VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkColorAttachmentView, VkNonDispatchable)
81VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDepthStencilView, VkNonDispatchable)
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -060082VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkShaderModule, VkNonDispatchable)
Mike Stroyan230e6252015-04-17 12:36:38 -060083VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkShader, VkNonDispatchable)
84VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipeline, VkNonDispatchable)
85VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipelineLayout, VkNonDispatchable)
86VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSampler, VkNonDispatchable)
87VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSet, VkNonDispatchable)
88VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSetLayout, VkNonDispatchable)
89VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorPool, VkNonDispatchable)
90VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicStateObject, VkNonDispatchable)
91VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicVpState, VkDynamicStateObject)
92VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicRsState, VkDynamicStateObject)
93VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicCbState, VkDynamicStateObject)
94VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicDsState, VkDynamicStateObject)
95VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFence, VkNonDispatchable)
96VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSemaphore, VkNonDispatchable)
97VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkEvent, VkNonDispatchable)
98VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkQueryPool, VkNonDispatchable)
99VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFramebuffer, VkNonDispatchable)
100VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkRenderPass, VkNonDispatchable)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600101
Tony Barbour8205d902015-04-16 15:59:00 -0600102#define VK_MAX_PHYSICAL_DEVICE_NAME 256
Mike Stroyan230e6252015-04-17 12:36:38 -0600103#define VK_MAX_EXTENSION_NAME 256
Mark Lobodzinski72346292015-07-02 16:49:40 -0600104#define VK_MAX_MEMORY_TYPES 32
105#define VK_MAX_MEMORY_HEAPS 16
106#define VK_LOD_CLAMP_NONE MAX_FLOAT
107#define VK_LAST_MIP_LEVEL UINT32_MAX
108#define VK_LAST_ARRAY_SLICE UINT32_MAX
Courtney Goeltzenleuchterdac96cf2015-06-04 11:35:43 -0600109
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600110
Tony Barbour8205d902015-04-16 15:59:00 -0600111#define VK_WHOLE_SIZE UINT64_MAX
112
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600113#define VK_TRUE 1
114#define VK_FALSE 0
115
116#define VK_NULL_HANDLE 0
117
118// This macro defines INT_MAX in enumerations to force compilers to use 32 bits
119// to represent them. This may or may not be necessary on some compilers. The
120// option to compile it out may allow compilers that warn about missing enumerants
121// in switch statements to be silenced.
Tony Barbour8205d902015-04-16 15:59:00 -0600122// Using this macro is not needed for flag bit enums because those aren't used
123// as storage type anywhere.
124#define VK_MAX_ENUM(Prefix) VK_##Prefix##_MAX_ENUM = 0x7FFFFFFF
125
126// This macro defines the BEGIN_RANGE, END_RANGE, NUM, and MAX_ENUM constants for
127// the enumerations.
128#define VK_ENUM_RANGE(Prefix, First, Last) \
129 VK_##Prefix##_BEGIN_RANGE = VK_##Prefix##_##First, \
130 VK_##Prefix##_END_RANGE = VK_##Prefix##_##Last, \
131 VK_NUM_##Prefix = (VK_##Prefix##_END_RANGE - VK_##Prefix##_BEGIN_RANGE + 1), \
132 VK_MAX_ENUM(Prefix)
133
134// This is a helper macro to define the value of flag bit enum values.
135#define VK_BIT(bit) (1 << (bit))
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600136
137// ------------------------------------------------------------------------------------------------
138// Enumerations
139
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600140typedef enum VkImageLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600141{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600142 VK_IMAGE_LAYOUT_UNDEFINED = 0x00000000, // Implicit layout an image is when its contents are undefined due to various reasons (e.g. right after creation)
143 VK_IMAGE_LAYOUT_GENERAL = 0x00000001, // General layout when image can be used for any kind of access
144 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL = 0x00000002, // Optimal layout when image is only used for color attachment read/write
145 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL = 0x00000003, // Optimal layout when image is only used for depth/stencil attachment read/write
146 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL = 0x00000004, // Optimal layout when image is used for read only depth/stencil attachment and shader access
147 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL = 0x00000005, // Optimal layout when image is used for read only shader access
Mark Lobodzinski4e97c452015-07-01 15:18:26 -0600148 VK_IMAGE_LAYOUT_TRANSFER_SOURCE_OPTIMAL = 0x00000006, // Optimal layout when image is used only as source of transfer operations
149 VK_IMAGE_LAYOUT_TRANSFER_DESTINATION_OPTIMAL = 0x00000007, // Optimal layout when image is used only as destination of transfer operations
Tony Barbour3e3420a2015-04-16 19:09:28 -0600150
Tony Barbour8205d902015-04-16 15:59:00 -0600151 VK_ENUM_RANGE(IMAGE_LAYOUT, UNDEFINED, TRANSFER_DESTINATION_OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600152} VkImageLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600153
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600154typedef enum VkAttachmentLoadOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600155{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600156 VK_ATTACHMENT_LOAD_OP_LOAD = 0x00000000,
157 VK_ATTACHMENT_LOAD_OP_CLEAR = 0x00000001,
158 VK_ATTACHMENT_LOAD_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600159
Tony Barbour8205d902015-04-16 15:59:00 -0600160 VK_ENUM_RANGE(ATTACHMENT_LOAD_OP, LOAD, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600161} VkAttachmentLoadOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600162
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600163typedef enum VkAttachmentStoreOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600164{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600165 VK_ATTACHMENT_STORE_OP_STORE = 0x00000000,
166 VK_ATTACHMENT_STORE_OP_RESOLVE_MSAA = 0x00000001,
167 VK_ATTACHMENT_STORE_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600168
Tony Barbour8205d902015-04-16 15:59:00 -0600169 VK_ENUM_RANGE(ATTACHMENT_STORE_OP, STORE, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600170} VkAttachmentStoreOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600171
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600172typedef enum VkImageType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600173{
Tony Barbour8205d902015-04-16 15:59:00 -0600174 VK_IMAGE_TYPE_1D = 0x00000000,
175 VK_IMAGE_TYPE_2D = 0x00000001,
176 VK_IMAGE_TYPE_3D = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600177
Tony Barbour8205d902015-04-16 15:59:00 -0600178 VK_ENUM_RANGE(IMAGE_TYPE, 1D, 3D)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600179} VkImageType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600180
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600181typedef enum VkImageTiling_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600182{
Tony Barbour8205d902015-04-16 15:59:00 -0600183 VK_IMAGE_TILING_LINEAR = 0x00000000,
184 VK_IMAGE_TILING_OPTIMAL = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600185
Tony Barbour8205d902015-04-16 15:59:00 -0600186 VK_ENUM_RANGE(IMAGE_TILING, LINEAR, OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600187} VkImageTiling;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600188
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600189typedef enum VkImageViewType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600190{
Tony Barbour8205d902015-04-16 15:59:00 -0600191 VK_IMAGE_VIEW_TYPE_1D = 0x00000000,
192 VK_IMAGE_VIEW_TYPE_2D = 0x00000001,
193 VK_IMAGE_VIEW_TYPE_3D = 0x00000002,
194 VK_IMAGE_VIEW_TYPE_CUBE = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600195
Tony Barbour8205d902015-04-16 15:59:00 -0600196 VK_ENUM_RANGE(IMAGE_VIEW_TYPE, 1D, CUBE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600197} VkImageViewType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600198
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600199typedef enum VkImageAspect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600200{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600201 VK_IMAGE_ASPECT_COLOR = 0x00000000,
202 VK_IMAGE_ASPECT_DEPTH = 0x00000001,
203 VK_IMAGE_ASPECT_STENCIL = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600204
Tony Barbour8205d902015-04-16 15:59:00 -0600205 VK_ENUM_RANGE(IMAGE_ASPECT, COLOR, STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600206} VkImageAspect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600207
Tony Barbour8205d902015-04-16 15:59:00 -0600208typedef enum VkBufferViewType_
209{
210 VK_BUFFER_VIEW_TYPE_RAW = 0x00000000, // Raw buffer without special structure (UBO, SSBO)
211 VK_BUFFER_VIEW_TYPE_FORMATTED = 0x00000001, // Buffer with format (TBO, IBO)
212
213 VK_ENUM_RANGE(BUFFER_VIEW_TYPE, RAW, FORMATTED)
214} VkBufferViewType;
215
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600216typedef enum VkChannelSwizzle_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600217{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600218 VK_CHANNEL_SWIZZLE_ZERO = 0x00000000,
219 VK_CHANNEL_SWIZZLE_ONE = 0x00000001,
220 VK_CHANNEL_SWIZZLE_R = 0x00000002,
221 VK_CHANNEL_SWIZZLE_G = 0x00000003,
222 VK_CHANNEL_SWIZZLE_B = 0x00000004,
223 VK_CHANNEL_SWIZZLE_A = 0x00000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600224
Tony Barbour8205d902015-04-16 15:59:00 -0600225 VK_ENUM_RANGE(CHANNEL_SWIZZLE, ZERO, A)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600226} VkChannelSwizzle;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600227
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600228typedef enum VkDescriptorType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600229{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600230 VK_DESCRIPTOR_TYPE_SAMPLER = 0x00000000,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600231 VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER = 0x00000001,
232 VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE = 0x00000002,
233 VK_DESCRIPTOR_TYPE_STORAGE_IMAGE = 0x00000003,
234 VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER = 0x00000004,
235 VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER = 0x00000005,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600236 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER = 0x00000006,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600237 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER = 0x00000007,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600238 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC = 0x00000008,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600239 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC = 0x00000009,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600240
Tony Barbour8205d902015-04-16 15:59:00 -0600241 VK_ENUM_RANGE(DESCRIPTOR_TYPE, SAMPLER, STORAGE_BUFFER_DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600242} VkDescriptorType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600243
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600244typedef enum VkDescriptorPoolUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600245{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600246 VK_DESCRIPTOR_POOL_USAGE_ONE_SHOT = 0x00000000,
247 VK_DESCRIPTOR_POOL_USAGE_DYNAMIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600248
Tony Barbour8205d902015-04-16 15:59:00 -0600249 VK_ENUM_RANGE(DESCRIPTOR_POOL_USAGE, ONE_SHOT, DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600250} VkDescriptorPoolUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600251
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600252typedef enum VkDescriptorSetUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600253{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600254 VK_DESCRIPTOR_SET_USAGE_ONE_SHOT = 0x00000000,
255 VK_DESCRIPTOR_SET_USAGE_STATIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600256
Tony Barbour8205d902015-04-16 15:59:00 -0600257 VK_ENUM_RANGE(DESCRIPTOR_SET_USAGE, ONE_SHOT, STATIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600258} VkDescriptorSetUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600259
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600260typedef enum VkQueryType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600261{
Tony Barbour8205d902015-04-16 15:59:00 -0600262 VK_QUERY_TYPE_OCCLUSION = 0x00000000,
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -0600263 VK_QUERY_TYPE_PIPELINE_STATISTICS = 0x00000001, // Optional
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600264
Tony Barbour8205d902015-04-16 15:59:00 -0600265 VK_ENUM_RANGE(QUERY_TYPE, OCCLUSION, PIPELINE_STATISTICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600266} VkQueryType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600267
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600268typedef enum VkTimestampType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600269{
Tony Barbour8205d902015-04-16 15:59:00 -0600270 VK_TIMESTAMP_TYPE_TOP = 0x00000000,
271 VK_TIMESTAMP_TYPE_BOTTOM = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600272
Tony Barbour8205d902015-04-16 15:59:00 -0600273 VK_ENUM_RANGE(TIMESTAMP_TYPE, TOP, BOTTOM)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600274} VkTimestampType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600275
Tony Barbour8205d902015-04-16 15:59:00 -0600276typedef enum VkBorderColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600277{
Tony Barbour2c4e7c72015-06-25 16:56:44 -0600278 VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK = 0x00000000,
279 VK_BORDER_COLOR_INT_TRANSPARENT_BLACK = 0x00000001,
280 VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK = 0x00000002,
281 VK_BORDER_COLOR_INT_OPAQUE_BLACK = 0x00000003,
282 VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE = 0x00000004,
283 VK_BORDER_COLOR_INT_OPAQUE_WHITE = 0x00000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600284
Tony Barbour2c4e7c72015-06-25 16:56:44 -0600285 VK_ENUM_RANGE(BORDER_COLOR, FLOAT_TRANSPARENT_BLACK, INT_OPAQUE_WHITE)
Tony Barbour8205d902015-04-16 15:59:00 -0600286} VkBorderColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600287
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600288typedef enum VkPipelineBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600289{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600290 VK_PIPELINE_BIND_POINT_COMPUTE = 0x00000000,
291 VK_PIPELINE_BIND_POINT_GRAPHICS = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600292
Tony Barbour8205d902015-04-16 15:59:00 -0600293 VK_ENUM_RANGE(PIPELINE_BIND_POINT, COMPUTE, GRAPHICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600294} VkPipelineBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600295
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600296typedef enum VkStateBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600297{
Tony Barbour8205d902015-04-16 15:59:00 -0600298 VK_STATE_BIND_POINT_VIEWPORT = 0x00000000,
299 VK_STATE_BIND_POINT_RASTER = 0x00000001,
300 VK_STATE_BIND_POINT_COLOR_BLEND = 0x00000002,
301 VK_STATE_BIND_POINT_DEPTH_STENCIL = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600302
Tony Barbour8205d902015-04-16 15:59:00 -0600303 VK_ENUM_RANGE(STATE_BIND_POINT, VIEWPORT, DEPTH_STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600304} VkStateBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600305
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600306typedef enum VkPrimitiveTopology_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600307{
Tony Barbour8205d902015-04-16 15:59:00 -0600308 VK_PRIMITIVE_TOPOLOGY_POINT_LIST = 0x00000000,
309 VK_PRIMITIVE_TOPOLOGY_LINE_LIST = 0x00000001,
310 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP = 0x00000002,
311 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST = 0x00000003,
312 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP = 0x00000004,
313 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN = 0x00000005,
314 VK_PRIMITIVE_TOPOLOGY_LINE_LIST_ADJ = 0x00000006,
315 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_ADJ = 0x00000007,
316 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_ADJ = 0x00000008,
317 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_ADJ = 0x00000009,
318 VK_PRIMITIVE_TOPOLOGY_PATCH = 0x0000000a,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600319
Tony Barbour8205d902015-04-16 15:59:00 -0600320 VK_ENUM_RANGE(PRIMITIVE_TOPOLOGY, POINT_LIST, PATCH)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600321} VkPrimitiveTopology;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600322
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600323typedef enum VkIndexType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600324{
Tony Barbour8205d902015-04-16 15:59:00 -0600325 VK_INDEX_TYPE_UINT8 = 0x00000000,
326 VK_INDEX_TYPE_UINT16 = 0x00000001,
327 VK_INDEX_TYPE_UINT32 = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600328
Tony Barbour8205d902015-04-16 15:59:00 -0600329 VK_ENUM_RANGE(INDEX_TYPE, UINT8, UINT32)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600330} VkIndexType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600331
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600332typedef enum VkTexFilter_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600333{
Tony Barbour8205d902015-04-16 15:59:00 -0600334 VK_TEX_FILTER_NEAREST = 0x00000000,
335 VK_TEX_FILTER_LINEAR = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600336
Tony Barbour8205d902015-04-16 15:59:00 -0600337 VK_ENUM_RANGE(TEX_FILTER, NEAREST, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600338} VkTexFilter;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600339
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600340typedef enum VkTexMipmapMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600341{
Tony Barbour8205d902015-04-16 15:59:00 -0600342 VK_TEX_MIPMAP_MODE_BASE = 0x00000000, // Always choose base level
343 VK_TEX_MIPMAP_MODE_NEAREST = 0x00000001, // Choose nearest mip level
344 VK_TEX_MIPMAP_MODE_LINEAR = 0x00000002, // Linear filter between mip levels
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600345
Tony Barbour8205d902015-04-16 15:59:00 -0600346 VK_ENUM_RANGE(TEX_MIPMAP_MODE, BASE, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600347} VkTexMipmapMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600348
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600349typedef enum VkTexAddress_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600350{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600351 VK_TEX_ADDRESS_WRAP = 0x00000000,
352 VK_TEX_ADDRESS_MIRROR = 0x00000001,
353 VK_TEX_ADDRESS_CLAMP = 0x00000002,
354 VK_TEX_ADDRESS_MIRROR_ONCE = 0x00000003,
355 VK_TEX_ADDRESS_CLAMP_BORDER = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600356
Tony Barbour8205d902015-04-16 15:59:00 -0600357 VK_ENUM_RANGE(TEX_ADDRESS, WRAP, CLAMP_BORDER)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600358} VkTexAddress;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600359
Tony Barbour8205d902015-04-16 15:59:00 -0600360typedef enum VkCompareOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600361{
Tony Barbour8205d902015-04-16 15:59:00 -0600362 VK_COMPARE_OP_NEVER = 0x00000000,
363 VK_COMPARE_OP_LESS = 0x00000001,
364 VK_COMPARE_OP_EQUAL = 0x00000002,
365 VK_COMPARE_OP_LESS_EQUAL = 0x00000003,
366 VK_COMPARE_OP_GREATER = 0x00000004,
367 VK_COMPARE_OP_NOT_EQUAL = 0x00000005,
368 VK_COMPARE_OP_GREATER_EQUAL = 0x00000006,
369 VK_COMPARE_OP_ALWAYS = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600370
Tony Barbour8205d902015-04-16 15:59:00 -0600371 VK_ENUM_RANGE(COMPARE_OP, NEVER, ALWAYS)
372} VkCompareOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600373
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600374typedef enum VkFillMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600375{
Tony Barbour8205d902015-04-16 15:59:00 -0600376 VK_FILL_MODE_POINTS = 0x00000000,
377 VK_FILL_MODE_WIREFRAME = 0x00000001,
378 VK_FILL_MODE_SOLID = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600379
Tony Barbour8205d902015-04-16 15:59:00 -0600380 VK_ENUM_RANGE(FILL_MODE, POINTS, SOLID)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600381} VkFillMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600382
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600383typedef enum VkCullMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600384{
Tony Barbour8205d902015-04-16 15:59:00 -0600385 VK_CULL_MODE_NONE = 0x00000000,
386 VK_CULL_MODE_FRONT = 0x00000001,
387 VK_CULL_MODE_BACK = 0x00000002,
388 VK_CULL_MODE_FRONT_AND_BACK = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600389
Tony Barbour8205d902015-04-16 15:59:00 -0600390 VK_ENUM_RANGE(CULL_MODE, NONE, FRONT_AND_BACK)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600391} VkCullMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600392
Tony Barbour8205d902015-04-16 15:59:00 -0600393typedef enum VkFrontFace_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600394{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600395 VK_FRONT_FACE_CCW = 0x00000000,
396 VK_FRONT_FACE_CW = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600397
Tony Barbour8205d902015-04-16 15:59:00 -0600398 VK_ENUM_RANGE(FRONT_FACE, CCW, CW)
399} VkFrontFace;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600400
Tony Barbour8205d902015-04-16 15:59:00 -0600401typedef enum VkProvokingVertex_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600402{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600403 VK_PROVOKING_VERTEX_FIRST = 0x00000000,
404 VK_PROVOKING_VERTEX_LAST = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600405
Tony Barbour8205d902015-04-16 15:59:00 -0600406 VK_ENUM_RANGE(PROVOKING_VERTEX, FIRST, LAST)
407} VkProvokingVertex;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600408
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600409typedef enum VkCoordinateOrigin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600410{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600411 VK_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000,
412 VK_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600413
Tony Barbour8205d902015-04-16 15:59:00 -0600414 VK_ENUM_RANGE(COORDINATE_ORIGIN, UPPER_LEFT, LOWER_LEFT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600415} VkCoordinateOrigin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600416
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600417typedef enum VkDepthMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600418{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600419 VK_DEPTH_MODE_ZERO_TO_ONE = 0x00000000,
420 VK_DEPTH_MODE_NEGATIVE_ONE_TO_ONE = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600421
Tony Barbour8205d902015-04-16 15:59:00 -0600422 VK_ENUM_RANGE(DEPTH_MODE, ZERO_TO_ONE, NEGATIVE_ONE_TO_ONE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600423} VkDepthMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600424
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600425typedef enum VkBlend_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600426{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600427 VK_BLEND_ZERO = 0x00000000,
428 VK_BLEND_ONE = 0x00000001,
429 VK_BLEND_SRC_COLOR = 0x00000002,
430 VK_BLEND_ONE_MINUS_SRC_COLOR = 0x00000003,
431 VK_BLEND_DEST_COLOR = 0x00000004,
432 VK_BLEND_ONE_MINUS_DEST_COLOR = 0x00000005,
433 VK_BLEND_SRC_ALPHA = 0x00000006,
434 VK_BLEND_ONE_MINUS_SRC_ALPHA = 0x00000007,
435 VK_BLEND_DEST_ALPHA = 0x00000008,
436 VK_BLEND_ONE_MINUS_DEST_ALPHA = 0x00000009,
437 VK_BLEND_CONSTANT_COLOR = 0x0000000a,
438 VK_BLEND_ONE_MINUS_CONSTANT_COLOR = 0x0000000b,
439 VK_BLEND_CONSTANT_ALPHA = 0x0000000c,
440 VK_BLEND_ONE_MINUS_CONSTANT_ALPHA = 0x0000000d,
441 VK_BLEND_SRC_ALPHA_SATURATE = 0x0000000e,
442 VK_BLEND_SRC1_COLOR = 0x0000000f,
443 VK_BLEND_ONE_MINUS_SRC1_COLOR = 0x00000010,
444 VK_BLEND_SRC1_ALPHA = 0x00000011,
445 VK_BLEND_ONE_MINUS_SRC1_ALPHA = 0x00000012,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600446
Tony Barbour8205d902015-04-16 15:59:00 -0600447 VK_ENUM_RANGE(BLEND, ZERO, ONE_MINUS_SRC1_ALPHA)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600448} VkBlend;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600449
Tony Barbour8205d902015-04-16 15:59:00 -0600450typedef enum VkBlendOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600451{
Tony Barbour8205d902015-04-16 15:59:00 -0600452 VK_BLEND_OP_ADD = 0x00000000,
453 VK_BLEND_OP_SUBTRACT = 0x00000001,
454 VK_BLEND_OP_REVERSE_SUBTRACT = 0x00000002,
455 VK_BLEND_OP_MIN = 0x00000003,
456 VK_BLEND_OP_MAX = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600457
Tony Barbour8205d902015-04-16 15:59:00 -0600458 VK_ENUM_RANGE(BLEND_OP, ADD, MAX)
459} VkBlendOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600460
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600461typedef enum VkStencilOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600462{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600463 VK_STENCIL_OP_KEEP = 0x00000000,
464 VK_STENCIL_OP_ZERO = 0x00000001,
465 VK_STENCIL_OP_REPLACE = 0x00000002,
466 VK_STENCIL_OP_INC_CLAMP = 0x00000003,
467 VK_STENCIL_OP_DEC_CLAMP = 0x00000004,
468 VK_STENCIL_OP_INVERT = 0x00000005,
469 VK_STENCIL_OP_INC_WRAP = 0x00000006,
470 VK_STENCIL_OP_DEC_WRAP = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600471
Tony Barbour8205d902015-04-16 15:59:00 -0600472 VK_ENUM_RANGE(STENCIL_OP, KEEP, DEC_WRAP)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600473} VkStencilOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600474
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600475typedef enum VkLogicOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600476{
Tony Barbourfdff5572015-06-26 13:28:56 -0600477 VK_LOGIC_OP_CLEAR = 0x00000000,
478 VK_LOGIC_OP_AND = 0x00000001,
479 VK_LOGIC_OP_AND_REVERSE = 0x00000002,
480 VK_LOGIC_OP_COPY = 0x00000003,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600481 VK_LOGIC_OP_AND_INVERTED = 0x00000004,
482 VK_LOGIC_OP_NOOP = 0x00000005,
483 VK_LOGIC_OP_XOR = 0x00000006,
484 VK_LOGIC_OP_OR = 0x00000007,
485 VK_LOGIC_OP_NOR = 0x00000008,
486 VK_LOGIC_OP_EQUIV = 0x00000009,
487 VK_LOGIC_OP_INVERT = 0x0000000a,
488 VK_LOGIC_OP_OR_REVERSE = 0x0000000b,
489 VK_LOGIC_OP_COPY_INVERTED = 0x0000000c,
490 VK_LOGIC_OP_OR_INVERTED = 0x0000000d,
491 VK_LOGIC_OP_NAND = 0x0000000e,
492 VK_LOGIC_OP_SET = 0x0000000f,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600493
Tony Barbourfdff5572015-06-26 13:28:56 -0600494 VK_ENUM_RANGE(LOGIC_OP, CLEAR, SET)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600495} VkLogicOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600496
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600497typedef enum VkSystemAllocType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600498{
Tony Barbour8205d902015-04-16 15:59:00 -0600499 VK_SYSTEM_ALLOC_TYPE_API_OBJECT = 0x00000000,
500 VK_SYSTEM_ALLOC_TYPE_INTERNAL = 0x00000001,
501 VK_SYSTEM_ALLOC_TYPE_INTERNAL_TEMP = 0x00000002,
502 VK_SYSTEM_ALLOC_TYPE_INTERNAL_SHADER = 0x00000003,
503 VK_SYSTEM_ALLOC_TYPE_DEBUG = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600504
Tony Barbour8205d902015-04-16 15:59:00 -0600505 VK_ENUM_RANGE(SYSTEM_ALLOC_TYPE, API_OBJECT, DEBUG)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600506} VkSystemAllocType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600507
Tony Barbour8205d902015-04-16 15:59:00 -0600508typedef enum VkPhysicalDeviceType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600509{
Tony Barbour8205d902015-04-16 15:59:00 -0600510 VK_PHYSICAL_DEVICE_TYPE_OTHER = 0x00000000,
511 VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU = 0x00000001,
512 VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU = 0x00000002,
513 VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU = 0x00000003,
514 VK_PHYSICAL_DEVICE_TYPE_CPU = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600515
Tony Barbour8205d902015-04-16 15:59:00 -0600516 VK_ENUM_RANGE(PHYSICAL_DEVICE_TYPE, OTHER, CPU)
517} VkPhysicalDeviceType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600518
Tony Barbour8205d902015-04-16 15:59:00 -0600519typedef enum VkVertexInputStepRate_
520{
521 VK_VERTEX_INPUT_STEP_RATE_VERTEX = 0x0,
522 VK_VERTEX_INPUT_STEP_RATE_INSTANCE = 0x1,
523 VK_VERTEX_INPUT_STEP_RATE_DRAW = 0x2, //Optional
524
525 VK_ENUM_RANGE(VERTEX_INPUT_STEP_RATE, VERTEX, DRAW)
526} VkVertexInputStepRate;
527
Tony Barbour8205d902015-04-16 15:59:00 -0600528// Vulkan format definitions
529typedef enum VkFormat_
530{
531 VK_FORMAT_UNDEFINED = 0x00000000,
532 VK_FORMAT_R4G4_UNORM = 0x00000001,
533 VK_FORMAT_R4G4_USCALED = 0x00000002,
534 VK_FORMAT_R4G4B4A4_UNORM = 0x00000003,
535 VK_FORMAT_R4G4B4A4_USCALED = 0x00000004,
536 VK_FORMAT_R5G6B5_UNORM = 0x00000005,
537 VK_FORMAT_R5G6B5_USCALED = 0x00000006,
538 VK_FORMAT_R5G5B5A1_UNORM = 0x00000007,
539 VK_FORMAT_R5G5B5A1_USCALED = 0x00000008,
540 VK_FORMAT_R8_UNORM = 0x00000009,
541 VK_FORMAT_R8_SNORM = 0x0000000A,
542 VK_FORMAT_R8_USCALED = 0x0000000B,
543 VK_FORMAT_R8_SSCALED = 0x0000000C,
544 VK_FORMAT_R8_UINT = 0x0000000D,
545 VK_FORMAT_R8_SINT = 0x0000000E,
546 VK_FORMAT_R8_SRGB = 0x0000000F,
547 VK_FORMAT_R8G8_UNORM = 0x00000010,
548 VK_FORMAT_R8G8_SNORM = 0x00000011,
549 VK_FORMAT_R8G8_USCALED = 0x00000012,
550 VK_FORMAT_R8G8_SSCALED = 0x00000013,
551 VK_FORMAT_R8G8_UINT = 0x00000014,
552 VK_FORMAT_R8G8_SINT = 0x00000015,
553 VK_FORMAT_R8G8_SRGB = 0x00000016,
554 VK_FORMAT_R8G8B8_UNORM = 0x00000017,
555 VK_FORMAT_R8G8B8_SNORM = 0x00000018,
556 VK_FORMAT_R8G8B8_USCALED = 0x00000019,
557 VK_FORMAT_R8G8B8_SSCALED = 0x0000001A,
558 VK_FORMAT_R8G8B8_UINT = 0x0000001B,
559 VK_FORMAT_R8G8B8_SINT = 0x0000001C,
560 VK_FORMAT_R8G8B8_SRGB = 0x0000001D,
561 VK_FORMAT_R8G8B8A8_UNORM = 0x0000001E,
562 VK_FORMAT_R8G8B8A8_SNORM = 0x0000001F,
563 VK_FORMAT_R8G8B8A8_USCALED = 0x00000020,
564 VK_FORMAT_R8G8B8A8_SSCALED = 0x00000021,
565 VK_FORMAT_R8G8B8A8_UINT = 0x00000022,
566 VK_FORMAT_R8G8B8A8_SINT = 0x00000023,
567 VK_FORMAT_R8G8B8A8_SRGB = 0x00000024,
568 VK_FORMAT_R10G10B10A2_UNORM = 0x00000025,
569 VK_FORMAT_R10G10B10A2_SNORM = 0x00000026,
570 VK_FORMAT_R10G10B10A2_USCALED = 0x00000027,
571 VK_FORMAT_R10G10B10A2_SSCALED = 0x00000028,
572 VK_FORMAT_R10G10B10A2_UINT = 0x00000029,
573 VK_FORMAT_R10G10B10A2_SINT = 0x0000002A,
574 VK_FORMAT_R16_UNORM = 0x0000002B,
575 VK_FORMAT_R16_SNORM = 0x0000002C,
576 VK_FORMAT_R16_USCALED = 0x0000002D,
577 VK_FORMAT_R16_SSCALED = 0x0000002E,
578 VK_FORMAT_R16_UINT = 0x0000002F,
579 VK_FORMAT_R16_SINT = 0x00000030,
580 VK_FORMAT_R16_SFLOAT = 0x00000031,
581 VK_FORMAT_R16G16_UNORM = 0x00000032,
582 VK_FORMAT_R16G16_SNORM = 0x00000033,
583 VK_FORMAT_R16G16_USCALED = 0x00000034,
584 VK_FORMAT_R16G16_SSCALED = 0x00000035,
585 VK_FORMAT_R16G16_UINT = 0x00000036,
586 VK_FORMAT_R16G16_SINT = 0x00000037,
587 VK_FORMAT_R16G16_SFLOAT = 0x00000038,
588 VK_FORMAT_R16G16B16_UNORM = 0x00000039,
589 VK_FORMAT_R16G16B16_SNORM = 0x0000003A,
590 VK_FORMAT_R16G16B16_USCALED = 0x0000003B,
591 VK_FORMAT_R16G16B16_SSCALED = 0x0000003C,
592 VK_FORMAT_R16G16B16_UINT = 0x0000003D,
593 VK_FORMAT_R16G16B16_SINT = 0x0000003E,
594 VK_FORMAT_R16G16B16_SFLOAT = 0x0000003F,
595 VK_FORMAT_R16G16B16A16_UNORM = 0x00000040,
596 VK_FORMAT_R16G16B16A16_SNORM = 0x00000041,
597 VK_FORMAT_R16G16B16A16_USCALED = 0x00000042,
598 VK_FORMAT_R16G16B16A16_SSCALED = 0x00000043,
599 VK_FORMAT_R16G16B16A16_UINT = 0x00000044,
600 VK_FORMAT_R16G16B16A16_SINT = 0x00000045,
601 VK_FORMAT_R16G16B16A16_SFLOAT = 0x00000046,
602 VK_FORMAT_R32_UINT = 0x00000047,
603 VK_FORMAT_R32_SINT = 0x00000048,
604 VK_FORMAT_R32_SFLOAT = 0x00000049,
605 VK_FORMAT_R32G32_UINT = 0x0000004A,
606 VK_FORMAT_R32G32_SINT = 0x0000004B,
607 VK_FORMAT_R32G32_SFLOAT = 0x0000004C,
608 VK_FORMAT_R32G32B32_UINT = 0x0000004D,
609 VK_FORMAT_R32G32B32_SINT = 0x0000004E,
610 VK_FORMAT_R32G32B32_SFLOAT = 0x0000004F,
611 VK_FORMAT_R32G32B32A32_UINT = 0x00000050,
612 VK_FORMAT_R32G32B32A32_SINT = 0x00000051,
613 VK_FORMAT_R32G32B32A32_SFLOAT = 0x00000052,
614 VK_FORMAT_R64_SFLOAT = 0x00000053,
615 VK_FORMAT_R64G64_SFLOAT = 0x00000054,
616 VK_FORMAT_R64G64B64_SFLOAT = 0x00000055,
617 VK_FORMAT_R64G64B64A64_SFLOAT = 0x00000056,
618 VK_FORMAT_R11G11B10_UFLOAT = 0x00000057,
619 VK_FORMAT_R9G9B9E5_UFLOAT = 0x00000058,
620 VK_FORMAT_D16_UNORM = 0x00000059,
621 VK_FORMAT_D24_UNORM = 0x0000005A,
622 VK_FORMAT_D32_SFLOAT = 0x0000005B,
623 VK_FORMAT_S8_UINT = 0x0000005C,
624 VK_FORMAT_D16_UNORM_S8_UINT = 0x0000005D,
625 VK_FORMAT_D24_UNORM_S8_UINT = 0x0000005E,
626 VK_FORMAT_D32_SFLOAT_S8_UINT = 0x0000005F,
627 VK_FORMAT_BC1_RGB_UNORM = 0x00000060,
628 VK_FORMAT_BC1_RGB_SRGB = 0x00000061,
629 VK_FORMAT_BC1_RGBA_UNORM = 0x00000062,
630 VK_FORMAT_BC1_RGBA_SRGB = 0x00000063,
631 VK_FORMAT_BC2_UNORM = 0x00000064,
632 VK_FORMAT_BC2_SRGB = 0x00000065,
633 VK_FORMAT_BC3_UNORM = 0x00000066,
634 VK_FORMAT_BC3_SRGB = 0x00000067,
635 VK_FORMAT_BC4_UNORM = 0x00000068,
636 VK_FORMAT_BC4_SNORM = 0x00000069,
637 VK_FORMAT_BC5_UNORM = 0x0000006A,
638 VK_FORMAT_BC5_SNORM = 0x0000006B,
639 VK_FORMAT_BC6H_UFLOAT = 0x0000006C,
640 VK_FORMAT_BC6H_SFLOAT = 0x0000006D,
641 VK_FORMAT_BC7_UNORM = 0x0000006E,
642 VK_FORMAT_BC7_SRGB = 0x0000006F,
643 VK_FORMAT_ETC2_R8G8B8_UNORM = 0x00000070,
644 VK_FORMAT_ETC2_R8G8B8_SRGB = 0x00000071,
645 VK_FORMAT_ETC2_R8G8B8A1_UNORM = 0x00000072,
646 VK_FORMAT_ETC2_R8G8B8A1_SRGB = 0x00000073,
647 VK_FORMAT_ETC2_R8G8B8A8_UNORM = 0x00000074,
648 VK_FORMAT_ETC2_R8G8B8A8_SRGB = 0x00000075,
649 VK_FORMAT_EAC_R11_UNORM = 0x00000076,
650 VK_FORMAT_EAC_R11_SNORM = 0x00000077,
651 VK_FORMAT_EAC_R11G11_UNORM = 0x00000078,
652 VK_FORMAT_EAC_R11G11_SNORM = 0x00000079,
653 VK_FORMAT_ASTC_4x4_UNORM = 0x0000007A,
654 VK_FORMAT_ASTC_4x4_SRGB = 0x0000007B,
655 VK_FORMAT_ASTC_5x4_UNORM = 0x0000007C,
656 VK_FORMAT_ASTC_5x4_SRGB = 0x0000007D,
657 VK_FORMAT_ASTC_5x5_UNORM = 0x0000007E,
658 VK_FORMAT_ASTC_5x5_SRGB = 0x0000007F,
659 VK_FORMAT_ASTC_6x5_UNORM = 0x00000080,
660 VK_FORMAT_ASTC_6x5_SRGB = 0x00000081,
661 VK_FORMAT_ASTC_6x6_UNORM = 0x00000082,
662 VK_FORMAT_ASTC_6x6_SRGB = 0x00000083,
663 VK_FORMAT_ASTC_8x5_UNORM = 0x00000084,
664 VK_FORMAT_ASTC_8x5_SRGB = 0x00000085,
665 VK_FORMAT_ASTC_8x6_UNORM = 0x00000086,
666 VK_FORMAT_ASTC_8x6_SRGB = 0x00000087,
667 VK_FORMAT_ASTC_8x8_UNORM = 0x00000088,
668 VK_FORMAT_ASTC_8x8_SRGB = 0x00000089,
669 VK_FORMAT_ASTC_10x5_UNORM = 0x0000008A,
670 VK_FORMAT_ASTC_10x5_SRGB = 0x0000008B,
671 VK_FORMAT_ASTC_10x6_UNORM = 0x0000008C,
672 VK_FORMAT_ASTC_10x6_SRGB = 0x0000008D,
673 VK_FORMAT_ASTC_10x8_UNORM = 0x0000008E,
674 VK_FORMAT_ASTC_10x8_SRGB = 0x0000008F,
675 VK_FORMAT_ASTC_10x10_UNORM = 0x00000090,
676 VK_FORMAT_ASTC_10x10_SRGB = 0x00000091,
677 VK_FORMAT_ASTC_12x10_UNORM = 0x00000092,
678 VK_FORMAT_ASTC_12x10_SRGB = 0x00000093,
679 VK_FORMAT_ASTC_12x12_UNORM = 0x00000094,
680 VK_FORMAT_ASTC_12x12_SRGB = 0x00000095,
681 VK_FORMAT_B4G4R4A4_UNORM = 0x00000096,
682 VK_FORMAT_B5G5R5A1_UNORM = 0x00000097,
683 VK_FORMAT_B5G6R5_UNORM = 0x00000098,
684 VK_FORMAT_B5G6R5_USCALED = 0x00000099,
685 VK_FORMAT_B8G8R8_UNORM = 0x0000009A,
686 VK_FORMAT_B8G8R8_SNORM = 0x0000009B,
687 VK_FORMAT_B8G8R8_USCALED = 0x0000009C,
688 VK_FORMAT_B8G8R8_SSCALED = 0x0000009D,
689 VK_FORMAT_B8G8R8_UINT = 0x0000009E,
690 VK_FORMAT_B8G8R8_SINT = 0x0000009F,
691 VK_FORMAT_B8G8R8_SRGB = 0x000000A0,
692 VK_FORMAT_B8G8R8A8_UNORM = 0x000000A1,
693 VK_FORMAT_B8G8R8A8_SNORM = 0x000000A2,
694 VK_FORMAT_B8G8R8A8_USCALED = 0x000000A3,
695 VK_FORMAT_B8G8R8A8_SSCALED = 0x000000A4,
696 VK_FORMAT_B8G8R8A8_UINT = 0x000000A5,
697 VK_FORMAT_B8G8R8A8_SINT = 0x000000A6,
698 VK_FORMAT_B8G8R8A8_SRGB = 0x000000A7,
699 VK_FORMAT_B10G10R10A2_UNORM = 0x000000A8,
700 VK_FORMAT_B10G10R10A2_SNORM = 0x000000A9,
701 VK_FORMAT_B10G10R10A2_USCALED = 0x000000AA,
702 VK_FORMAT_B10G10R10A2_SSCALED = 0x000000AB,
703 VK_FORMAT_B10G10R10A2_UINT = 0x000000AC,
704 VK_FORMAT_B10G10R10A2_SINT = 0x000000AD,
705
706 VK_ENUM_RANGE(FORMAT, UNDEFINED, B10G10R10A2_SINT)
707} VkFormat;
708
709// Shader stage enumerant
710typedef enum VkShaderStage_
711{
712 VK_SHADER_STAGE_VERTEX = 0,
713 VK_SHADER_STAGE_TESS_CONTROL = 1,
714 VK_SHADER_STAGE_TESS_EVALUATION = 2,
715 VK_SHADER_STAGE_GEOMETRY = 3,
716 VK_SHADER_STAGE_FRAGMENT = 4,
717 VK_SHADER_STAGE_COMPUTE = 5,
718
719 VK_ENUM_RANGE(SHADER_STAGE, VERTEX, COMPUTE)
720} VkShaderStage;
721
722// Structure type enumerant
723typedef enum VkStructureType_
724{
Tony Barbour04ee6b92015-06-26 15:02:35 -0600725 VK_STRUCTURE_TYPE_APPLICATION_INFO = 0,
726 VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO = 1,
727 VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO = 2,
728 VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO = 3,
729 VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO = 4,
730 VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO = 5,
731 VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO = 6,
732 VK_STRUCTURE_TYPE_SHADER_CREATE_INFO = 7,
733 VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO = 8,
734 VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO = 9,
735 VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO = 10,
736 VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO = 11,
737 VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO = 12,
738 VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO = 13,
739 VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO = 14,
740 VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO = 15,
741 VK_STRUCTURE_TYPE_EVENT_CREATE_INFO = 16,
742 VK_STRUCTURE_TYPE_FENCE_CREATE_INFO = 17,
743 VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO = 18,
744 VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO = 19,
745 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO = 20,
746 VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO = 21,
747 VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO = 22,
748 VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO = 23,
749 VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO = 24,
750 VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO = 25,
751 VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO = 26,
752 VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO = 27,
753 VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO = 28,
754 VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO = 29,
755 VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO = 30,
756 VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO = 31,
757 VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO = 32,
758 VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO = 33,
759 VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO = 34,
760 VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO = 35,
761 VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO = 36,
762 VK_STRUCTURE_TYPE_MEMORY_BARRIER = 37,
763 VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER = 38,
764 VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER = 39,
765 VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO = 40,
766 VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET = 41,
767 VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET = 42,
768 VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO = 43,
769 VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO = 44,
770 VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES = 45,
Tony Barbour8205d902015-04-16 15:59:00 -0600771
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600772 VK_ENUM_RANGE(STRUCTURE_TYPE, APPLICATION_INFO, EXTENSION_PROPERTIES)
Tony Barbour8205d902015-04-16 15:59:00 -0600773} VkStructureType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600774
Mike Stroyan230e6252015-04-17 12:36:38 -0600775// Object type enumerant
776typedef enum VkObjectType_
777{
778 VK_OBJECT_TYPE_INSTANCE = 0,
779 VK_OBJECT_TYPE_PHYSICAL_DEVICE = 1,
780 VK_OBJECT_TYPE_DEVICE = 2,
781 VK_OBJECT_TYPE_QUEUE = 3,
782 VK_OBJECT_TYPE_COMMAND_BUFFER = 4,
783 VK_OBJECT_TYPE_DEVICE_MEMORY = 5,
784 VK_OBJECT_TYPE_BUFFER = 6,
785 VK_OBJECT_TYPE_BUFFER_VIEW = 7,
786 VK_OBJECT_TYPE_IMAGE = 8,
787 VK_OBJECT_TYPE_IMAGE_VIEW = 9,
788 VK_OBJECT_TYPE_COLOR_ATTACHMENT_VIEW = 10,
789 VK_OBJECT_TYPE_DEPTH_STENCIL_VIEW = 11,
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -0600790 VK_OBJECT_TYPE_SHADER_MODULE = 12,
791 VK_OBJECT_TYPE_SHADER = 13,
792 VK_OBJECT_TYPE_PIPELINE = 14,
793 VK_OBJECT_TYPE_PIPELINE_LAYOUT = 15,
794 VK_OBJECT_TYPE_SAMPLER = 16,
795 VK_OBJECT_TYPE_DESCRIPTOR_SET = 17,
796 VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT = 18,
797 VK_OBJECT_TYPE_DESCRIPTOR_POOL = 19,
798 VK_OBJECT_TYPE_DYNAMIC_VP_STATE = 20,
799 VK_OBJECT_TYPE_DYNAMIC_RS_STATE = 21,
800 VK_OBJECT_TYPE_DYNAMIC_CB_STATE = 22,
801 VK_OBJECT_TYPE_DYNAMIC_DS_STATE = 23,
802 VK_OBJECT_TYPE_FENCE = 24,
803 VK_OBJECT_TYPE_SEMAPHORE = 25,
804 VK_OBJECT_TYPE_EVENT = 26,
805 VK_OBJECT_TYPE_QUERY_POOL = 27,
806 VK_OBJECT_TYPE_FRAMEBUFFER = 28,
807 VK_OBJECT_TYPE_RENDER_PASS = 29,
Mike Stroyan230e6252015-04-17 12:36:38 -0600808
809 // Valid ranges for core Vulkan:
810 VK_OBJECT_TYPE_BEGIN_RANGE = VK_OBJECT_TYPE_INSTANCE,
811 VK_OBJECT_TYPE_END_RANGE = VK_OBJECT_TYPE_RENDER_PASS,
812 VK_NUM_OBJECT_TYPE = (VK_OBJECT_TYPE_END_RANGE - VK_OBJECT_TYPE_BEGIN_RANGE + 1),
813 VK_MAX_ENUM(VkObjectType)
814} VkObjectType;
815
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600816// ------------------------------------------------------------------------------------------------
817// Error and return codes
818
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600819typedef enum VkResult_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600820{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600821 // Return codes for successful operation execution (> = 0)
822 VK_SUCCESS = 0x0000000,
823 VK_UNSUPPORTED = 0x0000001,
824 VK_NOT_READY = 0x0000002,
825 VK_TIMEOUT = 0x0000003,
826 VK_EVENT_SET = 0x0000004,
827 VK_EVENT_RESET = 0x0000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600828
829 // Error codes (negative values)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600830 VK_ERROR_UNKNOWN = -(0x00000001),
831 VK_ERROR_UNAVAILABLE = -(0x00000002),
832 VK_ERROR_INITIALIZATION_FAILED = -(0x00000003),
Tony Barbour8205d902015-04-16 15:59:00 -0600833 VK_ERROR_OUT_OF_HOST_MEMORY = -(0x00000004),
834 VK_ERROR_OUT_OF_DEVICE_MEMORY = -(0x00000005),
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600835 VK_ERROR_DEVICE_ALREADY_CREATED = -(0x00000006),
836 VK_ERROR_DEVICE_LOST = -(0x00000007),
837 VK_ERROR_INVALID_POINTER = -(0x00000008),
838 VK_ERROR_INVALID_VALUE = -(0x00000009),
839 VK_ERROR_INVALID_HANDLE = -(0x0000000A),
840 VK_ERROR_INVALID_ORDINAL = -(0x0000000B),
841 VK_ERROR_INVALID_MEMORY_SIZE = -(0x0000000C),
842 VK_ERROR_INVALID_EXTENSION = -(0x0000000D),
843 VK_ERROR_INVALID_FLAGS = -(0x0000000E),
844 VK_ERROR_INVALID_ALIGNMENT = -(0x0000000F),
845 VK_ERROR_INVALID_FORMAT = -(0x00000010),
846 VK_ERROR_INVALID_IMAGE = -(0x00000011),
847 VK_ERROR_INVALID_DESCRIPTOR_SET_DATA = -(0x00000012),
848 VK_ERROR_INVALID_QUEUE_TYPE = -(0x00000013),
849 VK_ERROR_INVALID_OBJECT_TYPE = -(0x00000014),
850 VK_ERROR_UNSUPPORTED_SHADER_IL_VERSION = -(0x00000015),
851 VK_ERROR_BAD_SHADER_CODE = -(0x00000016),
852 VK_ERROR_BAD_PIPELINE_DATA = -(0x00000017),
Courtney Goeltzenleuchterac834522015-05-01 17:56:13 -0600853 VK_ERROR_NOT_MAPPABLE = -(0x00000018),
854 VK_ERROR_MEMORY_MAP_FAILED = -(0x00000019),
855 VK_ERROR_MEMORY_UNMAP_FAILED = -(0x0000001A),
856 VK_ERROR_INCOMPATIBLE_DEVICE = -(0x0000001B),
857 VK_ERROR_INCOMPATIBLE_DRIVER = -(0x0000001C),
858 VK_ERROR_INCOMPLETE_COMMAND_BUFFER = -(0x0000001D),
859 VK_ERROR_BUILDING_COMMAND_BUFFER = -(0x0000001E),
860 VK_ERROR_MEMORY_NOT_BOUND = -(0x0000001F),
861 VK_ERROR_INCOMPATIBLE_QUEUE = -(0x00000020),
Tony Barbour8205d902015-04-16 15:59:00 -0600862
863 VK_MAX_ENUM(RESULT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600864} VkResult;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600865
866// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600867// Flags
868
869// Device creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600870typedef VkFlags VkDeviceCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600871
872// Queue capabilities
Tony Barbour8205d902015-04-16 15:59:00 -0600873typedef VkFlags VkQueueFlags;
874typedef enum VkQueueFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600875{
Tony Barbour8205d902015-04-16 15:59:00 -0600876 VK_QUEUE_GRAPHICS_BIT = VK_BIT(0), // Queue supports graphics operations
877 VK_QUEUE_COMPUTE_BIT = VK_BIT(1), // Queue supports compute operations
878 VK_QUEUE_DMA_BIT = VK_BIT(2), // Queue supports DMA operations
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500879 VK_QUEUE_SPARSE_MEMMGR_BIT = VK_BIT(3), // Queue supports sparse resource memory management operations
Tony Barbour8205d902015-04-16 15:59:00 -0600880 VK_QUEUE_EXTENDED_BIT = VK_BIT(30), // Extended queue
881} VkQueueFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600882
Tony Barbour8205d902015-04-16 15:59:00 -0600883// Memory properties passed into vkAllocMemory().
884typedef VkFlags VkMemoryPropertyFlags;
885typedef enum VkMemoryPropertyFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600886{
Tony Barbour8205d902015-04-16 15:59:00 -0600887 VK_MEMORY_PROPERTY_DEVICE_ONLY = 0, // If otherwise stated, then allocate memory on device
888 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT = VK_BIT(0), // Memory should be mappable by host
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600889 VK_MEMORY_PROPERTY_HOST_NON_COHERENT_BIT = VK_BIT(1), // Memory may not have i/o coherency so vkFlushMappedMemoryRanges and
890 // vkInvalidateMappedMemoryRanges must be used flush/invalidate host cache
Tony Barbour8205d902015-04-16 15:59:00 -0600891 VK_MEMORY_PROPERTY_HOST_UNCACHED_BIT = VK_BIT(2), // Memory should not be cached by the host
892 VK_MEMORY_PROPERTY_HOST_WRITE_COMBINED_BIT = VK_BIT(3), // Memory should support host write combining
893 VK_MEMORY_PROPERTY_PREFER_HOST_LOCAL = VK_BIT(4), // If set, prefer host access
Tony Barbour8205d902015-04-16 15:59:00 -0600894} VkMemoryPropertyFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600895
Tony Barbour8205d902015-04-16 15:59:00 -0600896// Memory output flags passed to resource transition commands
897typedef VkFlags VkMemoryOutputFlags;
898typedef enum VkMemoryOutputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600899{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600900 VK_MEMORY_OUTPUT_HOST_WRITE_BIT = VK_BIT(0), // Controls output coherency of host writes
Tony Barbour8205d902015-04-16 15:59:00 -0600901 VK_MEMORY_OUTPUT_SHADER_WRITE_BIT = VK_BIT(1), // Controls output coherency of generic shader writes
902 VK_MEMORY_OUTPUT_COLOR_ATTACHMENT_BIT = VK_BIT(2), // Controls output coherency of color attachment writes
903 VK_MEMORY_OUTPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(3), // Controls output coherency of depth/stencil attachment writes
904 VK_MEMORY_OUTPUT_TRANSFER_BIT = VK_BIT(4), // Controls output coherency of transfer operations
905} VkMemoryOutputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600906
Tony Barbour8205d902015-04-16 15:59:00 -0600907// Memory input flags passed to resource transition commands
908typedef VkFlags VkMemoryInputFlags;
909typedef enum VkMemoryInputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600910{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600911 VK_MEMORY_INPUT_HOST_READ_BIT = VK_BIT(0), // Controls input coherency of host reads
Tony Barbour8205d902015-04-16 15:59:00 -0600912 VK_MEMORY_INPUT_INDIRECT_COMMAND_BIT = VK_BIT(1), // Controls input coherency of indirect command reads
913 VK_MEMORY_INPUT_INDEX_FETCH_BIT = VK_BIT(2), // Controls input coherency of index fetches
914 VK_MEMORY_INPUT_VERTEX_ATTRIBUTE_FETCH_BIT = VK_BIT(3), // Controls input coherency of vertex attribute fetches
915 VK_MEMORY_INPUT_UNIFORM_READ_BIT = VK_BIT(4), // Controls input coherency of uniform buffer reads
916 VK_MEMORY_INPUT_SHADER_READ_BIT = VK_BIT(5), // Controls input coherency of generic shader reads
917 VK_MEMORY_INPUT_COLOR_ATTACHMENT_BIT = VK_BIT(6), // Controls input coherency of color attachment reads
918 VK_MEMORY_INPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(7), // Controls input coherency of depth/stencil attachment reads
919 VK_MEMORY_INPUT_TRANSFER_BIT = VK_BIT(8), // Controls input coherency of transfer operations
920} VkMemoryInputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600921
Tony Barbour8205d902015-04-16 15:59:00 -0600922// Buffer usage flags
923typedef VkFlags VkBufferUsageFlags;
924typedef enum VkBufferUsageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600925{
Tony Barbour8205d902015-04-16 15:59:00 -0600926 VK_BUFFER_USAGE_GENERAL = 0, // No special usage
927 VK_BUFFER_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
928 VK_BUFFER_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
929 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(2), // Can be used as TBO
930 VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(3), // Can be used as IBO
931 VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT = VK_BIT(4), // Can be used as UBO
932 VK_BUFFER_USAGE_STORAGE_BUFFER_BIT = VK_BIT(5), // Can be used as SSBO
933 VK_BUFFER_USAGE_INDEX_BUFFER_BIT = VK_BIT(6), // Can be used as source of fixed function index fetch (index buffer)
934 VK_BUFFER_USAGE_VERTEX_BUFFER_BIT = VK_BIT(7), // Can be used as source of fixed function vertex fetch (VBO)
935 VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT = VK_BIT(8), // Can be the source of indirect parameters (e.g. indirect buffer, parameter buffer)
936} VkBufferUsageFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600937
Tony Barbour8205d902015-04-16 15:59:00 -0600938// Buffer creation flags
939typedef VkFlags VkBufferCreateFlags;
940typedef enum VkBufferCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600941{
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600942 VK_BUFFER_CREATE_SPARSE_BIT = VK_BIT(0), // Buffer should support sparse backing
Tony Barbour8205d902015-04-16 15:59:00 -0600943} VkBufferCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600944
Tony Barbour8205d902015-04-16 15:59:00 -0600945// Shader stage flags
946typedef VkFlags VkShaderStageFlags;
947typedef enum VkShaderStageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600948{
Tony Barbour8205d902015-04-16 15:59:00 -0600949 VK_SHADER_STAGE_VERTEX_BIT = VK_BIT(0),
950 VK_SHADER_STAGE_TESS_CONTROL_BIT = VK_BIT(1),
951 VK_SHADER_STAGE_TESS_EVALUATION_BIT = VK_BIT(2),
952 VK_SHADER_STAGE_GEOMETRY_BIT = VK_BIT(3),
953 VK_SHADER_STAGE_FRAGMENT_BIT = VK_BIT(4),
954 VK_SHADER_STAGE_COMPUTE_BIT = VK_BIT(5),
955
956 VK_SHADER_STAGE_ALL = 0x7FFFFFFF,
957} VkShaderStageFlagBits;
958
959// Image usage flags
960typedef VkFlags VkImageUsageFlags;
961typedef enum VkImageUsageFlagBits_
962{
963 VK_IMAGE_USAGE_GENERAL = 0, // No special usage
964 VK_IMAGE_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
965 VK_IMAGE_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
966 VK_IMAGE_USAGE_SAMPLED_BIT = VK_BIT(2), // Can be sampled from (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
967 VK_IMAGE_USAGE_STORAGE_BIT = VK_BIT(3), // Can be used as storage image (STORAGE_IMAGE descriptor type)
968 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT = VK_BIT(4), // Can be used as framebuffer color attachment
969 VK_IMAGE_USAGE_DEPTH_STENCIL_BIT = VK_BIT(5), // Can be used as framebuffer depth/stencil attachment
970 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT = VK_BIT(6), // Image data not needed outside of rendering
971} VkImageUsageFlagBits;
972
973// Image creation flags
974typedef VkFlags VkImageCreateFlags;
975typedef enum VkImageCreateFlagBits_
976{
977 VK_IMAGE_CREATE_INVARIANT_DATA_BIT = VK_BIT(0),
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600978 VK_IMAGE_CREATE_SPARSE_BIT = VK_BIT(1), // Image should support sparse backing
979 VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT = VK_BIT(2), // Allows image views to have different format than the base image
980 VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT = VK_BIT(3), // Allows creating image views with cube type from the created image
Tony Barbour8205d902015-04-16 15:59:00 -0600981} VkImageCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600982
983// Depth-stencil view creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600984typedef VkFlags VkDepthStencilViewCreateFlags;
985typedef enum VkDepthStencilViewCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600986{
Tony Barbour8205d902015-04-16 15:59:00 -0600987 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_DEPTH_BIT = VK_BIT(0),
988 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_STENCIL_BIT = VK_BIT(1),
989} VkDepthStencilViewCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600990
991// Pipeline creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600992typedef VkFlags VkPipelineCreateFlags;
993typedef enum VkPipelineCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600994{
Tony Barbour8205d902015-04-16 15:59:00 -0600995 VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT = VK_BIT(0),
996 VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT = VK_BIT(1),
997} VkPipelineCreateFlagBits;
998
999// Channel flags
1000typedef VkFlags VkChannelFlags;
1001typedef enum VkChannelFlagBits_
1002{
1003 VK_CHANNEL_R_BIT = VK_BIT(0),
1004 VK_CHANNEL_G_BIT = VK_BIT(1),
1005 VK_CHANNEL_B_BIT = VK_BIT(2),
1006 VK_CHANNEL_A_BIT = VK_BIT(3),
1007} VkChannelFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001008
1009// Fence creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001010typedef VkFlags VkFenceCreateFlags;
1011typedef enum VkFenceCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001012{
Tony Barbour8205d902015-04-16 15:59:00 -06001013 VK_FENCE_CREATE_SIGNALED_BIT = VK_BIT(0),
1014} VkFenceCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001015
1016// Semaphore creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001017typedef VkFlags VkSemaphoreCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001018
1019// Format capability flags
Tony Barbour8205d902015-04-16 15:59:00 -06001020typedef VkFlags VkFormatFeatureFlags;
1021typedef enum VkFormatFeatureFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001022{
Tony Barbour8205d902015-04-16 15:59:00 -06001023 VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT = VK_BIT(0), // Format can be used for sampled images (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
1024 VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT = VK_BIT(1), // Format can be used for storage images (STORAGE_IMAGE descriptor type)
1025 VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT = VK_BIT(2), // Format supports atomic operations in case it's used for storage images
1026 VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(3), // Format can be used for uniform texel buffers (TBOs)
1027 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(4), // Format can be used for storage texel buffers (IBOs)
1028 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT = VK_BIT(5), // Format supports atomic operations in case it's used for storage texel buffers
1029 VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT = VK_BIT(6), // Format can be used for vertex buffers (VBOs)
1030 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT = VK_BIT(7), // Format can be used for color attachment images
1031 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT = VK_BIT(8), // Format supports blending in case it's used for color attachment images
1032 VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(9), // Format can be used for depth/stencil attachment images
1033 VK_FORMAT_FEATURE_CONVERSION_BIT = VK_BIT(10), // Format can be used as the source or destination of format converting blits
1034} VkFormatFeatureFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001035
Tony Barbourc2e987e2015-06-29 16:20:35 -06001036// Pipeline stage flags
1037typedef enum {
1038 VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT = VK_BIT(0),
1039 VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT = VK_BIT(1),
1040 VK_PIPELINE_STAGE_VERTEX_INPUT_BIT = VK_BIT(2),
1041 VK_PIPELINE_STAGE_VERTEX_SHADER_BIT = VK_BIT(3),
1042 VK_PIPELINE_STAGE_TESS_CONTROL_SHADER_BIT = VK_BIT(4),
1043 VK_PIPELINE_STAGE_TESS_EVALUATION_SHADER_BIT = VK_BIT(5),
1044 VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT = VK_BIT(6),
1045 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT = VK_BIT(7),
1046 VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT = VK_BIT(8),
1047 VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT = VK_BIT(9),
1048 VK_PIPELINE_STAGE_ATTACHMENT_OUTPUT_BIT = VK_BIT(10),
1049 VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT = VK_BIT(11),
1050 VK_PIPELINE_STAGE_TRANSFER_BIT = VK_BIT(12),
1051 VK_PIPELINE_STAGE_HOST_BIT = VK_BIT(13),
1052 VK_PIPELINE_STAGE_ALL_GRAPHICS = 0x000007FF,
1053 VK_PIPELINE_STAGE_ALL_GPU_COMMANDS = 0x00001FFF,
1054} VkPipelineStageFlagBits;
1055
1056typedef VkFlags VkPipelineStageFlags;
1057
Tony Barbour8205d902015-04-16 15:59:00 -06001058// Query control flags
1059typedef VkFlags VkQueryControlFlags;
1060typedef enum VkQueryControlFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001061{
Tony Barbour8205d902015-04-16 15:59:00 -06001062 VK_QUERY_CONTROL_CONSERVATIVE_BIT = VK_BIT(0), // Allow conservative results to be collected by the query
1063} VkQueryControlFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001064
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001065// Query result flags
Tony Barbour8205d902015-04-16 15:59:00 -06001066typedef VkFlags VkQueryResultFlags;
1067typedef enum VkQueryResultFlagBits_
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001068{
Courtney Goeltzenleuchterc0d0bb02015-06-09 08:45:23 -06001069 VK_QUERY_RESULT_DEFAULT = 0, // Results of the queries are immediately written to the destination buffer as 32-bit values
Tony Barbour8205d902015-04-16 15:59:00 -06001070 VK_QUERY_RESULT_64_BIT = VK_BIT(0), // Results of the queries are written to the destination buffer as 64-bit values
Tony Barbour8205d902015-04-16 15:59:00 -06001071 VK_QUERY_RESULT_WAIT_BIT = VK_BIT(1), // Results of the queries are waited on before proceeding with the result copy
1072 VK_QUERY_RESULT_WITH_AVAILABILITY_BIT = VK_BIT(2), // Besides the results of the query, the availability of the results is also written
1073 VK_QUERY_RESULT_PARTIAL_BIT = VK_BIT(3), // Copy the partial results of the query even if the final results aren't available
1074} VkQueryResultFlagBits;
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001075
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001076// Shader module creation flags
1077typedef VkFlags VkShaderModuleCreateFlags;
1078
Tony Barbour8205d902015-04-16 15:59:00 -06001079// Shader creation flags
1080typedef VkFlags VkShaderCreateFlags;
1081
1082// Event creation flags
1083typedef VkFlags VkEventCreateFlags;
1084
1085// Command buffer creation flags
1086typedef VkFlags VkCmdBufferCreateFlags;
1087
1088// Command buffer optimization flags
1089typedef VkFlags VkCmdBufferOptimizeFlags;
1090typedef enum VkCmdBufferOptimizeFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001091{
Tony Barbour8205d902015-04-16 15:59:00 -06001092 VK_CMD_BUFFER_OPTIMIZE_SMALL_BATCH_BIT = VK_BIT(0),
1093 VK_CMD_BUFFER_OPTIMIZE_PIPELINE_SWITCH_BIT = VK_BIT(1),
1094 VK_CMD_BUFFER_OPTIMIZE_ONE_TIME_SUBMIT_BIT = VK_BIT(2),
1095 VK_CMD_BUFFER_OPTIMIZE_DESCRIPTOR_SET_SWITCH_BIT = VK_BIT(3),
1096} VkCmdBufferOptimizeFlagBits;
1097
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001098// Pipeline statistics flags
1099typedef VkFlags VkQueryPipelineStatisticFlags;
1100typedef enum VkQueryPipelineStatisticFlagBits_ {
1101 VK_QUERY_PIPELINE_STATISTIC_IA_VERTICES_BIT = VK_BIT(0), // Optional
1102 VK_QUERY_PIPELINE_STATISTIC_IA_PRIMITIVES_BIT = VK_BIT(1), // Optional
1103 VK_QUERY_PIPELINE_STATISTIC_VS_INVOCATIONS_BIT = VK_BIT(2), // Optional
1104 VK_QUERY_PIPELINE_STATISTIC_GS_INVOCATIONS_BIT = VK_BIT(3), // Optional
1105 VK_QUERY_PIPELINE_STATISTIC_GS_PRIMITIVES_BIT = VK_BIT(4), // Optional
1106 VK_QUERY_PIPELINE_STATISTIC_C_INVOCATIONS_BIT = VK_BIT(5), // Optional
1107 VK_QUERY_PIPELINE_STATISTIC_C_PRIMITIVES_BIT = VK_BIT(6), // Optional
1108 VK_QUERY_PIPELINE_STATISTIC_FS_INVOCATIONS_BIT = VK_BIT(7), // Optional
1109 VK_QUERY_PIPELINE_STATISTIC_TCS_PATCHES_BIT = VK_BIT(8), // Optional
1110 VK_QUERY_PIPELINE_STATISTIC_TES_INVOCATIONS_BIT = VK_BIT(9), // Optional
1111 VK_QUERY_PIPELINE_STATISTIC_CS_INVOCATIONS_BIT = VK_BIT(10), // Optional
1112} VkQueryPipelineStatisticFlagBits;
1113
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001114// Memory mapping flags
1115typedef VkFlags VkMemoryMapFlags;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001116
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001117// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001118// Vulkan structures
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001119
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001120typedef struct VkOffset2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001121{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001122 int32_t x;
1123 int32_t y;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001124} VkOffset2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001125
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001126typedef struct VkOffset3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001127{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001128 int32_t x;
1129 int32_t y;
1130 int32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001131} VkOffset3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001132
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001133typedef struct VkExtent2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001134{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001135 int32_t width;
1136 int32_t height;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001137} VkExtent2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001138
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001139typedef struct VkExtent3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001140{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001141 int32_t width;
1142 int32_t height;
1143 int32_t depth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001144} VkExtent3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001145
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001146typedef struct VkViewport_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001147{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001148 float originX;
1149 float originY;
1150 float width;
1151 float height;
1152 float minDepth;
1153 float maxDepth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001154} VkViewport;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001155
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001156typedef struct VkRect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001157{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001158 VkOffset2D offset;
1159 VkExtent2D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001160} VkRect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001161
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001162typedef struct VkChannelMapping_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001163{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001164 VkChannelSwizzle r;
1165 VkChannelSwizzle g;
1166 VkChannelSwizzle b;
1167 VkChannelSwizzle a;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001168} VkChannelMapping;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001169
Tony Barbour8205d902015-04-16 15:59:00 -06001170typedef struct VkPhysicalDeviceProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001171{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001172 uint32_t apiVersion;
1173 uint32_t driverVersion;
1174 uint32_t vendorId;
1175 uint32_t deviceId;
Tony Barbour8205d902015-04-16 15:59:00 -06001176 VkPhysicalDeviceType deviceType;
1177 char deviceName[VK_MAX_PHYSICAL_DEVICE_NAME];
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001178 uint32_t maxBoundDescriptorSets;
1179 uint32_t maxThreadGroupSize;
1180 uint64_t timestampFrequency;
1181 bool32_t multiColorAttachmentClears;
1182 uint32_t maxDescriptorSets; // at least 2?
1183 uint32_t maxViewports; // at least 16?
1184 uint32_t maxColorAttachments; // at least 8?
Tony Barbour8205d902015-04-16 15:59:00 -06001185} VkPhysicalDeviceProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001186
Chris Forbesd7576302015-06-21 22:55:02 +12001187typedef struct VkPhysicalDeviceFeatures_
1188{
1189 // GFL_32 features
1190 bool32_t supportsGeometryShader;
1191 bool32_t supportsTessellationShader;
1192 bool32_t supportsSampleRateShading;
1193 bool32_t supportsFragmentSideEffects;
1194 bool32_t supportsConstantStorageBufferArrayIdexing;
1195 bool32_t supportsConstantStorageImageArrayIndexing;
1196 bool32_t supportsConstantUniformBufferArrayIndexing;
1197 bool32_t supportsDynamicSampledImageArrayIndexing;
1198 // GFL_45 features
1199 bool32_t supportsBlendSrc1;
1200 bool32_t supportsClipAndCullDistance;
1201 bool32_t supportsLogicOp;
1202 bool32_t supportsInstancedDrawIndirect;
1203 bool32_t supportsDepthClip;
1204 bool32_t supportsFillMode;
1205 bool32_t supportsStorageImageExtendedFormats;
1206 bool32_t supportsStorageImageMultisample;
1207 bool32_t supportsPipelineStatisticsQuery;
1208 bool32_t supportsVTGSideEffects;
1209 bool32_t supportsDynamicUniformBufferArrayIndexing;
1210 // optional features
1211 bool32_t supportsDynamicStorageBufferArrayIndexing;
1212 bool32_t supportsDynamicStorageImageArrayIndexing;
1213 bool32_t supportsShaderFloat64;
1214 bool32_t supportsDepthBounds;
1215 bool32_t supportsWideLines;
1216 bool32_t supportsTextureCompressionETC2;
1217 bool32_t supportsTextureCompressionASTC_LDR;
1218 bool32_t supportsTextureCompressionBC;
1219} VkPhysicalDeviceFeatures;
1220
1221typedef struct VkPhysicalDeviceLimits_
1222{
1223 uint32_t maxImageDimensions;
1224 uint32_t maxImageDepth;
1225 uint32_t maxImageArrayLayers;
1226 // <lots more>
1227} VkPhysicalDeviceLimits;
1228
1229
Tony Barbour8205d902015-04-16 15:59:00 -06001230typedef struct VkPhysicalDevicePerformance_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001231{
Tony Barbour8205d902015-04-16 15:59:00 -06001232 float maxDeviceClock;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001233 float aluPerClock;
1234 float texPerClock;
1235 float primsPerClock;
1236 float pixelsPerClock;
Tony Barbour8205d902015-04-16 15:59:00 -06001237} VkPhysicalDevicePerformance;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001238
Jon Ashburneb2728b2015-04-10 14:33:07 -06001239typedef struct VkExtensionProperties_
1240{
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001241 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES
1242 char name[VK_MAX_EXTENSION_NAME]; // extension name
Jon Ashburneb2728b2015-04-10 14:33:07 -06001243 uint32_t version; // version of the extension specification
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001244 char description[VK_MAX_EXTENSION_NAME]; // Name of library implementing this extension
Jon Ashburneb2728b2015-04-10 14:33:07 -06001245} VkExtensionProperties;
1246
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001247typedef struct VkApplicationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001248{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001249 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_APPLICATION_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001250 const void* pNext; // Next structure in chain
1251 const char* pAppName;
1252 uint32_t appVersion;
1253 const char* pEngineName;
1254 uint32_t engineVersion;
1255 uint32_t apiVersion;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001256} VkApplicationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001257
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001258typedef void* (VKAPI *PFN_vkAllocFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001259 void* pUserData,
1260 size_t size,
1261 size_t alignment,
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001262 VkSystemAllocType allocType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001263
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001264typedef void (VKAPI *PFN_vkFreeFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001265 void* pUserData,
1266 void* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001267
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001268typedef struct VkAllocCallbacks_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001269{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001270 void* pUserData;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001271 PFN_vkAllocFunction pfnAlloc;
1272 PFN_vkFreeFunction pfnFree;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001273} VkAllocCallbacks;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001274
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001275typedef struct VkDeviceQueueCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001276{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001277 uint32_t queueNodeIndex;
1278 uint32_t queueCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001279} VkDeviceQueueCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001280
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001281typedef struct VkDeviceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001282{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001283 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001284 const void* pNext; // Pointer to next structure
1285 uint32_t queueRecordCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001286 const VkDeviceQueueCreateInfo* pRequestedQueues;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001287 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001288 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Chris Forbesd7576302015-06-21 22:55:02 +12001289 const VkPhysicalDeviceFeatures* pEnabledFeatures;
Tony Barbour8205d902015-04-16 15:59:00 -06001290 VkDeviceCreateFlags flags; // Device creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001291} VkDeviceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001292
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001293typedef struct VkInstanceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001294{
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001295 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001296 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001297 const VkApplicationInfo* pAppInfo;
1298 const VkAllocCallbacks* pAllocCb;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001299 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001300 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001301} VkInstanceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001302
Tony Barbour8205d902015-04-16 15:59:00 -06001303typedef struct VkPhysicalDeviceQueueProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001304{
Tony Barbour8205d902015-04-16 15:59:00 -06001305 VkQueueFlags queueFlags; // Queue flags
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001306 uint32_t queueCount;
1307 uint32_t maxAtomicCounters;
1308 bool32_t supportsTimestamps;
Tony Barbour8205d902015-04-16 15:59:00 -06001309} VkPhysicalDeviceQueueProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001310
Mark Lobodzinski72346292015-07-02 16:49:40 -06001311typedef struct VkMemoryType_
1312{
1313 VkMemoryPropertyFlags propertyFlags; // Memory properties of this memory type
1314 uint32_t heapIndex; // Index of the memory heap allocations of this memory type are taken from
1315} VkMemoryType;
1316
1317typedef struct VkMemoryHeap_
1318{
1319 VkDeviceSize size; // Available memory in the heap
1320} VkMemoryHeap;
1321
Tony Barbour8205d902015-04-16 15:59:00 -06001322typedef struct VkPhysicalDeviceMemoryProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001323{
Mark Lobodzinski72346292015-07-02 16:49:40 -06001324 uint32_t memoryTypeCount;
1325 VkMemoryType memoryTypes[VK_MAX_MEMORY_TYPES];
1326 uint32_t memoryHeapCount;
1327 VkMemoryHeap memoryHeaps[VK_MAX_MEMORY_HEAPS];
Tony Barbour8205d902015-04-16 15:59:00 -06001328} VkPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001329
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001330typedef struct VkMemoryAllocInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001331{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001332 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001333 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001334 VkDeviceSize allocationSize; // Size of memory allocation
Mark Lobodzinski72346292015-07-02 16:49:40 -06001335 uint32_t memoryTypeIndex; // Index of the memory type to allocate from
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001336} VkMemoryAllocInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001337
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06001338typedef struct VkMappedMemoryRange_
1339{
1340 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
1341 const void* pNext; // Pointer to next structure
1342 VkDeviceMemory mem; // Mapped memory object
1343 VkDeviceSize offset; // Offset within the mapped memory the range starts from
1344 VkDeviceSize size; // Size of the range within the mapped memory
1345} VkMappedMemoryRange;
1346
Mark Lobodzinski72346292015-07-02 16:49:40 -06001347typedef struct VkMemoryRequirements_
1348{
1349 VkDeviceSize size; // Specified in bytes
1350 VkDeviceSize alignment; // Specified in bytes
1351 VkDeviceSize granularity; // Granularity at which memory can be bound to resource sub-ranges specified in bytes (usually the page size)
1352 uint32_t memoryTypeBits; // Bitfield of the allowed memory type indices into memoryTypes[] for this object
1353} VkMemoryRequirements;
1354
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001355typedef struct VkFormatProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001356{
Tony Barbour8205d902015-04-16 15:59:00 -06001357 VkFormatFeatureFlags linearTilingFeatures; // Format features in case of linear tiling
1358 VkFormatFeatureFlags optimalTilingFeatures; // Format features in case of optimal tiling
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001359} VkFormatProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001360
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001361typedef struct VkDescriptorInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001362{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001363 VkBufferView bufferView; // Buffer view to write to the descriptor (in case it's a buffer descriptor, otherwise should be VK_NULL_HANDLE)
1364 VkSampler sampler; // Sampler to write to the descriptor (in case it's a SAMPLER or COMBINED_IMAGE_SAMPLER descriptor, otherwise should be VK_NULL_HANDLE)
1365 VkImageView imageView; // Image view to write to the descriptor (in case it's a SAMPLED_IMAGE, STORAGE_IMAGE, or COMBINED_IMAGE_SAMPLER descriptor, otherwise should be VK_NULL_HANDLE)
1366 VkImageLayout imageLayout; // Layout the image is expected to be in when accessed using this descriptor (only used if <imageView> is not VK_NULL_HANDLE)
1367} VkDescriptorInfo;
1368
1369typedef struct VkWriteDescriptorSet_
1370{
1371 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001372 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001373
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001374 VkDescriptorSet destSet; // Destination descriptor set
1375 uint32_t destBinding; // Binding within the destination descriptor set to write
1376 uint32_t destArrayElement; // Array element within the destination binding to write
1377
1378 uint32_t count; // Number of descriptors to write (determines the size of the array pointed by <pDescriptors>)
1379
1380 VkDescriptorType descriptorType; // Descriptor type to write (determines which fields of the array pointed by <pDescriptors> are going to be used)
1381 const VkDescriptorInfo* pDescriptors; // Array of info structures describing the descriptors to write
1382} VkWriteDescriptorSet;
1383
1384typedef struct VkCopyDescriptorSet_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001385{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001386 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001387 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001388
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001389 VkDescriptorSet srcSet; // Source descriptor set
1390 uint32_t srcBinding; // Binding within the source descriptor set to copy from
1391 uint32_t srcArrayElement; // Array element within the source binding to copy from
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001392
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001393 VkDescriptorSet destSet; // Destination descriptor set
1394 uint32_t destBinding; // Binding within the destination descriptor set to copy to
1395 uint32_t destArrayElement; // Array element within the destination binding to copy to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001396
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001397 uint32_t count; // Number of descriptors to copy
1398} VkCopyDescriptorSet;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001399
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001400typedef struct VkBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001401{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001402 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001403 const void* pNext; // Pointer to next structure.
Tony Barbour8205d902015-04-16 15:59:00 -06001404 VkDeviceSize size; // Specified in bytes
1405 VkBufferUsageFlags usage; // Buffer usage flags
1406 VkBufferCreateFlags flags; // Buffer creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001407} VkBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001408
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001409typedef struct VkBufferViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001410{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001411 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001412 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001413 VkBuffer buffer;
1414 VkBufferViewType viewType;
1415 VkFormat format; // Optionally specifies format of elements
Tony Barbour8205d902015-04-16 15:59:00 -06001416 VkDeviceSize offset; // Specified in bytes
1417 VkDeviceSize range; // View size specified in bytes
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001418} VkBufferViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001419
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001420typedef struct VkImageSubresource_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001421{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001422 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001423 uint32_t mipLevel;
1424 uint32_t arraySlice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001425} VkImageSubresource;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001426
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001427typedef struct VkImageSubresourceRange_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001428{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001429 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001430 uint32_t baseMipLevel;
1431 uint32_t mipLevels;
1432 uint32_t baseArraySlice;
1433 uint32_t arraySize;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001434} VkImageSubresourceRange;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001435
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001436typedef struct VkMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001437{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001438 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001439 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001440
Tony Barbour8205d902015-04-16 15:59:00 -06001441 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1442 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001443} VkMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001444
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001445typedef struct VkBufferMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001446{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001447 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001448 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001449
Tony Barbour8205d902015-04-16 15:59:00 -06001450 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1451 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001452
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001453 VkBuffer buffer; // Buffer to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001454
Tony Barbour8205d902015-04-16 15:59:00 -06001455 VkDeviceSize offset; // Offset within the buffer to sync
1456 VkDeviceSize size; // Amount of bytes to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001457} VkBufferMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001458
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001459typedef struct VkImageMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001460{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001461 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001462 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001463
Tony Barbour8205d902015-04-16 15:59:00 -06001464 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1465 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001466
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001467 VkImageLayout oldLayout; // Current layout of the image
1468 VkImageLayout newLayout; // New layout to transition the image to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001469
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001470 VkImage image; // Image to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001471
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001472 VkImageSubresourceRange subresourceRange; // Subresource range to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001473} VkImageMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001474
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001475typedef struct VkImageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001476{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001477 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001478 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001479 VkImageType imageType;
1480 VkFormat format;
1481 VkExtent3D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001482 uint32_t mipLevels;
1483 uint32_t arraySize;
1484 uint32_t samples;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001485 VkImageTiling tiling;
Tony Barbour8205d902015-04-16 15:59:00 -06001486 VkImageUsageFlags usage; // Image usage flags
1487 VkImageCreateFlags flags; // Image creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001488} VkImageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001489
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001490typedef struct VkSubresourceLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001491{
Tony Barbour8205d902015-04-16 15:59:00 -06001492 VkDeviceSize offset; // Specified in bytes
1493 VkDeviceSize size; // Specified in bytes
1494 VkDeviceSize rowPitch; // Specified in bytes
1495 VkDeviceSize depthPitch; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001496} VkSubresourceLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001497
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001498typedef struct VkImageViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001499{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001500 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001501 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001502 VkImage image;
1503 VkImageViewType viewType;
1504 VkFormat format;
1505 VkChannelMapping channels;
1506 VkImageSubresourceRange subresourceRange;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001507} VkImageViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001508
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001509typedef struct VkColorAttachmentViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001510{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001511 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001512 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001513 VkImage image;
1514 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001515 uint32_t mipLevel;
1516 uint32_t baseArraySlice;
1517 uint32_t arraySize;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001518 VkImage msaaResolveImage;
1519 VkImageSubresourceRange msaaResolveSubResource;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001520} VkColorAttachmentViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001521
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001522typedef struct VkDepthStencilViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001523{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001524 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001525 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001526 VkImage image;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001527 uint32_t mipLevel;
1528 uint32_t baseArraySlice;
1529 uint32_t arraySize;
Tony Barbour8205d902015-04-16 15:59:00 -06001530 VkDepthStencilViewCreateFlags flags; // Depth stencil attachment view flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001531} VkDepthStencilViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001532
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001533typedef struct VkColorAttachmentBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001534{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001535 VkColorAttachmentView view;
1536 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001537} VkColorAttachmentBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001538
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001539typedef struct VkDepthStencilBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001540{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001541 VkDepthStencilView view;
1542 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001543} VkDepthStencilBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001544
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001545typedef struct VkBufferCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001546{
Tony Barbour8205d902015-04-16 15:59:00 -06001547 VkDeviceSize srcOffset; // Specified in bytes
1548 VkDeviceSize destOffset; // Specified in bytes
1549 VkDeviceSize copySize; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001550} VkBufferCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001551
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001552typedef struct VkImageMemoryBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001553{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001554 VkImageSubresource subresource;
1555 VkOffset3D offset;
1556 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001557} VkImageMemoryBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001558
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001559typedef struct VkImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001560{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001561 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001562 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001563 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001564 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1565 VkExtent3D extent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001566} VkImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001567
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001568typedef struct VkImageBlit_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001569{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001570 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001571 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
1572 VkExtent3D srcExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001573 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001574 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1575 VkExtent3D destExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001576} VkImageBlit;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001577
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001578typedef struct VkBufferImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001579{
Tony Barbour8205d902015-04-16 15:59:00 -06001580 VkDeviceSize bufferOffset; // Specified in bytes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001581 VkImageSubresource imageSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001582 VkOffset3D imageOffset; // Specified in pixels for both compressed and uncompressed images
1583 VkExtent3D imageExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001584} VkBufferImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001585
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001586typedef struct VkImageResolve_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001587{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001588 VkImageSubresource srcSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001589 VkOffset3D srcOffset;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001590 VkImageSubresource destSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001591 VkOffset3D destOffset;
1592 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001593} VkImageResolve;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001594
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001595typedef struct VkShaderModuleCreateInfo_
1596{
1597 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
1598 const void* pNext; // Pointer to next structure
1599 size_t codeSize; // Specified in bytes
1600 const void* pCode; // Binary code of size codeSize
1601 VkShaderModuleCreateFlags flags; // Reserved
1602} VkShaderModuleCreateInfo;
1603
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001604typedef struct VkShaderCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001605{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001606 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001607 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001608 VkShaderModule module; // Module containing entry point
Courtney Goeltzenleuchter2d034fd2015-06-28 13:01:17 -06001609 const char* pName; // Null-terminate entry point name
Tony Barbour8205d902015-04-16 15:59:00 -06001610 VkShaderCreateFlags flags; // Reserved
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001611} VkShaderCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001612
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001613typedef struct VkDescriptorSetLayoutBinding_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001614{
Tony Barbour8205d902015-04-16 15:59:00 -06001615 VkDescriptorType descriptorType; // Type of the descriptors in this binding
Chia-I Wud3114a22015-05-25 16:22:52 +08001616 uint32_t arraySize; // Number of descriptors in this binding
Tony Barbour8205d902015-04-16 15:59:00 -06001617 VkShaderStageFlags stageFlags; // Shader stages this binding is visible to
1618 const VkSampler* pImmutableSamplers; // Immutable samplers (used if descriptor type is SAMPLER or COMBINED_IMAGE_SAMPLER, is either NULL or contains <count> number of elements)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001619} VkDescriptorSetLayoutBinding;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001620
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001621typedef struct VkDescriptorSetLayoutCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001622{
Tony Barbour8205d902015-04-16 15:59:00 -06001623 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
1624 const void* pNext; // Pointer to next structure
1625 uint32_t count; // Number of bindings in the descriptor set layout
1626 const VkDescriptorSetLayoutBinding* pBinding; // Array of descriptor set layout bindings
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001627} VkDescriptorSetLayoutCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001628
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001629typedef struct VkDescriptorTypeCount_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001630{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001631 VkDescriptorType type;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001632 uint32_t count;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001633} VkDescriptorTypeCount;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001634
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001635typedef struct VkDescriptorPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001636{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001637 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001638 const void* pNext; // Pointer to next structure
1639 uint32_t count;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001640 const VkDescriptorTypeCount* pTypeCount;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001641} VkDescriptorPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001642
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001643typedef struct VkLinkConstBuffer_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001644{
1645 uint32_t bufferId;
1646 size_t bufferSize;
1647 const void* pBufferData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001648} VkLinkConstBuffer;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001649
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001650typedef struct VkSpecializationMapEntry_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001651{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001652 uint32_t constantId; // The SpecConstant ID specified in the BIL
1653 uint32_t offset; // Offset of the value in the data block
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001654} VkSpecializationMapEntry;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001655
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001656typedef struct VkSpecializationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001657{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001658 uint32_t mapEntryCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001659 const VkSpecializationMapEntry* pMap; // mapEntryCount entries
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001660 const void* pData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001661} VkSpecializationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001662
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001663typedef struct VkPipelineShaderStageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001664{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001665 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
1666 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001667 VkShaderStage stage;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001668 VkShader shader;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001669 uint32_t linkConstBufferCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001670 const VkLinkConstBuffer* pLinkConstBufferInfo;
1671 const VkSpecializationInfo* pSpecializationInfo;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001672} VkPipelineShaderStageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001673
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001674typedef struct VkComputePipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001675{
Tony Barbour8205d902015-04-16 15:59:00 -06001676 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
1677 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001678 VkPipelineShaderStageCreateInfo cs;
Tony Barbour8205d902015-04-16 15:59:00 -06001679 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001680 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001681} VkComputePipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001682
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001683typedef struct VkVertexInputBindingDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001684{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001685 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001686 uint32_t strideInBytes; // Distance between vertices in bytes (0 = no advancement)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001687
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001688 VkVertexInputStepRate stepRate; // Rate at which binding is incremented
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001689} VkVertexInputBindingDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001690
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001691typedef struct VkVertexInputAttributeDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001692{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001693 uint32_t location; // location of the shader vertex attrib
1694 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001695
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001696 VkFormat format; // format of source data
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001697
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001698 uint32_t offsetInBytes; // Offset of first element in bytes from base of vertex
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001699} VkVertexInputAttributeDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001700
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001701typedef struct VkPipelineVertexInputStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001702{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001703 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001704 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001705
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001706 uint32_t bindingCount; // number of bindings
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001707 const VkVertexInputBindingDescription* pVertexBindingDescriptions;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001708
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001709 uint32_t attributeCount; // number of attributes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001710 const VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001711} VkPipelineVertexInputStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001712
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001713typedef struct VkPipelineIaStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001714{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001715 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001716 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001717 VkPrimitiveTopology topology;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001718 bool32_t disableVertexReuse; // optional
1719 bool32_t primitiveRestartEnable;
1720 uint32_t primitiveRestartIndex; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001721} VkPipelineIaStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001722
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001723typedef struct VkPipelineTessStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001724{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001725 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001726 const void* pNext; // Pointer to next structure
1727 uint32_t patchControlPoints;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001728} VkPipelineTessStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001729
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001730typedef struct VkPipelineVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001731{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001732 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001733 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001734 uint32_t viewportCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001735 VkCoordinateOrigin clipOrigin; // optional (GL45)
1736 VkDepthMode depthMode; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001737} VkPipelineVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001738
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001739typedef struct VkPipelineRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001740{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001741 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001742 const void* pNext; // Pointer to next structure
1743 bool32_t depthClipEnable;
1744 bool32_t rasterizerDiscardEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001745 VkCoordinateOrigin pointOrigin; // optional (GL45)
Tony Barbour8205d902015-04-16 15:59:00 -06001746 VkProvokingVertex provokingVertex; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001747 VkFillMode fillMode; // optional (GL45)
1748 VkCullMode cullMode;
Tony Barbour8205d902015-04-16 15:59:00 -06001749 VkFrontFace frontFace;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001750} VkPipelineRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001751
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001752typedef struct VkPipelineMsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001753{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001754 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001755 const void* pNext; // Pointer to next structure
Tony Barboure094edf2015-06-26 10:18:34 -06001756 uint32_t rasterSamples;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001757 bool32_t multisampleEnable; // optional (GL45)
1758 bool32_t sampleShadingEnable; // optional (GL45)
1759 float minSampleShading; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001760 VkSampleMask sampleMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001761} VkPipelineMsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001762
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001763typedef struct VkPipelineCbAttachmentState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001764{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001765 bool32_t blendEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001766 VkFormat format;
1767 VkBlend srcBlendColor;
1768 VkBlend destBlendColor;
Tony Barbour8205d902015-04-16 15:59:00 -06001769 VkBlendOp blendOpColor;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001770 VkBlend srcBlendAlpha;
1771 VkBlend destBlendAlpha;
Tony Barbour8205d902015-04-16 15:59:00 -06001772 VkBlendOp blendOpAlpha;
1773 VkChannelFlags channelWriteMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001774} VkPipelineCbAttachmentState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001775
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001776typedef struct VkPipelineCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001777{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001778 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001779 const void* pNext; // Pointer to next structure
1780 bool32_t alphaToCoverageEnable;
1781 bool32_t logicOpEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001782 VkLogicOp logicOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001783 uint32_t attachmentCount; // # of pAttachments
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001784 const VkPipelineCbAttachmentState* pAttachments;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001785} VkPipelineCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001786
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001787typedef struct VkStencilOpState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001788{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001789 VkStencilOp stencilFailOp;
1790 VkStencilOp stencilPassOp;
1791 VkStencilOp stencilDepthFailOp;
Tony Barbour8205d902015-04-16 15:59:00 -06001792 VkCompareOp stencilCompareOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001793} VkStencilOpState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001794
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001795typedef struct VkPipelineDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001796{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001797 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001798 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001799 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001800 bool32_t depthTestEnable;
1801 bool32_t depthWriteEnable;
Tony Barbour8205d902015-04-16 15:59:00 -06001802 VkCompareOp depthCompareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001803 bool32_t depthBoundsEnable; // optional (depth_bounds_test)
1804 bool32_t stencilTestEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001805 VkStencilOpState front;
1806 VkStencilOpState back;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001807} VkPipelineDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001808
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001809typedef struct VkGraphicsPipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001810{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001811 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001812 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001813 uint32_t stageCount;
1814 const VkPipelineShaderStageCreateInfo* pStages; // One entry for each active shader stage
1815 const VkPipelineVertexInputStateCreateInfo* pVertexInputState;
1816 const VkPipelineIaStateCreateInfo* pIaState;
1817 const VkPipelineTessStateCreateInfo* pTessState;
1818 const VkPipelineVpStateCreateInfo* pVpState;
1819 const VkPipelineRsStateCreateInfo* pRsState;
1820 const VkPipelineMsStateCreateInfo* pMsState;
1821 const VkPipelineDsStateCreateInfo* pDsState;
1822 const VkPipelineCbStateCreateInfo* pCbState;
Tony Barbour8205d902015-04-16 15:59:00 -06001823 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001824 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001825} VkGraphicsPipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001826
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001827typedef struct VkPipelineLayoutCreateInfo_
1828{
1829 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
1830 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001831
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001832 uint32_t descriptorSetCount; // Number of descriptor sets interfaced by the pipeline
1833 const VkDescriptorSetLayout* pSetLayouts; // Array of <setCount> number of descriptor set layout objects defining the layout of the
1834} VkPipelineLayoutCreateInfo;
1835
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001836typedef struct VkSamplerCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001837{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001838 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001839 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001840 VkTexFilter magFilter; // Filter mode for magnification
1841 VkTexFilter minFilter; // Filter mode for minifiation
1842 VkTexMipmapMode mipMode; // Mipmap selection mode
1843 VkTexAddress addressU;
1844 VkTexAddress addressV;
1845 VkTexAddress addressW;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001846 float mipLodBias;
1847 uint32_t maxAnisotropy;
Tony Barbour8205d902015-04-16 15:59:00 -06001848 VkCompareOp compareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001849 float minLod;
1850 float maxLod;
Tony Barbour8205d902015-04-16 15:59:00 -06001851 VkBorderColor borderColor;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001852} VkSamplerCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001853
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001854typedef struct VkDynamicVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001855{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001856 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001857 const void* pNext; // Pointer to next structure
1858 uint32_t viewportAndScissorCount; // number of entries in pViewports and pScissors
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001859 const VkViewport* pViewports;
1860 const VkRect* pScissors;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001861} VkDynamicVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001862
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001863typedef struct VkDynamicRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001864{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001865 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001866 const void* pNext; // Pointer to next structure
1867 float depthBias;
1868 float depthBiasClamp;
1869 float slopeScaledDepthBias;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001870 float lineWidth; // optional (GL45) - Width of lines
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001871} VkDynamicRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001872
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001873typedef struct VkDynamicCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001874{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001875 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001876 const void* pNext; // Pointer to next structure
1877 float blendConst[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001878} VkDynamicCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001879
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001880typedef struct VkDynamicDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001881{
Mark Lobodzinski4405fbf2015-06-12 11:14:17 -06001882 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO
1883 const void* pNext; // Pointer to next structure
1884 float minDepthBounds; // optional (depth_bounds_test)
1885 float maxDepthBounds; // optional (depth_bounds_test)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001886 uint32_t stencilReadMask;
1887 uint32_t stencilWriteMask;
1888 uint32_t stencilFrontRef;
1889 uint32_t stencilBackRef;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001890} VkDynamicDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001891
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001892typedef struct VkCmdBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001893{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001894 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001895 const void* pNext; // Pointer to next structure
1896 uint32_t queueNodeIndex;
Tony Barbour8205d902015-04-16 15:59:00 -06001897 VkCmdBufferCreateFlags flags; // Command buffer creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001898} VkCmdBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001899
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001900typedef struct VkCmdBufferBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001901{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001902 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001903 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001904
Tony Barbour8205d902015-04-16 15:59:00 -06001905 VkCmdBufferOptimizeFlags flags; // Command buffer optimization flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001906} VkCmdBufferBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001907
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001908typedef struct VkRenderPassBegin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001909{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001910 VkRenderPass renderPass;
1911 VkFramebuffer framebuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001912} VkRenderPassBegin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001913
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001914typedef struct VkCmdBufferGraphicsBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001915{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001916 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001917 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001918
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001919 VkRenderPassBegin renderPassContinue; // Only needed when a render pass is split across two command buffers
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001920} VkCmdBufferGraphicsBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001921
1922// Union allowing specification of floating point or raw color data. Actual value selected is based on image being cleared.
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001923typedef union VkClearColorValue_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001924{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001925 float floatColor[4];
1926 uint32_t rawColor[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001927} VkClearColorValue;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001928
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001929typedef struct VkClearColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001930{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001931 VkClearColorValue color;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001932 bool32_t useRawValue;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001933} VkClearColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001934
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001935typedef struct VkRenderPassCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001936{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001937 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001938 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001939
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001940 VkRect renderArea;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001941 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001942 VkExtent2D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001943 uint32_t sampleCount;
1944 uint32_t layers;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001945 const VkFormat* pColorFormats;
1946 const VkImageLayout* pColorLayouts;
1947 const VkAttachmentLoadOp* pColorLoadOps;
1948 const VkAttachmentStoreOp* pColorStoreOps;
1949 const VkClearColor* pColorLoadClearValues;
1950 VkFormat depthStencilFormat;
1951 VkImageLayout depthStencilLayout;
1952 VkAttachmentLoadOp depthLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001953 float depthLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001954 VkAttachmentStoreOp depthStoreOp;
1955 VkAttachmentLoadOp stencilLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001956 uint32_t stencilLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001957 VkAttachmentStoreOp stencilStoreOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001958} VkRenderPassCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001959
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001960typedef struct VkEventCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001961{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001962 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_EVENT_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001963 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001964 VkEventCreateFlags flags; // Event creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001965} VkEventCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001966
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001967typedef struct VkFenceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001968{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001969 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001970 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001971 VkFenceCreateFlags flags; // Fence creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001972} VkFenceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001973
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001974typedef struct VkSemaphoreCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001975{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001976 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001977 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001978 VkSemaphoreCreateFlags flags; // Semaphore creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001979} VkSemaphoreCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001980
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001981typedef struct VkQueryPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001982{
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001983 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO
1984 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001985 VkQueryType queryType;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001986 uint32_t slots;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001987 VkQueryPipelineStatisticFlags pipelineStatistics; // Optional
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001988} VkQueryPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001989
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001990typedef struct VkFramebufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001991{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001992 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001993 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001994
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001995 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001996 const VkColorAttachmentBindInfo* pColorAttachments;
1997 const VkDepthStencilBindInfo* pDepthStencilAttachment;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001998
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001999 uint32_t sampleCount;
2000 uint32_t width;
2001 uint32_t height;
2002 uint32_t layers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002003} VkFramebufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002004
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002005typedef struct VkDrawIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002006{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002007 uint32_t vertexCount;
2008 uint32_t instanceCount;
2009 uint32_t firstVertex;
2010 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002011} VkDrawIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002012
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002013typedef struct VkDrawIndexedIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002014{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002015 uint32_t indexCount;
2016 uint32_t instanceCount;
2017 uint32_t firstIndex;
2018 int32_t vertexOffset;
2019 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002020} VkDrawIndexedIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002021
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002022typedef struct VkDispatchIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002023{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002024 uint32_t x;
2025 uint32_t y;
2026 uint32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002027} VkDispatchIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002028
2029// ------------------------------------------------------------------------------------------------
2030// API functions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002031typedef VkResult (VKAPI *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance);
2032typedef VkResult (VKAPI *PFN_vkDestroyInstance)(VkInstance instance);
Tony Barbour8205d902015-04-16 15:59:00 -06002033typedef VkResult (VKAPI *PFN_vkEnumeratePhysicalDevices)(VkInstance instance, uint32_t* pPhysicalDeviceCount, VkPhysicalDevice* pPhysicalDevices);
Chris Forbesd7576302015-06-21 22:55:02 +12002034typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFeatures)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures);
2035typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFormatInfo)(VkPhysicalDevice physicalDevice, VkFormat format, VkFormatProperties *pFormatInfo);
2036typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceLimits)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceLimits* pLimits);
Jon Ashburn53c16772015-05-06 10:15:07 -06002037typedef void * (VKAPI *PFN_vkGetInstanceProcAddr)(VkInstance instance, const char * pName);
Jon Ashburn1245cec2015-05-18 13:20:15 -06002038typedef void * (VKAPI *PFN_vkGetDeviceProcAddr)(VkDevice device, const char * pName);
Tony Barbour8205d902015-04-16 15:59:00 -06002039typedef VkResult (VKAPI *PFN_vkCreateDevice)(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, VkDevice* pDevice);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002040typedef VkResult (VKAPI *PFN_vkDestroyDevice)(VkDevice device);
Tony Barbour426b9052015-06-24 16:06:58 -06002041typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties* pProperties);
2042typedef VkResult (VKAPI *PFN_vkGetPhysicalDevicePerformance)(VkPhysicalDevice physicalDevice, VkPhysicalDevicePerformance* pPerformance);
2043typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2044typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueProperties)(VkPhysicalDevice physicalDevice, uint32_t count, VkPhysicalDeviceQueueProperties* pQueueProperties);
2045typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceMemoryProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2046typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionCount)(uint32_t* pCount);
2047typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionProperties)(uint32_t extensionIndex, VkExtensionProperties* pProperties);
2048typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2049typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionProperties)(VkPhysicalDevice physicalDevice, uint32_t extensionIndex, VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002050typedef VkResult (VKAPI *PFN_vkGetDeviceQueue)(VkDevice device, uint32_t queueNodeIndex, uint32_t queueIndex, VkQueue* pQueue);
2051typedef VkResult (VKAPI *PFN_vkQueueSubmit)(VkQueue queue, uint32_t cmdBufferCount, const VkCmdBuffer* pCmdBuffers, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002052typedef VkResult (VKAPI *PFN_vkQueueWaitIdle)(VkQueue queue);
2053typedef VkResult (VKAPI *PFN_vkDeviceWaitIdle)(VkDevice device);
Tony Barbour8205d902015-04-16 15:59:00 -06002054typedef VkResult (VKAPI *PFN_vkAllocMemory)(VkDevice device, const VkMemoryAllocInfo* pAllocInfo, VkDeviceMemory* pMem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002055typedef VkResult (VKAPI *PFN_vkFreeMemory)(VkDevice device, VkDeviceMemory mem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002056typedef VkResult (VKAPI *PFN_vkMapMemory)(VkDevice device, VkDeviceMemory mem, VkDeviceSize offset, VkDeviceSize size, VkMemoryMapFlags flags, void** ppData);
2057typedef VkResult (VKAPI *PFN_vkUnmapMemory)(VkDevice device, VkDeviceMemory mem);
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002058typedef VkResult (VKAPI *PFN_vkFlushMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
2059typedef VkResult (VKAPI *PFN_vkInvalidateMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
Mike Stroyan230e6252015-04-17 12:36:38 -06002060typedef VkResult (VKAPI *PFN_vkDestroyObject)(VkDevice device, VkObjectType objType, VkObject object);
Tony Barbour426b9052015-06-24 16:06:58 -06002061typedef VkResult (VKAPI *PFN_vkGetObjectMemoryRequirements)(VkDevice device, VkObjectType objType, VkObject object, VkMemoryRequirements* pMemoryRequirements);
Mark Lobodzinski23182612015-05-29 09:32:35 -05002062typedef VkResult (VKAPI *PFN_vkBindObjectMemory)(VkDevice device, VkObjectType objType, VkObject object, VkDeviceMemory mem, VkDeviceSize offset);
2063typedef VkResult (VKAPI *PFN_vkQueueBindSparseBufferMemory)(VkQueue queue, VkBuffer buffer, VkDeviceSize rangeOffset, VkDeviceSize rangeSize, VkDeviceMemory mem, VkDeviceSize memOffset);
2064typedef VkResult (VKAPI *PFN_vkQueueBindSparseImageMemory)(VkQueue queue, VkImage image, const VkImageMemoryBindInfo* pBindInfo, VkDeviceMemory mem, VkDeviceSize memOffset);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002065typedef VkResult (VKAPI *PFN_vkCreateFence)(VkDevice device, const VkFenceCreateInfo* pCreateInfo, VkFence* pFence);
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002066typedef VkResult (VKAPI *PFN_vkResetFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences);
Mike Stroyan230e6252015-04-17 12:36:38 -06002067typedef VkResult (VKAPI *PFN_vkGetFenceStatus)(VkDevice device, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002068typedef VkResult (VKAPI *PFN_vkWaitForFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences, bool32_t waitAll, uint64_t timeout);
2069typedef VkResult (VKAPI *PFN_vkCreateSemaphore)(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo, VkSemaphore* pSemaphore);
2070typedef VkResult (VKAPI *PFN_vkQueueSignalSemaphore)(VkQueue queue, VkSemaphore semaphore);
2071typedef VkResult (VKAPI *PFN_vkQueueWaitSemaphore)(VkQueue queue, VkSemaphore semaphore);
2072typedef VkResult (VKAPI *PFN_vkCreateEvent)(VkDevice device, const VkEventCreateInfo* pCreateInfo, VkEvent* pEvent);
Mike Stroyan230e6252015-04-17 12:36:38 -06002073typedef VkResult (VKAPI *PFN_vkGetEventStatus)(VkDevice device, VkEvent event);
2074typedef VkResult (VKAPI *PFN_vkSetEvent)(VkDevice device, VkEvent event);
2075typedef VkResult (VKAPI *PFN_vkResetEvent)(VkDevice device, VkEvent event);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002076typedef VkResult (VKAPI *PFN_vkCreateQueryPool)(VkDevice device, const VkQueryPoolCreateInfo* pCreateInfo, VkQueryPool* pQueryPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002077typedef VkResult (VKAPI *PFN_vkGetQueryPoolResults)(VkDevice device, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount, size_t* pDataSize, void* pData, VkQueryResultFlags flags);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002078typedef VkResult (VKAPI *PFN_vkCreateBuffer)(VkDevice device, const VkBufferCreateInfo* pCreateInfo, VkBuffer* pBuffer);
2079typedef VkResult (VKAPI *PFN_vkCreateBufferView)(VkDevice device, const VkBufferViewCreateInfo* pCreateInfo, VkBufferView* pView);
2080typedef VkResult (VKAPI *PFN_vkCreateImage)(VkDevice device, const VkImageCreateInfo* pCreateInfo, VkImage* pImage);
Tony Barbour426b9052015-06-24 16:06:58 -06002081typedef VkResult (VKAPI *PFN_vkGetImageSubresourceLayout)(VkDevice device, VkImage image, const VkImageSubresource* pSubresource, VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002082typedef VkResult (VKAPI *PFN_vkCreateImageView)(VkDevice device, const VkImageViewCreateInfo* pCreateInfo, VkImageView* pView);
2083typedef VkResult (VKAPI *PFN_vkCreateColorAttachmentView)(VkDevice device, const VkColorAttachmentViewCreateInfo* pCreateInfo, VkColorAttachmentView* pView);
2084typedef VkResult (VKAPI *PFN_vkCreateDepthStencilView)(VkDevice device, const VkDepthStencilViewCreateInfo* pCreateInfo, VkDepthStencilView* pView);
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002085typedef VkResult (VKAPI *PFN_vkCreateShaderModule)(VkDevice device, const VkShaderModuleCreateInfo* pCreateInfo, VkShaderModule* pShaderModule);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002086typedef VkResult (VKAPI *PFN_vkCreateShader)(VkDevice device, const VkShaderCreateInfo* pCreateInfo, VkShader* pShader);
2087typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipeline)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
2088typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipelineDerivative)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline basePipeline, VkPipeline* pPipeline);
2089typedef VkResult (VKAPI *PFN_vkCreateComputePipeline)(VkDevice device, const VkComputePipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
Mike Stroyan230e6252015-04-17 12:36:38 -06002090typedef VkResult (VKAPI *PFN_vkStorePipeline)(VkDevice device, VkPipeline pipeline, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002091typedef VkResult (VKAPI *PFN_vkLoadPipeline)(VkDevice device, size_t dataSize, const void* pData, VkPipeline* pPipeline);
2092typedef VkResult (VKAPI *PFN_vkLoadPipelineDerivative)(VkDevice device, size_t dataSize, const void* pData, VkPipeline basePipeline, VkPipeline* pPipeline);
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002093typedef VkResult (VKAPI *PFN_vkCreatePipelineLayout)(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo, VkPipelineLayout* pPipelineLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002094typedef VkResult (VKAPI *PFN_vkCreateSampler)(VkDevice device, const VkSamplerCreateInfo* pCreateInfo, VkSampler* pSampler);
2095typedef VkResult (VKAPI *PFN_vkCreateDescriptorSetLayout)(VkDevice device, const VkDescriptorSetLayoutCreateInfo* pCreateInfo, VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002096typedef VkResult (VKAPI *PFN_vkCreateDescriptorPool)(VkDevice device, VkDescriptorPoolUsage poolUsage, uint32_t maxSets, const VkDescriptorPoolCreateInfo* pCreateInfo, VkDescriptorPool* pDescriptorPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002097typedef VkResult (VKAPI *PFN_vkResetDescriptorPool)(VkDevice device, VkDescriptorPool descriptorPool);
2098typedef VkResult (VKAPI *PFN_vkAllocDescriptorSets)(VkDevice device, VkDescriptorPool descriptorPool, VkDescriptorSetUsage setUsage, uint32_t count, const VkDescriptorSetLayout* pSetLayouts, VkDescriptorSet* pDescriptorSets, uint32_t* pCount);
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002099typedef VkResult (VKAPI *PFN_vkUpdateDescriptorSets)(VkDevice device, uint32_t writeCount, const VkWriteDescriptorSet* pDescriptorWrites, uint32_t copyCount, const VkCopyDescriptorSet* pDescriptorCopies);
Courtney Goeltzenleuchterfcf855f2015-04-10 16:24:50 -06002100typedef VkResult (VKAPI *PFN_vkCreateDynamicViewportState)(VkDevice device, const VkDynamicVpStateCreateInfo* pCreateInfo, VkDynamicVpState* pState);
2101typedef VkResult (VKAPI *PFN_vkCreateDynamicRasterState)(VkDevice device, const VkDynamicRsStateCreateInfo* pCreateInfo, VkDynamicRsState* pState);
2102typedef VkResult (VKAPI *PFN_vkCreateDynamicColorBlendState)(VkDevice device, const VkDynamicCbStateCreateInfo* pCreateInfo, VkDynamicCbState* pState);
2103typedef VkResult (VKAPI *PFN_vkCreateDynamicDepthStencilState)(VkDevice device, const VkDynamicDsStateCreateInfo* pCreateInfo, VkDynamicDsState* pState);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002104typedef VkResult (VKAPI *PFN_vkCreateCommandBuffer)(VkDevice device, const VkCmdBufferCreateInfo* pCreateInfo, VkCmdBuffer* pCmdBuffer);
2105typedef VkResult (VKAPI *PFN_vkBeginCommandBuffer)(VkCmdBuffer cmdBuffer, const VkCmdBufferBeginInfo* pBeginInfo);
2106typedef VkResult (VKAPI *PFN_vkEndCommandBuffer)(VkCmdBuffer cmdBuffer);
2107typedef VkResult (VKAPI *PFN_vkResetCommandBuffer)(VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002108typedef void (VKAPI *PFN_vkCmdBindPipeline)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, VkPipeline pipeline);
2109typedef void (VKAPI *PFN_vkCmdBindDynamicStateObject)(VkCmdBuffer cmdBuffer, VkStateBindPoint stateBindPoint, VkDynamicStateObject state);
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002110typedef void (VKAPI *PFN_vkCmdBindDescriptorSets)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, VkPipelineLayout layout, uint32_t firstSet, uint32_t setCount, const VkDescriptorSet* pDescriptorSets, uint32_t dynamicOffsetCount, const uint32_t* pDynamicOffsets);
Tony Barbour8205d902015-04-16 15:59:00 -06002111typedef void (VKAPI *PFN_vkCmdBindIndexBuffer)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, VkIndexType indexType);
2112typedef void (VKAPI *PFN_vkCmdBindVertexBuffers)(VkCmdBuffer cmdBuffer, uint32_t startBinding, uint32_t bindingCount, const VkBuffer* pBuffers, const VkDeviceSize* pOffsets);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002113typedef void (VKAPI *PFN_vkCmdDraw)(VkCmdBuffer cmdBuffer, uint32_t firstVertex, uint32_t vertexCount, uint32_t firstInstance, uint32_t instanceCount);
2114typedef void (VKAPI *PFN_vkCmdDrawIndexed)(VkCmdBuffer cmdBuffer, uint32_t firstIndex, uint32_t indexCount, int32_t vertexOffset, uint32_t firstInstance, uint32_t instanceCount);
Tony Barbour8205d902015-04-16 15:59:00 -06002115typedef void (VKAPI *PFN_vkCmdDrawIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
2116typedef void (VKAPI *PFN_vkCmdDrawIndexedIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002117typedef void (VKAPI *PFN_vkCmdDispatch)(VkCmdBuffer cmdBuffer, uint32_t x, uint32_t y, uint32_t z);
Tony Barbour8205d902015-04-16 15:59:00 -06002118typedef void (VKAPI *PFN_vkCmdDispatchIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002119typedef void (VKAPI *PFN_vkCmdCopyBuffer)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkBuffer destBuffer, uint32_t regionCount, const VkBufferCopy* pRegions);
2120typedef void (VKAPI *PFN_vkCmdCopyImage)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkImageCopy* pRegions);
Mark Lobodzinski20f68592015-05-22 14:43:25 -05002121typedef void (VKAPI *PFN_vkCmdBlitImage)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkImageBlit* pRegions, VkTexFilter filter);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002122typedef void (VKAPI *PFN_vkCmdCopyBufferToImage)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkBufferImageCopy* pRegions);
2123typedef void (VKAPI *PFN_vkCmdCopyImageToBuffer)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkBuffer destBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions);
Tony Barbour8205d902015-04-16 15:59:00 -06002124typedef void (VKAPI *PFN_vkCmdUpdateBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize dataSize, const uint32_t* pData);
2125typedef void (VKAPI *PFN_vkCmdFillBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize fillSize, uint32_t data);
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002126typedef void (VKAPI *PFN_vkCmdClearColorImage)(VkCmdBuffer cmdBuffer, VkImage image, VkImageLayout imageLayout, const VkClearColor* pColor, uint32_t rangeCount, const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002127typedef void (VKAPI *PFN_vkCmdClearDepthStencil)(VkCmdBuffer cmdBuffer, VkImage image, VkImageLayout imageLayout, float depth, uint32_t stencil, uint32_t rangeCount, const VkImageSubresourceRange* pRanges);
Tony Barbour11f74372015-04-13 15:02:52 -06002128typedef void (VKAPI *PFN_vkCmdResolveImage)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkImageResolve* pRegions);
Tony Barbourc2e987e2015-06-29 16:20:35 -06002129typedef void (VKAPI *PFN_vkCmdSetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2130typedef void (VKAPI *PFN_vkCmdResetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2131typedef void (VKAPI *PFN_vkCmdWaitEvents)(VkCmdBuffer cmdBuffer, uint32_t eventCount, const VkEvent* pEvents, VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags destStageMask, uint32_t memBarrierCount, const void** ppMemBarriers);
2132typedef void (VKAPI *PFN_vkCmdPipelineBarrier)(VkCmdBuffer cmdBuffer, VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags destStageMask, bool32_t byRegion, uint32_t memBarrierCount, const void** ppMemBarriers);
Tony Barbour8205d902015-04-16 15:59:00 -06002133typedef void (VKAPI *PFN_vkCmdBeginQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot, VkQueryControlFlags flags);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002134typedef void (VKAPI *PFN_vkCmdEndQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot);
2135typedef void (VKAPI *PFN_vkCmdResetQueryPool)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount);
Tony Barbour8205d902015-04-16 15:59:00 -06002136typedef void (VKAPI *PFN_vkCmdWriteTimestamp)(VkCmdBuffer cmdBuffer, VkTimestampType timestampType, VkBuffer destBuffer, VkDeviceSize destOffset);
Tony Barbour3e3420a2015-04-16 19:09:28 -06002137typedef void (VKAPI *PFN_vkCmdCopyQueryPoolResults)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize destStride, VkQueryResultFlags flags);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002138typedef void (VKAPI *PFN_vkCmdInitAtomicCounters)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, uint32_t startCounter, uint32_t counterCount, const uint32_t* pData);
Tony Barbour8205d902015-04-16 15:59:00 -06002139typedef void (VKAPI *PFN_vkCmdLoadAtomicCounters)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, uint32_t startCounter, uint32_t counterCount, VkBuffer srcBuffer, VkDeviceSize srcOffset);
2140typedef void (VKAPI *PFN_vkCmdSaveAtomicCounters)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, uint32_t startCounter, uint32_t counterCount, VkBuffer destBuffer, VkDeviceSize destOffset);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002141typedef VkResult (VKAPI *PFN_vkCreateFramebuffer)(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo, VkFramebuffer* pFramebuffer);
2142typedef VkResult (VKAPI *PFN_vkCreateRenderPass)(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo, VkRenderPass* pRenderPass);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002143typedef void (VKAPI *PFN_vkCmdBeginRenderPass)(VkCmdBuffer cmdBuffer, const VkRenderPassBegin* pRenderPassBegin);
2144typedef void (VKAPI *PFN_vkCmdEndRenderPass)(VkCmdBuffer cmdBuffer, VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002145
2146#ifdef VK_PROTOTYPES
2147
Tony Barbour8205d902015-04-16 15:59:00 -06002148// Device initialization
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002149
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002150VkResult VKAPI vkCreateInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002151 const VkInstanceCreateInfo* pCreateInfo,
2152 VkInstance* pInstance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002153
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002154VkResult VKAPI vkDestroyInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002155 VkInstance instance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002156
Jon Ashburn07b309a2015-04-15 11:31:12 -06002157VkResult VKAPI vkEnumeratePhysicalDevices(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002158 VkInstance instance,
Jon Ashburn07b309a2015-04-15 11:31:12 -06002159 uint32_t* pPhysicalDeviceCount,
Tony Barbour8205d902015-04-16 15:59:00 -06002160 VkPhysicalDevice* pPhysicalDevices);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002161
Chris Forbesd7576302015-06-21 22:55:02 +12002162VkResult VKAPI vkGetPhysicalDeviceFeatures(
2163 VkPhysicalDevice physicalDevice,
2164 VkPhysicalDeviceFeatures* pFeatures);
2165
2166VkResult VKAPI vkGetPhysicalDeviceFormatInfo(
2167 VkPhysicalDevice physicalDevice,
2168 VkFormat format,
2169 VkFormatProperties* pFormatInfo);
2170
2171VkResult VKAPI vkGetPhysicalDeviceLimits(
2172 VkPhysicalDevice physicalDevice,
2173 VkPhysicalDeviceLimits* pLimits);
2174
Jon Ashburn53c16772015-05-06 10:15:07 -06002175void * VKAPI vkGetInstanceProcAddr(
2176 VkInstance instance,
2177 const char* pName);
2178
Jon Ashburn1245cec2015-05-18 13:20:15 -06002179void * VKAPI vkGetDeviceProcAddr(
2180 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002181 const char* pName);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002182// Device functions
2183
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002184VkResult VKAPI vkCreateDevice(
Tony Barbour8205d902015-04-16 15:59:00 -06002185 VkPhysicalDevice physicalDevice,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002186 const VkDeviceCreateInfo* pCreateInfo,
2187 VkDevice* pDevice);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002188
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002189VkResult VKAPI vkDestroyDevice(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002190 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002191
Tony Barbour426b9052015-06-24 16:06:58 -06002192VkResult VKAPI vkGetPhysicalDeviceProperties(
2193 VkPhysicalDevice physicalDevice,
2194 VkPhysicalDeviceProperties* pProperties);
2195
2196VkResult VKAPI vkGetPhysicalDevicePerformance(
2197 VkPhysicalDevice physicalDevice,
2198 VkPhysicalDevicePerformance* pPerformance);
2199
2200VkResult VKAPI vkGetPhysicalDeviceQueueCount(
2201 VkPhysicalDevice physicalDevice,
2202 uint32_t* pCount);
2203
2204VkResult VKAPI vkGetPhysicalDeviceQueueProperties(
2205 VkPhysicalDevice physicalDevice,
2206 uint32_t count,
2207 VkPhysicalDeviceQueueProperties* pQueueProperties);
2208
2209VkResult VKAPI vkGetPhysicalDeviceMemoryProperties(
2210 VkPhysicalDevice physicalDevice,
2211 VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2212
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002213// Extension discovery functions
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002214
Tony Barbour426b9052015-06-24 16:06:58 -06002215VkResult VKAPI vkGetGlobalExtensionCount(
2216 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002217
Tony Barbour426b9052015-06-24 16:06:58 -06002218VkResult VKAPI vkGetGlobalExtensionProperties(
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06002219 uint32_t extensionIndex,
Tony Barbour426b9052015-06-24 16:06:58 -06002220 VkExtensionProperties* pProperties);
2221
2222VkResult VKAPI vkGetPhysicalDeviceExtensionCount(
2223 VkPhysicalDevice physicalDevice,
2224 uint32_t* pCount);
2225
2226VkResult VKAPI vkGetPhysicalDeviceExtensionProperties(
2227 VkPhysicalDevice physicalDevice,
2228 uint32_t extensionIndex,
2229 VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002230
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002231// Queue functions
2232
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002233VkResult VKAPI vkGetDeviceQueue(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002234 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002235 uint32_t queueNodeIndex,
2236 uint32_t queueIndex,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002237 VkQueue* pQueue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002238
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002239VkResult VKAPI vkQueueSubmit(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002240 VkQueue queue,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002241 uint32_t cmdBufferCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002242 const VkCmdBuffer* pCmdBuffers,
2243 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002244
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002245VkResult VKAPI vkQueueWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002246 VkQueue queue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002247
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002248VkResult VKAPI vkDeviceWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002249 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002250
2251// Memory functions
2252
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002253VkResult VKAPI vkAllocMemory(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002254 VkDevice device,
2255 const VkMemoryAllocInfo* pAllocInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002256 VkDeviceMemory* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002257
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002258VkResult VKAPI vkFreeMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002259 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002260 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002261
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002262VkResult VKAPI vkMapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002263 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002264 VkDeviceMemory mem,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002265 VkDeviceSize offset,
2266 VkDeviceSize size,
Tony Barbour8205d902015-04-16 15:59:00 -06002267 VkMemoryMapFlags flags,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002268 void** ppData);
2269
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002270VkResult VKAPI vkUnmapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002271 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002272 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002273
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002274VkResult VKAPI vkFlushMappedMemoryRanges(
Mike Stroyan230e6252015-04-17 12:36:38 -06002275 VkDevice device,
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002276 uint32_t memRangeCount,
2277 const VkMappedMemoryRange* pMemRanges);
2278
2279VkResult VKAPI vkInvalidateMappedMemoryRanges(
2280 VkDevice device,
2281 uint32_t memRangeCount,
2282 const VkMappedMemoryRange* pMemRanges);
Tony Barbour859ceab2015-04-16 19:23:13 -06002283
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002284// Generic API object functions
2285
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002286VkResult VKAPI vkDestroyObject(
Mike Stroyan230e6252015-04-17 12:36:38 -06002287 VkDevice device,
2288 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002289 VkObject object);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002290
Tony Barbour3e3420a2015-04-16 19:09:28 -06002291// Memory management API functions
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002292
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002293VkResult VKAPI vkBindObjectMemory(
2294 VkDevice device,
Mike Stroyan230e6252015-04-17 12:36:38 -06002295 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002296 VkObject object,
Tony Barbour8205d902015-04-16 15:59:00 -06002297 VkDeviceMemory mem,
2298 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002299
Tony Barbour426b9052015-06-24 16:06:58 -06002300VkResult VKAPI vkGetObjectMemoryRequirements(
2301 VkDevice device,
2302 VkObjectType objType,
2303 VkObject object,
2304 VkMemoryRequirements* pMemoryRequirements);
2305
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002306VkResult VKAPI vkQueueBindSparseBufferMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002307 VkQueue queue,
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002308 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002309 VkDeviceSize rangeOffset,
2310 VkDeviceSize rangeSize,
2311 VkDeviceMemory mem,
2312 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002313
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002314VkResult VKAPI vkQueueBindSparseImageMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002315 VkQueue queue,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002316 VkImage image,
Jeremy Hayes47536532015-04-15 15:20:03 -06002317 const VkImageMemoryBindInfo* pBindInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002318 VkDeviceMemory mem,
2319 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002320
2321// Fence functions
2322
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002323VkResult VKAPI vkCreateFence(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002324 VkDevice device,
2325 const VkFenceCreateInfo* pCreateInfo,
2326 VkFence* pFence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002327
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002328VkResult VKAPI vkResetFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002329 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002330 uint32_t fenceCount,
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002331 const VkFence* pFences);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002332
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002333VkResult VKAPI vkGetFenceStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002334 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002335 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002336
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002337VkResult VKAPI vkWaitForFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002338 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002339 uint32_t fenceCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002340 const VkFence* pFences,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002341 bool32_t waitAll,
2342 uint64_t timeout); // timeout in nanoseconds
2343
2344// Queue semaphore functions
2345
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002346VkResult VKAPI vkCreateSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002347 VkDevice device,
2348 const VkSemaphoreCreateInfo* pCreateInfo,
2349 VkSemaphore* pSemaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002350
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002351VkResult VKAPI vkQueueSignalSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002352 VkQueue queue,
2353 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002354
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002355VkResult VKAPI vkQueueWaitSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002356 VkQueue queue,
2357 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002358
2359// Event functions
2360
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002361VkResult VKAPI vkCreateEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002362 VkDevice device,
2363 const VkEventCreateInfo* pCreateInfo,
2364 VkEvent* pEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002365
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002366VkResult VKAPI vkGetEventStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002367 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002368 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002369
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002370VkResult VKAPI vkSetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002371 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002372 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002373
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002374VkResult VKAPI vkResetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002375 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002376 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002377
2378// Query functions
2379
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002380VkResult VKAPI vkCreateQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002381 VkDevice device,
2382 const VkQueryPoolCreateInfo* pCreateInfo,
2383 VkQueryPool* pQueryPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002384
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002385VkResult VKAPI vkGetQueryPoolResults(
Mike Stroyan230e6252015-04-17 12:36:38 -06002386 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002387 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002388 uint32_t startQuery,
2389 uint32_t queryCount,
2390 size_t* pDataSize,
Tony Barbour8205d902015-04-16 15:59:00 -06002391 void* pData,
2392 VkQueryResultFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002393
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002394// Buffer functions
2395
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002396VkResult VKAPI vkCreateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002397 VkDevice device,
2398 const VkBufferCreateInfo* pCreateInfo,
2399 VkBuffer* pBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002400
2401// Buffer view functions
2402
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002403VkResult VKAPI vkCreateBufferView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002404 VkDevice device,
2405 const VkBufferViewCreateInfo* pCreateInfo,
2406 VkBufferView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002407
2408// Image functions
2409
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002410VkResult VKAPI vkCreateImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002411 VkDevice device,
2412 const VkImageCreateInfo* pCreateInfo,
2413 VkImage* pImage);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002414
Tony Barbour426b9052015-06-24 16:06:58 -06002415VkResult VKAPI vkGetImageSubresourceLayout(
Mike Stroyan230e6252015-04-17 12:36:38 -06002416 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002417 VkImage image,
2418 const VkImageSubresource* pSubresource,
Tony Barbour426b9052015-06-24 16:06:58 -06002419 VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002420
2421// Image view functions
2422
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002423VkResult VKAPI vkCreateImageView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002424 VkDevice device,
2425 const VkImageViewCreateInfo* pCreateInfo,
2426 VkImageView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002427
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002428VkResult VKAPI vkCreateColorAttachmentView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002429 VkDevice device,
2430 const VkColorAttachmentViewCreateInfo* pCreateInfo,
2431 VkColorAttachmentView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002432
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002433VkResult VKAPI vkCreateDepthStencilView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002434 VkDevice device,
2435 const VkDepthStencilViewCreateInfo* pCreateInfo,
2436 VkDepthStencilView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002437
2438// Shader functions
2439
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002440VkResult VKAPI vkCreateShaderModule(
2441 VkDevice device,
2442 const VkShaderModuleCreateInfo* pCreateInfo,
2443 VkShaderModule* pShaderModule);
2444
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002445VkResult VKAPI vkCreateShader(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002446 VkDevice device,
2447 const VkShaderCreateInfo* pCreateInfo,
2448 VkShader* pShader);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002449
2450// Pipeline functions
2451
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002452VkResult VKAPI vkCreateGraphicsPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002453 VkDevice device,
2454 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2455 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002456
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002457VkResult VKAPI vkCreateGraphicsPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002458 VkDevice device,
2459 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2460 VkPipeline basePipeline,
2461 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002462
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002463VkResult VKAPI vkCreateComputePipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002464 VkDevice device,
2465 const VkComputePipelineCreateInfo* pCreateInfo,
2466 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002467
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002468VkResult VKAPI vkStorePipeline(
Mike Stroyan230e6252015-04-17 12:36:38 -06002469 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002470 VkPipeline pipeline,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002471 size_t* pDataSize,
2472 void* pData);
2473
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002474VkResult VKAPI vkLoadPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002475 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002476 size_t dataSize,
2477 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002478 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002479
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002480VkResult VKAPI vkLoadPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002481 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002482 size_t dataSize,
2483 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002484 VkPipeline basePipeline,
2485 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002486
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002487// Pipeline layout functions
2488
2489VkResult VKAPI vkCreatePipelineLayout(
2490 VkDevice device,
2491 const VkPipelineLayoutCreateInfo* pCreateInfo,
2492 VkPipelineLayout* pPipelineLayout);
2493
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002494// Sampler functions
2495
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002496VkResult VKAPI vkCreateSampler(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002497 VkDevice device,
2498 const VkSamplerCreateInfo* pCreateInfo,
2499 VkSampler* pSampler);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002500
2501// Descriptor set functions
2502
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002503VkResult VKAPI vkCreateDescriptorSetLayout(
2504 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002505 const VkDescriptorSetLayoutCreateInfo* pCreateInfo,
2506 VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002507
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002508VkResult VKAPI vkCreateDescriptorPool(
2509 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002510 VkDescriptorPoolUsage poolUsage,
2511 uint32_t maxSets,
2512 const VkDescriptorPoolCreateInfo* pCreateInfo,
2513 VkDescriptorPool* pDescriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002514
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002515VkResult VKAPI vkResetDescriptorPool(
Mike Stroyan230e6252015-04-17 12:36:38 -06002516 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002517 VkDescriptorPool descriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002518
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002519VkResult VKAPI vkAllocDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002520 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002521 VkDescriptorPool descriptorPool,
2522 VkDescriptorSetUsage setUsage,
2523 uint32_t count,
2524 const VkDescriptorSetLayout* pSetLayouts,
2525 VkDescriptorSet* pDescriptorSets,
2526 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002527
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002528VkResult VKAPI vkUpdateDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002529 VkDevice device,
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002530 uint32_t writeCount,
2531 const VkWriteDescriptorSet* pDescriptorWrites,
2532 uint32_t copyCount,
2533 const VkCopyDescriptorSet* pDescriptorCopies);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002534
2535// State object functions
2536
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002537VkResult VKAPI vkCreateDynamicViewportState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002538 VkDevice device,
2539 const VkDynamicVpStateCreateInfo* pCreateInfo,
2540 VkDynamicVpState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002541
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002542VkResult VKAPI vkCreateDynamicRasterState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002543 VkDevice device,
2544 const VkDynamicRsStateCreateInfo* pCreateInfo,
2545 VkDynamicRsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002546
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002547VkResult VKAPI vkCreateDynamicColorBlendState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002548 VkDevice device,
2549 const VkDynamicCbStateCreateInfo* pCreateInfo,
2550 VkDynamicCbState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002551
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002552VkResult VKAPI vkCreateDynamicDepthStencilState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002553 VkDevice device,
2554 const VkDynamicDsStateCreateInfo* pCreateInfo,
2555 VkDynamicDsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002556
2557// Command buffer functions
2558
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002559VkResult VKAPI vkCreateCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002560 VkDevice device,
2561 const VkCmdBufferCreateInfo* pCreateInfo,
2562 VkCmdBuffer* pCmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002563
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002564VkResult VKAPI vkBeginCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002565 VkCmdBuffer cmdBuffer,
2566 const VkCmdBufferBeginInfo* pBeginInfo);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002567
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002568VkResult VKAPI vkEndCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002569 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002570
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002571VkResult VKAPI vkResetCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002572 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002573
2574// Command buffer building functions
2575
2576void VKAPI vkCmdBindPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002577 VkCmdBuffer cmdBuffer,
2578 VkPipelineBindPoint pipelineBindPoint,
2579 VkPipeline pipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002580
2581void VKAPI vkCmdBindDynamicStateObject(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002582 VkCmdBuffer cmdBuffer,
2583 VkStateBindPoint stateBindPoint,
2584 VkDynamicStateObject dynamicState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002585
2586void VKAPI vkCmdBindDescriptorSets(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002587 VkCmdBuffer cmdBuffer,
2588 VkPipelineBindPoint pipelineBindPoint,
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002589 VkPipelineLayout layout,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002590 uint32_t firstSet,
2591 uint32_t setCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002592 const VkDescriptorSet* pDescriptorSets,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002593 uint32_t dynamicOffsetCount,
2594 const uint32_t* pDynamicOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002595
2596void VKAPI vkCmdBindIndexBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002597 VkCmdBuffer cmdBuffer,
2598 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002599 VkDeviceSize offset,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002600 VkIndexType indexType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002601
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002602void VKAPI vkCmdBindVertexBuffers(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002603 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002604 uint32_t startBinding,
2605 uint32_t bindingCount,
2606 const VkBuffer* pBuffers,
Tony Barbour8205d902015-04-16 15:59:00 -06002607 const VkDeviceSize* pOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002608
2609void VKAPI vkCmdDraw(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002610 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002611 uint32_t firstVertex,
2612 uint32_t vertexCount,
2613 uint32_t firstInstance,
2614 uint32_t instanceCount);
2615
2616void VKAPI vkCmdDrawIndexed(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002617 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002618 uint32_t firstIndex,
2619 uint32_t indexCount,
2620 int32_t vertexOffset,
2621 uint32_t firstInstance,
2622 uint32_t instanceCount);
2623
2624void VKAPI vkCmdDrawIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002625 VkCmdBuffer cmdBuffer,
2626 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002627 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002628 uint32_t count,
2629 uint32_t stride);
2630
2631void VKAPI vkCmdDrawIndexedIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002632 VkCmdBuffer cmdBuffer,
2633 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002634 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002635 uint32_t count,
2636 uint32_t stride);
2637
2638void VKAPI vkCmdDispatch(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002639 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002640 uint32_t x,
2641 uint32_t y,
2642 uint32_t z);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002643
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002644void VKAPI vkCmdDispatchIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002645 VkCmdBuffer cmdBuffer,
2646 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002647 VkDeviceSize offset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002648
2649void VKAPI vkCmdCopyBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002650 VkCmdBuffer cmdBuffer,
2651 VkBuffer srcBuffer,
2652 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002653 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002654 const VkBufferCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002655
2656void VKAPI vkCmdCopyImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002657 VkCmdBuffer cmdBuffer,
2658 VkImage srcImage,
2659 VkImageLayout srcImageLayout,
2660 VkImage destImage,
2661 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002662 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002663 const VkImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002664
2665void VKAPI vkCmdBlitImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002666 VkCmdBuffer cmdBuffer,
2667 VkImage srcImage,
2668 VkImageLayout srcImageLayout,
2669 VkImage destImage,
2670 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002671 uint32_t regionCount,
Mark Lobodzinski20f68592015-05-22 14:43:25 -05002672 const VkImageBlit* pRegions,
2673 VkTexFilter filter);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002674
2675void VKAPI vkCmdCopyBufferToImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002676 VkCmdBuffer cmdBuffer,
2677 VkBuffer srcBuffer,
2678 VkImage destImage,
2679 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002680 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002681 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002682
2683void VKAPI vkCmdCopyImageToBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002684 VkCmdBuffer cmdBuffer,
2685 VkImage srcImage,
2686 VkImageLayout srcImageLayout,
2687 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002688 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002689 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002690
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002691void VKAPI vkCmdUpdateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002692 VkCmdBuffer cmdBuffer,
2693 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002694 VkDeviceSize destOffset,
2695 VkDeviceSize dataSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002696 const uint32_t* pData);
2697
2698void VKAPI vkCmdFillBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002699 VkCmdBuffer cmdBuffer,
2700 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002701 VkDeviceSize destOffset,
2702 VkDeviceSize fillSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002703 uint32_t data);
2704
2705void VKAPI vkCmdClearColorImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002706 VkCmdBuffer cmdBuffer,
2707 VkImage image,
2708 VkImageLayout imageLayout,
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002709 const VkClearColor* pColor,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002710 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002711 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002712
2713void VKAPI vkCmdClearDepthStencil(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002714 VkCmdBuffer cmdBuffer,
2715 VkImage image,
2716 VkImageLayout imageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002717 float depth,
2718 uint32_t stencil,
2719 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002720 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002721
2722void VKAPI vkCmdResolveImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002723 VkCmdBuffer cmdBuffer,
2724 VkImage srcImage,
2725 VkImageLayout srcImageLayout,
2726 VkImage destImage,
2727 VkImageLayout destImageLayout,
Tony Barbour11f74372015-04-13 15:02:52 -06002728 uint32_t regionCount,
2729 const VkImageResolve* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002730
2731void VKAPI vkCmdSetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002732 VkCmdBuffer cmdBuffer,
2733 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002734 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002735
2736void VKAPI vkCmdResetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002737 VkCmdBuffer cmdBuffer,
2738 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002739 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002740
2741void VKAPI vkCmdWaitEvents(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002742 VkCmdBuffer cmdBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002743 uint32_t eventCount,
2744 const VkEvent* pEvents,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002745 VkPipelineStageFlags sourceStageMask,
2746 VkPipelineStageFlags destStageMask,
Tony Barbour8205d902015-04-16 15:59:00 -06002747 uint32_t memBarrierCount,
2748 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002749
2750void VKAPI vkCmdPipelineBarrier(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002751 VkCmdBuffer cmdBuffer,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002752 VkPipelineStageFlags sourceStageMask,
2753 VkPipelineStageFlags destStageMask,
2754 bool32_t byRegion,
Tony Barbour8205d902015-04-16 15:59:00 -06002755 uint32_t memBarrierCount,
2756 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002757
2758void VKAPI vkCmdBeginQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002759 VkCmdBuffer cmdBuffer,
2760 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002761 uint32_t slot,
Tony Barbour8205d902015-04-16 15:59:00 -06002762 VkQueryControlFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002763
2764void VKAPI vkCmdEndQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002765 VkCmdBuffer cmdBuffer,
2766 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002767 uint32_t slot);
2768
2769void VKAPI vkCmdResetQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002770 VkCmdBuffer cmdBuffer,
2771 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002772 uint32_t startQuery,
2773 uint32_t queryCount);
2774
2775void VKAPI vkCmdWriteTimestamp(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002776 VkCmdBuffer cmdBuffer,
2777 VkTimestampType timestampType,
2778 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002779 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002780
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002781void VKAPI vkCmdCopyQueryPoolResults(
2782 VkCmdBuffer cmdBuffer,
2783 VkQueryPool queryPool,
2784 uint32_t startQuery,
2785 uint32_t queryCount,
2786 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002787 VkDeviceSize destOffset,
2788 VkDeviceSize destStride,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002789 VkQueryResultFlags flags);
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002790
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002791void VKAPI vkCmdInitAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002792 VkCmdBuffer cmdBuffer,
2793 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002794 uint32_t startCounter,
2795 uint32_t counterCount,
2796 const uint32_t* pData);
2797
2798void VKAPI vkCmdLoadAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002799 VkCmdBuffer cmdBuffer,
2800 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002801 uint32_t startCounter,
2802 uint32_t counterCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002803 VkBuffer srcBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002804 VkDeviceSize srcOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002805
2806void VKAPI vkCmdSaveAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002807 VkCmdBuffer cmdBuffer,
2808 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002809 uint32_t startCounter,
2810 uint32_t counterCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002811 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002812 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002813
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002814VkResult VKAPI vkCreateFramebuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002815 VkDevice device,
2816 const VkFramebufferCreateInfo* pCreateInfo,
2817 VkFramebuffer* pFramebuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002818
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002819VkResult VKAPI vkCreateRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002820 VkDevice device,
2821 const VkRenderPassCreateInfo* pCreateInfo,
2822 VkRenderPass* pRenderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002823
2824void VKAPI vkCmdBeginRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002825 VkCmdBuffer cmdBuffer,
2826 const VkRenderPassBegin* pRenderPassBegin);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002827
2828void VKAPI vkCmdEndRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002829 VkCmdBuffer cmdBuffer,
2830 VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002831
2832#endif // VK_PROTOTYPES
2833
2834#ifdef __cplusplus
2835} // extern "C"
2836#endif // __cplusplus
2837
2838#endif // __VULKAN_H__