1 // Copyright 2018 The SwiftShader Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #ifndef VK_SAMPLER_HPP_
16 #define VK_SAMPLER_HPP_
17
18 #include "VkImageView.hpp" // For ResolveIdentityMapping()
19 #include "Device/Config.hpp"
20 #include "Device/Memset.hpp"
21 #include "System/Math.hpp"
22
23 #include <atomic>
24
25 namespace vk {
26
27 struct SamplerState : sw::Memset<SamplerState>
28 {
29 SamplerState(const VkSamplerCreateInfo *pCreateInfo, const vk::SamplerYcbcrConversion *ycbcrConversion,
30 const VkClearColorValue &customBorderColor);
31
32 // Prevents accessing mipmap levels out of range.
ClampLodvk::SamplerState33 static float ClampLod(float lod)
34 {
35 return sw::clamp(lod, 0.0f, (float)(sw::MAX_TEXTURE_LOD));
36 }
37
38 const VkFilter magFilter = VK_FILTER_NEAREST;
39 const VkFilter minFilter = VK_FILTER_NEAREST;
40 const VkSamplerMipmapMode mipmapMode = VK_SAMPLER_MIPMAP_MODE_NEAREST;
41 const VkSamplerAddressMode addressModeU = VK_SAMPLER_ADDRESS_MODE_REPEAT;
42 const VkSamplerAddressMode addressModeV = VK_SAMPLER_ADDRESS_MODE_REPEAT;
43 const VkSamplerAddressMode addressModeW = VK_SAMPLER_ADDRESS_MODE_REPEAT;
44 const float mipLodBias = 0.0f;
45 const VkBool32 anisotropyEnable = VK_FALSE;
46 const float maxAnisotropy = 0.0f;
47 const VkBool32 compareEnable = VK_FALSE;
48 const VkCompareOp compareOp = VK_COMPARE_OP_NEVER;
49 const float minLod = 0.0f;
50 const float maxLod = 0.0f;
51 const VkBorderColor borderColor = VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK;
52 const VkClearColorValue customBorderColor = {};
53 const VkBool32 unnormalizedCoordinates = VK_FALSE;
54
55 VkSamplerYcbcrModelConversion ycbcrModel = VK_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY;
56 const bool highPrecisionFiltering = false;
57 bool studioSwing = false; // Narrow range
58 bool swappedChroma = false; // Cb/Cr components in reverse order
59 VkFilter chromaFilter = VK_FILTER_NEAREST;
60 VkChromaLocation chromaXOffset = VK_CHROMA_LOCATION_COSITED_EVEN;
61 VkChromaLocation chromaYOffset = VK_CHROMA_LOCATION_COSITED_EVEN;
62 };
63
64 class Sampler : public Object<Sampler, VkSampler>, public SamplerState
65 {
66 public:
67 Sampler(const VkSamplerCreateInfo *pCreateInfo, void *mem, const SamplerState &samplerState, uint32_t samplerID);
68
ComputeRequiredAllocationSize(const VkSamplerCreateInfo * pCreateInfo)69 static size_t ComputeRequiredAllocationSize(const VkSamplerCreateInfo *pCreateInfo)
70 {
71 return 0;
72 }
73
74 const uint32_t id = 0;
75 };
76
77 class SamplerYcbcrConversion : public Object<SamplerYcbcrConversion, VkSamplerYcbcrConversion>
78 {
79 public:
SamplerYcbcrConversion(const VkSamplerYcbcrConversionCreateInfo * pCreateInfo,void * mem)80 SamplerYcbcrConversion(const VkSamplerYcbcrConversionCreateInfo *pCreateInfo, void *mem)
81 : format(pCreateInfo->format)
82 , ycbcrModel(pCreateInfo->ycbcrModel)
83 , ycbcrRange(pCreateInfo->ycbcrRange)
84 , components(ResolveIdentityMapping(pCreateInfo->components))
85 , xChromaOffset(pCreateInfo->xChromaOffset)
86 , yChromaOffset(pCreateInfo->yChromaOffset)
87 , chromaFilter(pCreateInfo->chromaFilter)
88 , forceExplicitReconstruction(pCreateInfo->forceExplicitReconstruction)
89 {
90 }
91
92 ~SamplerYcbcrConversion() = default;
93
ComputeRequiredAllocationSize(const VkSamplerYcbcrConversionCreateInfo * pCreateInfo)94 static size_t ComputeRequiredAllocationSize(const VkSamplerYcbcrConversionCreateInfo *pCreateInfo)
95 {
96 return 0;
97 }
98
99 const VkFormat format = VK_FORMAT_UNDEFINED;
100 const VkSamplerYcbcrModelConversion ycbcrModel = VK_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY;
101 const VkSamplerYcbcrRange ycbcrRange = VK_SAMPLER_YCBCR_RANGE_ITU_FULL;
102 const VkComponentMapping components = { VK_COMPONENT_SWIZZLE_R, VK_COMPONENT_SWIZZLE_G, VK_COMPONENT_SWIZZLE_B, VK_COMPONENT_SWIZZLE_A };
103 const VkChromaLocation xChromaOffset = VK_CHROMA_LOCATION_COSITED_EVEN;
104 const VkChromaLocation yChromaOffset = VK_CHROMA_LOCATION_COSITED_EVEN;
105 const VkFilter chromaFilter = VK_FILTER_NEAREST;
106 const VkBool32 forceExplicitReconstruction = VK_FALSE;
107 };
108
Cast(VkSampler object)109 static inline Sampler *Cast(VkSampler object)
110 {
111 return Sampler::Cast(object);
112 }
113
Cast(VkSamplerYcbcrConversion object)114 static inline SamplerYcbcrConversion *Cast(VkSamplerYcbcrConversion object)
115 {
116 return SamplerYcbcrConversion::Cast(object);
117 }
118
119 } // namespace vk
120
121 #endif // VK_SAMPLER_HPP_
122