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