summaryrefslogtreecommitdiffstats
path: root/src/video_core/surface.h
blob: 3232e437f35c0af7ded3565379bb35624705159f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#pragma once

#include <climits>
#include <utility>
#include "common/assert.h"
#include "common/common_types.h"
#include "common/logging/log.h"
#include "video_core/gpu.h"
#include "video_core/textures/texture.h"

namespace VideoCore::Surface {

enum class PixelFormat {
    ABGR8U = 0,
    ABGR8S = 1,
    ABGR8UI = 2,
    B5G6R5U = 3,
    A2B10G10R10U = 4,
    A1B5G5R5U = 5,
    R8U = 6,
    R8UI = 7,
    RGBA16F = 8,
    RGBA16U = 9,
    RGBA16UI = 10,
    R11FG11FB10F = 11,
    RGBA32UI = 12,
    DXT1 = 13,
    DXT23 = 14,
    DXT45 = 15,
    DXN1 = 16, // This is also known as BC4
    DXN2UNORM = 17,
    DXN2SNORM = 18,
    BC7U = 19,
    BC6H_UF16 = 20,
    BC6H_SF16 = 21,
    ASTC_2D_4X4 = 22,
    G8R8U = 23,
    G8R8S = 24,
    BGRA8 = 25,
    RGBA32F = 26,
    RG32F = 27,
    R32F = 28,
    R16F = 29,
    R16U = 30,
    R16S = 31,
    R16UI = 32,
    R16I = 33,
    RG16 = 34,
    RG16F = 35,
    RG16UI = 36,
    RG16I = 37,
    RG16S = 38,
    RGB32F = 39,
    RGBA8_SRGB = 40,
    RG8U = 41,
    RG8S = 42,
    RG32UI = 43,
    R32UI = 44,
    ASTC_2D_8X8 = 45,
    ASTC_2D_8X5 = 46,
    ASTC_2D_5X4 = 47,
    BGRA8_SRGB = 48,
    DXT1_SRGB = 49,
    DXT23_SRGB = 50,
    DXT45_SRGB = 51,
    BC7U_SRGB = 52,
    ASTC_2D_4X4_SRGB = 53,
    ASTC_2D_8X8_SRGB = 54,
    ASTC_2D_8X5_SRGB = 55,
    ASTC_2D_5X4_SRGB = 56,

    MaxColorFormat,

    // Depth formats
    Z32F = 57,
    Z16 = 58,

    MaxDepthFormat,

    // DepthStencil formats
    Z24S8 = 59,
    S8Z24 = 60,
    Z32FS8 = 61,

    MaxDepthStencilFormat,

