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 bool singleMipLevel;
57 };
58 State getState() const;
59
60 private:
61 void pack(const State &data);
62
63 // Identifier is a union of this struct and the integer below.
64 struct
65 {
66 uint32_t imageViewType : 3;
67 uint32_t format : 8;
68 uint32_t r : 3;
69 uint32_t g : 3;
70 uint32_t b : 3;
71 uint32_t a : 3;
72 uint32_t singleMipLevel : 1;
73 };
74
75 uint32_t id = 0;
76 };
77
78 class ImageView : public Object<ImageView, VkImageView>
79 {
80 public:
81 // Image usage:
82 // RAW: Use the base image as is
83 // SAMPLING: Image used for texture sampling
84 enum Usage
85 {
86 RAW,
87 SAMPLING
88 };
89
90 ImageView(const VkImageViewCreateInfo *pCreateInfo, void *mem, const vk::SamplerYcbcrConversion *ycbcrConversion);
91 void destroy(const VkAllocationCallbacks *pAllocator);
92
93 static size_t ComputeRequiredAllocationSize(const VkImageViewCreateInfo *pCreateInfo);
94
95 void clear(const VkClearValue &clearValues, VkImageAspectFlags aspectMask, const VkRect2D &renderArea, uint32_t layerMask);
96 void clear(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkClearRect &renderArea, uint32_t layerMask);
97 void resolve(ImageView *resolveAttachment, uint32_t layerMask);
98 void resolveDepthStencil(ImageView *resolveAttachment, VkResolveModeFlagBits depthResolveMode, VkResolveModeFlagBits stencilResolveMode);
99
getType() const100 VkImageViewType getType() const { return viewType; }
101 Format getFormat(Usage usage = RAW) const;
getFormat(VkImageAspectFlagBits aspect) const102 Format getFormat(VkImageAspectFlagBits aspect) const { return image->getFormat(aspect); }
103 uint32_t rowPitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
104 uint32_t slicePitchBytes(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
105 uint32_t getMipLevelSize(VkImageAspectFlagBits aspect, uint32_t mipLevel, Usage usage = RAW) const;
106 uint32_t layerPitchBytes(VkImageAspectFlagBits aspect, Usage usage = RAW) const;
107 VkExtent2D getMipLevelExtent(uint32_t mipLevel) const;
108 VkExtent2D getMipLevelExtent(uint32_t mipLevel, VkImageAspectFlagBits aspect) const;
109 uint32_t getDepthOrLayerCount(uint32_t mipLevel) const;
110
getSampleCount() const111 int getSampleCount() const
112 {
113 switch(image->getSampleCountFlagBits())
114 {
115 case VK_SAMPLE_COUNT_1_BIT: return 1;
116 case VK_SAMPLE_COUNT_4_BIT: return 4;
117 default:
118 UNSUPPORTED("Sample count flags %d", image->getSampleCountFlagBits());
119 return 1;
120 }
121 }
122
123 void *getOffsetPointer(const VkOffset3D &offset, VkImageAspectFlagBits aspect, uint32_t mipLevel, uint32_t layer, Usage usage = RAW) const;
hasDepthAspect() const124 bool hasDepthAspect() const { return (subresourceRange.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0; }
hasStencilAspect() const125 bool hasStencilAspect() const { return (subresourceRange.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0; }
126
contentsChanged(Image::ContentsChangedContext context)127 void contentsChanged(Image::ContentsChangedContext context) { image->contentsChanged(subresourceRange, context); }
128
prepareForSampling()129 void prepareForSampling() { image->prepareForSampling(subresourceRange); }
130
getComponentMapping() const131 const VkComponentMapping &getComponentMapping() const { return components; }
getSubresourceRange() const132 const VkImageSubresourceRange &getSubresourceRange() const { return subresourceRange; }
getSizeInBytes() const133 size_t getSizeInBytes() const { return image->getSizeInBytes(subresourceRange); }
134
135 private:
136 bool imageTypesMatch(VkImageType imageType) const;
137 const Image *getImage(Usage usage) const;
138 void clear(const VkClearValue &clearValues, VkImageAspectFlags aspectMask, const VkRect2D &renderArea);
139 void clear(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkClearRect &renderArea);
140 void clearWithLayerMask(const VkClearValue &clearValue, VkImageAspectFlags aspectMask, const VkRect2D &renderArea, uint32_t layerMask);
141 void resolve(ImageView *resolveAttachment);
142 void resolveSingleLayer(ImageView *resolveAttachment, int layer);
143 void resolveWithLayerMask(ImageView *resolveAttachment, uint32_t layerMask);
144
145 Image *const image = nullptr;
146 const VkImageViewType viewType = VK_IMAGE_VIEW_TYPE_2D;
147 const Format format = VK_FORMAT_UNDEFINED;
148 const VkComponentMapping components = {};
149 const VkImageSubresourceRange subresourceRange = {};
150
151 const vk::SamplerYcbcrConversion *ycbcrConversion = nullptr;
152
153 public:
154 const Identifier id;
155 };
156
157 VkComponentMapping ResolveIdentityMapping(VkComponentMapping mapping);
158 VkComponentMapping ResolveComponentMapping(VkComponentMapping mapping, vk::Format format);
159 VkImageSubresourceRange ResolveRemainingLevelsLayers(VkImageSubresourceRange range, const vk::Image *image);
160
Cast(VkImageView object)161 static inline ImageView *Cast(VkImageView object)
162 {
163 return ImageView::Cast(object);
164 }
165
166 } // namespace vk
167
168 #endif // VK_IMAGE_VIEW_HPP_
169