blob: 6e7647ca0b1d80e9acb983c4b57633e8c88184ac [file] [log] [blame]
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001//
2// File: vulkan.h
3//
4/*
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06005** Copyright (c) 2014-2015 The Khronos Group Inc.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06006**
7** Permission is hereby granted, free of charge, to any person obtaining a
8** copy of this software and/or associated documentation files (the
9** "Materials"), to deal in the Materials without restriction, including
10** without limitation the rights to use, copy, modify, merge, publish,
11** distribute, sublicense, and/or sell copies of the Materials, and to
12** permit persons to whom the Materials are furnished to do so, subject to
13** the following conditions:
14**
15** The above copyright notice and this permission notice shall be included
16** in all copies or substantial portions of the Materials.
17**
18** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
25*/
26
27#ifndef __VULKAN_H__
28#define __VULKAN_H__
29
30#define VK_MAKE_VERSION(major, minor, patch) \
31 ((major << 22) | (minor << 12) | patch)
32
Courtney Goeltzenleuchter2040b432015-04-09 11:52:55 -060033#include "vk_platform.h"
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060034
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -060035// Vulkan API version supported by this file
Mark Lobodzinskic4e83e32015-07-02 09:53:03 -060036#define VK_API_VERSION VK_MAKE_VERSION(0, 118, 0)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060037
38#ifdef __cplusplus
39extern "C"
40{
41#endif // __cplusplus
42
43/*
44***************************************************************************************************
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -060045* Core Vulkan API
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060046***************************************************************************************************
47*/
48
Mike Stroyan230e6252015-04-17 12:36:38 -060049#if defined (__cplusplus) && (VK_UINTPTRLEAST64_MAX == UINTPTR_MAX)
50 #define VK_TYPE_SAFE_COMPATIBLE_HANDLES 1
51#endif
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -060052
Mike Stroyan230e6252015-04-17 12:36:38 -060053#if defined(VK_TYPE_SAFE_COMPATIBLE_HANDLES) && !defined(VK_DISABLE_TYPE_SAFE_HANDLES)
54 #define VK_DEFINE_PTR_HANDLE(_obj) struct _obj##_T { char _dummy; }; typedef _obj##_T* _obj;
55 #define VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base) struct _obj##_T : public _base##_T {}; typedef _obj##_T* _obj;
56
57 #define VK_DEFINE_BASE_HANDLE(_obj) VK_DEFINE_PTR_HANDLE(_obj)
58 #define VK_DEFINE_DISP_SUBCLASS_HANDLE(_obj, _base) VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base)
59 #define VK_DEFINE_NONDISP_SUBCLASS_HANDLE(_obj, _base) VK_DEFINE_PTR_SUBCLASS_HANDLE(_obj, _base)
60#else
61 #define VK_DEFINE_BASE_HANDLE(_obj) typedef VkUintPtrLeast64 _obj;
62 #define VK_DEFINE_DISP_SUBCLASS_HANDLE(_obj, _base) typedef uintptr_t _obj;
63 #define VK_DEFINE_NONDISP_SUBCLASS_HANDLE(_obj, _base) typedef VkUintPtrLeast64 _obj;
64#endif
65
66VK_DEFINE_BASE_HANDLE(VkObject)
67
68VK_DEFINE_DISP_SUBCLASS_HANDLE(VkInstance, VkObject)
69VK_DEFINE_DISP_SUBCLASS_HANDLE(VkPhysicalDevice, VkObject)
70VK_DEFINE_DISP_SUBCLASS_HANDLE(VkDevice, VkObject)
71VK_DEFINE_DISP_SUBCLASS_HANDLE(VkQueue, VkObject)
72VK_DEFINE_DISP_SUBCLASS_HANDLE(VkCmdBuffer, VkObject)
73
74VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkNonDispatchable, VkObject)
75VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDeviceMemory, VkNonDispatchable)
76VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkBuffer, VkNonDispatchable)
77VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkBufferView, VkNonDispatchable)
78VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkImage, VkNonDispatchable)
79VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkImageView, VkNonDispatchable)
80VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkColorAttachmentView, VkNonDispatchable)
81VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDepthStencilView, VkNonDispatchable)
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -060082VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkShaderModule, VkNonDispatchable)
Mike Stroyan230e6252015-04-17 12:36:38 -060083VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkShader, VkNonDispatchable)
84VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipeline, VkNonDispatchable)
85VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkPipelineLayout, VkNonDispatchable)
86VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSampler, VkNonDispatchable)
87VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSet, VkNonDispatchable)
88VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorSetLayout, VkNonDispatchable)
89VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDescriptorPool, VkNonDispatchable)
90VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicStateObject, VkNonDispatchable)
91VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicVpState, VkDynamicStateObject)
92VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicRsState, VkDynamicStateObject)
93VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicCbState, VkDynamicStateObject)
94VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkDynamicDsState, VkDynamicStateObject)
95VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFence, VkNonDispatchable)
96VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkSemaphore, VkNonDispatchable)
97VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkEvent, VkNonDispatchable)
98VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkQueryPool, VkNonDispatchable)
99VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkFramebuffer, VkNonDispatchable)
100VK_DEFINE_NONDISP_SUBCLASS_HANDLE(VkRenderPass, VkNonDispatchable)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600101
Tony Barbour8205d902015-04-16 15:59:00 -0600102#define VK_MAX_PHYSICAL_DEVICE_NAME 256
Mike Stroyan230e6252015-04-17 12:36:38 -0600103#define VK_MAX_EXTENSION_NAME 256
Mark Lobodzinski72346292015-07-02 16:49:40 -0600104#define VK_MAX_MEMORY_TYPES 32
105#define VK_MAX_MEMORY_HEAPS 16
106#define VK_LOD_CLAMP_NONE MAX_FLOAT
107#define VK_LAST_MIP_LEVEL UINT32_MAX
108#define VK_LAST_ARRAY_SLICE UINT32_MAX
Courtney Goeltzenleuchterdac96cf2015-06-04 11:35:43 -0600109
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600110
Tony Barbour8205d902015-04-16 15:59:00 -0600111#define VK_WHOLE_SIZE UINT64_MAX
112
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600113#define VK_TRUE 1
114#define VK_FALSE 0
115
116#define VK_NULL_HANDLE 0
117
118// This macro defines INT_MAX in enumerations to force compilers to use 32 bits
119// to represent them. This may or may not be necessary on some compilers. The
120// option to compile it out may allow compilers that warn about missing enumerants
121// in switch statements to be silenced.
Tony Barbour8205d902015-04-16 15:59:00 -0600122// Using this macro is not needed for flag bit enums because those aren't used
123// as storage type anywhere.
124#define VK_MAX_ENUM(Prefix) VK_##Prefix##_MAX_ENUM = 0x7FFFFFFF
125
126// This macro defines the BEGIN_RANGE, END_RANGE, NUM, and MAX_ENUM constants for
127// the enumerations.
128#define VK_ENUM_RANGE(Prefix, First, Last) \
129 VK_##Prefix##_BEGIN_RANGE = VK_##Prefix##_##First, \
130 VK_##Prefix##_END_RANGE = VK_##Prefix##_##Last, \
131 VK_NUM_##Prefix = (VK_##Prefix##_END_RANGE - VK_##Prefix##_BEGIN_RANGE + 1), \
132 VK_MAX_ENUM(Prefix)
133
134// This is a helper macro to define the value of flag bit enum values.
135#define VK_BIT(bit) (1 << (bit))
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600136
137// ------------------------------------------------------------------------------------------------
138// Enumerations
139
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600140typedef enum VkImageLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600141{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600142 VK_IMAGE_LAYOUT_UNDEFINED = 0x00000000, // Implicit layout an image is when its contents are undefined due to various reasons (e.g. right after creation)
143 VK_IMAGE_LAYOUT_GENERAL = 0x00000001, // General layout when image can be used for any kind of access
144 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL = 0x00000002, // Optimal layout when image is only used for color attachment read/write
145 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL = 0x00000003, // Optimal layout when image is only used for depth/stencil attachment read/write
146 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL = 0x00000004, // Optimal layout when image is used for read only depth/stencil attachment and shader access
147 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL = 0x00000005, // Optimal layout when image is used for read only shader access
Mark Lobodzinski4e97c452015-07-01 15:18:26 -0600148 VK_IMAGE_LAYOUT_TRANSFER_SOURCE_OPTIMAL = 0x00000006, // Optimal layout when image is used only as source of transfer operations
149 VK_IMAGE_LAYOUT_TRANSFER_DESTINATION_OPTIMAL = 0x00000007, // Optimal layout when image is used only as destination of transfer operations
Tony Barbour3e3420a2015-04-16 19:09:28 -0600150
Tony Barbour8205d902015-04-16 15:59:00 -0600151 VK_ENUM_RANGE(IMAGE_LAYOUT, UNDEFINED, TRANSFER_DESTINATION_OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600152} VkImageLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600153
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600154typedef enum VkAttachmentLoadOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600155{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600156 VK_ATTACHMENT_LOAD_OP_LOAD = 0x00000000,
157 VK_ATTACHMENT_LOAD_OP_CLEAR = 0x00000001,
158 VK_ATTACHMENT_LOAD_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600159
Tony Barbour8205d902015-04-16 15:59:00 -0600160 VK_ENUM_RANGE(ATTACHMENT_LOAD_OP, LOAD, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600161} VkAttachmentLoadOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600162
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600163typedef enum VkAttachmentStoreOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600164{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600165 VK_ATTACHMENT_STORE_OP_STORE = 0x00000000,
166 VK_ATTACHMENT_STORE_OP_RESOLVE_MSAA = 0x00000001,
167 VK_ATTACHMENT_STORE_OP_DONT_CARE = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600168
Tony Barbour8205d902015-04-16 15:59:00 -0600169 VK_ENUM_RANGE(ATTACHMENT_STORE_OP, STORE, DONT_CARE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600170} VkAttachmentStoreOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600171
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600172typedef enum VkImageType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600173{
Tony Barbour8205d902015-04-16 15:59:00 -0600174 VK_IMAGE_TYPE_1D = 0x00000000,
175 VK_IMAGE_TYPE_2D = 0x00000001,
176 VK_IMAGE_TYPE_3D = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600177
Tony Barbour8205d902015-04-16 15:59:00 -0600178 VK_ENUM_RANGE(IMAGE_TYPE, 1D, 3D)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600179} VkImageType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600180
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600181typedef enum VkImageTiling_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600182{
Tony Barbour8205d902015-04-16 15:59:00 -0600183 VK_IMAGE_TILING_LINEAR = 0x00000000,
184 VK_IMAGE_TILING_OPTIMAL = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600185
Tony Barbour8205d902015-04-16 15:59:00 -0600186 VK_ENUM_RANGE(IMAGE_TILING, LINEAR, OPTIMAL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600187} VkImageTiling;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600188
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600189typedef enum VkImageViewType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600190{
Tony Barbour8205d902015-04-16 15:59:00 -0600191 VK_IMAGE_VIEW_TYPE_1D = 0x00000000,
192 VK_IMAGE_VIEW_TYPE_2D = 0x00000001,
193 VK_IMAGE_VIEW_TYPE_3D = 0x00000002,
194 VK_IMAGE_VIEW_TYPE_CUBE = 0x00000003,
Mark Lobodzinskic4e83e32015-07-02 09:53:03 -0600195 VK_IMAGE_VIEW_TYPE_1D_ARRAY = 0x00000004,
196 VK_IMAGE_VIEW_TYPE_2D_ARRAY = 0x00000005,
197 VK_IMAGE_VIEW_TYPE_CUBE_ARRAY = 0x00000006,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600198
Mark Lobodzinskic4e83e32015-07-02 09:53:03 -0600199 VK_ENUM_RANGE(IMAGE_VIEW_TYPE, 1D, CUBE_ARRAY)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600200} VkImageViewType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600201
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600202typedef enum VkImageAspect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600203{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600204 VK_IMAGE_ASPECT_COLOR = 0x00000000,
205 VK_IMAGE_ASPECT_DEPTH = 0x00000001,
206 VK_IMAGE_ASPECT_STENCIL = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600207
Tony Barbour8205d902015-04-16 15:59:00 -0600208 VK_ENUM_RANGE(IMAGE_ASPECT, COLOR, STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600209} VkImageAspect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600210
Tony Barbour8205d902015-04-16 15:59:00 -0600211typedef enum VkBufferViewType_
212{
213 VK_BUFFER_VIEW_TYPE_RAW = 0x00000000, // Raw buffer without special structure (UBO, SSBO)
214 VK_BUFFER_VIEW_TYPE_FORMATTED = 0x00000001, // Buffer with format (TBO, IBO)
215
216 VK_ENUM_RANGE(BUFFER_VIEW_TYPE, RAW, FORMATTED)
217} VkBufferViewType;
218
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600219typedef enum VkChannelSwizzle_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600220{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600221 VK_CHANNEL_SWIZZLE_ZERO = 0x00000000,
222 VK_CHANNEL_SWIZZLE_ONE = 0x00000001,
223 VK_CHANNEL_SWIZZLE_R = 0x00000002,
224 VK_CHANNEL_SWIZZLE_G = 0x00000003,
225 VK_CHANNEL_SWIZZLE_B = 0x00000004,
226 VK_CHANNEL_SWIZZLE_A = 0x00000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600227
Tony Barbour8205d902015-04-16 15:59:00 -0600228 VK_ENUM_RANGE(CHANNEL_SWIZZLE, ZERO, A)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600229} VkChannelSwizzle;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600230
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600231typedef enum VkDescriptorType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600232{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600233 VK_DESCRIPTOR_TYPE_SAMPLER = 0x00000000,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600234 VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER = 0x00000001,
235 VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE = 0x00000002,
236 VK_DESCRIPTOR_TYPE_STORAGE_IMAGE = 0x00000003,
237 VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER = 0x00000004,
238 VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER = 0x00000005,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600239 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER = 0x00000006,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600240 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER = 0x00000007,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600241 VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC = 0x00000008,
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -0600242 VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC = 0x00000009,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600243
Tony Barbour8205d902015-04-16 15:59:00 -0600244 VK_ENUM_RANGE(DESCRIPTOR_TYPE, SAMPLER, STORAGE_BUFFER_DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600245} VkDescriptorType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600246
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600247typedef enum VkDescriptorPoolUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600248{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600249 VK_DESCRIPTOR_POOL_USAGE_ONE_SHOT = 0x00000000,
250 VK_DESCRIPTOR_POOL_USAGE_DYNAMIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600251
Tony Barbour8205d902015-04-16 15:59:00 -0600252 VK_ENUM_RANGE(DESCRIPTOR_POOL_USAGE, ONE_SHOT, DYNAMIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600253} VkDescriptorPoolUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600254
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600255typedef enum VkDescriptorSetUsage_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600256{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600257 VK_DESCRIPTOR_SET_USAGE_ONE_SHOT = 0x00000000,
258 VK_DESCRIPTOR_SET_USAGE_STATIC = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600259
Tony Barbour8205d902015-04-16 15:59:00 -0600260 VK_ENUM_RANGE(DESCRIPTOR_SET_USAGE, ONE_SHOT, STATIC)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600261} VkDescriptorSetUsage;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600262
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600263typedef enum VkQueryType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600264{
Tony Barbour8205d902015-04-16 15:59:00 -0600265 VK_QUERY_TYPE_OCCLUSION = 0x00000000,
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -0600266 VK_QUERY_TYPE_PIPELINE_STATISTICS = 0x00000001, // Optional
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600267
Tony Barbour8205d902015-04-16 15:59:00 -0600268 VK_ENUM_RANGE(QUERY_TYPE, OCCLUSION, PIPELINE_STATISTICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600269} VkQueryType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600270
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600271typedef enum VkTimestampType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600272{
Tony Barbour8205d902015-04-16 15:59:00 -0600273 VK_TIMESTAMP_TYPE_TOP = 0x00000000,
274 VK_TIMESTAMP_TYPE_BOTTOM = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600275
Tony Barbour8205d902015-04-16 15:59:00 -0600276 VK_ENUM_RANGE(TIMESTAMP_TYPE, TOP, BOTTOM)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600277} VkTimestampType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600278
Tony Barbour8205d902015-04-16 15:59:00 -0600279typedef enum VkBorderColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600280{
Tony Barbour2c4e7c72015-06-25 16:56:44 -0600281 VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK = 0x00000000,
282 VK_BORDER_COLOR_INT_TRANSPARENT_BLACK = 0x00000001,
283 VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK = 0x00000002,
284 VK_BORDER_COLOR_INT_OPAQUE_BLACK = 0x00000003,
285 VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE = 0x00000004,
286 VK_BORDER_COLOR_INT_OPAQUE_WHITE = 0x00000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600287
Tony Barbour2c4e7c72015-06-25 16:56:44 -0600288 VK_ENUM_RANGE(BORDER_COLOR, FLOAT_TRANSPARENT_BLACK, INT_OPAQUE_WHITE)
Tony Barbour8205d902015-04-16 15:59:00 -0600289} VkBorderColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600290
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600291typedef enum VkPipelineBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600292{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600293 VK_PIPELINE_BIND_POINT_COMPUTE = 0x00000000,
294 VK_PIPELINE_BIND_POINT_GRAPHICS = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600295
Tony Barbour8205d902015-04-16 15:59:00 -0600296 VK_ENUM_RANGE(PIPELINE_BIND_POINT, COMPUTE, GRAPHICS)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600297} VkPipelineBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600298
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600299typedef enum VkStateBindPoint_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600300{
Tony Barbour8205d902015-04-16 15:59:00 -0600301 VK_STATE_BIND_POINT_VIEWPORT = 0x00000000,
302 VK_STATE_BIND_POINT_RASTER = 0x00000001,
303 VK_STATE_BIND_POINT_COLOR_BLEND = 0x00000002,
304 VK_STATE_BIND_POINT_DEPTH_STENCIL = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600305
Tony Barbour8205d902015-04-16 15:59:00 -0600306 VK_ENUM_RANGE(STATE_BIND_POINT, VIEWPORT, DEPTH_STENCIL)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600307} VkStateBindPoint;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600308
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600309typedef enum VkPrimitiveTopology_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600310{
Tony Barbour8205d902015-04-16 15:59:00 -0600311 VK_PRIMITIVE_TOPOLOGY_POINT_LIST = 0x00000000,
312 VK_PRIMITIVE_TOPOLOGY_LINE_LIST = 0x00000001,
313 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP = 0x00000002,
314 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST = 0x00000003,
315 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP = 0x00000004,
316 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN = 0x00000005,
317 VK_PRIMITIVE_TOPOLOGY_LINE_LIST_ADJ = 0x00000006,
318 VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_ADJ = 0x00000007,
319 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_ADJ = 0x00000008,
320 VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_ADJ = 0x00000009,
321 VK_PRIMITIVE_TOPOLOGY_PATCH = 0x0000000a,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600322
Tony Barbour8205d902015-04-16 15:59:00 -0600323 VK_ENUM_RANGE(PRIMITIVE_TOPOLOGY, POINT_LIST, PATCH)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600324} VkPrimitiveTopology;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600325
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600326typedef enum VkIndexType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600327{
Tony Barbour8205d902015-04-16 15:59:00 -0600328 VK_INDEX_TYPE_UINT8 = 0x00000000,
329 VK_INDEX_TYPE_UINT16 = 0x00000001,
330 VK_INDEX_TYPE_UINT32 = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600331
Tony Barbour8205d902015-04-16 15:59:00 -0600332 VK_ENUM_RANGE(INDEX_TYPE, UINT8, UINT32)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600333} VkIndexType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600334
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600335typedef enum VkTexFilter_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600336{
Tony Barbour8205d902015-04-16 15:59:00 -0600337 VK_TEX_FILTER_NEAREST = 0x00000000,
338 VK_TEX_FILTER_LINEAR = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600339
Tony Barbour8205d902015-04-16 15:59:00 -0600340 VK_ENUM_RANGE(TEX_FILTER, NEAREST, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600341} VkTexFilter;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600342
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600343typedef enum VkTexMipmapMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600344{
Tony Barbour8205d902015-04-16 15:59:00 -0600345 VK_TEX_MIPMAP_MODE_BASE = 0x00000000, // Always choose base level
346 VK_TEX_MIPMAP_MODE_NEAREST = 0x00000001, // Choose nearest mip level
347 VK_TEX_MIPMAP_MODE_LINEAR = 0x00000002, // Linear filter between mip levels
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600348
Tony Barbour8205d902015-04-16 15:59:00 -0600349 VK_ENUM_RANGE(TEX_MIPMAP_MODE, BASE, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600350} VkTexMipmapMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600351
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600352typedef enum VkTexAddress_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600353{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600354 VK_TEX_ADDRESS_WRAP = 0x00000000,
355 VK_TEX_ADDRESS_MIRROR = 0x00000001,
356 VK_TEX_ADDRESS_CLAMP = 0x00000002,
357 VK_TEX_ADDRESS_MIRROR_ONCE = 0x00000003,
358 VK_TEX_ADDRESS_CLAMP_BORDER = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600359
Tony Barbour8205d902015-04-16 15:59:00 -0600360 VK_ENUM_RANGE(TEX_ADDRESS, WRAP, CLAMP_BORDER)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600361} VkTexAddress;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600362
Tony Barbour8205d902015-04-16 15:59:00 -0600363typedef enum VkCompareOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600364{
Tony Barbour8205d902015-04-16 15:59:00 -0600365 VK_COMPARE_OP_NEVER = 0x00000000,
366 VK_COMPARE_OP_LESS = 0x00000001,
367 VK_COMPARE_OP_EQUAL = 0x00000002,
368 VK_COMPARE_OP_LESS_EQUAL = 0x00000003,
369 VK_COMPARE_OP_GREATER = 0x00000004,
370 VK_COMPARE_OP_NOT_EQUAL = 0x00000005,
371 VK_COMPARE_OP_GREATER_EQUAL = 0x00000006,
372 VK_COMPARE_OP_ALWAYS = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600373
Tony Barbour8205d902015-04-16 15:59:00 -0600374 VK_ENUM_RANGE(COMPARE_OP, NEVER, ALWAYS)
375} VkCompareOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600376
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600377typedef enum VkFillMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600378{
Tony Barbour8205d902015-04-16 15:59:00 -0600379 VK_FILL_MODE_POINTS = 0x00000000,
380 VK_FILL_MODE_WIREFRAME = 0x00000001,
381 VK_FILL_MODE_SOLID = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600382
Tony Barbour8205d902015-04-16 15:59:00 -0600383 VK_ENUM_RANGE(FILL_MODE, POINTS, SOLID)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600384} VkFillMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600385
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600386typedef enum VkCullMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600387{
Tony Barbour8205d902015-04-16 15:59:00 -0600388 VK_CULL_MODE_NONE = 0x00000000,
389 VK_CULL_MODE_FRONT = 0x00000001,
390 VK_CULL_MODE_BACK = 0x00000002,
391 VK_CULL_MODE_FRONT_AND_BACK = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600392
Tony Barbour8205d902015-04-16 15:59:00 -0600393 VK_ENUM_RANGE(CULL_MODE, NONE, FRONT_AND_BACK)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600394} VkCullMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600395
Tony Barbour8205d902015-04-16 15:59:00 -0600396typedef enum VkFrontFace_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600397{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600398 VK_FRONT_FACE_CCW = 0x00000000,
399 VK_FRONT_FACE_CW = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600400
Tony Barbour8205d902015-04-16 15:59:00 -0600401 VK_ENUM_RANGE(FRONT_FACE, CCW, CW)
402} VkFrontFace;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600403
Tony Barbour8205d902015-04-16 15:59:00 -0600404typedef enum VkProvokingVertex_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600405{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600406 VK_PROVOKING_VERTEX_FIRST = 0x00000000,
407 VK_PROVOKING_VERTEX_LAST = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600408
Tony Barbour8205d902015-04-16 15:59:00 -0600409 VK_ENUM_RANGE(PROVOKING_VERTEX, FIRST, LAST)
410} VkProvokingVertex;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600411
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600412typedef enum VkCoordinateOrigin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600413{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600414 VK_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000,
415 VK_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600416
Tony Barbour8205d902015-04-16 15:59:00 -0600417 VK_ENUM_RANGE(COORDINATE_ORIGIN, UPPER_LEFT, LOWER_LEFT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600418} VkCoordinateOrigin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600419
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600420typedef enum VkDepthMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600421{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600422 VK_DEPTH_MODE_ZERO_TO_ONE = 0x00000000,
423 VK_DEPTH_MODE_NEGATIVE_ONE_TO_ONE = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600424
Tony Barbour8205d902015-04-16 15:59:00 -0600425 VK_ENUM_RANGE(DEPTH_MODE, ZERO_TO_ONE, NEGATIVE_ONE_TO_ONE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600426} VkDepthMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600427
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600428typedef enum VkBlend_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600429{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600430 VK_BLEND_ZERO = 0x00000000,
431 VK_BLEND_ONE = 0x00000001,
432 VK_BLEND_SRC_COLOR = 0x00000002,
433 VK_BLEND_ONE_MINUS_SRC_COLOR = 0x00000003,
434 VK_BLEND_DEST_COLOR = 0x00000004,
435 VK_BLEND_ONE_MINUS_DEST_COLOR = 0x00000005,
436 VK_BLEND_SRC_ALPHA = 0x00000006,
437 VK_BLEND_ONE_MINUS_SRC_ALPHA = 0x00000007,
438 VK_BLEND_DEST_ALPHA = 0x00000008,
439 VK_BLEND_ONE_MINUS_DEST_ALPHA = 0x00000009,
440 VK_BLEND_CONSTANT_COLOR = 0x0000000a,
441 VK_BLEND_ONE_MINUS_CONSTANT_COLOR = 0x0000000b,
442 VK_BLEND_CONSTANT_ALPHA = 0x0000000c,
443 VK_BLEND_ONE_MINUS_CONSTANT_ALPHA = 0x0000000d,
444 VK_BLEND_SRC_ALPHA_SATURATE = 0x0000000e,
445 VK_BLEND_SRC1_COLOR = 0x0000000f,
446 VK_BLEND_ONE_MINUS_SRC1_COLOR = 0x00000010,
447 VK_BLEND_SRC1_ALPHA = 0x00000011,
448 VK_BLEND_ONE_MINUS_SRC1_ALPHA = 0x00000012,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600449
Tony Barbour8205d902015-04-16 15:59:00 -0600450 VK_ENUM_RANGE(BLEND, ZERO, ONE_MINUS_SRC1_ALPHA)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600451} VkBlend;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600452
Tony Barbour8205d902015-04-16 15:59:00 -0600453typedef enum VkBlendOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600454{
Tony Barbour8205d902015-04-16 15:59:00 -0600455 VK_BLEND_OP_ADD = 0x00000000,
456 VK_BLEND_OP_SUBTRACT = 0x00000001,
457 VK_BLEND_OP_REVERSE_SUBTRACT = 0x00000002,
458 VK_BLEND_OP_MIN = 0x00000003,
459 VK_BLEND_OP_MAX = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600460
Tony Barbour8205d902015-04-16 15:59:00 -0600461 VK_ENUM_RANGE(BLEND_OP, ADD, MAX)
462} VkBlendOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600463
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600464typedef enum VkStencilOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600465{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600466 VK_STENCIL_OP_KEEP = 0x00000000,
467 VK_STENCIL_OP_ZERO = 0x00000001,
468 VK_STENCIL_OP_REPLACE = 0x00000002,
469 VK_STENCIL_OP_INC_CLAMP = 0x00000003,
470 VK_STENCIL_OP_DEC_CLAMP = 0x00000004,
471 VK_STENCIL_OP_INVERT = 0x00000005,
472 VK_STENCIL_OP_INC_WRAP = 0x00000006,
473 VK_STENCIL_OP_DEC_WRAP = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600474
Tony Barbour8205d902015-04-16 15:59:00 -0600475 VK_ENUM_RANGE(STENCIL_OP, KEEP, DEC_WRAP)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600476} VkStencilOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600477
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600478typedef enum VkLogicOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600479{
Tony Barbourfdff5572015-06-26 13:28:56 -0600480 VK_LOGIC_OP_CLEAR = 0x00000000,
481 VK_LOGIC_OP_AND = 0x00000001,
482 VK_LOGIC_OP_AND_REVERSE = 0x00000002,
483 VK_LOGIC_OP_COPY = 0x00000003,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600484 VK_LOGIC_OP_AND_INVERTED = 0x00000004,
485 VK_LOGIC_OP_NOOP = 0x00000005,
486 VK_LOGIC_OP_XOR = 0x00000006,
487 VK_LOGIC_OP_OR = 0x00000007,
488 VK_LOGIC_OP_NOR = 0x00000008,
489 VK_LOGIC_OP_EQUIV = 0x00000009,
490 VK_LOGIC_OP_INVERT = 0x0000000a,
491 VK_LOGIC_OP_OR_REVERSE = 0x0000000b,
492 VK_LOGIC_OP_COPY_INVERTED = 0x0000000c,
493 VK_LOGIC_OP_OR_INVERTED = 0x0000000d,
494 VK_LOGIC_OP_NAND = 0x0000000e,
495 VK_LOGIC_OP_SET = 0x0000000f,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600496
Tony Barbourfdff5572015-06-26 13:28:56 -0600497 VK_ENUM_RANGE(LOGIC_OP, CLEAR, SET)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600498} VkLogicOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600499
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600500typedef enum VkSystemAllocType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600501{
Tony Barbour8205d902015-04-16 15:59:00 -0600502 VK_SYSTEM_ALLOC_TYPE_API_OBJECT = 0x00000000,
503 VK_SYSTEM_ALLOC_TYPE_INTERNAL = 0x00000001,
504 VK_SYSTEM_ALLOC_TYPE_INTERNAL_TEMP = 0x00000002,
505 VK_SYSTEM_ALLOC_TYPE_INTERNAL_SHADER = 0x00000003,
506 VK_SYSTEM_ALLOC_TYPE_DEBUG = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600507
Tony Barbour8205d902015-04-16 15:59:00 -0600508 VK_ENUM_RANGE(SYSTEM_ALLOC_TYPE, API_OBJECT, DEBUG)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600509} VkSystemAllocType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600510
Tony Barbour8205d902015-04-16 15:59:00 -0600511typedef enum VkPhysicalDeviceType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600512{
Tony Barbour8205d902015-04-16 15:59:00 -0600513 VK_PHYSICAL_DEVICE_TYPE_OTHER = 0x00000000,
514 VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU = 0x00000001,
515 VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU = 0x00000002,
516 VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU = 0x00000003,
517 VK_PHYSICAL_DEVICE_TYPE_CPU = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600518
Tony Barbour8205d902015-04-16 15:59:00 -0600519 VK_ENUM_RANGE(PHYSICAL_DEVICE_TYPE, OTHER, CPU)
520} VkPhysicalDeviceType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600521
Tony Barbour8205d902015-04-16 15:59:00 -0600522typedef enum VkVertexInputStepRate_
523{
524 VK_VERTEX_INPUT_STEP_RATE_VERTEX = 0x0,
525 VK_VERTEX_INPUT_STEP_RATE_INSTANCE = 0x1,
526 VK_VERTEX_INPUT_STEP_RATE_DRAW = 0x2, //Optional
527
528 VK_ENUM_RANGE(VERTEX_INPUT_STEP_RATE, VERTEX, DRAW)
529} VkVertexInputStepRate;
530
Tony Barbour8205d902015-04-16 15:59:00 -0600531// Vulkan format definitions
532typedef enum VkFormat_
533{
534 VK_FORMAT_UNDEFINED = 0x00000000,
535 VK_FORMAT_R4G4_UNORM = 0x00000001,
536 VK_FORMAT_R4G4_USCALED = 0x00000002,
537 VK_FORMAT_R4G4B4A4_UNORM = 0x00000003,
538 VK_FORMAT_R4G4B4A4_USCALED = 0x00000004,
539 VK_FORMAT_R5G6B5_UNORM = 0x00000005,
540 VK_FORMAT_R5G6B5_USCALED = 0x00000006,
541 VK_FORMAT_R5G5B5A1_UNORM = 0x00000007,
542 VK_FORMAT_R5G5B5A1_USCALED = 0x00000008,
543 VK_FORMAT_R8_UNORM = 0x00000009,
544 VK_FORMAT_R8_SNORM = 0x0000000A,
545 VK_FORMAT_R8_USCALED = 0x0000000B,
546 VK_FORMAT_R8_SSCALED = 0x0000000C,
547 VK_FORMAT_R8_UINT = 0x0000000D,
548 VK_FORMAT_R8_SINT = 0x0000000E,
549 VK_FORMAT_R8_SRGB = 0x0000000F,
550 VK_FORMAT_R8G8_UNORM = 0x00000010,
551 VK_FORMAT_R8G8_SNORM = 0x00000011,
552 VK_FORMAT_R8G8_USCALED = 0x00000012,
553 VK_FORMAT_R8G8_SSCALED = 0x00000013,
554 VK_FORMAT_R8G8_UINT = 0x00000014,
555 VK_FORMAT_R8G8_SINT = 0x00000015,
556 VK_FORMAT_R8G8_SRGB = 0x00000016,
557 VK_FORMAT_R8G8B8_UNORM = 0x00000017,
558 VK_FORMAT_R8G8B8_SNORM = 0x00000018,
559 VK_FORMAT_R8G8B8_USCALED = 0x00000019,
560 VK_FORMAT_R8G8B8_SSCALED = 0x0000001A,
561 VK_FORMAT_R8G8B8_UINT = 0x0000001B,
562 VK_FORMAT_R8G8B8_SINT = 0x0000001C,
563 VK_FORMAT_R8G8B8_SRGB = 0x0000001D,
564 VK_FORMAT_R8G8B8A8_UNORM = 0x0000001E,
565 VK_FORMAT_R8G8B8A8_SNORM = 0x0000001F,
566 VK_FORMAT_R8G8B8A8_USCALED = 0x00000020,
567 VK_FORMAT_R8G8B8A8_SSCALED = 0x00000021,
568 VK_FORMAT_R8G8B8A8_UINT = 0x00000022,
569 VK_FORMAT_R8G8B8A8_SINT = 0x00000023,
570 VK_FORMAT_R8G8B8A8_SRGB = 0x00000024,
571 VK_FORMAT_R10G10B10A2_UNORM = 0x00000025,
572 VK_FORMAT_R10G10B10A2_SNORM = 0x00000026,
573 VK_FORMAT_R10G10B10A2_USCALED = 0x00000027,
574 VK_FORMAT_R10G10B10A2_SSCALED = 0x00000028,
575 VK_FORMAT_R10G10B10A2_UINT = 0x00000029,
576 VK_FORMAT_R10G10B10A2_SINT = 0x0000002A,
577 VK_FORMAT_R16_UNORM = 0x0000002B,
578 VK_FORMAT_R16_SNORM = 0x0000002C,
579 VK_FORMAT_R16_USCALED = 0x0000002D,
580 VK_FORMAT_R16_SSCALED = 0x0000002E,
581 VK_FORMAT_R16_UINT = 0x0000002F,
582 VK_FORMAT_R16_SINT = 0x00000030,
583 VK_FORMAT_R16_SFLOAT = 0x00000031,
584 VK_FORMAT_R16G16_UNORM = 0x00000032,
585 VK_FORMAT_R16G16_SNORM = 0x00000033,
586 VK_FORMAT_R16G16_USCALED = 0x00000034,
587 VK_FORMAT_R16G16_SSCALED = 0x00000035,
588 VK_FORMAT_R16G16_UINT = 0x00000036,
589 VK_FORMAT_R16G16_SINT = 0x00000037,
590 VK_FORMAT_R16G16_SFLOAT = 0x00000038,
591 VK_FORMAT_R16G16B16_UNORM = 0x00000039,
592 VK_FORMAT_R16G16B16_SNORM = 0x0000003A,
593 VK_FORMAT_R16G16B16_USCALED = 0x0000003B,
594 VK_FORMAT_R16G16B16_SSCALED = 0x0000003C,
595 VK_FORMAT_R16G16B16_UINT = 0x0000003D,
596 VK_FORMAT_R16G16B16_SINT = 0x0000003E,
597 VK_FORMAT_R16G16B16_SFLOAT = 0x0000003F,
598 VK_FORMAT_R16G16B16A16_UNORM = 0x00000040,
599 VK_FORMAT_R16G16B16A16_SNORM = 0x00000041,
600 VK_FORMAT_R16G16B16A16_USCALED = 0x00000042,
601 VK_FORMAT_R16G16B16A16_SSCALED = 0x00000043,
602 VK_FORMAT_R16G16B16A16_UINT = 0x00000044,
603 VK_FORMAT_R16G16B16A16_SINT = 0x00000045,
604 VK_FORMAT_R16G16B16A16_SFLOAT = 0x00000046,
605 VK_FORMAT_R32_UINT = 0x00000047,
606 VK_FORMAT_R32_SINT = 0x00000048,
607 VK_FORMAT_R32_SFLOAT = 0x00000049,
608 VK_FORMAT_R32G32_UINT = 0x0000004A,
609 VK_FORMAT_R32G32_SINT = 0x0000004B,
610 VK_FORMAT_R32G32_SFLOAT = 0x0000004C,
611 VK_FORMAT_R32G32B32_UINT = 0x0000004D,
612 VK_FORMAT_R32G32B32_SINT = 0x0000004E,
613 VK_FORMAT_R32G32B32_SFLOAT = 0x0000004F,
614 VK_FORMAT_R32G32B32A32_UINT = 0x00000050,
615 VK_FORMAT_R32G32B32A32_SINT = 0x00000051,
616 VK_FORMAT_R32G32B32A32_SFLOAT = 0x00000052,
617 VK_FORMAT_R64_SFLOAT = 0x00000053,
618 VK_FORMAT_R64G64_SFLOAT = 0x00000054,
619 VK_FORMAT_R64G64B64_SFLOAT = 0x00000055,
620 VK_FORMAT_R64G64B64A64_SFLOAT = 0x00000056,
621 VK_FORMAT_R11G11B10_UFLOAT = 0x00000057,
622 VK_FORMAT_R9G9B9E5_UFLOAT = 0x00000058,
623 VK_FORMAT_D16_UNORM = 0x00000059,
624 VK_FORMAT_D24_UNORM = 0x0000005A,
625 VK_FORMAT_D32_SFLOAT = 0x0000005B,
626 VK_FORMAT_S8_UINT = 0x0000005C,
627 VK_FORMAT_D16_UNORM_S8_UINT = 0x0000005D,
628 VK_FORMAT_D24_UNORM_S8_UINT = 0x0000005E,
629 VK_FORMAT_D32_SFLOAT_S8_UINT = 0x0000005F,
630 VK_FORMAT_BC1_RGB_UNORM = 0x00000060,
631 VK_FORMAT_BC1_RGB_SRGB = 0x00000061,
632 VK_FORMAT_BC1_RGBA_UNORM = 0x00000062,
633 VK_FORMAT_BC1_RGBA_SRGB = 0x00000063,
634 VK_FORMAT_BC2_UNORM = 0x00000064,
635 VK_FORMAT_BC2_SRGB = 0x00000065,
636 VK_FORMAT_BC3_UNORM = 0x00000066,
637 VK_FORMAT_BC3_SRGB = 0x00000067,
638 VK_FORMAT_BC4_UNORM = 0x00000068,
639 VK_FORMAT_BC4_SNORM = 0x00000069,
640 VK_FORMAT_BC5_UNORM = 0x0000006A,
641 VK_FORMAT_BC5_SNORM = 0x0000006B,
642 VK_FORMAT_BC6H_UFLOAT = 0x0000006C,
643 VK_FORMAT_BC6H_SFLOAT = 0x0000006D,
644 VK_FORMAT_BC7_UNORM = 0x0000006E,
645 VK_FORMAT_BC7_SRGB = 0x0000006F,
646 VK_FORMAT_ETC2_R8G8B8_UNORM = 0x00000070,
647 VK_FORMAT_ETC2_R8G8B8_SRGB = 0x00000071,
648 VK_FORMAT_ETC2_R8G8B8A1_UNORM = 0x00000072,
649 VK_FORMAT_ETC2_R8G8B8A1_SRGB = 0x00000073,
650 VK_FORMAT_ETC2_R8G8B8A8_UNORM = 0x00000074,
651 VK_FORMAT_ETC2_R8G8B8A8_SRGB = 0x00000075,
652 VK_FORMAT_EAC_R11_UNORM = 0x00000076,
653 VK_FORMAT_EAC_R11_SNORM = 0x00000077,
654 VK_FORMAT_EAC_R11G11_UNORM = 0x00000078,
655 VK_FORMAT_EAC_R11G11_SNORM = 0x00000079,
656 VK_FORMAT_ASTC_4x4_UNORM = 0x0000007A,
657 VK_FORMAT_ASTC_4x4_SRGB = 0x0000007B,
658 VK_FORMAT_ASTC_5x4_UNORM = 0x0000007C,
659 VK_FORMAT_ASTC_5x4_SRGB = 0x0000007D,
660 VK_FORMAT_ASTC_5x5_UNORM = 0x0000007E,
661 VK_FORMAT_ASTC_5x5_SRGB = 0x0000007F,
662 VK_FORMAT_ASTC_6x5_UNORM = 0x00000080,
663 VK_FORMAT_ASTC_6x5_SRGB = 0x00000081,
664 VK_FORMAT_ASTC_6x6_UNORM = 0x00000082,
665 VK_FORMAT_ASTC_6x6_SRGB = 0x00000083,
666 VK_FORMAT_ASTC_8x5_UNORM = 0x00000084,
667 VK_FORMAT_ASTC_8x5_SRGB = 0x00000085,
668 VK_FORMAT_ASTC_8x6_UNORM = 0x00000086,
669 VK_FORMAT_ASTC_8x6_SRGB = 0x00000087,
670 VK_FORMAT_ASTC_8x8_UNORM = 0x00000088,
671 VK_FORMAT_ASTC_8x8_SRGB = 0x00000089,
672 VK_FORMAT_ASTC_10x5_UNORM = 0x0000008A,
673 VK_FORMAT_ASTC_10x5_SRGB = 0x0000008B,
674 VK_FORMAT_ASTC_10x6_UNORM = 0x0000008C,
675 VK_FORMAT_ASTC_10x6_SRGB = 0x0000008D,
676 VK_FORMAT_ASTC_10x8_UNORM = 0x0000008E,
677 VK_FORMAT_ASTC_10x8_SRGB = 0x0000008F,
678 VK_FORMAT_ASTC_10x10_UNORM = 0x00000090,
679 VK_FORMAT_ASTC_10x10_SRGB = 0x00000091,
680 VK_FORMAT_ASTC_12x10_UNORM = 0x00000092,
681 VK_FORMAT_ASTC_12x10_SRGB = 0x00000093,
682 VK_FORMAT_ASTC_12x12_UNORM = 0x00000094,
683 VK_FORMAT_ASTC_12x12_SRGB = 0x00000095,
684 VK_FORMAT_B4G4R4A4_UNORM = 0x00000096,
685 VK_FORMAT_B5G5R5A1_UNORM = 0x00000097,
686 VK_FORMAT_B5G6R5_UNORM = 0x00000098,
687 VK_FORMAT_B5G6R5_USCALED = 0x00000099,
688 VK_FORMAT_B8G8R8_UNORM = 0x0000009A,
689 VK_FORMAT_B8G8R8_SNORM = 0x0000009B,
690 VK_FORMAT_B8G8R8_USCALED = 0x0000009C,
691 VK_FORMAT_B8G8R8_SSCALED = 0x0000009D,
692 VK_FORMAT_B8G8R8_UINT = 0x0000009E,
693 VK_FORMAT_B8G8R8_SINT = 0x0000009F,
694 VK_FORMAT_B8G8R8_SRGB = 0x000000A0,
695 VK_FORMAT_B8G8R8A8_UNORM = 0x000000A1,
696 VK_FORMAT_B8G8R8A8_SNORM = 0x000000A2,
697 VK_FORMAT_B8G8R8A8_USCALED = 0x000000A3,
698 VK_FORMAT_B8G8R8A8_SSCALED = 0x000000A4,
699 VK_FORMAT_B8G8R8A8_UINT = 0x000000A5,
700 VK_FORMAT_B8G8R8A8_SINT = 0x000000A6,
701 VK_FORMAT_B8G8R8A8_SRGB = 0x000000A7,
702 VK_FORMAT_B10G10R10A2_UNORM = 0x000000A8,
703 VK_FORMAT_B10G10R10A2_SNORM = 0x000000A9,
704 VK_FORMAT_B10G10R10A2_USCALED = 0x000000AA,
705 VK_FORMAT_B10G10R10A2_SSCALED = 0x000000AB,
706 VK_FORMAT_B10G10R10A2_UINT = 0x000000AC,
707 VK_FORMAT_B10G10R10A2_SINT = 0x000000AD,
708
709 VK_ENUM_RANGE(FORMAT, UNDEFINED, B10G10R10A2_SINT)
710} VkFormat;
711
712// Shader stage enumerant
713typedef enum VkShaderStage_
714{
715 VK_SHADER_STAGE_VERTEX = 0,
716 VK_SHADER_STAGE_TESS_CONTROL = 1,
717 VK_SHADER_STAGE_TESS_EVALUATION = 2,
718 VK_SHADER_STAGE_GEOMETRY = 3,
719 VK_SHADER_STAGE_FRAGMENT = 4,
720 VK_SHADER_STAGE_COMPUTE = 5,
721
722 VK_ENUM_RANGE(SHADER_STAGE, VERTEX, COMPUTE)
723} VkShaderStage;
724
725// Structure type enumerant
726typedef enum VkStructureType_
727{
Tony Barbour04ee6b92015-06-26 15:02:35 -0600728 VK_STRUCTURE_TYPE_APPLICATION_INFO = 0,
729 VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO = 1,
730 VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO = 2,
731 VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO = 3,
732 VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO = 4,
733 VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO = 5,
734 VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO = 6,
735 VK_STRUCTURE_TYPE_SHADER_CREATE_INFO = 7,
736 VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO = 8,
737 VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO = 9,
738 VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO = 10,
739 VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO = 11,
740 VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO = 12,
741 VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO = 13,
742 VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO = 14,
743 VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO = 15,
744 VK_STRUCTURE_TYPE_EVENT_CREATE_INFO = 16,
745 VK_STRUCTURE_TYPE_FENCE_CREATE_INFO = 17,
746 VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO = 18,
747 VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO = 19,
748 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO = 20,
749 VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO = 21,
750 VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO = 22,
751 VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO = 23,
752 VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO = 24,
753 VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO = 25,
754 VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO = 26,
755 VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO = 27,
756 VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO = 28,
757 VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO = 29,
758 VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO = 30,
759 VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO = 31,
760 VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO = 32,
761 VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO = 33,
762 VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO = 34,
763 VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO = 35,
764 VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO = 36,
765 VK_STRUCTURE_TYPE_MEMORY_BARRIER = 37,
766 VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER = 38,
767 VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER = 39,
768 VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO = 40,
769 VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET = 41,
770 VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET = 42,
771 VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO = 43,
772 VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO = 44,
773 VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES = 45,
Tony Barbour8205d902015-04-16 15:59:00 -0600774
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600775 VK_ENUM_RANGE(STRUCTURE_TYPE, APPLICATION_INFO, EXTENSION_PROPERTIES)
Tony Barbour8205d902015-04-16 15:59:00 -0600776} VkStructureType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600777
Mike Stroyan230e6252015-04-17 12:36:38 -0600778// Object type enumerant
779typedef enum VkObjectType_
780{
781 VK_OBJECT_TYPE_INSTANCE = 0,
782 VK_OBJECT_TYPE_PHYSICAL_DEVICE = 1,
783 VK_OBJECT_TYPE_DEVICE = 2,
784 VK_OBJECT_TYPE_QUEUE = 3,
785 VK_OBJECT_TYPE_COMMAND_BUFFER = 4,
786 VK_OBJECT_TYPE_DEVICE_MEMORY = 5,
787 VK_OBJECT_TYPE_BUFFER = 6,
788 VK_OBJECT_TYPE_BUFFER_VIEW = 7,
789 VK_OBJECT_TYPE_IMAGE = 8,
790 VK_OBJECT_TYPE_IMAGE_VIEW = 9,
791 VK_OBJECT_TYPE_COLOR_ATTACHMENT_VIEW = 10,
792 VK_OBJECT_TYPE_DEPTH_STENCIL_VIEW = 11,
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -0600793 VK_OBJECT_TYPE_SHADER_MODULE = 12,
794 VK_OBJECT_TYPE_SHADER = 13,
795 VK_OBJECT_TYPE_PIPELINE = 14,
796 VK_OBJECT_TYPE_PIPELINE_LAYOUT = 15,
797 VK_OBJECT_TYPE_SAMPLER = 16,
798 VK_OBJECT_TYPE_DESCRIPTOR_SET = 17,
799 VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT = 18,
800 VK_OBJECT_TYPE_DESCRIPTOR_POOL = 19,
801 VK_OBJECT_TYPE_DYNAMIC_VP_STATE = 20,
802 VK_OBJECT_TYPE_DYNAMIC_RS_STATE = 21,
803 VK_OBJECT_TYPE_DYNAMIC_CB_STATE = 22,
804 VK_OBJECT_TYPE_DYNAMIC_DS_STATE = 23,
805 VK_OBJECT_TYPE_FENCE = 24,
806 VK_OBJECT_TYPE_SEMAPHORE = 25,
807 VK_OBJECT_TYPE_EVENT = 26,
808 VK_OBJECT_TYPE_QUERY_POOL = 27,
809 VK_OBJECT_TYPE_FRAMEBUFFER = 28,
810 VK_OBJECT_TYPE_RENDER_PASS = 29,
Mike Stroyan230e6252015-04-17 12:36:38 -0600811
812 // Valid ranges for core Vulkan:
813 VK_OBJECT_TYPE_BEGIN_RANGE = VK_OBJECT_TYPE_INSTANCE,
814 VK_OBJECT_TYPE_END_RANGE = VK_OBJECT_TYPE_RENDER_PASS,
815 VK_NUM_OBJECT_TYPE = (VK_OBJECT_TYPE_END_RANGE - VK_OBJECT_TYPE_BEGIN_RANGE + 1),
816 VK_MAX_ENUM(VkObjectType)
817} VkObjectType;
818
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600819// ------------------------------------------------------------------------------------------------
820// Error and return codes
821
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600822typedef enum VkResult_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600823{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600824 // Return codes for successful operation execution (> = 0)
825 VK_SUCCESS = 0x0000000,
826 VK_UNSUPPORTED = 0x0000001,
827 VK_NOT_READY = 0x0000002,
828 VK_TIMEOUT = 0x0000003,
829 VK_EVENT_SET = 0x0000004,
830 VK_EVENT_RESET = 0x0000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600831
832 // Error codes (negative values)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600833 VK_ERROR_UNKNOWN = -(0x00000001),
834 VK_ERROR_UNAVAILABLE = -(0x00000002),
835 VK_ERROR_INITIALIZATION_FAILED = -(0x00000003),
Tony Barbour8205d902015-04-16 15:59:00 -0600836 VK_ERROR_OUT_OF_HOST_MEMORY = -(0x00000004),
837 VK_ERROR_OUT_OF_DEVICE_MEMORY = -(0x00000005),
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600838 VK_ERROR_DEVICE_ALREADY_CREATED = -(0x00000006),
839 VK_ERROR_DEVICE_LOST = -(0x00000007),
840 VK_ERROR_INVALID_POINTER = -(0x00000008),
841 VK_ERROR_INVALID_VALUE = -(0x00000009),
842 VK_ERROR_INVALID_HANDLE = -(0x0000000A),
843 VK_ERROR_INVALID_ORDINAL = -(0x0000000B),
844 VK_ERROR_INVALID_MEMORY_SIZE = -(0x0000000C),
845 VK_ERROR_INVALID_EXTENSION = -(0x0000000D),
846 VK_ERROR_INVALID_FLAGS = -(0x0000000E),
847 VK_ERROR_INVALID_ALIGNMENT = -(0x0000000F),
848 VK_ERROR_INVALID_FORMAT = -(0x00000010),
849 VK_ERROR_INVALID_IMAGE = -(0x00000011),
850 VK_ERROR_INVALID_DESCRIPTOR_SET_DATA = -(0x00000012),
851 VK_ERROR_INVALID_QUEUE_TYPE = -(0x00000013),
852 VK_ERROR_INVALID_OBJECT_TYPE = -(0x00000014),
853 VK_ERROR_UNSUPPORTED_SHADER_IL_VERSION = -(0x00000015),
854 VK_ERROR_BAD_SHADER_CODE = -(0x00000016),
855 VK_ERROR_BAD_PIPELINE_DATA = -(0x00000017),
Courtney Goeltzenleuchterac834522015-05-01 17:56:13 -0600856 VK_ERROR_NOT_MAPPABLE = -(0x00000018),
857 VK_ERROR_MEMORY_MAP_FAILED = -(0x00000019),
858 VK_ERROR_MEMORY_UNMAP_FAILED = -(0x0000001A),
859 VK_ERROR_INCOMPATIBLE_DEVICE = -(0x0000001B),
860 VK_ERROR_INCOMPATIBLE_DRIVER = -(0x0000001C),
861 VK_ERROR_INCOMPLETE_COMMAND_BUFFER = -(0x0000001D),
862 VK_ERROR_BUILDING_COMMAND_BUFFER = -(0x0000001E),
863 VK_ERROR_MEMORY_NOT_BOUND = -(0x0000001F),
864 VK_ERROR_INCOMPATIBLE_QUEUE = -(0x00000020),
Tony Barbour8205d902015-04-16 15:59:00 -0600865
866 VK_MAX_ENUM(RESULT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600867} VkResult;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600868
869// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600870// Flags
871
872// Device creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600873typedef VkFlags VkDeviceCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600874
875// Queue capabilities
Tony Barbour8205d902015-04-16 15:59:00 -0600876typedef VkFlags VkQueueFlags;
877typedef enum VkQueueFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600878{
Tony Barbour8205d902015-04-16 15:59:00 -0600879 VK_QUEUE_GRAPHICS_BIT = VK_BIT(0), // Queue supports graphics operations
880 VK_QUEUE_COMPUTE_BIT = VK_BIT(1), // Queue supports compute operations
881 VK_QUEUE_DMA_BIT = VK_BIT(2), // Queue supports DMA operations
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500882 VK_QUEUE_SPARSE_MEMMGR_BIT = VK_BIT(3), // Queue supports sparse resource memory management operations
Tony Barbour8205d902015-04-16 15:59:00 -0600883 VK_QUEUE_EXTENDED_BIT = VK_BIT(30), // Extended queue
884} VkQueueFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600885
Tony Barbour8205d902015-04-16 15:59:00 -0600886// Memory properties passed into vkAllocMemory().
887typedef VkFlags VkMemoryPropertyFlags;
888typedef enum VkMemoryPropertyFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600889{
Tony Barbour8205d902015-04-16 15:59:00 -0600890 VK_MEMORY_PROPERTY_DEVICE_ONLY = 0, // If otherwise stated, then allocate memory on device
891 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT = VK_BIT(0), // Memory should be mappable by host
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600892 VK_MEMORY_PROPERTY_HOST_NON_COHERENT_BIT = VK_BIT(1), // Memory may not have i/o coherency so vkFlushMappedMemoryRanges and
893 // vkInvalidateMappedMemoryRanges must be used flush/invalidate host cache
Tony Barbour8205d902015-04-16 15:59:00 -0600894 VK_MEMORY_PROPERTY_HOST_UNCACHED_BIT = VK_BIT(2), // Memory should not be cached by the host
895 VK_MEMORY_PROPERTY_HOST_WRITE_COMBINED_BIT = VK_BIT(3), // Memory should support host write combining
896 VK_MEMORY_PROPERTY_PREFER_HOST_LOCAL = VK_BIT(4), // If set, prefer host access
Tony Barbour8205d902015-04-16 15:59:00 -0600897} VkMemoryPropertyFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600898
Tony Barbour8205d902015-04-16 15:59:00 -0600899// Memory output flags passed to resource transition commands
900typedef VkFlags VkMemoryOutputFlags;
901typedef enum VkMemoryOutputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600902{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600903 VK_MEMORY_OUTPUT_HOST_WRITE_BIT = VK_BIT(0), // Controls output coherency of host writes
Tony Barbour8205d902015-04-16 15:59:00 -0600904 VK_MEMORY_OUTPUT_SHADER_WRITE_BIT = VK_BIT(1), // Controls output coherency of generic shader writes
905 VK_MEMORY_OUTPUT_COLOR_ATTACHMENT_BIT = VK_BIT(2), // Controls output coherency of color attachment writes
906 VK_MEMORY_OUTPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(3), // Controls output coherency of depth/stencil attachment writes
907 VK_MEMORY_OUTPUT_TRANSFER_BIT = VK_BIT(4), // Controls output coherency of transfer operations
908} VkMemoryOutputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600909
Tony Barbour8205d902015-04-16 15:59:00 -0600910// Memory input flags passed to resource transition commands
911typedef VkFlags VkMemoryInputFlags;
912typedef enum VkMemoryInputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600913{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600914 VK_MEMORY_INPUT_HOST_READ_BIT = VK_BIT(0), // Controls input coherency of host reads
Tony Barbour8205d902015-04-16 15:59:00 -0600915 VK_MEMORY_INPUT_INDIRECT_COMMAND_BIT = VK_BIT(1), // Controls input coherency of indirect command reads
916 VK_MEMORY_INPUT_INDEX_FETCH_BIT = VK_BIT(2), // Controls input coherency of index fetches
917 VK_MEMORY_INPUT_VERTEX_ATTRIBUTE_FETCH_BIT = VK_BIT(3), // Controls input coherency of vertex attribute fetches
918 VK_MEMORY_INPUT_UNIFORM_READ_BIT = VK_BIT(4), // Controls input coherency of uniform buffer reads
919 VK_MEMORY_INPUT_SHADER_READ_BIT = VK_BIT(5), // Controls input coherency of generic shader reads
920 VK_MEMORY_INPUT_COLOR_ATTACHMENT_BIT = VK_BIT(6), // Controls input coherency of color attachment reads
921 VK_MEMORY_INPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(7), // Controls input coherency of depth/stencil attachment reads
922 VK_MEMORY_INPUT_TRANSFER_BIT = VK_BIT(8), // Controls input coherency of transfer operations
923} VkMemoryInputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600924
Tony Barbour8205d902015-04-16 15:59:00 -0600925// Buffer usage flags
926typedef VkFlags VkBufferUsageFlags;
927typedef enum VkBufferUsageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600928{
Tony Barbour8205d902015-04-16 15:59:00 -0600929 VK_BUFFER_USAGE_GENERAL = 0, // No special usage
930 VK_BUFFER_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
931 VK_BUFFER_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
932 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(2), // Can be used as TBO
933 VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(3), // Can be used as IBO
934 VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT = VK_BIT(4), // Can be used as UBO
935 VK_BUFFER_USAGE_STORAGE_BUFFER_BIT = VK_BIT(5), // Can be used as SSBO
936 VK_BUFFER_USAGE_INDEX_BUFFER_BIT = VK_BIT(6), // Can be used as source of fixed function index fetch (index buffer)
937 VK_BUFFER_USAGE_VERTEX_BUFFER_BIT = VK_BIT(7), // Can be used as source of fixed function vertex fetch (VBO)
938 VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT = VK_BIT(8), // Can be the source of indirect parameters (e.g. indirect buffer, parameter buffer)
939} VkBufferUsageFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600940
Tony Barbour8205d902015-04-16 15:59:00 -0600941// Buffer creation flags
942typedef VkFlags VkBufferCreateFlags;
943typedef enum VkBufferCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600944{
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600945 VK_BUFFER_CREATE_SPARSE_BIT = VK_BIT(0), // Buffer should support sparse backing
Tony Barbour8205d902015-04-16 15:59:00 -0600946} VkBufferCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600947
Tony Barbour8205d902015-04-16 15:59:00 -0600948// Shader stage flags
949typedef VkFlags VkShaderStageFlags;
950typedef enum VkShaderStageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600951{
Tony Barbour8205d902015-04-16 15:59:00 -0600952 VK_SHADER_STAGE_VERTEX_BIT = VK_BIT(0),
953 VK_SHADER_STAGE_TESS_CONTROL_BIT = VK_BIT(1),
954 VK_SHADER_STAGE_TESS_EVALUATION_BIT = VK_BIT(2),
955 VK_SHADER_STAGE_GEOMETRY_BIT = VK_BIT(3),
956 VK_SHADER_STAGE_FRAGMENT_BIT = VK_BIT(4),
957 VK_SHADER_STAGE_COMPUTE_BIT = VK_BIT(5),
958
959 VK_SHADER_STAGE_ALL = 0x7FFFFFFF,
960} VkShaderStageFlagBits;
961
962// Image usage flags
963typedef VkFlags VkImageUsageFlags;
964typedef enum VkImageUsageFlagBits_
965{
966 VK_IMAGE_USAGE_GENERAL = 0, // No special usage
967 VK_IMAGE_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
968 VK_IMAGE_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
969 VK_IMAGE_USAGE_SAMPLED_BIT = VK_BIT(2), // Can be sampled from (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
970 VK_IMAGE_USAGE_STORAGE_BIT = VK_BIT(3), // Can be used as storage image (STORAGE_IMAGE descriptor type)
971 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT = VK_BIT(4), // Can be used as framebuffer color attachment
972 VK_IMAGE_USAGE_DEPTH_STENCIL_BIT = VK_BIT(5), // Can be used as framebuffer depth/stencil attachment
973 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT = VK_BIT(6), // Image data not needed outside of rendering
974} VkImageUsageFlagBits;
975
976// Image creation flags
977typedef VkFlags VkImageCreateFlags;
978typedef enum VkImageCreateFlagBits_
979{
980 VK_IMAGE_CREATE_INVARIANT_DATA_BIT = VK_BIT(0),
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600981 VK_IMAGE_CREATE_SPARSE_BIT = VK_BIT(1), // Image should support sparse backing
982 VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT = VK_BIT(2), // Allows image views to have different format than the base image
983 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 -0600984} VkImageCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600985
986// Depth-stencil view creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600987typedef VkFlags VkDepthStencilViewCreateFlags;
988typedef enum VkDepthStencilViewCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600989{
Tony Barbour8205d902015-04-16 15:59:00 -0600990 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_DEPTH_BIT = VK_BIT(0),
991 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_STENCIL_BIT = VK_BIT(1),
992} VkDepthStencilViewCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600993
994// Pipeline creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600995typedef VkFlags VkPipelineCreateFlags;
996typedef enum VkPipelineCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600997{
Tony Barbour8205d902015-04-16 15:59:00 -0600998 VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT = VK_BIT(0),
999 VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT = VK_BIT(1),
1000} VkPipelineCreateFlagBits;
1001
1002// Channel flags
1003typedef VkFlags VkChannelFlags;
1004typedef enum VkChannelFlagBits_
1005{
1006 VK_CHANNEL_R_BIT = VK_BIT(0),
1007 VK_CHANNEL_G_BIT = VK_BIT(1),
1008 VK_CHANNEL_B_BIT = VK_BIT(2),
1009 VK_CHANNEL_A_BIT = VK_BIT(3),
1010} VkChannelFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001011
1012// Fence creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001013typedef VkFlags VkFenceCreateFlags;
1014typedef enum VkFenceCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001015{
Tony Barbour8205d902015-04-16 15:59:00 -06001016 VK_FENCE_CREATE_SIGNALED_BIT = VK_BIT(0),
1017} VkFenceCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001018
1019// Semaphore creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001020typedef VkFlags VkSemaphoreCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001021
1022// Format capability flags
Tony Barbour8205d902015-04-16 15:59:00 -06001023typedef VkFlags VkFormatFeatureFlags;
1024typedef enum VkFormatFeatureFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001025{
Tony Barbour8205d902015-04-16 15:59:00 -06001026 VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT = VK_BIT(0), // Format can be used for sampled images (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
1027 VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT = VK_BIT(1), // Format can be used for storage images (STORAGE_IMAGE descriptor type)
1028 VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT = VK_BIT(2), // Format supports atomic operations in case it's used for storage images
1029 VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(3), // Format can be used for uniform texel buffers (TBOs)
1030 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(4), // Format can be used for storage texel buffers (IBOs)
1031 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT = VK_BIT(5), // Format supports atomic operations in case it's used for storage texel buffers
1032 VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT = VK_BIT(6), // Format can be used for vertex buffers (VBOs)
1033 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT = VK_BIT(7), // Format can be used for color attachment images
1034 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT = VK_BIT(8), // Format supports blending in case it's used for color attachment images
1035 VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(9), // Format can be used for depth/stencil attachment images
1036 VK_FORMAT_FEATURE_CONVERSION_BIT = VK_BIT(10), // Format can be used as the source or destination of format converting blits
1037} VkFormatFeatureFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001038
Tony Barbourc2e987e2015-06-29 16:20:35 -06001039// Pipeline stage flags
1040typedef enum {
1041 VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT = VK_BIT(0),
1042 VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT = VK_BIT(1),
1043 VK_PIPELINE_STAGE_VERTEX_INPUT_BIT = VK_BIT(2),
1044 VK_PIPELINE_STAGE_VERTEX_SHADER_BIT = VK_BIT(3),
1045 VK_PIPELINE_STAGE_TESS_CONTROL_SHADER_BIT = VK_BIT(4),
1046 VK_PIPELINE_STAGE_TESS_EVALUATION_SHADER_BIT = VK_BIT(5),
1047 VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT = VK_BIT(6),
1048 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT = VK_BIT(7),
1049 VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT = VK_BIT(8),
1050 VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT = VK_BIT(9),
1051 VK_PIPELINE_STAGE_ATTACHMENT_OUTPUT_BIT = VK_BIT(10),
1052 VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT = VK_BIT(11),
1053 VK_PIPELINE_STAGE_TRANSFER_BIT = VK_BIT(12),
1054 VK_PIPELINE_STAGE_HOST_BIT = VK_BIT(13),
1055 VK_PIPELINE_STAGE_ALL_GRAPHICS = 0x000007FF,
1056 VK_PIPELINE_STAGE_ALL_GPU_COMMANDS = 0x00001FFF,
1057} VkPipelineStageFlagBits;
1058
1059typedef VkFlags VkPipelineStageFlags;
1060
Tony Barbour8205d902015-04-16 15:59:00 -06001061// Query control flags
1062typedef VkFlags VkQueryControlFlags;
1063typedef enum VkQueryControlFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001064{
Tony Barbour8205d902015-04-16 15:59:00 -06001065 VK_QUERY_CONTROL_CONSERVATIVE_BIT = VK_BIT(0), // Allow conservative results to be collected by the query
1066} VkQueryControlFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001067
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001068// Query result flags
Tony Barbour8205d902015-04-16 15:59:00 -06001069typedef VkFlags VkQueryResultFlags;
1070typedef enum VkQueryResultFlagBits_
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001071{
Courtney Goeltzenleuchterc0d0bb02015-06-09 08:45:23 -06001072 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 -06001073 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 -06001074 VK_QUERY_RESULT_WAIT_BIT = VK_BIT(1), // Results of the queries are waited on before proceeding with the result copy
1075 VK_QUERY_RESULT_WITH_AVAILABILITY_BIT = VK_BIT(2), // Besides the results of the query, the availability of the results is also written
1076 VK_QUERY_RESULT_PARTIAL_BIT = VK_BIT(3), // Copy the partial results of the query even if the final results aren't available
1077} VkQueryResultFlagBits;
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001078
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001079// Shader module creation flags
1080typedef VkFlags VkShaderModuleCreateFlags;
1081
Tony Barbour8205d902015-04-16 15:59:00 -06001082// Shader creation flags
1083typedef VkFlags VkShaderCreateFlags;
1084
1085// Event creation flags
1086typedef VkFlags VkEventCreateFlags;
1087
1088// Command buffer creation flags
1089typedef VkFlags VkCmdBufferCreateFlags;
1090
1091// Command buffer optimization flags
1092typedef VkFlags VkCmdBufferOptimizeFlags;
1093typedef enum VkCmdBufferOptimizeFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001094{
Tony Barbour8205d902015-04-16 15:59:00 -06001095 VK_CMD_BUFFER_OPTIMIZE_SMALL_BATCH_BIT = VK_BIT(0),
1096 VK_CMD_BUFFER_OPTIMIZE_PIPELINE_SWITCH_BIT = VK_BIT(1),
1097 VK_CMD_BUFFER_OPTIMIZE_ONE_TIME_SUBMIT_BIT = VK_BIT(2),
1098 VK_CMD_BUFFER_OPTIMIZE_DESCRIPTOR_SET_SWITCH_BIT = VK_BIT(3),
1099} VkCmdBufferOptimizeFlagBits;
1100
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001101// Pipeline statistics flags
1102typedef VkFlags VkQueryPipelineStatisticFlags;
1103typedef enum VkQueryPipelineStatisticFlagBits_ {
1104 VK_QUERY_PIPELINE_STATISTIC_IA_VERTICES_BIT = VK_BIT(0), // Optional
1105 VK_QUERY_PIPELINE_STATISTIC_IA_PRIMITIVES_BIT = VK_BIT(1), // Optional
1106 VK_QUERY_PIPELINE_STATISTIC_VS_INVOCATIONS_BIT = VK_BIT(2), // Optional
1107 VK_QUERY_PIPELINE_STATISTIC_GS_INVOCATIONS_BIT = VK_BIT(3), // Optional
1108 VK_QUERY_PIPELINE_STATISTIC_GS_PRIMITIVES_BIT = VK_BIT(4), // Optional
1109 VK_QUERY_PIPELINE_STATISTIC_C_INVOCATIONS_BIT = VK_BIT(5), // Optional
1110 VK_QUERY_PIPELINE_STATISTIC_C_PRIMITIVES_BIT = VK_BIT(6), // Optional
1111 VK_QUERY_PIPELINE_STATISTIC_FS_INVOCATIONS_BIT = VK_BIT(7), // Optional
1112 VK_QUERY_PIPELINE_STATISTIC_TCS_PATCHES_BIT = VK_BIT(8), // Optional
1113 VK_QUERY_PIPELINE_STATISTIC_TES_INVOCATIONS_BIT = VK_BIT(9), // Optional
1114 VK_QUERY_PIPELINE_STATISTIC_CS_INVOCATIONS_BIT = VK_BIT(10), // Optional
1115} VkQueryPipelineStatisticFlagBits;
1116
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001117// Memory mapping flags
1118typedef VkFlags VkMemoryMapFlags;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001119
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001120// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001121// Vulkan structures
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001122
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001123typedef struct VkOffset2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001124{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001125 int32_t x;
1126 int32_t y;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001127} VkOffset2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001128
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001129typedef struct VkOffset3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001130{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001131 int32_t x;
1132 int32_t y;
1133 int32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001134} VkOffset3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001135
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001136typedef struct VkExtent2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001137{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001138 int32_t width;
1139 int32_t height;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001140} VkExtent2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001141
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001142typedef struct VkExtent3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001143{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001144 int32_t width;
1145 int32_t height;
1146 int32_t depth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001147} VkExtent3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001148
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001149typedef struct VkViewport_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001150{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001151 float originX;
1152 float originY;
1153 float width;
1154 float height;
1155 float minDepth;
1156 float maxDepth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001157} VkViewport;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001158
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001159typedef struct VkRect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001160{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001161 VkOffset2D offset;
1162 VkExtent2D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001163} VkRect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001164
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001165typedef struct VkChannelMapping_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001166{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001167 VkChannelSwizzle r;
1168 VkChannelSwizzle g;
1169 VkChannelSwizzle b;
1170 VkChannelSwizzle a;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001171} VkChannelMapping;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001172
Tony Barbour8205d902015-04-16 15:59:00 -06001173typedef struct VkPhysicalDeviceProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001174{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001175 uint32_t apiVersion;
1176 uint32_t driverVersion;
1177 uint32_t vendorId;
1178 uint32_t deviceId;
Tony Barbour8205d902015-04-16 15:59:00 -06001179 VkPhysicalDeviceType deviceType;
1180 char deviceName[VK_MAX_PHYSICAL_DEVICE_NAME];
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001181 uint32_t maxBoundDescriptorSets;
1182 uint32_t maxThreadGroupSize;
1183 uint64_t timestampFrequency;
1184 bool32_t multiColorAttachmentClears;
1185 uint32_t maxDescriptorSets; // at least 2?
1186 uint32_t maxViewports; // at least 16?
1187 uint32_t maxColorAttachments; // at least 8?
Tony Barbour8205d902015-04-16 15:59:00 -06001188} VkPhysicalDeviceProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001189
Chris Forbesd7576302015-06-21 22:55:02 +12001190typedef struct VkPhysicalDeviceFeatures_
1191{
1192 // GFL_32 features
1193 bool32_t supportsGeometryShader;
1194 bool32_t supportsTessellationShader;
1195 bool32_t supportsSampleRateShading;
1196 bool32_t supportsFragmentSideEffects;
1197 bool32_t supportsConstantStorageBufferArrayIdexing;
1198 bool32_t supportsConstantStorageImageArrayIndexing;
1199 bool32_t supportsConstantUniformBufferArrayIndexing;
1200 bool32_t supportsDynamicSampledImageArrayIndexing;
1201 // GFL_45 features
1202 bool32_t supportsBlendSrc1;
1203 bool32_t supportsClipAndCullDistance;
1204 bool32_t supportsLogicOp;
1205 bool32_t supportsInstancedDrawIndirect;
1206 bool32_t supportsDepthClip;
1207 bool32_t supportsFillMode;
1208 bool32_t supportsStorageImageExtendedFormats;
1209 bool32_t supportsStorageImageMultisample;
1210 bool32_t supportsPipelineStatisticsQuery;
1211 bool32_t supportsVTGSideEffects;
1212 bool32_t supportsDynamicUniformBufferArrayIndexing;
1213 // optional features
1214 bool32_t supportsDynamicStorageBufferArrayIndexing;
1215 bool32_t supportsDynamicStorageImageArrayIndexing;
1216 bool32_t supportsShaderFloat64;
1217 bool32_t supportsDepthBounds;
1218 bool32_t supportsWideLines;
1219 bool32_t supportsTextureCompressionETC2;
1220 bool32_t supportsTextureCompressionASTC_LDR;
1221 bool32_t supportsTextureCompressionBC;
1222} VkPhysicalDeviceFeatures;
1223
1224typedef struct VkPhysicalDeviceLimits_
1225{
1226 uint32_t maxImageDimensions;
1227 uint32_t maxImageDepth;
1228 uint32_t maxImageArrayLayers;
1229 // <lots more>
1230} VkPhysicalDeviceLimits;
1231
1232
Tony Barbour8205d902015-04-16 15:59:00 -06001233typedef struct VkPhysicalDevicePerformance_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001234{
Tony Barbour8205d902015-04-16 15:59:00 -06001235 float maxDeviceClock;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001236 float aluPerClock;
1237 float texPerClock;
1238 float primsPerClock;
1239 float pixelsPerClock;
Tony Barbour8205d902015-04-16 15:59:00 -06001240} VkPhysicalDevicePerformance;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001241
Jon Ashburneb2728b2015-04-10 14:33:07 -06001242typedef struct VkExtensionProperties_
1243{
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001244 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES
1245 char name[VK_MAX_EXTENSION_NAME]; // extension name
Jon Ashburneb2728b2015-04-10 14:33:07 -06001246 uint32_t version; // version of the extension specification
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001247 char description[VK_MAX_EXTENSION_NAME]; // Name of library implementing this extension
Jon Ashburneb2728b2015-04-10 14:33:07 -06001248} VkExtensionProperties;
1249
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001250typedef struct VkApplicationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001251{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001252 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_APPLICATION_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001253 const void* pNext; // Next structure in chain
1254 const char* pAppName;
1255 uint32_t appVersion;
1256 const char* pEngineName;
1257 uint32_t engineVersion;
1258 uint32_t apiVersion;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001259} VkApplicationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001260
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001261typedef void* (VKAPI *PFN_vkAllocFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001262 void* pUserData,
1263 size_t size,
1264 size_t alignment,
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001265 VkSystemAllocType allocType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001266
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001267typedef void (VKAPI *PFN_vkFreeFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001268 void* pUserData,
1269 void* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001270
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001271typedef struct VkAllocCallbacks_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001272{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001273 void* pUserData;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001274 PFN_vkAllocFunction pfnAlloc;
1275 PFN_vkFreeFunction pfnFree;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001276} VkAllocCallbacks;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001277
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001278typedef struct VkDeviceQueueCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001279{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001280 uint32_t queueNodeIndex;
1281 uint32_t queueCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001282} VkDeviceQueueCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001283
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001284typedef struct VkDeviceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001285{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001286 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001287 const void* pNext; // Pointer to next structure
1288 uint32_t queueRecordCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001289 const VkDeviceQueueCreateInfo* pRequestedQueues;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001290 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001291 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Chris Forbesd7576302015-06-21 22:55:02 +12001292 const VkPhysicalDeviceFeatures* pEnabledFeatures;
Tony Barbour8205d902015-04-16 15:59:00 -06001293 VkDeviceCreateFlags flags; // Device creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001294} VkDeviceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001295
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001296typedef struct VkInstanceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001297{
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001298 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001299 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001300 const VkApplicationInfo* pAppInfo;
1301 const VkAllocCallbacks* pAllocCb;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001302 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001303 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001304} VkInstanceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001305
Tony Barbour8205d902015-04-16 15:59:00 -06001306typedef struct VkPhysicalDeviceQueueProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001307{
Tony Barbour8205d902015-04-16 15:59:00 -06001308 VkQueueFlags queueFlags; // Queue flags
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001309 uint32_t queueCount;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001310 bool32_t supportsTimestamps;
Tony Barbour8205d902015-04-16 15:59:00 -06001311} VkPhysicalDeviceQueueProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001312
Mark Lobodzinski72346292015-07-02 16:49:40 -06001313typedef struct VkMemoryType_
1314{
1315 VkMemoryPropertyFlags propertyFlags; // Memory properties of this memory type
1316 uint32_t heapIndex; // Index of the memory heap allocations of this memory type are taken from
1317} VkMemoryType;
1318
1319typedef struct VkMemoryHeap_
1320{
1321 VkDeviceSize size; // Available memory in the heap
1322} VkMemoryHeap;
1323
Tony Barbour8205d902015-04-16 15:59:00 -06001324typedef struct VkPhysicalDeviceMemoryProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001325{
Mark Lobodzinski72346292015-07-02 16:49:40 -06001326 uint32_t memoryTypeCount;
1327 VkMemoryType memoryTypes[VK_MAX_MEMORY_TYPES];
1328 uint32_t memoryHeapCount;
1329 VkMemoryHeap memoryHeaps[VK_MAX_MEMORY_HEAPS];
Tony Barbour8205d902015-04-16 15:59:00 -06001330} VkPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001331
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001332typedef struct VkMemoryAllocInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001333{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001334 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001335 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001336 VkDeviceSize allocationSize; // Size of memory allocation
Mark Lobodzinski72346292015-07-02 16:49:40 -06001337 uint32_t memoryTypeIndex; // Index of the memory type to allocate from
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001338} VkMemoryAllocInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001339
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06001340typedef struct VkMappedMemoryRange_
1341{
1342 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
1343 const void* pNext; // Pointer to next structure
1344 VkDeviceMemory mem; // Mapped memory object
1345 VkDeviceSize offset; // Offset within the mapped memory the range starts from
1346 VkDeviceSize size; // Size of the range within the mapped memory
1347} VkMappedMemoryRange;
1348
Mark Lobodzinski72346292015-07-02 16:49:40 -06001349typedef struct VkMemoryRequirements_
1350{
1351 VkDeviceSize size; // Specified in bytes
1352 VkDeviceSize alignment; // Specified in bytes
1353 VkDeviceSize granularity; // Granularity at which memory can be bound to resource sub-ranges specified in bytes (usually the page size)
1354 uint32_t memoryTypeBits; // Bitfield of the allowed memory type indices into memoryTypes[] for this object
1355} VkMemoryRequirements;
1356
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001357typedef struct VkFormatProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001358{
Tony Barbour8205d902015-04-16 15:59:00 -06001359 VkFormatFeatureFlags linearTilingFeatures; // Format features in case of linear tiling
1360 VkFormatFeatureFlags optimalTilingFeatures; // Format features in case of optimal tiling
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001361} VkFormatProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001362
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001363typedef struct VkDescriptorInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001364{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001365 VkBufferView bufferView; // Buffer view to write to the descriptor (in case it's a buffer descriptor, otherwise should be VK_NULL_HANDLE)
1366 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)
1367 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)
1368 VkImageLayout imageLayout; // Layout the image is expected to be in when accessed using this descriptor (only used if <imageView> is not VK_NULL_HANDLE)
1369} VkDescriptorInfo;
1370
1371typedef struct VkWriteDescriptorSet_
1372{
1373 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001374 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001375
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001376 VkDescriptorSet destSet; // Destination descriptor set
1377 uint32_t destBinding; // Binding within the destination descriptor set to write
1378 uint32_t destArrayElement; // Array element within the destination binding to write
1379
1380 uint32_t count; // Number of descriptors to write (determines the size of the array pointed by <pDescriptors>)
1381
1382 VkDescriptorType descriptorType; // Descriptor type to write (determines which fields of the array pointed by <pDescriptors> are going to be used)
1383 const VkDescriptorInfo* pDescriptors; // Array of info structures describing the descriptors to write
1384} VkWriteDescriptorSet;
1385
1386typedef struct VkCopyDescriptorSet_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001387{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001388 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001389 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001390
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001391 VkDescriptorSet srcSet; // Source descriptor set
1392 uint32_t srcBinding; // Binding within the source descriptor set to copy from
1393 uint32_t srcArrayElement; // Array element within the source binding to copy from
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001394
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001395 VkDescriptorSet destSet; // Destination descriptor set
1396 uint32_t destBinding; // Binding within the destination descriptor set to copy to
1397 uint32_t destArrayElement; // Array element within the destination binding to copy to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001398
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001399 uint32_t count; // Number of descriptors to copy
1400} VkCopyDescriptorSet;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001401
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001402typedef struct VkBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001403{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001404 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001405 const void* pNext; // Pointer to next structure.
Tony Barbour8205d902015-04-16 15:59:00 -06001406 VkDeviceSize size; // Specified in bytes
1407 VkBufferUsageFlags usage; // Buffer usage flags
1408 VkBufferCreateFlags flags; // Buffer creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001409} VkBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001410
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001411typedef struct VkBufferViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001412{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001413 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001414 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001415 VkBuffer buffer;
1416 VkBufferViewType viewType;
1417 VkFormat format; // Optionally specifies format of elements
Tony Barbour8205d902015-04-16 15:59:00 -06001418 VkDeviceSize offset; // Specified in bytes
1419 VkDeviceSize range; // View size specified in bytes
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001420} VkBufferViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001421
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001422typedef struct VkImageSubresource_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001423{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001424 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001425 uint32_t mipLevel;
1426 uint32_t arraySlice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001427} VkImageSubresource;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001428
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001429typedef struct VkImageSubresourceRange_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001430{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001431 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001432 uint32_t baseMipLevel;
1433 uint32_t mipLevels;
1434 uint32_t baseArraySlice;
1435 uint32_t arraySize;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001436} VkImageSubresourceRange;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001437
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001438typedef struct VkMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001439{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001440 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001441 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001442
Tony Barbour8205d902015-04-16 15:59:00 -06001443 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1444 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001445} VkMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001446
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001447typedef struct VkBufferMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001448{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001449 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001450 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001451
Tony Barbour8205d902015-04-16 15:59:00 -06001452 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1453 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001454
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001455 VkBuffer buffer; // Buffer to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001456
Tony Barbour8205d902015-04-16 15:59:00 -06001457 VkDeviceSize offset; // Offset within the buffer to sync
1458 VkDeviceSize size; // Amount of bytes to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001459} VkBufferMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001460
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001461typedef struct VkImageMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001462{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001463 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001464 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001465
Tony Barbour8205d902015-04-16 15:59:00 -06001466 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1467 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001468
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001469 VkImageLayout oldLayout; // Current layout of the image
1470 VkImageLayout newLayout; // New layout to transition the image to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001471
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001472 VkImage image; // Image to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001473
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001474 VkImageSubresourceRange subresourceRange; // Subresource range to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001475} VkImageMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001476
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001477typedef struct VkImageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001478{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001479 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001480 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001481 VkImageType imageType;
1482 VkFormat format;
1483 VkExtent3D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001484 uint32_t mipLevels;
1485 uint32_t arraySize;
1486 uint32_t samples;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001487 VkImageTiling tiling;
Tony Barbour8205d902015-04-16 15:59:00 -06001488 VkImageUsageFlags usage; // Image usage flags
1489 VkImageCreateFlags flags; // Image creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001490} VkImageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001491
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001492typedef struct VkSubresourceLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001493{
Tony Barbour8205d902015-04-16 15:59:00 -06001494 VkDeviceSize offset; // Specified in bytes
1495 VkDeviceSize size; // Specified in bytes
1496 VkDeviceSize rowPitch; // Specified in bytes
1497 VkDeviceSize depthPitch; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001498} VkSubresourceLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001499
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001500typedef struct VkImageViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001501{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001502 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001503 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001504 VkImage image;
1505 VkImageViewType viewType;
1506 VkFormat format;
1507 VkChannelMapping channels;
1508 VkImageSubresourceRange subresourceRange;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001509} VkImageViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001510
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001511typedef struct VkColorAttachmentViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001512{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001513 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001514 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001515 VkImage image;
1516 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001517 uint32_t mipLevel;
1518 uint32_t baseArraySlice;
1519 uint32_t arraySize;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001520 VkImage msaaResolveImage;
1521 VkImageSubresourceRange msaaResolveSubResource;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001522} VkColorAttachmentViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001523
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001524typedef struct VkDepthStencilViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001525{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001526 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001527 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001528 VkImage image;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001529 uint32_t mipLevel;
1530 uint32_t baseArraySlice;
1531 uint32_t arraySize;
Tony Barbour8205d902015-04-16 15:59:00 -06001532 VkDepthStencilViewCreateFlags flags; // Depth stencil attachment view flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001533} VkDepthStencilViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001534
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001535typedef struct VkColorAttachmentBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001536{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001537 VkColorAttachmentView view;
1538 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001539} VkColorAttachmentBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001540
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001541typedef struct VkDepthStencilBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001542{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001543 VkDepthStencilView view;
1544 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001545} VkDepthStencilBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001546
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001547typedef struct VkBufferCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001548{
Tony Barbour8205d902015-04-16 15:59:00 -06001549 VkDeviceSize srcOffset; // Specified in bytes
1550 VkDeviceSize destOffset; // Specified in bytes
1551 VkDeviceSize copySize; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001552} VkBufferCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001553
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001554typedef struct VkImageMemoryBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001555{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001556 VkImageSubresource subresource;
1557 VkOffset3D offset;
1558 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001559} VkImageMemoryBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001560
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001561typedef struct VkImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001562{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001563 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001564 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001565 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001566 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1567 VkExtent3D extent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001568} VkImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001569
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001570typedef struct VkImageBlit_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001571{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001572 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001573 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
1574 VkExtent3D srcExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001575 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001576 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1577 VkExtent3D destExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001578} VkImageBlit;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001579
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001580typedef struct VkBufferImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001581{
Tony Barbour8205d902015-04-16 15:59:00 -06001582 VkDeviceSize bufferOffset; // Specified in bytes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001583 VkImageSubresource imageSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001584 VkOffset3D imageOffset; // Specified in pixels for both compressed and uncompressed images
1585 VkExtent3D imageExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001586} VkBufferImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001587
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001588typedef struct VkImageResolve_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001589{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001590 VkImageSubresource srcSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001591 VkOffset3D srcOffset;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001592 VkImageSubresource destSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001593 VkOffset3D destOffset;
1594 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001595} VkImageResolve;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001596
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001597typedef struct VkShaderModuleCreateInfo_
1598{
1599 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
1600 const void* pNext; // Pointer to next structure
1601 size_t codeSize; // Specified in bytes
1602 const void* pCode; // Binary code of size codeSize
1603 VkShaderModuleCreateFlags flags; // Reserved
1604} VkShaderModuleCreateInfo;
1605
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001606typedef struct VkShaderCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001607{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001608 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001609 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001610 VkShaderModule module; // Module containing entry point
Courtney Goeltzenleuchter2d034fd2015-06-28 13:01:17 -06001611 const char* pName; // Null-terminate entry point name
Tony Barbour8205d902015-04-16 15:59:00 -06001612 VkShaderCreateFlags flags; // Reserved
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001613} VkShaderCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001614
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001615typedef struct VkDescriptorSetLayoutBinding_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001616{
Tony Barbour8205d902015-04-16 15:59:00 -06001617 VkDescriptorType descriptorType; // Type of the descriptors in this binding
Chia-I Wud3114a22015-05-25 16:22:52 +08001618 uint32_t arraySize; // Number of descriptors in this binding
Tony Barbour8205d902015-04-16 15:59:00 -06001619 VkShaderStageFlags stageFlags; // Shader stages this binding is visible to
1620 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 -06001621} VkDescriptorSetLayoutBinding;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001622
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001623typedef struct VkDescriptorSetLayoutCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001624{
Tony Barbour8205d902015-04-16 15:59:00 -06001625 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
1626 const void* pNext; // Pointer to next structure
1627 uint32_t count; // Number of bindings in the descriptor set layout
1628 const VkDescriptorSetLayoutBinding* pBinding; // Array of descriptor set layout bindings
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001629} VkDescriptorSetLayoutCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001630
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001631typedef struct VkDescriptorTypeCount_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001632{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001633 VkDescriptorType type;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001634 uint32_t count;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001635} VkDescriptorTypeCount;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001636
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001637typedef struct VkDescriptorPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001638{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001639 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001640 const void* pNext; // Pointer to next structure
1641 uint32_t count;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001642 const VkDescriptorTypeCount* pTypeCount;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001643} VkDescriptorPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001644
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001645typedef struct VkLinkConstBuffer_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001646{
1647 uint32_t bufferId;
1648 size_t bufferSize;
1649 const void* pBufferData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001650} VkLinkConstBuffer;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001651
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001652typedef struct VkSpecializationMapEntry_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001653{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001654 uint32_t constantId; // The SpecConstant ID specified in the BIL
1655 uint32_t offset; // Offset of the value in the data block
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001656} VkSpecializationMapEntry;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001657
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001658typedef struct VkSpecializationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001659{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001660 uint32_t mapEntryCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001661 const VkSpecializationMapEntry* pMap; // mapEntryCount entries
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001662 const void* pData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001663} VkSpecializationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001664
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001665typedef struct VkPipelineShaderStageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001666{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001667 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
1668 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001669 VkShaderStage stage;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001670 VkShader shader;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001671 uint32_t linkConstBufferCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001672 const VkLinkConstBuffer* pLinkConstBufferInfo;
1673 const VkSpecializationInfo* pSpecializationInfo;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001674} VkPipelineShaderStageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001675
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001676typedef struct VkComputePipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001677{
Tony Barbour8205d902015-04-16 15:59:00 -06001678 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
1679 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001680 VkPipelineShaderStageCreateInfo cs;
Tony Barbour8205d902015-04-16 15:59:00 -06001681 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001682 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001683} VkComputePipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001684
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001685typedef struct VkVertexInputBindingDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001686{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001687 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001688 uint32_t strideInBytes; // Distance between vertices in bytes (0 = no advancement)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001689
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001690 VkVertexInputStepRate stepRate; // Rate at which binding is incremented
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001691} VkVertexInputBindingDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001692
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001693typedef struct VkVertexInputAttributeDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001694{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001695 uint32_t location; // location of the shader vertex attrib
1696 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001697
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001698 VkFormat format; // format of source data
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001699
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001700 uint32_t offsetInBytes; // Offset of first element in bytes from base of vertex
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001701} VkVertexInputAttributeDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001702
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001703typedef struct VkPipelineVertexInputStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001704{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001705 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001706 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001707
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001708 uint32_t bindingCount; // number of bindings
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001709 const VkVertexInputBindingDescription* pVertexBindingDescriptions;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001710
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001711 uint32_t attributeCount; // number of attributes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001712 const VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001713} VkPipelineVertexInputStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001714
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001715typedef struct VkPipelineIaStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001716{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001717 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001718 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001719 VkPrimitiveTopology topology;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001720 bool32_t disableVertexReuse; // optional
1721 bool32_t primitiveRestartEnable;
1722 uint32_t primitiveRestartIndex; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001723} VkPipelineIaStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001724
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001725typedef struct VkPipelineTessStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001726{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001727 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001728 const void* pNext; // Pointer to next structure
1729 uint32_t patchControlPoints;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001730} VkPipelineTessStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001731
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001732typedef struct VkPipelineVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001733{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001734 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001735 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001736 uint32_t viewportCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001737 VkCoordinateOrigin clipOrigin; // optional (GL45)
1738 VkDepthMode depthMode; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001739} VkPipelineVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001740
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001741typedef struct VkPipelineRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001742{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001743 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001744 const void* pNext; // Pointer to next structure
1745 bool32_t depthClipEnable;
1746 bool32_t rasterizerDiscardEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001747 VkCoordinateOrigin pointOrigin; // optional (GL45)
Tony Barbour8205d902015-04-16 15:59:00 -06001748 VkProvokingVertex provokingVertex; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001749 VkFillMode fillMode; // optional (GL45)
1750 VkCullMode cullMode;
Tony Barbour8205d902015-04-16 15:59:00 -06001751 VkFrontFace frontFace;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001752} VkPipelineRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001753
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001754typedef struct VkPipelineMsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001755{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001756 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001757 const void* pNext; // Pointer to next structure
Tony Barboure094edf2015-06-26 10:18:34 -06001758 uint32_t rasterSamples;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001759 bool32_t multisampleEnable; // optional (GL45)
1760 bool32_t sampleShadingEnable; // optional (GL45)
1761 float minSampleShading; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001762 VkSampleMask sampleMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001763} VkPipelineMsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001764
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001765typedef struct VkPipelineCbAttachmentState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001766{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001767 bool32_t blendEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001768 VkFormat format;
1769 VkBlend srcBlendColor;
1770 VkBlend destBlendColor;
Tony Barbour8205d902015-04-16 15:59:00 -06001771 VkBlendOp blendOpColor;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001772 VkBlend srcBlendAlpha;
1773 VkBlend destBlendAlpha;
Tony Barbour8205d902015-04-16 15:59:00 -06001774 VkBlendOp blendOpAlpha;
1775 VkChannelFlags channelWriteMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001776} VkPipelineCbAttachmentState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001777
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001778typedef struct VkPipelineCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001779{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001780 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001781 const void* pNext; // Pointer to next structure
1782 bool32_t alphaToCoverageEnable;
1783 bool32_t logicOpEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001784 VkLogicOp logicOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001785 uint32_t attachmentCount; // # of pAttachments
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001786 const VkPipelineCbAttachmentState* pAttachments;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001787} VkPipelineCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001788
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001789typedef struct VkStencilOpState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001790{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001791 VkStencilOp stencilFailOp;
1792 VkStencilOp stencilPassOp;
1793 VkStencilOp stencilDepthFailOp;
Tony Barbour8205d902015-04-16 15:59:00 -06001794 VkCompareOp stencilCompareOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001795} VkStencilOpState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001796
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001797typedef struct VkPipelineDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001798{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001799 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001800 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001801 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001802 bool32_t depthTestEnable;
1803 bool32_t depthWriteEnable;
Tony Barbour8205d902015-04-16 15:59:00 -06001804 VkCompareOp depthCompareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001805 bool32_t depthBoundsEnable; // optional (depth_bounds_test)
1806 bool32_t stencilTestEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001807 VkStencilOpState front;
1808 VkStencilOpState back;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001809} VkPipelineDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001810
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001811typedef struct VkGraphicsPipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001812{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001813 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001814 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001815 uint32_t stageCount;
1816 const VkPipelineShaderStageCreateInfo* pStages; // One entry for each active shader stage
1817 const VkPipelineVertexInputStateCreateInfo* pVertexInputState;
1818 const VkPipelineIaStateCreateInfo* pIaState;
1819 const VkPipelineTessStateCreateInfo* pTessState;
1820 const VkPipelineVpStateCreateInfo* pVpState;
1821 const VkPipelineRsStateCreateInfo* pRsState;
1822 const VkPipelineMsStateCreateInfo* pMsState;
1823 const VkPipelineDsStateCreateInfo* pDsState;
1824 const VkPipelineCbStateCreateInfo* pCbState;
Tony Barbour8205d902015-04-16 15:59:00 -06001825 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001826 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001827} VkGraphicsPipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001828
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001829typedef struct VkPipelineLayoutCreateInfo_
1830{
1831 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
1832 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001833
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001834 uint32_t descriptorSetCount; // Number of descriptor sets interfaced by the pipeline
1835 const VkDescriptorSetLayout* pSetLayouts; // Array of <setCount> number of descriptor set layout objects defining the layout of the
1836} VkPipelineLayoutCreateInfo;
1837
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001838typedef struct VkSamplerCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001839{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001840 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001841 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001842 VkTexFilter magFilter; // Filter mode for magnification
1843 VkTexFilter minFilter; // Filter mode for minifiation
1844 VkTexMipmapMode mipMode; // Mipmap selection mode
1845 VkTexAddress addressU;
1846 VkTexAddress addressV;
1847 VkTexAddress addressW;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001848 float mipLodBias;
1849 uint32_t maxAnisotropy;
Tony Barbour8205d902015-04-16 15:59:00 -06001850 VkCompareOp compareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001851 float minLod;
1852 float maxLod;
Tony Barbour8205d902015-04-16 15:59:00 -06001853 VkBorderColor borderColor;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001854} VkSamplerCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001855
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001856typedef struct VkDynamicVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001857{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001858 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001859 const void* pNext; // Pointer to next structure
1860 uint32_t viewportAndScissorCount; // number of entries in pViewports and pScissors
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001861 const VkViewport* pViewports;
1862 const VkRect* pScissors;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001863} VkDynamicVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001864
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001865typedef struct VkDynamicRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001866{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001867 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001868 const void* pNext; // Pointer to next structure
1869 float depthBias;
1870 float depthBiasClamp;
1871 float slopeScaledDepthBias;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001872 float lineWidth; // optional (GL45) - Width of lines
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001873} VkDynamicRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001874
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001875typedef struct VkDynamicCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001876{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001877 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001878 const void* pNext; // Pointer to next structure
1879 float blendConst[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001880} VkDynamicCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001881
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001882typedef struct VkDynamicDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001883{
Mark Lobodzinski4405fbf2015-06-12 11:14:17 -06001884 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO
1885 const void* pNext; // Pointer to next structure
1886 float minDepthBounds; // optional (depth_bounds_test)
1887 float maxDepthBounds; // optional (depth_bounds_test)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001888 uint32_t stencilReadMask;
1889 uint32_t stencilWriteMask;
1890 uint32_t stencilFrontRef;
1891 uint32_t stencilBackRef;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001892} VkDynamicDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001893
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001894typedef struct VkCmdBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001895{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001896 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001897 const void* pNext; // Pointer to next structure
1898 uint32_t queueNodeIndex;
Tony Barbour8205d902015-04-16 15:59:00 -06001899 VkCmdBufferCreateFlags flags; // Command buffer creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001900} VkCmdBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001901
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001902typedef struct VkCmdBufferBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001903{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001904 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001905 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001906
Tony Barbour8205d902015-04-16 15:59:00 -06001907 VkCmdBufferOptimizeFlags flags; // Command buffer optimization flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001908} VkCmdBufferBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001909
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001910typedef struct VkRenderPassBegin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001911{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001912 VkRenderPass renderPass;
1913 VkFramebuffer framebuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001914} VkRenderPassBegin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001915
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001916typedef struct VkCmdBufferGraphicsBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001917{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001918 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001919 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001920
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001921 VkRenderPassBegin renderPassContinue; // Only needed when a render pass is split across two command buffers
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001922} VkCmdBufferGraphicsBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001923
1924// 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 -06001925typedef union VkClearColorValue_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001926{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001927 float floatColor[4];
1928 uint32_t rawColor[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001929} VkClearColorValue;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001930
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001931typedef struct VkClearColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001932{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001933 VkClearColorValue color;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001934 bool32_t useRawValue;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001935} VkClearColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001936
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001937typedef struct VkRenderPassCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001938{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001939 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001940 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001941
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001942 VkRect renderArea;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001943 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001944 VkExtent2D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001945 uint32_t sampleCount;
1946 uint32_t layers;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001947 const VkFormat* pColorFormats;
1948 const VkImageLayout* pColorLayouts;
1949 const VkAttachmentLoadOp* pColorLoadOps;
1950 const VkAttachmentStoreOp* pColorStoreOps;
1951 const VkClearColor* pColorLoadClearValues;
1952 VkFormat depthStencilFormat;
1953 VkImageLayout depthStencilLayout;
1954 VkAttachmentLoadOp depthLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001955 float depthLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001956 VkAttachmentStoreOp depthStoreOp;
1957 VkAttachmentLoadOp stencilLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001958 uint32_t stencilLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001959 VkAttachmentStoreOp stencilStoreOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001960} VkRenderPassCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001961
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001962typedef struct VkEventCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001963{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001964 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_EVENT_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001965 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001966 VkEventCreateFlags flags; // Event creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001967} VkEventCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001968
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001969typedef struct VkFenceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001970{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001971 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001972 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001973 VkFenceCreateFlags flags; // Fence creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001974} VkFenceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001975
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001976typedef struct VkSemaphoreCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001977{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001978 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001979 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001980 VkSemaphoreCreateFlags flags; // Semaphore creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001981} VkSemaphoreCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001982
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001983typedef struct VkQueryPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001984{
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001985 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO
1986 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001987 VkQueryType queryType;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001988 uint32_t slots;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001989 VkQueryPipelineStatisticFlags pipelineStatistics; // Optional
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001990} VkQueryPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001991
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001992typedef struct VkFramebufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001993{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001994 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001995 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001996
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001997 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001998 const VkColorAttachmentBindInfo* pColorAttachments;
1999 const VkDepthStencilBindInfo* pDepthStencilAttachment;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002000
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002001 uint32_t sampleCount;
2002 uint32_t width;
2003 uint32_t height;
2004 uint32_t layers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002005} VkFramebufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002006
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002007typedef struct VkDrawIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002008{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002009 uint32_t vertexCount;
2010 uint32_t instanceCount;
2011 uint32_t firstVertex;
2012 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002013} VkDrawIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002014
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002015typedef struct VkDrawIndexedIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002016{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002017 uint32_t indexCount;
2018 uint32_t instanceCount;
2019 uint32_t firstIndex;
2020 int32_t vertexOffset;
2021 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002022} VkDrawIndexedIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002023
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002024typedef struct VkDispatchIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002025{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002026 uint32_t x;
2027 uint32_t y;
2028 uint32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002029} VkDispatchIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002030
2031// ------------------------------------------------------------------------------------------------
2032// API functions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002033typedef VkResult (VKAPI *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance);
2034typedef VkResult (VKAPI *PFN_vkDestroyInstance)(VkInstance instance);
Tony Barbour8205d902015-04-16 15:59:00 -06002035typedef VkResult (VKAPI *PFN_vkEnumeratePhysicalDevices)(VkInstance instance, uint32_t* pPhysicalDeviceCount, VkPhysicalDevice* pPhysicalDevices);
Chris Forbesd7576302015-06-21 22:55:02 +12002036typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFeatures)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures);
2037typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFormatInfo)(VkPhysicalDevice physicalDevice, VkFormat format, VkFormatProperties *pFormatInfo);
2038typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceLimits)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceLimits* pLimits);
Jon Ashburn53c16772015-05-06 10:15:07 -06002039typedef void * (VKAPI *PFN_vkGetInstanceProcAddr)(VkInstance instance, const char * pName);
Jon Ashburn1245cec2015-05-18 13:20:15 -06002040typedef void * (VKAPI *PFN_vkGetDeviceProcAddr)(VkDevice device, const char * pName);
Tony Barbour8205d902015-04-16 15:59:00 -06002041typedef VkResult (VKAPI *PFN_vkCreateDevice)(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, VkDevice* pDevice);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002042typedef VkResult (VKAPI *PFN_vkDestroyDevice)(VkDevice device);
Tony Barbour426b9052015-06-24 16:06:58 -06002043typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties* pProperties);
2044typedef VkResult (VKAPI *PFN_vkGetPhysicalDevicePerformance)(VkPhysicalDevice physicalDevice, VkPhysicalDevicePerformance* pPerformance);
2045typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2046typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueProperties)(VkPhysicalDevice physicalDevice, uint32_t count, VkPhysicalDeviceQueueProperties* pQueueProperties);
2047typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceMemoryProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2048typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionCount)(uint32_t* pCount);
2049typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionProperties)(uint32_t extensionIndex, VkExtensionProperties* pProperties);
2050typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2051typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionProperties)(VkPhysicalDevice physicalDevice, uint32_t extensionIndex, VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002052typedef VkResult (VKAPI *PFN_vkGetDeviceQueue)(VkDevice device, uint32_t queueNodeIndex, uint32_t queueIndex, VkQueue* pQueue);
2053typedef VkResult (VKAPI *PFN_vkQueueSubmit)(VkQueue queue, uint32_t cmdBufferCount, const VkCmdBuffer* pCmdBuffers, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002054typedef VkResult (VKAPI *PFN_vkQueueWaitIdle)(VkQueue queue);
2055typedef VkResult (VKAPI *PFN_vkDeviceWaitIdle)(VkDevice device);
Tony Barbour8205d902015-04-16 15:59:00 -06002056typedef VkResult (VKAPI *PFN_vkAllocMemory)(VkDevice device, const VkMemoryAllocInfo* pAllocInfo, VkDeviceMemory* pMem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002057typedef VkResult (VKAPI *PFN_vkFreeMemory)(VkDevice device, VkDeviceMemory mem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002058typedef VkResult (VKAPI *PFN_vkMapMemory)(VkDevice device, VkDeviceMemory mem, VkDeviceSize offset, VkDeviceSize size, VkMemoryMapFlags flags, void** ppData);
2059typedef VkResult (VKAPI *PFN_vkUnmapMemory)(VkDevice device, VkDeviceMemory mem);
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002060typedef VkResult (VKAPI *PFN_vkFlushMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
2061typedef VkResult (VKAPI *PFN_vkInvalidateMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
Mike Stroyan230e6252015-04-17 12:36:38 -06002062typedef VkResult (VKAPI *PFN_vkDestroyObject)(VkDevice device, VkObjectType objType, VkObject object);
Tony Barbour426b9052015-06-24 16:06:58 -06002063typedef VkResult (VKAPI *PFN_vkGetObjectMemoryRequirements)(VkDevice device, VkObjectType objType, VkObject object, VkMemoryRequirements* pMemoryRequirements);
Mark Lobodzinski23182612015-05-29 09:32:35 -05002064typedef VkResult (VKAPI *PFN_vkBindObjectMemory)(VkDevice device, VkObjectType objType, VkObject object, VkDeviceMemory mem, VkDeviceSize offset);
2065typedef VkResult (VKAPI *PFN_vkQueueBindSparseBufferMemory)(VkQueue queue, VkBuffer buffer, VkDeviceSize rangeOffset, VkDeviceSize rangeSize, VkDeviceMemory mem, VkDeviceSize memOffset);
2066typedef VkResult (VKAPI *PFN_vkQueueBindSparseImageMemory)(VkQueue queue, VkImage image, const VkImageMemoryBindInfo* pBindInfo, VkDeviceMemory mem, VkDeviceSize memOffset);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002067typedef VkResult (VKAPI *PFN_vkCreateFence)(VkDevice device, const VkFenceCreateInfo* pCreateInfo, VkFence* pFence);
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002068typedef VkResult (VKAPI *PFN_vkResetFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences);
Mike Stroyan230e6252015-04-17 12:36:38 -06002069typedef VkResult (VKAPI *PFN_vkGetFenceStatus)(VkDevice device, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002070typedef VkResult (VKAPI *PFN_vkWaitForFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences, bool32_t waitAll, uint64_t timeout);
2071typedef VkResult (VKAPI *PFN_vkCreateSemaphore)(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo, VkSemaphore* pSemaphore);
2072typedef VkResult (VKAPI *PFN_vkQueueSignalSemaphore)(VkQueue queue, VkSemaphore semaphore);
2073typedef VkResult (VKAPI *PFN_vkQueueWaitSemaphore)(VkQueue queue, VkSemaphore semaphore);
2074typedef VkResult (VKAPI *PFN_vkCreateEvent)(VkDevice device, const VkEventCreateInfo* pCreateInfo, VkEvent* pEvent);
Mike Stroyan230e6252015-04-17 12:36:38 -06002075typedef VkResult (VKAPI *PFN_vkGetEventStatus)(VkDevice device, VkEvent event);
2076typedef VkResult (VKAPI *PFN_vkSetEvent)(VkDevice device, VkEvent event);
2077typedef VkResult (VKAPI *PFN_vkResetEvent)(VkDevice device, VkEvent event);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002078typedef VkResult (VKAPI *PFN_vkCreateQueryPool)(VkDevice device, const VkQueryPoolCreateInfo* pCreateInfo, VkQueryPool* pQueryPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002079typedef 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 -06002080typedef VkResult (VKAPI *PFN_vkCreateBuffer)(VkDevice device, const VkBufferCreateInfo* pCreateInfo, VkBuffer* pBuffer);
2081typedef VkResult (VKAPI *PFN_vkCreateBufferView)(VkDevice device, const VkBufferViewCreateInfo* pCreateInfo, VkBufferView* pView);
2082typedef VkResult (VKAPI *PFN_vkCreateImage)(VkDevice device, const VkImageCreateInfo* pCreateInfo, VkImage* pImage);
Tony Barbour426b9052015-06-24 16:06:58 -06002083typedef VkResult (VKAPI *PFN_vkGetImageSubresourceLayout)(VkDevice device, VkImage image, const VkImageSubresource* pSubresource, VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002084typedef VkResult (VKAPI *PFN_vkCreateImageView)(VkDevice device, const VkImageViewCreateInfo* pCreateInfo, VkImageView* pView);
2085typedef VkResult (VKAPI *PFN_vkCreateColorAttachmentView)(VkDevice device, const VkColorAttachmentViewCreateInfo* pCreateInfo, VkColorAttachmentView* pView);
2086typedef VkResult (VKAPI *PFN_vkCreateDepthStencilView)(VkDevice device, const VkDepthStencilViewCreateInfo* pCreateInfo, VkDepthStencilView* pView);
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002087typedef VkResult (VKAPI *PFN_vkCreateShaderModule)(VkDevice device, const VkShaderModuleCreateInfo* pCreateInfo, VkShaderModule* pShaderModule);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002088typedef VkResult (VKAPI *PFN_vkCreateShader)(VkDevice device, const VkShaderCreateInfo* pCreateInfo, VkShader* pShader);
2089typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipeline)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
2090typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipelineDerivative)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline basePipeline, VkPipeline* pPipeline);
2091typedef VkResult (VKAPI *PFN_vkCreateComputePipeline)(VkDevice device, const VkComputePipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
Mike Stroyan230e6252015-04-17 12:36:38 -06002092typedef VkResult (VKAPI *PFN_vkStorePipeline)(VkDevice device, VkPipeline pipeline, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002093typedef VkResult (VKAPI *PFN_vkLoadPipeline)(VkDevice device, size_t dataSize, const void* pData, VkPipeline* pPipeline);
2094typedef VkResult (VKAPI *PFN_vkLoadPipelineDerivative)(VkDevice device, size_t dataSize, const void* pData, VkPipeline basePipeline, VkPipeline* pPipeline);
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002095typedef VkResult (VKAPI *PFN_vkCreatePipelineLayout)(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo, VkPipelineLayout* pPipelineLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002096typedef VkResult (VKAPI *PFN_vkCreateSampler)(VkDevice device, const VkSamplerCreateInfo* pCreateInfo, VkSampler* pSampler);
2097typedef VkResult (VKAPI *PFN_vkCreateDescriptorSetLayout)(VkDevice device, const VkDescriptorSetLayoutCreateInfo* pCreateInfo, VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002098typedef VkResult (VKAPI *PFN_vkCreateDescriptorPool)(VkDevice device, VkDescriptorPoolUsage poolUsage, uint32_t maxSets, const VkDescriptorPoolCreateInfo* pCreateInfo, VkDescriptorPool* pDescriptorPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002099typedef VkResult (VKAPI *PFN_vkResetDescriptorPool)(VkDevice device, VkDescriptorPool descriptorPool);
2100typedef 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 +08002101typedef 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 -06002102typedef VkResult (VKAPI *PFN_vkCreateDynamicViewportState)(VkDevice device, const VkDynamicVpStateCreateInfo* pCreateInfo, VkDynamicVpState* pState);
2103typedef VkResult (VKAPI *PFN_vkCreateDynamicRasterState)(VkDevice device, const VkDynamicRsStateCreateInfo* pCreateInfo, VkDynamicRsState* pState);
2104typedef VkResult (VKAPI *PFN_vkCreateDynamicColorBlendState)(VkDevice device, const VkDynamicCbStateCreateInfo* pCreateInfo, VkDynamicCbState* pState);
2105typedef VkResult (VKAPI *PFN_vkCreateDynamicDepthStencilState)(VkDevice device, const VkDynamicDsStateCreateInfo* pCreateInfo, VkDynamicDsState* pState);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002106typedef VkResult (VKAPI *PFN_vkCreateCommandBuffer)(VkDevice device, const VkCmdBufferCreateInfo* pCreateInfo, VkCmdBuffer* pCmdBuffer);
2107typedef VkResult (VKAPI *PFN_vkBeginCommandBuffer)(VkCmdBuffer cmdBuffer, const VkCmdBufferBeginInfo* pBeginInfo);
2108typedef VkResult (VKAPI *PFN_vkEndCommandBuffer)(VkCmdBuffer cmdBuffer);
2109typedef VkResult (VKAPI *PFN_vkResetCommandBuffer)(VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002110typedef void (VKAPI *PFN_vkCmdBindPipeline)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, VkPipeline pipeline);
2111typedef void (VKAPI *PFN_vkCmdBindDynamicStateObject)(VkCmdBuffer cmdBuffer, VkStateBindPoint stateBindPoint, VkDynamicStateObject state);
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002112typedef 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 -06002113typedef void (VKAPI *PFN_vkCmdBindIndexBuffer)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, VkIndexType indexType);
2114typedef 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 -06002115typedef void (VKAPI *PFN_vkCmdDraw)(VkCmdBuffer cmdBuffer, uint32_t firstVertex, uint32_t vertexCount, uint32_t firstInstance, uint32_t instanceCount);
2116typedef 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 -06002117typedef void (VKAPI *PFN_vkCmdDrawIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
2118typedef void (VKAPI *PFN_vkCmdDrawIndexedIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002119typedef void (VKAPI *PFN_vkCmdDispatch)(VkCmdBuffer cmdBuffer, uint32_t x, uint32_t y, uint32_t z);
Tony Barbour8205d902015-04-16 15:59:00 -06002120typedef void (VKAPI *PFN_vkCmdDispatchIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002121typedef void (VKAPI *PFN_vkCmdCopyBuffer)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkBuffer destBuffer, uint32_t regionCount, const VkBufferCopy* pRegions);
2122typedef 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 -05002123typedef 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 -06002124typedef void (VKAPI *PFN_vkCmdCopyBufferToImage)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkBufferImageCopy* pRegions);
2125typedef 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 -06002126typedef void (VKAPI *PFN_vkCmdUpdateBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize dataSize, const uint32_t* pData);
2127typedef void (VKAPI *PFN_vkCmdFillBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize fillSize, uint32_t data);
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002128typedef 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 -06002129typedef 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 -06002130typedef void (VKAPI *PFN_vkCmdResolveImage)(VkCmdBuffer cmdBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkImageResolve* pRegions);
Tony Barbourc2e987e2015-06-29 16:20:35 -06002131typedef void (VKAPI *PFN_vkCmdSetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2132typedef void (VKAPI *PFN_vkCmdResetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2133typedef void (VKAPI *PFN_vkCmdWaitEvents)(VkCmdBuffer cmdBuffer, uint32_t eventCount, const VkEvent* pEvents, VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags destStageMask, uint32_t memBarrierCount, const void** ppMemBarriers);
2134typedef void (VKAPI *PFN_vkCmdPipelineBarrier)(VkCmdBuffer cmdBuffer, VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags destStageMask, bool32_t byRegion, uint32_t memBarrierCount, const void** ppMemBarriers);
Tony Barbour8205d902015-04-16 15:59:00 -06002135typedef void (VKAPI *PFN_vkCmdBeginQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot, VkQueryControlFlags flags);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002136typedef void (VKAPI *PFN_vkCmdEndQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot);
2137typedef void (VKAPI *PFN_vkCmdResetQueryPool)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount);
Tony Barbour8205d902015-04-16 15:59:00 -06002138typedef void (VKAPI *PFN_vkCmdWriteTimestamp)(VkCmdBuffer cmdBuffer, VkTimestampType timestampType, VkBuffer destBuffer, VkDeviceSize destOffset);
Tony Barbour3e3420a2015-04-16 19:09:28 -06002139typedef void (VKAPI *PFN_vkCmdCopyQueryPoolResults)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize destStride, VkQueryResultFlags flags);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002140typedef VkResult (VKAPI *PFN_vkCreateFramebuffer)(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo, VkFramebuffer* pFramebuffer);
2141typedef VkResult (VKAPI *PFN_vkCreateRenderPass)(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo, VkRenderPass* pRenderPass);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002142typedef void (VKAPI *PFN_vkCmdBeginRenderPass)(VkCmdBuffer cmdBuffer, const VkRenderPassBegin* pRenderPassBegin);
2143typedef void (VKAPI *PFN_vkCmdEndRenderPass)(VkCmdBuffer cmdBuffer, VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002144
2145#ifdef VK_PROTOTYPES
2146
Tony Barbour8205d902015-04-16 15:59:00 -06002147// Device initialization
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002148
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002149VkResult VKAPI vkCreateInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002150 const VkInstanceCreateInfo* pCreateInfo,
2151 VkInstance* pInstance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002152
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002153VkResult VKAPI vkDestroyInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002154 VkInstance instance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002155
Jon Ashburn07b309a2015-04-15 11:31:12 -06002156VkResult VKAPI vkEnumeratePhysicalDevices(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002157 VkInstance instance,
Jon Ashburn07b309a2015-04-15 11:31:12 -06002158 uint32_t* pPhysicalDeviceCount,
Tony Barbour8205d902015-04-16 15:59:00 -06002159 VkPhysicalDevice* pPhysicalDevices);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002160
Chris Forbesd7576302015-06-21 22:55:02 +12002161VkResult VKAPI vkGetPhysicalDeviceFeatures(
2162 VkPhysicalDevice physicalDevice,
2163 VkPhysicalDeviceFeatures* pFeatures);
2164
2165VkResult VKAPI vkGetPhysicalDeviceFormatInfo(
2166 VkPhysicalDevice physicalDevice,
2167 VkFormat format,
2168 VkFormatProperties* pFormatInfo);
2169
2170VkResult VKAPI vkGetPhysicalDeviceLimits(
2171 VkPhysicalDevice physicalDevice,
2172 VkPhysicalDeviceLimits* pLimits);
2173
Jon Ashburn53c16772015-05-06 10:15:07 -06002174void * VKAPI vkGetInstanceProcAddr(
2175 VkInstance instance,
2176 const char* pName);
2177
Jon Ashburn1245cec2015-05-18 13:20:15 -06002178void * VKAPI vkGetDeviceProcAddr(
2179 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002180 const char* pName);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002181// Device functions
2182
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002183VkResult VKAPI vkCreateDevice(
Tony Barbour8205d902015-04-16 15:59:00 -06002184 VkPhysicalDevice physicalDevice,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002185 const VkDeviceCreateInfo* pCreateInfo,
2186 VkDevice* pDevice);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002187
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002188VkResult VKAPI vkDestroyDevice(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002189 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002190
Tony Barbour426b9052015-06-24 16:06:58 -06002191VkResult VKAPI vkGetPhysicalDeviceProperties(
2192 VkPhysicalDevice physicalDevice,
2193 VkPhysicalDeviceProperties* pProperties);
2194
2195VkResult VKAPI vkGetPhysicalDevicePerformance(
2196 VkPhysicalDevice physicalDevice,
2197 VkPhysicalDevicePerformance* pPerformance);
2198
2199VkResult VKAPI vkGetPhysicalDeviceQueueCount(
2200 VkPhysicalDevice physicalDevice,
2201 uint32_t* pCount);
2202
2203VkResult VKAPI vkGetPhysicalDeviceQueueProperties(
2204 VkPhysicalDevice physicalDevice,
2205 uint32_t count,
2206 VkPhysicalDeviceQueueProperties* pQueueProperties);
2207
2208VkResult VKAPI vkGetPhysicalDeviceMemoryProperties(
2209 VkPhysicalDevice physicalDevice,
2210 VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2211
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002212// Extension discovery functions
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002213
Tony Barbour426b9052015-06-24 16:06:58 -06002214VkResult VKAPI vkGetGlobalExtensionCount(
2215 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002216
Tony Barbour426b9052015-06-24 16:06:58 -06002217VkResult VKAPI vkGetGlobalExtensionProperties(
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06002218 uint32_t extensionIndex,
Tony Barbour426b9052015-06-24 16:06:58 -06002219 VkExtensionProperties* pProperties);
2220
2221VkResult VKAPI vkGetPhysicalDeviceExtensionCount(
2222 VkPhysicalDevice physicalDevice,
2223 uint32_t* pCount);
2224
2225VkResult VKAPI vkGetPhysicalDeviceExtensionProperties(
2226 VkPhysicalDevice physicalDevice,
2227 uint32_t extensionIndex,
2228 VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002229
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002230// Queue functions
2231
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002232VkResult VKAPI vkGetDeviceQueue(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002233 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002234 uint32_t queueNodeIndex,
2235 uint32_t queueIndex,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002236 VkQueue* pQueue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002237
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002238VkResult VKAPI vkQueueSubmit(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002239 VkQueue queue,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002240 uint32_t cmdBufferCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002241 const VkCmdBuffer* pCmdBuffers,
2242 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002243
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002244VkResult VKAPI vkQueueWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002245 VkQueue queue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002246
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002247VkResult VKAPI vkDeviceWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002248 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002249
2250// Memory functions
2251
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002252VkResult VKAPI vkAllocMemory(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002253 VkDevice device,
2254 const VkMemoryAllocInfo* pAllocInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002255 VkDeviceMemory* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002256
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002257VkResult VKAPI vkFreeMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002258 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002259 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002260
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002261VkResult VKAPI vkMapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002262 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002263 VkDeviceMemory mem,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002264 VkDeviceSize offset,
2265 VkDeviceSize size,
Tony Barbour8205d902015-04-16 15:59:00 -06002266 VkMemoryMapFlags flags,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002267 void** ppData);
2268
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002269VkResult VKAPI vkUnmapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002270 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002271 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002272
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002273VkResult VKAPI vkFlushMappedMemoryRanges(
Mike Stroyan230e6252015-04-17 12:36:38 -06002274 VkDevice device,
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002275 uint32_t memRangeCount,
2276 const VkMappedMemoryRange* pMemRanges);
2277
2278VkResult VKAPI vkInvalidateMappedMemoryRanges(
2279 VkDevice device,
2280 uint32_t memRangeCount,
2281 const VkMappedMemoryRange* pMemRanges);
Tony Barbour859ceab2015-04-16 19:23:13 -06002282
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002283// Generic API object functions
2284
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002285VkResult VKAPI vkDestroyObject(
Mike Stroyan230e6252015-04-17 12:36:38 -06002286 VkDevice device,
2287 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002288 VkObject object);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002289
Tony Barbour3e3420a2015-04-16 19:09:28 -06002290// Memory management API functions
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002291
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002292VkResult VKAPI vkBindObjectMemory(
2293 VkDevice device,
Mike Stroyan230e6252015-04-17 12:36:38 -06002294 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002295 VkObject object,
Tony Barbour8205d902015-04-16 15:59:00 -06002296 VkDeviceMemory mem,
2297 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002298
Tony Barbour426b9052015-06-24 16:06:58 -06002299VkResult VKAPI vkGetObjectMemoryRequirements(
2300 VkDevice device,
2301 VkObjectType objType,
2302 VkObject object,
2303 VkMemoryRequirements* pMemoryRequirements);
2304
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002305VkResult VKAPI vkQueueBindSparseBufferMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002306 VkQueue queue,
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002307 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002308 VkDeviceSize rangeOffset,
2309 VkDeviceSize rangeSize,
2310 VkDeviceMemory mem,
2311 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002312
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002313VkResult VKAPI vkQueueBindSparseImageMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002314 VkQueue queue,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002315 VkImage image,
Jeremy Hayes47536532015-04-15 15:20:03 -06002316 const VkImageMemoryBindInfo* pBindInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002317 VkDeviceMemory mem,
2318 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002319
2320// Fence functions
2321
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002322VkResult VKAPI vkCreateFence(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002323 VkDevice device,
2324 const VkFenceCreateInfo* pCreateInfo,
2325 VkFence* pFence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002326
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002327VkResult VKAPI vkResetFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002328 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002329 uint32_t fenceCount,
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002330 const VkFence* pFences);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002331
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002332VkResult VKAPI vkGetFenceStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002333 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002334 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002335
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002336VkResult VKAPI vkWaitForFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002337 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002338 uint32_t fenceCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002339 const VkFence* pFences,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002340 bool32_t waitAll,
2341 uint64_t timeout); // timeout in nanoseconds
2342
2343// Queue semaphore functions
2344
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002345VkResult VKAPI vkCreateSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002346 VkDevice device,
2347 const VkSemaphoreCreateInfo* pCreateInfo,
2348 VkSemaphore* pSemaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002349
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002350VkResult VKAPI vkQueueSignalSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002351 VkQueue queue,
2352 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002353
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002354VkResult VKAPI vkQueueWaitSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002355 VkQueue queue,
2356 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002357
2358// Event functions
2359
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002360VkResult VKAPI vkCreateEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002361 VkDevice device,
2362 const VkEventCreateInfo* pCreateInfo,
2363 VkEvent* pEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002364
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002365VkResult VKAPI vkGetEventStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002366 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002367 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002368
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002369VkResult VKAPI vkSetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002370 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002371 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002372
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002373VkResult VKAPI vkResetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002374 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002375 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002376
2377// Query functions
2378
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002379VkResult VKAPI vkCreateQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002380 VkDevice device,
2381 const VkQueryPoolCreateInfo* pCreateInfo,
2382 VkQueryPool* pQueryPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002383
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002384VkResult VKAPI vkGetQueryPoolResults(
Mike Stroyan230e6252015-04-17 12:36:38 -06002385 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002386 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002387 uint32_t startQuery,
2388 uint32_t queryCount,
2389 size_t* pDataSize,
Tony Barbour8205d902015-04-16 15:59:00 -06002390 void* pData,
2391 VkQueryResultFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002392
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002393// Buffer functions
2394
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002395VkResult VKAPI vkCreateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002396 VkDevice device,
2397 const VkBufferCreateInfo* pCreateInfo,
2398 VkBuffer* pBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002399
2400// Buffer view functions
2401
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002402VkResult VKAPI vkCreateBufferView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002403 VkDevice device,
2404 const VkBufferViewCreateInfo* pCreateInfo,
2405 VkBufferView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002406
2407// Image functions
2408
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002409VkResult VKAPI vkCreateImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002410 VkDevice device,
2411 const VkImageCreateInfo* pCreateInfo,
2412 VkImage* pImage);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002413
Tony Barbour426b9052015-06-24 16:06:58 -06002414VkResult VKAPI vkGetImageSubresourceLayout(
Mike Stroyan230e6252015-04-17 12:36:38 -06002415 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002416 VkImage image,
2417 const VkImageSubresource* pSubresource,
Tony Barbour426b9052015-06-24 16:06:58 -06002418 VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002419
2420// Image view functions
2421
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002422VkResult VKAPI vkCreateImageView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002423 VkDevice device,
2424 const VkImageViewCreateInfo* pCreateInfo,
2425 VkImageView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002426
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002427VkResult VKAPI vkCreateColorAttachmentView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002428 VkDevice device,
2429 const VkColorAttachmentViewCreateInfo* pCreateInfo,
2430 VkColorAttachmentView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002431
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002432VkResult VKAPI vkCreateDepthStencilView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002433 VkDevice device,
2434 const VkDepthStencilViewCreateInfo* pCreateInfo,
2435 VkDepthStencilView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002436
2437// Shader functions
2438
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002439VkResult VKAPI vkCreateShaderModule(
2440 VkDevice device,
2441 const VkShaderModuleCreateInfo* pCreateInfo,
2442 VkShaderModule* pShaderModule);
2443
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002444VkResult VKAPI vkCreateShader(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002445 VkDevice device,
2446 const VkShaderCreateInfo* pCreateInfo,
2447 VkShader* pShader);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002448
2449// Pipeline functions
2450
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002451VkResult VKAPI vkCreateGraphicsPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002452 VkDevice device,
2453 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2454 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002455
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002456VkResult VKAPI vkCreateGraphicsPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002457 VkDevice device,
2458 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2459 VkPipeline basePipeline,
2460 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002461
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002462VkResult VKAPI vkCreateComputePipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002463 VkDevice device,
2464 const VkComputePipelineCreateInfo* pCreateInfo,
2465 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002466
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002467VkResult VKAPI vkStorePipeline(
Mike Stroyan230e6252015-04-17 12:36:38 -06002468 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002469 VkPipeline pipeline,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002470 size_t* pDataSize,
2471 void* pData);
2472
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002473VkResult VKAPI vkLoadPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002474 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002475 size_t dataSize,
2476 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002477 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002478
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002479VkResult VKAPI vkLoadPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002480 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002481 size_t dataSize,
2482 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002483 VkPipeline basePipeline,
2484 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002485
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002486// Pipeline layout functions
2487
2488VkResult VKAPI vkCreatePipelineLayout(
2489 VkDevice device,
2490 const VkPipelineLayoutCreateInfo* pCreateInfo,
2491 VkPipelineLayout* pPipelineLayout);
2492
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002493// Sampler functions
2494
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002495VkResult VKAPI vkCreateSampler(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002496 VkDevice device,
2497 const VkSamplerCreateInfo* pCreateInfo,
2498 VkSampler* pSampler);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002499
2500// Descriptor set functions
2501
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002502VkResult VKAPI vkCreateDescriptorSetLayout(
2503 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002504 const VkDescriptorSetLayoutCreateInfo* pCreateInfo,
2505 VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002506
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002507VkResult VKAPI vkCreateDescriptorPool(
2508 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002509 VkDescriptorPoolUsage poolUsage,
2510 uint32_t maxSets,
2511 const VkDescriptorPoolCreateInfo* pCreateInfo,
2512 VkDescriptorPool* pDescriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002513
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002514VkResult VKAPI vkResetDescriptorPool(
Mike Stroyan230e6252015-04-17 12:36:38 -06002515 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002516 VkDescriptorPool descriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002517
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002518VkResult VKAPI vkAllocDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002519 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002520 VkDescriptorPool descriptorPool,
2521 VkDescriptorSetUsage setUsage,
2522 uint32_t count,
2523 const VkDescriptorSetLayout* pSetLayouts,
2524 VkDescriptorSet* pDescriptorSets,
2525 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002526
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002527VkResult VKAPI vkUpdateDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002528 VkDevice device,
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002529 uint32_t writeCount,
2530 const VkWriteDescriptorSet* pDescriptorWrites,
2531 uint32_t copyCount,
2532 const VkCopyDescriptorSet* pDescriptorCopies);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002533
2534// State object functions
2535
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002536VkResult VKAPI vkCreateDynamicViewportState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002537 VkDevice device,
2538 const VkDynamicVpStateCreateInfo* pCreateInfo,
2539 VkDynamicVpState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002540
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002541VkResult VKAPI vkCreateDynamicRasterState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002542 VkDevice device,
2543 const VkDynamicRsStateCreateInfo* pCreateInfo,
2544 VkDynamicRsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002545
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002546VkResult VKAPI vkCreateDynamicColorBlendState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002547 VkDevice device,
2548 const VkDynamicCbStateCreateInfo* pCreateInfo,
2549 VkDynamicCbState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002550
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002551VkResult VKAPI vkCreateDynamicDepthStencilState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002552 VkDevice device,
2553 const VkDynamicDsStateCreateInfo* pCreateInfo,
2554 VkDynamicDsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002555
2556// Command buffer functions
2557
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002558VkResult VKAPI vkCreateCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002559 VkDevice device,
2560 const VkCmdBufferCreateInfo* pCreateInfo,
2561 VkCmdBuffer* pCmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002562
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002563VkResult VKAPI vkBeginCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002564 VkCmdBuffer cmdBuffer,
2565 const VkCmdBufferBeginInfo* pBeginInfo);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002566
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002567VkResult VKAPI vkEndCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002568 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002569
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002570VkResult VKAPI vkResetCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002571 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002572
2573// Command buffer building functions
2574
2575void VKAPI vkCmdBindPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002576 VkCmdBuffer cmdBuffer,
2577 VkPipelineBindPoint pipelineBindPoint,
2578 VkPipeline pipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002579
2580void VKAPI vkCmdBindDynamicStateObject(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002581 VkCmdBuffer cmdBuffer,
2582 VkStateBindPoint stateBindPoint,
2583 VkDynamicStateObject dynamicState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002584
2585void VKAPI vkCmdBindDescriptorSets(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002586 VkCmdBuffer cmdBuffer,
2587 VkPipelineBindPoint pipelineBindPoint,
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002588 VkPipelineLayout layout,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002589 uint32_t firstSet,
2590 uint32_t setCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002591 const VkDescriptorSet* pDescriptorSets,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002592 uint32_t dynamicOffsetCount,
2593 const uint32_t* pDynamicOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002594
2595void VKAPI vkCmdBindIndexBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002596 VkCmdBuffer cmdBuffer,
2597 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002598 VkDeviceSize offset,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002599 VkIndexType indexType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002600
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002601void VKAPI vkCmdBindVertexBuffers(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002602 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002603 uint32_t startBinding,
2604 uint32_t bindingCount,
2605 const VkBuffer* pBuffers,
Tony Barbour8205d902015-04-16 15:59:00 -06002606 const VkDeviceSize* pOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002607
2608void VKAPI vkCmdDraw(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002609 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002610 uint32_t firstVertex,
2611 uint32_t vertexCount,
2612 uint32_t firstInstance,
2613 uint32_t instanceCount);
2614
2615void VKAPI vkCmdDrawIndexed(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002616 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002617 uint32_t firstIndex,
2618 uint32_t indexCount,
2619 int32_t vertexOffset,
2620 uint32_t firstInstance,
2621 uint32_t instanceCount);
2622
2623void VKAPI vkCmdDrawIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002624 VkCmdBuffer cmdBuffer,
2625 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002626 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002627 uint32_t count,
2628 uint32_t stride);
2629
2630void VKAPI vkCmdDrawIndexedIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002631 VkCmdBuffer cmdBuffer,
2632 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002633 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002634 uint32_t count,
2635 uint32_t stride);
2636
2637void VKAPI vkCmdDispatch(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002638 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002639 uint32_t x,
2640 uint32_t y,
2641 uint32_t z);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002642
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002643void VKAPI vkCmdDispatchIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002644 VkCmdBuffer cmdBuffer,
2645 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002646 VkDeviceSize offset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002647
2648void VKAPI vkCmdCopyBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002649 VkCmdBuffer cmdBuffer,
2650 VkBuffer srcBuffer,
2651 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002652 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002653 const VkBufferCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002654
2655void VKAPI vkCmdCopyImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002656 VkCmdBuffer cmdBuffer,
2657 VkImage srcImage,
2658 VkImageLayout srcImageLayout,
2659 VkImage destImage,
2660 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002661 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002662 const VkImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002663
2664void VKAPI vkCmdBlitImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002665 VkCmdBuffer cmdBuffer,
2666 VkImage srcImage,
2667 VkImageLayout srcImageLayout,
2668 VkImage destImage,
2669 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002670 uint32_t regionCount,
Mark Lobodzinski20f68592015-05-22 14:43:25 -05002671 const VkImageBlit* pRegions,
2672 VkTexFilter filter);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002673
2674void VKAPI vkCmdCopyBufferToImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002675 VkCmdBuffer cmdBuffer,
2676 VkBuffer srcBuffer,
2677 VkImage destImage,
2678 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002679 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002680 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002681
2682void VKAPI vkCmdCopyImageToBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002683 VkCmdBuffer cmdBuffer,
2684 VkImage srcImage,
2685 VkImageLayout srcImageLayout,
2686 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002687 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002688 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002689
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002690void VKAPI vkCmdUpdateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002691 VkCmdBuffer cmdBuffer,
2692 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002693 VkDeviceSize destOffset,
2694 VkDeviceSize dataSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002695 const uint32_t* pData);
2696
2697void VKAPI vkCmdFillBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002698 VkCmdBuffer cmdBuffer,
2699 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002700 VkDeviceSize destOffset,
2701 VkDeviceSize fillSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002702 uint32_t data);
2703
2704void VKAPI vkCmdClearColorImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002705 VkCmdBuffer cmdBuffer,
2706 VkImage image,
2707 VkImageLayout imageLayout,
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002708 const VkClearColor* pColor,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002709 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002710 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002711
2712void VKAPI vkCmdClearDepthStencil(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002713 VkCmdBuffer cmdBuffer,
2714 VkImage image,
2715 VkImageLayout imageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002716 float depth,
2717 uint32_t stencil,
2718 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002719 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002720
2721void VKAPI vkCmdResolveImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002722 VkCmdBuffer cmdBuffer,
2723 VkImage srcImage,
2724 VkImageLayout srcImageLayout,
2725 VkImage destImage,
2726 VkImageLayout destImageLayout,
Tony Barbour11f74372015-04-13 15:02:52 -06002727 uint32_t regionCount,
2728 const VkImageResolve* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002729
2730void VKAPI vkCmdSetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002731 VkCmdBuffer cmdBuffer,
2732 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002733 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002734
2735void VKAPI vkCmdResetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002736 VkCmdBuffer cmdBuffer,
2737 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002738 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002739
2740void VKAPI vkCmdWaitEvents(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002741 VkCmdBuffer cmdBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002742 uint32_t eventCount,
2743 const VkEvent* pEvents,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002744 VkPipelineStageFlags sourceStageMask,
2745 VkPipelineStageFlags destStageMask,
Tony Barbour8205d902015-04-16 15:59:00 -06002746 uint32_t memBarrierCount,
2747 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002748
2749void VKAPI vkCmdPipelineBarrier(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002750 VkCmdBuffer cmdBuffer,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002751 VkPipelineStageFlags sourceStageMask,
2752 VkPipelineStageFlags destStageMask,
2753 bool32_t byRegion,
Tony Barbour8205d902015-04-16 15:59:00 -06002754 uint32_t memBarrierCount,
2755 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002756
2757void VKAPI vkCmdBeginQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002758 VkCmdBuffer cmdBuffer,
2759 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002760 uint32_t slot,
Tony Barbour8205d902015-04-16 15:59:00 -06002761 VkQueryControlFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002762
2763void VKAPI vkCmdEndQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002764 VkCmdBuffer cmdBuffer,
2765 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002766 uint32_t slot);
2767
2768void VKAPI vkCmdResetQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002769 VkCmdBuffer cmdBuffer,
2770 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002771 uint32_t startQuery,
2772 uint32_t queryCount);
2773
2774void VKAPI vkCmdWriteTimestamp(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002775 VkCmdBuffer cmdBuffer,
2776 VkTimestampType timestampType,
2777 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002778 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002779
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002780void VKAPI vkCmdCopyQueryPoolResults(
2781 VkCmdBuffer cmdBuffer,
2782 VkQueryPool queryPool,
2783 uint32_t startQuery,
2784 uint32_t queryCount,
2785 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002786 VkDeviceSize destOffset,
2787 VkDeviceSize destStride,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002788 VkQueryResultFlags flags);
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002789
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002790VkResult VKAPI vkCreateFramebuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002791 VkDevice device,
2792 const VkFramebufferCreateInfo* pCreateInfo,
2793 VkFramebuffer* pFramebuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002794
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002795VkResult VKAPI vkCreateRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002796 VkDevice device,
2797 const VkRenderPassCreateInfo* pCreateInfo,
2798 VkRenderPass* pRenderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002799
2800void VKAPI vkCmdBeginRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002801 VkCmdBuffer cmdBuffer,
2802 const VkRenderPassBegin* pRenderPassBegin);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002803
2804void VKAPI vkCmdEndRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002805 VkCmdBuffer cmdBuffer,
2806 VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002807
2808#endif // VK_PROTOTYPES
2809
2810#ifdef __cplusplus
2811} // extern "C"
2812#endif // __cplusplus
2813
2814#endif // __VULKAN_H__