    Max = MaxDepthStencilFormat,
    Invalid = 255,
};

static constexpr std::size_t MaxPixelFormat = static_cast<std::size_t>(PixelFormat::Max);

enum class ComponentType {
    Invalid = 0,
    SNorm = 1,
    UNorm = 2,
    SInt = 3,
    UInt = 4,
    Float = 5,
};

enum class SurfaceType {
    ColorTexture = 0,
    Depth = 1,
    DepthStencil = 2,
    Fill = 3,
    Invalid = 4,
};

enum class SurfaceTarget {
    Texture1D,
    Texture2D,
    Texture3D,
    Texture1DArray,
    Texture2DArray,
    TextureCubemap,
};

/**
 * Gets the compression factor for the specified PixelFormat. This applies to just the
 * "compressed width" and "compressed height", not the overall compression factor of a
 * compressed image. This is used for maintaining proper surface sizes for compressed
 * texture formats.
 */
static constexpr u32 GetCompressionFactor(PixelFormat format) {
    if (format == PixelFormat::Invalid)
        return 0;

    constexpr std::array<u32, MaxPixelFormat> compression_factor_table = {{
        1, // ABGR8U
        1, // ABGR8S
        1, // ABGR8UI
        1, // B5G6R5U
        1, // A2B10G10R10U
        1, // A1B5G5R5U
        1, // R8U
        1, // R8UI
        1, // RGBA16F
        1, // RGBA16U
        1, // RGBA16UI
        1, // R11FG11FB10F
        1, // RGBA32UI
        4, // DXT1
        4, // DXT23
        4, // DXT45
        4, // DXN1
        4, // DXN2UNORM
        4, // DXN2SNORM
        4, // BC7U
        4, // BC6H_UF16
        4, // BC6H_SF16
        4, // ASTC_2D_4X4
        1, // G8R8U
        1, // G8R8S
        1, // BGRA8
        1, // RGBA32F
        1, // RG32F
        1, // R32F
        1, // R16F
        1, // R16U
        1, // R16S
        1, // R16UI
        1, // R16I
        1, // RG16
        1, // RG16F
        1, // RG16UI
        1, // RG16I
        1, // RG16S
        1, // RGB32F
        1, // RGBA8_SRGB
        1, // RG8U
        1, // RG8S
        1, // RG32UI
        1, // R32UI
        4, // ASTC_2D_8X8
        4, // ASTC_2D_8X5
        4, // ASTC_2D_5X4
        1, // BGRA8_SRGB
        4, // DXT1_SRGB
        4, // DXT23_SRGB
        4, // DXT45_SRGB
        4, // BC7U_SRGB
        4, // ASTC_2D_4X4_SRGB
        4, // ASTC_2D_8X8_SRGB
        4, // ASTC_2D_8X5_SRGB
        4, // ASTC_2D_5X4_SRGB
        1, // Z32F
        1, // Z16
        1, // Z24S8
        1, // S8Z24
        1, // Z32FS8
    }};

    ASSERT(static_cast<std::size_t>(format) < compression_factor_table.size());
    return compression_factor_table[static_cast<std::size_t>(format)];
}

static constexpr u32 GetDefaultBlockHeight(PixelFormat format) {
    if (format == PixelFormat::Invalid)
        return 0;

    constexpr std::array<u32, MaxPixelFormat> block_height_table = {{
        1, // ABGR8U
        1, // ABGR8S
        1, // ABGR8UI
        1, // B5G6R5U
        1, // A2B10G10R10U
        1, // A1B5G5R5U
        1, // R8U
        1, // R8UI
        1, // RGBA16F
        1, // RGBA16U
        1, // RGBA16UI
        1, // R11FG11FB10F
        1, // RGBA32UI
        4, // DXT1
        4, // DXT23
        4, // DXT45
        4, // DXN1
        4, // DXN2UNORM
        4, // DXN2SNORM
        4, // BC7U
        4, // BC6H_UF16
        4, // BC6H_SF16
        4, // ASTC_2D_4X4
        1, // G8R8U
        1, // G8R8S
        1, // BGRA8
        1, // RGBA32F
        1, // RG32F
        1, // R32F
        1, // R16F
        1, // R16U
        1, // R16S
        1, // R16UI
        1, // R16I
        1, // RG16
        1, // RG16F
        1, // RG16UI
        1, // RG16I
        1, // RG16S
        1, // RGB32F
        1, // RGBA8_SRGB
        1, // RG8U
        1, // RG8S
        1, // RG32UI
        1, // R32UI
        8, // ASTC_2D_8X8
        5, // ASTC_2D_8X5
        4, // ASTC_2D_5X4
        1, // BGRA8_SRGB
        4, // DXT1_SRGB
        4, // DXT23_SRGB
        4, // DXT45_SRGB
        4, // BC7U_SRGB
        4, // ASTC_2D_4X4_SRGB
        8, // ASTC_2D_8X8_SRGB
        5, // ASTC_2D_8X5_SRGB
        4, // ASTC_2D_5X4_SRGB
        1, // Z32F
        1, // Z16
        1, // Z24S8
        1, // S8Z24
        1, // Z32FS8
    }};

    ASSERT(static_cast<std::size_t>(format) < block_height_table.size());
    return block_height_table[static_cast<std::size_t>(format)];
}

static constexpr u32 GetFormatBpp(PixelFormat format) {
    if (format == PixelFormat::Invalid)
        return 0;

    constexpr std::array<u32, MaxPixelFormat> bpp_table = {{
        32,  // ABGR8U
        32,  // ABGR8S
        32,  // ABGR8UI
        16,  // B5G6R5U
        32,  // A2B10G10R10U
        16,  // A1B5G5R5U
        8,   // R8U
        8,   // R8UI
        64,  // RGBA16F
        64,  // RGBA16U
        64,  // RGBA16UI
        32,  // R11FG11FB10F
        128, // RGBA32UI
        64,  // DXT1
        128, // DXT23
        128, // DXT45
        64,  // DXN1
        128, // DXN2UNORM
        128, // DXN2SNORM
        128, // BC7U
        128, // BC6H_UF16
        128, // BC6H_SF16
        32,  // ASTC_2D_4X4
        16,  // G8R8U
        16,  // G8R8S
        32,  // BGRA8
        128, // RGBA32F
        64,  // RG32F
        32,  // R32F
        16,  // R16F
        16,  // R16U
        16,  // R16S
        16,  // R16UI
        16,  // R16I
        32,  // RG16
        32,  // RG16F
        32,  // RG16UI
        32,  // RG16I
        32,  // RG16S
        96,  // RGB32F
        32,  // RGBA8_SRGB
        16,  // RG8U
        16,  // RG8S
        64,  // RG32UI
        32,  // R32UI
        16,  // ASTC_2D_8X8
        16,  // ASTC_2D_8X5
        32,  // ASTC_2D_5X4
        32,  // BGRA8_SRGB
        64,  // DXT1_SRGB
        128, // DXT23_SRGB
        128, // DXT45_SRGB
        128, // BC7U
        32,  // ASTC_2D_4X4_SRGB
        16,  // ASTC_2D_8X8_SRGB
        16,  // ASTC_2D_8X5_SRGB
        32,  // ASTC_2D_5X4_SRGB
        32,  // Z32F
        16,  // Z16
        32,  // Z24S8
        32,  // S8Z24
        64,  // Z32FS8
    }};

    ASSERT(static_cast<std::size_t>(format) < bpp_table.size());
    return bpp_table[static_cast<std::size_t>(format)];
}

/// Returns the sizer in bytes of the specified pixel format
static constexpr u32 GetBytesPerPixel(PixelFormat pixel_format) {
    if (pixel_format == PixelFormat::Invalid) {
        return 0;
    }
    return GetFormatBpp(pixel_format) / CHAR_BIT;
}

SurfaceTarget SurfaceTargetFromTextureType(Tegra::Texture::TextureType texture_type);

bool SurfaceTargetIsLayered(SurfaceTarget target);

PixelFormat PixelFormatFromDepthFormat(Tegra::DepthFormat format);

PixelFormat PixelFormatFromRenderTargetFormat(Tegra::RenderTargetFormat format);

PixelFormat PixelFormatFromTextureFormat(Tegra::Texture::TextureFormat format,
                                         Tegra::Texture::ComponentType component_type,
                                         bool is_srgb);

ComponentType ComponentTypeFromTexture(Tegra::Texture::ComponentType type);

ComponentType ComponentTypeFromRenderTarget(Tegra::RenderTargetFormat format);

PixelFormat PixelFormatFromGPUPixelFormat(Tegra::FramebufferConfig::PixelFormat format);

ComponentType ComponentTypeFromDepthFormat(Tegra::DepthFormat format);

SurfaceType GetFormatType(PixelFormat pixel_format);

bool IsPixelFormatASTC(PixelFormat format);

std::pair<u32, u32> GetASTCBlockSize(PixelFormat format);

/// Returns true if the specified PixelFormat is a BCn format, e.g. DXT or DXN
bool IsFormatBCn(PixelFormat format);

} // namespace VideoCore::Surface