blob: bb40adfebd825f68c7c9b590ed4b389eec1a279e [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
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -060036#define VK_API_VERSION VK_MAKE_VERSION(0, 105, 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)
82VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkShader, VkNonDispatchable)
83VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipeline, VkNonDispatchable)
84VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipelineLayout, VkNonDispatchable)
85VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSampler, VkNonDispatchable)
86VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSet, VkNonDispatchable)
87VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSetLayout, VkNonDispatchable)
88VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorPool, VkNonDispatchable)
89VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicStateObject, VkNonDispatchable)
90VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicVpState, VkDynamicStateObject)
91VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicRsState, VkDynamicStateObject)
92VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicCbState, VkDynamicStateObject)
93VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicDsState, VkDynamicStateObject)
94VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFence, VkNonDispatchable)
95VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSemaphore, VkNonDispatchable)
96VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkEvent, VkNonDispatchable)
97VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkQueryPool, VkNonDispatchable)
98VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFramebuffer, VkNonDispatchable)
99VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkRenderPass, VkNonDispatchable)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600100
Tony Barbour8205d902015-04-16 15:59:00 -0600101#define VK_MAX_PHYSICAL_DEVICE_NAME 256
Mike Stroyan230e6252015-04-17 12:36:38 -0600102#define VK_MAX_EXTENSION_NAME 256
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600103
104#define VK_LOD_CLAMP_NONE MAX_FLOAT
Courtney Goeltzenleuchterdac96cf2015-06-04 11:35:43 -0600105#define VK_LAST_MIP_LEVEL UINT32_MAX
106#define VK_LAST_ARRAY_SLICE UINT32_MAX
107
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600108
Tony Barbour8205d902015-04-16 15:59:00 -0600109#define VK_WHOLE_SIZE UINT64_MAX
110
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600111#define VK_TRUE 1
112#define VK_FALSE 0
113
114#define VK_NULL_HANDLE 0
115
116// This macro defines INT_MAX in enumerations to force compilers to use 32 bits
117// to represent them. This may or may not be necessary on some compilers. The
118// option to compile it out may allow compilers that warn about missing enumerants
119// in switch statements to be silenced.
Tony Barbour8205d902015-04-16 15:59:00 -0600120// Using this macro is not needed for flag bit enums because those aren't used
121// as storage type anywhere.
122#define VK_MAX_ENUM(Prefix) VK_##Prefix##_MAX_ENUM = 0x7FFFFFFF
123
124// This macro defines the BEGIN_RANGE, END_RANGE, NUM, and MAX_ENUM constants for
125// the enumerations.
126#define VK_ENUM_RANGE(Prefix, First, Last) \
127 VK_##Prefix##_BEGIN_RANGE = VK_##Prefix##_##First, \
128 VK_##Prefix##_END_RANGE = VK_##Prefix##_##Last, \
129 VK_NUM_##Prefix = (VK_##Prefix##_END_RANGE - VK_##Prefix##_BEGIN_RANGE + 1), \
130 VK_MAX_ENUM(Prefix)
131
132// This is a helper macro to define the value of flag bit enum values.
133#define VK_BIT(bit) (1 << (bit))
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600134
135// ------------------------------------------------------------------------------------------------
136// Enumerations
137
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600138typedef enum VkImageLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600139{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600140 VK_IMAGE_LAYOUT_UNDEFINED = 0x00000000, // Implicit layout an image is when its contents are undefined due to various reasons (e.g. right after creation)
141 VK_IMAGE_LAYOUT_GENERAL = 0x00000001, // General layout when image can be used for any kind of access
142 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL = 0x00000002, // Optimal layout when image is only used for color attachment read/write
143 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL = 0x00000003, // Optimal layout when image is only used for depth/stencil attachment read/write
144 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL = 0x00000004, // Optimal layout when image is used for read only depth/stencil attachment and shader access
145 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL = 0x00000005, // Optimal layout when image is used for read only shader access
146 VK_IMAGE_LAYOUT_CLEAR_OPTIMAL = 0x00000006, // Optimal layout when image is used only for clear operations
147 VK_IMAGE_LAYOUT_TRANSFER_SOURCE_OPTIMAL = 0x00000007, // Optimal layout when image is used only as source of transfer operations
148 VK_IMAGE_LAYOUT_TRANSFER_DESTINATION_OPTIMAL = 0x00000008, // Optimal layout when image is used only as destination of transfer operations
Tony Barbour3e3420a2015-04-16 19:09:28 -0600149
Tony Barbour8205d902015-04-16 15:59:00 -0600150 VK_ENUM_RANGE(IMAGE_LAYOUT, UNDEFINED, TRANSFER_DESTINATION_OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600151} VkImageLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600152
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600153typedef enum VkPipeEvent_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600154{
Tony Barbour8205d902015-04-16 15:59:00 -0600155 VK_PIPE_EVENT_TOP_OF_PIPE = 0x00000001, // Set event before the device starts processing subsequent command
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600156 VK_PIPE_EVENT_VERTEX_PROCESSING_COMPLETE = 0x00000002, // Set event when all pending vertex processing is complete
157 VK_PIPE_EVENT_LOCAL_FRAGMENT_PROCESSING_COMPLETE = 0x00000003, // Set event when all pending fragment shader executions are complete, within each fragment location
158 VK_PIPE_EVENT_FRAGMENT_PROCESSING_COMPLETE = 0x00000004, // Set event when all pending fragment shader executions are complete
159 VK_PIPE_EVENT_GRAPHICS_PIPELINE_COMPLETE = 0x00000005, // Set event when all pending graphics operations are complete
160 VK_PIPE_EVENT_COMPUTE_PIPELINE_COMPLETE = 0x00000006, // Set event when all pending compute operations are complete
161 VK_PIPE_EVENT_TRANSFER_COMPLETE = 0x00000007, // Set event when all pending transfer operations are complete
Tony Barbour8205d902015-04-16 15:59:00 -0600162 VK_PIPE_EVENT_COMMANDS_COMPLETE = 0x00000008, // Set event when all pending work is complete
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600163
Tony Barbour8205d902015-04-16 15:59:00 -0600164 VK_ENUM_RANGE(PIPE_EVENT, TOP_OF_PIPE, COMMANDS_COMPLETE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600165} VkPipeEvent;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600166
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600167typedef enum VkWaitEvent_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600168{
Tony Barbour8205d902015-04-16 15:59:00 -0600169 VK_WAIT_EVENT_TOP_OF_PIPE = 0x00000001, // Wait event before the device starts processing subsequent commands
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600170 VK_WAIT_EVENT_BEFORE_RASTERIZATION = 0x00000002, // Wait event before rasterizing subsequent primitives
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600171
Tony Barbour8205d902015-04-16 15:59:00 -0600172 VK_ENUM_RANGE(WAIT_EVENT, TOP_OF_PIPE, BEFORE_RASTERIZATION)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600173} VkWaitEvent;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600174
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600175typedef enum VkAttachmentLoadOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600176{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600177 VK_ATTACHMENT_LOAD_OP_LOAD = 0x00000000,
178 VK_ATTACHMENT_LOAD_OP_CLEAR = 0x00000001,
179 VK_ATTACHMENT_LOAD_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600180
Tony Barbour8205d902015-04-16 15:59:00 -0600181 VK_ENUM_RANGE(ATTACHMENT_LOAD_OP, LOAD, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600182} VkAttachmentLoadOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600183
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600184typedef enum VkAttachmentStoreOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600185{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600186 VK_ATTACHMENT_STORE_OP_STORE = 0x00000000,
187 VK_ATTACHMENT_STORE_OP_RESOLVE_MSAA = 0x00000001,
188 VK_ATTACHMENT_STORE_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600189
Tony Barbour8205d902015-04-16 15:59:00 -0600190 VK_ENUM_RANGE(ATTACHMENT_STORE_OP, STORE, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600191} VkAttachmentStoreOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600192
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600193typedef enum VkImageType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600194{
Tony Barbour8205d902015-04-16 15:59:00 -0600195 VK_IMAGE_TYPE_1D = 0x00000000,
196 VK_IMAGE_TYPE_2D = 0x00000001,
197 VK_IMAGE_TYPE_3D = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600198
Tony Barbour8205d902015-04-16 15:59:00 -0600199 VK_ENUM_RANGE(IMAGE_TYPE, 1D, 3D)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600200} VkImageType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600201
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600202typedef enum VkImageTiling_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600203{
Tony Barbour8205d902015-04-16 15:59:00 -0600204 VK_IMAGE_TILING_LINEAR = 0x00000000,
205 VK_IMAGE_TILING_OPTIMAL = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600206
Tony Barbour8205d902015-04-16 15:59:00 -0600207 VK_ENUM_RANGE(IMAGE_TILING, LINEAR, OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600208} VkImageTiling;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600209
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600210typedef enum VkImageViewType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600211{
Tony Barbour8205d902015-04-16 15:59:00 -0600212 VK_IMAGE_VIEW_TYPE_1D = 0x00000000,
213 VK_IMAGE_VIEW_TYPE_2D = 0x00000001,
214 VK_IMAGE_VIEW_TYPE_3D = 0x00000002,
215 VK_IMAGE_VIEW_TYPE_CUBE = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600216
Tony Barbour8205d902015-04-16 15:59:00 -0600217 VK_ENUM_RANGE(IMAGE_VIEW_TYPE, 1D, CUBE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600218} VkImageViewType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600219
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600220typedef enum VkImageAspect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600221{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600222 VK_IMAGE_ASPECT_COLOR = 0x00000000,
223 VK_IMAGE_ASPECT_DEPTH = 0x00000001,
224 VK_IMAGE_ASPECT_STENCIL = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600225
Tony Barbour8205d902015-04-16 15:59:00 -0600226 VK_ENUM_RANGE(IMAGE_ASPECT, COLOR, STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600227} VkImageAspect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600228
Tony Barbour8205d902015-04-16 15:59:00 -0600229typedef enum VkBufferViewType_
230{
231 VK_BUFFER_VIEW_TYPE_RAW = 0x00000000, // Raw buffer without special structure (UBO, SSBO)
232 VK_BUFFER_VIEW_TYPE_FORMATTED = 0x00000001, // Buffer with format (TBO, IBO)
233
234 VK_ENUM_RANGE(BUFFER_VIEW_TYPE, RAW, FORMATTED)
235} VkBufferViewType;
236
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600237typedef enum VkChannelSwizzle_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600238{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600239 VK_CHANNEL_SWIZZLE_ZERO = 0x00000000,
240 VK_CHANNEL_SWIZZLE_ONE = 0x00000001,
241 VK_CHANNEL_SWIZZLE_R = 0x00000002,
242 VK_CHANNEL_SWIZZLE_G = 0x00000003,
243 VK_CHANNEL_SWIZZLE_B = 0x00000004,
244 VK_CHANNEL_SWIZZLE_A = 0x00000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600245
Tony Barbour8205d902015-04-16 15:59:00 -0600246 VK_ENUM_RANGE(CHANNEL_SWIZZLE, ZERO, A)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600247} VkChannelSwizzle;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600248
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600249typedef enum VkDescriptorType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600250{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600251 VK_DESCRIPTOR_TYPE_SAMPLER = 0x00000000,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600252 VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER = 0x00000001,
253 VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE = 0x00000002,
254 VK_DESCRIPTOR_TYPE_STORAGE_IMAGE = 0x00000003,
255 VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER = 0x00000004,
256 VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER = 0x00000005,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600257 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER = 0x00000006,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600258 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER = 0x00000007,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600259 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC = 0x00000008,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600260 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC = 0x00000009,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600261
Tony Barbour8205d902015-04-16 15:59:00 -0600262 VK_ENUM_RANGE(DESCRIPTOR_TYPE, SAMPLER, STORAGE_BUFFER_DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600263} VkDescriptorType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600264
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600265typedef enum VkDescriptorPoolUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600266{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600267 VK_DESCRIPTOR_POOL_USAGE_ONE_SHOT = 0x00000000,
268 VK_DESCRIPTOR_POOL_USAGE_DYNAMIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600269
Tony Barbour8205d902015-04-16 15:59:00 -0600270 VK_ENUM_RANGE(DESCRIPTOR_POOL_USAGE, ONE_SHOT, DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600271} VkDescriptorPoolUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600272
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600273typedef enum VkDescriptorSetUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600274{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600275 VK_DESCRIPTOR_SET_USAGE_ONE_SHOT = 0x00000000,
276 VK_DESCRIPTOR_SET_USAGE_STATIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600277
Tony Barbour8205d902015-04-16 15:59:00 -0600278 VK_ENUM_RANGE(DESCRIPTOR_SET_USAGE, ONE_SHOT, STATIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600279} VkDescriptorSetUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600280
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600281typedef enum VkQueryType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600282{
Tony Barbour8205d902015-04-16 15:59:00 -0600283 VK_QUERY_TYPE_OCCLUSION = 0x00000000,
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -0600284 VK_QUERY_TYPE_PIPELINE_STATISTICS = 0x00000001, // Optional
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600285
Tony Barbour8205d902015-04-16 15:59:00 -0600286 VK_ENUM_RANGE(QUERY_TYPE, OCCLUSION, PIPELINE_STATISTICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600287} VkQueryType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600288
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600289typedef enum VkTimestampType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600290{
Tony Barbour8205d902015-04-16 15:59:00 -0600291 VK_TIMESTAMP_TYPE_TOP = 0x00000000,
292 VK_TIMESTAMP_TYPE_BOTTOM = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600293
Tony Barbour8205d902015-04-16 15:59:00 -0600294 VK_ENUM_RANGE(TIMESTAMP_TYPE, TOP, BOTTOM)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600295} VkTimestampType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600296
Tony Barbour8205d902015-04-16 15:59:00 -0600297typedef enum VkBorderColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600298{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600299 VK_BORDER_COLOR_OPAQUE_WHITE = 0x00000000,
300 VK_BORDER_COLOR_TRANSPARENT_BLACK = 0x00000001,
301 VK_BORDER_COLOR_OPAQUE_BLACK = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600302
Tony Barbour8205d902015-04-16 15:59:00 -0600303 VK_ENUM_RANGE(BORDER_COLOR, OPAQUE_WHITE, OPAQUE_BLACK)
304} VkBorderColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600305
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600306typedef enum VkPipelineBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600307{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600308 VK_PIPELINE_BIND_POINT_COMPUTE = 0x00000000,
309 VK_PIPELINE_BIND_POINT_GRAPHICS = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600310
Tony Barbour8205d902015-04-16 15:59:00 -0600311 VK_ENUM_RANGE(PIPELINE_BIND_POINT, COMPUTE, GRAPHICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600312} VkPipelineBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600313
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600314typedef enum VkStateBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600315{
Tony Barbour8205d902015-04-16 15:59:00 -0600316 VK_STATE_BIND_POINT_VIEWPORT = 0x00000000,
317 VK_STATE_BIND_POINT_RASTER = 0x00000001,
318 VK_STATE_BIND_POINT_COLOR_BLEND = 0x00000002,
319 VK_STATE_BIND_POINT_DEPTH_STENCIL = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600320
Tony Barbour8205d902015-04-16 15:59:00 -0600321 VK_ENUM_RANGE(STATE_BIND_POINT, VIEWPORT, DEPTH_STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600322} VkStateBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600323
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600324typedef enum VkPrimitiveTopology_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600325{
Tony Barbour8205d902015-04-16 15:59:00 -0600326 VK_PRIMITIVE_TOPOLOGY_POINT_LIST = 0x00000000,
327 VK_PRIMITIVE_TOPOLOGY_LINE_LIST = 0x00000001,
328 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP = 0x00000002,
329 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST = 0x00000003,
330 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP = 0x00000004,
331 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN = 0x00000005,
332 VK_PRIMITIVE_TOPOLOGY_LINE_LIST_ADJ = 0x00000006,
333 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_ADJ = 0x00000007,
334 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_ADJ = 0x00000008,
335 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_ADJ = 0x00000009,
336 VK_PRIMITIVE_TOPOLOGY_PATCH = 0x0000000a,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600337
Tony Barbour8205d902015-04-16 15:59:00 -0600338 VK_ENUM_RANGE(PRIMITIVE_TOPOLOGY, POINT_LIST, PATCH)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600339} VkPrimitiveTopology;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600340
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600341typedef enum VkIndexType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600342{
Tony Barbour8205d902015-04-16 15:59:00 -0600343 VK_INDEX_TYPE_UINT8 = 0x00000000,
344 VK_INDEX_TYPE_UINT16 = 0x00000001,
345 VK_INDEX_TYPE_UINT32 = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600346
Tony Barbour8205d902015-04-16 15:59:00 -0600347 VK_ENUM_RANGE(INDEX_TYPE, UINT8, UINT32)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600348} VkIndexType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600349
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600350typedef enum VkTexFilter_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600351{
Tony Barbour8205d902015-04-16 15:59:00 -0600352 VK_TEX_FILTER_NEAREST = 0x00000000,
353 VK_TEX_FILTER_LINEAR = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600354
Tony Barbour8205d902015-04-16 15:59:00 -0600355 VK_ENUM_RANGE(TEX_FILTER, NEAREST, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600356} VkTexFilter;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600357
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600358typedef enum VkTexMipmapMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600359{
Tony Barbour8205d902015-04-16 15:59:00 -0600360 VK_TEX_MIPMAP_MODE_BASE = 0x00000000, // Always choose base level
361 VK_TEX_MIPMAP_MODE_NEAREST = 0x00000001, // Choose nearest mip level
362 VK_TEX_MIPMAP_MODE_LINEAR = 0x00000002, // Linear filter between mip levels
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600363
Tony Barbour8205d902015-04-16 15:59:00 -0600364 VK_ENUM_RANGE(TEX_MIPMAP_MODE, BASE, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600365} VkTexMipmapMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600366
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600367typedef enum VkTexAddress_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600368{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600369 VK_TEX_ADDRESS_WRAP = 0x00000000,
370 VK_TEX_ADDRESS_MIRROR = 0x00000001,
371 VK_TEX_ADDRESS_CLAMP = 0x00000002,
372 VK_TEX_ADDRESS_MIRROR_ONCE = 0x00000003,
373 VK_TEX_ADDRESS_CLAMP_BORDER = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600374
Tony Barbour8205d902015-04-16 15:59:00 -0600375 VK_ENUM_RANGE(TEX_ADDRESS, WRAP, CLAMP_BORDER)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600376} VkTexAddress;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600377
Tony Barbour8205d902015-04-16 15:59:00 -0600378typedef enum VkCompareOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600379{
Tony Barbour8205d902015-04-16 15:59:00 -0600380 VK_COMPARE_OP_NEVER = 0x00000000,
381 VK_COMPARE_OP_LESS = 0x00000001,
382 VK_COMPARE_OP_EQUAL = 0x00000002,
383 VK_COMPARE_OP_LESS_EQUAL = 0x00000003,
384 VK_COMPARE_OP_GREATER = 0x00000004,
385 VK_COMPARE_OP_NOT_EQUAL = 0x00000005,
386 VK_COMPARE_OP_GREATER_EQUAL = 0x00000006,
387 VK_COMPARE_OP_ALWAYS = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600388
Tony Barbour8205d902015-04-16 15:59:00 -0600389 VK_ENUM_RANGE(COMPARE_OP, NEVER, ALWAYS)
390} VkCompareOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600391
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600392typedef enum VkFillMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600393{
Tony Barbour8205d902015-04-16 15:59:00 -0600394 VK_FILL_MODE_POINTS = 0x00000000,
395 VK_FILL_MODE_WIREFRAME = 0x00000001,
396 VK_FILL_MODE_SOLID = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600397
Tony Barbour8205d902015-04-16 15:59:00 -0600398 VK_ENUM_RANGE(FILL_MODE, POINTS, SOLID)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600399} VkFillMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600400
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600401typedef enum VkCullMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600402{
Tony Barbour8205d902015-04-16 15:59:00 -0600403 VK_CULL_MODE_NONE = 0x00000000,
404 VK_CULL_MODE_FRONT = 0x00000001,
405 VK_CULL_MODE_BACK = 0x00000002,
406 VK_CULL_MODE_FRONT_AND_BACK = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600407
Tony Barbour8205d902015-04-16 15:59:00 -0600408 VK_ENUM_RANGE(CULL_MODE, NONE, FRONT_AND_BACK)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600409} VkCullMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600410
Tony Barbour8205d902015-04-16 15:59:00 -0600411typedef enum VkFrontFace_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600412{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600413 VK_FRONT_FACE_CCW = 0x00000000,
414 VK_FRONT_FACE_CW = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600415
Tony Barbour8205d902015-04-16 15:59:00 -0600416 VK_ENUM_RANGE(FRONT_FACE, CCW, CW)
417} VkFrontFace;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600418
Tony Barbour8205d902015-04-16 15:59:00 -0600419typedef enum VkProvokingVertex_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600420{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600421 VK_PROVOKING_VERTEX_FIRST = 0x00000000,
422 VK_PROVOKING_VERTEX_LAST = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600423
Tony Barbour8205d902015-04-16 15:59:00 -0600424 VK_ENUM_RANGE(PROVOKING_VERTEX, FIRST, LAST)
425} VkProvokingVertex;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600426
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600427typedef enum VkCoordinateOrigin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600428{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600429 VK_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000,
430 VK_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600431
Tony Barbour8205d902015-04-16 15:59:00 -0600432 VK_ENUM_RANGE(COORDINATE_ORIGIN, UPPER_LEFT, LOWER_LEFT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600433} VkCoordinateOrigin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600434
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600435typedef enum VkDepthMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600436{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600437 VK_DEPTH_MODE_ZERO_TO_ONE = 0x00000000,
438 VK_DEPTH_MODE_NEGATIVE_ONE_TO_ONE = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600439
Tony Barbour8205d902015-04-16 15:59:00 -0600440 VK_ENUM_RANGE(DEPTH_MODE, ZERO_TO_ONE, NEGATIVE_ONE_TO_ONE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600441} VkDepthMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600442
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600443typedef enum VkBlend_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600444{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600445 VK_BLEND_ZERO = 0x00000000,
446 VK_BLEND_ONE = 0x00000001,
447 VK_BLEND_SRC_COLOR = 0x00000002,
448 VK_BLEND_ONE_MINUS_SRC_COLOR = 0x00000003,
449 VK_BLEND_DEST_COLOR = 0x00000004,
450 VK_BLEND_ONE_MINUS_DEST_COLOR = 0x00000005,
451 VK_BLEND_SRC_ALPHA = 0x00000006,
452 VK_BLEND_ONE_MINUS_SRC_ALPHA = 0x00000007,
453 VK_BLEND_DEST_ALPHA = 0x00000008,
454 VK_BLEND_ONE_MINUS_DEST_ALPHA = 0x00000009,
455 VK_BLEND_CONSTANT_COLOR = 0x0000000a,
456 VK_BLEND_ONE_MINUS_CONSTANT_COLOR = 0x0000000b,
457 VK_BLEND_CONSTANT_ALPHA = 0x0000000c,
458 VK_BLEND_ONE_MINUS_CONSTANT_ALPHA = 0x0000000d,
459 VK_BLEND_SRC_ALPHA_SATURATE = 0x0000000e,
460 VK_BLEND_SRC1_COLOR = 0x0000000f,
461 VK_BLEND_ONE_MINUS_SRC1_COLOR = 0x00000010,
462 VK_BLEND_SRC1_ALPHA = 0x00000011,
463 VK_BLEND_ONE_MINUS_SRC1_ALPHA = 0x00000012,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600464
Tony Barbour8205d902015-04-16 15:59:00 -0600465 VK_ENUM_RANGE(BLEND, ZERO, ONE_MINUS_SRC1_ALPHA)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600466} VkBlend;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600467
Tony Barbour8205d902015-04-16 15:59:00 -0600468typedef enum VkBlendOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600469{
Tony Barbour8205d902015-04-16 15:59:00 -0600470 VK_BLEND_OP_ADD = 0x00000000,
471 VK_BLEND_OP_SUBTRACT = 0x00000001,
472 VK_BLEND_OP_REVERSE_SUBTRACT = 0x00000002,
473 VK_BLEND_OP_MIN = 0x00000003,
474 VK_BLEND_OP_MAX = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600475
Tony Barbour8205d902015-04-16 15:59:00 -0600476 VK_ENUM_RANGE(BLEND_OP, ADD, MAX)
477} VkBlendOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600478
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600479typedef enum VkStencilOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600480{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600481 VK_STENCIL_OP_KEEP = 0x00000000,
482 VK_STENCIL_OP_ZERO = 0x00000001,
483 VK_STENCIL_OP_REPLACE = 0x00000002,
484 VK_STENCIL_OP_INC_CLAMP = 0x00000003,
485 VK_STENCIL_OP_DEC_CLAMP = 0x00000004,
486 VK_STENCIL_OP_INVERT = 0x00000005,
487 VK_STENCIL_OP_INC_WRAP = 0x00000006,
488 VK_STENCIL_OP_DEC_WRAP = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600489
Tony Barbour8205d902015-04-16 15:59:00 -0600490 VK_ENUM_RANGE(STENCIL_OP, KEEP, DEC_WRAP)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600491} VkStencilOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600492
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600493typedef enum VkLogicOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600494{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600495 VK_LOGIC_OP_COPY = 0x00000000,
496 VK_LOGIC_OP_CLEAR = 0x00000001,
497 VK_LOGIC_OP_AND = 0x00000002,
498 VK_LOGIC_OP_AND_REVERSE = 0x00000003,
499 VK_LOGIC_OP_AND_INVERTED = 0x00000004,
500 VK_LOGIC_OP_NOOP = 0x00000005,
501 VK_LOGIC_OP_XOR = 0x00000006,
502 VK_LOGIC_OP_OR = 0x00000007,
503 VK_LOGIC_OP_NOR = 0x00000008,
504 VK_LOGIC_OP_EQUIV = 0x00000009,
505 VK_LOGIC_OP_INVERT = 0x0000000a,
506 VK_LOGIC_OP_OR_REVERSE = 0x0000000b,
507 VK_LOGIC_OP_COPY_INVERTED = 0x0000000c,
508 VK_LOGIC_OP_OR_INVERTED = 0x0000000d,
509 VK_LOGIC_OP_NAND = 0x0000000e,
510 VK_LOGIC_OP_SET = 0x0000000f,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600511
Tony Barbour8205d902015-04-16 15:59:00 -0600512 VK_ENUM_RANGE(LOGIC_OP, COPY, SET)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600513} VkLogicOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600514
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600515typedef enum VkSystemAllocType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600516{
Tony Barbour8205d902015-04-16 15:59:00 -0600517 VK_SYSTEM_ALLOC_TYPE_API_OBJECT = 0x00000000,
518 VK_SYSTEM_ALLOC_TYPE_INTERNAL = 0x00000001,
519 VK_SYSTEM_ALLOC_TYPE_INTERNAL_TEMP = 0x00000002,
520 VK_SYSTEM_ALLOC_TYPE_INTERNAL_SHADER = 0x00000003,
521 VK_SYSTEM_ALLOC_TYPE_DEBUG = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600522
Tony Barbour8205d902015-04-16 15:59:00 -0600523 VK_ENUM_RANGE(SYSTEM_ALLOC_TYPE, API_OBJECT, DEBUG)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600524} VkSystemAllocType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600525
Tony Barbour8205d902015-04-16 15:59:00 -0600526typedef enum VkPhysicalDeviceType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600527{
Tony Barbour8205d902015-04-16 15:59:00 -0600528 VK_PHYSICAL_DEVICE_TYPE_OTHER = 0x00000000,
529 VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU = 0x00000001,
530 VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU = 0x00000002,
531 VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU = 0x00000003,
532 VK_PHYSICAL_DEVICE_TYPE_CPU = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600533
Tony Barbour8205d902015-04-16 15:59:00 -0600534 VK_ENUM_RANGE(PHYSICAL_DEVICE_TYPE, OTHER, CPU)
535} VkPhysicalDeviceType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600536
Tony Barbour8205d902015-04-16 15:59:00 -0600537typedef enum VkPhysicalDeviceInfoType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600538{
Tony Barbour8205d902015-04-16 15:59:00 -0600539 // Info type for vkGetPhysicalDeviceInfo()
540 VK_PHYSICAL_DEVICE_INFO_TYPE_PROPERTIES = 0x00000000,
541 VK_PHYSICAL_DEVICE_INFO_TYPE_PERFORMANCE = 0x00000001,
542 VK_PHYSICAL_DEVICE_INFO_TYPE_QUEUE_PROPERTIES = 0x00000002,
543 VK_PHYSICAL_DEVICE_INFO_TYPE_MEMORY_PROPERTIES = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600544
Tony Barbour8205d902015-04-16 15:59:00 -0600545 VK_ENUM_RANGE(PHYSICAL_DEVICE_INFO_TYPE, PROPERTIES, MEMORY_PROPERTIES)
546} VkPhysicalDeviceInfoType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600547
Jon Ashburneb2728b2015-04-10 14:33:07 -0600548typedef enum VkExtensionInfoType_
549{
550 // Info type for vkGetGlobalExtensionInfo() and vkGetPhysicalDeviceExtensionInfo()
551 VK_EXTENSION_INFO_TYPE_COUNT = 0x00000000,
552 VK_EXTENSION_INFO_TYPE_PROPERTIES = 0x00000001,
553
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -0600554 VK_ENUM_RANGE(EXTENSION_INFO_TYPE, COUNT, PROPERTIES)
Jon Ashburneb2728b2015-04-10 14:33:07 -0600555} VkExtensionInfoType;
556
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600557typedef enum VkFormatInfoType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600558{
559 // Info type for vkGetFormatInfo()
Tony Barbour8205d902015-04-16 15:59:00 -0600560 VK_FORMAT_INFO_TYPE_PROPERTIES = 0x00000000,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600561
Tony Barbour8205d902015-04-16 15:59:00 -0600562 VK_ENUM_RANGE(FORMAT_INFO_TYPE, PROPERTIES, PROPERTIES)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600563} VkFormatInfoType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600564
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600565typedef enum VkSubresourceInfoType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600566{
567 // Info type for vkGetImageSubresourceInfo()
Tony Barbour8205d902015-04-16 15:59:00 -0600568 VK_SUBRESOURCE_INFO_TYPE_LAYOUT = 0x00000000,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600569
Tony Barbour8205d902015-04-16 15:59:00 -0600570 VK_ENUM_RANGE(SUBRESOURCE_INFO_TYPE, LAYOUT, LAYOUT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600571} VkSubresourceInfoType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600572
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600573typedef enum VkObjectInfoType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600574{
575 // Info type for vkGetObjectInfo()
Mark Lobodzinski23182612015-05-29 09:32:35 -0500576 VK_OBJECT_INFO_TYPE_MEMORY_REQUIREMENTS = 0x00000000,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600577
Mark Lobodzinski23182612015-05-29 09:32:35 -0500578 VK_ENUM_RANGE(OBJECT_INFO_TYPE, MEMORY_REQUIREMENTS, MEMORY_REQUIREMENTS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600579} VkObjectInfoType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600580
Tony Barbour8205d902015-04-16 15:59:00 -0600581typedef enum VkVertexInputStepRate_
582{
583 VK_VERTEX_INPUT_STEP_RATE_VERTEX = 0x0,
584 VK_VERTEX_INPUT_STEP_RATE_INSTANCE = 0x1,
585 VK_VERTEX_INPUT_STEP_RATE_DRAW = 0x2, //Optional
586
587 VK_ENUM_RANGE(VERTEX_INPUT_STEP_RATE, VERTEX, DRAW)
588} VkVertexInputStepRate;
589
Tony Barbour8205d902015-04-16 15:59:00 -0600590// Vulkan format definitions
591typedef enum VkFormat_
592{
593 VK_FORMAT_UNDEFINED = 0x00000000,
594 VK_FORMAT_R4G4_UNORM = 0x00000001,
595 VK_FORMAT_R4G4_USCALED = 0x00000002,
596 VK_FORMAT_R4G4B4A4_UNORM = 0x00000003,
597 VK_FORMAT_R4G4B4A4_USCALED = 0x00000004,
598 VK_FORMAT_R5G6B5_UNORM = 0x00000005,
599 VK_FORMAT_R5G6B5_USCALED = 0x00000006,
600 VK_FORMAT_R5G5B5A1_UNORM = 0x00000007,
601 VK_FORMAT_R5G5B5A1_USCALED = 0x00000008,
602 VK_FORMAT_R8_UNORM = 0x00000009,
603 VK_FORMAT_R8_SNORM = 0x0000000A,
604 VK_FORMAT_R8_USCALED = 0x0000000B,
605 VK_FORMAT_R8_SSCALED = 0x0000000C,
606 VK_FORMAT_R8_UINT = 0x0000000D,
607 VK_FORMAT_R8_SINT = 0x0000000E,
608 VK_FORMAT_R8_SRGB = 0x0000000F,
609 VK_FORMAT_R8G8_UNORM = 0x00000010,
610 VK_FORMAT_R8G8_SNORM = 0x00000011,
611 VK_FORMAT_R8G8_USCALED = 0x00000012,
612 VK_FORMAT_R8G8_SSCALED = 0x00000013,
613 VK_FORMAT_R8G8_UINT = 0x00000014,
614 VK_FORMAT_R8G8_SINT = 0x00000015,
615 VK_FORMAT_R8G8_SRGB = 0x00000016,
616 VK_FORMAT_R8G8B8_UNORM = 0x00000017,
617 VK_FORMAT_R8G8B8_SNORM = 0x00000018,
618 VK_FORMAT_R8G8B8_USCALED = 0x00000019,
619 VK_FORMAT_R8G8B8_SSCALED = 0x0000001A,
620 VK_FORMAT_R8G8B8_UINT = 0x0000001B,
621 VK_FORMAT_R8G8B8_SINT = 0x0000001C,
622 VK_FORMAT_R8G8B8_SRGB = 0x0000001D,
623 VK_FORMAT_R8G8B8A8_UNORM = 0x0000001E,
624 VK_FORMAT_R8G8B8A8_SNORM = 0x0000001F,
625 VK_FORMAT_R8G8B8A8_USCALED = 0x00000020,
626 VK_FORMAT_R8G8B8A8_SSCALED = 0x00000021,
627 VK_FORMAT_R8G8B8A8_UINT = 0x00000022,
628 VK_FORMAT_R8G8B8A8_SINT = 0x00000023,
629 VK_FORMAT_R8G8B8A8_SRGB = 0x00000024,
630 VK_FORMAT_R10G10B10A2_UNORM = 0x00000025,
631 VK_FORMAT_R10G10B10A2_SNORM = 0x00000026,
632 VK_FORMAT_R10G10B10A2_USCALED = 0x00000027,
633 VK_FORMAT_R10G10B10A2_SSCALED = 0x00000028,
634 VK_FORMAT_R10G10B10A2_UINT = 0x00000029,
635 VK_FORMAT_R10G10B10A2_SINT = 0x0000002A,
636 VK_FORMAT_R16_UNORM = 0x0000002B,
637 VK_FORMAT_R16_SNORM = 0x0000002C,
638 VK_FORMAT_R16_USCALED = 0x0000002D,
639 VK_FORMAT_R16_SSCALED = 0x0000002E,
640 VK_FORMAT_R16_UINT = 0x0000002F,
641 VK_FORMAT_R16_SINT = 0x00000030,
642 VK_FORMAT_R16_SFLOAT = 0x00000031,
643 VK_FORMAT_R16G16_UNORM = 0x00000032,
644 VK_FORMAT_R16G16_SNORM = 0x00000033,
645 VK_FORMAT_R16G16_USCALED = 0x00000034,
646 VK_FORMAT_R16G16_SSCALED = 0x00000035,
647 VK_FORMAT_R16G16_UINT = 0x00000036,
648 VK_FORMAT_R16G16_SINT = 0x00000037,
649 VK_FORMAT_R16G16_SFLOAT = 0x00000038,
650 VK_FORMAT_R16G16B16_UNORM = 0x00000039,
651 VK_FORMAT_R16G16B16_SNORM = 0x0000003A,
652 VK_FORMAT_R16G16B16_USCALED = 0x0000003B,
653 VK_FORMAT_R16G16B16_SSCALED = 0x0000003C,
654 VK_FORMAT_R16G16B16_UINT = 0x0000003D,
655 VK_FORMAT_R16G16B16_SINT = 0x0000003E,
656 VK_FORMAT_R16G16B16_SFLOAT = 0x0000003F,
657 VK_FORMAT_R16G16B16A16_UNORM = 0x00000040,
658 VK_FORMAT_R16G16B16A16_SNORM = 0x00000041,
659 VK_FORMAT_R16G16B16A16_USCALED = 0x00000042,
660 VK_FORMAT_R16G16B16A16_SSCALED = 0x00000043,
661 VK_FORMAT_R16G16B16A16_UINT = 0x00000044,
662 VK_FORMAT_R16G16B16A16_SINT = 0x00000045,
663 VK_FORMAT_R16G16B16A16_SFLOAT = 0x00000046,
664 VK_FORMAT_R32_UINT = 0x00000047,
665 VK_FORMAT_R32_SINT = 0x00000048,
666 VK_FORMAT_R32_SFLOAT = 0x00000049,
667 VK_FORMAT_R32G32_UINT = 0x0000004A,
668 VK_FORMAT_R32G32_SINT = 0x0000004B,
669 VK_FORMAT_R32G32_SFLOAT = 0x0000004C,
670 VK_FORMAT_R32G32B32_UINT = 0x0000004D,
671 VK_FORMAT_R32G32B32_SINT = 0x0000004E,
672 VK_FORMAT_R32G32B32_SFLOAT = 0x0000004F,
673 VK_FORMAT_R32G32B32A32_UINT = 0x00000050,
674 VK_FORMAT_R32G32B32A32_SINT = 0x00000051,
675 VK_FORMAT_R32G32B32A32_SFLOAT = 0x00000052,
676 VK_FORMAT_R64_SFLOAT = 0x00000053,
677 VK_FORMAT_R64G64_SFLOAT = 0x00000054,
678 VK_FORMAT_R64G64B64_SFLOAT = 0x00000055,
679 VK_FORMAT_R64G64B64A64_SFLOAT = 0x00000056,
680 VK_FORMAT_R11G11B10_UFLOAT = 0x00000057,
681 VK_FORMAT_R9G9B9E5_UFLOAT = 0x00000058,
682 VK_FORMAT_D16_UNORM = 0x00000059,
683 VK_FORMAT_D24_UNORM = 0x0000005A,
684 VK_FORMAT_D32_SFLOAT = 0x0000005B,
685 VK_FORMAT_S8_UINT = 0x0000005C,
686 VK_FORMAT_D16_UNORM_S8_UINT = 0x0000005D,
687 VK_FORMAT_D24_UNORM_S8_UINT = 0x0000005E,
688 VK_FORMAT_D32_SFLOAT_S8_UINT = 0x0000005F,
689 VK_FORMAT_BC1_RGB_UNORM = 0x00000060,
690 VK_FORMAT_BC1_RGB_SRGB = 0x00000061,
691 VK_FORMAT_BC1_RGBA_UNORM = 0x00000062,
692 VK_FORMAT_BC1_RGBA_SRGB = 0x00000063,
693 VK_FORMAT_BC2_UNORM = 0x00000064,
694 VK_FORMAT_BC2_SRGB = 0x00000065,
695 VK_FORMAT_BC3_UNORM = 0x00000066,
696 VK_FORMAT_BC3_SRGB = 0x00000067,
697 VK_FORMAT_BC4_UNORM = 0x00000068,
698 VK_FORMAT_BC4_SNORM = 0x00000069,
699 VK_FORMAT_BC5_UNORM = 0x0000006A,
700 VK_FORMAT_BC5_SNORM = 0x0000006B,
701 VK_FORMAT_BC6H_UFLOAT = 0x0000006C,
702 VK_FORMAT_BC6H_SFLOAT = 0x0000006D,
703 VK_FORMAT_BC7_UNORM = 0x0000006E,
704 VK_FORMAT_BC7_SRGB = 0x0000006F,
705 VK_FORMAT_ETC2_R8G8B8_UNORM = 0x00000070,
706 VK_FORMAT_ETC2_R8G8B8_SRGB = 0x00000071,
707 VK_FORMAT_ETC2_R8G8B8A1_UNORM = 0x00000072,
708 VK_FORMAT_ETC2_R8G8B8A1_SRGB = 0x00000073,
709 VK_FORMAT_ETC2_R8G8B8A8_UNORM = 0x00000074,
710 VK_FORMAT_ETC2_R8G8B8A8_SRGB = 0x00000075,
711 VK_FORMAT_EAC_R11_UNORM = 0x00000076,
712 VK_FORMAT_EAC_R11_SNORM = 0x00000077,
713 VK_FORMAT_EAC_R11G11_UNORM = 0x00000078,
714 VK_FORMAT_EAC_R11G11_SNORM = 0x00000079,
715 VK_FORMAT_ASTC_4x4_UNORM = 0x0000007A,
716 VK_FORMAT_ASTC_4x4_SRGB = 0x0000007B,
717 VK_FORMAT_ASTC_5x4_UNORM = 0x0000007C,
718 VK_FORMAT_ASTC_5x4_SRGB = 0x0000007D,
719 VK_FORMAT_ASTC_5x5_UNORM = 0x0000007E,
720 VK_FORMAT_ASTC_5x5_SRGB = 0x0000007F,
721 VK_FORMAT_ASTC_6x5_UNORM = 0x00000080,
722 VK_FORMAT_ASTC_6x5_SRGB = 0x00000081,
723 VK_FORMAT_ASTC_6x6_UNORM = 0x00000082,
724 VK_FORMAT_ASTC_6x6_SRGB = 0x00000083,
725 VK_FORMAT_ASTC_8x5_UNORM = 0x00000084,
726 VK_FORMAT_ASTC_8x5_SRGB = 0x00000085,
727 VK_FORMAT_ASTC_8x6_UNORM = 0x00000086,
728 VK_FORMAT_ASTC_8x6_SRGB = 0x00000087,
729 VK_FORMAT_ASTC_8x8_UNORM = 0x00000088,
730 VK_FORMAT_ASTC_8x8_SRGB = 0x00000089,
731 VK_FORMAT_ASTC_10x5_UNORM = 0x0000008A,
732 VK_FORMAT_ASTC_10x5_SRGB = 0x0000008B,
733 VK_FORMAT_ASTC_10x6_UNORM = 0x0000008C,
734 VK_FORMAT_ASTC_10x6_SRGB = 0x0000008D,
735 VK_FORMAT_ASTC_10x8_UNORM = 0x0000008E,
736 VK_FORMAT_ASTC_10x8_SRGB = 0x0000008F,
737 VK_FORMAT_ASTC_10x10_UNORM = 0x00000090,
738 VK_FORMAT_ASTC_10x10_SRGB = 0x00000091,
739 VK_FORMAT_ASTC_12x10_UNORM = 0x00000092,
740 VK_FORMAT_ASTC_12x10_SRGB = 0x00000093,
741 VK_FORMAT_ASTC_12x12_UNORM = 0x00000094,
742 VK_FORMAT_ASTC_12x12_SRGB = 0x00000095,
743 VK_FORMAT_B4G4R4A4_UNORM = 0x00000096,
744 VK_FORMAT_B5G5R5A1_UNORM = 0x00000097,
745 VK_FORMAT_B5G6R5_UNORM = 0x00000098,
746 VK_FORMAT_B5G6R5_USCALED = 0x00000099,
747 VK_FORMAT_B8G8R8_UNORM = 0x0000009A,
748 VK_FORMAT_B8G8R8_SNORM = 0x0000009B,
749 VK_FORMAT_B8G8R8_USCALED = 0x0000009C,
750 VK_FORMAT_B8G8R8_SSCALED = 0x0000009D,
751 VK_FORMAT_B8G8R8_UINT = 0x0000009E,
752 VK_FORMAT_B8G8R8_SINT = 0x0000009F,
753 VK_FORMAT_B8G8R8_SRGB = 0x000000A0,
754 VK_FORMAT_B8G8R8A8_UNORM = 0x000000A1,
755 VK_FORMAT_B8G8R8A8_SNORM = 0x000000A2,
756 VK_FORMAT_B8G8R8A8_USCALED = 0x000000A3,
757 VK_FORMAT_B8G8R8A8_SSCALED = 0x000000A4,
758 VK_FORMAT_B8G8R8A8_UINT = 0x000000A5,
759 VK_FORMAT_B8G8R8A8_SINT = 0x000000A6,
760 VK_FORMAT_B8G8R8A8_SRGB = 0x000000A7,
761 VK_FORMAT_B10G10R10A2_UNORM = 0x000000A8,
762 VK_FORMAT_B10G10R10A2_SNORM = 0x000000A9,
763 VK_FORMAT_B10G10R10A2_USCALED = 0x000000AA,
764 VK_FORMAT_B10G10R10A2_SSCALED = 0x000000AB,
765 VK_FORMAT_B10G10R10A2_UINT = 0x000000AC,
766 VK_FORMAT_B10G10R10A2_SINT = 0x000000AD,
767
768 VK_ENUM_RANGE(FORMAT, UNDEFINED, B10G10R10A2_SINT)
769} VkFormat;
770
771// Shader stage enumerant
772typedef enum VkShaderStage_
773{
774 VK_SHADER_STAGE_VERTEX = 0,
775 VK_SHADER_STAGE_TESS_CONTROL = 1,
776 VK_SHADER_STAGE_TESS_EVALUATION = 2,
777 VK_SHADER_STAGE_GEOMETRY = 3,
778 VK_SHADER_STAGE_FRAGMENT = 4,
779 VK_SHADER_STAGE_COMPUTE = 5,
780
781 VK_ENUM_RANGE(SHADER_STAGE, VERTEX, COMPUTE)
782} VkShaderStage;
783
784// Structure type enumerant
785typedef enum VkStructureType_
786{
787 VK_STRUCTURE_TYPE_APPLICATION_INFO = 0,
788 VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO = 1,
789 VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO = 2,
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600790// VK_STRUCTURE_TYPE_BUFFER_VIEW_ATTACH_INFO = 3,
791// VK_STRUCTURE_TYPE_IMAGE_VIEW_ATTACH_INFO = 4,
792 VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO = 5,
793 VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO = 6,
794 VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO = 7,
795 VK_STRUCTURE_TYPE_SHADER_CREATE_INFO = 8,
796 VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO = 9,
797 VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO = 10,
798 VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO = 11,
799 VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO = 12,
800 VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO = 13,
801 VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO = 14,
802 VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO = 15,
803 VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO = 16,
804 VK_STRUCTURE_TYPE_EVENT_CREATE_INFO = 17,
805 VK_STRUCTURE_TYPE_FENCE_CREATE_INFO = 18,
806 VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO = 19,
807 VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO = 20,
808 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO = 21,
809 VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO = 22,
810 VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO = 23,
811 VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO = 24,
812 VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO = 25,
813 VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO = 26,
814 VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO = 27,
815 VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO = 28,
816 VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO = 29,
817 VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO = 30,
818 VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO = 31,
819 VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO = 32,
820 VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO = 33,
821 VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO = 34,
822 VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO = 35,
823 VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO = 36,
824 VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO = 37,
825 VK_STRUCTURE_TYPE_MEMORY_BARRIER = 38,
826 VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER = 39,
827 VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER = 40,
828 VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO = 41,
829 VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET = 42,
830 VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET = 43,
831 VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO = 44,
832 VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO = 45,
833 VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES = 46,
Tony Barbour8205d902015-04-16 15:59:00 -0600834
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600835 VK_ENUM_RANGE(STRUCTURE_TYPE, APPLICATION_INFO, EXTENSION_PROPERTIES)
Tony Barbour8205d902015-04-16 15:59:00 -0600836} VkStructureType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600837
Mike Stroyan230e6252015-04-17 12:36:38 -0600838// Object type enumerant
839typedef enum VkObjectType_
840{
841 VK_OBJECT_TYPE_INSTANCE = 0,
842 VK_OBJECT_TYPE_PHYSICAL_DEVICE = 1,
843 VK_OBJECT_TYPE_DEVICE = 2,
844 VK_OBJECT_TYPE_QUEUE = 3,
845 VK_OBJECT_TYPE_COMMAND_BUFFER = 4,
846 VK_OBJECT_TYPE_DEVICE_MEMORY = 5,
847 VK_OBJECT_TYPE_BUFFER = 6,
848 VK_OBJECT_TYPE_BUFFER_VIEW = 7,
849 VK_OBJECT_TYPE_IMAGE = 8,
850 VK_OBJECT_TYPE_IMAGE_VIEW = 9,
851 VK_OBJECT_TYPE_COLOR_ATTACHMENT_VIEW = 10,
852 VK_OBJECT_TYPE_DEPTH_STENCIL_VIEW = 11,
853 VK_OBJECT_TYPE_SHADER = 12,
854 VK_OBJECT_TYPE_PIPELINE = 13,
855 VK_OBJECT_TYPE_PIPELINE_LAYOUT = 14,
856 VK_OBJECT_TYPE_SAMPLER = 15,
857 VK_OBJECT_TYPE_DESCRIPTOR_SET = 16,
858 VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT = 17,
859 VK_OBJECT_TYPE_DESCRIPTOR_POOL = 18,
860 VK_OBJECT_TYPE_DYNAMIC_VP_STATE = 19,
861 VK_OBJECT_TYPE_DYNAMIC_RS_STATE = 20,
862 VK_OBJECT_TYPE_DYNAMIC_CB_STATE = 21,
863 VK_OBJECT_TYPE_DYNAMIC_DS_STATE = 22,
864 VK_OBJECT_TYPE_FENCE = 23,
865 VK_OBJECT_TYPE_SEMAPHORE = 24,
866 VK_OBJECT_TYPE_EVENT = 25,
867 VK_OBJECT_TYPE_QUERY_POOL = 26,
868 VK_OBJECT_TYPE_FRAMEBUFFER = 27,
869 VK_OBJECT_TYPE_RENDER_PASS = 28,
870
871 // Valid ranges for core Vulkan:
872 VK_OBJECT_TYPE_BEGIN_RANGE = VK_OBJECT_TYPE_INSTANCE,
873 VK_OBJECT_TYPE_END_RANGE = VK_OBJECT_TYPE_RENDER_PASS,
874 VK_NUM_OBJECT_TYPE = (VK_OBJECT_TYPE_END_RANGE - VK_OBJECT_TYPE_BEGIN_RANGE + 1),
875 VK_MAX_ENUM(VkObjectType)
876} VkObjectType;
877
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600878// ------------------------------------------------------------------------------------------------
879// Error and return codes
880
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600881typedef enum VkResult_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600882{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600883 // Return codes for successful operation execution (> = 0)
884 VK_SUCCESS = 0x0000000,
885 VK_UNSUPPORTED = 0x0000001,
886 VK_NOT_READY = 0x0000002,
887 VK_TIMEOUT = 0x0000003,
888 VK_EVENT_SET = 0x0000004,
889 VK_EVENT_RESET = 0x0000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600890
891 // Error codes (negative values)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600892 VK_ERROR_UNKNOWN = -(0x00000001),
893 VK_ERROR_UNAVAILABLE = -(0x00000002),
894 VK_ERROR_INITIALIZATION_FAILED = -(0x00000003),
Tony Barbour8205d902015-04-16 15:59:00 -0600895 VK_ERROR_OUT_OF_HOST_MEMORY = -(0x00000004),
896 VK_ERROR_OUT_OF_DEVICE_MEMORY = -(0x00000005),
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600897 VK_ERROR_DEVICE_ALREADY_CREATED = -(0x00000006),
898 VK_ERROR_DEVICE_LOST = -(0x00000007),
899 VK_ERROR_INVALID_POINTER = -(0x00000008),
900 VK_ERROR_INVALID_VALUE = -(0x00000009),
901 VK_ERROR_INVALID_HANDLE = -(0x0000000A),
902 VK_ERROR_INVALID_ORDINAL = -(0x0000000B),
903 VK_ERROR_INVALID_MEMORY_SIZE = -(0x0000000C),
904 VK_ERROR_INVALID_EXTENSION = -(0x0000000D),
905 VK_ERROR_INVALID_FLAGS = -(0x0000000E),
906 VK_ERROR_INVALID_ALIGNMENT = -(0x0000000F),
907 VK_ERROR_INVALID_FORMAT = -(0x00000010),
908 VK_ERROR_INVALID_IMAGE = -(0x00000011),
909 VK_ERROR_INVALID_DESCRIPTOR_SET_DATA = -(0x00000012),
910 VK_ERROR_INVALID_QUEUE_TYPE = -(0x00000013),
911 VK_ERROR_INVALID_OBJECT_TYPE = -(0x00000014),
912 VK_ERROR_UNSUPPORTED_SHADER_IL_VERSION = -(0x00000015),
913 VK_ERROR_BAD_SHADER_CODE = -(0x00000016),
914 VK_ERROR_BAD_PIPELINE_DATA = -(0x00000017),
Courtney Goeltzenleuchterac834522015-05-01 17:56:13 -0600915 VK_ERROR_NOT_MAPPABLE = -(0x00000018),
916 VK_ERROR_MEMORY_MAP_FAILED = -(0x00000019),
917 VK_ERROR_MEMORY_UNMAP_FAILED = -(0x0000001A),
918 VK_ERROR_INCOMPATIBLE_DEVICE = -(0x0000001B),
919 VK_ERROR_INCOMPATIBLE_DRIVER = -(0x0000001C),
920 VK_ERROR_INCOMPLETE_COMMAND_BUFFER = -(0x0000001D),
921 VK_ERROR_BUILDING_COMMAND_BUFFER = -(0x0000001E),
922 VK_ERROR_MEMORY_NOT_BOUND = -(0x0000001F),
923 VK_ERROR_INCOMPATIBLE_QUEUE = -(0x00000020),
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600924 VK_ERROR_MISSING_EXTENSION_DEPENDENCY = -(0x00000021),
Tony Barbour8205d902015-04-16 15:59:00 -0600925
926 VK_MAX_ENUM(RESULT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600927} VkResult;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600928
929// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600930// Flags
931
932// Device creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600933typedef VkFlags VkDeviceCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600934
935// Queue capabilities
Tony Barbour8205d902015-04-16 15:59:00 -0600936typedef VkFlags VkQueueFlags;
937typedef enum VkQueueFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600938{
Tony Barbour8205d902015-04-16 15:59:00 -0600939 VK_QUEUE_GRAPHICS_BIT = VK_BIT(0), // Queue supports graphics operations
940 VK_QUEUE_COMPUTE_BIT = VK_BIT(1), // Queue supports compute operations
941 VK_QUEUE_DMA_BIT = VK_BIT(2), // Queue supports DMA operations
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500942 VK_QUEUE_SPARSE_MEMMGR_BIT = VK_BIT(3), // Queue supports sparse resource memory management operations
Tony Barbour8205d902015-04-16 15:59:00 -0600943 VK_QUEUE_EXTENDED_BIT = VK_BIT(30), // Extended queue
944} VkQueueFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600945
Tony Barbour8205d902015-04-16 15:59:00 -0600946// Memory properties passed into vkAllocMemory().
947typedef VkFlags VkMemoryPropertyFlags;
948typedef enum VkMemoryPropertyFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600949{
Tony Barbour8205d902015-04-16 15:59:00 -0600950 VK_MEMORY_PROPERTY_DEVICE_ONLY = 0, // If otherwise stated, then allocate memory on device
951 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT = VK_BIT(0), // Memory should be mappable by host
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600952 VK_MEMORY_PROPERTY_HOST_NON_COHERENT_BIT = VK_BIT(1), // Memory may not have i/o coherency so vkFlushMappedMemoryRanges and
953 // vkInvalidateMappedMemoryRanges must be used flush/invalidate host cache
Tony Barbour8205d902015-04-16 15:59:00 -0600954 VK_MEMORY_PROPERTY_HOST_UNCACHED_BIT = VK_BIT(2), // Memory should not be cached by the host
955 VK_MEMORY_PROPERTY_HOST_WRITE_COMBINED_BIT = VK_BIT(3), // Memory should support host write combining
956 VK_MEMORY_PROPERTY_PREFER_HOST_LOCAL = VK_BIT(4), // If set, prefer host access
Tony Barbour8205d902015-04-16 15:59:00 -0600957} VkMemoryPropertyFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600958
Tony Barbour8205d902015-04-16 15:59:00 -0600959// Memory output flags passed to resource transition commands
960typedef VkFlags VkMemoryOutputFlags;
961typedef enum VkMemoryOutputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600962{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600963 VK_MEMORY_OUTPUT_HOST_WRITE_BIT = VK_BIT(0), // Controls output coherency of host writes
Tony Barbour8205d902015-04-16 15:59:00 -0600964 VK_MEMORY_OUTPUT_SHADER_WRITE_BIT = VK_BIT(1), // Controls output coherency of generic shader writes
965 VK_MEMORY_OUTPUT_COLOR_ATTACHMENT_BIT = VK_BIT(2), // Controls output coherency of color attachment writes
966 VK_MEMORY_OUTPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(3), // Controls output coherency of depth/stencil attachment writes
967 VK_MEMORY_OUTPUT_TRANSFER_BIT = VK_BIT(4), // Controls output coherency of transfer operations
968} VkMemoryOutputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600969
Tony Barbour8205d902015-04-16 15:59:00 -0600970// Memory input flags passed to resource transition commands
971typedef VkFlags VkMemoryInputFlags;
972typedef enum VkMemoryInputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600973{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600974 VK_MEMORY_INPUT_HOST_READ_BIT = VK_BIT(0), // Controls input coherency of host reads
Tony Barbour8205d902015-04-16 15:59:00 -0600975 VK_MEMORY_INPUT_INDIRECT_COMMAND_BIT = VK_BIT(1), // Controls input coherency of indirect command reads
976 VK_MEMORY_INPUT_INDEX_FETCH_BIT = VK_BIT(2), // Controls input coherency of index fetches
977 VK_MEMORY_INPUT_VERTEX_ATTRIBUTE_FETCH_BIT = VK_BIT(3), // Controls input coherency of vertex attribute fetches
978 VK_MEMORY_INPUT_UNIFORM_READ_BIT = VK_BIT(4), // Controls input coherency of uniform buffer reads
979 VK_MEMORY_INPUT_SHADER_READ_BIT = VK_BIT(5), // Controls input coherency of generic shader reads
980 VK_MEMORY_INPUT_COLOR_ATTACHMENT_BIT = VK_BIT(6), // Controls input coherency of color attachment reads
981 VK_MEMORY_INPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(7), // Controls input coherency of depth/stencil attachment reads
982 VK_MEMORY_INPUT_TRANSFER_BIT = VK_BIT(8), // Controls input coherency of transfer operations
983} VkMemoryInputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600984
Tony Barbour8205d902015-04-16 15:59:00 -0600985// Buffer usage flags
986typedef VkFlags VkBufferUsageFlags;
987typedef enum VkBufferUsageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600988{
Tony Barbour8205d902015-04-16 15:59:00 -0600989 VK_BUFFER_USAGE_GENERAL = 0, // No special usage
990 VK_BUFFER_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
991 VK_BUFFER_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
992 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(2), // Can be used as TBO
993 VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(3), // Can be used as IBO
994 VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT = VK_BIT(4), // Can be used as UBO
995 VK_BUFFER_USAGE_STORAGE_BUFFER_BIT = VK_BIT(5), // Can be used as SSBO
996 VK_BUFFER_USAGE_INDEX_BUFFER_BIT = VK_BIT(6), // Can be used as source of fixed function index fetch (index buffer)
997 VK_BUFFER_USAGE_VERTEX_BUFFER_BIT = VK_BIT(7), // Can be used as source of fixed function vertex fetch (VBO)
998 VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT = VK_BIT(8), // Can be the source of indirect parameters (e.g. indirect buffer, parameter buffer)
999} VkBufferUsageFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001000
Tony Barbour8205d902015-04-16 15:59:00 -06001001// Buffer creation flags
1002typedef VkFlags VkBufferCreateFlags;
1003typedef enum VkBufferCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001004{
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -06001005 VK_BUFFER_CREATE_SPARSE_BIT = VK_BIT(0), // Buffer should support sparse backing
Tony Barbour8205d902015-04-16 15:59:00 -06001006} VkBufferCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001007
Tony Barbour8205d902015-04-16 15:59:00 -06001008// Shader stage flags
1009typedef VkFlags VkShaderStageFlags;
1010typedef enum VkShaderStageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001011{
Tony Barbour8205d902015-04-16 15:59:00 -06001012 VK_SHADER_STAGE_VERTEX_BIT = VK_BIT(0),
1013 VK_SHADER_STAGE_TESS_CONTROL_BIT = VK_BIT(1),
1014 VK_SHADER_STAGE_TESS_EVALUATION_BIT = VK_BIT(2),
1015 VK_SHADER_STAGE_GEOMETRY_BIT = VK_BIT(3),
1016 VK_SHADER_STAGE_FRAGMENT_BIT = VK_BIT(4),
1017 VK_SHADER_STAGE_COMPUTE_BIT = VK_BIT(5),
1018
1019 VK_SHADER_STAGE_ALL = 0x7FFFFFFF,
1020} VkShaderStageFlagBits;
1021
1022// Image usage flags
1023typedef VkFlags VkImageUsageFlags;
1024typedef enum VkImageUsageFlagBits_
1025{
1026 VK_IMAGE_USAGE_GENERAL = 0, // No special usage
1027 VK_IMAGE_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
1028 VK_IMAGE_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
1029 VK_IMAGE_USAGE_SAMPLED_BIT = VK_BIT(2), // Can be sampled from (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
1030 VK_IMAGE_USAGE_STORAGE_BIT = VK_BIT(3), // Can be used as storage image (STORAGE_IMAGE descriptor type)
1031 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT = VK_BIT(4), // Can be used as framebuffer color attachment
1032 VK_IMAGE_USAGE_DEPTH_STENCIL_BIT = VK_BIT(5), // Can be used as framebuffer depth/stencil attachment
1033 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT = VK_BIT(6), // Image data not needed outside of rendering
1034} VkImageUsageFlagBits;
1035
1036// Image creation flags
1037typedef VkFlags VkImageCreateFlags;
1038typedef enum VkImageCreateFlagBits_
1039{
1040 VK_IMAGE_CREATE_INVARIANT_DATA_BIT = VK_BIT(0),
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -06001041 VK_IMAGE_CREATE_SPARSE_BIT = VK_BIT(1), // Image should support sparse backing
1042 VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT = VK_BIT(2), // Allows image views to have different format than the base image
1043 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 -06001044} VkImageCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001045
1046// Depth-stencil view creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001047typedef VkFlags VkDepthStencilViewCreateFlags;
1048typedef enum VkDepthStencilViewCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001049{
Tony Barbour8205d902015-04-16 15:59:00 -06001050 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_DEPTH_BIT = VK_BIT(0),
1051 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_STENCIL_BIT = VK_BIT(1),
1052} VkDepthStencilViewCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001053
1054// Pipeline creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001055typedef VkFlags VkPipelineCreateFlags;
1056typedef enum VkPipelineCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001057{
Tony Barbour8205d902015-04-16 15:59:00 -06001058 VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT = VK_BIT(0),
1059 VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT = VK_BIT(1),
1060} VkPipelineCreateFlagBits;
1061
1062// Channel flags
1063typedef VkFlags VkChannelFlags;
1064typedef enum VkChannelFlagBits_
1065{
1066 VK_CHANNEL_R_BIT = VK_BIT(0),
1067 VK_CHANNEL_G_BIT = VK_BIT(1),
1068 VK_CHANNEL_B_BIT = VK_BIT(2),
1069 VK_CHANNEL_A_BIT = VK_BIT(3),
1070} VkChannelFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001071
1072// Fence creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001073typedef VkFlags VkFenceCreateFlags;
1074typedef enum VkFenceCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001075{
Tony Barbour8205d902015-04-16 15:59:00 -06001076 VK_FENCE_CREATE_SIGNALED_BIT = VK_BIT(0),
1077} VkFenceCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001078
1079// Semaphore creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001080typedef VkFlags VkSemaphoreCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001081
1082// Format capability flags
Tony Barbour8205d902015-04-16 15:59:00 -06001083typedef VkFlags VkFormatFeatureFlags;
1084typedef enum VkFormatFeatureFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001085{
Tony Barbour8205d902015-04-16 15:59:00 -06001086 VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT = VK_BIT(0), // Format can be used for sampled images (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
1087 VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT = VK_BIT(1), // Format can be used for storage images (STORAGE_IMAGE descriptor type)
1088 VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT = VK_BIT(2), // Format supports atomic operations in case it's used for storage images
1089 VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(3), // Format can be used for uniform texel buffers (TBOs)
1090 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(4), // Format can be used for storage texel buffers (IBOs)
1091 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT = VK_BIT(5), // Format supports atomic operations in case it's used for storage texel buffers
1092 VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT = VK_BIT(6), // Format can be used for vertex buffers (VBOs)
1093 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT = VK_BIT(7), // Format can be used for color attachment images
1094 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT = VK_BIT(8), // Format supports blending in case it's used for color attachment images
1095 VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(9), // Format can be used for depth/stencil attachment images
1096 VK_FORMAT_FEATURE_CONVERSION_BIT = VK_BIT(10), // Format can be used as the source or destination of format converting blits
1097} VkFormatFeatureFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001098
Tony Barbour8205d902015-04-16 15:59:00 -06001099// Query control flags
1100typedef VkFlags VkQueryControlFlags;
1101typedef enum VkQueryControlFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001102{
Tony Barbour8205d902015-04-16 15:59:00 -06001103 VK_QUERY_CONTROL_CONSERVATIVE_BIT = VK_BIT(0), // Allow conservative results to be collected by the query
1104} VkQueryControlFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001105
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001106// Query result flags
Tony Barbour8205d902015-04-16 15:59:00 -06001107typedef VkFlags VkQueryResultFlags;
1108typedef enum VkQueryResultFlagBits_
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001109{
Courtney Goeltzenleuchterc0d0bb02015-06-09 08:45:23 -06001110 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 -06001111 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 -06001112 VK_QUERY_RESULT_WAIT_BIT = VK_BIT(1), // Results of the queries are waited on before proceeding with the result copy
1113 VK_QUERY_RESULT_WITH_AVAILABILITY_BIT = VK_BIT(2), // Besides the results of the query, the availability of the results is also written
1114 VK_QUERY_RESULT_PARTIAL_BIT = VK_BIT(3), // Copy the partial results of the query even if the final results aren't available
1115} VkQueryResultFlagBits;
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001116
Tony Barbour8205d902015-04-16 15:59:00 -06001117// Shader creation flags
1118typedef VkFlags VkShaderCreateFlags;
1119
1120// Event creation flags
1121typedef VkFlags VkEventCreateFlags;
1122
1123// Command buffer creation flags
1124typedef VkFlags VkCmdBufferCreateFlags;
1125
1126// Command buffer optimization flags
1127typedef VkFlags VkCmdBufferOptimizeFlags;
1128typedef enum VkCmdBufferOptimizeFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001129{
Tony Barbour8205d902015-04-16 15:59:00 -06001130 VK_CMD_BUFFER_OPTIMIZE_SMALL_BATCH_BIT = VK_BIT(0),
1131 VK_CMD_BUFFER_OPTIMIZE_PIPELINE_SWITCH_BIT = VK_BIT(1),
1132 VK_CMD_BUFFER_OPTIMIZE_ONE_TIME_SUBMIT_BIT = VK_BIT(2),
1133 VK_CMD_BUFFER_OPTIMIZE_DESCRIPTOR_SET_SWITCH_BIT = VK_BIT(3),
1134} VkCmdBufferOptimizeFlagBits;
1135
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001136// Pipeline statistics flags
1137typedef VkFlags VkQueryPipelineStatisticFlags;
1138typedef enum VkQueryPipelineStatisticFlagBits_ {
1139 VK_QUERY_PIPELINE_STATISTIC_IA_VERTICES_BIT = VK_BIT(0), // Optional
1140 VK_QUERY_PIPELINE_STATISTIC_IA_PRIMITIVES_BIT = VK_BIT(1), // Optional
1141 VK_QUERY_PIPELINE_STATISTIC_VS_INVOCATIONS_BIT = VK_BIT(2), // Optional
1142 VK_QUERY_PIPELINE_STATISTIC_GS_INVOCATIONS_BIT = VK_BIT(3), // Optional
1143 VK_QUERY_PIPELINE_STATISTIC_GS_PRIMITIVES_BIT = VK_BIT(4), // Optional
1144 VK_QUERY_PIPELINE_STATISTIC_C_INVOCATIONS_BIT = VK_BIT(5), // Optional
1145 VK_QUERY_PIPELINE_STATISTIC_C_PRIMITIVES_BIT = VK_BIT(6), // Optional
1146 VK_QUERY_PIPELINE_STATISTIC_FS_INVOCATIONS_BIT = VK_BIT(7), // Optional
1147 VK_QUERY_PIPELINE_STATISTIC_TCS_PATCHES_BIT = VK_BIT(8), // Optional
1148 VK_QUERY_PIPELINE_STATISTIC_TES_INVOCATIONS_BIT = VK_BIT(9), // Optional
1149 VK_QUERY_PIPELINE_STATISTIC_CS_INVOCATIONS_BIT = VK_BIT(10), // Optional
1150} VkQueryPipelineStatisticFlagBits;
1151
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001152// Memory mapping flags
1153typedef VkFlags VkMemoryMapFlags;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001154
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001155// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001156// Vulkan structures
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001157
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001158typedef struct VkOffset2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001159{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001160 int32_t x;
1161 int32_t y;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001162} VkOffset2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001163
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001164typedef struct VkOffset3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001165{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001166 int32_t x;
1167 int32_t y;
1168 int32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001169} VkOffset3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001170
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001171typedef struct VkExtent2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001172{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001173 int32_t width;
1174 int32_t height;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001175} VkExtent2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001176
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001177typedef struct VkExtent3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001178{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001179 int32_t width;
1180 int32_t height;
1181 int32_t depth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001182} VkExtent3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001183
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001184typedef struct VkViewport_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001185{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001186 float originX;
1187 float originY;
1188 float width;
1189 float height;
1190 float minDepth;
1191 float maxDepth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001192} VkViewport;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001193
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001194typedef struct VkRect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001195{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001196 VkOffset2D offset;
1197 VkExtent2D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001198} VkRect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001199
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001200typedef struct VkChannelMapping_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001201{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001202 VkChannelSwizzle r;
1203 VkChannelSwizzle g;
1204 VkChannelSwizzle b;
1205 VkChannelSwizzle a;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001206} VkChannelMapping;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001207
Tony Barbour8205d902015-04-16 15:59:00 -06001208typedef struct VkPhysicalDeviceProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001209{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001210 uint32_t apiVersion;
1211 uint32_t driverVersion;
1212 uint32_t vendorId;
1213 uint32_t deviceId;
Tony Barbour8205d902015-04-16 15:59:00 -06001214 VkPhysicalDeviceType deviceType;
1215 char deviceName[VK_MAX_PHYSICAL_DEVICE_NAME];
1216 VkDeviceSize maxInlineMemoryUpdateSize;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001217 uint32_t maxBoundDescriptorSets;
1218 uint32_t maxThreadGroupSize;
1219 uint64_t timestampFrequency;
1220 bool32_t multiColorAttachmentClears;
1221 uint32_t maxDescriptorSets; // at least 2?
1222 uint32_t maxViewports; // at least 16?
1223 uint32_t maxColorAttachments; // at least 8?
Tony Barbour8205d902015-04-16 15:59:00 -06001224} VkPhysicalDeviceProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001225
Tony Barbour8205d902015-04-16 15:59:00 -06001226typedef struct VkPhysicalDevicePerformance_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001227{
Tony Barbour8205d902015-04-16 15:59:00 -06001228 float maxDeviceClock;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001229 float aluPerClock;
1230 float texPerClock;
1231 float primsPerClock;
1232 float pixelsPerClock;
Tony Barbour8205d902015-04-16 15:59:00 -06001233} VkPhysicalDevicePerformance;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001234
Jon Ashburneb2728b2015-04-10 14:33:07 -06001235typedef struct VkExtensionProperties_
1236{
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001237 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES
1238 char name[VK_MAX_EXTENSION_NAME]; // extension name
Jon Ashburneb2728b2015-04-10 14:33:07 -06001239 uint32_t version; // version of the extension specification
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001240 char description[VK_MAX_EXTENSION_NAME]; // Name of library implementing this extension
Jon Ashburneb2728b2015-04-10 14:33:07 -06001241} VkExtensionProperties;
1242
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001243typedef struct VkApplicationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001244{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001245 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_APPLICATION_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001246 const void* pNext; // Next structure in chain
1247 const char* pAppName;
1248 uint32_t appVersion;
1249 const char* pEngineName;
1250 uint32_t engineVersion;
1251 uint32_t apiVersion;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001252} VkApplicationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001253
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001254typedef void* (VKAPI *PFN_vkAllocFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001255 void* pUserData,
1256 size_t size,
1257 size_t alignment,
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001258 VkSystemAllocType allocType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001259
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001260typedef void (VKAPI *PFN_vkFreeFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001261 void* pUserData,
1262 void* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001263
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001264typedef struct VkAllocCallbacks_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001265{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001266 void* pUserData;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001267 PFN_vkAllocFunction pfnAlloc;
1268 PFN_vkFreeFunction pfnFree;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001269} VkAllocCallbacks;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001270
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001271typedef struct VkDeviceQueueCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001272{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001273 uint32_t queueNodeIndex;
1274 uint32_t queueCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001275} VkDeviceQueueCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001276
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001277typedef struct VkDeviceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001278{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001279 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001280 const void* pNext; // Pointer to next structure
1281 uint32_t queueRecordCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001282 const VkDeviceQueueCreateInfo* pRequestedQueues;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001283 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001284 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Tony Barbour8205d902015-04-16 15:59:00 -06001285 VkDeviceCreateFlags flags; // Device creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001286} VkDeviceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001287
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001288typedef struct VkInstanceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001289{
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001290 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001291 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001292 const VkApplicationInfo* pAppInfo;
1293 const VkAllocCallbacks* pAllocCb;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001294 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001295 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001296} VkInstanceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001297
Tony Barbour8205d902015-04-16 15:59:00 -06001298typedef struct VkPhysicalDeviceQueueProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001299{
Tony Barbour8205d902015-04-16 15:59:00 -06001300 VkQueueFlags queueFlags; // Queue flags
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001301 uint32_t queueCount;
1302 uint32_t maxAtomicCounters;
1303 bool32_t supportsTimestamps;
Tony Barbour8205d902015-04-16 15:59:00 -06001304} VkPhysicalDeviceQueueProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001305
Tony Barbour8205d902015-04-16 15:59:00 -06001306typedef struct VkPhysicalDeviceMemoryProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001307{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001308 bool32_t supportsMigration;
Tony Barbour8205d902015-04-16 15:59:00 -06001309} VkPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001310
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001311typedef struct VkMemoryAllocInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001312{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001313 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001314 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001315 VkDeviceSize allocationSize; // Size of memory allocation
1316 VkMemoryPropertyFlags memProps; // Memory property flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001317} VkMemoryAllocInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001318
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001319typedef struct VkMemoryRequirements_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001320{
Tony Barbour8205d902015-04-16 15:59:00 -06001321 VkDeviceSize size; // Specified in bytes
1322 VkDeviceSize alignment; // Specified in bytes
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05001323 VkDeviceSize granularity; // Granularity at which memory can be bound to resource sub-ranges specified in bytes (usually the page size)
Jeremy Hayesd02809a2015-04-15 14:17:56 -06001324 VkMemoryPropertyFlags memPropsAllowed; // Allowed memory property flags
1325 VkMemoryPropertyFlags memPropsRequired; // Required memory property flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001326} VkMemoryRequirements;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001327
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06001328typedef struct VkMappedMemoryRange_
1329{
1330 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
1331 const void* pNext; // Pointer to next structure
1332 VkDeviceMemory mem; // Mapped memory object
1333 VkDeviceSize offset; // Offset within the mapped memory the range starts from
1334 VkDeviceSize size; // Size of the range within the mapped memory
1335} VkMappedMemoryRange;
1336
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001337typedef struct VkFormatProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001338{
Tony Barbour8205d902015-04-16 15:59:00 -06001339 VkFormatFeatureFlags linearTilingFeatures; // Format features in case of linear tiling
1340 VkFormatFeatureFlags optimalTilingFeatures; // Format features in case of optimal tiling
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001341} VkFormatProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001342
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001343typedef struct VkDescriptorInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001344{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001345 VkBufferView bufferView; // Buffer view to write to the descriptor (in case it's a buffer descriptor, otherwise should be VK_NULL_HANDLE)
1346 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)
1347 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)
1348 VkImageLayout imageLayout; // Layout the image is expected to be in when accessed using this descriptor (only used if <imageView> is not VK_NULL_HANDLE)
1349} VkDescriptorInfo;
1350
1351typedef struct VkWriteDescriptorSet_
1352{
1353 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001354 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001355
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001356 VkDescriptorSet destSet; // Destination descriptor set
1357 uint32_t destBinding; // Binding within the destination descriptor set to write
1358 uint32_t destArrayElement; // Array element within the destination binding to write
1359
1360 uint32_t count; // Number of descriptors to write (determines the size of the array pointed by <pDescriptors>)
1361
1362 VkDescriptorType descriptorType; // Descriptor type to write (determines which fields of the array pointed by <pDescriptors> are going to be used)
1363 const VkDescriptorInfo* pDescriptors; // Array of info structures describing the descriptors to write
1364} VkWriteDescriptorSet;
1365
1366typedef struct VkCopyDescriptorSet_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001367{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001368 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001369 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001370
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001371 VkDescriptorSet srcSet; // Source descriptor set
1372 uint32_t srcBinding; // Binding within the source descriptor set to copy from
1373 uint32_t srcArrayElement; // Array element within the source binding to copy from
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001374
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001375 VkDescriptorSet destSet; // Destination descriptor set
1376 uint32_t destBinding; // Binding within the destination descriptor set to copy to
1377 uint32_t destArrayElement; // Array element within the destination binding to copy to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001378
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001379 uint32_t count; // Number of descriptors to copy
1380} VkCopyDescriptorSet;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001381
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001382typedef struct VkBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001383{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001384 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001385 const void* pNext; // Pointer to next structure.
Tony Barbour8205d902015-04-16 15:59:00 -06001386 VkDeviceSize size; // Specified in bytes
1387 VkBufferUsageFlags usage; // Buffer usage flags
1388 VkBufferCreateFlags flags; // Buffer creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001389} VkBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001390
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001391typedef struct VkBufferViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001392{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001393 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001394 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001395 VkBuffer buffer;
1396 VkBufferViewType viewType;
1397 VkFormat format; // Optionally specifies format of elements
Tony Barbour8205d902015-04-16 15:59:00 -06001398 VkDeviceSize offset; // Specified in bytes
1399 VkDeviceSize range; // View size specified in bytes
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001400} VkBufferViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001401
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001402typedef struct VkImageSubresource_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001403{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001404 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001405 uint32_t mipLevel;
1406 uint32_t arraySlice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001407} VkImageSubresource;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001408
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001409typedef struct VkImageSubresourceRange_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001410{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001411 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001412 uint32_t baseMipLevel;
1413 uint32_t mipLevels;
1414 uint32_t baseArraySlice;
1415 uint32_t arraySize;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001416} VkImageSubresourceRange;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001417
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001418typedef struct VkMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001419{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001420 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001421 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001422
Tony Barbour8205d902015-04-16 15:59:00 -06001423 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1424 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001425} VkMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001426
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001427typedef struct VkBufferMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001428{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001429 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001430 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001431
Tony Barbour8205d902015-04-16 15:59:00 -06001432 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1433 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001434
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001435 VkBuffer buffer; // Buffer to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001436
Tony Barbour8205d902015-04-16 15:59:00 -06001437 VkDeviceSize offset; // Offset within the buffer to sync
1438 VkDeviceSize size; // Amount of bytes to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001439} VkBufferMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001440
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001441typedef struct VkImageMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001442{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001443 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001444 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001445
Tony Barbour8205d902015-04-16 15:59:00 -06001446 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1447 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001448
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001449 VkImageLayout oldLayout; // Current layout of the image
1450 VkImageLayout newLayout; // New layout to transition the image to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001451
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001452 VkImage image; // Image to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001453
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001454 VkImageSubresourceRange subresourceRange; // Subresource range to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001455} VkImageMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001456
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001457typedef struct VkImageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001458{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001459 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001460 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001461 VkImageType imageType;
1462 VkFormat format;
1463 VkExtent3D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001464 uint32_t mipLevels;
1465 uint32_t arraySize;
1466 uint32_t samples;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001467 VkImageTiling tiling;
Tony Barbour8205d902015-04-16 15:59:00 -06001468 VkImageUsageFlags usage; // Image usage flags
1469 VkImageCreateFlags flags; // Image creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001470} VkImageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001471
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001472typedef struct VkSubresourceLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001473{
Tony Barbour8205d902015-04-16 15:59:00 -06001474 VkDeviceSize offset; // Specified in bytes
1475 VkDeviceSize size; // Specified in bytes
1476 VkDeviceSize rowPitch; // Specified in bytes
1477 VkDeviceSize depthPitch; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001478} VkSubresourceLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001479
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001480typedef struct VkImageViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001481{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001482 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001483 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001484 VkImage image;
1485 VkImageViewType viewType;
1486 VkFormat format;
1487 VkChannelMapping channels;
1488 VkImageSubresourceRange subresourceRange;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001489 float minLod;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001490} VkImageViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001491
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001492typedef struct VkColorAttachmentViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001493{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001494 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001495 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001496 VkImage image;
1497 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001498 uint32_t mipLevel;
1499 uint32_t baseArraySlice;
1500 uint32_t arraySize;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001501 VkImage msaaResolveImage;
1502 VkImageSubresourceRange msaaResolveSubResource;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001503} VkColorAttachmentViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001504
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001505typedef struct VkDepthStencilViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001506{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001507 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001508 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001509 VkImage image;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001510 uint32_t mipLevel;
1511 uint32_t baseArraySlice;
1512 uint32_t arraySize;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001513 VkImage msaaResolveImage;
1514 VkImageSubresourceRange msaaResolveSubResource;
Tony Barbour8205d902015-04-16 15:59:00 -06001515 VkDepthStencilViewCreateFlags flags; // Depth stencil attachment view flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001516} VkDepthStencilViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001517
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001518typedef struct VkColorAttachmentBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001519{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001520 VkColorAttachmentView view;
1521 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001522} VkColorAttachmentBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001523
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001524typedef struct VkDepthStencilBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001525{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001526 VkDepthStencilView view;
1527 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001528} VkDepthStencilBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001529
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001530typedef struct VkBufferCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001531{
Tony Barbour8205d902015-04-16 15:59:00 -06001532 VkDeviceSize srcOffset; // Specified in bytes
1533 VkDeviceSize destOffset; // Specified in bytes
1534 VkDeviceSize copySize; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001535} VkBufferCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001536
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001537typedef struct VkImageMemoryBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001538{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001539 VkImageSubresource subresource;
1540 VkOffset3D offset;
1541 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001542} VkImageMemoryBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001543
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001544typedef struct VkImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001545{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001546 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001547 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001548 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001549 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1550 VkExtent3D extent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001551} VkImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001552
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001553typedef struct VkImageBlit_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001554{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001555 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001556 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
1557 VkExtent3D srcExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001558 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001559 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1560 VkExtent3D destExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001561} VkImageBlit;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001562
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001563typedef struct VkBufferImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001564{
Tony Barbour8205d902015-04-16 15:59:00 -06001565 VkDeviceSize bufferOffset; // Specified in bytes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001566 VkImageSubresource imageSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001567 VkOffset3D imageOffset; // Specified in pixels for both compressed and uncompressed images
1568 VkExtent3D imageExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001569} VkBufferImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001570
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001571typedef struct VkImageResolve_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001572{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001573 VkImageSubresource srcSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001574 VkOffset3D srcOffset;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001575 VkImageSubresource destSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001576 VkOffset3D destOffset;
1577 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001578} VkImageResolve;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001579
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001580typedef struct VkShaderCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001581{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001582 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001583 const void* pNext; // Pointer to next structure
1584 size_t codeSize; // Specified in bytes
1585 const void* pCode;
Tony Barbour8205d902015-04-16 15:59:00 -06001586 VkShaderCreateFlags flags; // Reserved
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001587} VkShaderCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001588
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001589typedef struct VkDescriptorSetLayoutBinding_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001590{
Tony Barbour8205d902015-04-16 15:59:00 -06001591 VkDescriptorType descriptorType; // Type of the descriptors in this binding
Chia-I Wud3114a22015-05-25 16:22:52 +08001592 uint32_t arraySize; // Number of descriptors in this binding
Tony Barbour8205d902015-04-16 15:59:00 -06001593 VkShaderStageFlags stageFlags; // Shader stages this binding is visible to
1594 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 -06001595} VkDescriptorSetLayoutBinding;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001596
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001597typedef struct VkDescriptorSetLayoutCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001598{
Tony Barbour8205d902015-04-16 15:59:00 -06001599 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
1600 const void* pNext; // Pointer to next structure
1601 uint32_t count; // Number of bindings in the descriptor set layout
1602 const VkDescriptorSetLayoutBinding* pBinding; // Array of descriptor set layout bindings
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001603} VkDescriptorSetLayoutCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001604
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001605typedef struct VkDescriptorTypeCount_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001606{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001607 VkDescriptorType type;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001608 uint32_t count;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001609} VkDescriptorTypeCount;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001610
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001611typedef struct VkDescriptorPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001612{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001613 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001614 const void* pNext; // Pointer to next structure
1615 uint32_t count;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001616 const VkDescriptorTypeCount* pTypeCount;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001617} VkDescriptorPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001618
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001619typedef struct VkLinkConstBuffer_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001620{
1621 uint32_t bufferId;
1622 size_t bufferSize;
1623 const void* pBufferData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001624} VkLinkConstBuffer;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001625
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001626typedef struct VkSpecializationMapEntry_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001627{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001628 uint32_t constantId; // The SpecConstant ID specified in the BIL
1629 uint32_t offset; // Offset of the value in the data block
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001630} VkSpecializationMapEntry;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001631
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001632typedef struct VkSpecializationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001633{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001634 uint32_t mapEntryCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001635 const VkSpecializationMapEntry* pMap; // mapEntryCount entries
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001636 const void* pData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001637} VkSpecializationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001638
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001639typedef struct VkPipelineShaderStageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001640{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001641 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
1642 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001643 VkShaderStage stage;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001644 VkShader shader;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001645 uint32_t linkConstBufferCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001646 const VkLinkConstBuffer* pLinkConstBufferInfo;
1647 const VkSpecializationInfo* pSpecializationInfo;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001648} VkPipelineShaderStageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001649
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001650typedef struct VkComputePipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001651{
Tony Barbour8205d902015-04-16 15:59:00 -06001652 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
1653 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001654 VkPipelineShaderStageCreateInfo cs;
Tony Barbour8205d902015-04-16 15:59:00 -06001655 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001656 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001657} VkComputePipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001658
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001659typedef struct VkVertexInputBindingDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001660{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001661 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001662 uint32_t strideInBytes; // Distance between vertices in bytes (0 = no advancement)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001663
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001664 VkVertexInputStepRate stepRate; // Rate at which binding is incremented
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001665} VkVertexInputBindingDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001666
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001667typedef struct VkVertexInputAttributeDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001668{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001669 uint32_t location; // location of the shader vertex attrib
1670 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001671
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001672 VkFormat format; // format of source data
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001673
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001674 uint32_t offsetInBytes; // Offset of first element in bytes from base of vertex
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001675} VkVertexInputAttributeDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001676
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001677typedef struct VkPipelineVertexInputStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001678{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001679 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001680 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001681
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001682 uint32_t bindingCount; // number of bindings
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001683 const VkVertexInputBindingDescription* pVertexBindingDescriptions;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001684
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001685 uint32_t attributeCount; // number of attributes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001686 const VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001687} VkPipelineVertexInputStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001688
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001689typedef struct VkPipelineIaStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001690{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001691 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001692 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001693 VkPrimitiveTopology topology;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001694 bool32_t disableVertexReuse; // optional
1695 bool32_t primitiveRestartEnable;
1696 uint32_t primitiveRestartIndex; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001697} VkPipelineIaStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001698
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001699typedef struct VkPipelineTessStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001700{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001701 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001702 const void* pNext; // Pointer to next structure
1703 uint32_t patchControlPoints;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001704} VkPipelineTessStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001705
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001706typedef struct VkPipelineVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001707{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001708 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001709 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001710 uint32_t viewportCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001711 VkCoordinateOrigin clipOrigin; // optional (GL45)
1712 VkDepthMode depthMode; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001713} VkPipelineVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001714
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001715typedef struct VkPipelineRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001716{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001717 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001718 const void* pNext; // Pointer to next structure
1719 bool32_t depthClipEnable;
1720 bool32_t rasterizerDiscardEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001721 VkCoordinateOrigin pointOrigin; // optional (GL45)
Tony Barbour8205d902015-04-16 15:59:00 -06001722 VkProvokingVertex provokingVertex; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001723 VkFillMode fillMode; // optional (GL45)
1724 VkCullMode cullMode;
Tony Barbour8205d902015-04-16 15:59:00 -06001725 VkFrontFace frontFace;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001726} VkPipelineRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001727
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001728typedef struct VkPipelineMsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001729{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001730 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001731 const void* pNext; // Pointer to next structure
1732 uint32_t samples;
1733 bool32_t multisampleEnable; // optional (GL45)
1734 bool32_t sampleShadingEnable; // optional (GL45)
1735 float minSampleShading; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001736 VkSampleMask sampleMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001737} VkPipelineMsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001738
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001739typedef struct VkPipelineCbAttachmentState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001740{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001741 bool32_t blendEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001742 VkFormat format;
1743 VkBlend srcBlendColor;
1744 VkBlend destBlendColor;
Tony Barbour8205d902015-04-16 15:59:00 -06001745 VkBlendOp blendOpColor;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001746 VkBlend srcBlendAlpha;
1747 VkBlend destBlendAlpha;
Tony Barbour8205d902015-04-16 15:59:00 -06001748 VkBlendOp blendOpAlpha;
1749 VkChannelFlags channelWriteMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001750} VkPipelineCbAttachmentState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001751
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001752typedef struct VkPipelineCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001753{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001754 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001755 const void* pNext; // Pointer to next structure
1756 bool32_t alphaToCoverageEnable;
1757 bool32_t logicOpEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001758 VkLogicOp logicOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001759 uint32_t attachmentCount; // # of pAttachments
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001760 const VkPipelineCbAttachmentState* pAttachments;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001761} VkPipelineCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001762
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001763typedef struct VkStencilOpState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001764{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001765 VkStencilOp stencilFailOp;
1766 VkStencilOp stencilPassOp;
1767 VkStencilOp stencilDepthFailOp;
Tony Barbour8205d902015-04-16 15:59:00 -06001768 VkCompareOp stencilCompareOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001769} VkStencilOpState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001770
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001771typedef struct VkPipelineDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001772{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001773 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001774 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001775 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001776 bool32_t depthTestEnable;
1777 bool32_t depthWriteEnable;
Tony Barbour8205d902015-04-16 15:59:00 -06001778 VkCompareOp depthCompareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001779 bool32_t depthBoundsEnable; // optional (depth_bounds_test)
1780 bool32_t stencilTestEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001781 VkStencilOpState front;
1782 VkStencilOpState back;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001783} VkPipelineDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001784
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001785typedef struct VkGraphicsPipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001786{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001787 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001788 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001789 uint32_t stageCount;
1790 const VkPipelineShaderStageCreateInfo* pStages; // One entry for each active shader stage
1791 const VkPipelineVertexInputStateCreateInfo* pVertexInputState;
1792 const VkPipelineIaStateCreateInfo* pIaState;
1793 const VkPipelineTessStateCreateInfo* pTessState;
1794 const VkPipelineVpStateCreateInfo* pVpState;
1795 const VkPipelineRsStateCreateInfo* pRsState;
1796 const VkPipelineMsStateCreateInfo* pMsState;
1797 const VkPipelineDsStateCreateInfo* pDsState;
1798 const VkPipelineCbStateCreateInfo* pCbState;
Tony Barbour8205d902015-04-16 15:59:00 -06001799 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001800 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001801} VkGraphicsPipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001802
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001803typedef struct VkPipelineLayoutCreateInfo_
1804{
1805 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
1806 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001807
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001808 uint32_t descriptorSetCount; // Number of descriptor sets interfaced by the pipeline
1809 const VkDescriptorSetLayout* pSetLayouts; // Array of <setCount> number of descriptor set layout objects defining the layout of the
1810} VkPipelineLayoutCreateInfo;
1811
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001812typedef struct VkSamplerCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001813{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001814 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001815 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001816 VkTexFilter magFilter; // Filter mode for magnification
1817 VkTexFilter minFilter; // Filter mode for minifiation
1818 VkTexMipmapMode mipMode; // Mipmap selection mode
1819 VkTexAddress addressU;
1820 VkTexAddress addressV;
1821 VkTexAddress addressW;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001822 float mipLodBias;
1823 uint32_t maxAnisotropy;
Tony Barbour8205d902015-04-16 15:59:00 -06001824 VkCompareOp compareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001825 float minLod;
1826 float maxLod;
Tony Barbour8205d902015-04-16 15:59:00 -06001827 VkBorderColor borderColor;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001828} VkSamplerCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001829
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001830typedef struct VkDynamicVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001831{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001832 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001833 const void* pNext; // Pointer to next structure
1834 uint32_t viewportAndScissorCount; // number of entries in pViewports and pScissors
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001835 const VkViewport* pViewports;
1836 const VkRect* pScissors;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001837} VkDynamicVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001838
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001839typedef struct VkDynamicRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001840{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001841 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001842 const void* pNext; // Pointer to next structure
1843 float depthBias;
1844 float depthBiasClamp;
1845 float slopeScaledDepthBias;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001846 float lineWidth; // optional (GL45) - Width of lines
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001847} VkDynamicRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001848
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001849typedef struct VkDynamicCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001850{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001851 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001852 const void* pNext; // Pointer to next structure
1853 float blendConst[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001854} VkDynamicCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001855
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001856typedef struct VkDynamicDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001857{
Mark Lobodzinski4405fbf2015-06-12 11:14:17 -06001858 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO
1859 const void* pNext; // Pointer to next structure
1860 float minDepthBounds; // optional (depth_bounds_test)
1861 float maxDepthBounds; // optional (depth_bounds_test)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001862 uint32_t stencilReadMask;
1863 uint32_t stencilWriteMask;
1864 uint32_t stencilFrontRef;
1865 uint32_t stencilBackRef;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001866} VkDynamicDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001867
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001868typedef struct VkCmdBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001869{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001870 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001871 const void* pNext; // Pointer to next structure
1872 uint32_t queueNodeIndex;
Tony Barbour8205d902015-04-16 15:59:00 -06001873 VkCmdBufferCreateFlags flags; // Command buffer creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001874} VkCmdBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001875
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001876typedef struct VkCmdBufferBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001877{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001878 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001879 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001880
Tony Barbour8205d902015-04-16 15:59:00 -06001881 VkCmdBufferOptimizeFlags flags; // Command buffer optimization flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001882} VkCmdBufferBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001883
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001884typedef struct VkRenderPassBegin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001885{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001886 VkRenderPass renderPass;
1887 VkFramebuffer framebuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001888} VkRenderPassBegin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001889
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001890typedef struct VkCmdBufferGraphicsBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001891{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001892 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001893 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001894
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001895 VkRenderPassBegin renderPassContinue; // Only needed when a render pass is split across two command buffers
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001896} VkCmdBufferGraphicsBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001897
1898// 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 -06001899typedef union VkClearColorValue_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001900{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001901 float floatColor[4];
1902 uint32_t rawColor[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001903} VkClearColorValue;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001904
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001905typedef struct VkClearColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001906{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001907 VkClearColorValue color;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001908 bool32_t useRawValue;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001909} VkClearColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001910
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001911typedef struct VkRenderPassCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001912{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001913 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001914 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001915
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001916 VkRect renderArea;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001917 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001918 VkExtent2D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001919 uint32_t sampleCount;
1920 uint32_t layers;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001921 const VkFormat* pColorFormats;
1922 const VkImageLayout* pColorLayouts;
1923 const VkAttachmentLoadOp* pColorLoadOps;
1924 const VkAttachmentStoreOp* pColorStoreOps;
1925 const VkClearColor* pColorLoadClearValues;
1926 VkFormat depthStencilFormat;
1927 VkImageLayout depthStencilLayout;
1928 VkAttachmentLoadOp depthLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001929 float depthLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001930 VkAttachmentStoreOp depthStoreOp;
1931 VkAttachmentLoadOp stencilLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001932 uint32_t stencilLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001933 VkAttachmentStoreOp stencilStoreOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001934} VkRenderPassCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001935
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001936typedef struct VkEventCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001937{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001938 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_EVENT_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001939 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001940 VkEventCreateFlags flags; // Event creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001941} VkEventCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001942
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001943typedef struct VkFenceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001944{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001945 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001946 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001947 VkFenceCreateFlags flags; // Fence creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001948} VkFenceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001949
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001950typedef struct VkSemaphoreCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001951{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001952 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001953 const void* pNext; // Pointer to next structure
1954 uint32_t initialCount;
Tony Barbour8205d902015-04-16 15:59:00 -06001955 VkSemaphoreCreateFlags flags; // Semaphore creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001956} VkSemaphoreCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001957
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001958typedef struct VkQueryPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001959{
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001960 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO
1961 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001962 VkQueryType queryType;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001963 uint32_t slots;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001964 VkQueryPipelineStatisticFlags pipelineStatistics; // Optional
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001965} VkQueryPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001966
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001967typedef struct VkFramebufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001968{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001969 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001970 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001971
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001972 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001973 const VkColorAttachmentBindInfo* pColorAttachments;
1974 const VkDepthStencilBindInfo* pDepthStencilAttachment;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001975
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001976 uint32_t sampleCount;
1977 uint32_t width;
1978 uint32_t height;
1979 uint32_t layers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001980} VkFramebufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001981
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001982typedef struct VkDrawIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001983{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001984 uint32_t vertexCount;
1985 uint32_t instanceCount;
1986 uint32_t firstVertex;
1987 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001988} VkDrawIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001989
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001990typedef struct VkDrawIndexedIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001991{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001992 uint32_t indexCount;
1993 uint32_t instanceCount;
1994 uint32_t firstIndex;
1995 int32_t vertexOffset;
1996 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001997} VkDrawIndexedIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001998
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001999typedef struct VkDispatchIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002000{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002001 uint32_t x;
2002 uint32_t y;
2003 uint32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002004} VkDispatchIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002005
2006// ------------------------------------------------------------------------------------------------
2007// API functions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002008typedef VkResult (VKAPI *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance);
2009typedef VkResult (VKAPI *PFN_vkDestroyInstance)(VkInstance instance);
Tony Barbour8205d902015-04-16 15:59:00 -06002010typedef VkResult (VKAPI *PFN_vkEnumeratePhysicalDevices)(VkInstance instance, uint32_t* pPhysicalDeviceCount, VkPhysicalDevice* pPhysicalDevices);
2011typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceInfo)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceInfoType infoType, size_t* pDataSize, void* pData);
Jon Ashburn53c16772015-05-06 10:15:07 -06002012typedef void * (VKAPI *PFN_vkGetInstanceProcAddr)(VkInstance instance, const char * pName);
Jon Ashburn1245cec2015-05-18 13:20:15 -06002013typedef void * (VKAPI *PFN_vkGetDeviceProcAddr)(VkDevice device, const char * pName);
Tony Barbour8205d902015-04-16 15:59:00 -06002014typedef VkResult (VKAPI *PFN_vkCreateDevice)(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, VkDevice* pDevice);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002015typedef VkResult (VKAPI *PFN_vkDestroyDevice)(VkDevice device);
Jon Ashburneb2728b2015-04-10 14:33:07 -06002016typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionInfo)(VkExtensionInfoType infoType, uint32_t extensionIndex, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002017typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionInfo)(VkPhysicalDevice physicalDevice, VkExtensionInfoType infoType, uint32_t extensionIndex, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002018typedef VkResult (VKAPI *PFN_vkGetDeviceQueue)(VkDevice device, uint32_t queueNodeIndex, uint32_t queueIndex, VkQueue* pQueue);
2019typedef VkResult (VKAPI *PFN_vkQueueSubmit)(VkQueue queue, uint32_t cmdBufferCount, const VkCmdBuffer* pCmdBuffers, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002020typedef VkResult (VKAPI *PFN_vkQueueWaitIdle)(VkQueue queue);
2021typedef VkResult (VKAPI *PFN_vkDeviceWaitIdle)(VkDevice device);
Tony Barbour8205d902015-04-16 15:59:00 -06002022typedef VkResult (VKAPI *PFN_vkAllocMemory)(VkDevice device, const VkMemoryAllocInfo* pAllocInfo, VkDeviceMemory* pMem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002023typedef VkResult (VKAPI *PFN_vkFreeMemory)(VkDevice device, VkDeviceMemory mem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002024typedef VkResult (VKAPI *PFN_vkMapMemory)(VkDevice device, VkDeviceMemory mem, VkDeviceSize offset, VkDeviceSize size, VkMemoryMapFlags flags, void** ppData);
2025typedef VkResult (VKAPI *PFN_vkUnmapMemory)(VkDevice device, VkDeviceMemory mem);
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002026typedef VkResult (VKAPI *PFN_vkFlushMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
2027typedef VkResult (VKAPI *PFN_vkInvalidateMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
Mike Stroyan230e6252015-04-17 12:36:38 -06002028typedef VkResult (VKAPI *PFN_vkDestroyObject)(VkDevice device, VkObjectType objType, VkObject object);
2029typedef VkResult (VKAPI *PFN_vkGetObjectInfo)(VkDevice device, VkObjectType objType, VkObject object, VkObjectInfoType infoType, size_t* pDataSize, void* pData);
Mark Lobodzinski23182612015-05-29 09:32:35 -05002030typedef VkResult (VKAPI *PFN_vkBindObjectMemory)(VkDevice device, VkObjectType objType, VkObject object, VkDeviceMemory mem, VkDeviceSize offset);
2031typedef VkResult (VKAPI *PFN_vkQueueBindSparseBufferMemory)(VkQueue queue, VkBuffer buffer, VkDeviceSize rangeOffset, VkDeviceSize rangeSize, VkDeviceMemory mem, VkDeviceSize memOffset);
2032typedef VkResult (VKAPI *PFN_vkQueueBindSparseImageMemory)(VkQueue queue, VkImage image, const VkImageMemoryBindInfo* pBindInfo, VkDeviceMemory mem, VkDeviceSize memOffset);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002033typedef VkResult (VKAPI *PFN_vkCreateFence)(VkDevice device, const VkFenceCreateInfo* pCreateInfo, VkFence* pFence);
2034typedef VkResult (VKAPI *PFN_vkResetFences)(VkDevice device, uint32_t fenceCount, VkFence* pFences);
Mike Stroyan230e6252015-04-17 12:36:38 -06002035typedef VkResult (VKAPI *PFN_vkGetFenceStatus)(VkDevice device, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002036typedef VkResult (VKAPI *PFN_vkWaitForFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences, bool32_t waitAll, uint64_t timeout);
2037typedef VkResult (VKAPI *PFN_vkCreateSemaphore)(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo, VkSemaphore* pSemaphore);
2038typedef VkResult (VKAPI *PFN_vkQueueSignalSemaphore)(VkQueue queue, VkSemaphore semaphore);
2039typedef VkResult (VKAPI *PFN_vkQueueWaitSemaphore)(VkQueue queue, VkSemaphore semaphore);
2040typedef VkResult (VKAPI *PFN_vkCreateEvent)(VkDevice device, const VkEventCreateInfo* pCreateInfo, VkEvent* pEvent);
Mike Stroyan230e6252015-04-17 12:36:38 -06002041typedef VkResult (VKAPI *PFN_vkGetEventStatus)(VkDevice device, VkEvent event);
2042typedef VkResult (VKAPI *PFN_vkSetEvent)(VkDevice device, VkEvent event);
2043typedef VkResult (VKAPI *PFN_vkResetEvent)(VkDevice device, VkEvent event);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002044typedef VkResult (VKAPI *PFN_vkCreateQueryPool)(VkDevice device, const VkQueryPoolCreateInfo* pCreateInfo, VkQueryPool* pQueryPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002045typedef 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 -06002046typedef VkResult (VKAPI *PFN_vkGetFormatInfo)(VkDevice device, VkFormat format, VkFormatInfoType infoType, size_t* pDataSize, void* pData);
2047typedef VkResult (VKAPI *PFN_vkCreateBuffer)(VkDevice device, const VkBufferCreateInfo* pCreateInfo, VkBuffer* pBuffer);
2048typedef VkResult (VKAPI *PFN_vkCreateBufferView)(VkDevice device, const VkBufferViewCreateInfo* pCreateInfo, VkBufferView* pView);
2049typedef VkResult (VKAPI *PFN_vkCreateImage)(VkDevice device, const VkImageCreateInfo* pCreateInfo, VkImage* pImage);
Mike Stroyan230e6252015-04-17 12:36:38 -06002050typedef VkResult (VKAPI *PFN_vkGetImageSubresourceInfo)(VkDevice device, VkImage image, const VkImageSubresource* pSubresource, VkSubresourceInfoType infoType, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002051typedef VkResult (VKAPI *PFN_vkCreateImageView)(VkDevice device, const VkImageViewCreateInfo* pCreateInfo, VkImageView* pView);
2052typedef VkResult (VKAPI *PFN_vkCreateColorAttachmentView)(VkDevice device, const VkColorAttachmentViewCreateInfo* pCreateInfo, VkColorAttachmentView* pView);
2053typedef VkResult (VKAPI *PFN_vkCreateDepthStencilView)(VkDevice device, const VkDepthStencilViewCreateInfo* pCreateInfo, VkDepthStencilView* pView);
2054typedef VkResult (VKAPI *PFN_vkCreateShader)(VkDevice device, const VkShaderCreateInfo* pCreateInfo, VkShader* pShader);
2055typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipeline)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
2056typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipelineDerivative)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline basePipeline, VkPipeline* pPipeline);
2057typedef VkResult (VKAPI *PFN_vkCreateComputePipeline)(VkDevice device, const VkComputePipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
Mike Stroyan230e6252015-04-17 12:36:38 -06002058typedef VkResult (VKAPI *PFN_vkStorePipeline)(VkDevice device, VkPipeline pipeline, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002059typedef VkResult (VKAPI *PFN_vkLoadPipeline)(VkDevice device, size_t dataSize, const void* pData, VkPipeline* pPipeline);
2060typedef VkResult (VKAPI *PFN_vkLoadPipelineDerivative)(VkDevice device, size_t dataSize, const void* pData, VkPipeline basePipeline, VkPipeline* pPipeline);
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002061typedef VkResult (VKAPI *PFN_vkCreatePipelineLayout)(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo, VkPipelineLayout* pPipelineLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002062typedef VkResult (VKAPI *PFN_vkCreateSampler)(VkDevice device, const VkSamplerCreateInfo* pCreateInfo, VkSampler* pSampler);
2063typedef VkResult (VKAPI *PFN_vkCreateDescriptorSetLayout)(VkDevice device, const VkDescriptorSetLayoutCreateInfo* pCreateInfo, VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002064typedef VkResult (VKAPI *PFN_vkCreateDescriptorPool)(VkDevice device, VkDescriptorPoolUsage poolUsage, uint32_t maxSets, const VkDescriptorPoolCreateInfo* pCreateInfo, VkDescriptorPool* pDescriptorPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002065typedef VkResult (VKAPI *PFN_vkResetDescriptorPool)(VkDevice device, VkDescriptorPool descriptorPool);
2066typedef 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 +08002067typedef 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 -06002068typedef VkResult (VKAPI *PFN_vkCreateDynamicViewportState)(VkDevice device, const VkDynamicVpStateCreateInfo* pCreateInfo, VkDynamicVpState* pState);
2069typedef VkResult (VKAPI *PFN_vkCreateDynamicRasterState)(VkDevice device, const VkDynamicRsStateCreateInfo* pCreateInfo, VkDynamicRsState* pState);
2070typedef VkResult (VKAPI *PFN_vkCreateDynamicColorBlendState)(VkDevice device, const VkDynamicCbStateCreateInfo* pCreateInfo, VkDynamicCbState* pState);
2071typedef VkResult (VKAPI *PFN_vkCreateDynamicDepthStencilState)(VkDevice device, const VkDynamicDsStateCreateInfo* pCreateInfo, VkDynamicDsState* pState);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002072typedef VkResult (VKAPI *PFN_vkCreateCommandBuffer)(VkDevice device, const VkCmdBufferCreateInfo* pCreateInfo, VkCmdBuffer* pCmdBuffer);
2073typedef VkResult (VKAPI *PFN_vkBeginCommandBuffer)(VkCmdBuffer cmdBuffer, const VkCmdBufferBeginInfo* pBeginInfo);
2074typedef VkResult (VKAPI *PFN_vkEndCommandBuffer)(VkCmdBuffer cmdBuffer);
2075typedef VkResult (VKAPI *PFN_vkResetCommandBuffer)(VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002076typedef void (VKAPI *PFN_vkCmdBindPipeline)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, VkPipeline pipeline);
2077typedef void (VKAPI *PFN_vkCmdBindDynamicStateObject)(VkCmdBuffer cmdBuffer, VkStateBindPoint stateBindPoint, VkDynamicStateObject state);
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002078typedef 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 -06002079typedef void (VKAPI *PFN_vkCmdBindIndexBuffer)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, VkIndexType indexType);
2080typedef 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 -06002081typedef void (VKAPI *PFN_vkCmdDraw)(VkCmdBuffer cmdBuffer, uint32_t firstVertex, uint32_t vertexCount, uint32_t firstInstance, uint32_t instanceCount);
2082typedef 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 -06002083typedef void (VKAPI *PFN_vkCmdDrawIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
2084typedef void (VKAPI *PFN_vkCmdDrawIndexedIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002085typedef void (VKAPI *PFN_vkCmdDispatch)(VkCmdBuffer cmdBuffer, uint32_t x, uint32_t y, uint32_t z);
Tony Barbour8205d902015-04-16 15:59:00 -06002086typedef void (VKAPI *PFN_vkCmdDispatchIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002087typedef void (VKAPI *PFN_vkCmdCopyBuffer)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkBuffer destBuffer, uint32_t regionCount, const VkBufferCopy* pRegions);
2088typedef 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 -05002089typedef 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 -06002090typedef void (VKAPI *PFN_vkCmdCopyBufferToImage)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkBufferImageCopy* pRegions);
2091typedef 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 -06002092typedef void (VKAPI *PFN_vkCmdUpdateBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize dataSize, const uint32_t* pData);
2093typedef void (VKAPI *PFN_vkCmdFillBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize fillSize, uint32_t data);
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002094typedef 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 -06002095typedef 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 -06002096typedef void (VKAPI *PFN_vkCmdResolveImage)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkImageResolve* pRegions);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002097typedef void (VKAPI *PFN_vkCmdSetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipeEvent pipeEvent);
2098typedef void (VKAPI *PFN_vkCmdResetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipeEvent pipeEvent);
Tony Barbour8205d902015-04-16 15:59:00 -06002099typedef void (VKAPI *PFN_vkCmdWaitEvents)(VkCmdBuffer cmdBuffer, VkWaitEvent waitEvent, uint32_t eventCount, const VkEvent* pEvents, uint32_t memBarrierCount, const void** ppMemBarriers);
2100typedef void (VKAPI *PFN_vkCmdPipelineBarrier)(VkCmdBuffer cmdBuffer, VkWaitEvent waitEvent, uint32_t pipeEventCount, const VkPipeEvent* pPipeEvents, uint32_t memBarrierCount, const void** ppMemBarriers);
2101typedef void (VKAPI *PFN_vkCmdBeginQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot, VkQueryControlFlags flags);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002102typedef void (VKAPI *PFN_vkCmdEndQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot);
2103typedef void (VKAPI *PFN_vkCmdResetQueryPool)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount);
Tony Barbour8205d902015-04-16 15:59:00 -06002104typedef void (VKAPI *PFN_vkCmdWriteTimestamp)(VkCmdBuffer cmdBuffer, VkTimestampType timestampType, VkBuffer destBuffer, VkDeviceSize destOffset);
Tony Barbour3e3420a2015-04-16 19:09:28 -06002105typedef 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 -06002106typedef 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 -06002107typedef void (VKAPI *PFN_vkCmdLoadAtomicCounters)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, uint32_t startCounter, uint32_t counterCount, VkBuffer srcBuffer, VkDeviceSize srcOffset);
2108typedef 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 -06002109typedef VkResult (VKAPI *PFN_vkCreateFramebuffer)(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo, VkFramebuffer* pFramebuffer);
2110typedef VkResult (VKAPI *PFN_vkCreateRenderPass)(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo, VkRenderPass* pRenderPass);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002111typedef void (VKAPI *PFN_vkCmdBeginRenderPass)(VkCmdBuffer cmdBuffer, const VkRenderPassBegin* pRenderPassBegin);
2112typedef void (VKAPI *PFN_vkCmdEndRenderPass)(VkCmdBuffer cmdBuffer, VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002113
2114#ifdef VK_PROTOTYPES
2115
Tony Barbour8205d902015-04-16 15:59:00 -06002116// Device initialization
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002117
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002118VkResult VKAPI vkCreateInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002119 const VkInstanceCreateInfo* pCreateInfo,
2120 VkInstance* pInstance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002121
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002122VkResult VKAPI vkDestroyInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002123 VkInstance instance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002124
Jon Ashburn07b309a2015-04-15 11:31:12 -06002125VkResult VKAPI vkEnumeratePhysicalDevices(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002126 VkInstance instance,
Jon Ashburn07b309a2015-04-15 11:31:12 -06002127 uint32_t* pPhysicalDeviceCount,
Tony Barbour8205d902015-04-16 15:59:00 -06002128 VkPhysicalDevice* pPhysicalDevices);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002129
Tony Barbour8205d902015-04-16 15:59:00 -06002130VkResult VKAPI vkGetPhysicalDeviceInfo(
2131 VkPhysicalDevice physicalDevice,
2132 VkPhysicalDeviceInfoType infoType,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002133 size_t* pDataSize,
2134 void* pData);
2135
Jon Ashburn53c16772015-05-06 10:15:07 -06002136void * VKAPI vkGetInstanceProcAddr(
2137 VkInstance instance,
2138 const char* pName);
2139
Jon Ashburn1245cec2015-05-18 13:20:15 -06002140void * VKAPI vkGetDeviceProcAddr(
2141 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002142 const char* pName);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002143// Device functions
2144
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002145VkResult VKAPI vkCreateDevice(
Tony Barbour8205d902015-04-16 15:59:00 -06002146 VkPhysicalDevice physicalDevice,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002147 const VkDeviceCreateInfo* pCreateInfo,
2148 VkDevice* pDevice);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002149
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002150VkResult VKAPI vkDestroyDevice(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002151 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002152
2153// Extension discovery functions
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002154
Jon Ashburneb2728b2015-04-10 14:33:07 -06002155VkResult VKAPI vkGetGlobalExtensionInfo(
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06002156 VkExtensionInfoType infoType,
2157 uint32_t extensionIndex,
2158 size_t* pDataSize,
2159 void* pData);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002160
Tobin Ehlis0ef6ec52015-04-16 12:51:37 -06002161VkResult VKAPI vkGetPhysicalDeviceExtensionInfo(
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06002162 VkPhysicalDevice physicalDevice,
2163 VkExtensionInfoType infoType,
2164 uint32_t extensionIndex,
2165 size_t* pDataSize,
2166 void* pData);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002167
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002168// Queue functions
2169
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002170VkResult VKAPI vkGetDeviceQueue(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002171 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002172 uint32_t queueNodeIndex,
2173 uint32_t queueIndex,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002174 VkQueue* pQueue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002175
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002176VkResult VKAPI vkQueueSubmit(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002177 VkQueue queue,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002178 uint32_t cmdBufferCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002179 const VkCmdBuffer* pCmdBuffers,
2180 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002181
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002182VkResult VKAPI vkQueueWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002183 VkQueue queue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002184
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002185VkResult VKAPI vkDeviceWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002186 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002187
2188// Memory functions
2189
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002190VkResult VKAPI vkAllocMemory(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002191 VkDevice device,
2192 const VkMemoryAllocInfo* pAllocInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002193 VkDeviceMemory* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002194
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002195VkResult VKAPI vkFreeMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002196 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002197 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002198
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002199VkResult VKAPI vkMapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002200 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002201 VkDeviceMemory mem,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002202 VkDeviceSize offset,
2203 VkDeviceSize size,
Tony Barbour8205d902015-04-16 15:59:00 -06002204 VkMemoryMapFlags flags,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002205 void** ppData);
2206
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002207VkResult VKAPI vkUnmapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002208 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002209 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002210
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002211VkResult VKAPI vkFlushMappedMemoryRanges(
Mike Stroyan230e6252015-04-17 12:36:38 -06002212 VkDevice device,
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002213 uint32_t memRangeCount,
2214 const VkMappedMemoryRange* pMemRanges);
2215
2216VkResult VKAPI vkInvalidateMappedMemoryRanges(
2217 VkDevice device,
2218 uint32_t memRangeCount,
2219 const VkMappedMemoryRange* pMemRanges);
Tony Barbour859ceab2015-04-16 19:23:13 -06002220
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002221// Generic API object functions
2222
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002223VkResult VKAPI vkDestroyObject(
Mike Stroyan230e6252015-04-17 12:36:38 -06002224 VkDevice device,
2225 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002226 VkObject object);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002227
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002228VkResult VKAPI vkGetObjectInfo(
Mike Stroyan230e6252015-04-17 12:36:38 -06002229 VkDevice device,
2230 VkObjectType objType,
2231 VkObject object,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002232 VkObjectInfoType infoType,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002233 size_t* pDataSize,
2234 void* pData);
2235
Tony Barbour3e3420a2015-04-16 19:09:28 -06002236// Memory management API functions
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002237
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002238VkResult VKAPI vkBindObjectMemory(
2239 VkDevice device,
Mike Stroyan230e6252015-04-17 12:36:38 -06002240 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002241 VkObject object,
Tony Barbour8205d902015-04-16 15:59:00 -06002242 VkDeviceMemory mem,
2243 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002244
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002245VkResult VKAPI vkQueueBindSparseBufferMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002246 VkQueue queue,
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002247 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002248 VkDeviceSize rangeOffset,
2249 VkDeviceSize rangeSize,
2250 VkDeviceMemory mem,
2251 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002252
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002253VkResult VKAPI vkQueueBindSparseImageMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002254 VkQueue queue,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002255 VkImage image,
Jeremy Hayes47536532015-04-15 15:20:03 -06002256 const VkImageMemoryBindInfo* pBindInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002257 VkDeviceMemory mem,
2258 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002259
2260// Fence functions
2261
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002262VkResult VKAPI vkCreateFence(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002263 VkDevice device,
2264 const VkFenceCreateInfo* pCreateInfo,
2265 VkFence* pFence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002266
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002267VkResult VKAPI vkResetFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002268 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002269 uint32_t fenceCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002270 VkFence* pFences);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002271
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002272VkResult VKAPI vkGetFenceStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002273 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002274 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002275
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002276VkResult VKAPI vkWaitForFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002277 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002278 uint32_t fenceCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002279 const VkFence* pFences,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002280 bool32_t waitAll,
2281 uint64_t timeout); // timeout in nanoseconds
2282
2283// Queue semaphore functions
2284
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002285VkResult VKAPI vkCreateSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002286 VkDevice device,
2287 const VkSemaphoreCreateInfo* pCreateInfo,
2288 VkSemaphore* pSemaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002289
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002290VkResult VKAPI vkQueueSignalSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002291 VkQueue queue,
2292 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002293
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002294VkResult VKAPI vkQueueWaitSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002295 VkQueue queue,
2296 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002297
2298// Event functions
2299
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002300VkResult VKAPI vkCreateEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002301 VkDevice device,
2302 const VkEventCreateInfo* pCreateInfo,
2303 VkEvent* pEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002304
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002305VkResult VKAPI vkGetEventStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002306 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002307 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002308
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002309VkResult VKAPI vkSetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002310 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002311 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002312
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002313VkResult VKAPI vkResetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002314 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002315 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002316
2317// Query functions
2318
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002319VkResult VKAPI vkCreateQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002320 VkDevice device,
2321 const VkQueryPoolCreateInfo* pCreateInfo,
2322 VkQueryPool* pQueryPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002323
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002324VkResult VKAPI vkGetQueryPoolResults(
Mike Stroyan230e6252015-04-17 12:36:38 -06002325 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002326 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002327 uint32_t startQuery,
2328 uint32_t queryCount,
2329 size_t* pDataSize,
Tony Barbour8205d902015-04-16 15:59:00 -06002330 void* pData,
2331 VkQueryResultFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002332
2333// Format capabilities
2334
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002335VkResult VKAPI vkGetFormatInfo(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002336 VkDevice device,
2337 VkFormat format,
2338 VkFormatInfoType infoType,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002339 size_t* pDataSize,
2340 void* pData);
2341
2342// Buffer functions
2343
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002344VkResult VKAPI vkCreateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002345 VkDevice device,
2346 const VkBufferCreateInfo* pCreateInfo,
2347 VkBuffer* pBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002348
2349// Buffer view functions
2350
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002351VkResult VKAPI vkCreateBufferView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002352 VkDevice device,
2353 const VkBufferViewCreateInfo* pCreateInfo,
2354 VkBufferView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002355
2356// Image functions
2357
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002358VkResult VKAPI vkCreateImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002359 VkDevice device,
2360 const VkImageCreateInfo* pCreateInfo,
2361 VkImage* pImage);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002362
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002363VkResult VKAPI vkGetImageSubresourceInfo(
Mike Stroyan230e6252015-04-17 12:36:38 -06002364 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002365 VkImage image,
2366 const VkImageSubresource* pSubresource,
2367 VkSubresourceInfoType infoType,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002368 size_t* pDataSize,
2369 void* pData);
2370
2371// Image view functions
2372
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002373VkResult VKAPI vkCreateImageView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002374 VkDevice device,
2375 const VkImageViewCreateInfo* pCreateInfo,
2376 VkImageView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002377
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002378VkResult VKAPI vkCreateColorAttachmentView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002379 VkDevice device,
2380 const VkColorAttachmentViewCreateInfo* pCreateInfo,
2381 VkColorAttachmentView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002382
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002383VkResult VKAPI vkCreateDepthStencilView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002384 VkDevice device,
2385 const VkDepthStencilViewCreateInfo* pCreateInfo,
2386 VkDepthStencilView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002387
2388// Shader functions
2389
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002390VkResult VKAPI vkCreateShader(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002391 VkDevice device,
2392 const VkShaderCreateInfo* pCreateInfo,
2393 VkShader* pShader);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002394
2395// Pipeline functions
2396
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002397VkResult VKAPI vkCreateGraphicsPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002398 VkDevice device,
2399 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2400 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002401
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002402VkResult VKAPI vkCreateGraphicsPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002403 VkDevice device,
2404 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2405 VkPipeline basePipeline,
2406 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002407
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002408VkResult VKAPI vkCreateComputePipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002409 VkDevice device,
2410 const VkComputePipelineCreateInfo* pCreateInfo,
2411 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002412
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002413VkResult VKAPI vkStorePipeline(
Mike Stroyan230e6252015-04-17 12:36:38 -06002414 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002415 VkPipeline pipeline,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002416 size_t* pDataSize,
2417 void* pData);
2418
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002419VkResult VKAPI vkLoadPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002420 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002421 size_t dataSize,
2422 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002423 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002424
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002425VkResult VKAPI vkLoadPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002426 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002427 size_t dataSize,
2428 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002429 VkPipeline basePipeline,
2430 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002431
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002432// Pipeline layout functions
2433
2434VkResult VKAPI vkCreatePipelineLayout(
2435 VkDevice device,
2436 const VkPipelineLayoutCreateInfo* pCreateInfo,
2437 VkPipelineLayout* pPipelineLayout);
2438
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002439// Sampler functions
2440
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002441VkResult VKAPI vkCreateSampler(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002442 VkDevice device,
2443 const VkSamplerCreateInfo* pCreateInfo,
2444 VkSampler* pSampler);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002445
2446// Descriptor set functions
2447
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002448VkResult VKAPI vkCreateDescriptorSetLayout(
2449 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002450 const VkDescriptorSetLayoutCreateInfo* pCreateInfo,
2451 VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002452
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002453VkResult VKAPI vkCreateDescriptorPool(
2454 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002455 VkDescriptorPoolUsage poolUsage,
2456 uint32_t maxSets,
2457 const VkDescriptorPoolCreateInfo* pCreateInfo,
2458 VkDescriptorPool* pDescriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002459
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002460VkResult VKAPI vkResetDescriptorPool(
Mike Stroyan230e6252015-04-17 12:36:38 -06002461 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002462 VkDescriptorPool descriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002463
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002464VkResult VKAPI vkAllocDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002465 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002466 VkDescriptorPool descriptorPool,
2467 VkDescriptorSetUsage setUsage,
2468 uint32_t count,
2469 const VkDescriptorSetLayout* pSetLayouts,
2470 VkDescriptorSet* pDescriptorSets,
2471 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002472
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002473VkResult VKAPI vkUpdateDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002474 VkDevice device,
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002475 uint32_t writeCount,
2476 const VkWriteDescriptorSet* pDescriptorWrites,
2477 uint32_t copyCount,
2478 const VkCopyDescriptorSet* pDescriptorCopies);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002479
2480// State object functions
2481
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002482VkResult VKAPI vkCreateDynamicViewportState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002483 VkDevice device,
2484 const VkDynamicVpStateCreateInfo* pCreateInfo,
2485 VkDynamicVpState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002486
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002487VkResult VKAPI vkCreateDynamicRasterState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002488 VkDevice device,
2489 const VkDynamicRsStateCreateInfo* pCreateInfo,
2490 VkDynamicRsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002491
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002492VkResult VKAPI vkCreateDynamicColorBlendState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002493 VkDevice device,
2494 const VkDynamicCbStateCreateInfo* pCreateInfo,
2495 VkDynamicCbState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002496
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002497VkResult VKAPI vkCreateDynamicDepthStencilState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002498 VkDevice device,
2499 const VkDynamicDsStateCreateInfo* pCreateInfo,
2500 VkDynamicDsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002501
2502// Command buffer functions
2503
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002504VkResult VKAPI vkCreateCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002505 VkDevice device,
2506 const VkCmdBufferCreateInfo* pCreateInfo,
2507 VkCmdBuffer* pCmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002508
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002509VkResult VKAPI vkBeginCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002510 VkCmdBuffer cmdBuffer,
2511 const VkCmdBufferBeginInfo* pBeginInfo);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002512
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002513VkResult VKAPI vkEndCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002514 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002515
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002516VkResult VKAPI vkResetCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002517 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002518
2519// Command buffer building functions
2520
2521void VKAPI vkCmdBindPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002522 VkCmdBuffer cmdBuffer,
2523 VkPipelineBindPoint pipelineBindPoint,
2524 VkPipeline pipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002525
2526void VKAPI vkCmdBindDynamicStateObject(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002527 VkCmdBuffer cmdBuffer,
2528 VkStateBindPoint stateBindPoint,
2529 VkDynamicStateObject dynamicState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002530
2531void VKAPI vkCmdBindDescriptorSets(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002532 VkCmdBuffer cmdBuffer,
2533 VkPipelineBindPoint pipelineBindPoint,
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002534 VkPipelineLayout layout,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002535 uint32_t firstSet,
2536 uint32_t setCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002537 const VkDescriptorSet* pDescriptorSets,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002538 uint32_t dynamicOffsetCount,
2539 const uint32_t* pDynamicOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002540
2541void VKAPI vkCmdBindIndexBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002542 VkCmdBuffer cmdBuffer,
2543 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002544 VkDeviceSize offset,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002545 VkIndexType indexType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002546
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002547void VKAPI vkCmdBindVertexBuffers(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002548 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002549 uint32_t startBinding,
2550 uint32_t bindingCount,
2551 const VkBuffer* pBuffers,
Tony Barbour8205d902015-04-16 15:59:00 -06002552 const VkDeviceSize* pOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002553
2554void VKAPI vkCmdDraw(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002555 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002556 uint32_t firstVertex,
2557 uint32_t vertexCount,
2558 uint32_t firstInstance,
2559 uint32_t instanceCount);
2560
2561void VKAPI vkCmdDrawIndexed(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002562 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002563 uint32_t firstIndex,
2564 uint32_t indexCount,
2565 int32_t vertexOffset,
2566 uint32_t firstInstance,
2567 uint32_t instanceCount);
2568
2569void VKAPI vkCmdDrawIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002570 VkCmdBuffer cmdBuffer,
2571 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002572 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002573 uint32_t count,
2574 uint32_t stride);
2575
2576void VKAPI vkCmdDrawIndexedIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002577 VkCmdBuffer cmdBuffer,
2578 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002579 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002580 uint32_t count,
2581 uint32_t stride);
2582
2583void VKAPI vkCmdDispatch(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002584 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002585 uint32_t x,
2586 uint32_t y,
2587 uint32_t z);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002588
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002589void VKAPI vkCmdDispatchIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002590 VkCmdBuffer cmdBuffer,
2591 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002592 VkDeviceSize offset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002593
2594void VKAPI vkCmdCopyBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002595 VkCmdBuffer cmdBuffer,
2596 VkBuffer srcBuffer,
2597 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002598 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002599 const VkBufferCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002600
2601void VKAPI vkCmdCopyImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002602 VkCmdBuffer cmdBuffer,
2603 VkImage srcImage,
2604 VkImageLayout srcImageLayout,
2605 VkImage destImage,
2606 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002607 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002608 const VkImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002609
2610void VKAPI vkCmdBlitImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002611 VkCmdBuffer cmdBuffer,
2612 VkImage srcImage,
2613 VkImageLayout srcImageLayout,
2614 VkImage destImage,
2615 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002616 uint32_t regionCount,
Mark Lobodzinski20f68592015-05-22 14:43:25 -05002617 const VkImageBlit* pRegions,
2618 VkTexFilter filter);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002619
2620void VKAPI vkCmdCopyBufferToImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002621 VkCmdBuffer cmdBuffer,
2622 VkBuffer srcBuffer,
2623 VkImage destImage,
2624 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002625 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002626 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002627
2628void VKAPI vkCmdCopyImageToBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002629 VkCmdBuffer cmdBuffer,
2630 VkImage srcImage,
2631 VkImageLayout srcImageLayout,
2632 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002633 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002634 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002635
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002636void VKAPI vkCmdUpdateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002637 VkCmdBuffer cmdBuffer,
2638 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002639 VkDeviceSize destOffset,
2640 VkDeviceSize dataSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002641 const uint32_t* pData);
2642
2643void VKAPI vkCmdFillBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002644 VkCmdBuffer cmdBuffer,
2645 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002646 VkDeviceSize destOffset,
2647 VkDeviceSize fillSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002648 uint32_t data);
2649
2650void VKAPI vkCmdClearColorImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002651 VkCmdBuffer cmdBuffer,
2652 VkImage image,
2653 VkImageLayout imageLayout,
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002654 const VkClearColor* pColor,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002655 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002656 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002657
2658void VKAPI vkCmdClearDepthStencil(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002659 VkCmdBuffer cmdBuffer,
2660 VkImage image,
2661 VkImageLayout imageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002662 float depth,
2663 uint32_t stencil,
2664 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002665 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002666
2667void VKAPI vkCmdResolveImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002668 VkCmdBuffer cmdBuffer,
2669 VkImage srcImage,
2670 VkImageLayout srcImageLayout,
2671 VkImage destImage,
2672 VkImageLayout destImageLayout,
Tony Barbour11f74372015-04-13 15:02:52 -06002673 uint32_t regionCount,
2674 const VkImageResolve* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002675
2676void VKAPI vkCmdSetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002677 VkCmdBuffer cmdBuffer,
2678 VkEvent event,
2679 VkPipeEvent pipeEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002680
2681void VKAPI vkCmdResetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002682 VkCmdBuffer cmdBuffer,
2683 VkEvent event,
2684 VkPipeEvent pipeEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002685
2686void VKAPI vkCmdWaitEvents(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002687 VkCmdBuffer cmdBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002688 VkWaitEvent waitEvent,
2689 uint32_t eventCount,
2690 const VkEvent* pEvents,
2691 uint32_t memBarrierCount,
2692 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002693
2694void VKAPI vkCmdPipelineBarrier(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002695 VkCmdBuffer cmdBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002696 VkWaitEvent waitEvent,
2697 uint32_t pipeEventCount,
2698 const VkPipeEvent* pPipeEvents,
2699 uint32_t memBarrierCount,
2700 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002701
2702void VKAPI vkCmdBeginQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002703 VkCmdBuffer cmdBuffer,
2704 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002705 uint32_t slot,
Tony Barbour8205d902015-04-16 15:59:00 -06002706 VkQueryControlFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002707
2708void VKAPI vkCmdEndQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002709 VkCmdBuffer cmdBuffer,
2710 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002711 uint32_t slot);
2712
2713void VKAPI vkCmdResetQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002714 VkCmdBuffer cmdBuffer,
2715 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002716 uint32_t startQuery,
2717 uint32_t queryCount);
2718
2719void VKAPI vkCmdWriteTimestamp(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002720 VkCmdBuffer cmdBuffer,
2721 VkTimestampType timestampType,
2722 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002723 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002724
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002725void VKAPI vkCmdCopyQueryPoolResults(
2726 VkCmdBuffer cmdBuffer,
2727 VkQueryPool queryPool,
2728 uint32_t startQuery,
2729 uint32_t queryCount,
2730 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002731 VkDeviceSize destOffset,
2732 VkDeviceSize destStride,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002733 VkQueryResultFlags flags);
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002734
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002735void VKAPI vkCmdInitAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002736 VkCmdBuffer cmdBuffer,
2737 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002738 uint32_t startCounter,
2739 uint32_t counterCount,
2740 const uint32_t* pData);
2741
2742void VKAPI vkCmdLoadAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002743 VkCmdBuffer cmdBuffer,
2744 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002745 uint32_t startCounter,
2746 uint32_t counterCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002747 VkBuffer srcBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002748 VkDeviceSize srcOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002749
2750void VKAPI vkCmdSaveAtomicCounters(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002751 VkCmdBuffer cmdBuffer,
2752 VkPipelineBindPoint pipelineBindPoint,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002753 uint32_t startCounter,
2754 uint32_t counterCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002755 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002756 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002757
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002758VkResult VKAPI vkCreateFramebuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002759 VkDevice device,
2760 const VkFramebufferCreateInfo* pCreateInfo,
2761 VkFramebuffer* pFramebuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002762
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002763VkResult VKAPI vkCreateRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002764 VkDevice device,
2765 const VkRenderPassCreateInfo* pCreateInfo,
2766 VkRenderPass* pRenderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002767
2768void VKAPI vkCmdBeginRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002769 VkCmdBuffer cmdBuffer,
2770 const VkRenderPassBegin* pRenderPassBegin);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002771
2772void VKAPI vkCmdEndRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002773 VkCmdBuffer cmdBuffer,
2774 VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002775
2776#endif // VK_PROTOTYPES
2777
2778#ifdef __cplusplus
2779} // extern "C"
2780#endif // __cplusplus
2781
2782#endif // __VULKAN_H__