ReShade
A generic post-processing injector for games and video software.
reshade_api_format.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 Patrick Mours
3  * SPDX-License-Identifier: BSD-3-Clause OR MIT
4  */
5 
6 #pragma once
7 
8 #include <cfloat>
9 #include <cstdint>
10 
11 namespace reshade::api
12 {
17  enum class format : uint32_t
18  {
19  unknown = 0,
20 
21  // Color formats
22 
23  r1_unorm = 66,
24 
25  r8_typeless = 60,
26  r8_unorm = 61,
27  r8_uint = 62,
28  r8_snorm = 63,
29  r8_sint = 64,
30  l8_unorm = 0x3030384C, // L800
31  a8_unorm = 65,
32 
33  r8g8_typeless = 48,
34  r8g8_unorm = 49,
35  r8g8_uint = 50,
36  r8g8_snorm = 51,
37  r8g8_sint = 52,
38  l8a8_unorm = 0x3038414C, // LA80
39 
40  r8g8b8_typeless = 0x42475230,
41  r8g8b8_unorm = 0x42475231,
42  r8g8b8_unorm_srgb = 0x42475235,
43  r8g8b8_uint = 0x42475232,
44  r8g8b8_snorm = 0x42475233,
45  r8g8b8_sint = 0x42475234,
46  b8g8r8_typeless = 0x52474230,
47  b8g8r8_unorm = 0x52474231,
48  b8g8r8_unorm_srgb = 0x52474235,
49 
50  r8g8b8a8_typeless = 27,
51  r8g8b8a8_unorm = 28,
52  r8g8b8a8_unorm_srgb = 29,
53  r8g8b8a8_uint = 30,
54  r8g8b8a8_snorm = 31,
55  r8g8b8a8_sint = 32,
56  r8g8b8x8_unorm = 0x424757B9,
57  r8g8b8x8_unorm_srgb = 0x424757BA,
58  b8g8r8a8_typeless = 90,
59  b8g8r8a8_unorm = 87,
60  b8g8r8a8_unorm_srgb = 91,
61  b8g8r8x8_typeless = 92,
62  b8g8r8x8_unorm = 88,
63  b8g8r8x8_unorm_srgb = 93,
64 
65  r10g10b10a2_typeless = 23,
66  r10g10b10a2_unorm = 24,
67  r10g10b10a2_uint = 25,
68  r10g10b10a2_xr_bias = 89,
69  b10g10r10a2_typeless = 0x42475330,
70  b10g10r10a2_unorm = 0x42475331,
71  b10g10r10a2_uint = 0x42475332,
72 
73  r16_typeless = 53,
74  r16_float = 54,
75  r16_unorm = 56,
76  r16_uint = 57,
77  r16_snorm = 58,
78  r16_sint = 59,
79  l16_unorm = 0x3036314C,
80 
81  l16a16_unorm = 0x3631414C, // LA16
82  r16g16_typeless = 33,
83  r16g16_float = 34,
84  r16g16_unorm = 35,
85  r16g16_uint = 36,
86  r16g16_snorm = 37,
87  r16g16_sint = 38,
88 
89  r16g16b16_typeless = 0x42475430,
90  r16g16b16_float = 0x42475435,
91  r16g16b16_unorm = 0x42475431,
92  r16g16b16_uint = 0x42475432,
93  r16g16b16_snorm = 0x42475433,
94  r16g16b16_sint = 0x42475434,
95 
96  r16g16b16a16_typeless = 9,
97  r16g16b16a16_float = 10,
98  r16g16b16a16_unorm = 11,
99  r16g16b16a16_uint = 12,
100  r16g16b16a16_snorm = 13,
101  r16g16b16a16_sint = 14,
102 
103  r32_typeless = 39,
104  r32_float = 41,
105  r32_uint = 42,
106  r32_sint = 43,
107 
108  r32g32_typeless = 15,
109  r32g32_float = 16,
110  r32g32_uint = 17,
111  r32g32_sint = 18,
112 
113  r32g32b32_typeless = 5,
114  r32g32b32_float = 6,
115  r32g32b32_uint = 7,
116  r32g32b32_sint = 8,
117 
118  r32g32b32a32_typeless = 1,
119  r32g32b32a32_float = 2,
120  r32g32b32a32_uint = 3,
121  r32g32b32a32_sint = 4,
122 
123  r9g9b9e5 = 67,
124  r11g11b10_float = 26,
125  b5g6r5_unorm = 85,
126  b5g5r5a1_unorm = 86,
127  b5g5r5x1_unorm = 0x424757B5,
128  b4g4r4a4_unorm = 115,
129  a4b4g4r4_unorm = 191,
130 
131  // Depth-stencil formats
132 
133  s8_uint = 0x30303853, // S800
134  d16_unorm = 55,
135  d16_unorm_s8_uint = 0x38363144, // D168
136  d24_unorm_x8_uint = 0x38343244, // D248
137  d24_unorm_s8_uint = 45,
138  d32_float = 40,
139  d32_float_s8_uint = 20,
140 
141  r24_g8_typeless = 44,
142  r24_unorm_x8_uint = 46,
143  x24_unorm_g8_uint = 47,
144  r32_g8_typeless = 19,
145  r32_float_x8_uint = 21,
146  x32_float_g8_uint = 22,
147 
148  // Compressed data formats
149 
150  bc1_typeless = 70,
151  bc1_unorm = 71,
152  bc1_unorm_srgb = 72,
153  bc2_typeless = 73,
154  bc2_unorm = 74,
155  bc2_unorm_srgb = 75,
156  bc3_typeless = 76,
157  bc3_unorm = 77,
158  bc3_unorm_srgb = 78,
159  bc4_typeless = 79,
160  bc4_unorm = 80,
161  bc4_snorm = 81,
162  bc5_typeless = 82,
163  bc5_unorm = 83,
164  bc5_snorm = 84,
165  bc6h_typeless = 94,
166  bc6h_ufloat = 95,
167  bc6h_sfloat = 96,
168  bc7_typeless = 97,
169  bc7_unorm = 98,
170  bc7_unorm_srgb = 99,
171 
172  // Video formats
173 
174  r8g8_b8g8_unorm = 68,
175  g8r8_g8b8_unorm = 69,
176 
177  // Special purpose formats
178 
179  intz = 0x5A544E49, // INTZ
180  };
181 
185  enum class color_space : uint32_t
186  {
187  unknown = 0,
188 
189  // BT.709/sRGB primaries
190  srgb,
191  // BT.709/sRGB primaries + linear
192  scrgb,
193  // BT.2020 primaries + PQ transfer function
194  hdr10_pq,
195  // BT.2020 primaries + HLG transfer function
196  hdr10_hlg,
197 
198  srgb_nonlinear = srgb,
199  extended_srgb_linear = scrgb,
200  hdr10_st2084 = hdr10_pq,
201  };
202 
207  inline format format_to_typeless(format value)
208  {
209  switch (value)
210  {
211  case format::l8_unorm:
212  case format::r8_typeless:
213  case format::r8_uint:
214  case format::r8_sint:
215  case format::r8_unorm:
216  case format::r8_snorm:
217  return format::r8_typeless;
218  case format::l8a8_unorm:
219  case format::r8g8_typeless:
220  case format::r8g8_uint:
221  case format::r8g8_sint:
222  case format::r8g8_unorm:
223  case format::r8g8_snorm:
224  return format::r8g8_typeless;
225  case format::r8g8b8a8_typeless:
226  case format::r8g8b8a8_uint:
227  case format::r8g8b8a8_sint:
228  case format::r8g8b8a8_unorm:
229  case format::r8g8b8a8_unorm_srgb:
230  case format::r8g8b8a8_snorm:
231  case format::r8g8b8x8_unorm:
232  case format::r8g8b8x8_unorm_srgb:
233  return format::r8g8b8a8_typeless;
234  case format::b8g8r8a8_typeless:
235  case format::b8g8r8a8_unorm:
236  case format::b8g8r8a8_unorm_srgb:
237  return format::b8g8r8a8_typeless;
238  case format::b8g8r8x8_typeless:
239  case format::b8g8r8x8_unorm:
240  case format::b8g8r8x8_unorm_srgb:
241  return format::b8g8r8x8_typeless;
242  case format::r10g10b10a2_typeless:
243  case format::r10g10b10a2_uint:
244  case format::r10g10b10a2_unorm:
245  case format::r10g10b10a2_xr_bias:
246  return format::r10g10b10a2_typeless;
247  case format::b10g10r10a2_typeless:
248  case format::b10g10r10a2_uint:
249  case format::b10g10r10a2_unorm:
250  return format::b10g10r10a2_typeless;
251  case format::l16_unorm:
252  case format::d16_unorm:
253  case format::r16_typeless:
254  case format::r16_uint:
255  case format::r16_sint:
256  case format::r16_float:
257  case format::r16_unorm:
258  case format::r16_snorm:
259  return format::r16_typeless;
260  case format::l16a16_unorm:
261  case format::r16g16_typeless:
262  case format::r16g16_uint:
263  case format::r16g16_sint:
264  case format::r16g16_float:
265  case format::r16g16_unorm:
266  case format::r16g16_snorm:
267  return format::r16g16_typeless;
268  case format::r16g16b16a16_typeless:
269  case format::r16g16b16a16_uint:
270  case format::r16g16b16a16_sint:
271  case format::r16g16b16a16_float:
272  case format::r16g16b16a16_unorm:
273  case format::r16g16b16a16_snorm:
274  return format::r16g16b16a16_typeless;
275  case format::d32_float:
276  case format::r32_typeless:
277  case format::r32_uint:
278  case format::r32_sint:
279  case format::r32_float:
280  return format::r32_typeless;
281  case format::r32g32_typeless:
282  case format::r32g32_uint:
283  case format::r32g32_sint:
284  case format::r32g32_float:
285  return format::r32g32_typeless;
286  case format::r32g32b32_typeless:
287  case format::r32g32b32_uint:
288  case format::r32g32b32_sint:
289  case format::r32g32b32_float:
290  return format::r32g32b32_typeless;
291  case format::r32g32b32a32_typeless:
292  case format::r32g32b32a32_uint:
293  case format::r32g32b32a32_sint:
294  case format::r32g32b32a32_float:
295  return format::r32g32b32a32_typeless;
296  case format::d32_float_s8_uint:
297  case format::r32_g8_typeless:
298  case format::r32_float_x8_uint:
299  case format::x32_float_g8_uint:
300  return format::r32_g8_typeless;
301  case format::d24_unorm_s8_uint: // Do not also convert 'd24_unorm_x8_uint' here, to keep it distinguishable from 'd24_unorm_s8_uint'
302  case format::r24_g8_typeless:
303  case format::r24_unorm_x8_uint:
304  case format::x24_unorm_g8_uint:
305  return format::r24_g8_typeless;
306  case format::bc1_typeless:
307  case format::bc1_unorm:
308  case format::bc1_unorm_srgb:
309  return format::bc1_typeless;
310  case format::bc2_typeless:
311  case format::bc2_unorm:
312  case format::bc2_unorm_srgb:
313  return format::bc2_typeless;
314  case format::bc3_typeless:
315  case format::bc3_unorm:
316  case format::bc3_unorm_srgb:
317  return format::bc3_typeless;
318  case format::bc4_typeless:
319  case format::bc4_unorm:
320  case format::bc4_snorm:
321  return format::bc4_typeless;
322  case format::bc5_typeless:
323  case format::bc5_unorm:
324  case format::bc5_snorm:
325  return format::bc5_typeless;
326  case format::bc6h_typeless:
327  case format::bc6h_ufloat:
328  case format::bc6h_sfloat:
329  return format::bc6h_typeless;
330  case format::bc7_typeless:
331  case format::bc7_unorm:
332  case format::bc7_unorm_srgb:
333  return format::bc7_typeless;
334  default:
335  return value;
336  }
337  }
338 
344  inline format format_to_default_typed(format value, int srgb_variant = -1)
345  {
346  switch (value)
347  {
348  case format::r8_typeless:
349  return format::r8_unorm;
350  case format::r8g8_typeless:
351  return format::r8g8_unorm;
352  case format::r8g8b8_typeless:
353  case format::r8g8b8_unorm:
354  return srgb_variant == 1 ? format::r8g8b8_unorm_srgb : format::r8g8b8_unorm;
355  case format::r8g8b8_unorm_srgb:
356  return srgb_variant != 0 ? format::r8g8b8_unorm_srgb : format::r8g8b8_unorm;
357  case format::b8g8r8_typeless:
358  case format::b8g8r8_unorm:
359  return srgb_variant == 1 ? format::b8g8r8_unorm_srgb : format::b8g8r8_unorm;
360  case format::b8g8r8_unorm_srgb:
361  return srgb_variant != 0 ? format::b8g8r8_unorm_srgb : format::b8g8r8_unorm;
362  case format::r8g8b8a8_typeless:
363  case format::r8g8b8a8_unorm:
364  return srgb_variant == 1 ? format::r8g8b8a8_unorm_srgb : format::r8g8b8a8_unorm;
365  case format::r8g8b8a8_unorm_srgb:
366  return srgb_variant != 0 ? format::r8g8b8a8_unorm_srgb : format::r8g8b8a8_unorm;
367  case format::r8g8b8x8_unorm:
368  return srgb_variant == 1 ? format::r8g8b8x8_unorm_srgb : format::r8g8b8x8_unorm;
369  case format::r8g8b8x8_unorm_srgb:
370  return srgb_variant != 0 ? format::r8g8b8x8_unorm_srgb : format::r8g8b8x8_unorm;
371  case format::b8g8r8a8_typeless:
372  case format::b8g8r8a8_unorm:
373  return srgb_variant == 1 ? format::b8g8r8a8_unorm_srgb : format::b8g8r8a8_unorm;
374  case format::b8g8r8a8_unorm_srgb:
375  return srgb_variant != 0 ? format::b8g8r8a8_unorm_srgb : format::b8g8r8a8_unorm;
376  case format::b8g8r8x8_typeless:
377  case format::b8g8r8x8_unorm:
378  return srgb_variant == 1 ? format::b8g8r8x8_unorm_srgb : format::b8g8r8x8_unorm;
379  case format::b8g8r8x8_unorm_srgb:
380  return srgb_variant != 0 ? format::b8g8r8x8_unorm_srgb : format::b8g8r8x8_unorm;
381  case format::r10g10b10a2_typeless:
382  return format::r10g10b10a2_unorm;
383  case format::b10g10r10a2_typeless:
384  return format::b10g10r10a2_unorm;
385  case format::d16_unorm:
386  return format::r16_unorm;
387  case format::r16_typeless:
388  return format::r16_float;
389  case format::r16g16_typeless:
390  return format::r16g16_float;
391  case format::r16g16b16_typeless:
392  return format::r16g16b16_float;
393  case format::r16g16b16a16_typeless:
394  return format::r16g16b16a16_float;
395  case format::d32_float:
396  case format::r32_typeless:
397  return format::r32_float;
398  case format::r32g32_typeless:
399  return format::r32g32_float;
400  case format::r32g32b32_typeless:
401  return format::r32g32b32_float;
402  case format::r32g32b32a32_typeless:
403  return format::r32g32b32a32_float;
404  case format::d32_float_s8_uint:
405  case format::r32_g8_typeless:
406  return format::r32_float_x8_uint;
407  case format::d24_unorm_s8_uint: // Do not also convert 'd24_unorm_x8_uint' here, to keep it distinguishable from 'd24_unorm_s8_uint'
408  case format::r24_g8_typeless:
409  return format::r24_unorm_x8_uint;
410  case format::bc1_typeless:
411  case format::bc1_unorm:
412  return srgb_variant == 1 ? format::bc1_unorm_srgb : format::bc1_unorm;
413  case format::bc1_unorm_srgb:
414  return srgb_variant != 0 ? format::bc1_unorm_srgb : format::bc1_unorm;
415  case format::bc2_typeless:
416  case format::bc2_unorm:
417  return srgb_variant == 1 ? format::bc2_unorm_srgb : format::bc2_unorm;
418  case format::bc2_unorm_srgb:
419  return srgb_variant != 0 ? format::bc2_unorm_srgb : format::bc2_unorm;
420  case format::bc3_typeless:
421  case format::bc3_unorm:
422  return srgb_variant == 1 ? format::bc3_unorm_srgb : format::bc3_unorm;
423  case format::bc3_unorm_srgb:
424  return srgb_variant != 0 ? format::bc3_unorm_srgb : format::bc3_unorm;
425  case format::bc4_typeless:
426  return format::bc4_unorm;
427  case format::bc5_typeless:
428  return format::bc5_unorm;
429  case format::bc6h_typeless:
430  return format::bc6h_ufloat;
431  case format::bc7_typeless:
432  case format::bc7_unorm:
433  return srgb_variant == 1 ? format::bc7_unorm_srgb : format::bc7_unorm;
434  case format::bc7_unorm_srgb:
435  return srgb_variant != 0 ? format::bc7_unorm_srgb : format::bc7_unorm;
436  default:
437  return value;
438  }
439  }
440 
445  inline format format_to_depth_stencil_typed(format value)
446  {
447  switch (value)
448  {
449  case format::r16_typeless:
450  case format::r16_unorm:
451  return format::d16_unorm;
452  case format::r32_typeless:
453  case format::r32_float:
454  return format::d32_float;
455  case format::r32_g8_typeless:
456  case format::r32_float_x8_uint:
457  case format::x32_float_g8_uint:
458  return format::d32_float_s8_uint;
459  case format::r24_g8_typeless:
460  case format::r24_unorm_x8_uint:
461  case format::x24_unorm_g8_uint:
462  return format::d24_unorm_s8_uint;
463  default:
464  return value;
465  }
466  }
467 
471  inline const uint32_t format_bit_depth(format value)
472  {
473  switch (value)
474  {
475  case format::b5g6r5_unorm:
476  case format::b5g5r5a1_unorm:
477  case format::b5g5r5x1_unorm:
478  return 5;
479  case format::r8g8b8a8_typeless:
480  case format::r8g8b8a8_unorm:
481  case format::r8g8b8a8_unorm_srgb:
482  case format::r8g8b8x8_unorm:
483  case format::r8g8b8x8_unorm_srgb:
484  case format::b8g8r8a8_typeless:
485  case format::b8g8r8a8_unorm:
486  case format::b8g8r8a8_unorm_srgb:
487  case format::b8g8r8x8_typeless:
488  case format::b8g8r8x8_unorm:
489  case format::b8g8r8x8_unorm_srgb:
490  return 8;
491  case format::r9g9b9e5:
492  return 9;
493  case format::r10g10b10a2_typeless:
494  case format::r10g10b10a2_unorm:
495  case format::r10g10b10a2_xr_bias:
496  case format::b10g10r10a2_typeless:
497  case format::b10g10r10a2_unorm:
498  return 10;
499  case format::r11g11b10_float:
500  return 11;
501  case format::r16g16b16a16_typeless:
502  case format::r16g16b16a16_float:
503  return 16;
504  case format::r32g32b32_typeless:
505  case format::r32g32b32_float:
506  case format::r32g32b32a32_typeless:
507  case format::r32g32b32a32_float:
508  return 32;
509  default:
510  return 0;
511  }
512  }
513 
517  inline const uint32_t format_row_pitch(format value, uint32_t width)
518  {
519  if (value == format::unknown)
520  return 0;
521 
522  if (value <= format::r32g32b32a32_sint)
523  return 16 * width;
524  if (value <= format::r32g32b32_sint)
525  return 12 * width;
526  if (value <= format::x32_float_g8_uint)
527  return 8 * width;
528  if (value <= format::x24_unorm_g8_uint || value == format::l16a16_unorm)
529  return 4 * width;
530  if (value <= format::r16_sint || value == format::b5g6r5_unorm || value == format::b5g5r5a1_unorm || value == format::b5g5r5x1_unorm || value == format::l8a8_unorm || value == format::l16_unorm)
531  return 2 * width;
532  if (value <= format::a8_unorm || value == format::l8_unorm)
533  return 1 * width;
534  if (value <= format::g8r8_g8b8_unorm || (value >= format::b8g8r8a8_unorm && value <= format::b8g8r8x8_unorm_srgb) || (value == format::r8g8b8x8_unorm || value == format::r8g8b8x8_unorm_srgb) || (value >= format::b10g10r10a2_typeless && value <= format::b10g10r10a2_uint))
535  return 4 * width;
536 
537  // Block compressed formats are bytes per block, rather than per pixel
538  if ((value >= format::bc2_typeless && value <= format::bc2_unorm_srgb) || (value >= format::bc3_typeless && value <= format::bc3_unorm_srgb) || (value >= format::bc5_typeless && value <= format::bc7_unorm_srgb))
539  return 16 * ((width + 3) / 4);
540  if ((value >= format::bc1_typeless && value <= format::bc1_unorm_srgb) || (value >= format::bc4_typeless && value <= format::bc4_snorm))
541  return 8 * ((width + 3) / 4);
542 
543  // Unusual formats
544  if ((value >= format::r16g16b16_typeless && value <= format::r16g16b16_float))
545  return 6 * width;
546  if ((value >= format::r8g8b8_typeless && value <= format::r8g8b8_unorm_srgb) || (value >= format::b8g8r8_typeless && value <= format::b8g8r8_unorm_srgb))
547  return 3 * width;
548 
549  return 0;
550  }
551 
555  inline const uint32_t format_slice_pitch(format value, uint32_t row_pitch, uint32_t height)
556  {
557  if ((value >= format::bc1_typeless && value <= format::bc5_snorm) || (value >= format::bc6h_typeless && value <= format::bc7_unorm_srgb))
558  return row_pitch * ((height + 3) / 4);
559 
560  return row_pitch * height;
561  }
562 
566  inline bool format_is_typeless(format value)
567  {
568  return value == api::format_to_typeless(value) && value != api::format_to_default_typed(value);
569  }
570 
574  inline bool format_is_block_compressed(format value)
575  {
576  switch (value)
577  {
578  case format::bc1_typeless:
579  case format::bc1_unorm:
580  case format::bc1_unorm_srgb:
581  case format::bc2_typeless:
582  case format::bc2_unorm:
583  case format::bc2_unorm_srgb:
584  case format::bc3_typeless:
585  case format::bc3_unorm:
586  case format::bc3_unorm_srgb:
587  case format::bc4_typeless:
588  case format::bc4_unorm:
589  case format::bc4_snorm:
590  case format::bc5_typeless:
591  case format::bc5_unorm:
592  case format::bc5_snorm:
593  case format::bc6h_typeless:
594  case format::bc6h_ufloat:
595  case format::bc6h_sfloat:
596  case format::bc7_typeless:
597  case format::bc7_unorm:
598  case format::bc7_unorm_srgb:
599  return true;
600  default:
601  return false;
602  }
603  }
604 }
reshade::api
Definition: reshade_api.hpp:11
reshade::api::format_to_default_typed
format format_to_default_typed(format value, int srgb_variant=-1)
Converts the specified format value to its equivalent typed variant ("unorm" or "float").
Definition: reshade_api_format.hpp:344
reshade::api::format_slice_pitch
const uint32_t format_slice_pitch(format value, uint32_t row_pitch, uint32_t height)
Gets the number of bytes a texture slice of the specified format value occupies.
Definition: reshade_api_format.hpp:555
reshade::api::format_row_pitch
const uint32_t format_row_pitch(format value, uint32_t width)
Gets the number of bytes a texture row of the specified format value occupies.
Definition: reshade_api_format.hpp:517
reshade::api::color_space
color_space
The available color space types for presentation.
Definition: reshade_api_format.hpp:186
reshade::api::format_to_depth_stencil_typed
format format_to_depth_stencil_typed(format value)
Converts the specified format value to its equivalent depth-stencil variant.
Definition: reshade_api_format.hpp:445
reshade::api::format_bit_depth
const uint32_t format_bit_depth(format value)
Gets the average component bit depth of the specified format value .
Definition: reshade_api_format.hpp:471
reshade::api::format_to_typeless
format format_to_typeless(format value)
Converts the specified format value to its equivalent typeless variant.
Definition: reshade_api_format.hpp:207
reshade::api::format_is_typeless
bool format_is_typeless(format value)
Checks whether the specified format value is a typeless format.
Definition: reshade_api_format.hpp:566
reshade::api::format_is_block_compressed
bool format_is_block_compressed(format value)
Checks whether the specified format value is a block compressed (BC) format.
Definition: reshade_api_format.hpp:574
reshade::api::format
format
Available data and texture formats. This is mostly compatible with 'DXGI_FORMAT'.
Definition: reshade_api_format.hpp:18
Generated by doxygen 1.9.1