Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/servers/rendering/rendering_device_commons.h
10277 views
1
/**************************************************************************/
2
/* rendering_device_commons.h */
3
/**************************************************************************/
4
/* This file is part of: */
5
/* GODOT ENGINE */
6
/* https://godotengine.org */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10
/* */
11
/* Permission is hereby granted, free of charge, to any person obtaining */
12
/* a copy of this software and associated documentation files (the */
13
/* "Software"), to deal in the Software without restriction, including */
14
/* without limitation the rights to use, copy, modify, merge, publish, */
15
/* distribute, sublicense, and/or sell copies of the Software, and to */
16
/* permit persons to whom the Software is furnished to do so, subject to */
17
/* the following conditions: */
18
/* */
19
/* The above copyright notice and this permission notice shall be */
20
/* included in all copies or substantial portions of the Software. */
21
/* */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29
/**************************************************************************/
30
31
#pragma once
32
33
#include "core/object/object.h"
34
#include "core/variant/type_info.h"
35
36
#include <algorithm>
37
38
#define STEPIFY(m_number, m_alignment) ((((m_number) + ((m_alignment) - 1)) / (m_alignment)) * (m_alignment))
39
40
// This may one day be used in Godot for interoperability between C arrays, Vector and LocalVector.
41
// (See https://github.com/godotengine/godot-proposals/issues/5144.)
42
template <typename T>
43
class VectorView {
44
const T *_ptr = nullptr;
45
const uint32_t _size = 0;
46
47
public:
48
const T &operator[](uint32_t p_index) {
49
DEV_ASSERT(p_index < _size);
50
return _ptr[p_index];
51
}
52
53
_ALWAYS_INLINE_ const T *ptr() const { return _ptr; }
54
_ALWAYS_INLINE_ uint32_t size() const { return _size; }
55
56
VectorView() = default;
57
VectorView(const T &p_ptr) :
58
// With this one you can pass a single element very conveniently!
59
_ptr(&p_ptr),
60
_size(1) {}
61
VectorView(const T *p_ptr, uint32_t p_size) :
62
_ptr(p_ptr), _size(p_size) {}
63
VectorView(const Vector<T> &p_lv) :
64
_ptr(p_lv.ptr()), _size(p_lv.size()) {}
65
VectorView(const LocalVector<T> &p_lv) :
66
_ptr(p_lv.ptr()), _size(p_lv.size()) {}
67
};
68
69
class RenderingDeviceCommons : public Object {
70
////////////////////////////////////////////
71
// PUBLIC STUFF
72
// Exposed by RenderingDevice, and shared
73
// with RenderingDeviceDriver.
74
////////////////////////////////////////////
75
public:
76
static const bool command_pool_reset_enabled = true;
77
78
/*****************/
79
/**** GENERIC ****/
80
/*****************/
81
82
static const int INVALID_ID = -1;
83
84
enum DataFormat {
85
DATA_FORMAT_R4G4_UNORM_PACK8,
86
DATA_FORMAT_R4G4B4A4_UNORM_PACK16,
87
DATA_FORMAT_B4G4R4A4_UNORM_PACK16,
88
DATA_FORMAT_R5G6B5_UNORM_PACK16,
89
DATA_FORMAT_B5G6R5_UNORM_PACK16,
90
DATA_FORMAT_R5G5B5A1_UNORM_PACK16,
91
DATA_FORMAT_B5G5R5A1_UNORM_PACK16,
92
DATA_FORMAT_A1R5G5B5_UNORM_PACK16,
93
DATA_FORMAT_R8_UNORM,
94
DATA_FORMAT_R8_SNORM,
95
DATA_FORMAT_R8_USCALED,
96
DATA_FORMAT_R8_SSCALED,
97
DATA_FORMAT_R8_UINT,
98
DATA_FORMAT_R8_SINT,
99
DATA_FORMAT_R8_SRGB,
100
DATA_FORMAT_R8G8_UNORM,
101
DATA_FORMAT_R8G8_SNORM,
102
DATA_FORMAT_R8G8_USCALED,
103
DATA_FORMAT_R8G8_SSCALED,
104
DATA_FORMAT_R8G8_UINT,
105
DATA_FORMAT_R8G8_SINT,
106
DATA_FORMAT_R8G8_SRGB,
107
DATA_FORMAT_R8G8B8_UNORM,
108
DATA_FORMAT_R8G8B8_SNORM,
109
DATA_FORMAT_R8G8B8_USCALED,
110
DATA_FORMAT_R8G8B8_SSCALED,
111
DATA_FORMAT_R8G8B8_UINT,
112
DATA_FORMAT_R8G8B8_SINT,
113
DATA_FORMAT_R8G8B8_SRGB,
114
DATA_FORMAT_B8G8R8_UNORM,
115
DATA_FORMAT_B8G8R8_SNORM,
116
DATA_FORMAT_B8G8R8_USCALED,
117
DATA_FORMAT_B8G8R8_SSCALED,
118
DATA_FORMAT_B8G8R8_UINT,
119
DATA_FORMAT_B8G8R8_SINT,
120
DATA_FORMAT_B8G8R8_SRGB,
121
DATA_FORMAT_R8G8B8A8_UNORM,
122
DATA_FORMAT_R8G8B8A8_SNORM,
123
DATA_FORMAT_R8G8B8A8_USCALED,
124
DATA_FORMAT_R8G8B8A8_SSCALED,
125
DATA_FORMAT_R8G8B8A8_UINT,
126
DATA_FORMAT_R8G8B8A8_SINT,
127
DATA_FORMAT_R8G8B8A8_SRGB,
128
DATA_FORMAT_B8G8R8A8_UNORM,
129
DATA_FORMAT_B8G8R8A8_SNORM,
130
DATA_FORMAT_B8G8R8A8_USCALED,
131
DATA_FORMAT_B8G8R8A8_SSCALED,
132
DATA_FORMAT_B8G8R8A8_UINT,
133
DATA_FORMAT_B8G8R8A8_SINT,
134
DATA_FORMAT_B8G8R8A8_SRGB,
135
DATA_FORMAT_A8B8G8R8_UNORM_PACK32,
136
DATA_FORMAT_A8B8G8R8_SNORM_PACK32,
137
DATA_FORMAT_A8B8G8R8_USCALED_PACK32,
138
DATA_FORMAT_A8B8G8R8_SSCALED_PACK32,
139
DATA_FORMAT_A8B8G8R8_UINT_PACK32,
140
DATA_FORMAT_A8B8G8R8_SINT_PACK32,
141
DATA_FORMAT_A8B8G8R8_SRGB_PACK32,
142
DATA_FORMAT_A2R10G10B10_UNORM_PACK32,
143
DATA_FORMAT_A2R10G10B10_SNORM_PACK32,
144
DATA_FORMAT_A2R10G10B10_USCALED_PACK32,
145
DATA_FORMAT_A2R10G10B10_SSCALED_PACK32,
146
DATA_FORMAT_A2R10G10B10_UINT_PACK32,
147
DATA_FORMAT_A2R10G10B10_SINT_PACK32,
148
DATA_FORMAT_A2B10G10R10_UNORM_PACK32,
149
DATA_FORMAT_A2B10G10R10_SNORM_PACK32,
150
DATA_FORMAT_A2B10G10R10_USCALED_PACK32,
151
DATA_FORMAT_A2B10G10R10_SSCALED_PACK32,
152
DATA_FORMAT_A2B10G10R10_UINT_PACK32,
153
DATA_FORMAT_A2B10G10R10_SINT_PACK32,
154
DATA_FORMAT_R16_UNORM,
155
DATA_FORMAT_R16_SNORM,
156
DATA_FORMAT_R16_USCALED,
157
DATA_FORMAT_R16_SSCALED,
158
DATA_FORMAT_R16_UINT,
159
DATA_FORMAT_R16_SINT,
160
DATA_FORMAT_R16_SFLOAT,
161
DATA_FORMAT_R16G16_UNORM,
162
DATA_FORMAT_R16G16_SNORM,
163
DATA_FORMAT_R16G16_USCALED,
164
DATA_FORMAT_R16G16_SSCALED,
165
DATA_FORMAT_R16G16_UINT,
166
DATA_FORMAT_R16G16_SINT,
167
DATA_FORMAT_R16G16_SFLOAT,
168
DATA_FORMAT_R16G16B16_UNORM,
169
DATA_FORMAT_R16G16B16_SNORM,
170
DATA_FORMAT_R16G16B16_USCALED,
171
DATA_FORMAT_R16G16B16_SSCALED,
172
DATA_FORMAT_R16G16B16_UINT,
173
DATA_FORMAT_R16G16B16_SINT,
174
DATA_FORMAT_R16G16B16_SFLOAT,
175
DATA_FORMAT_R16G16B16A16_UNORM,
176
DATA_FORMAT_R16G16B16A16_SNORM,
177
DATA_FORMAT_R16G16B16A16_USCALED,
178
DATA_FORMAT_R16G16B16A16_SSCALED,
179
DATA_FORMAT_R16G16B16A16_UINT,
180
DATA_FORMAT_R16G16B16A16_SINT,
181
DATA_FORMAT_R16G16B16A16_SFLOAT,
182
DATA_FORMAT_R32_UINT,
183
DATA_FORMAT_R32_SINT,
184
DATA_FORMAT_R32_SFLOAT,
185
DATA_FORMAT_R32G32_UINT,
186
DATA_FORMAT_R32G32_SINT,
187
DATA_FORMAT_R32G32_SFLOAT,
188
DATA_FORMAT_R32G32B32_UINT,
189
DATA_FORMAT_R32G32B32_SINT,
190
DATA_FORMAT_R32G32B32_SFLOAT,
191
DATA_FORMAT_R32G32B32A32_UINT,
192
DATA_FORMAT_R32G32B32A32_SINT,
193
DATA_FORMAT_R32G32B32A32_SFLOAT,
194
DATA_FORMAT_R64_UINT,
195
DATA_FORMAT_R64_SINT,
196
DATA_FORMAT_R64_SFLOAT,
197
DATA_FORMAT_R64G64_UINT,
198
DATA_FORMAT_R64G64_SINT,
199
DATA_FORMAT_R64G64_SFLOAT,
200
DATA_FORMAT_R64G64B64_UINT,
201
DATA_FORMAT_R64G64B64_SINT,
202
DATA_FORMAT_R64G64B64_SFLOAT,
203
DATA_FORMAT_R64G64B64A64_UINT,
204
DATA_FORMAT_R64G64B64A64_SINT,
205
DATA_FORMAT_R64G64B64A64_SFLOAT,
206
DATA_FORMAT_B10G11R11_UFLOAT_PACK32,
207
DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32,
208
DATA_FORMAT_D16_UNORM,
209
DATA_FORMAT_X8_D24_UNORM_PACK32,
210
DATA_FORMAT_D32_SFLOAT,
211
DATA_FORMAT_S8_UINT,
212
DATA_FORMAT_D16_UNORM_S8_UINT,
213
DATA_FORMAT_D24_UNORM_S8_UINT,
214
DATA_FORMAT_D32_SFLOAT_S8_UINT,
215
DATA_FORMAT_BC1_RGB_UNORM_BLOCK,
216
DATA_FORMAT_BC1_RGB_SRGB_BLOCK,
217
DATA_FORMAT_BC1_RGBA_UNORM_BLOCK,
218
DATA_FORMAT_BC1_RGBA_SRGB_BLOCK,
219
DATA_FORMAT_BC2_UNORM_BLOCK,
220
DATA_FORMAT_BC2_SRGB_BLOCK,
221
DATA_FORMAT_BC3_UNORM_BLOCK,
222
DATA_FORMAT_BC3_SRGB_BLOCK,
223
DATA_FORMAT_BC4_UNORM_BLOCK,
224
DATA_FORMAT_BC4_SNORM_BLOCK,
225
DATA_FORMAT_BC5_UNORM_BLOCK,
226
DATA_FORMAT_BC5_SNORM_BLOCK,
227
DATA_FORMAT_BC6H_UFLOAT_BLOCK,
228
DATA_FORMAT_BC6H_SFLOAT_BLOCK,
229
DATA_FORMAT_BC7_UNORM_BLOCK,
230
DATA_FORMAT_BC7_SRGB_BLOCK,
231
DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK,
232
DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK,
233
DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK,
234
DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK,
235
DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK,
236
DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK,
237
DATA_FORMAT_EAC_R11_UNORM_BLOCK,
238
DATA_FORMAT_EAC_R11_SNORM_BLOCK,
239
DATA_FORMAT_EAC_R11G11_UNORM_BLOCK,
240
DATA_FORMAT_EAC_R11G11_SNORM_BLOCK,
241
DATA_FORMAT_ASTC_4x4_UNORM_BLOCK,
242
DATA_FORMAT_ASTC_4x4_SRGB_BLOCK,
243
DATA_FORMAT_ASTC_5x4_UNORM_BLOCK,
244
DATA_FORMAT_ASTC_5x4_SRGB_BLOCK,
245
DATA_FORMAT_ASTC_5x5_UNORM_BLOCK,
246
DATA_FORMAT_ASTC_5x5_SRGB_BLOCK,
247
DATA_FORMAT_ASTC_6x5_UNORM_BLOCK,
248
DATA_FORMAT_ASTC_6x5_SRGB_BLOCK,
249
DATA_FORMAT_ASTC_6x6_UNORM_BLOCK,
250
DATA_FORMAT_ASTC_6x6_SRGB_BLOCK,
251
DATA_FORMAT_ASTC_8x5_UNORM_BLOCK,
252
DATA_FORMAT_ASTC_8x5_SRGB_BLOCK,
253
DATA_FORMAT_ASTC_8x6_UNORM_BLOCK,
254
DATA_FORMAT_ASTC_8x6_SRGB_BLOCK,
255
DATA_FORMAT_ASTC_8x8_UNORM_BLOCK,
256
DATA_FORMAT_ASTC_8x8_SRGB_BLOCK,
257
DATA_FORMAT_ASTC_10x5_UNORM_BLOCK,
258
DATA_FORMAT_ASTC_10x5_SRGB_BLOCK,
259
DATA_FORMAT_ASTC_10x6_UNORM_BLOCK,
260
DATA_FORMAT_ASTC_10x6_SRGB_BLOCK,
261
DATA_FORMAT_ASTC_10x8_UNORM_BLOCK,
262
DATA_FORMAT_ASTC_10x8_SRGB_BLOCK,
263
DATA_FORMAT_ASTC_10x10_UNORM_BLOCK,
264
DATA_FORMAT_ASTC_10x10_SRGB_BLOCK,
265
DATA_FORMAT_ASTC_12x10_UNORM_BLOCK,
266
DATA_FORMAT_ASTC_12x10_SRGB_BLOCK,
267
DATA_FORMAT_ASTC_12x12_UNORM_BLOCK,
268
DATA_FORMAT_ASTC_12x12_SRGB_BLOCK,
269
DATA_FORMAT_G8B8G8R8_422_UNORM,
270
DATA_FORMAT_B8G8R8G8_422_UNORM,
271
DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM,
272
DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM,
273
DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM,
274
DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM,
275
DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM,
276
DATA_FORMAT_R10X6_UNORM_PACK16,
277
DATA_FORMAT_R10X6G10X6_UNORM_2PACK16,
278
DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,
279
DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16,
280
DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16,
281
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16,
282
DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16,
283
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16,
284
DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16,
285
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16,
286
DATA_FORMAT_R12X4_UNORM_PACK16,
287
DATA_FORMAT_R12X4G12X4_UNORM_2PACK16,
288
DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16,
289
DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16,
290
DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16,
291
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16,
292
DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16,
293
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16,
294
DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16,
295
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16,
296
DATA_FORMAT_G16B16G16R16_422_UNORM,
297
DATA_FORMAT_B16G16R16G16_422_UNORM,
298
DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM,
299
DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM,
300
DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM,
301
DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM,
302
DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM,
303
DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK, // HDR variant.
304
DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK, // HDR variant.
305
DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK, // HDR variant.
306
DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK, // HDR variant.
307
DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK, // HDR variant.
308
DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK, // HDR variant.
309
DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK, // HDR variant.
310
DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK, // HDR variant.
311
DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK, // HDR variant.
312
DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK, // HDR variant.
313
DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK, // HDR variant.
314
DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK, // HDR variant.
315
DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK, // HDR variant.
316
DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK, // HDR variant.
317
DATA_FORMAT_MAX,
318
};
319
320
// Breadcrumb markers are useful for debugging GPU crashes (i.e. DEVICE_LOST). Internally
321
// they're just an uint32_t to "tag" a GPU command. These are only used for debugging and do not
322
// (or at least shouldn't) alter the execution behavior in any way.
323
//
324
// When a GPU crashes and Godot was built in dev or debug mode; Godot will dump what commands
325
// were being executed and what tag they were marked with.
326
// This makes narrowing down the cause of a crash easier. Note that a GPU can be executing
327
// multiple commands at the same time. It is also useful to identify data hazards.
328
//
329
// For example if each LIGHTMAPPER_PASS must be executed in sequential order, but dumps
330
// indicated that pass (LIGHTMAPPER_PASS | 5) was being executed at the same time as
331
// (LIGHTMAPPER_PASS | 4), that would indicate there is a missing barrier or a render graph bug.
332
//
333
// The enums are bitshifted by 16 bits so it's possible to add user data via bitwise operations.
334
// Using this enum is not mandatory; but it is recommended so that all subsystems agree what each
335
// ID means when dumping info.
336
enum BreadcrumbMarker {
337
NONE = 0,
338
// Environment
339
REFLECTION_PROBES = 1u << 16u,
340
SKY_PASS = 2u << 16u,
341
// Light mapping
342
LIGHTMAPPER_PASS = 3u << 16u,
343
// Shadows
344
SHADOW_PASS_DIRECTIONAL = 4u << 16u,
345
SHADOW_PASS_CUBE = 5u << 16u,
346
// Geometry passes
347
OPAQUE_PASS = 6u << 16u,
348
ALPHA_PASS = 7u << 16u,
349
TRANSPARENT_PASS = 8u << 16u,
350
// Screen effects
351
POST_PROCESSING_PASS = 9u << 16u,
352
BLIT_PASS = 10u << 16u,
353
UI_PASS = 11u << 16u,
354
// Other
355
DEBUG_PASS = 12u << 16u,
356
};
357
358
enum CompareOperator {
359
COMPARE_OP_NEVER,
360
COMPARE_OP_LESS,
361
COMPARE_OP_EQUAL,
362
COMPARE_OP_LESS_OR_EQUAL,
363
COMPARE_OP_GREATER,
364
COMPARE_OP_NOT_EQUAL,
365
COMPARE_OP_GREATER_OR_EQUAL,
366
COMPARE_OP_ALWAYS,
367
COMPARE_OP_MAX
368
};
369
370
/*****************/
371
/**** TEXTURE ****/
372
/*****************/
373
374
enum TextureType {
375
TEXTURE_TYPE_1D,
376
TEXTURE_TYPE_2D,
377
TEXTURE_TYPE_3D,
378
TEXTURE_TYPE_CUBE,
379
TEXTURE_TYPE_1D_ARRAY,
380
TEXTURE_TYPE_2D_ARRAY,
381
TEXTURE_TYPE_CUBE_ARRAY,
382
TEXTURE_TYPE_MAX,
383
};
384
385
enum TextureSamples {
386
TEXTURE_SAMPLES_1,
387
TEXTURE_SAMPLES_2,
388
TEXTURE_SAMPLES_4,
389
TEXTURE_SAMPLES_8,
390
TEXTURE_SAMPLES_16,
391
TEXTURE_SAMPLES_32,
392
TEXTURE_SAMPLES_64,
393
TEXTURE_SAMPLES_MAX,
394
};
395
396
enum TextureUsageBits {
397
TEXTURE_USAGE_SAMPLING_BIT = (1 << 0),
398
TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = (1 << 1),
399
TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = (1 << 2),
400
TEXTURE_USAGE_STORAGE_BIT = (1 << 3),
401
TEXTURE_USAGE_STORAGE_ATOMIC_BIT = (1 << 4),
402
TEXTURE_USAGE_CPU_READ_BIT = (1 << 5),
403
TEXTURE_USAGE_CAN_UPDATE_BIT = (1 << 6),
404
TEXTURE_USAGE_CAN_COPY_FROM_BIT = (1 << 7),
405
TEXTURE_USAGE_CAN_COPY_TO_BIT = (1 << 8),
406
TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = (1 << 9),
407
TEXTURE_USAGE_VRS_ATTACHMENT_BIT = (1 << 10),
408
// When set, the texture is not backed by actual memory. It only ever lives in the cache.
409
// This is particularly useful for:
410
// 1. Depth/stencil buffers that are not needed after producing the colour output.
411
// 2. MSAA surfaces that are immediately resolved (i.e. its raw content isn't needed).
412
//
413
// This flag heavily improves performance & saves memory on TBDR GPUs (e.g. mobile).
414
// On Desktop this flag won't save memory but it still instructs the render graph that data will
415
// be discarded aggressively which may still improve some performance.
416
//
417
// It is not valid to perform copies from/to this texture, since it doesn't occupy actual RAM.
418
// It is also not valid to sample from this texture except using subpasses or via read/write
419
// pixel shader extensions (e.g. VK_EXT_rasterization_order_attachment_access).
420
//
421
// Try to set this bit as much as possible. If you set it, validation doesn't complain
422
// and it works fine on mobile, then go ahead.
423
TEXTURE_USAGE_TRANSIENT_BIT = (1 << 11),
424
TEXTURE_USAGE_MAX_BIT = TEXTURE_USAGE_TRANSIENT_BIT,
425
};
426
427
struct TextureFormat {
428
DataFormat format = DATA_FORMAT_R8_UNORM;
429
uint32_t width = 1;
430
uint32_t height = 1;
431
uint32_t depth = 1;
432
uint32_t array_layers = 1;
433
uint32_t mipmaps = 1;
434
TextureType texture_type = TEXTURE_TYPE_2D;
435
TextureSamples samples = TEXTURE_SAMPLES_1;
436
uint32_t usage_bits = 0;
437
Vector<DataFormat> shareable_formats;
438
bool is_resolve_buffer = false;
439
bool is_discardable = false;
440
441
bool operator==(const TextureFormat &b) const {
442
if (format != b.format) {
443
return false;
444
} else if (width != b.width) {
445
return false;
446
} else if (height != b.height) {
447
return false;
448
} else if (depth != b.depth) {
449
return false;
450
} else if (array_layers != b.array_layers) {
451
return false;
452
} else if (mipmaps != b.mipmaps) {
453
return false;
454
} else if (texture_type != b.texture_type) {
455
return false;
456
} else if (samples != b.samples) {
457
return false;
458
} else if (usage_bits != b.usage_bits) {
459
return false;
460
} else if (shareable_formats != b.shareable_formats) {
461
return false;
462
} else if (is_resolve_buffer != b.is_resolve_buffer) {
463
return false;
464
} else if (is_discardable != b.is_discardable) {
465
return false;
466
} else {
467
return true;
468
}
469
}
470
};
471
472
enum TextureSwizzle {
473
TEXTURE_SWIZZLE_IDENTITY,
474
TEXTURE_SWIZZLE_ZERO,
475
TEXTURE_SWIZZLE_ONE,
476
TEXTURE_SWIZZLE_R,
477
TEXTURE_SWIZZLE_G,
478
TEXTURE_SWIZZLE_B,
479
TEXTURE_SWIZZLE_A,
480
TEXTURE_SWIZZLE_MAX
481
};
482
483
enum TextureSliceType {
484
TEXTURE_SLICE_2D,
485
TEXTURE_SLICE_CUBEMAP,
486
TEXTURE_SLICE_3D,
487
TEXTURE_SLICE_2D_ARRAY,
488
TEXTURE_SLICE_MAX
489
};
490
491
/*****************/
492
/**** SAMPLER ****/
493
/*****************/
494
495
enum SamplerFilter {
496
SAMPLER_FILTER_NEAREST,
497
SAMPLER_FILTER_LINEAR,
498
};
499
500
enum SamplerRepeatMode {
501
SAMPLER_REPEAT_MODE_REPEAT,
502
SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,
503
SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,
504
SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,
505
SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,
506
SAMPLER_REPEAT_MODE_MAX
507
};
508
509
enum SamplerBorderColor {
510
SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,
511
SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,
512
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,
513
SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,
514
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,
515
SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,
516
SAMPLER_BORDER_COLOR_MAX
517
};
518
519
struct SamplerState {
520
SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;
521
SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;
522
SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;
523
SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
524
SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
525
SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
526
float lod_bias = 0.0f;
527
bool use_anisotropy = false;
528
float anisotropy_max = 1.0f;
529
bool enable_compare = false;
530
CompareOperator compare_op = COMPARE_OP_ALWAYS;
531
float min_lod = 0.0f;
532
float max_lod = 1e20; // Something very large should do.
533
SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;
534
bool unnormalized_uvw = false;
535
};
536
537
/**********************/
538
/**** VERTEX ARRAY ****/
539
/**********************/
540
541
enum IndexBufferFormat {
542
INDEX_BUFFER_FORMAT_UINT16,
543
INDEX_BUFFER_FORMAT_UINT32,
544
};
545
546
enum VertexFrequency {
547
VERTEX_FREQUENCY_VERTEX,
548
VERTEX_FREQUENCY_INSTANCE,
549
};
550
551
struct VertexAttribute {
552
uint32_t location = 0; // Shader location.
553
uint32_t offset = 0;
554
DataFormat format = DATA_FORMAT_MAX;
555
uint32_t stride = 0;
556
VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;
557
};
558
559
/*********************/
560
/**** FRAMEBUFFER ****/
561
/*********************/
562
563
static const int32_t ATTACHMENT_UNUSED = -1;
564
565
/****************/
566
/**** SHADER ****/
567
/****************/
568
569
enum ShaderStage {
570
SHADER_STAGE_VERTEX,
571
SHADER_STAGE_FRAGMENT,
572
SHADER_STAGE_TESSELATION_CONTROL,
573
SHADER_STAGE_TESSELATION_EVALUATION,
574
SHADER_STAGE_COMPUTE,
575
SHADER_STAGE_MAX,
576
SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),
577
SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),
578
SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),
579
SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),
580
SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),
581
};
582
583
enum ShaderLanguage {
584
SHADER_LANGUAGE_GLSL,
585
SHADER_LANGUAGE_HLSL,
586
};
587
588
enum ShaderLanguageVersion {
589
SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),
590
SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),
591
SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),
592
SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),
593
SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),
594
SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,
595
};
596
597
enum ShaderSpirvVersion {
598
SHADER_SPIRV_VERSION_1_0 = (1 << 16),
599
SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),
600
SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),
601
SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),
602
SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),
603
SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),
604
SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),
605
};
606
607
struct ShaderStageSPIRVData {
608
ShaderStage shader_stage = SHADER_STAGE_MAX;
609
Vector<uint8_t> spirv;
610
};
611
612
/*********************/
613
/**** UNIFORM SET ****/
614
/*********************/
615
616
static const uint32_t MAX_UNIFORM_SETS = 16;
617
618
enum UniformType {
619
UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).
620
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.
621
UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).
622
UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.
623
UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).
624
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).
625
UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.
626
UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).
627
UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.
628
UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.
629
UNIFORM_TYPE_MAX
630
};
631
632
/******************/
633
/**** PIPELINE ****/
634
/******************/
635
636
enum PipelineSpecializationConstantType {
637
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,
638
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,
639
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,
640
};
641
642
struct PipelineSpecializationConstant {
643
PipelineSpecializationConstantType type = {};
644
uint32_t constant_id = 0xffffffff;
645
union {
646
uint32_t int_value = 0;
647
float float_value;
648
bool bool_value;
649
};
650
};
651
652
/*******************/
653
/**** RENDERING ****/
654
/*******************/
655
656
// ----- PIPELINE -----
657
658
enum RenderPrimitive {
659
RENDER_PRIMITIVE_POINTS,
660
RENDER_PRIMITIVE_LINES,
661
RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,
662
RENDER_PRIMITIVE_LINESTRIPS,
663
RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,
664
RENDER_PRIMITIVE_TRIANGLES,
665
RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,
666
RENDER_PRIMITIVE_TRIANGLE_STRIPS,
667
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).
668
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,
669
RENDER_PRIMITIVE_TESSELATION_PATCH,
670
RENDER_PRIMITIVE_MAX
671
};
672
673
enum PolygonCullMode {
674
POLYGON_CULL_DISABLED,
675
POLYGON_CULL_FRONT,
676
POLYGON_CULL_BACK,
677
POLYGON_CULL_MAX
678
};
679
680
enum PolygonFrontFace {
681
POLYGON_FRONT_FACE_CLOCKWISE,
682
POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,
683
};
684
685
enum StencilOperation {
686
STENCIL_OP_KEEP,
687
STENCIL_OP_ZERO,
688
STENCIL_OP_REPLACE,
689
STENCIL_OP_INCREMENT_AND_CLAMP,
690
STENCIL_OP_DECREMENT_AND_CLAMP,
691
STENCIL_OP_INVERT,
692
STENCIL_OP_INCREMENT_AND_WRAP,
693
STENCIL_OP_DECREMENT_AND_WRAP,
694
STENCIL_OP_MAX
695
};
696
697
enum LogicOperation {
698
LOGIC_OP_CLEAR,
699
LOGIC_OP_AND,
700
LOGIC_OP_AND_REVERSE,
701
LOGIC_OP_COPY,
702
LOGIC_OP_AND_INVERTED,
703
LOGIC_OP_NO_OP,
704
LOGIC_OP_XOR,
705
LOGIC_OP_OR,
706
LOGIC_OP_NOR,
707
LOGIC_OP_EQUIVALENT,
708
LOGIC_OP_INVERT,
709
LOGIC_OP_OR_REVERSE,
710
LOGIC_OP_COPY_INVERTED,
711
LOGIC_OP_OR_INVERTED,
712
LOGIC_OP_NAND,
713
LOGIC_OP_SET,
714
LOGIC_OP_MAX
715
};
716
717
enum BlendFactor {
718
BLEND_FACTOR_ZERO,
719
BLEND_FACTOR_ONE,
720
BLEND_FACTOR_SRC_COLOR,
721
BLEND_FACTOR_ONE_MINUS_SRC_COLOR,
722
BLEND_FACTOR_DST_COLOR,
723
BLEND_FACTOR_ONE_MINUS_DST_COLOR,
724
BLEND_FACTOR_SRC_ALPHA,
725
BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,
726
BLEND_FACTOR_DST_ALPHA,
727
BLEND_FACTOR_ONE_MINUS_DST_ALPHA,
728
BLEND_FACTOR_CONSTANT_COLOR,
729
BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,
730
BLEND_FACTOR_CONSTANT_ALPHA,
731
BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,
732
BLEND_FACTOR_SRC_ALPHA_SATURATE,
733
BLEND_FACTOR_SRC1_COLOR,
734
BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,
735
BLEND_FACTOR_SRC1_ALPHA,
736
BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,
737
BLEND_FACTOR_MAX
738
};
739
740
enum BlendOperation {
741
BLEND_OP_ADD,
742
BLEND_OP_SUBTRACT,
743
BLEND_OP_REVERSE_SUBTRACT,
744
BLEND_OP_MINIMUM,
745
BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.
746
BLEND_OP_MAX
747
};
748
749
struct PipelineRasterizationState {
750
bool enable_depth_clamp = false;
751
bool discard_primitives = false;
752
bool wireframe = false;
753
PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;
754
PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;
755
bool depth_bias_enabled = false;
756
float depth_bias_constant_factor = 0.0f;
757
float depth_bias_clamp = 0.0f;
758
float depth_bias_slope_factor = 0.0f;
759
float line_width = 1.0f;
760
uint32_t patch_control_points = 1;
761
};
762
763
struct PipelineMultisampleState {
764
TextureSamples sample_count = TEXTURE_SAMPLES_1;
765
bool enable_sample_shading = false;
766
float min_sample_shading = 0.0f;
767
Vector<uint32_t> sample_mask;
768
bool enable_alpha_to_coverage = false;
769
bool enable_alpha_to_one = false;
770
};
771
772
struct PipelineDepthStencilState {
773
bool enable_depth_test = false;
774
bool enable_depth_write = false;
775
CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;
776
bool enable_depth_range = false;
777
float depth_range_min = 0;
778
float depth_range_max = 0;
779
bool enable_stencil = false;
780
781
struct StencilOperationState {
782
StencilOperation fail = STENCIL_OP_ZERO;
783
StencilOperation pass = STENCIL_OP_ZERO;
784
StencilOperation depth_fail = STENCIL_OP_ZERO;
785
CompareOperator compare = COMPARE_OP_ALWAYS;
786
uint32_t compare_mask = 0;
787
uint32_t write_mask = 0;
788
uint32_t reference = 0;
789
};
790
791
StencilOperationState front_op;
792
StencilOperationState back_op;
793
};
794
795
struct PipelineColorBlendState {
796
bool enable_logic_op = false;
797
LogicOperation logic_op = LOGIC_OP_CLEAR;
798
799
struct Attachment {
800
bool enable_blend = false;
801
BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;
802
BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;
803
BlendOperation color_blend_op = BLEND_OP_ADD;
804
BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;
805
BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;
806
BlendOperation alpha_blend_op = BLEND_OP_ADD;
807
bool write_r = true;
808
bool write_g = true;
809
bool write_b = true;
810
bool write_a = true;
811
};
812
813
static PipelineColorBlendState create_disabled(int p_attachments = 1) {
814
PipelineColorBlendState bs;
815
for (int i = 0; i < p_attachments; i++) {
816
bs.attachments.push_back(Attachment());
817
}
818
return bs;
819
}
820
821
static PipelineColorBlendState create_blend(int p_attachments = 1) {
822
PipelineColorBlendState bs;
823
for (int i = 0; i < p_attachments; i++) {
824
Attachment ba;
825
ba.enable_blend = true;
826
ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;
827
ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
828
ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;
829
ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
830
831
bs.attachments.push_back(ba);
832
}
833
return bs;
834
}
835
836
Vector<Attachment> attachments; // One per render target texture.
837
Color blend_constant;
838
};
839
840
enum PipelineDynamicStateFlags {
841
DYNAMIC_STATE_LINE_WIDTH = (1 << 0),
842
DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),
843
DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),
844
DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),
845
DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),
846
DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),
847
DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),
848
};
849
850
/**************/
851
/**** MISC ****/
852
/**************/
853
854
// This enum matches VkPhysicalDeviceType (except for `DEVICE_TYPE_MAX`).
855
// Unlike VkPhysicalDeviceType, DeviceType is exposed to the scripting API.
856
enum DeviceType {
857
DEVICE_TYPE_OTHER,
858
DEVICE_TYPE_INTEGRATED_GPU,
859
DEVICE_TYPE_DISCRETE_GPU,
860
DEVICE_TYPE_VIRTUAL_GPU,
861
DEVICE_TYPE_CPU,
862
DEVICE_TYPE_MAX
863
};
864
865
// Defined in an API-agnostic way.
866
// Some may not make sense for the underlying API; in that case, 0 is returned.
867
enum DriverResource {
868
DRIVER_RESOURCE_LOGICAL_DEVICE,
869
DRIVER_RESOURCE_PHYSICAL_DEVICE,
870
DRIVER_RESOURCE_TOPMOST_OBJECT,
871
DRIVER_RESOURCE_COMMAND_QUEUE,
872
DRIVER_RESOURCE_QUEUE_FAMILY,
873
DRIVER_RESOURCE_TEXTURE,
874
DRIVER_RESOURCE_TEXTURE_VIEW,
875
DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,
876
DRIVER_RESOURCE_SAMPLER,
877
DRIVER_RESOURCE_UNIFORM_SET,
878
DRIVER_RESOURCE_BUFFER,
879
DRIVER_RESOURCE_COMPUTE_PIPELINE,
880
DRIVER_RESOURCE_RENDER_PIPELINE,
881
#ifndef DISABLE_DEPRECATED
882
DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,
883
DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,
884
DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,
885
DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,
886
DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,
887
DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,
888
DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,
889
DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,
890
DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,
891
DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,
892
DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,
893
DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,
894
DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,
895
#endif
896
};
897
898
enum Limit {
899
LIMIT_MAX_BOUND_UNIFORM_SETS,
900
LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,
901
LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,
902
LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,
903
LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,
904
LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,
905
LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,
906
LIMIT_MAX_DRAW_INDEXED_INDEX,
907
LIMIT_MAX_FRAMEBUFFER_HEIGHT,
908
LIMIT_MAX_FRAMEBUFFER_WIDTH,
909
LIMIT_MAX_TEXTURE_ARRAY_LAYERS,
910
LIMIT_MAX_TEXTURE_SIZE_1D,
911
LIMIT_MAX_TEXTURE_SIZE_2D,
912
LIMIT_MAX_TEXTURE_SIZE_3D,
913
LIMIT_MAX_TEXTURE_SIZE_CUBE,
914
LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,
915
LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,
916
LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,
917
LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,
918
LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,
919
LIMIT_MAX_PUSH_CONSTANT_SIZE,
920
LIMIT_MAX_UNIFORM_BUFFER_SIZE,
921
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,
922
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,
923
LIMIT_MAX_VERTEX_INPUT_BINDINGS,
924
LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,
925
LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,
926
LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,
927
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,
928
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,
929
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,
930
LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,
931
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,
932
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,
933
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,
934
LIMIT_MAX_VIEWPORT_DIMENSIONS_X,
935
LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,
936
LIMIT_SUBGROUP_SIZE,
937
LIMIT_SUBGROUP_MIN_SIZE,
938
LIMIT_SUBGROUP_MAX_SIZE,
939
LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.
940
LIMIT_SUBGROUP_OPERATIONS,
941
LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,
942
LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,
943
LIMIT_MAX_SHADER_VARYINGS,
944
};
945
946
enum Features {
947
SUPPORTS_MULTIVIEW,
948
SUPPORTS_HALF_FLOAT,
949
SUPPORTS_ATTACHMENT_VRS,
950
SUPPORTS_METALFX_SPATIAL,
951
SUPPORTS_METALFX_TEMPORAL,
952
// If not supported, a fragment shader with only side effects (i.e., writes to buffers, but doesn't output to attachments), may be optimized down to no-op by the GPU driver.
953
SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,
954
SUPPORTS_BUFFER_DEVICE_ADDRESS,
955
SUPPORTS_IMAGE_ATOMIC_32_BIT,
956
SUPPORTS_VULKAN_MEMORY_MODEL,
957
};
958
959
enum SubgroupOperations {
960
SUBGROUP_BASIC_BIT = 1,
961
SUBGROUP_VOTE_BIT = 2,
962
SUBGROUP_ARITHMETIC_BIT = 4,
963
SUBGROUP_BALLOT_BIT = 8,
964
SUBGROUP_SHUFFLE_BIT = 16,
965
SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,
966
SUBGROUP_CLUSTERED_BIT = 64,
967
SUBGROUP_QUAD_BIT = 128,
968
};
969
970
////////////////////////////////////////////
971
// PROTECTED STUFF
972
// Not exposed by RenderingDevice, but shared
973
// with RenderingDeviceDriver for convenience.
974
////////////////////////////////////////////
975
protected:
976
/*****************/
977
/**** GENERIC ****/
978
/*****************/
979
980
static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];
981
982
/*****************/
983
/**** TEXTURE ****/
984
/*****************/
985
986
static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;
987
988
static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];
989
990
static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);
991
uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;
992
static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);
993
static uint32_t get_image_format_required_size(DataFormat p_format, uint32_t p_width, uint32_t p_height, uint32_t p_depth, uint32_t p_mipmaps, uint32_t *r_blockw = nullptr, uint32_t *r_blockh = nullptr, uint32_t *r_depth = nullptr);
994
static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);
995
static bool format_has_stencil(DataFormat p_format);
996
static uint32_t format_get_plane_count(DataFormat p_format);
997
998
/*****************/
999
/**** SAMPLER ****/
1000
/*****************/
1001
1002
static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];
1003
1004
/**********************/
1005
/**** VERTEX ARRAY ****/
1006
/**********************/
1007
1008
static uint32_t get_format_vertex_size(DataFormat p_format);
1009
1010
public:
1011
/*****************/
1012
/**** TEXTURE ****/
1013
/*****************/
1014
1015
static uint32_t get_image_format_pixel_size(DataFormat p_format);
1016
1017
/****************/
1018
/**** SHADER ****/
1019
/****************/
1020
1021
static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];
1022
1023
struct ShaderUniform {
1024
UniformType type = UniformType::UNIFORM_TYPE_MAX;
1025
bool writable = false;
1026
uint32_t binding = 0;
1027
BitField<ShaderStage> stages = {};
1028
uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).
1029
1030
bool operator!=(const ShaderUniform &p_other) const {
1031
return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;
1032
}
1033
1034
bool operator<(const ShaderUniform &p_other) const {
1035
if (binding != p_other.binding) {
1036
return binding < p_other.binding;
1037
}
1038
if (type != p_other.type) {
1039
return type < p_other.type;
1040
}
1041
if (writable != p_other.writable) {
1042
return writable < p_other.writable;
1043
}
1044
if (stages != p_other.stages) {
1045
return stages < p_other.stages;
1046
}
1047
if (length != p_other.length) {
1048
return length < p_other.length;
1049
}
1050
return false;
1051
}
1052
};
1053
1054
struct ShaderSpecializationConstant : public PipelineSpecializationConstant {
1055
BitField<ShaderStage> stages = {};
1056
1057
bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }
1058
};
1059
1060
struct ShaderReflection {
1061
uint64_t vertex_input_mask = 0;
1062
uint32_t fragment_output_mask = 0;
1063
bool is_compute = false;
1064
bool has_multiview = false;
1065
uint32_t compute_local_size[3] = {};
1066
uint32_t push_constant_size = 0;
1067
1068
Vector<Vector<ShaderUniform>> uniform_sets;
1069
Vector<ShaderSpecializationConstant> specialization_constants;
1070
Vector<ShaderStage> stages_vector;
1071
BitField<ShaderStage> stages_bits = {};
1072
BitField<ShaderStage> push_constant_stages = {};
1073
};
1074
1075
static Error reflect_spirv(VectorView<ShaderStageSPIRVData> p_spirv, ShaderReflection &r_reflection);
1076
};
1077
1078