rendering_device_commons.h 33 KB

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