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_IMAGE_VIEW_HPP_
16 #define VK_IMAGE_VIEW_HPP_
17
18 #include "VkFormat.hpp"
19 #include "VkImage.hpp"
20 #include "VkObject.hpp"
21
22 #include "System/Debug.hpp"
23
24 #include <atomic>
25
26 namespace vk {
27
28 class SamplerYcbcrConversion;
29
30 // Uniquely identifies state used by sampling routine generation.
31 // Integer ID space shared by image views and buffer views.
32 union Identifier
33 {
34 // Image view identifier
35 Identifier(const VkImageViewCreateInfo *pCreateInfo);
36
37 // Buffer view identifier
38 Identifier(VkFormat format);
39
40 // Copy constructor from existing identifier
Identifier(uint32_t fromId)41 Identifier(uint32_t fromId)
42 : id(fromId)
43 {}
44
operator uint32_t() const45 operator uint32_t() const
46 {
47 static_assert(sizeof(Identifier) == sizeof(uint32_t), "Identifier must be 32-bit");
48 return id;
49 }
50
51 struct State
52 {
53 VkImageViewType imageViewType;
54 VkFormat format;
55 VkComponentMapping mapping;
56 uint8_t minLod;
57 uint8_t maxLod;
58 bool singleMipLevel;
59 };
60 State getState() const;
61
62 private:
63 void pack(const State &data);
64
65 // Identifier is a union of this struct and the integer below.
66 static_assert(sw::MIPMAP_LEVELS <= 15);
67 struct
68 {
69 uint32_t imageViewType : 3;
70 uint32_t format : 8;
71 uint32_t r : 3;
72 uint32_t g : 3;
73 uint32_t b : 3;
74 uint32_t a : 3;
75 uint32_t minLod : 4;
76 uint32_t maxLod : 4;
77 uint32_t singleMipLevel : 1;
78 };
79
80 uint32_t id = 0;
81 };
82
83 class ImageView : public Object<ImageView, VkImageView>
84 {
85 public:
86 // Image usage:
87 // RAW: Use the base image as is
88 // SAMPLING: Image used for texture sampling
89 enum Usage
90 {
91 RAW,
92 SAMPLING
93 };
94
95 ImageView(const VkImageViewCreateInfo *pCreateInfo, void *mem, const vk::SamplerYcbcrConversion *ycbcrConversion);
96 void destroy(const VkAllocationCallbacks *pAllocator);
97
98 static size_t ComputeRequiredAllocationSize(const VkImageViewCreateInfo *pCreateInfo);
99
100 void clear(const VkClearValue &clearValues, VkImageAspectFlags aspectMask, const VkRect2D &renderArea, uint32_t layerMask);
101 void clear(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkClearRect &renderArea, uint32_t layerMask);
102 void resolve(ImageView *resolveAttachment, uint32_t layerMask);
103 void resolveDepthStencil(ImageView *resolveAttachment, VkResolveModeFlagBits depthResolveMode, VkResolveModeFlagBits stencilResolveMode);
104
getType() const105 VkImageViewType getType() const { return viewType; }
106 Format getFormat(Usage usage = RAW) const;
getFormat(VkImageAspectFlagBits aspect) const107 Format getFormat(VkImageAspectFlagBits aspect) const { return image->getFormat(aspect); }
108 uint32_t rowPitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
109 uint32_t slicePitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
110 uint32_t getMipLevelSize(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
111 uint32_t layerPitchBytes(VkImageAspectFlagBits aspect, Usage usage = RAW) const;
112 VkExtent2D getMipLevelExtent(uint32_t mipLevel) const;
113 VkExtent2D getMipLevelExtent(uint32_t mipLevel, VkImageAspectFlagBits aspect) const;
114 uint32_t getDepthOrLayerCount(uint32_t mipLevel) const;
115
getSampleCount() const116 int getSampleCount() const
117 {
118 switch(image->getSampleCount())
119 {
120 case VK_SAMPLE_COUNT_1_BIT: return 1;
121 case VK_SAMPLE_COUNT_4_BIT: return 4;
122 default:
123 UNSUPPORTED("Sample count %d", image->getSampleCount());
124 return 1;
125 }
126 }
127
128 void *getOffsetPointer(const VkOffset3D &offset, VkImageAspectFlagBits aspect, uint32_t mipLevel, uint32_t layer, Usage usage = RAW) const;
hasDepthAspect() const129 bool hasDepthAspect() const { return (subresourceRange.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0; }
hasStencilAspect() const130 bool hasStencilAspect() const { return (subresourceRange.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0; }
131
contentsChanged(Image::ContentsChangedContext context)132 void contentsChanged(Image::ContentsChangedContext context) { image->contentsChanged(subresourceRange, context); }
133
prepareForSampling()134 void prepareForSampling() { image->prepareForSampling(subresourceRange); }
135
getComponentMapping() const136 const VkComponentMapping &getComponentMapping() const { return components; }
getSubresourceRange() const137 const VkImageSubresourceRange &getSubresourceRange() const { return subresourceRange; }
getSizeInBytes() const138 size_t getSizeInBytes() const { return image->getSizeInBytes(subresourceRange); }
139
140 private:
141 bool imageTypesMatch(VkImageType imageType) const;
142 const Image *getImage(Usage usage) const;
143 void clear(const VkClearValue &clearValues, VkImageAspectFlags aspectMask, const VkRect2D &renderArea);
144 void clear(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkClearRect &renderArea);
145 void clearWithLayerMask(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkRect2D &renderArea, uint32_t layerMask);
146 void resolve(ImageView *resolveAttachment);
147 void resolveSingleLayer(ImageView *resolveAttachment, int layer);
148 void resolveWithLayerMask(ImageView *resolveAttachment, uint32_t layerMask);
149
150 Image *const image = nullptr;
151 const VkImageViewType viewType = VK_IMAGE_VIEW_TYPE_2D;
152 const Format format = VK_FORMAT_UNDEFINED;
153 const VkComponentMapping components = {};
154 const VkImageSubresourceRange subresourceRange = {};
155
156 const vk::SamplerYcbcrConversion *ycbcrConversion = nullptr;
157
158 public:
159 const Identifier id;
160 };
161
162 VkComponentMapping ResolveIdentityMapping(VkComponentMapping mapping);
163 VkComponentMapping ResolveComponentMapping(VkComponentMapping mapping, vk::Format format);
164 VkImageSubresourceRange ResolveRemainingLevelsLayers(VkImageSubresourceRange range, const vk::Image *image);
165
Cast(VkImageView object)166 static inline ImageView *Cast(VkImageView object)
167 {
168 return ImageView::Cast(object);
169 }
170
171 } // namespace vk
172
173 #endif // VK_IMAGE_VIEW_HPP_
174