Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/servers/rendering/rendering_device_commons.h
22517 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
#define STEPIFY(m_number, m_alignment) ((((m_number) + ((m_alignment) - 1)) / (m_alignment)) * (m_alignment))
37
38
// This may one day be used in Godot for interoperability between C arrays, Vector and LocalVector.
39
// (See https://github.com/godotengine/godot-proposals/issues/5144.)
40
template <typename T>
41
class VectorView {
42
const T *_ptr = nullptr;
43
const uint32_t _size = 0;
44
45
public:
46
const T &operator[](uint32_t p_index) {
47
DEV_ASSERT(p_index < _size);
48
return _ptr[p_index];
49
}
50
51
_ALWAYS_INLINE_ const T *ptr() const { return _ptr; }
52
_ALWAYS_INLINE_ uint32_t size() const { return _size; }
53
54
VectorView() = default;
55
VectorView(const T &p_ptr) :
56
// With this one you can pass a single element very conveniently!
57
_ptr(&p_ptr),
58
_size(1) {}
59
VectorView(const T *p_ptr, uint32_t p_size) :
60
_ptr(p_ptr), _size(p_size) {}
61
VectorView(const Vector<T> &p_lv) :
62
_ptr(p_lv.ptr()), _size(p_lv.size()) {}
63
VectorView(const LocalVector<T> &p_lv) :
64
_ptr(p_lv.ptr()), _size(p_lv.size()) {}
65
};
66
67
class RenderingDeviceCommons : public Object {
68
GDSOFTCLASS(RenderingDeviceCommons, Object);
69
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
enum ColorSpace {
321
COLOR_SPACE_REC709_LINEAR,
322
COLOR_SPACE_REC709_NONLINEAR_SRGB,
323
COLOR_SPACE_MAX,
324
};
325
326
// Breadcrumb markers are useful for debugging GPU crashes (i.e. DEVICE_LOST). Internally
327
// they're just an uint32_t to "tag" a GPU command. These are only used for debugging and do not
328
// (or at least shouldn't) alter the execution behavior in any way.
329
//
330
// When a GPU crashes and Godot was built in dev or debug mode; Godot will dump what commands
331
// were being executed and what tag they were marked with.
332
// This makes narrowing down the cause of a crash easier. Note that a GPU can be executing
333
// multiple commands at the same time. It is also useful to identify data hazards.
334
//
335
// For example if each LIGHTMAPPER_PASS must be executed in sequential order, but dumps
336
// indicated that pass (LIGHTMAPPER_PASS | 5) was being executed at the same time as
337
// (LIGHTMAPPER_PASS | 4), that would indicate there is a missing barrier or a render graph bug.
338
//
339
// The enums are bitshifted by 16 bits so it's possible to add user data via bitwise operations.
340
// Using this enum is not mandatory; but it is recommended so that all subsystems agree what each
341
// ID means when dumping info.
342
enum BreadcrumbMarker {
343
NONE = 0,
344
// Environment
345
REFLECTION_PROBES = 1u << 16u,
346
SKY_PASS = 2u << 16u,
347
// Light mapping
348
LIGHTMAPPER_PASS = 3u << 16u,
349
// Shadows
350
SHADOW_PASS_DIRECTIONAL = 4u << 16u,
351
SHADOW_PASS_CUBE = 5u << 16u,
352
// Geometry passes
353
OPAQUE_PASS = 6u << 16u,
354
ALPHA_PASS = 7u << 16u,
355
TRANSPARENT_PASS = 8u << 16u,
356
// Screen effects
357
POST_PROCESSING_PASS = 9u << 16u,
358
BLIT_PASS = 10u << 16u,
359
UI_PASS = 11u << 16u,
360
// Other
361
DEBUG_PASS = 12u << 16u,
362
};
363
364
enum CompareOperator {
365
COMPARE_OP_NEVER,
366
COMPARE_OP_LESS,
367
COMPARE_OP_EQUAL,
368
COMPARE_OP_LESS_OR_EQUAL,
369
COMPARE_OP_GREATER,
370
COMPARE_OP_NOT_EQUAL,
371
COMPARE_OP_GREATER_OR_EQUAL,
372
COMPARE_OP_ALWAYS,
373
COMPARE_OP_MAX
374
};
375
376
/*****************/
377
/**** TEXTURE ****/
378
/*****************/
379
380
enum TextureType {
381
TEXTURE_TYPE_1D,
382
TEXTURE_TYPE_2D,
383
TEXTURE_TYPE_3D,
384
TEXTURE_TYPE_CUBE,
385
TEXTURE_TYPE_1D_ARRAY,
386
TEXTURE_TYPE_2D_ARRAY,
387
TEXTURE_TYPE_CUBE_ARRAY,
388
TEXTURE_TYPE_MAX,
389
};
390
391
enum TextureSamples {
392
TEXTURE_SAMPLES_1,
393
TEXTURE_SAMPLES_2,
394
TEXTURE_SAMPLES_4,
395
TEXTURE_SAMPLES_8,
396
TEXTURE_SAMPLES_16,
397
TEXTURE_SAMPLES_32,
398
TEXTURE_SAMPLES_64,
399
TEXTURE_SAMPLES_MAX,
400
};
401
402
enum TextureUsageBits {
403
TEXTURE_USAGE_SAMPLING_BIT = (1 << 0),
404
TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = (1 << 1),
405
TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = (1 << 2),
406
TEXTURE_USAGE_STORAGE_BIT = (1 << 3),
407
TEXTURE_USAGE_STORAGE_ATOMIC_BIT = (1 << 4),
408
TEXTURE_USAGE_CPU_READ_BIT = (1 << 5),
409
TEXTURE_USAGE_CAN_UPDATE_BIT = (1 << 6),
410
TEXTURE_USAGE_CAN_COPY_FROM_BIT = (1 << 7),
411
TEXTURE_USAGE_CAN_COPY_TO_BIT = (1 << 8),
412
TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = (1 << 9),
413
TEXTURE_USAGE_VRS_ATTACHMENT_BIT = (1 << 10),
414
// When set, the texture is not backed by actual memory. It only ever lives in the cache.
415
// This is particularly useful for:
416
// 1. Depth/stencil buffers that are not needed after producing the colour output.
417
// 2. MSAA surfaces that are immediately resolved (i.e. its raw content isn't needed).
418
//
419
// This flag heavily improves performance & saves memory on TBDR GPUs (e.g. mobile).
420
// On Desktop this flag won't save memory but it still instructs the render graph that data will
421
// be discarded aggressively which may still improve some performance.
422
//
423
// It is not valid to perform copies from/to this texture, since it doesn't occupy actual RAM.
424
// It is also not valid to sample from this texture except using subpasses or via read/write
425
// pixel shader extensions (e.g. VK_EXT_rasterization_order_attachment_access).
426
//
427
// Try to set this bit as much as possible. If you set it, validation doesn't complain
428
// and it works fine on mobile, then go ahead.
429
TEXTURE_USAGE_TRANSIENT_BIT = (1 << 11),
430
TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT = (1 << 12),
431
TEXTURE_USAGE_MAX_BIT = TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT,
432
};
433
434
struct TextureFormat {
435
DataFormat format = DATA_FORMAT_R8_UNORM;
436
uint32_t width = 1;
437
uint32_t height = 1;
438
uint32_t depth = 1;
439
uint32_t array_layers = 1;
440
uint32_t mipmaps = 1;
441
TextureType texture_type = TEXTURE_TYPE_2D;
442
TextureSamples samples = TEXTURE_SAMPLES_1;
443
uint32_t usage_bits = 0;
444
Vector<DataFormat> shareable_formats;
445
bool is_resolve_buffer = false;
446
bool is_discardable = false;
447
448
bool operator==(const TextureFormat &b) const {
449
if (format != b.format) {
450
return false;
451
} else if (width != b.width) {
452
return false;
453
} else if (height != b.height) {
454
return false;
455
} else if (depth != b.depth) {
456
return false;
457
} else if (array_layers != b.array_layers) {
458
return false;
459
} else if (mipmaps != b.mipmaps) {
460
return false;
461
} else if (texture_type != b.texture_type) {
462
return false;
463
} else if (samples != b.samples) {
464
return false;
465
} else if (usage_bits != b.usage_bits) {
466
return false;
467
} else if (shareable_formats != b.shareable_formats) {
468
return false;
469
} else if (is_resolve_buffer != b.is_resolve_buffer) {
470
return false;
471
} else if (is_discardable != b.is_discardable) {
472
return false;
473
} else {
474
return true;
475
}
476
}
477
};
478
479
enum TextureSwizzle {
480
TEXTURE_SWIZZLE_IDENTITY,
481
TEXTURE_SWIZZLE_ZERO,
482
TEXTURE_SWIZZLE_ONE,
483
TEXTURE_SWIZZLE_R,
484
TEXTURE_SWIZZLE_G,
485
TEXTURE_SWIZZLE_B,
486
TEXTURE_SWIZZLE_A,
487
TEXTURE_SWIZZLE_MAX
488
};
489
490
enum TextureSliceType {
491
TEXTURE_SLICE_2D,
492
TEXTURE_SLICE_CUBEMAP,
493
TEXTURE_SLICE_3D,
494
TEXTURE_SLICE_2D_ARRAY,
495
TEXTURE_SLICE_MAX
496
};
497
498
/*****************/
499
/**** SAMPLER ****/
500
/*****************/
501
502
enum SamplerFilter {
503
SAMPLER_FILTER_NEAREST,
504
SAMPLER_FILTER_LINEAR,
505
};
506
507
enum SamplerRepeatMode {
508
SAMPLER_REPEAT_MODE_REPEAT,
509
SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,
510
SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,
511
SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,
512
SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,
513
SAMPLER_REPEAT_MODE_MAX
514
};
515
516
enum SamplerBorderColor {
517
SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,
518
SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,
519
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,
520
SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,
521
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,
522
SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,
523
SAMPLER_BORDER_COLOR_MAX
524
};
525
526
struct SamplerState {
527
SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;
528
SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;
529
SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;
530
SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
531
SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
532
SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
533
float lod_bias = 0.0f;
534
bool use_anisotropy = false;
535
float anisotropy_max = 1.0f;
536
bool enable_compare = false;
537
CompareOperator compare_op = COMPARE_OP_ALWAYS;
538
float min_lod = 0.0f;
539
float max_lod = 1e20; // Something very large should do.
540
SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;
541
bool unnormalized_uvw = false;
542
};
543
544
/**********************/
545
/**** VERTEX ARRAY ****/
546
/**********************/
547
548
enum IndexBufferFormat {
549
INDEX_BUFFER_FORMAT_UINT16,
550
INDEX_BUFFER_FORMAT_UINT32,
551
};
552
553
enum VertexFrequency {
554
VERTEX_FREQUENCY_VERTEX,
555
VERTEX_FREQUENCY_INSTANCE,
556
};
557
558
struct VertexAttribute {
559
uint32_t binding = UINT32_MAX; // Attribute buffer binding index. When set to UINT32_MAX, it uses the index of the attribute in the layout.
560
uint32_t location = 0; // Shader location.
561
uint32_t offset = 0;
562
DataFormat format = DATA_FORMAT_MAX;
563
uint32_t stride = 0;
564
VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;
565
};
566
567
struct VertexAttributeBinding {
568
uint32_t stride = 0;
569
VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;
570
571
VertexAttributeBinding() = default;
572
VertexAttributeBinding(uint32_t p_stride, VertexFrequency p_frequency) :
573
stride(p_stride),
574
frequency(p_frequency) {}
575
};
576
577
typedef HashMap<uint32_t, VertexAttributeBinding> VertexAttributeBindingsMap;
578
579
/*********************/
580
/**** FRAMEBUFFER ****/
581
/*********************/
582
583
static const int32_t ATTACHMENT_UNUSED = -1;
584
585
/****************/
586
/**** SHADER ****/
587
/****************/
588
589
enum ShaderStage {
590
SHADER_STAGE_VERTEX,
591
SHADER_STAGE_FRAGMENT,
592
SHADER_STAGE_TESSELATION_CONTROL,
593
SHADER_STAGE_TESSELATION_EVALUATION,
594
SHADER_STAGE_COMPUTE,
595
SHADER_STAGE_RAYGEN,
596
SHADER_STAGE_ANY_HIT,
597
SHADER_STAGE_CLOSEST_HIT,
598
SHADER_STAGE_MISS,
599
SHADER_STAGE_INTERSECTION,
600
SHADER_STAGE_MAX,
601
SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),
602
SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),
603
SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),
604
SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),
605
SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),
606
SHADER_STAGE_RAYGEN_BIT = (1 << SHADER_STAGE_RAYGEN),
607
SHADER_STAGE_ANY_HIT_BIT = (1 << SHADER_STAGE_ANY_HIT),
608
SHADER_STAGE_CLOSEST_HIT_BIT = (1 << SHADER_STAGE_CLOSEST_HIT),
609
SHADER_STAGE_MISS_BIT = (1 << SHADER_STAGE_MISS),
610
SHADER_STAGE_INTERSECTION_BIT = (1 << SHADER_STAGE_INTERSECTION),
611
};
612
613
enum ShaderLanguage {
614
SHADER_LANGUAGE_GLSL,
615
SHADER_LANGUAGE_HLSL,
616
};
617
618
enum ShaderLanguageVersion {
619
SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),
620
SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),
621
SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),
622
SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),
623
SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),
624
SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,
625
};
626
627
enum ShaderSpirvVersion {
628
SHADER_SPIRV_VERSION_1_0 = (1 << 16),
629
SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),
630
SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),
631
SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),
632
SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),
633
SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),
634
SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),
635
};
636
637
struct ShaderStageSPIRVData {
638
ShaderStage shader_stage = SHADER_STAGE_MAX;
639
Vector<uint8_t> spirv;
640
Vector<uint64_t> dynamic_buffers;
641
};
642
643
/*********************/
644
/**** UNIFORM SET ****/
645
/*********************/
646
647
static const uint32_t MAX_UNIFORM_SETS = 16;
648
649
// Keep the enum values in sync with the `SHADER_UNIFORM_NAMES` values (file rendering_device.cpp).
650
enum UniformType {
651
UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).
652
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.
653
UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).
654
UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.
655
UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).
656
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).
657
UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.
658
UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).
659
UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.
660
UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.
661
UNIFORM_TYPE_UNIFORM_BUFFER_DYNAMIC, // Same as UNIFORM but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.
662
UNIFORM_TYPE_STORAGE_BUFFER_DYNAMIC, // Same as STORAGE but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.
663
UNIFORM_TYPE_ACCELERATION_STRUCTURE, // Bounding Volume Hierarchy (Top + Bottom Level acceleration structures), for raytracing only.
664
UNIFORM_TYPE_MAX
665
};
666
667
/******************/
668
/**** PIPELINE ****/
669
/******************/
670
671
enum PipelineSpecializationConstantType {
672
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,
673
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,
674
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,
675
};
676
677
struct PipelineSpecializationConstant {
678
PipelineSpecializationConstantType type = {};
679
uint32_t constant_id = 0xffffffff;
680
union {
681
uint32_t int_value = 0;
682
float float_value;
683
bool bool_value;
684
};
685
};
686
687
/*******************/
688
/**** RENDERING ****/
689
/*******************/
690
691
// ----- PIPELINE -----
692
693
// Rendering Shader Container expects this type to be 4 bytes for proper alignment with the shaders.
694
enum PipelineType : uint32_t {
695
PIPELINE_TYPE_RASTERIZATION,
696
PIPELINE_TYPE_COMPUTE,
697
PIPELINE_TYPE_RAYTRACING,
698
};
699
700
enum RenderPrimitive {
701
RENDER_PRIMITIVE_POINTS,
702
RENDER_PRIMITIVE_LINES,
703
RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,
704
RENDER_PRIMITIVE_LINESTRIPS,
705
RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,
706
RENDER_PRIMITIVE_TRIANGLES,
707
RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,
708
RENDER_PRIMITIVE_TRIANGLE_STRIPS,
709
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).
710
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,
711
RENDER_PRIMITIVE_TESSELATION_PATCH,
712
RENDER_PRIMITIVE_MAX
713
};
714
715
enum PolygonCullMode {
716
POLYGON_CULL_DISABLED,
717
POLYGON_CULL_FRONT,
718
POLYGON_CULL_BACK,
719
POLYGON_CULL_MAX
720
};
721
722
enum PolygonFrontFace {
723
POLYGON_FRONT_FACE_CLOCKWISE,
724
POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,
725
};
726
727
enum StencilOperation {
728
STENCIL_OP_KEEP,
729
STENCIL_OP_ZERO,
730
STENCIL_OP_REPLACE,
731
STENCIL_OP_INCREMENT_AND_CLAMP,
732
STENCIL_OP_DECREMENT_AND_CLAMP,
733
STENCIL_OP_INVERT,
734
STENCIL_OP_INCREMENT_AND_WRAP,
735
STENCIL_OP_DECREMENT_AND_WRAP,
736
STENCIL_OP_MAX
737
};
738
739
enum LogicOperation {
740
LOGIC_OP_CLEAR,
741
LOGIC_OP_AND,
742
LOGIC_OP_AND_REVERSE,
743
LOGIC_OP_COPY,
744
LOGIC_OP_AND_INVERTED,
745
LOGIC_OP_NO_OP,
746
LOGIC_OP_XOR,
747
LOGIC_OP_OR,
748
LOGIC_OP_NOR,
749
LOGIC_OP_EQUIVALENT,
750
LOGIC_OP_INVERT,
751
LOGIC_OP_OR_REVERSE,
752
LOGIC_OP_COPY_INVERTED,
753
LOGIC_OP_OR_INVERTED,
754
LOGIC_OP_NAND,
755
LOGIC_OP_SET,
756
LOGIC_OP_MAX
757
};
758
759
enum BlendFactor {
760
BLEND_FACTOR_ZERO,
761
BLEND_FACTOR_ONE,
762
BLEND_FACTOR_SRC_COLOR,
763
BLEND_FACTOR_ONE_MINUS_SRC_COLOR,
764
BLEND_FACTOR_DST_COLOR,
765
BLEND_FACTOR_ONE_MINUS_DST_COLOR,
766
BLEND_FACTOR_SRC_ALPHA,
767
BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,
768
BLEND_FACTOR_DST_ALPHA,
769
BLEND_FACTOR_ONE_MINUS_DST_ALPHA,
770
BLEND_FACTOR_CONSTANT_COLOR,
771
BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,
772
BLEND_FACTOR_CONSTANT_ALPHA,
773
BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,
774
BLEND_FACTOR_SRC_ALPHA_SATURATE,
775
BLEND_FACTOR_SRC1_COLOR,
776
BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,
777
BLEND_FACTOR_SRC1_ALPHA,
778
BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,
779
BLEND_FACTOR_MAX
780
};
781
782
enum BlendOperation {
783
BLEND_OP_ADD,
784
BLEND_OP_SUBTRACT,
785
BLEND_OP_REVERSE_SUBTRACT,
786
BLEND_OP_MINIMUM,
787
BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.
788
BLEND_OP_MAX
789
};
790
791
struct PipelineRasterizationState {
792
bool enable_depth_clamp = false;
793
bool discard_primitives = false;
794
bool wireframe = false;
795
PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;
796
PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;
797
bool depth_bias_enabled = false;
798
float depth_bias_constant_factor = 0.0f;
799
float depth_bias_clamp = 0.0f;
800
float depth_bias_slope_factor = 0.0f;
801
float line_width = 1.0f;
802
uint32_t patch_control_points = 1;
803
};
804
805
struct PipelineMultisampleState {
806
TextureSamples sample_count = TEXTURE_SAMPLES_1;
807
bool enable_sample_shading = false;
808
float min_sample_shading = 0.0f;
809
Vector<uint32_t> sample_mask;
810
bool enable_alpha_to_coverage = false;
811
bool enable_alpha_to_one = false;
812
};
813
814
struct PipelineDepthStencilState {
815
bool enable_depth_test = false;
816
bool enable_depth_write = false;
817
CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;
818
bool enable_depth_range = false;
819
float depth_range_min = 0;
820
float depth_range_max = 0;
821
bool enable_stencil = false;
822
823
struct StencilOperationState {
824
StencilOperation fail = STENCIL_OP_ZERO;
825
StencilOperation pass = STENCIL_OP_ZERO;
826
StencilOperation depth_fail = STENCIL_OP_ZERO;
827
CompareOperator compare = COMPARE_OP_ALWAYS;
828
uint32_t compare_mask = 0;
829
uint32_t write_mask = 0;
830
uint32_t reference = 0;
831
};
832
833
StencilOperationState front_op;
834
StencilOperationState back_op;
835
};
836
837
struct PipelineColorBlendState {
838
bool enable_logic_op = false;
839
LogicOperation logic_op = LOGIC_OP_CLEAR;
840
841
struct Attachment {
842
bool enable_blend = false;
843
BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;
844
BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;
845
BlendOperation color_blend_op = BLEND_OP_ADD;
846
BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;
847
BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;
848
BlendOperation alpha_blend_op = BLEND_OP_ADD;
849
bool write_r = true;
850
bool write_g = true;
851
bool write_b = true;
852
bool write_a = true;
853
};
854
855
static PipelineColorBlendState create_disabled(int p_attachments = 1) {
856
PipelineColorBlendState bs;
857
for (int i = 0; i < p_attachments; i++) {
858
bs.attachments.push_back(Attachment());
859
}
860
return bs;
861
}
862
863
static PipelineColorBlendState create_blend(int p_attachments = 1) {
864
PipelineColorBlendState bs;
865
for (int i = 0; i < p_attachments; i++) {
866
Attachment ba;
867
ba.enable_blend = true;
868
ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;
869
ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
870
ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;
871
ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
872
873
bs.attachments.push_back(ba);
874
}
875
return bs;
876
}
877
878
Vector<Attachment> attachments; // One per render target texture.
879
Color blend_constant;
880
};
881
882
enum PipelineDynamicStateFlags {
883
DYNAMIC_STATE_LINE_WIDTH = (1 << 0),
884
DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),
885
DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),
886
DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),
887
DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),
888
DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),
889
DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),
890
};
891
892
/**************/
893
/**** MISC ****/
894
/**************/
895
896
// Defined in an API-agnostic way.
897
// Some may not make sense for the underlying API; in that case, 0 is returned.
898
enum DriverResource {
899
DRIVER_RESOURCE_LOGICAL_DEVICE,
900
DRIVER_RESOURCE_PHYSICAL_DEVICE,
901
DRIVER_RESOURCE_TOPMOST_OBJECT,
902
DRIVER_RESOURCE_COMMAND_QUEUE,
903
DRIVER_RESOURCE_QUEUE_FAMILY,
904
DRIVER_RESOURCE_TEXTURE,
905
DRIVER_RESOURCE_TEXTURE_VIEW,
906
DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,
907
DRIVER_RESOURCE_SAMPLER,
908
DRIVER_RESOURCE_UNIFORM_SET,
909
DRIVER_RESOURCE_BUFFER,
910
DRIVER_RESOURCE_COMPUTE_PIPELINE,
911
DRIVER_RESOURCE_RENDER_PIPELINE,
912
#ifndef DISABLE_DEPRECATED
913
DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,
914
DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,
915
DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,
916
DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,
917
DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,
918
DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,
919
DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,
920
DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,
921
DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,
922
DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,
923
DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,
924
DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,
925
DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,
926
#endif
927
};
928
929
enum Limit {
930
LIMIT_MAX_BOUND_UNIFORM_SETS,
931
LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,
932
LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,
933
LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,
934
LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,
935
LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,
936
LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,
937
LIMIT_MAX_DRAW_INDEXED_INDEX,
938
LIMIT_MAX_FRAMEBUFFER_HEIGHT,
939
LIMIT_MAX_FRAMEBUFFER_WIDTH,
940
LIMIT_MAX_TEXTURE_ARRAY_LAYERS,
941
LIMIT_MAX_TEXTURE_SIZE_1D,
942
LIMIT_MAX_TEXTURE_SIZE_2D,
943
LIMIT_MAX_TEXTURE_SIZE_3D,
944
LIMIT_MAX_TEXTURE_SIZE_CUBE,
945
LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,
946
LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,
947
LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,
948
LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,
949
LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,
950
LIMIT_MAX_PUSH_CONSTANT_SIZE,
951
LIMIT_MAX_UNIFORM_BUFFER_SIZE,
952
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,
953
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,
954
LIMIT_MAX_VERTEX_INPUT_BINDINGS,
955
LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,
956
LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,
957
LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,
958
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,
959
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,
960
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,
961
LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,
962
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,
963
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,
964
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,
965
LIMIT_MAX_VIEWPORT_DIMENSIONS_X,
966
LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,
967
LIMIT_SUBGROUP_SIZE,
968
LIMIT_SUBGROUP_MIN_SIZE,
969
LIMIT_SUBGROUP_MAX_SIZE,
970
LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.
971
LIMIT_SUBGROUP_OPERATIONS,
972
LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,
973
LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,
974
LIMIT_MAX_SHADER_VARYINGS,
975
};
976
977
enum Features {
978
SUPPORTS_MULTIVIEW,
979
SUPPORTS_HALF_FLOAT,
980
SUPPORTS_ATTACHMENT_VRS,
981
SUPPORTS_METALFX_SPATIAL,
982
SUPPORTS_METALFX_TEMPORAL,
983
// 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.
984
SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,
985
SUPPORTS_BUFFER_DEVICE_ADDRESS,
986
SUPPORTS_IMAGE_ATOMIC_32_BIT,
987
SUPPORTS_VULKAN_MEMORY_MODEL,
988
SUPPORTS_FRAMEBUFFER_DEPTH_RESOLVE,
989
SUPPORTS_POINT_SIZE,
990
SUPPORTS_RAY_QUERY,
991
SUPPORTS_RAYTRACING_PIPELINE,
992
SUPPORTS_HDR_OUTPUT,
993
};
994
995
enum SubgroupOperations {
996
SUBGROUP_BASIC_BIT = 1,
997
SUBGROUP_VOTE_BIT = 2,
998
SUBGROUP_ARITHMETIC_BIT = 4,
999
SUBGROUP_BALLOT_BIT = 8,
1000
SUBGROUP_SHUFFLE_BIT = 16,
1001
SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,
1002
SUBGROUP_CLUSTERED_BIT = 64,
1003
SUBGROUP_QUAD_BIT = 128,
1004
};
1005
1006
////////////////////////////////////////////
1007
// PROTECTED STUFF
1008
// Not exposed by RenderingDevice, but shared
1009
// with RenderingDeviceDriver for convenience.
1010
////////////////////////////////////////////
1011
protected:
1012
/*****************/
1013
/**** GENERIC ****/
1014
/*****************/
1015
1016
static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];
1017
1018
/*****************/
1019
/**** TEXTURE ****/
1020
/*****************/
1021
1022
static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;
1023
1024
static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];
1025
1026
static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);
1027
uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;
1028
static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);
1029
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);
1030
static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);
1031
static bool format_has_depth(DataFormat p_format);
1032
static bool format_has_stencil(DataFormat p_format);
1033
static uint32_t format_get_plane_count(DataFormat p_format);
1034
1035
/*****************/
1036
/**** SAMPLER ****/
1037
/*****************/
1038
1039
static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];
1040
1041
/**********************/
1042
/**** VERTEX ARRAY ****/
1043
/**********************/
1044
1045
static uint32_t get_format_vertex_size(DataFormat p_format);
1046
1047
public:
1048
/*****************/
1049
/**** TEXTURE ****/
1050
/*****************/
1051
1052
static uint32_t get_image_format_pixel_size(DataFormat p_format);
1053
1054
/****************/
1055
/**** SHADER ****/
1056
/****************/
1057
1058
static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];
1059
1060
struct ShaderUniform {
1061
UniformType type = UniformType::UNIFORM_TYPE_MAX;
1062
bool writable = false;
1063
uint32_t binding = 0;
1064
BitField<ShaderStage> stages = {};
1065
uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).
1066
1067
bool operator!=(const ShaderUniform &p_other) const {
1068
return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;
1069
}
1070
1071
bool operator<(const ShaderUniform &p_other) const {
1072
if (binding != p_other.binding) {
1073
return binding < p_other.binding;
1074
}
1075
if (type != p_other.type) {
1076
return type < p_other.type;
1077
}
1078
if (writable != p_other.writable) {
1079
return writable < p_other.writable;
1080
}
1081
if (stages != p_other.stages) {
1082
return stages < p_other.stages;
1083
}
1084
if (length != p_other.length) {
1085
return length < p_other.length;
1086
}
1087
return false;
1088
}
1089
};
1090
1091
struct ShaderSpecializationConstant : public PipelineSpecializationConstant {
1092
BitField<ShaderStage> stages = {};
1093
1094
bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }
1095
};
1096
1097
struct ShaderReflection {
1098
uint64_t vertex_input_mask = 0;
1099
uint32_t fragment_output_mask = 0;
1100
PipelineType pipeline_type = PIPELINE_TYPE_RASTERIZATION;
1101
bool has_multiview = false;
1102
bool has_dynamic_buffers = false;
1103
uint32_t compute_local_size[3] = {};
1104
uint32_t push_constant_size = 0;
1105
1106
Vector<Vector<ShaderUniform>> uniform_sets;
1107
Vector<ShaderSpecializationConstant> specialization_constants;
1108
Vector<ShaderStage> stages_vector;
1109
BitField<ShaderStage> stages_bits = {};
1110
BitField<ShaderStage> push_constant_stages = {};
1111
};
1112
};
1113
1114