1 /*
2 * Copyright 2016 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7 
8 #include "src/gpu/vk/GrVkSampler.h"
9 
10 #include "src/gpu/vk/GrVkGpu.h"
11 #include "src/gpu/vk/GrVkSamplerYcbcrConversion.h"
12 
wrap_mode_to_vk_sampler_address(GrSamplerState::WrapMode wrapMode)13 static inline VkSamplerAddressMode wrap_mode_to_vk_sampler_address(
14         GrSamplerState::WrapMode wrapMode) {
15     switch (wrapMode) {
16         case GrSamplerState::WrapMode::kClamp:
17             return VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
18         case GrSamplerState::WrapMode::kRepeat:
19             return VK_SAMPLER_ADDRESS_MODE_REPEAT;
20         case GrSamplerState::WrapMode::kMirrorRepeat:
21             return VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT;
22         case GrSamplerState::WrapMode::kClampToBorder:
23             return VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER;
24     }
25     SK_ABORT("Unknown wrap mode.");
26 }
27 
Create(GrVkGpu * gpu,const GrSamplerState & samplerState,const GrVkYcbcrConversionInfo & ycbcrInfo)28 GrVkSampler* GrVkSampler::Create(GrVkGpu* gpu, const GrSamplerState& samplerState,
29                                  const GrVkYcbcrConversionInfo& ycbcrInfo) {
30     static VkFilter vkMinFilterModes[] = {
31         VK_FILTER_NEAREST,
32         VK_FILTER_LINEAR,
33         VK_FILTER_LINEAR
34     };
35     static VkFilter vkMagFilterModes[] = {
36         VK_FILTER_NEAREST,
37         VK_FILTER_LINEAR,
38         VK_FILTER_LINEAR
39     };
40 
41     VkSamplerCreateInfo createInfo;
42     memset(&createInfo, 0, sizeof(VkSamplerCreateInfo));
43     createInfo.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
44     createInfo.pNext = nullptr;
45     createInfo.flags = 0;
46     createInfo.magFilter = vkMagFilterModes[static_cast<int>(samplerState.filter())];
47     createInfo.minFilter = vkMinFilterModes[static_cast<int>(samplerState.filter())];
48     createInfo.mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR;
49     createInfo.addressModeU = wrap_mode_to_vk_sampler_address(samplerState.wrapModeX());
50     createInfo.addressModeV = wrap_mode_to_vk_sampler_address(samplerState.wrapModeY());
51     createInfo.addressModeW = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE; // Shouldn't matter
52     createInfo.mipLodBias = 0.0f;
53     createInfo.anisotropyEnable = VK_FALSE;
54     createInfo.maxAnisotropy = 1.0f;
55     createInfo.compareEnable = VK_FALSE;
56     createInfo.compareOp = VK_COMPARE_OP_NEVER;
57     // Vulkan doesn't have a direct mapping of GL's nearest or linear filters for minFilter since
58     // there is always a mipmapMode. To get the same effect as GL we can set minLod = maxLod = 0.0.
59     // This works since our min and mag filters are the same (this forces us to use mag on the 0
60     // level mip). If the filters weren't the same we could set min = 0 and max = 0.25 to force
61     // the minFilter on mip level 0.
62     createInfo.minLod = 0.0f;
63     bool useMipMaps = GrSamplerState::Filter::kMipMap == samplerState.filter();
64     createInfo.maxLod = !useMipMaps ? 0.0f : 10000.0f;
65     createInfo.borderColor = VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK;
66     createInfo.unnormalizedCoordinates = VK_FALSE;
67 
68     VkSamplerYcbcrConversionInfo conversionInfo;
69     GrVkSamplerYcbcrConversion* ycbcrConversion = nullptr;
70     if (ycbcrInfo.isValid()) {
71         SkASSERT(gpu->vkCaps().supportsYcbcrConversion());
72 
73         ycbcrConversion =
74                 gpu->resourceProvider().findOrCreateCompatibleSamplerYcbcrConversion(ycbcrInfo);
75         if (!ycbcrConversion) {
76             return nullptr;
77         }
78 
79         conversionInfo.sType = VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_INFO;
80         conversionInfo.pNext = nullptr;
81         conversionInfo.conversion = ycbcrConversion->ycbcrConversion();
82 
83         createInfo.pNext = &conversionInfo;
84 
85         VkFormatFeatureFlags flags = ycbcrInfo.fFormatFeatures;
86         if (!SkToBool(flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT)) {
87             createInfo.magFilter = VK_FILTER_NEAREST;
88             createInfo.minFilter = VK_FILTER_NEAREST;
89         } else if (
90                 !(flags &
91                   VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT)) {
92             createInfo.magFilter = ycbcrInfo.fChromaFilter;
93             createInfo.minFilter = ycbcrInfo.fChromaFilter;
94         }
95 
96         // Required values when using ycbcr conversion
97         createInfo.addressModeU = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
98         createInfo.addressModeV = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
99         createInfo.addressModeW = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
100         createInfo.anisotropyEnable = VK_FALSE;
101         createInfo.unnormalizedCoordinates = VK_FALSE;
102     }
103 
104     VkSampler sampler;
105     GR_VK_CALL_ERRCHECK(gpu->vkInterface(), CreateSampler(gpu->device(),
106                                                           &createInfo,
107                                                           nullptr,
108                                                           &sampler));
109 
110     return new GrVkSampler(sampler, ycbcrConversion, GenerateKey(samplerState, ycbcrInfo));
111 }
112 
freeGPUData(GrVkGpu * gpu) const113 void GrVkSampler::freeGPUData(GrVkGpu* gpu) const {
114     SkASSERT(fSampler);
115     GR_VK_CALL(gpu->vkInterface(), DestroySampler(gpu->device(), fSampler, nullptr));
116     if (fYcbcrConversion) {
117         fYcbcrConversion->unref(gpu);
118     }
119 }
120 
abandonGPUData() const121 void GrVkSampler::abandonGPUData() const {
122     if (fYcbcrConversion) {
123         fYcbcrConversion->unrefAndAbandon();
124     }
125 }
126 
GenerateKey(const GrSamplerState & samplerState,const GrVkYcbcrConversionInfo & ycbcrInfo)127 GrVkSampler::Key GrVkSampler::GenerateKey(const GrSamplerState& samplerState,
128                                           const GrVkYcbcrConversionInfo& ycbcrInfo) {
129     return { GrSamplerState::GenerateKey(samplerState),
130              GrVkSamplerYcbcrConversion::GenerateKey(ycbcrInfo) };
131 }
132 
133