| Flutter Impeller |

sampler_vk.cc
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 #include "impeller/renderer/backend/vulkan/sampler_vk.h"
6
7 #include "impeller/renderer/backend/vulkan/context_vk.h"
8 #include "impeller/renderer/backend/vulkan/formats_vk.h"
9 #include "impeller/renderer/backend/vulkan/yuv_conversion_vk.h"
10 #include "vulkan/vulkan_core.h"
11
12 namespace impeller {
13
14 static vk::UniqueSampler CreateSampler(
15 const vk::Device& device,
16 const SamplerDescriptor& desc,
17 const std::shared_ptr<YUVConversionVK>& yuv_conversion) {
18 const auto min_filter = ToVKSamplerMinMagFilter(desc.min_filter);
19 const auto mag_filter = ToVKSamplerMinMagFilter(desc.mag_filter);
20
21 const auto address_mode_u = ToVKSamplerAddressMode(desc.width_address_mode);
22 const auto address_mode_v = ToVKSamplerAddressMode(desc.height_address_mode);
23 const auto address_mode_w = ToVKSamplerAddressMode(desc.depth_address_mode);
24
25 vk::StructureChain<vk::SamplerCreateInfo,
26 // For VK_KHR_sampler_ycbcr_conversion
27 vk::SamplerYcbcrConversionInfo>
28 sampler_chain;
29
30 auto& sampler_info = sampler_chain.get();
31
32 sampler_info.magFilter = mag_filter;
33 sampler_info.minFilter = min_filter;
34 sampler_info.addressModeU = address_mode_u;
35 sampler_info.addressModeV = address_mode_v;
36 sampler_info.addressModeW = address_mode_w;
37 sampler_info.borderColor = vk::BorderColor::eFloatTransparentBlack;
38 sampler_info.maxLod = VK_LOD_CLAMP_NONE;
39
40 // https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkSamplerCreateInfo.html#_description
41 switch (desc.mip_filter) {
42 case MipFilter::kBase:
43 sampler_info.mipmapMode = vk::SamplerMipmapMode::eNearest;
44 sampler_info.minLod = sampler_info.maxLod = 0.0f;
45 break;
46 case MipFilter::kNearest:
47 sampler_info.mipmapMode = vk::SamplerMipmapMode::eNearest;
48 break;
49 case MipFilter::kLinear:
50 sampler_info.mipmapMode = vk::SamplerMipmapMode::eLinear;
51 break;
52 }
53
54 if (yuv_conversion && yuv_conversion->IsValid()) {
55 sampler_chain.get<vk::SamplerYcbcrConversionInfo>().conversion =
56 yuv_conversion->GetConversion();
57
58 //
59 // TL;DR: When using YUV conversion, our samplers are somewhat hobbled and
60 // not all options configurable in Impeller (especially the linear
61 // filtering which is by far the most used form of filtering) can be
62 // supported. Switch to safe defaults.
63 //
64 // Spec: If sampler Y'CBCR conversion is enabled and the potential format
65 // features of the sampler Y'CBCR conversion do not support or enable
66 // separate reconstruction filters, minFilter and magFilter must be equal to
67 // the sampler Y'CBCR conversion's chromaFilter.
68 //
69 // Thing is, we don't enable separate reconstruction filters. By the time we
70 // are here, we also don't have access to the descriptor used to create this
71 // conversion. So we don't yet know what the chromaFilter is. But eNearest
72 // is a safe bet since the `AndroidHardwareBufferTextureSourceVK` defaults
73 // to that safe value. So just use that.
74 //
75 // See the validation VUID-VkSamplerCreateInfo-minFilter-01645 for more.
76 //
77 sampler_info.magFilter = vk::Filter::eNearest;
78 sampler_info.minFilter = vk::Filter::eNearest;
79
80 // Spec: If sampler Y′CBCR conversion is enabled, addressModeU,
81 // addressModeV, and addressModeW must be
82 // VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, anisotropyEnable must be VK_FALSE,
83 // and unnormalizedCoordinates must be VK_FALSE.
84 //
85 // See the validation VUID-VkSamplerCreateInfo-addressModeU-01646 for more.
86 //
87 sampler_info.addressModeU = vk::SamplerAddressMode::eClampToEdge;
88 sampler_info.addressModeV = vk::SamplerAddressMode::eClampToEdge;
89 sampler_info.addressModeW = vk::SamplerAddressMode::eClampToEdge;
90 sampler_info.anisotropyEnable = false;
91 sampler_info.unnormalizedCoordinates = false;
92 } else {
93 sampler_chain.unlink<vk::SamplerYcbcrConversionInfo>();
94 }
95
96 auto sampler = device.createSamplerUnique(sampler_chain.get());
97 if (sampler.result != vk::Result::eSuccess) {
98 VALIDATION_LOG << "Could not create sampler: "
99 << vk::to_string(sampler.result);
100 return {};
101 }
102
103 if (!desc.label.empty()) {
104 ContextVK::SetDebugName(device, sampler.value.get(), desc.label.c_str());
105 }
106
107 return std::move(sampler.value);
108 }
109
110 SamplerVK::SamplerVK(const vk::Device& device,
111 SamplerDescriptor desc,
112 std::shared_ptr<YUVConversionVK> yuv_conversion)
113 : Sampler(std::move(desc)),
114 device_(device),
115 sampler_(MakeSharedVK<vk::Sampler>(
116 CreateSampler(device, desc_, yuv_conversion))),
117 yuv_conversion_(std::move(yuv_conversion)) {
118 is_valid_ = sampler_ && !!sampler_->Get();
119 }
120
121 SamplerVK::~SamplerVK() = default;
122
123 vk::Sampler SamplerVK::GetSampler() const {
124 return *sampler_;
125 }
126
127 std::shared_ptr<SamplerVK> SamplerVK::CreateVariantForConversion(
128 std::shared_ptr<YUVConversionVK> conversion) const {
129 if (!conversion || !is_valid_) {
130 return nullptr;
131 }
132 return std::make_shared<SamplerVK>(device_, desc_, std::move(conversion));
133 }
134
135 const std::shared_ptr<YUVConversionVK>& SamplerVK::GetYUVConversion() const {
136 return yuv_conversion_;
137 }
138
139 } // namespace impeller
impeller::SamplerVK::SamplerVK
SamplerVK(const vk::Device &device, SamplerDescriptor desc, std::shared_ptr< YUVConversionVK > yuv_conversion={})
Definition: sampler_vk.cc:110
impeller::SamplerVK::GetYUVConversion
const std::shared_ptr< YUVConversionVK > & GetYUVConversion() const
Definition: sampler_vk.cc:135
impeller::ToVKSamplerAddressMode
constexpr vk::SamplerAddressMode ToVKSamplerAddressMode(SamplerAddressMode mode)
Definition: formats_vk.h:235
impeller::CreateSampler
static vk::UniqueSampler CreateSampler(const vk::Device &device, const SamplerDescriptor &desc, const std::shared_ptr< YUVConversionVK > &yuv_conversion)
Definition: sampler_vk.cc:14
impeller::SamplerVK::CreateVariantForConversion
std::shared_ptr< SamplerVK > CreateVariantForConversion(std::shared_ptr< YUVConversionVK > conversion) const
Definition: sampler_vk.cc:127
formats_vk.h
impeller::SamplerDescriptor::mag_filter
MinMagFilter mag_filter
Definition: sampler_descriptor.h:17
impeller::SamplerDescriptor
Definition: sampler_descriptor.h:15
impeller::MipFilter::kNearest
@ kNearest
The nearst mipmap level is selected.
impeller::Sampler
Definition: sampler.h:15
impeller::SamplerDescriptor::min_filter
MinMagFilter min_filter
Definition: sampler_descriptor.h:16
impeller::SamplerDescriptor::width_address_mode
SamplerAddressMode width_address_mode
Definition: sampler_descriptor.h:20
impeller::SamplerDescriptor::depth_address_mode
SamplerAddressMode depth_address_mode
Definition: sampler_descriptor.h:22
impeller::SamplerVK::GetSampler
vk::Sampler GetSampler() const
Definition: sampler_vk.cc:123
impeller::ContextVK::SetDebugName
bool SetDebugName(T handle, std::string_view label) const
Definition: context_vk.h:108
impeller::SamplerDescriptor::mip_filter
MipFilter mip_filter
Definition: sampler_descriptor.h:18
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:73
impeller::MakeSharedVK
auto MakeSharedVK(vk::UniqueHandle< T, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE > handle)
Definition: shared_object_vk.h:44
impeller::ToVKSamplerMinMagFilter
constexpr vk::Filter ToVKSamplerMinMagFilter(MinMagFilter filter)
Definition: formats_vk.h:212
yuv_conversion_vk.h
impeller::MipFilter::kBase
@ kBase
The texture is sampled as if it only had a single mipmap level.
std
Definition: comparable.h:95
impeller::MipFilter::kLinear
@ kLinear
Sample from the two nearest mip levels and linearly interpolate.
impeller::SamplerDescriptor::label
std::string label
Definition: sampler_descriptor.h:24
sampler_vk.h
context_vk.h
impeller::SamplerVK::~SamplerVK
~SamplerVK() override
impeller::SamplerDescriptor::height_address_mode
SamplerAddressMode height_address_mode
Definition: sampler_descriptor.h:21
impeller
Definition: aiks_blend_unittests.cc:18
impeller::Sampler::desc_
SamplerDescriptor desc_
Definition: sampler.h:22