Flutter Impeller
formats_vk.h
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef FLUTTER_IMPELLER_RENDERER_BACKEND_VULKAN_FORMATS_VK_H_
6 #define FLUTTER_IMPELLER_RENDERER_BACKEND_VULKAN_FORMATS_VK_H_
7 
8 #include <cstdint>
9 #include <ostream>
10 
11 #include "fml/logging.h"
12 #include "impeller/base/validation.h"
13 #include "impeller/core/formats.h"
14 #include "impeller/core/shader_types.h"
15 #include "impeller/renderer/backend/vulkan/vk.h"
16 #include "vulkan/vulkan_enums.hpp"
17 
18 namespace impeller {
19 
20 constexpr std::optional<PixelFormat> VkFormatToImpellerFormat(
21  vk::Format format) {
22  switch (format) {
23  case vk::Format::eR8G8B8A8Unorm:
24  return PixelFormat::kR8G8B8A8UNormInt;
25  case vk::Format::eB8G8R8A8Unorm:
26  return PixelFormat::kB8G8R8A8UNormInt;
27  default:
28  return std::nullopt;
29  }
30 }
31 
32 constexpr vk::SampleCountFlagBits ToVKSampleCountFlagBits(SampleCount count) {
33  switch (count) {
34  case SampleCount::kCount1:
35  return vk::SampleCountFlagBits::e1;
36  case SampleCount::kCount4:
37  return vk::SampleCountFlagBits::e4;
38  }
39  FML_UNREACHABLE();
40 }
41 
42 constexpr vk::BlendFactor ToVKBlendFactor(BlendFactor factor) {
43  switch (factor) {
44  case BlendFactor::kZero:
45  return vk::BlendFactor::eZero;
46  case BlendFactor::kOne:
47  return vk::BlendFactor::eOne;
48  case BlendFactor::kSourceColor:
49  return vk::BlendFactor::eSrcColor;
50  case BlendFactor::kOneMinusSourceColor:
51  return vk::BlendFactor::eOneMinusSrcColor;
52  case BlendFactor::kSourceAlpha:
53  return vk::BlendFactor::eSrcAlpha;
54  case BlendFactor::kOneMinusSourceAlpha:
55  return vk::BlendFactor::eOneMinusSrcAlpha;
56  case BlendFactor::kDestinationColor:
57  return vk::BlendFactor::eDstColor;
58  case BlendFactor::kOneMinusDestinationColor:
59  return vk::BlendFactor::eOneMinusDstColor;
60  case BlendFactor::kDestinationAlpha:
61  return vk::BlendFactor::eDstAlpha;
62  case BlendFactor::kOneMinusDestinationAlpha:
63  return vk::BlendFactor::eOneMinusDstAlpha;
64  case BlendFactor::kSourceAlphaSaturated:
65  return vk::BlendFactor::eSrcAlphaSaturate;
66  case BlendFactor::kBlendColor:
67  return vk::BlendFactor::eConstantColor;
68  case BlendFactor::kOneMinusBlendColor:
69  return vk::BlendFactor::eOneMinusConstantColor;
70  case BlendFactor::kBlendAlpha:
71  return vk::BlendFactor::eConstantAlpha;
72  case BlendFactor::kOneMinusBlendAlpha:
73  return vk::BlendFactor::eOneMinusConstantAlpha;
74  }
75  FML_UNREACHABLE();
76 }
77 
78 constexpr vk::BlendOp ToVKBlendOp(BlendOperation op) {
79  switch (op) {
80  case BlendOperation::kAdd:
81  return vk::BlendOp::eAdd;
82  case BlendOperation::kSubtract:
83  return vk::BlendOp::eSubtract;
84  case BlendOperation::kReverseSubtract:
85  return vk::BlendOp::eReverseSubtract;
86  }
87  FML_UNREACHABLE();
88 }
89 
90 constexpr vk::ColorComponentFlags ToVKColorComponentFlags(ColorWriteMask type) {
91  vk::ColorComponentFlags mask;
92 
93  if (type & ColorWriteMaskBits::kRed) {
94  mask |= vk::ColorComponentFlagBits::eR;
95  }
96 
97  if (type & ColorWriteMaskBits::kGreen) {
98  mask |= vk::ColorComponentFlagBits::eG;
99  }
100 
101  if (type & ColorWriteMaskBits::kBlue) {
102  mask |= vk::ColorComponentFlagBits::eB;
103  }
104 
105  if (type & ColorWriteMaskBits::kAlpha) {
106  mask |= vk::ColorComponentFlagBits::eA;
107  }
108 
109  return mask;
110 }
111 
112 constexpr vk::PipelineColorBlendAttachmentState
113 ToVKPipelineColorBlendAttachmentState(const ColorAttachmentDescriptor& desc) {
114  vk::PipelineColorBlendAttachmentState res;
115 
116  res.setBlendEnable(desc.blending_enabled);
117 
118  res.setSrcColorBlendFactor(ToVKBlendFactor(desc.src_color_blend_factor));
119  res.setColorBlendOp(ToVKBlendOp(desc.color_blend_op));
120  res.setDstColorBlendFactor(ToVKBlendFactor(desc.dst_color_blend_factor));
121 
122  res.setSrcAlphaBlendFactor(ToVKBlendFactor(desc.src_alpha_blend_factor));
123  res.setAlphaBlendOp(ToVKBlendOp(desc.alpha_blend_op));
124  res.setDstAlphaBlendFactor(ToVKBlendFactor(desc.dst_alpha_blend_factor));
125 
126  res.setColorWriteMask(ToVKColorComponentFlags(desc.write_mask));
127 
128  return res;
129 }
130 
131 constexpr std::optional<vk::ShaderStageFlagBits> ToVKShaderStageFlagBits(
132  ShaderStage stage) {
133  switch (stage) {
134  case ShaderStage::kUnknown:
135  return std::nullopt;
136  case ShaderStage::kVertex:
137  return vk::ShaderStageFlagBits::eVertex;
138  case ShaderStage::kFragment:
139  return vk::ShaderStageFlagBits::eFragment;
140  case ShaderStage::kCompute:
141  return vk::ShaderStageFlagBits::eCompute;
142  }
143  FML_UNREACHABLE();
144 }
145 
146 constexpr vk::Format ToVKImageFormat(PixelFormat format) {
147  switch (format) {
148  case PixelFormat::kUnknown:
149  case PixelFormat::kB10G10R10XR:
150  case PixelFormat::kB10G10R10A10XR:
151  case PixelFormat::kB10G10R10XRSRGB:
152  return vk::Format::eUndefined;
153  case PixelFormat::kA8UNormInt:
154  // TODO(csg): This is incorrect. Don't depend on swizzle support for GLES.
155  return vk::Format::eR8Unorm;
156  case PixelFormat::kR8G8B8A8UNormInt:
157  return vk::Format::eR8G8B8A8Unorm;
158  case PixelFormat::kR8G8B8A8UNormIntSRGB:
159  return vk::Format::eR8G8B8A8Srgb;
160  case PixelFormat::kB8G8R8A8UNormInt:
161  return vk::Format::eB8G8R8A8Unorm;
162  case PixelFormat::kB8G8R8A8UNormIntSRGB:
163  return vk::Format::eB8G8R8A8Srgb;
164  case PixelFormat::kR32G32B32A32Float:
165  return vk::Format::eR32G32B32A32Sfloat;
166  case PixelFormat::kR16G16B16A16Float:
167  return vk::Format::eR16G16B16A16Sfloat;
168  case PixelFormat::kS8UInt:
169  return vk::Format::eS8Uint;
170  case PixelFormat::kD24UnormS8Uint:
171  return vk::Format::eD24UnormS8Uint;
172  case PixelFormat::kD32FloatS8UInt:
173  return vk::Format::eD32SfloatS8Uint;
174  case PixelFormat::kR8UNormInt:
175  return vk::Format::eR8Unorm;
176  case PixelFormat::kR8G8UNormInt:
177  return vk::Format::eR8G8Unorm;
178  case PixelFormat::kR32Float:
179  return vk::Format::eR32Sfloat;
180  case PixelFormat::kBC1RGBAUNormInt:
181  return vk::Format::eBc1RgbaUnormBlock;
182  case PixelFormat::kBC1RGBAUNormIntSRGB:
183  return vk::Format::eBc1RgbaSrgbBlock;
184  case PixelFormat::kBC3RGBAUNormInt:
185  return vk::Format::eBc3UnormBlock;
186  case PixelFormat::kBC3RGBAUNormIntSRGB:
187  return vk::Format::eBc3SrgbBlock;
188  case PixelFormat::kBC5RGUNormInt:
189  return vk::Format::eBc5UnormBlock;
190  case PixelFormat::kBC7RGBAUNormInt:
191  return vk::Format::eBc7UnormBlock;
192  case PixelFormat::kBC7RGBAUNormIntSRGB:
193  return vk::Format::eBc7SrgbBlock;
194  case PixelFormat::kETC2RGB8UNormInt:
195  return vk::Format::eEtc2R8G8B8UnormBlock;
196  case PixelFormat::kETC2RGB8UNormIntSRGB:
197  return vk::Format::eEtc2R8G8B8SrgbBlock;
198  case PixelFormat::kETC2RGBA8UNormInt:
199  return vk::Format::eEtc2R8G8B8A8UnormBlock;
200  case PixelFormat::kETC2RGBA8UNormIntSRGB:
201  return vk::Format::eEtc2R8G8B8A8SrgbBlock;
202  case PixelFormat::kASTC4x4LDR:
203  return vk::Format::eAstc4x4UnormBlock;
204  case PixelFormat::kASTC4x4LDRSRGB:
205  return vk::Format::eAstc4x4SrgbBlock;
206  case PixelFormat::kASTC8x8LDR:
207  return vk::Format::eAstc8x8UnormBlock;
208  case PixelFormat::kASTC8x8LDRSRGB:
209  return vk::Format::eAstc8x8SrgbBlock;
210  case PixelFormat::kASTC4x4HDR:
211  return vk::Format::eAstc4x4SfloatBlock;
212  case PixelFormat::kASTC8x8HDR:
213  return vk::Format::eAstc8x8SfloatBlock;
214  }
215 
216  FML_UNREACHABLE();
217 }
218 
219 constexpr PixelFormat ToPixelFormat(vk::Format format) {
220  switch (format) {
221  case vk::Format::eUndefined:
222  return PixelFormat::kUnknown;
223  case vk::Format::eR8G8B8A8Unorm:
224  return PixelFormat::kR8G8B8A8UNormInt;
225  case vk::Format::eR8G8B8A8Srgb:
226  return PixelFormat::kR8G8B8A8UNormIntSRGB;
227  case vk::Format::eB8G8R8A8Unorm:
228  return PixelFormat::kB8G8R8A8UNormInt;
229  case vk::Format::eB8G8R8A8Srgb:
230  return PixelFormat::kB8G8R8A8UNormIntSRGB;
231  case vk::Format::eR32G32B32A32Sfloat:
232  return PixelFormat::kR32G32B32A32Float;
233  case vk::Format::eR16G16B16A16Sfloat:
234  return PixelFormat::kR16G16B16A16Float;
235  case vk::Format::eS8Uint:
236  return PixelFormat::kS8UInt;
237  case vk::Format::eD24UnormS8Uint:
238  return PixelFormat::kD24UnormS8Uint;
239  case vk::Format::eD32SfloatS8Uint:
240  return PixelFormat::kD32FloatS8UInt;
241  case vk::Format::eR8Unorm:
242  return PixelFormat::kR8UNormInt;
243  case vk::Format::eR8G8Unorm:
244  return PixelFormat::kR8G8UNormInt;
245  default:
246  return PixelFormat::kUnknown;
247  }
248 }
249 
250 constexpr vk::SampleCountFlagBits ToVKSampleCount(SampleCount sample_count) {
251  switch (sample_count) {
252  case SampleCount::kCount1:
253  return vk::SampleCountFlagBits::e1;
254  case SampleCount::kCount4:
255  return vk::SampleCountFlagBits::e4;
256  }
257 
258  FML_UNREACHABLE();
259 }
260 
261 constexpr vk::Filter ToVKSamplerMinMagFilter(MinMagFilter filter) {
262  switch (filter) {
263  case MinMagFilter::kNearest:
264  return vk::Filter::eNearest;
265  case MinMagFilter::kLinear:
266  return vk::Filter::eLinear;
267  }
268 
269  FML_UNREACHABLE();
270 }
271 
272 constexpr vk::SamplerMipmapMode ToVKSamplerMipmapMode(MipFilter filter) {
273  switch (filter) {
274  case MipFilter::kBase:
275  case MipFilter::kNearest:
276  return vk::SamplerMipmapMode::eNearest;
277  case MipFilter::kLinear:
278  return vk::SamplerMipmapMode::eLinear;
279  }
280 
281  FML_UNREACHABLE();
282 }
283 
284 constexpr vk::SamplerAddressMode ToVKSamplerAddressMode(
285  SamplerAddressMode mode) {
286  switch (mode) {
287  case SamplerAddressMode::kRepeat:
288  return vk::SamplerAddressMode::eRepeat;
289  case SamplerAddressMode::kMirror:
290  return vk::SamplerAddressMode::eMirroredRepeat;
291  case SamplerAddressMode::kClampToEdge:
292  return vk::SamplerAddressMode::eClampToEdge;
293  case SamplerAddressMode::kDecal:
294  return vk::SamplerAddressMode::eClampToBorder;
295  }
296 
297  FML_UNREACHABLE();
298 }
299 
300 constexpr vk::ShaderStageFlags ToVkShaderStage(ShaderStage stage) {
301  switch (stage) {
302  case ShaderStage::kUnknown:
303  return vk::ShaderStageFlagBits::eAll;
304  case ShaderStage::kFragment:
305  return vk::ShaderStageFlagBits::eFragment;
306  case ShaderStage::kCompute:
307  return vk::ShaderStageFlagBits::eCompute;
308  case ShaderStage::kVertex:
309  return vk::ShaderStageFlagBits::eVertex;
310  }
311 
312  FML_UNREACHABLE();
313 }
314 
315 static_assert(static_cast<int>(DescriptorType::kSampledImage) ==
316  static_cast<int>(vk::DescriptorType::eCombinedImageSampler));
317 static_assert(static_cast<int>(DescriptorType::kUniformBuffer) ==
318  static_cast<int>(vk::DescriptorType::eUniformBuffer));
319 static_assert(static_cast<int>(DescriptorType::kStorageBuffer) ==
320  static_cast<int>(vk::DescriptorType::eStorageBuffer));
321 static_assert(static_cast<int>(DescriptorType::kImage) ==
322  static_cast<int>(vk::DescriptorType::eSampledImage));
323 static_assert(static_cast<int>(DescriptorType::kSampler) ==
324  static_cast<int>(vk::DescriptorType::eSampler));
325 static_assert(static_cast<int>(DescriptorType::kInputAttachment) ==
326  static_cast<int>(vk::DescriptorType::eInputAttachment));
327 
328 constexpr vk::DescriptorType ToVKDescriptorType(DescriptorType type) {
329  return static_cast<vk::DescriptorType>(type);
330 }
331 
332 constexpr vk::DescriptorSetLayoutBinding ToVKDescriptorSetLayoutBinding(
333  const DescriptorSetLayout& layout) {
334  vk::DescriptorSetLayoutBinding binding;
335  binding.binding = layout.binding;
336  binding.descriptorCount = 1u;
337  binding.descriptorType = ToVKDescriptorType(layout.descriptor_type);
338  binding.stageFlags = ToVkShaderStage(layout.shader_stage);
339  return binding;
340 }
341 
342 constexpr vk::AttachmentLoadOp ToVKAttachmentLoadOp(LoadAction load_action) {
343  switch (load_action) {
344  case LoadAction::kLoad:
345  return vk::AttachmentLoadOp::eLoad;
346  case LoadAction::kClear:
347  return vk::AttachmentLoadOp::eClear;
348  case LoadAction::kDontCare:
349  return vk::AttachmentLoadOp::eDontCare;
350  }
351 
352  FML_UNREACHABLE();
353 }
354 
355 constexpr vk::AttachmentStoreOp ToVKAttachmentStoreOp(StoreAction store_action,
356  bool is_resolve_texture) {
357  switch (store_action) {
358  case StoreAction::kStore:
359  // Both MSAA and resolve textures need to be stored. A resolve is NOT
360  // performed.
361  return vk::AttachmentStoreOp::eStore;
362  case StoreAction::kDontCare:
363  // Both MSAA and resolve textures can be discarded. A resolve is NOT
364  // performed.
365  return vk::AttachmentStoreOp::eDontCare;
366  case StoreAction::kMultisampleResolve:
367  // The resolve texture is stored but the MSAA texture can be discarded. A
368  // resolve IS performed.
369  return is_resolve_texture ? vk::AttachmentStoreOp::eStore
370  : vk::AttachmentStoreOp::eDontCare;
371  case StoreAction::kStoreAndMultisampleResolve:
372  // Both MSAA and resolve textures need to be stored. A resolve IS
373  // performed.
374  return vk::AttachmentStoreOp::eStore;
375  }
376  FML_UNREACHABLE();
377 }
378 
379 constexpr bool StoreActionPerformsResolve(StoreAction store_action) {
380  switch (store_action) {
381  case StoreAction::kDontCare:
382  case StoreAction::kStore:
383  return false;
384  case StoreAction::kMultisampleResolve:
385  case StoreAction::kStoreAndMultisampleResolve:
386  return true;
387  }
388  FML_UNREACHABLE();
389 }
390 
391 constexpr vk::IndexType ToVKIndexType(IndexType index_type) {
392  switch (index_type) {
393  case IndexType::k16bit:
394  return vk::IndexType::eUint16;
395  case IndexType::k32bit:
396  return vk::IndexType::eUint32;
397  case IndexType::kUnknown:
398  return vk::IndexType::eUint32;
399  case IndexType::kNone:
400  FML_UNREACHABLE();
401  }
402 
403  FML_UNREACHABLE();
404 }
405 
406 constexpr vk::PolygonMode ToVKPolygonMode(PolygonMode mode) {
407  switch (mode) {
408  case PolygonMode::kFill:
409  return vk::PolygonMode::eFill;
410  case PolygonMode::kLine:
411  return vk::PolygonMode::eLine;
412  }
413  FML_UNREACHABLE();
414 }
415 
416 constexpr bool PrimitiveTopologySupportsPrimitiveRestart(
417  PrimitiveType primitive) {
418  switch (primitive) {
419  case PrimitiveType::kTriangleStrip:
420  case PrimitiveType::kLine:
421  case PrimitiveType::kPoint:
422  case PrimitiveType::kTriangleFan:
423  return true;
424  case PrimitiveType::kTriangle:
425  case PrimitiveType::kLineStrip:
426  return false;
427  }
428  FML_UNREACHABLE();
429 }
430 
431 constexpr vk::PrimitiveTopology ToVKPrimitiveTopology(PrimitiveType primitive) {
432  switch (primitive) {
433  case PrimitiveType::kTriangle:
434  return vk::PrimitiveTopology::eTriangleList;
435  case PrimitiveType::kTriangleStrip:
436  return vk::PrimitiveTopology::eTriangleStrip;
437  case PrimitiveType::kLine:
438  return vk::PrimitiveTopology::eLineList;
439  case PrimitiveType::kLineStrip:
440  return vk::PrimitiveTopology::eLineStrip;
441  case PrimitiveType::kPoint:
442  return vk::PrimitiveTopology::ePointList;
443  case PrimitiveType::kTriangleFan:
444  return vk::PrimitiveTopology::eTriangleFan;
445  }
446 
447  FML_UNREACHABLE();
448 }
449 
450 constexpr bool PixelFormatIsDepthStencil(PixelFormat format) {
451  switch (format) {
452  case PixelFormat::kUnknown:
453  case PixelFormat::kA8UNormInt:
454  case PixelFormat::kR8UNormInt:
455  case PixelFormat::kR8G8UNormInt:
456  case PixelFormat::kR8G8B8A8UNormInt:
457  case PixelFormat::kR8G8B8A8UNormIntSRGB:
458  case PixelFormat::kB8G8R8A8UNormInt:
459  case PixelFormat::kB8G8R8A8UNormIntSRGB:
460  case PixelFormat::kR32G32B32A32Float:
461  case PixelFormat::kR16G16B16A16Float:
462  case PixelFormat::kB10G10R10XR:
463  case PixelFormat::kB10G10R10XRSRGB:
464  case PixelFormat::kB10G10R10A10XR:
465  case PixelFormat::kR32Float:
466  case PixelFormat::kBC1RGBAUNormInt:
467  case PixelFormat::kBC1RGBAUNormIntSRGB:
468  case PixelFormat::kBC3RGBAUNormInt:
469  case PixelFormat::kBC3RGBAUNormIntSRGB:
470  case PixelFormat::kBC5RGUNormInt:
471  case PixelFormat::kBC7RGBAUNormInt:
472  case PixelFormat::kBC7RGBAUNormIntSRGB:
473  case PixelFormat::kETC2RGB8UNormInt:
474  case PixelFormat::kETC2RGB8UNormIntSRGB:
475  case PixelFormat::kETC2RGBA8UNormInt:
476  case PixelFormat::kETC2RGBA8UNormIntSRGB:
477  case PixelFormat::kASTC4x4LDR:
478  case PixelFormat::kASTC4x4LDRSRGB:
479  case PixelFormat::kASTC8x8LDR:
480  case PixelFormat::kASTC8x8LDRSRGB:
481  case PixelFormat::kASTC4x4HDR:
482  case PixelFormat::kASTC8x8HDR:
483  return false;
484  case PixelFormat::kS8UInt:
485  case PixelFormat::kD24UnormS8Uint:
486  case PixelFormat::kD32FloatS8UInt:
487  return true;
488  }
489  return false;
490 }
491 
492 static constexpr vk::AttachmentReference kUnusedAttachmentReference = {
493  VK_ATTACHMENT_UNUSED, vk::ImageLayout::eUndefined};
494 
495 constexpr vk::CullModeFlags ToVKCullModeFlags(CullMode mode) {
496  switch (mode) {
497  case CullMode::kNone:
498  return vk::CullModeFlagBits::eNone;
499  case CullMode::kFrontFace:
500  return vk::CullModeFlagBits::eFront;
501  case CullMode::kBackFace:
502  return vk::CullModeFlagBits::eBack;
503  }
504  FML_UNREACHABLE();
505 }
506 
507 constexpr vk::CompareOp ToVKCompareOp(CompareFunction op) {
508  switch (op) {
509  case CompareFunction::kNever:
510  return vk::CompareOp::eNever;
511  case CompareFunction::kAlways:
512  return vk::CompareOp::eAlways;
513  case CompareFunction::kLess:
514  return vk::CompareOp::eLess;
515  case CompareFunction::kEqual:
516  return vk::CompareOp::eEqual;
517  case CompareFunction::kLessEqual:
518  return vk::CompareOp::eLessOrEqual;
519  case CompareFunction::kGreater:
520  return vk::CompareOp::eGreater;
521  case CompareFunction::kNotEqual:
522  return vk::CompareOp::eNotEqual;
523  case CompareFunction::kGreaterEqual:
524  return vk::CompareOp::eGreaterOrEqual;
525  }
526  FML_UNREACHABLE();
527 }
528 
529 constexpr vk::StencilOp ToVKStencilOp(StencilOperation op) {
530  switch (op) {
531  case StencilOperation::kKeep:
532  return vk::StencilOp::eKeep;
533  case StencilOperation::kZero:
534  return vk::StencilOp::eZero;
535  case StencilOperation::kSetToReferenceValue:
536  return vk::StencilOp::eReplace;
537  case StencilOperation::kIncrementClamp:
538  return vk::StencilOp::eIncrementAndClamp;
539  case StencilOperation::kDecrementClamp:
540  return vk::StencilOp::eDecrementAndClamp;
541  case StencilOperation::kInvert:
542  return vk::StencilOp::eInvert;
543  case StencilOperation::kIncrementWrap:
544  return vk::StencilOp::eIncrementAndWrap;
545  case StencilOperation::kDecrementWrap:
546  return vk::StencilOp::eDecrementAndWrap;
547  break;
548  }
549  FML_UNREACHABLE();
550 }
551 
552 constexpr vk::StencilOpState ToVKStencilOpState(
553  const StencilAttachmentDescriptor& desc) {
554  vk::StencilOpState state;
555  state.failOp = ToVKStencilOp(desc.stencil_failure);
556  state.passOp = ToVKStencilOp(desc.depth_stencil_pass);
557  state.depthFailOp = ToVKStencilOp(desc.depth_failure);
558  state.compareOp = ToVKCompareOp(desc.stencil_compare);
559  state.compareMask = desc.read_mask;
560  state.writeMask = desc.write_mask;
561  // This is irrelevant as the stencil references are always dynamic state and
562  // will be set in the render pass.
563  state.reference = 1988;
564  return state;
565 }
566 
567 constexpr vk::ImageAspectFlags ToVKImageAspectFlags(PixelFormat format) {
568  switch (format) {
569  case PixelFormat::kUnknown:
570  case PixelFormat::kA8UNormInt:
571  case PixelFormat::kR8UNormInt:
572  case PixelFormat::kR8G8UNormInt:
573  case PixelFormat::kR8G8B8A8UNormInt:
574  case PixelFormat::kR8G8B8A8UNormIntSRGB:
575  case PixelFormat::kB8G8R8A8UNormInt:
576  case PixelFormat::kB8G8R8A8UNormIntSRGB:
577  case PixelFormat::kR32G32B32A32Float:
578  case PixelFormat::kR16G16B16A16Float:
579  case PixelFormat::kB10G10R10XR:
580  case PixelFormat::kB10G10R10XRSRGB:
581  case PixelFormat::kB10G10R10A10XR:
582  case PixelFormat::kR32Float:
583  case PixelFormat::kBC1RGBAUNormInt:
584  case PixelFormat::kBC1RGBAUNormIntSRGB:
585  case PixelFormat::kBC3RGBAUNormInt:
586  case PixelFormat::kBC3RGBAUNormIntSRGB:
587  case PixelFormat::kBC5RGUNormInt:
588  case PixelFormat::kBC7RGBAUNormInt:
589  case PixelFormat::kBC7RGBAUNormIntSRGB:
590  case PixelFormat::kETC2RGB8UNormInt:
591  case PixelFormat::kETC2RGB8UNormIntSRGB:
592  case PixelFormat::kETC2RGBA8UNormInt:
593  case PixelFormat::kETC2RGBA8UNormIntSRGB:
594  case PixelFormat::kASTC4x4LDR:
595  case PixelFormat::kASTC4x4LDRSRGB:
596  case PixelFormat::kASTC8x8LDR:
597  case PixelFormat::kASTC8x8LDRSRGB:
598  case PixelFormat::kASTC4x4HDR:
599  case PixelFormat::kASTC8x8HDR:
600  return vk::ImageAspectFlagBits::eColor;
601  case PixelFormat::kS8UInt:
602  return vk::ImageAspectFlagBits::eStencil;
603  case PixelFormat::kD24UnormS8Uint:
604  case PixelFormat::kD32FloatS8UInt:
605  return vk::ImageAspectFlagBits::eDepth |
606  vk::ImageAspectFlagBits::eStencil;
607  }
608  FML_UNREACHABLE();
609 }
610 
611 constexpr uint32_t ToArrayLayerCount(TextureType type) {
612  switch (type) {
613  case TextureType::kTexture2D:
614  case TextureType::kTexture2DMultisample:
615  return 1u;
616  case TextureType::kTextureCube:
617  return 6u;
618  case TextureType::kTextureExternalOES:
619  VALIDATION_LOG
620  << "kTextureExternalOES can not be used with the Vulkan backend.";
621  }
622  FML_UNREACHABLE();
623 }
624 
625 constexpr vk::ImageViewType ToVKImageViewType(TextureType type) {
626  switch (type) {
627  case TextureType::kTexture2D:
628  case TextureType::kTexture2DMultisample:
629  return vk::ImageViewType::e2D;
630  case TextureType::kTextureCube:
631  return vk::ImageViewType::eCube;
632  case TextureType::kTextureExternalOES:
633  VALIDATION_LOG
634  << "kTextureExternalOES can not be used with the Vulkan backend.";
635  }
636  FML_UNREACHABLE();
637 }
638 
639 constexpr vk::ImageCreateFlags ToVKImageCreateFlags(TextureType type) {
640  switch (type) {
641  case TextureType::kTexture2D:
642  case TextureType::kTexture2DMultisample:
643  return {};
644  case TextureType::kTextureCube:
645  return vk::ImageCreateFlagBits::eCubeCompatible;
646  case TextureType::kTextureExternalOES:
647  VALIDATION_LOG
648  << "kTextureExternalOES can not be used with the Vulkan backend.";
649  }
650  FML_UNREACHABLE();
651 }
652 
653 vk::PipelineDepthStencilStateCreateInfo ToVKPipelineDepthStencilStateCreateInfo(
654  std::optional<DepthAttachmentDescriptor> depth,
655  std::optional<StencilAttachmentDescriptor> front,
656  std::optional<StencilAttachmentDescriptor> back);
657 
658 constexpr vk::ImageAspectFlags ToImageAspectFlags(PixelFormat format) {
659  switch (format) {
660  case PixelFormat::kUnknown:
661  return {};
662  case PixelFormat::kA8UNormInt:
663  case PixelFormat::kR8UNormInt:
664  case PixelFormat::kR8G8UNormInt:
665  case PixelFormat::kR8G8B8A8UNormInt:
666  case PixelFormat::kR8G8B8A8UNormIntSRGB:
667  case PixelFormat::kB8G8R8A8UNormInt:
668  case PixelFormat::kB8G8R8A8UNormIntSRGB:
669  case PixelFormat::kR32G32B32A32Float:
670  case PixelFormat::kR16G16B16A16Float:
671  case PixelFormat::kB10G10R10XR:
672  case PixelFormat::kB10G10R10XRSRGB:
673  case PixelFormat::kB10G10R10A10XR:
674  case PixelFormat::kR32Float:
675  case PixelFormat::kBC1RGBAUNormInt:
676  case PixelFormat::kBC1RGBAUNormIntSRGB:
677  case PixelFormat::kBC3RGBAUNormInt:
678  case PixelFormat::kBC3RGBAUNormIntSRGB:
679  case PixelFormat::kBC5RGUNormInt:
680  case PixelFormat::kBC7RGBAUNormInt:
681  case PixelFormat::kBC7RGBAUNormIntSRGB:
682  case PixelFormat::kETC2RGB8UNormInt:
683  case PixelFormat::kETC2RGB8UNormIntSRGB:
684  case PixelFormat::kETC2RGBA8UNormInt:
685  case PixelFormat::kETC2RGBA8UNormIntSRGB:
686  case PixelFormat::kASTC4x4LDR:
687  case PixelFormat::kASTC4x4LDRSRGB:
688  case PixelFormat::kASTC8x8LDR:
689  case PixelFormat::kASTC8x8LDRSRGB:
690  case PixelFormat::kASTC4x4HDR:
691  case PixelFormat::kASTC8x8HDR:
692  return vk::ImageAspectFlagBits::eColor;
693  case PixelFormat::kS8UInt:
694  return vk::ImageAspectFlagBits::eStencil;
695  case PixelFormat::kD24UnormS8Uint:
696  case PixelFormat::kD32FloatS8UInt:
697  return vk::ImageAspectFlagBits::eDepth |
698  vk::ImageAspectFlagBits::eStencil;
699  }
700  FML_UNREACHABLE();
701 }
702 
703 } // namespace impeller
704 
705 #endif // FLUTTER_IMPELLER_RENDERER_BACKEND_VULKAN_FORMATS_VK_H_
e1
Vector3 e1
Definition: line_contents.cc:105
impeller::kUnusedAttachmentReference
static constexpr vk::AttachmentReference kUnusedAttachmentReference
Definition: formats_vk.h:492
impeller::BlendFactor
BlendFactor
Definition: formats.h:366
impeller::PrimitiveType
PrimitiveType
Decides how backend draws pixels based on input vertices.
Definition: formats.h:529
impeller::PrimitiveType::kPoint
@ kPoint
Draws a point at each input vertex.
impeller::ToVKSamplerAddressMode
constexpr vk::SamplerAddressMode ToVKSamplerAddressMode(SamplerAddressMode mode)
Definition: formats_vk.h:284
impeller::IndexType::kNone
@ kNone
Does not use the index buffer.
impeller::ToVKPipelineColorBlendAttachmentState
constexpr vk::PipelineColorBlendAttachmentState ToVKPipelineColorBlendAttachmentState(const ColorAttachmentDescriptor &desc)
Definition: formats_vk.h:113
impeller::ToPixelFormat
constexpr PixelFormat ToPixelFormat(vk::Format format)
Definition: formats_vk.h:219
impeller::ToVKCompareOp
constexpr vk::CompareOp ToVKCompareOp(CompareFunction op)
Definition: formats_vk.h:507
impeller::ToVKSamplerMipmapMode
constexpr vk::SamplerMipmapMode ToVKSamplerMipmapMode(MipFilter filter)
Definition: formats_vk.h:272
impeller::SamplerAddressMode
SamplerAddressMode
Definition: formats.h:618
impeller::SamplerAddressMode::kDecal
@ kDecal
decal sampling mode is only supported on devices that pass the Capabilities.SupportsDecalSamplerAddre...
impeller::StoreActionPerformsResolve
constexpr bool StoreActionPerformsResolve(StoreAction store_action)
Definition: formats_vk.h:379
impeller::ToVKIndexType
constexpr vk::IndexType ToVKIndexType(IndexType index_type)
Definition: formats_vk.h:391
impeller::ToVKDescriptorSetLayoutBinding
constexpr vk::DescriptorSetLayoutBinding ToVKDescriptorSetLayoutBinding(const DescriptorSetLayout &layout)
Definition: formats_vk.h:332
impeller::ToArrayLayerCount
constexpr uint32_t ToArrayLayerCount(TextureType type)
Definition: formats_vk.h:611
impeller::ToVKSamplerMinMagFilter
constexpr vk::Filter ToVKSamplerMinMagFilter(MinMagFilter filter)
Definition: formats_vk.h:261
impeller::ToImageAspectFlags
constexpr vk::ImageAspectFlags ToImageAspectFlags(PixelFormat format)
Definition: formats_vk.h:658
impeller::ToVKSampleCountFlagBits
constexpr vk::SampleCountFlagBits ToVKSampleCountFlagBits(SampleCount count)
Definition: formats_vk.h:32
impeller::ToVKShaderStageFlagBits
constexpr std::optional< vk::ShaderStageFlagBits > ToVKShaderStageFlagBits(ShaderStage stage)
Definition: formats_vk.h:131
impeller::ToVKAttachmentLoadOp
constexpr vk::AttachmentLoadOp ToVKAttachmentLoadOp(LoadAction load_action)
Definition: formats_vk.h:342
impeller::ToVKDescriptorType
constexpr vk::DescriptorType ToVKDescriptorType(DescriptorType type)
Definition: formats_vk.h:328
impeller::ToVKPolygonMode
constexpr vk::PolygonMode ToVKPolygonMode(PolygonMode mode)
Definition: formats_vk.h:406
impeller::PixelFormat
PixelFormat
The Pixel formats supported by Impeller. The naming convention denotes the usage of the component,...
Definition: formats.h:99
impeller::CompareFunction
CompareFunction
Definition: formats.h:804
impeller::CompareFunction::kEqual
@ kEqual
Comparison test passes if new_value == current_value.
impeller::CompareFunction::kLessEqual
@ kLessEqual
Comparison test passes if new_value <= current_value.
impeller::CompareFunction::kGreaterEqual
@ kGreaterEqual
Comparison test passes if new_value >= current_value.
impeller::CompareFunction::kAlways
@ kAlways
Comparison test passes always passes.
impeller::CompareFunction::kLess
@ kLess
Comparison test passes if new_value < current_value.
impeller::CompareFunction::kGreater
@ kGreater
Comparison test passes if new_value > current_value.
impeller::CompareFunction::kNotEqual
@ kNotEqual
Comparison test passes if new_value != current_value.
impeller::CompareFunction::kNever
@ kNever
Comparison test never passes.
impeller::ToVKAttachmentStoreOp
constexpr vk::AttachmentStoreOp ToVKAttachmentStoreOp(StoreAction store_action, bool is_resolve_texture)
Definition: formats_vk.h:355
impeller::ToVKCullModeFlags
constexpr vk::CullModeFlags ToVKCullModeFlags(CullMode mode)
Definition: formats_vk.h:495
impeller::MipFilter
MipFilter
Options for selecting and filtering between mipmap levels.
Definition: formats.h:602
impeller::MipFilter::kLinear
@ kLinear
Sample from the two nearest mip levels and linearly interpolate.
impeller::MipFilter::kBase
@ kBase
The texture is sampled as if it only had a single mipmap level.
impeller::MipFilter::kNearest
@ kNearest
The nearst mipmap level is selected.
impeller::ToVKColorComponentFlags
constexpr vk::ColorComponentFlags ToVKColorComponentFlags(ColorWriteMask type)
Definition: formats_vk.h:90
impeller::StencilOperation
StencilOperation
Definition: formats.h:823
impeller::StencilOperation::kDecrementWrap
@ kDecrementWrap
Decrement the current stencil value by 1. If at zero, set to maximum.
impeller::StencilOperation::kSetToReferenceValue
@ kSetToReferenceValue
Reset the stencil value to the reference value.
impeller::StencilOperation::kDecrementClamp
@ kDecrementClamp
Decrement the current stencil value by 1. Clamp it to zero.
impeller::StencilOperation::kZero
@ kZero
Reset the stencil value to zero.
impeller::StencilOperation::kIncrementClamp
@ kIncrementClamp
Increment the current stencil value by 1. Clamp it to the maximum.
impeller::StencilOperation::kIncrementWrap
@ kIncrementWrap
Increment the current stencil value by 1. If at maximum, set to zero.
impeller::StencilOperation::kInvert
@ kInvert
Perform a logical bitwise invert on the current stencil value.
impeller::StencilOperation::kKeep
@ kKeep
Don't modify the current stencil value.
impeller::ToVKBlendFactor
constexpr vk::BlendFactor ToVKBlendFactor(BlendFactor factor)
Definition: formats_vk.h:42
impeller::VkFormatToImpellerFormat
constexpr std::optional< PixelFormat > VkFormatToImpellerFormat(vk::Format format)
Definition: formats_vk.h:20
impeller::TextureType
TextureType
Definition: formats.h:450
impeller::PixelFormatIsDepthStencil
constexpr bool PixelFormatIsDepthStencil(PixelFormat format)
Definition: formats_vk.h:450
impeller::ToVKPipelineDepthStencilStateCreateInfo
vk::PipelineDepthStencilStateCreateInfo ToVKPipelineDepthStencilStateCreateInfo(std::optional< DepthAttachmentDescriptor > depth, std::optional< StencilAttachmentDescriptor > front, std::optional< StencilAttachmentDescriptor > back)
Definition: formats_vk.cc:9
impeller::PrimitiveTopologySupportsPrimitiveRestart
constexpr bool PrimitiveTopologySupportsPrimitiveRestart(PrimitiveType primitive)
Definition: formats_vk.h:416
impeller::ToVKImageViewType
constexpr vk::ImageViewType ToVKImageViewType(TextureType type)
Definition: formats_vk.h:625
impeller::LoadAction
LoadAction
Definition: formats.h:390
impeller::StoreAction
StoreAction
Definition: formats.h:396
impeller::ToVKSampleCount
constexpr vk::SampleCountFlagBits ToVKSampleCount(SampleCount sample_count)
Definition: formats_vk.h:250
impeller::ToVKImageFormat
constexpr vk::Format ToVKImageFormat(PixelFormat format)
Definition: formats_vk.h:146
impeller::ToVKStencilOpState
constexpr vk::StencilOpState ToVKStencilOpState(const StencilAttachmentDescriptor &desc)
Definition: formats_vk.h:552
impeller::ToVkShaderStage
constexpr vk::ShaderStageFlags ToVkShaderStage(ShaderStage stage)
Definition: formats_vk.h:300
impeller::ToVKPrimitiveTopology
constexpr vk::PrimitiveTopology ToVKPrimitiveTopology(PrimitiveType primitive)
Definition: formats_vk.h:431
impeller::PolygonMode
PolygonMode
Definition: formats.h:566
impeller::ToVKBlendOp
constexpr vk::BlendOp ToVKBlendOp(BlendOperation op)
Definition: formats_vk.h:78
impeller::ToVKStencilOp
constexpr vk::StencilOp ToVKStencilOp(StencilOperation op)
Definition: formats_vk.h:529
impeller::MinMagFilter
MinMagFilter
Describes how the texture should be sampled when the texture is being shrunk (minified) or expanded (...
Definition: formats.h:592
impeller::MinMagFilter::kNearest
@ kNearest
Select nearest to the sample point. Most widely supported.
impeller::ToVKImageCreateFlags
constexpr vk::ImageCreateFlags ToVKImageCreateFlags(TextureType type)
Definition: formats_vk.h:639
impeller::ToVKImageAspectFlags
constexpr vk::ImageAspectFlags ToVKImageAspectFlags(PixelFormat format)
Definition: formats_vk.h:567
impeller::BlendOperation
BlendOperation
Definition: formats.h:384
impeller::SampleCount
SampleCount
Definition: formats.h:483
shader_types.h
impeller::ColorAttachmentDescriptor
Describe the color attachment that will be used with this pipeline.
Definition: formats.h:770
impeller::StencilAttachmentDescriptor::depth_stencil_pass
StencilOperation depth_stencil_pass
Definition: formats.h:881
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:91