Flutter Impeller
capabilities_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_CAPABILITIES_VK_H_
6 #define FLUTTER_IMPELLER_RENDERER_BACKEND_VULKAN_CAPABILITIES_VK_H_
7 
8 #include <cstdint>
9 #include <map>
10 #include <optional>
11 #include <set>
12 #include <string>
13 #include <vector>
14 
20 
21 namespace impeller {
22 
23 class ContextVK;
24 
25 //------------------------------------------------------------------------------
26 /// @brief A device extension available on all platforms. Without the
27 /// presence of these extensions, context creation will fail.
28 ///
29 enum class RequiredCommonDeviceExtensionVK : uint32_t {
30  //----------------------------------------------------------------------------
31  /// For displaying content in the window system.
32  ///
33  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_swapchain.html
34  ///
36 
37  kLast,
38 };
39 
40 //------------------------------------------------------------------------------
41 /// @brief A device extension available on all Android platforms. Without
42 /// the presence of these extensions on Android, context creation
43 /// will fail.
44 ///
45 /// Platform agnostic code can still check if these Android
46 /// extensions are present.
47 ///
48 enum class RequiredAndroidDeviceExtensionVK : uint32_t {
49  //----------------------------------------------------------------------------
50  /// For importing hardware buffers used in external texture composition.
51  ///
52  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_ANDROID_external_memory_android_hardware_buffer.html
53  ///
55 
56  //----------------------------------------------------------------------------
57  /// Dependency of kANDROIDExternalMemoryAndroidHardwareBuffer.
58  ///
59  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_sampler_ycbcr_conversion.html
60  ///
62 
63  //----------------------------------------------------------------------------
64  /// Dependency of kANDROIDExternalMemoryAndroidHardwareBuffer.
65  ///
66  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_external_memory.html
67  ///
69 
70  //----------------------------------------------------------------------------
71  /// Dependency of kANDROIDExternalMemoryAndroidHardwareBuffer.
72  ///
73  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_queue_family_foreign.html
74  ///
76 
77  //----------------------------------------------------------------------------
78  /// Dependency of kANDROIDExternalMemoryAndroidHardwareBuffer.
79  ///
80  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_dedicated_allocation.html
81  ///
83 
84  kLast,
85 };
86 
87 //------------------------------------------------------------------------------
88 /// @brief A device extension available on some Android platforms.
89 ///
90 /// Platform agnostic code can still check if these Android
91 /// extensions are present.
92 ///
93 enum class OptionalAndroidDeviceExtensionVK : uint32_t {
94  //----------------------------------------------------------------------------
95  /// For exporting file descriptors from fences to interact with platform APIs.
96  ///
97  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_external_fence_fd.html
98  ///
100 
101  //----------------------------------------------------------------------------
102  /// Dependency of kKHRExternalFenceFd.
103  ///
104  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_external_fence.html
105  ///
107 
108  //----------------------------------------------------------------------------
109  /// For importing sync file descriptors as semaphores so the GPU can wait for
110  /// semaphore to be signaled.
111  ///
112  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_external_semaphore_fd.html
114 
115  //----------------------------------------------------------------------------
116  /// Dependency of kKHRExternalSemaphoreFd
117  ///
118  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_external_semaphore.html
120 
121  kLast,
122 };
123 
124 //------------------------------------------------------------------------------
125 /// @brief A device extension enabled if available. Subsystems cannot
126 /// assume availability and must check if these extensions are
127 /// available.
128 ///
129 /// @see `CapabilitiesVK::HasExtension`.
130 ///
131 enum class OptionalDeviceExtensionVK : uint32_t {
132  //----------------------------------------------------------------------------
133  /// To instrument and profile PSO creation.
134  ///
135  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_pipeline_creation_feedback.html
136  ///
138 
139  //----------------------------------------------------------------------------
140  /// To enable context creation on MoltenVK. A non-conformant Vulkan
141  /// implementation.
142  ///
143  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_portability_subset.html
144  ///
146 
147  //----------------------------------------------------------------------------
148  /// For fixed-rate compression of images.
149  ///
150  /// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_compression_control.html
151  ///
153 
154  kLast,
155 };
156 
157 //------------------------------------------------------------------------------
158 /// @brief A pixel format and usage that is sufficient to check if images
159 /// of that format and usage are suitable for use with fixed-rate
160 /// compression.
161 ///
163  vk::Format format = vk::Format::eUndefined;
164  vk::ImageType type = {};
165  vk::ImageTiling tiling = {};
166  vk::ImageUsageFlags usage = {};
167  vk::ImageCreateFlags flags = {};
168 
169  explicit FRCFormatDescriptor(const vk::ImageCreateInfo& image_info)
170  : format(image_info.format),
171  type(image_info.imageType),
172  tiling(image_info.tiling),
173  usage(image_info.usage),
174  flags(image_info.flags) {}
175 };
176 
177 //------------------------------------------------------------------------------
178 /// @brief The Vulkan layers and extensions wrangler.
179 ///
180 class CapabilitiesVK final : public Capabilities,
181  public BackendCast<CapabilitiesVK, Capabilities> {
182  public:
183  explicit CapabilitiesVK(bool enable_validations,
184  bool fatal_missing_validations = false,
185  bool use_embedder_extensions = false,
186  std::vector<std::string> instance_extensions = {},
187  std::vector<std::string> device_extensions = {});
188 
190 
191  bool IsValid() const;
192 
193  bool AreValidationsEnabled() const;
194 
196 
198 
199  bool HasExtension(OptionalDeviceExtensionVK ext) const;
200 
202 
203  std::optional<std::vector<std::string>> GetEnabledLayers() const;
204 
205  std::optional<std::vector<std::string>> GetEnabledInstanceExtensions() const;
206 
207  std::optional<std::vector<std::string>> GetEnabledDeviceExtensions(
208  const vk::PhysicalDevice& physical_device) const;
209 
211  vk::StructureChain<vk::PhysicalDeviceFeatures2,
212  vk::PhysicalDeviceSamplerYcbcrConversionFeaturesKHR,
213  vk::PhysicalDevice16BitStorageFeatures,
214  vk::PhysicalDeviceImageCompressionControlFeaturesEXT>;
215 
216  std::optional<PhysicalDeviceFeatures> GetEnabledDeviceFeatures(
217  const vk::PhysicalDevice& physical_device) const;
218 
219  [[nodiscard]] bool SetPhysicalDevice(
220  const vk::PhysicalDevice& physical_device,
221  const PhysicalDeviceFeatures& enabled_features);
222 
223  const vk::PhysicalDeviceProperties& GetPhysicalDeviceProperties() const;
224 
225  void SetOffscreenFormat(PixelFormat pixel_format) const;
226 
227  // |Capabilities|
228  bool SupportsOffscreenMSAA() const override;
229 
230  // |Capabilities|
231  bool SupportsImplicitResolvingMSAA() const override;
232 
233  // |Capabilities|
234  bool SupportsSSBO() const override;
235 
236  // |Capabilities|
237  bool SupportsTextureToTextureBlits() const override;
238 
239  // |Capabilities|
240  bool SupportsFramebufferFetch() const override;
241 
242  // |Capabilities|
243  bool SupportsCompute() const override;
244 
245  // |Capabilities|
246  bool SupportsComputeSubgroups() const override;
247 
248  // |Capabilities|
249  bool SupportsReadFromResolve() const override;
250 
251  // |Capabilities|
252  bool SupportsDecalSamplerAddressMode() const override;
253 
254  // |Capabilities|
255  bool SupportsDeviceTransientTextures() const override;
256 
257  // |Capabilities|
258  bool SupportsTriangleFan() const override;
259 
260  // |Capabilities|
261  bool SupportsPrimitiveRestart() const override;
262 
263  // |Capabilities|
264  bool SupportsExtendedRangeFormats() const override;
265 
266  // |Capabilities|
267  PixelFormat GetDefaultColorFormat() const override;
268 
269  // |Capabilities|
270  PixelFormat GetDefaultStencilFormat() const override;
271 
272  // |Capabilities|
273  PixelFormat GetDefaultDepthStencilFormat() const override;
274 
275  // |Capabilities|
276  PixelFormat GetDefaultGlyphAtlasFormat() const override;
277 
278  // |Capabilities|
279  ISize GetMaximumRenderPassAttachmentSize() const override;
280 
281  // |Capabilities|
282  size_t GetMinimumUniformAlignment() const override;
283 
284  //----------------------------------------------------------------------------
285  /// @return If fixed-rate compression for non-onscreen surfaces is
286  /// supported.
287  ///
289 
290  /// Whether the external fence and semaphore extensions used for AHB support
291  /// are available.
293 
294  //----------------------------------------------------------------------------
295  /// @brief Get the fixed compression rate supported by the context for
296  /// the given format and usage.
297  ///
298  /// @param[in] compression_type The compression type.
299  /// @param[in] desc The format and usage of the image.
300  ///
301  /// @return The supported fixed compression rate.
302  ///
303  std::optional<vk::ImageCompressionFixedRateFlagBitsEXT> GetSupportedFRCRate(
304  CompressionType compression_type,
305  const FRCFormatDescriptor& desc) const;
306 
307  //----------------------------------------------------------------------------
308  /// @brief Update capabilities for the given set of workarounds.
309  void ApplyWorkarounds(const WorkaroundsVK& workarounds);
310 
311  private:
312  bool validations_enabled_ = false;
313  std::map<std::string, std::set<std::string>> exts_;
314  std::set<RequiredCommonDeviceExtensionVK> required_common_device_extensions_;
315  std::set<RequiredAndroidDeviceExtensionVK>
316  required_android_device_extensions_;
317  std::set<OptionalAndroidDeviceExtensionVK>
318  optional_android_device_extensions_;
319  std::set<OptionalDeviceExtensionVK> optional_device_extensions_;
320  mutable PixelFormat default_color_format_ = PixelFormat::kUnknown;
321  PixelFormat default_stencil_format_ = PixelFormat::kUnknown;
322  PixelFormat default_depth_stencil_format_ = PixelFormat::kUnknown;
323  vk::PhysicalDevice physical_device_;
324  vk::PhysicalDeviceProperties device_properties_;
325  size_t minimum_uniform_alignment_ = 256;
326  bool supports_compute_subgroups_ = false;
327  bool supports_device_transient_textures_ = false;
328  bool supports_texture_fixed_rate_compression_ = false;
329  ISize max_render_pass_attachment_size_ = ISize{0, 0};
330  bool has_triangle_fans_ = true;
331  bool has_primitive_restart_ = true;
332  bool has_framebuffer_fetch_ = true;
333  bool supports_external_fence_and_semaphore_ = false;
334  bool is_valid_ = false;
335 
336  // The embedder.h API is responsible for providing the instance and device
337  // extensions.
338  bool use_embedder_extensions_ = false;
339  std::vector<std::string> embedder_instance_extensions_;
340  std::vector<std::string> embedder_device_extensions_;
341 
342  bool HasExtension(const std::string& ext) const;
343 
344  bool HasLayer(const std::string& layer) const;
345 
346  CapabilitiesVK(const CapabilitiesVK&) = delete;
347 
348  CapabilitiesVK& operator=(const CapabilitiesVK&) = delete;
349 };
350 
351 } // namespace impeller
352 
353 #endif // FLUTTER_IMPELLER_RENDERER_BACKEND_VULKAN_CAPABILITIES_VK_H_
The Vulkan layers and extensions wrangler.
bool SupportsTriangleFan() const override
Whether the primitive type TriangleFan is supported by the backend.
size_t GetMinimumUniformAlignment() const override
The minimum alignment of uniform value offsets in bytes.
bool SupportsDeviceTransientTextures() const override
Whether the context backend supports allocating StorageMode::kDeviceTransient (aka "memoryless") text...
std::optional< std::vector< std::string > > GetEnabledInstanceExtensions() const
bool AreValidationsEnabled() const
bool SetPhysicalDevice(const vk::PhysicalDevice &physical_device, const PhysicalDeviceFeatures &enabled_features)
ISize GetMaximumRenderPassAttachmentSize() const override
Return the maximum size of a render pass attachment.
bool SupportsSSBO() const override
Whether the context backend supports binding Shader Storage Buffer Objects (SSBOs) to pipelines.
bool SupportsFramebufferFetch() const override
Whether the context backend is able to support pipelines with shaders that read from the framebuffer ...
bool SupportsExternalSemaphoreExtensions() const
CapabilitiesVK(bool enable_validations, bool fatal_missing_validations=false, bool use_embedder_extensions=false, std::vector< std::string > instance_extensions={}, std::vector< std::string > device_extensions={})
bool SupportsOffscreenMSAA() const override
Whether the context backend supports attaching offscreen MSAA color/stencil textures.
bool SupportsCompute() const override
Whether the context backend supports ComputePass.
bool HasExtension(RequiredCommonDeviceExtensionVK ext) const
std::optional< vk::ImageCompressionFixedRateFlagBitsEXT > GetSupportedFRCRate(CompressionType compression_type, const FRCFormatDescriptor &desc) const
Get the fixed compression rate supported by the context for the given format and usage.
void SetOffscreenFormat(PixelFormat pixel_format) const
PixelFormat GetDefaultStencilFormat() const override
Returns a supported PixelFormat for textures that store stencil information. May include a depth chan...
void ApplyWorkarounds(const WorkaroundsVK &workarounds)
Update capabilities for the given set of workarounds.
vk::StructureChain< vk::PhysicalDeviceFeatures2, vk::PhysicalDeviceSamplerYcbcrConversionFeaturesKHR, vk::PhysicalDevice16BitStorageFeatures, vk::PhysicalDeviceImageCompressionControlFeaturesEXT > PhysicalDeviceFeatures
bool SupportsComputeSubgroups() const override
Whether the context backend supports configuring ComputePass command subgroups.
PixelFormat GetDefaultDepthStencilFormat() const override
Returns a supported PixelFormat for textures that store both a stencil and depth component....
bool SupportsTextureToTextureBlits() const override
Whether the context backend supports blitting from one texture region to another texture region (via ...
std::optional< std::vector< std::string > > GetEnabledDeviceExtensions(const vk::PhysicalDevice &physical_device) const
bool SupportsReadFromResolve() const override
Whether the context backend supports binding the current RenderPass attachments. This is supported if...
bool SupportsDecalSamplerAddressMode() const override
Whether the context backend supports SamplerAddressMode::Decal.
bool SupportsPrimitiveRestart() const override
Whether primitive restart is supported.
std::optional< std::vector< std::string > > GetEnabledLayers() const
bool SupportsTextureFixedRateCompression() const
PixelFormat GetDefaultGlyphAtlasFormat() const override
Returns the default pixel format for the alpha bitmap glyph atlas.
PixelFormat GetDefaultColorFormat() const override
Returns a supported PixelFormat for textures that store 4-channel colors (red/green/blue/alpha).
const vk::PhysicalDeviceProperties & GetPhysicalDeviceProperties() const
bool SupportsExtendedRangeFormats() const override
Whether the XR formats are supported on this device.
bool SupportsImplicitResolvingMSAA() const override
Whether the context backend supports multisampled rendering to the on-screen surface without requirin...
std::optional< PhysicalDeviceFeatures > GetEnabledDeviceFeatures(const vk::PhysicalDevice &physical_device) const
RequiredAndroidDeviceExtensionVK
A device extension available on all Android platforms. Without the presence of these extensions on An...
PixelFormat
The Pixel formats supported by Impeller. The naming convention denotes the usage of the component,...
Definition: formats.h:99
RequiredCommonDeviceExtensionVK
A device extension available on all platforms. Without the presence of these extensions,...
OptionalAndroidDeviceExtensionVK
A device extension available on some Android platforms.
CompressionType
Additional compression to apply to a texture. This value is ignored on platforms which do not support...
OptionalDeviceExtensionVK
A device extension enabled if available. Subsystems cannot assume availability and must check if thes...
A pixel format and usage that is sufficient to check if images of that format and usage are suitable ...
vk::ImageCreateFlags flags
FRCFormatDescriptor(const vk::ImageCreateInfo &image_info)
A non-exhaustive set of driver specific workarounds.