mirrored from https://chromium.googlesource.com/angle/angle
-
Notifications
You must be signed in to change notification settings - Fork 619
/
vk_format_utils.h
304 lines (250 loc) · 11.8 KB
/
vk_format_utils.h
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
//
// Copyright 2016 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// vk_format_utils:
// Helper for Vulkan format code.
#ifndef LIBANGLE_RENDERER_VULKAN_VK_FORMAT_UTILS_H_
#define LIBANGLE_RENDERER_VULKAN_VK_FORMAT_UTILS_H_
#include "common/SimpleMutex.h"
#include "common/vulkan/vk_headers.h"
#include "libANGLE/formatutils.h"
#include "libANGLE/renderer/Format.h"
#include "libANGLE/renderer/copyvertex.h"
#include "libANGLE/renderer/renderer_utils.h"
#include "platform/autogen/FeaturesVk_autogen.h"
#include <array>
namespace gl
{
struct SwizzleState;
class TextureCapsMap;
} // namespace gl
namespace rx
{
class ContextVk;
namespace vk
{
class Renderer;
// VkFormat values in range [0, kNumVkFormats) are used as indices in various tables.
constexpr uint32_t kNumVkFormats = 185;
enum ImageAccess
{
SampleOnly,
Renderable,
};
struct ImageFormatInitInfo final
{
angle::FormatID format;
InitializeTextureDataFunction initializer;
};
struct BufferFormatInitInfo final
{
angle::FormatID format;
bool vkFormatIsPacked;
VertexCopyFunction vertexLoadFunction;
bool vertexLoadRequiresConversion;
};
VkFormat GetVkFormatFromFormatID(const Renderer *renderer, angle::FormatID actualFormatID);
angle::FormatID GetFormatIDFromVkFormat(VkFormat vkFormat);
// Returns buffer alignment for image-copy operations (to or from a buffer).
size_t GetImageCopyBufferAlignment(angle::FormatID actualFormatID);
size_t GetValidImageCopyBufferAlignment(angle::FormatID intendedFormatID,
angle::FormatID actualFormatID);
bool HasEmulatedImageChannels(const angle::Format &intendedFormat,
const angle::Format &actualFormat);
// Returns true if the image has a different image format than intended.
bool HasEmulatedImageFormat(angle::FormatID intendedFormatID, angle::FormatID actualFormatID);
// Describes a Vulkan format. For more information on formats in the Vulkan back-end please see
// https://chromium.googlesource.com/angle/angle/+/main/src/libANGLE/renderer/vulkan/doc/FormatTablesAndEmulation.md
class Format final : private angle::NonCopyable
{
public:
Format();
bool valid() const { return mIntendedGLFormat != 0; }
GLenum getIntendedGLFormat() const { return mIntendedGLFormat; }
// The intended format is the front-end format. For Textures this usually correponds to a
// GLenum in the headers. Buffer formats don't always have a corresponding GLenum type.
// Some Surface formats and unsized types also don't have a corresponding GLenum.
angle::FormatID getIntendedFormatID() const { return mIntendedFormatID; }
const angle::Format &getIntendedFormat() const { return angle::Format::Get(mIntendedFormatID); }
// The actual Image format is used to implement the front-end format for Texture/Renderbuffers.
const angle::Format &getActualImageFormat(ImageAccess access) const
{
return angle::Format::Get(getActualImageFormatID(access));
}
angle::FormatID getActualRenderableImageFormatID() const
{
return mActualRenderableImageFormatID;
}
const angle::Format &getActualRenderableImageFormat() const
{
return angle::Format::Get(mActualRenderableImageFormatID);
}
VkFormat getActualRenderableImageVkFormat(const Renderer *renderer) const
{
return GetVkFormatFromFormatID(renderer, mActualRenderableImageFormatID);
}
angle::FormatID getActualImageFormatID(ImageAccess access) const
{
return ImageAccess::Renderable == access ? mActualRenderableImageFormatID
: mActualSampleOnlyImageFormatID;
}
VkFormat getActualImageVkFormat(const Renderer *renderer, ImageAccess access) const
{
return GetVkFormatFromFormatID(renderer, getActualImageFormatID(access));
}
LoadImageFunctionInfo getTextureLoadFunction(ImageAccess access, GLenum type) const
{
return ImageAccess::Renderable == access ? mRenderableTextureLoadFunctions(type)
: mTextureLoadFunctions(type);
}
// The actual Buffer format is used to implement the front-end format for Buffers. This format
// is used by vertex buffers as well as texture buffers. Note that all formats required for
// GL_EXT_texture_buffer have mandatory support for vertex buffers in Vulkan, so they won't be
// using an emulated format.
const angle::Format &getActualBufferFormat(bool compressed) const
{
return angle::Format::Get(compressed ? mActualCompressedBufferFormatID
: mActualBufferFormatID);
}
VkFormat getActualBufferVkFormat(const Renderer *renderer, bool compressed) const
{
return GetVkFormatFromFormatID(
renderer, compressed ? mActualCompressedBufferFormatID : mActualBufferFormatID);
}
VertexCopyFunction getVertexLoadFunction(bool compressed) const
{
return compressed ? mCompressedVertexLoadFunction : mVertexLoadFunction;
}
bool getVertexLoadRequiresConversion(bool compressed) const
{
return compressed ? mCompressedVertexLoadRequiresConversion : mVertexLoadRequiresConversion;
}
// |intendedGLFormat| always correponds to a valid GLenum type. For types that don't have a
// corresponding GLenum we do our best to specify a GLenum that is "close".
const gl::InternalFormat &getInternalFormatInfo(GLenum type) const
{
return gl::GetInternalFormatInfo(mIntendedGLFormat, type);
}
bool hasRenderableImageFallbackFormat() const
{
return mActualSampleOnlyImageFormatID != mActualRenderableImageFormatID;
}
bool canCompressBufferData() const
{
return mActualCompressedBufferFormatID != angle::FormatID::NONE &&
mActualBufferFormatID != mActualCompressedBufferFormatID;
}
// Returns the alignment for a buffer to be used with the vertex input stage in Vulkan. This
// calculation is listed in the Vulkan spec at the end of the section 'Vertex Input
// Description'.
size_t getVertexInputAlignment(bool compressed) const;
private:
friend class FormatTable;
// This is an auto-generated method in vk_format_table_autogen.cpp.
void initialize(Renderer *renderer, const angle::Format &intendedAngleFormat);
// These are used in the format table init.
void initImageFallback(Renderer *renderer, const ImageFormatInitInfo *info, int numInfo);
void initBufferFallback(Renderer *renderer,
const BufferFormatInitInfo *fallbackInfo,
int numInfo,
int compressedStartIndex);
angle::FormatID mIntendedFormatID;
GLenum mIntendedGLFormat;
angle::FormatID mActualSampleOnlyImageFormatID;
angle::FormatID mActualRenderableImageFormatID;
angle::FormatID mActualBufferFormatID;
angle::FormatID mActualCompressedBufferFormatID;
InitializeTextureDataFunction mImageInitializerFunction;
LoadFunctionMap mTextureLoadFunctions;
LoadFunctionMap mRenderableTextureLoadFunctions;
VertexCopyFunction mVertexLoadFunction;
VertexCopyFunction mCompressedVertexLoadFunction;
bool mVertexLoadRequiresConversion;
bool mCompressedVertexLoadRequiresConversion;
bool mVkBufferFormatIsPacked;
bool mVkCompressedBufferFormatIsPacked;
bool mVkFormatIsInt;
bool mVkFormatIsUnsigned;
};
bool operator==(const Format &lhs, const Format &rhs);
bool operator!=(const Format &lhs, const Format &rhs);
class FormatTable final : angle::NonCopyable
{
public:
FormatTable();
~FormatTable();
// Also initializes the TextureCapsMap and the compressedTextureCaps in the Caps instance.
void initialize(Renderer *renderer, gl::TextureCapsMap *outTextureCapsMap);
ANGLE_INLINE const Format &operator[](GLenum internalFormat) const
{
angle::FormatID formatID = angle::Format::InternalFormatToID(internalFormat);
return mFormatData[static_cast<size_t>(formatID)];
}
ANGLE_INLINE const Format &operator[](angle::FormatID formatID) const
{
return mFormatData[static_cast<size_t>(formatID)];
}
private:
// The table data is indexed by angle::FormatID.
std::array<Format, angle::kNumANGLEFormats> mFormatData;
};
// Extra data required for a renderable external format, for EXT_yuv_target support.
// We have one of these structures per external format slot (angle::FormatID::EXTERNALn)
// and allocate them to particular actual external formats in the order we see them.
struct ExternalYuvFormatInfo
{
// Vendor-specific external format value to be passed in VkExternalFormatANDROID
uint64_t externalFormat;
// Format the driver wants us to use for a temporary color attachment in order to render into
// this external format
VkFormat colorAttachmentFormat;
VkFormatFeatureFlags formatFeatures;
};
class ExternalFormatTable final : angle::NonCopyable
{
public:
// Convert externalFormat to one of angle::FormatID::EXTERNALn so that we can pass around in
// ANGLE
angle::FormatID getOrAllocExternalFormatID(uint64_t externalFormat,
VkFormat colorAttachmentFormat,
VkFormatFeatureFlags formatFeatures);
const ExternalYuvFormatInfo &getExternalFormatInfo(angle::FormatID format) const;
private:
static constexpr size_t kMaxExternalFormatCountSupported =
ToUnderlying(angle::FormatID::EXTERNAL7) - ToUnderlying(angle::FormatID::EXTERNAL0) + 1;
// YUV rendering format cache. We build this table at run time when external formats are used.
angle::FixedVector<ExternalYuvFormatInfo, kMaxExternalFormatCountSupported> mExternalYuvFormats;
mutable angle::SimpleMutex mExternalYuvFormatMutex;
};
bool IsYUVExternalFormat(angle::FormatID formatID);
// This will return a reference to a VkFormatProperties with the feature flags supported
// if the format is a mandatory format described in section 31.3.3. Required Format Support
// of the Vulkan spec. If the vkFormat isn't mandatory, it will return a VkFormatProperties
// initialized to 0.
const VkFormatProperties &GetMandatoryFormatSupport(angle::FormatID formatID);
VkImageUsageFlags GetMaximalImageUsageFlags(Renderer *renderer, angle::FormatID formatID);
VkImageCreateFlags GetMinimalImageCreateFlags(Renderer *renderer,
gl::TextureType textureType,
VkImageUsageFlags usage);
} // namespace vk
// Checks if a Vulkan format supports all the features needed to use it as a GL texture format.
bool HasFullTextureFormatSupport(vk::Renderer *renderer, angle::FormatID formatID);
// Checks if a Vulkan format supports all the features except rendering.
bool HasNonRenderableTextureFormatSupport(vk::Renderer *renderer, angle::FormatID formatID);
// Checks if it is a ETC texture format
bool IsETCFormat(angle::FormatID formatID);
// Checks if it is a BC texture format
bool IsBCFormat(angle::FormatID formatID);
angle::FormatID GetTranscodeBCFormatID(angle::FormatID formatID);
VkFormat AdjustASTCFormatForHDR(const vk::Renderer *renderer, VkFormat vkFormat);
// Get Etc format cpu transcoding to Bc function.
LoadImageFunctionInfo GetEtcToBcTransCodingFunc(angle::FormatID formatID);
// Get the swizzle state based on format's requirements and emulations.
gl::SwizzleState GetFormatSwizzle(const angle::Format &angleFormat, const bool sized);
// Apply application's swizzle to the swizzle implied by format as received from GetFormatSwizzle.
gl::SwizzleState ApplySwizzle(const gl::SwizzleState &formatSwizzle,
const gl::SwizzleState &toApply);
} // namespace rx
#endif // LIBANGLE_RENDERER_VULKAN_VK_FORMAT_UTILS_H_