blob: 6d79fcc5f1b2cd7f3ee7a013e8a3f96f780f6135 [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 Lobodzinski99d272a2015-07-02 17:09:57 -060036#define VK_API_VERSION VK_MAKE_VERSION(0, 120, 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{
Mark Lobodzinskic20fc412015-07-02 10:03:43 -0600328 VK_INDEX_TYPE_UINT16 = 0x00000000,
329 VK_INDEX_TYPE_UINT32 = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600330
Mark Lobodzinskic20fc412015-07-02 10:03:43 -0600331 VK_ENUM_RANGE(INDEX_TYPE, UINT16, UINT32)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600332} VkIndexType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600333
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600334typedef enum VkTexFilter_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600335{
Tony Barbour8205d902015-04-16 15:59:00 -0600336 VK_TEX_FILTER_NEAREST = 0x00000000,
337 VK_TEX_FILTER_LINEAR = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600338
Tony Barbour8205d902015-04-16 15:59:00 -0600339 VK_ENUM_RANGE(TEX_FILTER, NEAREST, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600340} VkTexFilter;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600341
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600342typedef enum VkTexMipmapMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600343{
Tony Barbour8205d902015-04-16 15:59:00 -0600344 VK_TEX_MIPMAP_MODE_BASE = 0x00000000, // Always choose base level
345 VK_TEX_MIPMAP_MODE_NEAREST = 0x00000001, // Choose nearest mip level
346 VK_TEX_MIPMAP_MODE_LINEAR = 0x00000002, // Linear filter between mip levels
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600347
Tony Barbour8205d902015-04-16 15:59:00 -0600348 VK_ENUM_RANGE(TEX_MIPMAP_MODE, BASE, LINEAR)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600349} VkTexMipmapMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600350
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600351typedef enum VkTexAddress_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600352{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600353 VK_TEX_ADDRESS_WRAP = 0x00000000,
354 VK_TEX_ADDRESS_MIRROR = 0x00000001,
355 VK_TEX_ADDRESS_CLAMP = 0x00000002,
356 VK_TEX_ADDRESS_MIRROR_ONCE = 0x00000003,
357 VK_TEX_ADDRESS_CLAMP_BORDER = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600358
Tony Barbour8205d902015-04-16 15:59:00 -0600359 VK_ENUM_RANGE(TEX_ADDRESS, WRAP, CLAMP_BORDER)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600360} VkTexAddress;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600361
Tony Barbour8205d902015-04-16 15:59:00 -0600362typedef enum VkCompareOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600363{
Tony Barbour8205d902015-04-16 15:59:00 -0600364 VK_COMPARE_OP_NEVER = 0x00000000,
365 VK_COMPARE_OP_LESS = 0x00000001,
366 VK_COMPARE_OP_EQUAL = 0x00000002,
367 VK_COMPARE_OP_LESS_EQUAL = 0x00000003,
368 VK_COMPARE_OP_GREATER = 0x00000004,
369 VK_COMPARE_OP_NOT_EQUAL = 0x00000005,
370 VK_COMPARE_OP_GREATER_EQUAL = 0x00000006,
371 VK_COMPARE_OP_ALWAYS = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600372
Tony Barbour8205d902015-04-16 15:59:00 -0600373 VK_ENUM_RANGE(COMPARE_OP, NEVER, ALWAYS)
374} VkCompareOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600375
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600376typedef enum VkFillMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600377{
Tony Barbour8205d902015-04-16 15:59:00 -0600378 VK_FILL_MODE_POINTS = 0x00000000,
379 VK_FILL_MODE_WIREFRAME = 0x00000001,
380 VK_FILL_MODE_SOLID = 0x00000002,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600381
Tony Barbour8205d902015-04-16 15:59:00 -0600382 VK_ENUM_RANGE(FILL_MODE, POINTS, SOLID)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600383} VkFillMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600384
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600385typedef enum VkCullMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600386{
Tony Barbour8205d902015-04-16 15:59:00 -0600387 VK_CULL_MODE_NONE = 0x00000000,
388 VK_CULL_MODE_FRONT = 0x00000001,
389 VK_CULL_MODE_BACK = 0x00000002,
390 VK_CULL_MODE_FRONT_AND_BACK = 0x00000003,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600391
Tony Barbour8205d902015-04-16 15:59:00 -0600392 VK_ENUM_RANGE(CULL_MODE, NONE, FRONT_AND_BACK)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600393} VkCullMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600394
Tony Barbour8205d902015-04-16 15:59:00 -0600395typedef enum VkFrontFace_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600396{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600397 VK_FRONT_FACE_CCW = 0x00000000,
398 VK_FRONT_FACE_CW = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600399
Tony Barbour8205d902015-04-16 15:59:00 -0600400 VK_ENUM_RANGE(FRONT_FACE, CCW, CW)
401} VkFrontFace;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600402
Tony Barbour8205d902015-04-16 15:59:00 -0600403typedef enum VkProvokingVertex_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600404{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600405 VK_PROVOKING_VERTEX_FIRST = 0x00000000,
406 VK_PROVOKING_VERTEX_LAST = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600407
Tony Barbour8205d902015-04-16 15:59:00 -0600408 VK_ENUM_RANGE(PROVOKING_VERTEX, FIRST, LAST)
409} VkProvokingVertex;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600410
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600411typedef enum VkCoordinateOrigin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600412{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600413 VK_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000,
414 VK_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600415
Tony Barbour8205d902015-04-16 15:59:00 -0600416 VK_ENUM_RANGE(COORDINATE_ORIGIN, UPPER_LEFT, LOWER_LEFT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600417} VkCoordinateOrigin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600418
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600419typedef enum VkDepthMode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600420{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600421 VK_DEPTH_MODE_ZERO_TO_ONE = 0x00000000,
422 VK_DEPTH_MODE_NEGATIVE_ONE_TO_ONE = 0x00000001,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600423
Tony Barbour8205d902015-04-16 15:59:00 -0600424 VK_ENUM_RANGE(DEPTH_MODE, ZERO_TO_ONE, NEGATIVE_ONE_TO_ONE)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600425} VkDepthMode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600426
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600427typedef enum VkBlend_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600428{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600429 VK_BLEND_ZERO = 0x00000000,
430 VK_BLEND_ONE = 0x00000001,
431 VK_BLEND_SRC_COLOR = 0x00000002,
432 VK_BLEND_ONE_MINUS_SRC_COLOR = 0x00000003,
433 VK_BLEND_DEST_COLOR = 0x00000004,
434 VK_BLEND_ONE_MINUS_DEST_COLOR = 0x00000005,
435 VK_BLEND_SRC_ALPHA = 0x00000006,
436 VK_BLEND_ONE_MINUS_SRC_ALPHA = 0x00000007,
437 VK_BLEND_DEST_ALPHA = 0x00000008,
438 VK_BLEND_ONE_MINUS_DEST_ALPHA = 0x00000009,
439 VK_BLEND_CONSTANT_COLOR = 0x0000000a,
440 VK_BLEND_ONE_MINUS_CONSTANT_COLOR = 0x0000000b,
441 VK_BLEND_CONSTANT_ALPHA = 0x0000000c,
442 VK_BLEND_ONE_MINUS_CONSTANT_ALPHA = 0x0000000d,
443 VK_BLEND_SRC_ALPHA_SATURATE = 0x0000000e,
444 VK_BLEND_SRC1_COLOR = 0x0000000f,
445 VK_BLEND_ONE_MINUS_SRC1_COLOR = 0x00000010,
446 VK_BLEND_SRC1_ALPHA = 0x00000011,
447 VK_BLEND_ONE_MINUS_SRC1_ALPHA = 0x00000012,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600448
Tony Barbour8205d902015-04-16 15:59:00 -0600449 VK_ENUM_RANGE(BLEND, ZERO, ONE_MINUS_SRC1_ALPHA)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600450} VkBlend;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600451
Tony Barbour8205d902015-04-16 15:59:00 -0600452typedef enum VkBlendOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600453{
Tony Barbour8205d902015-04-16 15:59:00 -0600454 VK_BLEND_OP_ADD = 0x00000000,
455 VK_BLEND_OP_SUBTRACT = 0x00000001,
456 VK_BLEND_OP_REVERSE_SUBTRACT = 0x00000002,
457 VK_BLEND_OP_MIN = 0x00000003,
458 VK_BLEND_OP_MAX = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600459
Tony Barbour8205d902015-04-16 15:59:00 -0600460 VK_ENUM_RANGE(BLEND_OP, ADD, MAX)
461} VkBlendOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600462
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600463typedef enum VkStencilOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600464{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600465 VK_STENCIL_OP_KEEP = 0x00000000,
466 VK_STENCIL_OP_ZERO = 0x00000001,
467 VK_STENCIL_OP_REPLACE = 0x00000002,
468 VK_STENCIL_OP_INC_CLAMP = 0x00000003,
469 VK_STENCIL_OP_DEC_CLAMP = 0x00000004,
470 VK_STENCIL_OP_INVERT = 0x00000005,
471 VK_STENCIL_OP_INC_WRAP = 0x00000006,
472 VK_STENCIL_OP_DEC_WRAP = 0x00000007,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600473
Tony Barbour8205d902015-04-16 15:59:00 -0600474 VK_ENUM_RANGE(STENCIL_OP, KEEP, DEC_WRAP)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600475} VkStencilOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600476
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600477typedef enum VkLogicOp_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600478{
Tony Barbourfdff5572015-06-26 13:28:56 -0600479 VK_LOGIC_OP_CLEAR = 0x00000000,
480 VK_LOGIC_OP_AND = 0x00000001,
481 VK_LOGIC_OP_AND_REVERSE = 0x00000002,
482 VK_LOGIC_OP_COPY = 0x00000003,
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600483 VK_LOGIC_OP_AND_INVERTED = 0x00000004,
484 VK_LOGIC_OP_NOOP = 0x00000005,
485 VK_LOGIC_OP_XOR = 0x00000006,
486 VK_LOGIC_OP_OR = 0x00000007,
487 VK_LOGIC_OP_NOR = 0x00000008,
488 VK_LOGIC_OP_EQUIV = 0x00000009,
489 VK_LOGIC_OP_INVERT = 0x0000000a,
490 VK_LOGIC_OP_OR_REVERSE = 0x0000000b,
491 VK_LOGIC_OP_COPY_INVERTED = 0x0000000c,
492 VK_LOGIC_OP_OR_INVERTED = 0x0000000d,
493 VK_LOGIC_OP_NAND = 0x0000000e,
494 VK_LOGIC_OP_SET = 0x0000000f,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600495
Tony Barbourfdff5572015-06-26 13:28:56 -0600496 VK_ENUM_RANGE(LOGIC_OP, CLEAR, SET)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600497} VkLogicOp;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600498
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600499typedef enum VkSystemAllocType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600500{
Tony Barbour8205d902015-04-16 15:59:00 -0600501 VK_SYSTEM_ALLOC_TYPE_API_OBJECT = 0x00000000,
502 VK_SYSTEM_ALLOC_TYPE_INTERNAL = 0x00000001,
503 VK_SYSTEM_ALLOC_TYPE_INTERNAL_TEMP = 0x00000002,
504 VK_SYSTEM_ALLOC_TYPE_INTERNAL_SHADER = 0x00000003,
505 VK_SYSTEM_ALLOC_TYPE_DEBUG = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600506
Tony Barbour8205d902015-04-16 15:59:00 -0600507 VK_ENUM_RANGE(SYSTEM_ALLOC_TYPE, API_OBJECT, DEBUG)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600508} VkSystemAllocType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600509
Tony Barbour8205d902015-04-16 15:59:00 -0600510typedef enum VkPhysicalDeviceType_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600511{
Tony Barbour8205d902015-04-16 15:59:00 -0600512 VK_PHYSICAL_DEVICE_TYPE_OTHER = 0x00000000,
513 VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU = 0x00000001,
514 VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU = 0x00000002,
515 VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU = 0x00000003,
516 VK_PHYSICAL_DEVICE_TYPE_CPU = 0x00000004,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600517
Tony Barbour8205d902015-04-16 15:59:00 -0600518 VK_ENUM_RANGE(PHYSICAL_DEVICE_TYPE, OTHER, CPU)
519} VkPhysicalDeviceType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600520
Tony Barbour8205d902015-04-16 15:59:00 -0600521typedef enum VkVertexInputStepRate_
522{
523 VK_VERTEX_INPUT_STEP_RATE_VERTEX = 0x0,
524 VK_VERTEX_INPUT_STEP_RATE_INSTANCE = 0x1,
525 VK_VERTEX_INPUT_STEP_RATE_DRAW = 0x2, //Optional
526
527 VK_ENUM_RANGE(VERTEX_INPUT_STEP_RATE, VERTEX, DRAW)
528} VkVertexInputStepRate;
529
Tony Barbour8205d902015-04-16 15:59:00 -0600530// Vulkan format definitions
531typedef enum VkFormat_
532{
533 VK_FORMAT_UNDEFINED = 0x00000000,
534 VK_FORMAT_R4G4_UNORM = 0x00000001,
535 VK_FORMAT_R4G4_USCALED = 0x00000002,
536 VK_FORMAT_R4G4B4A4_UNORM = 0x00000003,
537 VK_FORMAT_R4G4B4A4_USCALED = 0x00000004,
538 VK_FORMAT_R5G6B5_UNORM = 0x00000005,
539 VK_FORMAT_R5G6B5_USCALED = 0x00000006,
540 VK_FORMAT_R5G5B5A1_UNORM = 0x00000007,
541 VK_FORMAT_R5G5B5A1_USCALED = 0x00000008,
542 VK_FORMAT_R8_UNORM = 0x00000009,
543 VK_FORMAT_R8_SNORM = 0x0000000A,
544 VK_FORMAT_R8_USCALED = 0x0000000B,
545 VK_FORMAT_R8_SSCALED = 0x0000000C,
546 VK_FORMAT_R8_UINT = 0x0000000D,
547 VK_FORMAT_R8_SINT = 0x0000000E,
548 VK_FORMAT_R8_SRGB = 0x0000000F,
549 VK_FORMAT_R8G8_UNORM = 0x00000010,
550 VK_FORMAT_R8G8_SNORM = 0x00000011,
551 VK_FORMAT_R8G8_USCALED = 0x00000012,
552 VK_FORMAT_R8G8_SSCALED = 0x00000013,
553 VK_FORMAT_R8G8_UINT = 0x00000014,
554 VK_FORMAT_R8G8_SINT = 0x00000015,
555 VK_FORMAT_R8G8_SRGB = 0x00000016,
556 VK_FORMAT_R8G8B8_UNORM = 0x00000017,
557 VK_FORMAT_R8G8B8_SNORM = 0x00000018,
558 VK_FORMAT_R8G8B8_USCALED = 0x00000019,
559 VK_FORMAT_R8G8B8_SSCALED = 0x0000001A,
560 VK_FORMAT_R8G8B8_UINT = 0x0000001B,
561 VK_FORMAT_R8G8B8_SINT = 0x0000001C,
562 VK_FORMAT_R8G8B8_SRGB = 0x0000001D,
563 VK_FORMAT_R8G8B8A8_UNORM = 0x0000001E,
564 VK_FORMAT_R8G8B8A8_SNORM = 0x0000001F,
565 VK_FORMAT_R8G8B8A8_USCALED = 0x00000020,
566 VK_FORMAT_R8G8B8A8_SSCALED = 0x00000021,
567 VK_FORMAT_R8G8B8A8_UINT = 0x00000022,
568 VK_FORMAT_R8G8B8A8_SINT = 0x00000023,
569 VK_FORMAT_R8G8B8A8_SRGB = 0x00000024,
570 VK_FORMAT_R10G10B10A2_UNORM = 0x00000025,
571 VK_FORMAT_R10G10B10A2_SNORM = 0x00000026,
572 VK_FORMAT_R10G10B10A2_USCALED = 0x00000027,
573 VK_FORMAT_R10G10B10A2_SSCALED = 0x00000028,
574 VK_FORMAT_R10G10B10A2_UINT = 0x00000029,
575 VK_FORMAT_R10G10B10A2_SINT = 0x0000002A,
576 VK_FORMAT_R16_UNORM = 0x0000002B,
577 VK_FORMAT_R16_SNORM = 0x0000002C,
578 VK_FORMAT_R16_USCALED = 0x0000002D,
579 VK_FORMAT_R16_SSCALED = 0x0000002E,
580 VK_FORMAT_R16_UINT = 0x0000002F,
581 VK_FORMAT_R16_SINT = 0x00000030,
582 VK_FORMAT_R16_SFLOAT = 0x00000031,
583 VK_FORMAT_R16G16_UNORM = 0x00000032,
584 VK_FORMAT_R16G16_SNORM = 0x00000033,
585 VK_FORMAT_R16G16_USCALED = 0x00000034,
586 VK_FORMAT_R16G16_SSCALED = 0x00000035,
587 VK_FORMAT_R16G16_UINT = 0x00000036,
588 VK_FORMAT_R16G16_SINT = 0x00000037,
589 VK_FORMAT_R16G16_SFLOAT = 0x00000038,
590 VK_FORMAT_R16G16B16_UNORM = 0x00000039,
591 VK_FORMAT_R16G16B16_SNORM = 0x0000003A,
592 VK_FORMAT_R16G16B16_USCALED = 0x0000003B,
593 VK_FORMAT_R16G16B16_SSCALED = 0x0000003C,
594 VK_FORMAT_R16G16B16_UINT = 0x0000003D,
595 VK_FORMAT_R16G16B16_SINT = 0x0000003E,
596 VK_FORMAT_R16G16B16_SFLOAT = 0x0000003F,
597 VK_FORMAT_R16G16B16A16_UNORM = 0x00000040,
598 VK_FORMAT_R16G16B16A16_SNORM = 0x00000041,
599 VK_FORMAT_R16G16B16A16_USCALED = 0x00000042,
600 VK_FORMAT_R16G16B16A16_SSCALED = 0x00000043,
601 VK_FORMAT_R16G16B16A16_UINT = 0x00000044,
602 VK_FORMAT_R16G16B16A16_SINT = 0x00000045,
603 VK_FORMAT_R16G16B16A16_SFLOAT = 0x00000046,
604 VK_FORMAT_R32_UINT = 0x00000047,
605 VK_FORMAT_R32_SINT = 0x00000048,
606 VK_FORMAT_R32_SFLOAT = 0x00000049,
607 VK_FORMAT_R32G32_UINT = 0x0000004A,
608 VK_FORMAT_R32G32_SINT = 0x0000004B,
609 VK_FORMAT_R32G32_SFLOAT = 0x0000004C,
610 VK_FORMAT_R32G32B32_UINT = 0x0000004D,
611 VK_FORMAT_R32G32B32_SINT = 0x0000004E,
612 VK_FORMAT_R32G32B32_SFLOAT = 0x0000004F,
613 VK_FORMAT_R32G32B32A32_UINT = 0x00000050,
614 VK_FORMAT_R32G32B32A32_SINT = 0x00000051,
615 VK_FORMAT_R32G32B32A32_SFLOAT = 0x00000052,
616 VK_FORMAT_R64_SFLOAT = 0x00000053,
617 VK_FORMAT_R64G64_SFLOAT = 0x00000054,
618 VK_FORMAT_R64G64B64_SFLOAT = 0x00000055,
619 VK_FORMAT_R64G64B64A64_SFLOAT = 0x00000056,
620 VK_FORMAT_R11G11B10_UFLOAT = 0x00000057,
621 VK_FORMAT_R9G9B9E5_UFLOAT = 0x00000058,
622 VK_FORMAT_D16_UNORM = 0x00000059,
623 VK_FORMAT_D24_UNORM = 0x0000005A,
624 VK_FORMAT_D32_SFLOAT = 0x0000005B,
625 VK_FORMAT_S8_UINT = 0x0000005C,
626 VK_FORMAT_D16_UNORM_S8_UINT = 0x0000005D,
627 VK_FORMAT_D24_UNORM_S8_UINT = 0x0000005E,
628 VK_FORMAT_D32_SFLOAT_S8_UINT = 0x0000005F,
629 VK_FORMAT_BC1_RGB_UNORM = 0x00000060,
630 VK_FORMAT_BC1_RGB_SRGB = 0x00000061,
631 VK_FORMAT_BC1_RGBA_UNORM = 0x00000062,
632 VK_FORMAT_BC1_RGBA_SRGB = 0x00000063,
633 VK_FORMAT_BC2_UNORM = 0x00000064,
634 VK_FORMAT_BC2_SRGB = 0x00000065,
635 VK_FORMAT_BC3_UNORM = 0x00000066,
636 VK_FORMAT_BC3_SRGB = 0x00000067,
637 VK_FORMAT_BC4_UNORM = 0x00000068,
638 VK_FORMAT_BC4_SNORM = 0x00000069,
639 VK_FORMAT_BC5_UNORM = 0x0000006A,
640 VK_FORMAT_BC5_SNORM = 0x0000006B,
641 VK_FORMAT_BC6H_UFLOAT = 0x0000006C,
642 VK_FORMAT_BC6H_SFLOAT = 0x0000006D,
643 VK_FORMAT_BC7_UNORM = 0x0000006E,
644 VK_FORMAT_BC7_SRGB = 0x0000006F,
645 VK_FORMAT_ETC2_R8G8B8_UNORM = 0x00000070,
646 VK_FORMAT_ETC2_R8G8B8_SRGB = 0x00000071,
647 VK_FORMAT_ETC2_R8G8B8A1_UNORM = 0x00000072,
648 VK_FORMAT_ETC2_R8G8B8A1_SRGB = 0x00000073,
649 VK_FORMAT_ETC2_R8G8B8A8_UNORM = 0x00000074,
650 VK_FORMAT_ETC2_R8G8B8A8_SRGB = 0x00000075,
651 VK_FORMAT_EAC_R11_UNORM = 0x00000076,
652 VK_FORMAT_EAC_R11_SNORM = 0x00000077,
653 VK_FORMAT_EAC_R11G11_UNORM = 0x00000078,
654 VK_FORMAT_EAC_R11G11_SNORM = 0x00000079,
655 VK_FORMAT_ASTC_4x4_UNORM = 0x0000007A,
656 VK_FORMAT_ASTC_4x4_SRGB = 0x0000007B,
657 VK_FORMAT_ASTC_5x4_UNORM = 0x0000007C,
658 VK_FORMAT_ASTC_5x4_SRGB = 0x0000007D,
659 VK_FORMAT_ASTC_5x5_UNORM = 0x0000007E,
660 VK_FORMAT_ASTC_5x5_SRGB = 0x0000007F,
661 VK_FORMAT_ASTC_6x5_UNORM = 0x00000080,
662 VK_FORMAT_ASTC_6x5_SRGB = 0x00000081,
663 VK_FORMAT_ASTC_6x6_UNORM = 0x00000082,
664 VK_FORMAT_ASTC_6x6_SRGB = 0x00000083,
665 VK_FORMAT_ASTC_8x5_UNORM = 0x00000084,
666 VK_FORMAT_ASTC_8x5_SRGB = 0x00000085,
667 VK_FORMAT_ASTC_8x6_UNORM = 0x00000086,
668 VK_FORMAT_ASTC_8x6_SRGB = 0x00000087,
669 VK_FORMAT_ASTC_8x8_UNORM = 0x00000088,
670 VK_FORMAT_ASTC_8x8_SRGB = 0x00000089,
671 VK_FORMAT_ASTC_10x5_UNORM = 0x0000008A,
672 VK_FORMAT_ASTC_10x5_SRGB = 0x0000008B,
673 VK_FORMAT_ASTC_10x6_UNORM = 0x0000008C,
674 VK_FORMAT_ASTC_10x6_SRGB = 0x0000008D,
675 VK_FORMAT_ASTC_10x8_UNORM = 0x0000008E,
676 VK_FORMAT_ASTC_10x8_SRGB = 0x0000008F,
677 VK_FORMAT_ASTC_10x10_UNORM = 0x00000090,
678 VK_FORMAT_ASTC_10x10_SRGB = 0x00000091,
679 VK_FORMAT_ASTC_12x10_UNORM = 0x00000092,
680 VK_FORMAT_ASTC_12x10_SRGB = 0x00000093,
681 VK_FORMAT_ASTC_12x12_UNORM = 0x00000094,
682 VK_FORMAT_ASTC_12x12_SRGB = 0x00000095,
683 VK_FORMAT_B4G4R4A4_UNORM = 0x00000096,
684 VK_FORMAT_B5G5R5A1_UNORM = 0x00000097,
685 VK_FORMAT_B5G6R5_UNORM = 0x00000098,
686 VK_FORMAT_B5G6R5_USCALED = 0x00000099,
687 VK_FORMAT_B8G8R8_UNORM = 0x0000009A,
688 VK_FORMAT_B8G8R8_SNORM = 0x0000009B,
689 VK_FORMAT_B8G8R8_USCALED = 0x0000009C,
690 VK_FORMAT_B8G8R8_SSCALED = 0x0000009D,
691 VK_FORMAT_B8G8R8_UINT = 0x0000009E,
692 VK_FORMAT_B8G8R8_SINT = 0x0000009F,
693 VK_FORMAT_B8G8R8_SRGB = 0x000000A0,
694 VK_FORMAT_B8G8R8A8_UNORM = 0x000000A1,
695 VK_FORMAT_B8G8R8A8_SNORM = 0x000000A2,
696 VK_FORMAT_B8G8R8A8_USCALED = 0x000000A3,
697 VK_FORMAT_B8G8R8A8_SSCALED = 0x000000A4,
698 VK_FORMAT_B8G8R8A8_UINT = 0x000000A5,
699 VK_FORMAT_B8G8R8A8_SINT = 0x000000A6,
700 VK_FORMAT_B8G8R8A8_SRGB = 0x000000A7,
701 VK_FORMAT_B10G10R10A2_UNORM = 0x000000A8,
702 VK_FORMAT_B10G10R10A2_SNORM = 0x000000A9,
703 VK_FORMAT_B10G10R10A2_USCALED = 0x000000AA,
704 VK_FORMAT_B10G10R10A2_SSCALED = 0x000000AB,
705 VK_FORMAT_B10G10R10A2_UINT = 0x000000AC,
706 VK_FORMAT_B10G10R10A2_SINT = 0x000000AD,
707
708 VK_ENUM_RANGE(FORMAT, UNDEFINED, B10G10R10A2_SINT)
709} VkFormat;
710
711// Shader stage enumerant
712typedef enum VkShaderStage_
713{
714 VK_SHADER_STAGE_VERTEX = 0,
715 VK_SHADER_STAGE_TESS_CONTROL = 1,
716 VK_SHADER_STAGE_TESS_EVALUATION = 2,
717 VK_SHADER_STAGE_GEOMETRY = 3,
718 VK_SHADER_STAGE_FRAGMENT = 4,
719 VK_SHADER_STAGE_COMPUTE = 5,
720
721 VK_ENUM_RANGE(SHADER_STAGE, VERTEX, COMPUTE)
722} VkShaderStage;
723
724// Structure type enumerant
725typedef enum VkStructureType_
726{
Tony Barbour04ee6b92015-06-26 15:02:35 -0600727 VK_STRUCTURE_TYPE_APPLICATION_INFO = 0,
728 VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO = 1,
729 VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO = 2,
730 VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO = 3,
731 VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO = 4,
732 VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO = 5,
733 VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO = 6,
734 VK_STRUCTURE_TYPE_SHADER_CREATE_INFO = 7,
735 VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO = 8,
736 VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO = 9,
737 VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO = 10,
738 VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO = 11,
739 VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO = 12,
740 VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO = 13,
741 VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO = 14,
742 VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO = 15,
743 VK_STRUCTURE_TYPE_EVENT_CREATE_INFO = 16,
744 VK_STRUCTURE_TYPE_FENCE_CREATE_INFO = 17,
745 VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO = 18,
746 VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO = 19,
747 VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO = 20,
748 VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO = 21,
749 VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO = 22,
750 VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO = 23,
751 VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO = 24,
752 VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO = 25,
753 VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO = 26,
754 VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO = 27,
755 VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO = 28,
756 VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO = 29,
757 VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO = 30,
758 VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO = 31,
759 VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO = 32,
760 VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO = 33,
761 VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO = 34,
762 VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO = 35,
763 VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO = 36,
764 VK_STRUCTURE_TYPE_MEMORY_BARRIER = 37,
765 VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER = 38,
766 VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER = 39,
767 VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO = 40,
768 VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET = 41,
769 VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET = 42,
770 VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO = 43,
771 VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO = 44,
772 VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES = 45,
Tony Barbour8205d902015-04-16 15:59:00 -0600773
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600774 VK_ENUM_RANGE(STRUCTURE_TYPE, APPLICATION_INFO, EXTENSION_PROPERTIES)
Tony Barbour8205d902015-04-16 15:59:00 -0600775} VkStructureType;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600776
Mike Stroyan230e6252015-04-17 12:36:38 -0600777// Object type enumerant
778typedef enum VkObjectType_
779{
780 VK_OBJECT_TYPE_INSTANCE = 0,
781 VK_OBJECT_TYPE_PHYSICAL_DEVICE = 1,
782 VK_OBJECT_TYPE_DEVICE = 2,
783 VK_OBJECT_TYPE_QUEUE = 3,
784 VK_OBJECT_TYPE_COMMAND_BUFFER = 4,
785 VK_OBJECT_TYPE_DEVICE_MEMORY = 5,
786 VK_OBJECT_TYPE_BUFFER = 6,
787 VK_OBJECT_TYPE_BUFFER_VIEW = 7,
788 VK_OBJECT_TYPE_IMAGE = 8,
789 VK_OBJECT_TYPE_IMAGE_VIEW = 9,
790 VK_OBJECT_TYPE_COLOR_ATTACHMENT_VIEW = 10,
791 VK_OBJECT_TYPE_DEPTH_STENCIL_VIEW = 11,
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -0600792 VK_OBJECT_TYPE_SHADER_MODULE = 12,
793 VK_OBJECT_TYPE_SHADER = 13,
794 VK_OBJECT_TYPE_PIPELINE = 14,
795 VK_OBJECT_TYPE_PIPELINE_LAYOUT = 15,
796 VK_OBJECT_TYPE_SAMPLER = 16,
797 VK_OBJECT_TYPE_DESCRIPTOR_SET = 17,
798 VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT = 18,
799 VK_OBJECT_TYPE_DESCRIPTOR_POOL = 19,
800 VK_OBJECT_TYPE_DYNAMIC_VP_STATE = 20,
801 VK_OBJECT_TYPE_DYNAMIC_RS_STATE = 21,
802 VK_OBJECT_TYPE_DYNAMIC_CB_STATE = 22,
803 VK_OBJECT_TYPE_DYNAMIC_DS_STATE = 23,
804 VK_OBJECT_TYPE_FENCE = 24,
805 VK_OBJECT_TYPE_SEMAPHORE = 25,
806 VK_OBJECT_TYPE_EVENT = 26,
807 VK_OBJECT_TYPE_QUERY_POOL = 27,
808 VK_OBJECT_TYPE_FRAMEBUFFER = 28,
809 VK_OBJECT_TYPE_RENDER_PASS = 29,
Mike Stroyan230e6252015-04-17 12:36:38 -0600810
811 // Valid ranges for core Vulkan:
812 VK_OBJECT_TYPE_BEGIN_RANGE = VK_OBJECT_TYPE_INSTANCE,
813 VK_OBJECT_TYPE_END_RANGE = VK_OBJECT_TYPE_RENDER_PASS,
814 VK_NUM_OBJECT_TYPE = (VK_OBJECT_TYPE_END_RANGE - VK_OBJECT_TYPE_BEGIN_RANGE + 1),
815 VK_MAX_ENUM(VkObjectType)
816} VkObjectType;
817
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600818// ------------------------------------------------------------------------------------------------
819// Error and return codes
820
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600821typedef enum VkResult_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600822{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600823 // Return codes for successful operation execution (> = 0)
824 VK_SUCCESS = 0x0000000,
825 VK_UNSUPPORTED = 0x0000001,
826 VK_NOT_READY = 0x0000002,
827 VK_TIMEOUT = 0x0000003,
828 VK_EVENT_SET = 0x0000004,
829 VK_EVENT_RESET = 0x0000005,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600830
831 // Error codes (negative values)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600832 VK_ERROR_UNKNOWN = -(0x00000001),
833 VK_ERROR_UNAVAILABLE = -(0x00000002),
834 VK_ERROR_INITIALIZATION_FAILED = -(0x00000003),
Tony Barbour8205d902015-04-16 15:59:00 -0600835 VK_ERROR_OUT_OF_HOST_MEMORY = -(0x00000004),
836 VK_ERROR_OUT_OF_DEVICE_MEMORY = -(0x00000005),
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -0600837 VK_ERROR_DEVICE_ALREADY_CREATED = -(0x00000006),
838 VK_ERROR_DEVICE_LOST = -(0x00000007),
839 VK_ERROR_INVALID_POINTER = -(0x00000008),
840 VK_ERROR_INVALID_VALUE = -(0x00000009),
841 VK_ERROR_INVALID_HANDLE = -(0x0000000A),
842 VK_ERROR_INVALID_ORDINAL = -(0x0000000B),
843 VK_ERROR_INVALID_MEMORY_SIZE = -(0x0000000C),
844 VK_ERROR_INVALID_EXTENSION = -(0x0000000D),
845 VK_ERROR_INVALID_FLAGS = -(0x0000000E),
846 VK_ERROR_INVALID_ALIGNMENT = -(0x0000000F),
847 VK_ERROR_INVALID_FORMAT = -(0x00000010),
848 VK_ERROR_INVALID_IMAGE = -(0x00000011),
849 VK_ERROR_INVALID_DESCRIPTOR_SET_DATA = -(0x00000012),
850 VK_ERROR_INVALID_QUEUE_TYPE = -(0x00000013),
851 VK_ERROR_INVALID_OBJECT_TYPE = -(0x00000014),
852 VK_ERROR_UNSUPPORTED_SHADER_IL_VERSION = -(0x00000015),
853 VK_ERROR_BAD_SHADER_CODE = -(0x00000016),
854 VK_ERROR_BAD_PIPELINE_DATA = -(0x00000017),
Courtney Goeltzenleuchterac834522015-05-01 17:56:13 -0600855 VK_ERROR_NOT_MAPPABLE = -(0x00000018),
856 VK_ERROR_MEMORY_MAP_FAILED = -(0x00000019),
857 VK_ERROR_MEMORY_UNMAP_FAILED = -(0x0000001A),
858 VK_ERROR_INCOMPATIBLE_DEVICE = -(0x0000001B),
859 VK_ERROR_INCOMPATIBLE_DRIVER = -(0x0000001C),
860 VK_ERROR_INCOMPLETE_COMMAND_BUFFER = -(0x0000001D),
861 VK_ERROR_BUILDING_COMMAND_BUFFER = -(0x0000001E),
862 VK_ERROR_MEMORY_NOT_BOUND = -(0x0000001F),
863 VK_ERROR_INCOMPATIBLE_QUEUE = -(0x00000020),
Tony Barbour8205d902015-04-16 15:59:00 -0600864
865 VK_MAX_ENUM(RESULT)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600866} VkResult;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600867
868// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600869// Flags
870
871// Device creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600872typedef VkFlags VkDeviceCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600873
874// Queue capabilities
Tony Barbour8205d902015-04-16 15:59:00 -0600875typedef VkFlags VkQueueFlags;
876typedef enum VkQueueFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600877{
Tony Barbour8205d902015-04-16 15:59:00 -0600878 VK_QUEUE_GRAPHICS_BIT = VK_BIT(0), // Queue supports graphics operations
879 VK_QUEUE_COMPUTE_BIT = VK_BIT(1), // Queue supports compute operations
880 VK_QUEUE_DMA_BIT = VK_BIT(2), // Queue supports DMA operations
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500881 VK_QUEUE_SPARSE_MEMMGR_BIT = VK_BIT(3), // Queue supports sparse resource memory management operations
Tony Barbour8205d902015-04-16 15:59:00 -0600882 VK_QUEUE_EXTENDED_BIT = VK_BIT(30), // Extended queue
883} VkQueueFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600884
Tony Barbour8205d902015-04-16 15:59:00 -0600885// Memory properties passed into vkAllocMemory().
886typedef VkFlags VkMemoryPropertyFlags;
887typedef enum VkMemoryPropertyFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600888{
Tony Barbour8205d902015-04-16 15:59:00 -0600889 VK_MEMORY_PROPERTY_DEVICE_ONLY = 0, // If otherwise stated, then allocate memory on device
890 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT = VK_BIT(0), // Memory should be mappable by host
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600891 VK_MEMORY_PROPERTY_HOST_NON_COHERENT_BIT = VK_BIT(1), // Memory may not have i/o coherency so vkFlushMappedMemoryRanges and
892 // vkInvalidateMappedMemoryRanges must be used flush/invalidate host cache
Tony Barbour8205d902015-04-16 15:59:00 -0600893 VK_MEMORY_PROPERTY_HOST_UNCACHED_BIT = VK_BIT(2), // Memory should not be cached by the host
894 VK_MEMORY_PROPERTY_HOST_WRITE_COMBINED_BIT = VK_BIT(3), // Memory should support host write combining
Tony Barbour8205d902015-04-16 15:59:00 -0600895} VkMemoryPropertyFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600896
Tony Barbour8205d902015-04-16 15:59:00 -0600897// Memory output flags passed to resource transition commands
898typedef VkFlags VkMemoryOutputFlags;
899typedef enum VkMemoryOutputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600900{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600901 VK_MEMORY_OUTPUT_HOST_WRITE_BIT = VK_BIT(0), // Controls output coherency of host writes
Tony Barbour8205d902015-04-16 15:59:00 -0600902 VK_MEMORY_OUTPUT_SHADER_WRITE_BIT = VK_BIT(1), // Controls output coherency of generic shader writes
903 VK_MEMORY_OUTPUT_COLOR_ATTACHMENT_BIT = VK_BIT(2), // Controls output coherency of color attachment writes
904 VK_MEMORY_OUTPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(3), // Controls output coherency of depth/stencil attachment writes
905 VK_MEMORY_OUTPUT_TRANSFER_BIT = VK_BIT(4), // Controls output coherency of transfer operations
906} VkMemoryOutputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600907
Tony Barbour8205d902015-04-16 15:59:00 -0600908// Memory input flags passed to resource transition commands
909typedef VkFlags VkMemoryInputFlags;
910typedef enum VkMemoryInputFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600911{
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600912 VK_MEMORY_INPUT_HOST_READ_BIT = VK_BIT(0), // Controls input coherency of host reads
Tony Barbour8205d902015-04-16 15:59:00 -0600913 VK_MEMORY_INPUT_INDIRECT_COMMAND_BIT = VK_BIT(1), // Controls input coherency of indirect command reads
914 VK_MEMORY_INPUT_INDEX_FETCH_BIT = VK_BIT(2), // Controls input coherency of index fetches
915 VK_MEMORY_INPUT_VERTEX_ATTRIBUTE_FETCH_BIT = VK_BIT(3), // Controls input coherency of vertex attribute fetches
916 VK_MEMORY_INPUT_UNIFORM_READ_BIT = VK_BIT(4), // Controls input coherency of uniform buffer reads
917 VK_MEMORY_INPUT_SHADER_READ_BIT = VK_BIT(5), // Controls input coherency of generic shader reads
918 VK_MEMORY_INPUT_COLOR_ATTACHMENT_BIT = VK_BIT(6), // Controls input coherency of color attachment reads
919 VK_MEMORY_INPUT_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(7), // Controls input coherency of depth/stencil attachment reads
920 VK_MEMORY_INPUT_TRANSFER_BIT = VK_BIT(8), // Controls input coherency of transfer operations
921} VkMemoryInputFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600922
Tony Barbour8205d902015-04-16 15:59:00 -0600923// Buffer usage flags
924typedef VkFlags VkBufferUsageFlags;
925typedef enum VkBufferUsageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600926{
Tony Barbour8205d902015-04-16 15:59:00 -0600927 VK_BUFFER_USAGE_GENERAL = 0, // No special usage
928 VK_BUFFER_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
929 VK_BUFFER_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
930 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(2), // Can be used as TBO
931 VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(3), // Can be used as IBO
932 VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT = VK_BIT(4), // Can be used as UBO
933 VK_BUFFER_USAGE_STORAGE_BUFFER_BIT = VK_BIT(5), // Can be used as SSBO
934 VK_BUFFER_USAGE_INDEX_BUFFER_BIT = VK_BIT(6), // Can be used as source of fixed function index fetch (index buffer)
935 VK_BUFFER_USAGE_VERTEX_BUFFER_BIT = VK_BIT(7), // Can be used as source of fixed function vertex fetch (VBO)
936 VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT = VK_BIT(8), // Can be the source of indirect parameters (e.g. indirect buffer, parameter buffer)
937} VkBufferUsageFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600938
Tony Barbour8205d902015-04-16 15:59:00 -0600939// Buffer creation flags
940typedef VkFlags VkBufferCreateFlags;
941typedef enum VkBufferCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600942{
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600943 VK_BUFFER_CREATE_SPARSE_BIT = VK_BIT(0), // Buffer should support sparse backing
Tony Barbour8205d902015-04-16 15:59:00 -0600944} VkBufferCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600945
Tony Barbour8205d902015-04-16 15:59:00 -0600946// Shader stage flags
947typedef VkFlags VkShaderStageFlags;
948typedef enum VkShaderStageFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600949{
Tony Barbour8205d902015-04-16 15:59:00 -0600950 VK_SHADER_STAGE_VERTEX_BIT = VK_BIT(0),
951 VK_SHADER_STAGE_TESS_CONTROL_BIT = VK_BIT(1),
952 VK_SHADER_STAGE_TESS_EVALUATION_BIT = VK_BIT(2),
953 VK_SHADER_STAGE_GEOMETRY_BIT = VK_BIT(3),
954 VK_SHADER_STAGE_FRAGMENT_BIT = VK_BIT(4),
955 VK_SHADER_STAGE_COMPUTE_BIT = VK_BIT(5),
956
957 VK_SHADER_STAGE_ALL = 0x7FFFFFFF,
958} VkShaderStageFlagBits;
959
960// Image usage flags
961typedef VkFlags VkImageUsageFlags;
962typedef enum VkImageUsageFlagBits_
963{
964 VK_IMAGE_USAGE_GENERAL = 0, // No special usage
965 VK_IMAGE_USAGE_TRANSFER_SOURCE_BIT = VK_BIT(0), // Can be used as a source of transfer operations
966 VK_IMAGE_USAGE_TRANSFER_DESTINATION_BIT = VK_BIT(1), // Can be used as a destination of transfer operations
967 VK_IMAGE_USAGE_SAMPLED_BIT = VK_BIT(2), // Can be sampled from (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
968 VK_IMAGE_USAGE_STORAGE_BIT = VK_BIT(3), // Can be used as storage image (STORAGE_IMAGE descriptor type)
969 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT = VK_BIT(4), // Can be used as framebuffer color attachment
970 VK_IMAGE_USAGE_DEPTH_STENCIL_BIT = VK_BIT(5), // Can be used as framebuffer depth/stencil attachment
971 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT = VK_BIT(6), // Image data not needed outside of rendering
972} VkImageUsageFlagBits;
973
974// Image creation flags
975typedef VkFlags VkImageCreateFlags;
976typedef enum VkImageCreateFlagBits_
977{
978 VK_IMAGE_CREATE_INVARIANT_DATA_BIT = VK_BIT(0),
Courtney Goeltzenleuchterb25c9b92015-06-18 17:01:41 -0600979 VK_IMAGE_CREATE_SPARSE_BIT = VK_BIT(1), // Image should support sparse backing
980 VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT = VK_BIT(2), // Allows image views to have different format than the base image
981 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 -0600982} VkImageCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600983
984// Depth-stencil view creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600985typedef VkFlags VkDepthStencilViewCreateFlags;
986typedef enum VkDepthStencilViewCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600987{
Tony Barbour8205d902015-04-16 15:59:00 -0600988 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_DEPTH_BIT = VK_BIT(0),
989 VK_DEPTH_STENCIL_VIEW_CREATE_READ_ONLY_STENCIL_BIT = VK_BIT(1),
990} VkDepthStencilViewCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600991
992// Pipeline creation flags
Tony Barbour8205d902015-04-16 15:59:00 -0600993typedef VkFlags VkPipelineCreateFlags;
994typedef enum VkPipelineCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600995{
Tony Barbour8205d902015-04-16 15:59:00 -0600996 VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT = VK_BIT(0),
997 VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT = VK_BIT(1),
998} VkPipelineCreateFlagBits;
999
1000// Channel flags
1001typedef VkFlags VkChannelFlags;
1002typedef enum VkChannelFlagBits_
1003{
1004 VK_CHANNEL_R_BIT = VK_BIT(0),
1005 VK_CHANNEL_G_BIT = VK_BIT(1),
1006 VK_CHANNEL_B_BIT = VK_BIT(2),
1007 VK_CHANNEL_A_BIT = VK_BIT(3),
1008} VkChannelFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001009
1010// Fence creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001011typedef VkFlags VkFenceCreateFlags;
1012typedef enum VkFenceCreateFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001013{
Tony Barbour8205d902015-04-16 15:59:00 -06001014 VK_FENCE_CREATE_SIGNALED_BIT = VK_BIT(0),
1015} VkFenceCreateFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001016
1017// Semaphore creation flags
Tony Barbour8205d902015-04-16 15:59:00 -06001018typedef VkFlags VkSemaphoreCreateFlags;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001019
1020// Format capability flags
Tony Barbour8205d902015-04-16 15:59:00 -06001021typedef VkFlags VkFormatFeatureFlags;
1022typedef enum VkFormatFeatureFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001023{
Tony Barbour8205d902015-04-16 15:59:00 -06001024 VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT = VK_BIT(0), // Format can be used for sampled images (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)
1025 VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT = VK_BIT(1), // Format can be used for storage images (STORAGE_IMAGE descriptor type)
1026 VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT = VK_BIT(2), // Format supports atomic operations in case it's used for storage images
1027 VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT = VK_BIT(3), // Format can be used for uniform texel buffers (TBOs)
1028 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT = VK_BIT(4), // Format can be used for storage texel buffers (IBOs)
1029 VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT = VK_BIT(5), // Format supports atomic operations in case it's used for storage texel buffers
1030 VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT = VK_BIT(6), // Format can be used for vertex buffers (VBOs)
1031 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT = VK_BIT(7), // Format can be used for color attachment images
1032 VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT = VK_BIT(8), // Format supports blending in case it's used for color attachment images
1033 VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT = VK_BIT(9), // Format can be used for depth/stencil attachment images
1034 VK_FORMAT_FEATURE_CONVERSION_BIT = VK_BIT(10), // Format can be used as the source or destination of format converting blits
1035} VkFormatFeatureFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001036
Tony Barbourc2e987e2015-06-29 16:20:35 -06001037// Pipeline stage flags
1038typedef enum {
1039 VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT = VK_BIT(0),
1040 VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT = VK_BIT(1),
1041 VK_PIPELINE_STAGE_VERTEX_INPUT_BIT = VK_BIT(2),
1042 VK_PIPELINE_STAGE_VERTEX_SHADER_BIT = VK_BIT(3),
1043 VK_PIPELINE_STAGE_TESS_CONTROL_SHADER_BIT = VK_BIT(4),
1044 VK_PIPELINE_STAGE_TESS_EVALUATION_SHADER_BIT = VK_BIT(5),
1045 VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT = VK_BIT(6),
1046 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT = VK_BIT(7),
1047 VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT = VK_BIT(8),
1048 VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT = VK_BIT(9),
1049 VK_PIPELINE_STAGE_ATTACHMENT_OUTPUT_BIT = VK_BIT(10),
1050 VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT = VK_BIT(11),
1051 VK_PIPELINE_STAGE_TRANSFER_BIT = VK_BIT(12),
1052 VK_PIPELINE_STAGE_HOST_BIT = VK_BIT(13),
1053 VK_PIPELINE_STAGE_ALL_GRAPHICS = 0x000007FF,
1054 VK_PIPELINE_STAGE_ALL_GPU_COMMANDS = 0x00001FFF,
1055} VkPipelineStageFlagBits;
1056
1057typedef VkFlags VkPipelineStageFlags;
1058
Tony Barbour8205d902015-04-16 15:59:00 -06001059// Query control flags
1060typedef VkFlags VkQueryControlFlags;
1061typedef enum VkQueryControlFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001062{
Tony Barbour8205d902015-04-16 15:59:00 -06001063 VK_QUERY_CONTROL_CONSERVATIVE_BIT = VK_BIT(0), // Allow conservative results to be collected by the query
1064} VkQueryControlFlagBits;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001065
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001066// Query result flags
Tony Barbour8205d902015-04-16 15:59:00 -06001067typedef VkFlags VkQueryResultFlags;
1068typedef enum VkQueryResultFlagBits_
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001069{
Courtney Goeltzenleuchterc0d0bb02015-06-09 08:45:23 -06001070 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 -06001071 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 -06001072 VK_QUERY_RESULT_WAIT_BIT = VK_BIT(1), // Results of the queries are waited on before proceeding with the result copy
1073 VK_QUERY_RESULT_WITH_AVAILABILITY_BIT = VK_BIT(2), // Besides the results of the query, the availability of the results is also written
1074 VK_QUERY_RESULT_PARTIAL_BIT = VK_BIT(3), // Copy the partial results of the query even if the final results aren't available
1075} VkQueryResultFlagBits;
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06001076
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001077// Shader module creation flags
1078typedef VkFlags VkShaderModuleCreateFlags;
1079
Tony Barbour8205d902015-04-16 15:59:00 -06001080// Shader creation flags
1081typedef VkFlags VkShaderCreateFlags;
1082
1083// Event creation flags
1084typedef VkFlags VkEventCreateFlags;
1085
1086// Command buffer creation flags
1087typedef VkFlags VkCmdBufferCreateFlags;
1088
1089// Command buffer optimization flags
1090typedef VkFlags VkCmdBufferOptimizeFlags;
1091typedef enum VkCmdBufferOptimizeFlagBits_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001092{
Tony Barbour8205d902015-04-16 15:59:00 -06001093 VK_CMD_BUFFER_OPTIMIZE_SMALL_BATCH_BIT = VK_BIT(0),
1094 VK_CMD_BUFFER_OPTIMIZE_PIPELINE_SWITCH_BIT = VK_BIT(1),
1095 VK_CMD_BUFFER_OPTIMIZE_ONE_TIME_SUBMIT_BIT = VK_BIT(2),
1096 VK_CMD_BUFFER_OPTIMIZE_DESCRIPTOR_SET_SWITCH_BIT = VK_BIT(3),
1097} VkCmdBufferOptimizeFlagBits;
1098
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001099// Pipeline statistics flags
1100typedef VkFlags VkQueryPipelineStatisticFlags;
1101typedef enum VkQueryPipelineStatisticFlagBits_ {
1102 VK_QUERY_PIPELINE_STATISTIC_IA_VERTICES_BIT = VK_BIT(0), // Optional
1103 VK_QUERY_PIPELINE_STATISTIC_IA_PRIMITIVES_BIT = VK_BIT(1), // Optional
1104 VK_QUERY_PIPELINE_STATISTIC_VS_INVOCATIONS_BIT = VK_BIT(2), // Optional
1105 VK_QUERY_PIPELINE_STATISTIC_GS_INVOCATIONS_BIT = VK_BIT(3), // Optional
1106 VK_QUERY_PIPELINE_STATISTIC_GS_PRIMITIVES_BIT = VK_BIT(4), // Optional
1107 VK_QUERY_PIPELINE_STATISTIC_C_INVOCATIONS_BIT = VK_BIT(5), // Optional
1108 VK_QUERY_PIPELINE_STATISTIC_C_PRIMITIVES_BIT = VK_BIT(6), // Optional
1109 VK_QUERY_PIPELINE_STATISTIC_FS_INVOCATIONS_BIT = VK_BIT(7), // Optional
1110 VK_QUERY_PIPELINE_STATISTIC_TCS_PATCHES_BIT = VK_BIT(8), // Optional
1111 VK_QUERY_PIPELINE_STATISTIC_TES_INVOCATIONS_BIT = VK_BIT(9), // Optional
1112 VK_QUERY_PIPELINE_STATISTIC_CS_INVOCATIONS_BIT = VK_BIT(10), // Optional
1113} VkQueryPipelineStatisticFlagBits;
1114
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001115// Memory mapping flags
1116typedef VkFlags VkMemoryMapFlags;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001117
Mark Lobodzinski99d272a2015-07-02 17:09:57 -06001118// Memory heap flags
1119typedef VkFlags VkMemoryHeapFlags;
1120typedef enum VkMemoryHeapFlagBits_ {
1121 VK_MEMORY_HEAP_HOST_LOCAL = VK_BIT(0), // If set, heap represents host memory
1122} VkMemoryHeapFlagBits;
1123
1124
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001125// ------------------------------------------------------------------------------------------------
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001126// Vulkan structures
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001127
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001128typedef struct VkOffset2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001129{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001130 int32_t x;
1131 int32_t y;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001132} VkOffset2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001133
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001134typedef struct VkOffset3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001135{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001136 int32_t x;
1137 int32_t y;
1138 int32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001139} VkOffset3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001140
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001141typedef struct VkExtent2D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001142{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001143 int32_t width;
1144 int32_t height;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001145} VkExtent2D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001146
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001147typedef struct VkExtent3D_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001148{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001149 int32_t width;
1150 int32_t height;
1151 int32_t depth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001152} VkExtent3D;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001153
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001154typedef struct VkViewport_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001155{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001156 float originX;
1157 float originY;
1158 float width;
1159 float height;
1160 float minDepth;
1161 float maxDepth;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001162} VkViewport;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001163
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001164typedef struct VkRect_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001165{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001166 VkOffset2D offset;
1167 VkExtent2D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001168} VkRect;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001169
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001170typedef struct VkChannelMapping_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001171{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001172 VkChannelSwizzle r;
1173 VkChannelSwizzle g;
1174 VkChannelSwizzle b;
1175 VkChannelSwizzle a;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001176} VkChannelMapping;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001177
Tony Barbour8205d902015-04-16 15:59:00 -06001178typedef struct VkPhysicalDeviceProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001179{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001180 uint32_t apiVersion;
1181 uint32_t driverVersion;
1182 uint32_t vendorId;
1183 uint32_t deviceId;
Tony Barbour8205d902015-04-16 15:59:00 -06001184 VkPhysicalDeviceType deviceType;
1185 char deviceName[VK_MAX_PHYSICAL_DEVICE_NAME];
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001186 uint32_t maxBoundDescriptorSets;
1187 uint32_t maxThreadGroupSize;
1188 uint64_t timestampFrequency;
1189 bool32_t multiColorAttachmentClears;
1190 uint32_t maxDescriptorSets; // at least 2?
1191 uint32_t maxViewports; // at least 16?
1192 uint32_t maxColorAttachments; // at least 8?
Tony Barbour8205d902015-04-16 15:59:00 -06001193} VkPhysicalDeviceProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001194
Chris Forbesd7576302015-06-21 22:55:02 +12001195typedef struct VkPhysicalDeviceFeatures_
1196{
1197 // GFL_32 features
1198 bool32_t supportsGeometryShader;
1199 bool32_t supportsTessellationShader;
1200 bool32_t supportsSampleRateShading;
1201 bool32_t supportsFragmentSideEffects;
1202 bool32_t supportsConstantStorageBufferArrayIdexing;
1203 bool32_t supportsConstantStorageImageArrayIndexing;
1204 bool32_t supportsConstantUniformBufferArrayIndexing;
1205 bool32_t supportsDynamicSampledImageArrayIndexing;
1206 // GFL_45 features
1207 bool32_t supportsBlendSrc1;
1208 bool32_t supportsClipAndCullDistance;
1209 bool32_t supportsLogicOp;
1210 bool32_t supportsInstancedDrawIndirect;
1211 bool32_t supportsDepthClip;
1212 bool32_t supportsFillMode;
1213 bool32_t supportsStorageImageExtendedFormats;
1214 bool32_t supportsStorageImageMultisample;
1215 bool32_t supportsPipelineStatisticsQuery;
1216 bool32_t supportsVTGSideEffects;
1217 bool32_t supportsDynamicUniformBufferArrayIndexing;
1218 // optional features
1219 bool32_t supportsDynamicStorageBufferArrayIndexing;
1220 bool32_t supportsDynamicStorageImageArrayIndexing;
1221 bool32_t supportsShaderFloat64;
1222 bool32_t supportsDepthBounds;
1223 bool32_t supportsWideLines;
1224 bool32_t supportsTextureCompressionETC2;
1225 bool32_t supportsTextureCompressionASTC_LDR;
1226 bool32_t supportsTextureCompressionBC;
1227} VkPhysicalDeviceFeatures;
1228
1229typedef struct VkPhysicalDeviceLimits_
1230{
1231 uint32_t maxImageDimensions;
1232 uint32_t maxImageDepth;
1233 uint32_t maxImageArrayLayers;
1234 // <lots more>
1235} VkPhysicalDeviceLimits;
1236
1237
Tony Barbour8205d902015-04-16 15:59:00 -06001238typedef struct VkPhysicalDevicePerformance_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001239{
Tony Barbour8205d902015-04-16 15:59:00 -06001240 float maxDeviceClock;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001241 float aluPerClock;
1242 float texPerClock;
1243 float primsPerClock;
1244 float pixelsPerClock;
Tony Barbour8205d902015-04-16 15:59:00 -06001245} VkPhysicalDevicePerformance;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001246
Jon Ashburneb2728b2015-04-10 14:33:07 -06001247typedef struct VkExtensionProperties_
1248{
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001249 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_EXTENSION_PROPERTIES
1250 char name[VK_MAX_EXTENSION_NAME]; // extension name
Jon Ashburneb2728b2015-04-10 14:33:07 -06001251 uint32_t version; // version of the extension specification
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001252 char description[VK_MAX_EXTENSION_NAME]; // Name of library implementing this extension
Jon Ashburneb2728b2015-04-10 14:33:07 -06001253} VkExtensionProperties;
1254
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001255typedef struct VkApplicationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001256{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001257 VkStructureType sType; // Type of structure. Should be VK_STRUCTURE_TYPE_APPLICATION_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001258 const void* pNext; // Next structure in chain
1259 const char* pAppName;
1260 uint32_t appVersion;
1261 const char* pEngineName;
1262 uint32_t engineVersion;
1263 uint32_t apiVersion;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001264} VkApplicationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001265
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001266typedef void* (VKAPI *PFN_vkAllocFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001267 void* pUserData,
1268 size_t size,
1269 size_t alignment,
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001270 VkSystemAllocType allocType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001271
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001272typedef void (VKAPI *PFN_vkFreeFunction)(
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001273 void* pUserData,
1274 void* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001275
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001276typedef struct VkAllocCallbacks_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001277{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001278 void* pUserData;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001279 PFN_vkAllocFunction pfnAlloc;
1280 PFN_vkFreeFunction pfnFree;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001281} VkAllocCallbacks;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001282
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001283typedef struct VkDeviceQueueCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001284{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001285 uint32_t queueNodeIndex;
1286 uint32_t queueCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001287} VkDeviceQueueCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001288
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001289typedef struct VkDeviceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001290{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001291 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001292 const void* pNext; // Pointer to next structure
1293 uint32_t queueRecordCount;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001294 const VkDeviceQueueCreateInfo* pRequestedQueues;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001295 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001296 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Chris Forbesd7576302015-06-21 22:55:02 +12001297 const VkPhysicalDeviceFeatures* pEnabledFeatures;
Tony Barbour8205d902015-04-16 15:59:00 -06001298 VkDeviceCreateFlags flags; // Device creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001299} VkDeviceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001300
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001301typedef struct VkInstanceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001302{
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001303 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001304 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter553acb92015-04-16 21:42:44 -06001305 const VkApplicationInfo* pAppInfo;
1306 const VkAllocCallbacks* pAllocCb;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001307 uint32_t extensionCount;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -06001308 const VkExtensionProperties* pEnabledExtensions; // Indicate extensions to enable by index value
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001309} VkInstanceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001310
Tony Barbour8205d902015-04-16 15:59:00 -06001311typedef struct VkPhysicalDeviceQueueProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001312{
Tony Barbour8205d902015-04-16 15:59:00 -06001313 VkQueueFlags queueFlags; // Queue flags
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001314 uint32_t queueCount;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001315 bool32_t supportsTimestamps;
Tony Barbour8205d902015-04-16 15:59:00 -06001316} VkPhysicalDeviceQueueProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001317
Mark Lobodzinski72346292015-07-02 16:49:40 -06001318typedef struct VkMemoryType_
1319{
1320 VkMemoryPropertyFlags propertyFlags; // Memory properties of this memory type
1321 uint32_t heapIndex; // Index of the memory heap allocations of this memory type are taken from
1322} VkMemoryType;
1323
1324typedef struct VkMemoryHeap_
1325{
1326 VkDeviceSize size; // Available memory in the heap
Mark Lobodzinski99d272a2015-07-02 17:09:57 -06001327 VkMemoryHeapFlags flags; // Flags for the heap
Mark Lobodzinski72346292015-07-02 16:49:40 -06001328} VkMemoryHeap;
1329
Tony Barbour8205d902015-04-16 15:59:00 -06001330typedef struct VkPhysicalDeviceMemoryProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001331{
Mark Lobodzinski72346292015-07-02 16:49:40 -06001332 uint32_t memoryTypeCount;
1333 VkMemoryType memoryTypes[VK_MAX_MEMORY_TYPES];
1334 uint32_t memoryHeapCount;
1335 VkMemoryHeap memoryHeaps[VK_MAX_MEMORY_HEAPS];
Tony Barbour8205d902015-04-16 15:59:00 -06001336} VkPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001337
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001338typedef struct VkMemoryAllocInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001339{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001340 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001341 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001342 VkDeviceSize allocationSize; // Size of memory allocation
Mark Lobodzinski72346292015-07-02 16:49:40 -06001343 uint32_t memoryTypeIndex; // Index of the memory type to allocate from
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001344} VkMemoryAllocInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001345
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06001346typedef struct VkMappedMemoryRange_
1347{
1348 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
1349 const void* pNext; // Pointer to next structure
1350 VkDeviceMemory mem; // Mapped memory object
1351 VkDeviceSize offset; // Offset within the mapped memory the range starts from
1352 VkDeviceSize size; // Size of the range within the mapped memory
1353} VkMappedMemoryRange;
1354
Mark Lobodzinski72346292015-07-02 16:49:40 -06001355typedef struct VkMemoryRequirements_
1356{
1357 VkDeviceSize size; // Specified in bytes
1358 VkDeviceSize alignment; // Specified in bytes
1359 VkDeviceSize granularity; // Granularity at which memory can be bound to resource sub-ranges specified in bytes (usually the page size)
1360 uint32_t memoryTypeBits; // Bitfield of the allowed memory type indices into memoryTypes[] for this object
1361} VkMemoryRequirements;
1362
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001363typedef struct VkFormatProperties_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001364{
Tony Barbour8205d902015-04-16 15:59:00 -06001365 VkFormatFeatureFlags linearTilingFeatures; // Format features in case of linear tiling
1366 VkFormatFeatureFlags optimalTilingFeatures; // Format features in case of optimal tiling
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001367} VkFormatProperties;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001368
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001369typedef struct VkDescriptorInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001370{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001371 VkBufferView bufferView; // Buffer view to write to the descriptor (in case it's a buffer descriptor, otherwise should be VK_NULL_HANDLE)
1372 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)
1373 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)
1374 VkImageLayout imageLayout; // Layout the image is expected to be in when accessed using this descriptor (only used if <imageView> is not VK_NULL_HANDLE)
1375} VkDescriptorInfo;
1376
1377typedef struct VkWriteDescriptorSet_
1378{
1379 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001380 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001381
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001382 VkDescriptorSet destSet; // Destination descriptor set
1383 uint32_t destBinding; // Binding within the destination descriptor set to write
1384 uint32_t destArrayElement; // Array element within the destination binding to write
1385
1386 uint32_t count; // Number of descriptors to write (determines the size of the array pointed by <pDescriptors>)
1387
1388 VkDescriptorType descriptorType; // Descriptor type to write (determines which fields of the array pointed by <pDescriptors> are going to be used)
1389 const VkDescriptorInfo* pDescriptors; // Array of info structures describing the descriptors to write
1390} VkWriteDescriptorSet;
1391
1392typedef struct VkCopyDescriptorSet_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001393{
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001394 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001395 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001396
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001397 VkDescriptorSet srcSet; // Source descriptor set
1398 uint32_t srcBinding; // Binding within the source descriptor set to copy from
1399 uint32_t srcArrayElement; // Array element within the source binding to copy from
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001400
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001401 VkDescriptorSet destSet; // Destination descriptor set
1402 uint32_t destBinding; // Binding within the destination descriptor set to copy to
1403 uint32_t destArrayElement; // Array element within the destination binding to copy to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001404
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08001405 uint32_t count; // Number of descriptors to copy
1406} VkCopyDescriptorSet;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001407
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001408typedef struct VkBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001409{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001410 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001411 const void* pNext; // Pointer to next structure.
Tony Barbour8205d902015-04-16 15:59:00 -06001412 VkDeviceSize size; // Specified in bytes
1413 VkBufferUsageFlags usage; // Buffer usage flags
1414 VkBufferCreateFlags flags; // Buffer creation flags
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001415} VkBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001416
Courtney Goeltzenleuchter070f6da2015-04-10 17:59:44 -06001417typedef struct VkBufferViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001418{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001419 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001420 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001421 VkBuffer buffer;
1422 VkBufferViewType viewType;
1423 VkFormat format; // Optionally specifies format of elements
Tony Barbour8205d902015-04-16 15:59:00 -06001424 VkDeviceSize offset; // Specified in bytes
1425 VkDeviceSize range; // View size specified in bytes
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001426} VkBufferViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001427
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001428typedef struct VkImageSubresource_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001429{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001430 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001431 uint32_t mipLevel;
1432 uint32_t arraySlice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001433} VkImageSubresource;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001434
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001435typedef struct VkImageSubresourceRange_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001436{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001437 VkImageAspect aspect;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001438 uint32_t baseMipLevel;
1439 uint32_t mipLevels;
1440 uint32_t baseArraySlice;
1441 uint32_t arraySize;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001442} VkImageSubresourceRange;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001443
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001444typedef struct VkMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001445{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001446 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001447 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001448
Tony Barbour8205d902015-04-16 15:59:00 -06001449 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1450 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001451} VkMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001452
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001453typedef struct VkBufferMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001454{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001455 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001456 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001457
Tony Barbour8205d902015-04-16 15:59:00 -06001458 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1459 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001460
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001461 VkBuffer buffer; // Buffer to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001462
Tony Barbour8205d902015-04-16 15:59:00 -06001463 VkDeviceSize offset; // Offset within the buffer to sync
1464 VkDeviceSize size; // Amount of bytes to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001465} VkBufferMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001466
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001467typedef struct VkImageMemoryBarrier_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001468{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001469 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001470 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001471
Tony Barbour8205d902015-04-16 15:59:00 -06001472 VkMemoryOutputFlags outputMask; // Outputs the barrier should sync
1473 VkMemoryInputFlags inputMask; // Inputs the barrier should sync to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001474
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001475 VkImageLayout oldLayout; // Current layout of the image
1476 VkImageLayout newLayout; // New layout to transition the image to
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001477
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001478 VkImage image; // Image to sync
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001479
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001480 VkImageSubresourceRange subresourceRange; // Subresource range to sync
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001481} VkImageMemoryBarrier;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001482
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001483typedef struct VkImageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001484{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001485 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001486 const void* pNext; // Pointer to next structure.
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001487 VkImageType imageType;
1488 VkFormat format;
1489 VkExtent3D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001490 uint32_t mipLevels;
1491 uint32_t arraySize;
1492 uint32_t samples;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001493 VkImageTiling tiling;
Tony Barbour8205d902015-04-16 15:59:00 -06001494 VkImageUsageFlags usage; // Image usage flags
1495 VkImageCreateFlags flags; // Image creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001496} VkImageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001497
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001498typedef struct VkSubresourceLayout_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001499{
Tony Barbour8205d902015-04-16 15:59:00 -06001500 VkDeviceSize offset; // Specified in bytes
1501 VkDeviceSize size; // Specified in bytes
1502 VkDeviceSize rowPitch; // Specified in bytes
1503 VkDeviceSize depthPitch; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001504} VkSubresourceLayout;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001505
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001506typedef struct VkImageViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001507{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001508 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001509 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001510 VkImage image;
1511 VkImageViewType viewType;
1512 VkFormat format;
1513 VkChannelMapping channels;
1514 VkImageSubresourceRange subresourceRange;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001515} VkImageViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001516
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001517typedef struct VkColorAttachmentViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001518{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001519 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COLOR_ATTACHMENT_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001520 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001521 VkImage image;
1522 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001523 uint32_t mipLevel;
1524 uint32_t baseArraySlice;
1525 uint32_t arraySize;
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001526 VkImage msaaResolveImage;
1527 VkImageSubresourceRange msaaResolveSubResource;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001528} VkColorAttachmentViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001529
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001530typedef struct VkDepthStencilViewCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001531{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001532 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DEPTH_STENCIL_VIEW_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001533 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001534 VkImage image;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001535 uint32_t mipLevel;
1536 uint32_t baseArraySlice;
1537 uint32_t arraySize;
Tony Barbour8205d902015-04-16 15:59:00 -06001538 VkDepthStencilViewCreateFlags flags; // Depth stencil attachment view flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001539} VkDepthStencilViewCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001540
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001541typedef struct VkColorAttachmentBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001542{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001543 VkColorAttachmentView view;
1544 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001545} VkColorAttachmentBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001546
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001547typedef struct VkDepthStencilBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001548{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001549 VkDepthStencilView view;
1550 VkImageLayout layout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001551} VkDepthStencilBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001552
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001553typedef struct VkBufferCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001554{
Tony Barbour8205d902015-04-16 15:59:00 -06001555 VkDeviceSize srcOffset; // Specified in bytes
1556 VkDeviceSize destOffset; // Specified in bytes
1557 VkDeviceSize copySize; // Specified in bytes
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001558} VkBufferCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001559
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001560typedef struct VkImageMemoryBindInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001561{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001562 VkImageSubresource subresource;
1563 VkOffset3D offset;
1564 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001565} VkImageMemoryBindInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001566
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001567typedef struct VkImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001568{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001569 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001570 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001571 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001572 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1573 VkExtent3D extent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001574} VkImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001575
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001576typedef struct VkImageBlit_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001577{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001578 VkImageSubresource srcSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001579 VkOffset3D srcOffset; // Specified in pixels for both compressed and uncompressed images
1580 VkExtent3D srcExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001581 VkImageSubresource destSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001582 VkOffset3D destOffset; // Specified in pixels for both compressed and uncompressed images
1583 VkExtent3D destExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001584} VkImageBlit;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001585
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001586typedef struct VkBufferImageCopy_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001587{
Tony Barbour8205d902015-04-16 15:59:00 -06001588 VkDeviceSize bufferOffset; // Specified in bytes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001589 VkImageSubresource imageSubresource;
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001590 VkOffset3D imageOffset; // Specified in pixels for both compressed and uncompressed images
1591 VkExtent3D imageExtent; // Specified in pixels for both compressed and uncompressed images
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001592} VkBufferImageCopy;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001593
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001594typedef struct VkImageResolve_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001595{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001596 VkImageSubresource srcSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001597 VkOffset3D srcOffset;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001598 VkImageSubresource destSubresource;
Tony Barboure9f99942015-04-13 13:11:12 -06001599 VkOffset3D destOffset;
1600 VkExtent3D extent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001601} VkImageResolve;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001602
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001603typedef struct VkShaderModuleCreateInfo_
1604{
1605 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
1606 const void* pNext; // Pointer to next structure
1607 size_t codeSize; // Specified in bytes
1608 const void* pCode; // Binary code of size codeSize
1609 VkShaderModuleCreateFlags flags; // Reserved
1610} VkShaderModuleCreateInfo;
1611
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001612typedef struct VkShaderCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001613{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001614 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SHADER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001615 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06001616 VkShaderModule module; // Module containing entry point
Courtney Goeltzenleuchter2d034fd2015-06-28 13:01:17 -06001617 const char* pName; // Null-terminate entry point name
Tony Barbour8205d902015-04-16 15:59:00 -06001618 VkShaderCreateFlags flags; // Reserved
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001619} VkShaderCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001620
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001621typedef struct VkDescriptorSetLayoutBinding_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001622{
Tony Barbour8205d902015-04-16 15:59:00 -06001623 VkDescriptorType descriptorType; // Type of the descriptors in this binding
Chia-I Wud3114a22015-05-25 16:22:52 +08001624 uint32_t arraySize; // Number of descriptors in this binding
Tony Barbour8205d902015-04-16 15:59:00 -06001625 VkShaderStageFlags stageFlags; // Shader stages this binding is visible to
1626 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 -06001627} VkDescriptorSetLayoutBinding;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001628
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001629typedef struct VkDescriptorSetLayoutCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001630{
Tony Barbour8205d902015-04-16 15:59:00 -06001631 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
1632 const void* pNext; // Pointer to next structure
1633 uint32_t count; // Number of bindings in the descriptor set layout
1634 const VkDescriptorSetLayoutBinding* pBinding; // Array of descriptor set layout bindings
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001635} VkDescriptorSetLayoutCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001636
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001637typedef struct VkDescriptorTypeCount_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001638{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001639 VkDescriptorType type;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001640 uint32_t count;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001641} VkDescriptorTypeCount;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001642
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001643typedef struct VkDescriptorPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001644{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001645 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001646 const void* pNext; // Pointer to next structure
1647 uint32_t count;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001648 const VkDescriptorTypeCount* pTypeCount;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001649} VkDescriptorPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001650
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001651typedef struct VkLinkConstBuffer_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001652{
1653 uint32_t bufferId;
1654 size_t bufferSize;
1655 const void* pBufferData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001656} VkLinkConstBuffer;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001657
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001658typedef struct VkSpecializationMapEntry_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001659{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001660 uint32_t constantId; // The SpecConstant ID specified in the BIL
1661 uint32_t offset; // Offset of the value in the data block
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001662} VkSpecializationMapEntry;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001663
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001664typedef struct VkSpecializationInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001665{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001666 uint32_t mapEntryCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001667 const VkSpecializationMapEntry* pMap; // mapEntryCount entries
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001668 const void* pData;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001669} VkSpecializationInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001670
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001671typedef struct VkPipelineShaderStageCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001672{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001673 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
1674 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001675 VkShaderStage stage;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001676 VkShader shader;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001677 uint32_t linkConstBufferCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001678 const VkLinkConstBuffer* pLinkConstBufferInfo;
1679 const VkSpecializationInfo* pSpecializationInfo;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001680} VkPipelineShaderStageCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001681
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001682typedef struct VkComputePipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001683{
Tony Barbour8205d902015-04-16 15:59:00 -06001684 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
1685 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001686 VkPipelineShaderStageCreateInfo cs;
Tony Barbour8205d902015-04-16 15:59:00 -06001687 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001688 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001689} VkComputePipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001690
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001691typedef struct VkVertexInputBindingDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001692{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001693 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchterad870812015-04-15 15:29:59 -06001694 uint32_t strideInBytes; // Distance between vertices in bytes (0 = no advancement)
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001695
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001696 VkVertexInputStepRate stepRate; // Rate at which binding is incremented
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001697} VkVertexInputBindingDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001698
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001699typedef struct VkVertexInputAttributeDescription_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001700{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001701 uint32_t location; // location of the shader vertex attrib
1702 uint32_t binding; // Vertex buffer binding id
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001703
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001704 VkFormat format; // format of source data
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001705
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001706 uint32_t offsetInBytes; // Offset of first element in bytes from base of vertex
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001707} VkVertexInputAttributeDescription;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001708
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001709typedef struct VkPipelineVertexInputStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001710{
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001711 VkStructureType sType; // Should be VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001712 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001713
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001714 uint32_t bindingCount; // number of bindings
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001715 const VkVertexInputBindingDescription* pVertexBindingDescriptions;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001716
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001717 uint32_t attributeCount; // number of attributes
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001718 const VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001719} VkPipelineVertexInputStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001720
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001721typedef struct VkPipelineIaStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001722{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001723 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_IA_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001724 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001725 VkPrimitiveTopology topology;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001726 bool32_t disableVertexReuse; // optional
1727 bool32_t primitiveRestartEnable;
1728 uint32_t primitiveRestartIndex; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001729} VkPipelineIaStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001730
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001731typedef struct VkPipelineTessStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001732{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001733 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_TESS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001734 const void* pNext; // Pointer to next structure
1735 uint32_t patchControlPoints;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001736} VkPipelineTessStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001737
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001738typedef struct VkPipelineVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001739{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001740 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001741 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001742 uint32_t viewportCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001743 VkCoordinateOrigin clipOrigin; // optional (GL45)
1744 VkDepthMode depthMode; // optional (GL45)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001745} VkPipelineVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001746
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001747typedef struct VkPipelineRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001748{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001749 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001750 const void* pNext; // Pointer to next structure
1751 bool32_t depthClipEnable;
1752 bool32_t rasterizerDiscardEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001753 VkCoordinateOrigin pointOrigin; // optional (GL45)
Tony Barbour8205d902015-04-16 15:59:00 -06001754 VkProvokingVertex provokingVertex; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001755 VkFillMode fillMode; // optional (GL45)
1756 VkCullMode cullMode;
Tony Barbour8205d902015-04-16 15:59:00 -06001757 VkFrontFace frontFace;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001758} VkPipelineRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001759
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001760typedef struct VkPipelineMsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001761{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001762 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_MS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001763 const void* pNext; // Pointer to next structure
Tony Barboure094edf2015-06-26 10:18:34 -06001764 uint32_t rasterSamples;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001765 bool32_t multisampleEnable; // optional (GL45)
1766 bool32_t sampleShadingEnable; // optional (GL45)
1767 float minSampleShading; // optional (GL45)
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001768 VkSampleMask sampleMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001769} VkPipelineMsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001770
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001771typedef struct VkPipelineCbAttachmentState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001772{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001773 bool32_t blendEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001774 VkFormat format;
1775 VkBlend srcBlendColor;
1776 VkBlend destBlendColor;
Tony Barbour8205d902015-04-16 15:59:00 -06001777 VkBlendOp blendOpColor;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001778 VkBlend srcBlendAlpha;
1779 VkBlend destBlendAlpha;
Tony Barbour8205d902015-04-16 15:59:00 -06001780 VkBlendOp blendOpAlpha;
1781 VkChannelFlags channelWriteMask;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001782} VkPipelineCbAttachmentState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001783
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001784typedef struct VkPipelineCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001785{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001786 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001787 const void* pNext; // Pointer to next structure
1788 bool32_t alphaToCoverageEnable;
1789 bool32_t logicOpEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001790 VkLogicOp logicOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001791 uint32_t attachmentCount; // # of pAttachments
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001792 const VkPipelineCbAttachmentState* pAttachments;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001793} VkPipelineCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001794
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001795typedef struct VkStencilOpState_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001796{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001797 VkStencilOp stencilFailOp;
1798 VkStencilOp stencilPassOp;
1799 VkStencilOp stencilDepthFailOp;
Tony Barbour8205d902015-04-16 15:59:00 -06001800 VkCompareOp stencilCompareOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001801} VkStencilOpState;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001802
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001803typedef struct VkPipelineDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001804{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001805 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_DS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001806 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001807 VkFormat format;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001808 bool32_t depthTestEnable;
1809 bool32_t depthWriteEnable;
Tony Barbour8205d902015-04-16 15:59:00 -06001810 VkCompareOp depthCompareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001811 bool32_t depthBoundsEnable; // optional (depth_bounds_test)
1812 bool32_t stencilTestEnable;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001813 VkStencilOpState front;
1814 VkStencilOpState back;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001815} VkPipelineDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001816
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001817typedef struct VkGraphicsPipelineCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001818{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001819 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001820 const void* pNext; // Pointer to next structure
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -06001821 uint32_t stageCount;
1822 const VkPipelineShaderStageCreateInfo* pStages; // One entry for each active shader stage
1823 const VkPipelineVertexInputStateCreateInfo* pVertexInputState;
1824 const VkPipelineIaStateCreateInfo* pIaState;
1825 const VkPipelineTessStateCreateInfo* pTessState;
1826 const VkPipelineVpStateCreateInfo* pVpState;
1827 const VkPipelineRsStateCreateInfo* pRsState;
1828 const VkPipelineMsStateCreateInfo* pMsState;
1829 const VkPipelineDsStateCreateInfo* pDsState;
1830 const VkPipelineCbStateCreateInfo* pCbState;
Tony Barbour8205d902015-04-16 15:59:00 -06001831 VkPipelineCreateFlags flags; // Pipeline creation flags
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001832 VkPipelineLayout layout; // Interface layout of the pipeline
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001833} VkGraphicsPipelineCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001834
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001835typedef struct VkPipelineLayoutCreateInfo_
1836{
1837 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
1838 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06001839
Mark Lobodzinski556f7212015-04-17 14:11:39 -05001840 uint32_t descriptorSetCount; // Number of descriptor sets interfaced by the pipeline
1841 const VkDescriptorSetLayout* pSetLayouts; // Array of <setCount> number of descriptor set layout objects defining the layout of the
1842} VkPipelineLayoutCreateInfo;
1843
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001844typedef struct VkSamplerCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001845{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001846 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001847 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001848 VkTexFilter magFilter; // Filter mode for magnification
1849 VkTexFilter minFilter; // Filter mode for minifiation
1850 VkTexMipmapMode mipMode; // Mipmap selection mode
1851 VkTexAddress addressU;
1852 VkTexAddress addressV;
1853 VkTexAddress addressW;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001854 float mipLodBias;
1855 uint32_t maxAnisotropy;
Tony Barbour8205d902015-04-16 15:59:00 -06001856 VkCompareOp compareOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001857 float minLod;
1858 float maxLod;
Tony Barbour8205d902015-04-16 15:59:00 -06001859 VkBorderColor borderColor;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001860} VkSamplerCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001861
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001862typedef struct VkDynamicVpStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001863{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001864 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_VP_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001865 const void* pNext; // Pointer to next structure
1866 uint32_t viewportAndScissorCount; // number of entries in pViewports and pScissors
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001867 const VkViewport* pViewports;
1868 const VkRect* pScissors;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001869} VkDynamicVpStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001870
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001871typedef struct VkDynamicRsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001872{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001873 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_RS_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001874 const void* pNext; // Pointer to next structure
1875 float depthBias;
1876 float depthBiasClamp;
1877 float slopeScaledDepthBias;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001878 float lineWidth; // optional (GL45) - Width of lines
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001879} VkDynamicRsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001880
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001881typedef struct VkDynamicCbStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001882{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001883 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_CB_STATE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001884 const void* pNext; // Pointer to next structure
1885 float blendConst[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001886} VkDynamicCbStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001887
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001888typedef struct VkDynamicDsStateCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001889{
Mark Lobodzinski4405fbf2015-06-12 11:14:17 -06001890 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_DYNAMIC_DS_STATE_CREATE_INFO
1891 const void* pNext; // Pointer to next structure
1892 float minDepthBounds; // optional (depth_bounds_test)
1893 float maxDepthBounds; // optional (depth_bounds_test)
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001894 uint32_t stencilReadMask;
1895 uint32_t stencilWriteMask;
1896 uint32_t stencilFrontRef;
1897 uint32_t stencilBackRef;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001898} VkDynamicDsStateCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001899
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001900typedef struct VkCmdBufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001901{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001902 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001903 const void* pNext; // Pointer to next structure
1904 uint32_t queueNodeIndex;
Tony Barbour8205d902015-04-16 15:59:00 -06001905 VkCmdBufferCreateFlags flags; // Command buffer creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001906} VkCmdBufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001907
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001908typedef struct VkCmdBufferBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001909{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001910 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001911 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001912
Tony Barbour8205d902015-04-16 15:59:00 -06001913 VkCmdBufferOptimizeFlags flags; // Command buffer optimization flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001914} VkCmdBufferBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001915
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001916typedef struct VkRenderPassBegin_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001917{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001918 VkRenderPass renderPass;
1919 VkFramebuffer framebuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001920} VkRenderPassBegin;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001921
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001922typedef struct VkCmdBufferGraphicsBeginInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001923{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001924 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_CMD_BUFFER_GRAPHICS_BEGIN_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001925 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001926
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001927 VkRenderPassBegin renderPassContinue; // Only needed when a render pass is split across two command buffers
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001928} VkCmdBufferGraphicsBeginInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001929
1930// 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 -06001931typedef union VkClearColorValue_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001932{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001933 float floatColor[4];
1934 uint32_t rawColor[4];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001935} VkClearColorValue;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001936
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001937typedef struct VkClearColor_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001938{
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001939 VkClearColorValue color;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001940 bool32_t useRawValue;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001941} VkClearColor;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001942
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001943typedef struct VkRenderPassCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001944{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001945 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001946 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001947
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001948 VkRect renderArea;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001949 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001950 VkExtent2D extent;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001951 uint32_t sampleCount;
1952 uint32_t layers;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001953 const VkFormat* pColorFormats;
1954 const VkImageLayout* pColorLayouts;
1955 const VkAttachmentLoadOp* pColorLoadOps;
1956 const VkAttachmentStoreOp* pColorStoreOps;
1957 const VkClearColor* pColorLoadClearValues;
1958 VkFormat depthStencilFormat;
1959 VkImageLayout depthStencilLayout;
1960 VkAttachmentLoadOp depthLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001961 float depthLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001962 VkAttachmentStoreOp depthStoreOp;
1963 VkAttachmentLoadOp stencilLoadOp;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001964 uint32_t stencilLoadClearValue;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001965 VkAttachmentStoreOp stencilStoreOp;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001966} VkRenderPassCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001967
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001968typedef struct VkEventCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001969{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001970 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_EVENT_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001971 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001972 VkEventCreateFlags flags; // Event creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001973} VkEventCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001974
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001975typedef struct VkFenceCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001976{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001977 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001978 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001979 VkFenceCreateFlags flags; // Fence creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001980} VkFenceCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001981
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001982typedef struct VkSemaphoreCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001983{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06001984 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001985 const void* pNext; // Pointer to next structure
Tony Barbour8205d902015-04-16 15:59:00 -06001986 VkSemaphoreCreateFlags flags; // Semaphore creation flags
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001987} VkSemaphoreCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001988
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001989typedef struct VkQueryPoolCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001990{
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001991 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO
1992 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06001993 VkQueryType queryType;
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001994 uint32_t slots;
Courtney Goeltzenleuchter29862812015-04-16 09:13:59 -06001995 VkQueryPipelineStatisticFlags pipelineStatistics; // Optional
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001996} VkQueryPoolCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001997
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001998typedef struct VkFramebufferCreateInfo_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06001999{
Courtney Goeltzenleuchter136eb182015-04-10 16:34:21 -06002000 VkStructureType sType; // Must be VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002001 const void* pNext; // Pointer to next structure
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002002
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002003 uint32_t colorAttachmentCount;
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002004 const VkColorAttachmentBindInfo* pColorAttachments;
2005 const VkDepthStencilBindInfo* pDepthStencilAttachment;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002006
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002007 uint32_t sampleCount;
2008 uint32_t width;
2009 uint32_t height;
2010 uint32_t layers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002011} VkFramebufferCreateInfo;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002012
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002013typedef struct VkDrawIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002014{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002015 uint32_t vertexCount;
2016 uint32_t instanceCount;
2017 uint32_t firstVertex;
2018 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002019} VkDrawIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002020
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002021typedef struct VkDrawIndexedIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002022{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002023 uint32_t indexCount;
2024 uint32_t instanceCount;
2025 uint32_t firstIndex;
2026 int32_t vertexOffset;
2027 uint32_t firstInstance;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002028} VkDrawIndexedIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002029
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002030typedef struct VkDispatchIndirectCmd_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002031{
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06002032 uint32_t x;
2033 uint32_t y;
2034 uint32_t z;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002035} VkDispatchIndirectCmd;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002036
2037// ------------------------------------------------------------------------------------------------
2038// API functions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002039typedef VkResult (VKAPI *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance);
2040typedef VkResult (VKAPI *PFN_vkDestroyInstance)(VkInstance instance);
Tony Barbour8205d902015-04-16 15:59:00 -06002041typedef VkResult (VKAPI *PFN_vkEnumeratePhysicalDevices)(VkInstance instance, uint32_t* pPhysicalDeviceCount, VkPhysicalDevice* pPhysicalDevices);
Chris Forbesd7576302015-06-21 22:55:02 +12002042typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFeatures)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures);
2043typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceFormatInfo)(VkPhysicalDevice physicalDevice, VkFormat format, VkFormatProperties *pFormatInfo);
2044typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceLimits)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceLimits* pLimits);
Jon Ashburn53c16772015-05-06 10:15:07 -06002045typedef void * (VKAPI *PFN_vkGetInstanceProcAddr)(VkInstance instance, const char * pName);
Jon Ashburn1245cec2015-05-18 13:20:15 -06002046typedef void * (VKAPI *PFN_vkGetDeviceProcAddr)(VkDevice device, const char * pName);
Tony Barbour8205d902015-04-16 15:59:00 -06002047typedef VkResult (VKAPI *PFN_vkCreateDevice)(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, VkDevice* pDevice);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002048typedef VkResult (VKAPI *PFN_vkDestroyDevice)(VkDevice device);
Tony Barbour426b9052015-06-24 16:06:58 -06002049typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties* pProperties);
2050typedef VkResult (VKAPI *PFN_vkGetPhysicalDevicePerformance)(VkPhysicalDevice physicalDevice, VkPhysicalDevicePerformance* pPerformance);
2051typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2052typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceQueueProperties)(VkPhysicalDevice physicalDevice, uint32_t count, VkPhysicalDeviceQueueProperties* pQueueProperties);
2053typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceMemoryProperties)(VkPhysicalDevice physicalDevice, VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2054typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionCount)(uint32_t* pCount);
2055typedef VkResult (VKAPI *PFN_vkGetGlobalExtensionProperties)(uint32_t extensionIndex, VkExtensionProperties* pProperties);
2056typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionCount)(VkPhysicalDevice physicalDevice, uint32_t* pCount);
2057typedef VkResult (VKAPI *PFN_vkGetPhysicalDeviceExtensionProperties)(VkPhysicalDevice physicalDevice, uint32_t extensionIndex, VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002058typedef VkResult (VKAPI *PFN_vkGetDeviceQueue)(VkDevice device, uint32_t queueNodeIndex, uint32_t queueIndex, VkQueue* pQueue);
2059typedef VkResult (VKAPI *PFN_vkQueueSubmit)(VkQueue queue, uint32_t cmdBufferCount, const VkCmdBuffer* pCmdBuffers, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002060typedef VkResult (VKAPI *PFN_vkQueueWaitIdle)(VkQueue queue);
2061typedef VkResult (VKAPI *PFN_vkDeviceWaitIdle)(VkDevice device);
Tony Barbour8205d902015-04-16 15:59:00 -06002062typedef VkResult (VKAPI *PFN_vkAllocMemory)(VkDevice device, const VkMemoryAllocInfo* pAllocInfo, VkDeviceMemory* pMem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002063typedef VkResult (VKAPI *PFN_vkFreeMemory)(VkDevice device, VkDeviceMemory mem);
Mike Stroyan230e6252015-04-17 12:36:38 -06002064typedef VkResult (VKAPI *PFN_vkMapMemory)(VkDevice device, VkDeviceMemory mem, VkDeviceSize offset, VkDeviceSize size, VkMemoryMapFlags flags, void** ppData);
2065typedef VkResult (VKAPI *PFN_vkUnmapMemory)(VkDevice device, VkDeviceMemory mem);
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002066typedef VkResult (VKAPI *PFN_vkFlushMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
2067typedef VkResult (VKAPI *PFN_vkInvalidateMappedMemoryRanges)(VkDevice device, uint32_t memRangeCount, const VkMappedMemoryRange* pMemRanges);
Mike Stroyan230e6252015-04-17 12:36:38 -06002068typedef VkResult (VKAPI *PFN_vkDestroyObject)(VkDevice device, VkObjectType objType, VkObject object);
Tony Barbour426b9052015-06-24 16:06:58 -06002069typedef VkResult (VKAPI *PFN_vkGetObjectMemoryRequirements)(VkDevice device, VkObjectType objType, VkObject object, VkMemoryRequirements* pMemoryRequirements);
Mark Lobodzinski23182612015-05-29 09:32:35 -05002070typedef VkResult (VKAPI *PFN_vkBindObjectMemory)(VkDevice device, VkObjectType objType, VkObject object, VkDeviceMemory mem, VkDeviceSize offset);
2071typedef VkResult (VKAPI *PFN_vkQueueBindSparseBufferMemory)(VkQueue queue, VkBuffer buffer, VkDeviceSize rangeOffset, VkDeviceSize rangeSize, VkDeviceMemory mem, VkDeviceSize memOffset);
2072typedef VkResult (VKAPI *PFN_vkQueueBindSparseImageMemory)(VkQueue queue, VkImage image, const VkImageMemoryBindInfo* pBindInfo, VkDeviceMemory mem, VkDeviceSize memOffset);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002073typedef VkResult (VKAPI *PFN_vkCreateFence)(VkDevice device, const VkFenceCreateInfo* pCreateInfo, VkFence* pFence);
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002074typedef VkResult (VKAPI *PFN_vkResetFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences);
Mike Stroyan230e6252015-04-17 12:36:38 -06002075typedef VkResult (VKAPI *PFN_vkGetFenceStatus)(VkDevice device, VkFence fence);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002076typedef VkResult (VKAPI *PFN_vkWaitForFences)(VkDevice device, uint32_t fenceCount, const VkFence* pFences, bool32_t waitAll, uint64_t timeout);
2077typedef VkResult (VKAPI *PFN_vkCreateSemaphore)(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo, VkSemaphore* pSemaphore);
2078typedef VkResult (VKAPI *PFN_vkQueueSignalSemaphore)(VkQueue queue, VkSemaphore semaphore);
2079typedef VkResult (VKAPI *PFN_vkQueueWaitSemaphore)(VkQueue queue, VkSemaphore semaphore);
2080typedef VkResult (VKAPI *PFN_vkCreateEvent)(VkDevice device, const VkEventCreateInfo* pCreateInfo, VkEvent* pEvent);
Mike Stroyan230e6252015-04-17 12:36:38 -06002081typedef VkResult (VKAPI *PFN_vkGetEventStatus)(VkDevice device, VkEvent event);
2082typedef VkResult (VKAPI *PFN_vkSetEvent)(VkDevice device, VkEvent event);
2083typedef VkResult (VKAPI *PFN_vkResetEvent)(VkDevice device, VkEvent event);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002084typedef VkResult (VKAPI *PFN_vkCreateQueryPool)(VkDevice device, const VkQueryPoolCreateInfo* pCreateInfo, VkQueryPool* pQueryPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002085typedef 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 -06002086typedef VkResult (VKAPI *PFN_vkCreateBuffer)(VkDevice device, const VkBufferCreateInfo* pCreateInfo, VkBuffer* pBuffer);
2087typedef VkResult (VKAPI *PFN_vkCreateBufferView)(VkDevice device, const VkBufferViewCreateInfo* pCreateInfo, VkBufferView* pView);
2088typedef VkResult (VKAPI *PFN_vkCreateImage)(VkDevice device, const VkImageCreateInfo* pCreateInfo, VkImage* pImage);
Tony Barbour426b9052015-06-24 16:06:58 -06002089typedef VkResult (VKAPI *PFN_vkGetImageSubresourceLayout)(VkDevice device, VkImage image, const VkImageSubresource* pSubresource, VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002090typedef VkResult (VKAPI *PFN_vkCreateImageView)(VkDevice device, const VkImageViewCreateInfo* pCreateInfo, VkImageView* pView);
2091typedef VkResult (VKAPI *PFN_vkCreateColorAttachmentView)(VkDevice device, const VkColorAttachmentViewCreateInfo* pCreateInfo, VkColorAttachmentView* pView);
2092typedef VkResult (VKAPI *PFN_vkCreateDepthStencilView)(VkDevice device, const VkDepthStencilViewCreateInfo* pCreateInfo, VkDepthStencilView* pView);
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002093typedef VkResult (VKAPI *PFN_vkCreateShaderModule)(VkDevice device, const VkShaderModuleCreateInfo* pCreateInfo, VkShaderModule* pShaderModule);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002094typedef VkResult (VKAPI *PFN_vkCreateShader)(VkDevice device, const VkShaderCreateInfo* pCreateInfo, VkShader* pShader);
2095typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipeline)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
2096typedef VkResult (VKAPI *PFN_vkCreateGraphicsPipelineDerivative)(VkDevice device, const VkGraphicsPipelineCreateInfo* pCreateInfo, VkPipeline basePipeline, VkPipeline* pPipeline);
2097typedef VkResult (VKAPI *PFN_vkCreateComputePipeline)(VkDevice device, const VkComputePipelineCreateInfo* pCreateInfo, VkPipeline* pPipeline);
Mike Stroyan230e6252015-04-17 12:36:38 -06002098typedef VkResult (VKAPI *PFN_vkStorePipeline)(VkDevice device, VkPipeline pipeline, size_t* pDataSize, void* pData);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002099typedef VkResult (VKAPI *PFN_vkLoadPipeline)(VkDevice device, size_t dataSize, const void* pData, VkPipeline* pPipeline);
2100typedef VkResult (VKAPI *PFN_vkLoadPipelineDerivative)(VkDevice device, size_t dataSize, const void* pData, VkPipeline basePipeline, VkPipeline* pPipeline);
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002101typedef VkResult (VKAPI *PFN_vkCreatePipelineLayout)(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo, VkPipelineLayout* pPipelineLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002102typedef VkResult (VKAPI *PFN_vkCreateSampler)(VkDevice device, const VkSamplerCreateInfo* pCreateInfo, VkSampler* pSampler);
2103typedef VkResult (VKAPI *PFN_vkCreateDescriptorSetLayout)(VkDevice device, const VkDescriptorSetLayoutCreateInfo* pCreateInfo, VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002104typedef VkResult (VKAPI *PFN_vkCreateDescriptorPool)(VkDevice device, VkDescriptorPoolUsage poolUsage, uint32_t maxSets, const VkDescriptorPoolCreateInfo* pCreateInfo, VkDescriptorPool* pDescriptorPool);
Mike Stroyan230e6252015-04-17 12:36:38 -06002105typedef VkResult (VKAPI *PFN_vkResetDescriptorPool)(VkDevice device, VkDescriptorPool descriptorPool);
2106typedef 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 +08002107typedef 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 -06002108typedef VkResult (VKAPI *PFN_vkCreateDynamicViewportState)(VkDevice device, const VkDynamicVpStateCreateInfo* pCreateInfo, VkDynamicVpState* pState);
2109typedef VkResult (VKAPI *PFN_vkCreateDynamicRasterState)(VkDevice device, const VkDynamicRsStateCreateInfo* pCreateInfo, VkDynamicRsState* pState);
2110typedef VkResult (VKAPI *PFN_vkCreateDynamicColorBlendState)(VkDevice device, const VkDynamicCbStateCreateInfo* pCreateInfo, VkDynamicCbState* pState);
2111typedef VkResult (VKAPI *PFN_vkCreateDynamicDepthStencilState)(VkDevice device, const VkDynamicDsStateCreateInfo* pCreateInfo, VkDynamicDsState* pState);
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002112typedef VkResult (VKAPI *PFN_vkCreateCommandBuffer)(VkDevice device, const VkCmdBufferCreateInfo* pCreateInfo, VkCmdBuffer* pCmdBuffer);
2113typedef VkResult (VKAPI *PFN_vkBeginCommandBuffer)(VkCmdBuffer cmdBuffer, const VkCmdBufferBeginInfo* pBeginInfo);
2114typedef VkResult (VKAPI *PFN_vkEndCommandBuffer)(VkCmdBuffer cmdBuffer);
2115typedef VkResult (VKAPI *PFN_vkResetCommandBuffer)(VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002116typedef void (VKAPI *PFN_vkCmdBindPipeline)(VkCmdBuffer cmdBuffer, VkPipelineBindPoint pipelineBindPoint, VkPipeline pipeline);
2117typedef void (VKAPI *PFN_vkCmdBindDynamicStateObject)(VkCmdBuffer cmdBuffer, VkStateBindPoint stateBindPoint, VkDynamicStateObject state);
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002118typedef 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 -06002119typedef void (VKAPI *PFN_vkCmdBindIndexBuffer)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, VkIndexType indexType);
2120typedef 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 -06002121typedef void (VKAPI *PFN_vkCmdDraw)(VkCmdBuffer cmdBuffer, uint32_t firstVertex, uint32_t vertexCount, uint32_t firstInstance, uint32_t instanceCount);
2122typedef 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 -06002123typedef void (VKAPI *PFN_vkCmdDrawIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
2124typedef void (VKAPI *PFN_vkCmdDrawIndexedIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t count, uint32_t stride);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002125typedef void (VKAPI *PFN_vkCmdDispatch)(VkCmdBuffer cmdBuffer, uint32_t x, uint32_t y, uint32_t z);
Tony Barbour8205d902015-04-16 15:59:00 -06002126typedef void (VKAPI *PFN_vkCmdDispatchIndirect)(VkCmdBuffer cmdBuffer, VkBuffer buffer, VkDeviceSize offset);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002127typedef void (VKAPI *PFN_vkCmdCopyBuffer)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkBuffer destBuffer, uint32_t regionCount, const VkBufferCopy* pRegions);
2128typedef 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 -05002129typedef 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 -06002130typedef void (VKAPI *PFN_vkCmdCopyBufferToImage)(VkCmdBuffer cmdBuffer, VkBuffer srcBuffer, VkImage destImage, VkImageLayout destImageLayout, uint32_t regionCount, const VkBufferImageCopy* pRegions);
2131typedef 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 -06002132typedef void (VKAPI *PFN_vkCmdUpdateBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize dataSize, const uint32_t* pData);
2133typedef void (VKAPI *PFN_vkCmdFillBuffer)(VkCmdBuffer cmdBuffer, VkBuffer destBuffer, VkDeviceSize destOffset, VkDeviceSize fillSize, uint32_t data);
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002134typedef 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 -06002135typedef 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 -06002136typedef 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 -06002137typedef void (VKAPI *PFN_vkCmdSetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2138typedef void (VKAPI *PFN_vkCmdResetEvent)(VkCmdBuffer cmdBuffer, VkEvent event, VkPipelineStageFlags stageMask);
2139typedef void (VKAPI *PFN_vkCmdWaitEvents)(VkCmdBuffer cmdBuffer, uint32_t eventCount, const VkEvent* pEvents, VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags destStageMask, uint32_t memBarrierCount, const void** ppMemBarriers);
2140typedef 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 -06002141typedef void (VKAPI *PFN_vkCmdBeginQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot, VkQueryControlFlags flags);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002142typedef void (VKAPI *PFN_vkCmdEndQuery)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t slot);
2143typedef void (VKAPI *PFN_vkCmdResetQueryPool)(VkCmdBuffer cmdBuffer, VkQueryPool queryPool, uint32_t startQuery, uint32_t queryCount);
Tony Barbour8205d902015-04-16 15:59:00 -06002144typedef void (VKAPI *PFN_vkCmdWriteTimestamp)(VkCmdBuffer cmdBuffer, VkTimestampType timestampType, VkBuffer destBuffer, VkDeviceSize destOffset);
Tony Barbour3e3420a2015-04-16 19:09:28 -06002145typedef 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 -06002146typedef VkResult (VKAPI *PFN_vkCreateFramebuffer)(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo, VkFramebuffer* pFramebuffer);
2147typedef VkResult (VKAPI *PFN_vkCreateRenderPass)(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo, VkRenderPass* pRenderPass);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002148typedef void (VKAPI *PFN_vkCmdBeginRenderPass)(VkCmdBuffer cmdBuffer, const VkRenderPassBegin* pRenderPassBegin);
2149typedef void (VKAPI *PFN_vkCmdEndRenderPass)(VkCmdBuffer cmdBuffer, VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002150
2151#ifdef VK_PROTOTYPES
2152
Tony Barbour8205d902015-04-16 15:59:00 -06002153// Device initialization
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002154
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002155VkResult VKAPI vkCreateInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002156 const VkInstanceCreateInfo* pCreateInfo,
2157 VkInstance* pInstance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002158
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002159VkResult VKAPI vkDestroyInstance(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002160 VkInstance instance);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002161
Jon Ashburn07b309a2015-04-15 11:31:12 -06002162VkResult VKAPI vkEnumeratePhysicalDevices(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002163 VkInstance instance,
Jon Ashburn07b309a2015-04-15 11:31:12 -06002164 uint32_t* pPhysicalDeviceCount,
Tony Barbour8205d902015-04-16 15:59:00 -06002165 VkPhysicalDevice* pPhysicalDevices);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002166
Chris Forbesd7576302015-06-21 22:55:02 +12002167VkResult VKAPI vkGetPhysicalDeviceFeatures(
2168 VkPhysicalDevice physicalDevice,
2169 VkPhysicalDeviceFeatures* pFeatures);
2170
2171VkResult VKAPI vkGetPhysicalDeviceFormatInfo(
2172 VkPhysicalDevice physicalDevice,
2173 VkFormat format,
2174 VkFormatProperties* pFormatInfo);
2175
2176VkResult VKAPI vkGetPhysicalDeviceLimits(
2177 VkPhysicalDevice physicalDevice,
2178 VkPhysicalDeviceLimits* pLimits);
2179
Jon Ashburn53c16772015-05-06 10:15:07 -06002180void * VKAPI vkGetInstanceProcAddr(
2181 VkInstance instance,
2182 const char* pName);
2183
Jon Ashburn1245cec2015-05-18 13:20:15 -06002184void * VKAPI vkGetDeviceProcAddr(
2185 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002186 const char* pName);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002187// Device functions
2188
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002189VkResult VKAPI vkCreateDevice(
Tony Barbour8205d902015-04-16 15:59:00 -06002190 VkPhysicalDevice physicalDevice,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002191 const VkDeviceCreateInfo* pCreateInfo,
2192 VkDevice* pDevice);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002193
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002194VkResult VKAPI vkDestroyDevice(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002195 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002196
Tony Barbour426b9052015-06-24 16:06:58 -06002197VkResult VKAPI vkGetPhysicalDeviceProperties(
2198 VkPhysicalDevice physicalDevice,
2199 VkPhysicalDeviceProperties* pProperties);
2200
2201VkResult VKAPI vkGetPhysicalDevicePerformance(
2202 VkPhysicalDevice physicalDevice,
2203 VkPhysicalDevicePerformance* pPerformance);
2204
2205VkResult VKAPI vkGetPhysicalDeviceQueueCount(
2206 VkPhysicalDevice physicalDevice,
2207 uint32_t* pCount);
2208
2209VkResult VKAPI vkGetPhysicalDeviceQueueProperties(
2210 VkPhysicalDevice physicalDevice,
2211 uint32_t count,
2212 VkPhysicalDeviceQueueProperties* pQueueProperties);
2213
2214VkResult VKAPI vkGetPhysicalDeviceMemoryProperties(
2215 VkPhysicalDevice physicalDevice,
2216 VkPhysicalDeviceMemoryProperties* pMemoryProperies);
2217
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002218// Extension discovery functions
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002219
Tony Barbour426b9052015-06-24 16:06:58 -06002220VkResult VKAPI vkGetGlobalExtensionCount(
2221 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002222
Tony Barbour426b9052015-06-24 16:06:58 -06002223VkResult VKAPI vkGetGlobalExtensionProperties(
Courtney Goeltzenleuchter699e2aa2015-04-17 20:48:17 -06002224 uint32_t extensionIndex,
Tony Barbour426b9052015-06-24 16:06:58 -06002225 VkExtensionProperties* pProperties);
2226
2227VkResult VKAPI vkGetPhysicalDeviceExtensionCount(
2228 VkPhysicalDevice physicalDevice,
2229 uint32_t* pCount);
2230
2231VkResult VKAPI vkGetPhysicalDeviceExtensionProperties(
2232 VkPhysicalDevice physicalDevice,
2233 uint32_t extensionIndex,
2234 VkExtensionProperties* pProperties);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002235
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002236// Queue functions
2237
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002238VkResult VKAPI vkGetDeviceQueue(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002239 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002240 uint32_t queueNodeIndex,
2241 uint32_t queueIndex,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002242 VkQueue* pQueue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002243
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002244VkResult VKAPI vkQueueSubmit(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002245 VkQueue queue,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002246 uint32_t cmdBufferCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002247 const VkCmdBuffer* pCmdBuffers,
2248 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002249
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002250VkResult VKAPI vkQueueWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002251 VkQueue queue);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002252
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002253VkResult VKAPI vkDeviceWaitIdle(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002254 VkDevice device);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002255
2256// Memory functions
2257
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002258VkResult VKAPI vkAllocMemory(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002259 VkDevice device,
2260 const VkMemoryAllocInfo* pAllocInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002261 VkDeviceMemory* pMem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002262
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002263VkResult VKAPI vkFreeMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002264 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002265 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002266
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002267VkResult VKAPI vkMapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002268 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002269 VkDeviceMemory mem,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002270 VkDeviceSize offset,
2271 VkDeviceSize size,
Tony Barbour8205d902015-04-16 15:59:00 -06002272 VkMemoryMapFlags flags,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002273 void** ppData);
2274
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002275VkResult VKAPI vkUnmapMemory(
Mike Stroyan230e6252015-04-17 12:36:38 -06002276 VkDevice device,
Tony Barbour8205d902015-04-16 15:59:00 -06002277 VkDeviceMemory mem);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002278
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002279VkResult VKAPI vkFlushMappedMemoryRanges(
Mike Stroyan230e6252015-04-17 12:36:38 -06002280 VkDevice device,
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -06002281 uint32_t memRangeCount,
2282 const VkMappedMemoryRange* pMemRanges);
2283
2284VkResult VKAPI vkInvalidateMappedMemoryRanges(
2285 VkDevice device,
2286 uint32_t memRangeCount,
2287 const VkMappedMemoryRange* pMemRanges);
Tony Barbour859ceab2015-04-16 19:23:13 -06002288
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002289// Generic API object functions
2290
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002291VkResult VKAPI vkDestroyObject(
Mike Stroyan230e6252015-04-17 12:36:38 -06002292 VkDevice device,
2293 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002294 VkObject object);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002295
Tony Barbour3e3420a2015-04-16 19:09:28 -06002296// Memory management API functions
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002297
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002298VkResult VKAPI vkBindObjectMemory(
2299 VkDevice device,
Mike Stroyan230e6252015-04-17 12:36:38 -06002300 VkObjectType objType,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002301 VkObject object,
Tony Barbour8205d902015-04-16 15:59:00 -06002302 VkDeviceMemory mem,
2303 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002304
Tony Barbour426b9052015-06-24 16:06:58 -06002305VkResult VKAPI vkGetObjectMemoryRequirements(
2306 VkDevice device,
2307 VkObjectType objType,
2308 VkObject object,
2309 VkMemoryRequirements* pMemoryRequirements);
2310
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002311VkResult VKAPI vkQueueBindSparseBufferMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002312 VkQueue queue,
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002313 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002314 VkDeviceSize rangeOffset,
2315 VkDeviceSize rangeSize,
2316 VkDeviceMemory mem,
2317 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002318
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -05002319VkResult VKAPI vkQueueBindSparseImageMemory(
Mark Lobodzinskicf26e072015-04-16 11:44:05 -05002320 VkQueue queue,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002321 VkImage image,
Jeremy Hayes47536532015-04-15 15:20:03 -06002322 const VkImageMemoryBindInfo* pBindInfo,
Tony Barbour8205d902015-04-16 15:59:00 -06002323 VkDeviceMemory mem,
2324 VkDeviceSize memOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002325
2326// Fence functions
2327
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002328VkResult VKAPI vkCreateFence(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002329 VkDevice device,
2330 const VkFenceCreateInfo* pCreateInfo,
2331 VkFence* pFence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002332
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002333VkResult VKAPI vkResetFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002334 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002335 uint32_t fenceCount,
Courtney Goeltzenleuchterf2e33ad2015-06-18 17:28:20 -06002336 const VkFence* pFences);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002337
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002338VkResult VKAPI vkGetFenceStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002339 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002340 VkFence fence);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002341
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002342VkResult VKAPI vkWaitForFences(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002343 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002344 uint32_t fenceCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002345 const VkFence* pFences,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002346 bool32_t waitAll,
2347 uint64_t timeout); // timeout in nanoseconds
2348
2349// Queue semaphore functions
2350
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002351VkResult VKAPI vkCreateSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002352 VkDevice device,
2353 const VkSemaphoreCreateInfo* pCreateInfo,
2354 VkSemaphore* pSemaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002355
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002356VkResult VKAPI vkQueueSignalSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002357 VkQueue queue,
2358 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002359
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002360VkResult VKAPI vkQueueWaitSemaphore(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002361 VkQueue queue,
2362 VkSemaphore semaphore);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002363
2364// Event functions
2365
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002366VkResult VKAPI vkCreateEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002367 VkDevice device,
2368 const VkEventCreateInfo* pCreateInfo,
2369 VkEvent* pEvent);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002370
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002371VkResult VKAPI vkGetEventStatus(
Mike Stroyan230e6252015-04-17 12:36:38 -06002372 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002373 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002374
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002375VkResult VKAPI vkSetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002376 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002377 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002378
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002379VkResult VKAPI vkResetEvent(
Mike Stroyan230e6252015-04-17 12:36:38 -06002380 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002381 VkEvent event);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002382
2383// Query functions
2384
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002385VkResult VKAPI vkCreateQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002386 VkDevice device,
2387 const VkQueryPoolCreateInfo* pCreateInfo,
2388 VkQueryPool* pQueryPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002389
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002390VkResult VKAPI vkGetQueryPoolResults(
Mike Stroyan230e6252015-04-17 12:36:38 -06002391 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002392 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002393 uint32_t startQuery,
2394 uint32_t queryCount,
2395 size_t* pDataSize,
Tony Barbour8205d902015-04-16 15:59:00 -06002396 void* pData,
2397 VkQueryResultFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002398
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002399// Buffer functions
2400
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002401VkResult VKAPI vkCreateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002402 VkDevice device,
2403 const VkBufferCreateInfo* pCreateInfo,
2404 VkBuffer* pBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002405
2406// Buffer view functions
2407
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002408VkResult VKAPI vkCreateBufferView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002409 VkDevice device,
2410 const VkBufferViewCreateInfo* pCreateInfo,
2411 VkBufferView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002412
2413// Image functions
2414
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002415VkResult VKAPI vkCreateImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002416 VkDevice device,
2417 const VkImageCreateInfo* pCreateInfo,
2418 VkImage* pImage);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002419
Tony Barbour426b9052015-06-24 16:06:58 -06002420VkResult VKAPI vkGetImageSubresourceLayout(
Mike Stroyan230e6252015-04-17 12:36:38 -06002421 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002422 VkImage image,
2423 const VkImageSubresource* pSubresource,
Tony Barbour426b9052015-06-24 16:06:58 -06002424 VkSubresourceLayout* pLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002425
2426// Image view functions
2427
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002428VkResult VKAPI vkCreateImageView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002429 VkDevice device,
2430 const VkImageViewCreateInfo* pCreateInfo,
2431 VkImageView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002432
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002433VkResult VKAPI vkCreateColorAttachmentView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002434 VkDevice device,
2435 const VkColorAttachmentViewCreateInfo* pCreateInfo,
2436 VkColorAttachmentView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002437
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002438VkResult VKAPI vkCreateDepthStencilView(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002439 VkDevice device,
2440 const VkDepthStencilViewCreateInfo* pCreateInfo,
2441 VkDepthStencilView* pView);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002442
2443// Shader functions
2444
Courtney Goeltzenleuchter1d723102015-06-18 21:49:59 -06002445VkResult VKAPI vkCreateShaderModule(
2446 VkDevice device,
2447 const VkShaderModuleCreateInfo* pCreateInfo,
2448 VkShaderModule* pShaderModule);
2449
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002450VkResult VKAPI vkCreateShader(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002451 VkDevice device,
2452 const VkShaderCreateInfo* pCreateInfo,
2453 VkShader* pShader);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002454
2455// Pipeline functions
2456
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002457VkResult VKAPI vkCreateGraphicsPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002458 VkDevice device,
2459 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2460 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002461
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002462VkResult VKAPI vkCreateGraphicsPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002463 VkDevice device,
2464 const VkGraphicsPipelineCreateInfo* pCreateInfo,
2465 VkPipeline basePipeline,
2466 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002467
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002468VkResult VKAPI vkCreateComputePipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002469 VkDevice device,
2470 const VkComputePipelineCreateInfo* pCreateInfo,
2471 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002472
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002473VkResult VKAPI vkStorePipeline(
Mike Stroyan230e6252015-04-17 12:36:38 -06002474 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002475 VkPipeline pipeline,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002476 size_t* pDataSize,
2477 void* pData);
2478
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002479VkResult VKAPI vkLoadPipeline(
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* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002484
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002485VkResult VKAPI vkLoadPipelineDerivative(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002486 VkDevice device,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002487 size_t dataSize,
2488 const void* pData,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002489 VkPipeline basePipeline,
2490 VkPipeline* pPipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002491
Mark Lobodzinski556f7212015-04-17 14:11:39 -05002492// Pipeline layout functions
2493
2494VkResult VKAPI vkCreatePipelineLayout(
2495 VkDevice device,
2496 const VkPipelineLayoutCreateInfo* pCreateInfo,
2497 VkPipelineLayout* pPipelineLayout);
2498
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002499// Sampler functions
2500
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002501VkResult VKAPI vkCreateSampler(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002502 VkDevice device,
2503 const VkSamplerCreateInfo* pCreateInfo,
2504 VkSampler* pSampler);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002505
2506// Descriptor set functions
2507
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002508VkResult VKAPI vkCreateDescriptorSetLayout(
2509 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002510 const VkDescriptorSetLayoutCreateInfo* pCreateInfo,
2511 VkDescriptorSetLayout* pSetLayout);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002512
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002513VkResult VKAPI vkCreateDescriptorPool(
2514 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002515 VkDescriptorPoolUsage poolUsage,
2516 uint32_t maxSets,
2517 const VkDescriptorPoolCreateInfo* pCreateInfo,
2518 VkDescriptorPool* pDescriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002519
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002520VkResult VKAPI vkResetDescriptorPool(
Mike Stroyan230e6252015-04-17 12:36:38 -06002521 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002522 VkDescriptorPool descriptorPool);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002523
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002524VkResult VKAPI vkAllocDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002525 VkDevice device,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002526 VkDescriptorPool descriptorPool,
2527 VkDescriptorSetUsage setUsage,
2528 uint32_t count,
2529 const VkDescriptorSetLayout* pSetLayouts,
2530 VkDescriptorSet* pDescriptorSets,
2531 uint32_t* pCount);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002532
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002533VkResult VKAPI vkUpdateDescriptorSets(
Mike Stroyan230e6252015-04-17 12:36:38 -06002534 VkDevice device,
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +08002535 uint32_t writeCount,
2536 const VkWriteDescriptorSet* pDescriptorWrites,
2537 uint32_t copyCount,
2538 const VkCopyDescriptorSet* pDescriptorCopies);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002539
2540// State object functions
2541
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002542VkResult VKAPI vkCreateDynamicViewportState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002543 VkDevice device,
2544 const VkDynamicVpStateCreateInfo* pCreateInfo,
2545 VkDynamicVpState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002546
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002547VkResult VKAPI vkCreateDynamicRasterState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002548 VkDevice device,
2549 const VkDynamicRsStateCreateInfo* pCreateInfo,
2550 VkDynamicRsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002551
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002552VkResult VKAPI vkCreateDynamicColorBlendState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002553 VkDevice device,
2554 const VkDynamicCbStateCreateInfo* pCreateInfo,
2555 VkDynamicCbState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002556
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002557VkResult VKAPI vkCreateDynamicDepthStencilState(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002558 VkDevice device,
2559 const VkDynamicDsStateCreateInfo* pCreateInfo,
2560 VkDynamicDsState* pState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002561
2562// Command buffer functions
2563
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002564VkResult VKAPI vkCreateCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002565 VkDevice device,
2566 const VkCmdBufferCreateInfo* pCreateInfo,
2567 VkCmdBuffer* pCmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002568
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002569VkResult VKAPI vkBeginCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002570 VkCmdBuffer cmdBuffer,
2571 const VkCmdBufferBeginInfo* pBeginInfo);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002572
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002573VkResult VKAPI vkEndCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002574 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002575
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002576VkResult VKAPI vkResetCommandBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002577 VkCmdBuffer cmdBuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002578
2579// Command buffer building functions
2580
2581void VKAPI vkCmdBindPipeline(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002582 VkCmdBuffer cmdBuffer,
2583 VkPipelineBindPoint pipelineBindPoint,
2584 VkPipeline pipeline);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002585
2586void VKAPI vkCmdBindDynamicStateObject(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002587 VkCmdBuffer cmdBuffer,
2588 VkStateBindPoint stateBindPoint,
2589 VkDynamicStateObject dynamicState);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002590
2591void VKAPI vkCmdBindDescriptorSets(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002592 VkCmdBuffer cmdBuffer,
2593 VkPipelineBindPoint pipelineBindPoint,
Mark Lobodzinskia65c4632015-06-15 13:21:21 -06002594 VkPipelineLayout layout,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002595 uint32_t firstSet,
2596 uint32_t setCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002597 const VkDescriptorSet* pDescriptorSets,
Cody Northrop1a01b1d2015-04-16 13:41:56 -06002598 uint32_t dynamicOffsetCount,
2599 const uint32_t* pDynamicOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002600
2601void VKAPI vkCmdBindIndexBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002602 VkCmdBuffer cmdBuffer,
2603 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002604 VkDeviceSize offset,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002605 VkIndexType indexType);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002606
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002607void VKAPI vkCmdBindVertexBuffers(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002608 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -06002609 uint32_t startBinding,
2610 uint32_t bindingCount,
2611 const VkBuffer* pBuffers,
Tony Barbour8205d902015-04-16 15:59:00 -06002612 const VkDeviceSize* pOffsets);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002613
2614void VKAPI vkCmdDraw(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002615 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002616 uint32_t firstVertex,
2617 uint32_t vertexCount,
2618 uint32_t firstInstance,
2619 uint32_t instanceCount);
2620
2621void VKAPI vkCmdDrawIndexed(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002622 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002623 uint32_t firstIndex,
2624 uint32_t indexCount,
2625 int32_t vertexOffset,
2626 uint32_t firstInstance,
2627 uint32_t instanceCount);
2628
2629void VKAPI vkCmdDrawIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002630 VkCmdBuffer cmdBuffer,
2631 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002632 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002633 uint32_t count,
2634 uint32_t stride);
2635
2636void VKAPI vkCmdDrawIndexedIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002637 VkCmdBuffer cmdBuffer,
2638 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002639 VkDeviceSize offset,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002640 uint32_t count,
2641 uint32_t stride);
2642
2643void VKAPI vkCmdDispatch(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002644 VkCmdBuffer cmdBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002645 uint32_t x,
2646 uint32_t y,
2647 uint32_t z);
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002648
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002649void VKAPI vkCmdDispatchIndirect(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002650 VkCmdBuffer cmdBuffer,
2651 VkBuffer buffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002652 VkDeviceSize offset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002653
2654void VKAPI vkCmdCopyBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002655 VkCmdBuffer cmdBuffer,
2656 VkBuffer srcBuffer,
2657 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002658 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002659 const VkBufferCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002660
2661void VKAPI vkCmdCopyImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002662 VkCmdBuffer cmdBuffer,
2663 VkImage srcImage,
2664 VkImageLayout srcImageLayout,
2665 VkImage destImage,
2666 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002667 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002668 const VkImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002669
2670void VKAPI vkCmdBlitImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002671 VkCmdBuffer cmdBuffer,
2672 VkImage srcImage,
2673 VkImageLayout srcImageLayout,
2674 VkImage destImage,
2675 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002676 uint32_t regionCount,
Mark Lobodzinski20f68592015-05-22 14:43:25 -05002677 const VkImageBlit* pRegions,
2678 VkTexFilter filter);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002679
2680void VKAPI vkCmdCopyBufferToImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002681 VkCmdBuffer cmdBuffer,
2682 VkBuffer srcBuffer,
2683 VkImage destImage,
2684 VkImageLayout destImageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002685 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002686 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002687
2688void VKAPI vkCmdCopyImageToBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002689 VkCmdBuffer cmdBuffer,
2690 VkImage srcImage,
2691 VkImageLayout srcImageLayout,
2692 VkBuffer destBuffer,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002693 uint32_t regionCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002694 const VkBufferImageCopy* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002695
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002696void VKAPI vkCmdUpdateBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002697 VkCmdBuffer cmdBuffer,
2698 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002699 VkDeviceSize destOffset,
2700 VkDeviceSize dataSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002701 const uint32_t* pData);
2702
2703void VKAPI vkCmdFillBuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002704 VkCmdBuffer cmdBuffer,
2705 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002706 VkDeviceSize destOffset,
2707 VkDeviceSize fillSize,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002708 uint32_t data);
2709
2710void VKAPI vkCmdClearColorImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002711 VkCmdBuffer cmdBuffer,
2712 VkImage image,
2713 VkImageLayout imageLayout,
Courtney Goeltzenleuchterda4a99e2015-04-23 17:49:22 -06002714 const VkClearColor* pColor,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002715 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002716 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002717
2718void VKAPI vkCmdClearDepthStencil(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002719 VkCmdBuffer cmdBuffer,
2720 VkImage image,
2721 VkImageLayout imageLayout,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002722 float depth,
2723 uint32_t stencil,
2724 uint32_t rangeCount,
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002725 const VkImageSubresourceRange* pRanges);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002726
2727void VKAPI vkCmdResolveImage(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002728 VkCmdBuffer cmdBuffer,
2729 VkImage srcImage,
2730 VkImageLayout srcImageLayout,
2731 VkImage destImage,
2732 VkImageLayout destImageLayout,
Tony Barbour11f74372015-04-13 15:02:52 -06002733 uint32_t regionCount,
2734 const VkImageResolve* pRegions);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002735
2736void VKAPI vkCmdSetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002737 VkCmdBuffer cmdBuffer,
2738 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002739 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002740
2741void VKAPI vkCmdResetEvent(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002742 VkCmdBuffer cmdBuffer,
2743 VkEvent event,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002744 VkPipelineStageFlags stageMask);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002745
2746void VKAPI vkCmdWaitEvents(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002747 VkCmdBuffer cmdBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002748 uint32_t eventCount,
2749 const VkEvent* pEvents,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002750 VkPipelineStageFlags sourceStageMask,
2751 VkPipelineStageFlags destStageMask,
Tony Barbour8205d902015-04-16 15:59:00 -06002752 uint32_t memBarrierCount,
2753 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002754
2755void VKAPI vkCmdPipelineBarrier(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002756 VkCmdBuffer cmdBuffer,
Tony Barbourc2e987e2015-06-29 16:20:35 -06002757 VkPipelineStageFlags sourceStageMask,
2758 VkPipelineStageFlags destStageMask,
2759 bool32_t byRegion,
Tony Barbour8205d902015-04-16 15:59:00 -06002760 uint32_t memBarrierCount,
2761 const void** ppMemBarriers);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002762
2763void VKAPI vkCmdBeginQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002764 VkCmdBuffer cmdBuffer,
2765 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002766 uint32_t slot,
Tony Barbour8205d902015-04-16 15:59:00 -06002767 VkQueryControlFlags flags);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002768
2769void VKAPI vkCmdEndQuery(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002770 VkCmdBuffer cmdBuffer,
2771 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002772 uint32_t slot);
2773
2774void VKAPI vkCmdResetQueryPool(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002775 VkCmdBuffer cmdBuffer,
2776 VkQueryPool queryPool,
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002777 uint32_t startQuery,
2778 uint32_t queryCount);
2779
2780void VKAPI vkCmdWriteTimestamp(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002781 VkCmdBuffer cmdBuffer,
2782 VkTimestampType timestampType,
2783 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002784 VkDeviceSize destOffset);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002785
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002786void VKAPI vkCmdCopyQueryPoolResults(
2787 VkCmdBuffer cmdBuffer,
2788 VkQueryPool queryPool,
2789 uint32_t startQuery,
2790 uint32_t queryCount,
2791 VkBuffer destBuffer,
Tony Barbour8205d902015-04-16 15:59:00 -06002792 VkDeviceSize destOffset,
2793 VkDeviceSize destStride,
Tony Barbour3e3420a2015-04-16 19:09:28 -06002794 VkQueryResultFlags flags);
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -06002795
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002796VkResult VKAPI vkCreateFramebuffer(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002797 VkDevice device,
2798 const VkFramebufferCreateInfo* pCreateInfo,
2799 VkFramebuffer* pFramebuffer);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002800
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06002801VkResult VKAPI vkCreateRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002802 VkDevice device,
2803 const VkRenderPassCreateInfo* pCreateInfo,
2804 VkRenderPass* pRenderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002805
2806void VKAPI vkCmdBeginRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002807 VkCmdBuffer cmdBuffer,
2808 const VkRenderPassBegin* pRenderPassBegin);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002809
2810void VKAPI vkCmdEndRenderPass(
Courtney Goeltzenleuchterf4f69592015-04-10 18:00:50 -06002811 VkCmdBuffer cmdBuffer,
2812 VkRenderPass renderPass);
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -06002813
2814#endif // VK_PROTOTYPES
2815
2816#ifdef __cplusplus
2817} // extern "C"
2818#endif // __cplusplus
2819
2820#endif // __VULKAN_H__