1 #ifndef _VKTSHADERRENDER_HPP
2 #define _VKTSHADERRENDER_HPP
3 /*------------------------------------------------------------------------
4 * Vulkan Conformance Tests
5 * ------------------------
7 * Copyright (c) 2015 The Khronos Group Inc.
8 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
14 * http://www.apache.org/licenses/LICENSE-2.0
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
24 * \brief Vulkan ShaderRenderCase
25 *//*--------------------------------------------------------------------*/
27 #include "tcuTexture.hpp"
28 #include "tcuSurface.hpp"
31 #include "deSharedPtr.hpp"
32 #include "deUniquePtr.hpp"
35 #include "vkRefUtil.hpp"
36 #include "vkPrograms.hpp"
38 #include "vkMemUtil.hpp"
39 #include "vkBuilderUtil.hpp"
40 #include "vkTypeUtil.hpp"
41 #include "vkPlatform.hpp"
43 #include "vktTestCaseUtil.hpp"
53 LineStream (int indent = 0) { m_indent = indent; }
56 const char* str (void) const { m_string = m_stream.str(); return m_string.c_str(); }
57 LineStream& operator<< (const char* line) { for (int i = 0; i < m_indent; i++) { m_stream << "\t"; } m_stream << line << "\n"; return *this; }
61 std::ostringstream m_stream;
62 mutable std::string m_string;
66 class ShaderRenderCaseInstance;
95 deUint32 baseMipLevel;
96 vk::VkComponentMapping componentMapping;
97 vk::VkSampleCountFlagBits samples;
100 Parameters (deUint32 baseMipLevel_ = 0,
101 vk::VkComponentMapping componentMapping_ = vk::makeComponentMappingRGBA(),
102 vk::VkSampleCountFlagBits samples_ = vk::VK_SAMPLE_COUNT_1_BIT,
103 Init initialization_ = INIT_UPLOAD_DATA)
104 : baseMipLevel (baseMipLevel_)
105 , componentMapping (componentMapping_)
107 , initialization (initialization_)
112 TextureBinding (const tcu::Archive& archive,
113 const char* filename,
115 const tcu::Sampler& sampler);
117 TextureBinding (const tcu::Texture1D* tex1D, const tcu::Sampler& sampler);
118 TextureBinding (const tcu::Texture2D* tex2D, const tcu::Sampler& sampler);
119 TextureBinding (const tcu::Texture3D* tex3D, const tcu::Sampler& sampler);
120 TextureBinding (const tcu::TextureCube* texCube, const tcu::Sampler& sampler);
121 TextureBinding (const tcu::Texture1DArray* tex1DArray, const tcu::Sampler& sampler);
122 TextureBinding (const tcu::Texture2DArray* tex2DArray, const tcu::Sampler& sampler);
123 TextureBinding (const tcu::TextureCubeArray* texCubeArray, const tcu::Sampler& sampler);
125 ~TextureBinding (void);
127 Type getType (void) const { return m_type; }
128 const tcu::Sampler& getSampler (void) const { return m_sampler; }
130 const tcu::Texture1D& get1D (void) const { DE_ASSERT(getType() == TYPE_1D && m_binding.tex1D != NULL); return *m_binding.tex1D; }
131 const tcu::Texture2D& get2D (void) const { DE_ASSERT(getType() == TYPE_2D && m_binding.tex2D != NULL); return *m_binding.tex2D; }
132 const tcu::Texture3D& get3D (void) const { DE_ASSERT(getType() == TYPE_3D && m_binding.tex3D != NULL); return *m_binding.tex3D; }
133 const tcu::TextureCube& getCube (void) const { DE_ASSERT(getType() == TYPE_CUBE_MAP && m_binding.texCube != NULL); return *m_binding.texCube; }
134 const tcu::Texture1DArray& get1DArray (void) const { DE_ASSERT(getType() == TYPE_1D_ARRAY && m_binding.tex1DArray != NULL); return *m_binding.tex1DArray; }
135 const tcu::Texture2DArray& get2DArray (void) const { DE_ASSERT(getType() == TYPE_2D_ARRAY && m_binding.tex2DArray != NULL); return *m_binding.tex2DArray; }
136 const tcu::TextureCubeArray& getCubeArray (void) const { DE_ASSERT(getType() == TYPE_CUBE_ARRAY && m_binding.texCubeArray != NULL); return *m_binding.texCubeArray; }
138 void setParameters (const Parameters& params) { m_params = params; }
139 const Parameters& getParameters (void) const { return m_params; }
142 TextureBinding (const TextureBinding&); // not allowed!
143 TextureBinding& operator= (const TextureBinding&); // not allowed!
145 static de::MovePtr<tcu::Texture2D> loadTexture2D (const tcu::Archive& archive, const char* filename);
148 tcu::Sampler m_sampler;
153 const tcu::Texture1D* tex1D;
154 const tcu::Texture2D* tex2D;
155 const tcu::Texture3D* tex3D;
156 const tcu::TextureCube* texCube;
157 const tcu::Texture1DArray* tex1DArray;
158 const tcu::Texture2DArray* tex2DArray;
159 const tcu::TextureCubeArray* texCubeArray;
163 typedef de::SharedPtr<TextureBinding> TextureBindingSp;
165 // ShaderEvalContext.
167 class ShaderEvalContext
173 MAX_USER_ATTRIBS = 4,
179 tcu::Sampler sampler;
180 const tcu::Texture1D* tex1D;
181 const tcu::Texture2D* tex2D;
182 const tcu::Texture3D* tex3D;
183 const tcu::TextureCube* texCube;
184 const tcu::Texture1DArray* tex1DArray;
185 const tcu::Texture2DArray* tex2DArray;
186 const tcu::TextureCubeArray* texCubeArray;
188 inline ShaderSampler (void)
193 , tex1DArray (DE_NULL)
194 , tex2DArray (DE_NULL)
195 , texCubeArray (DE_NULL)
200 ShaderEvalContext (const QuadGrid& quadGrid);
201 ~ShaderEvalContext (void);
203 void reset (float sx, float sy);
207 tcu::Vec4 unitCoords;
208 tcu::Vec4 constCoords;
210 tcu::Vec4 in[MAX_USER_ATTRIBS];
211 ShaderSampler textures[MAX_TEXTURES];
218 inline void discard (void) { isDiscarded = true; }
219 tcu::Vec4 texture2D (int unitNdx, const tcu::Vec2& coords);
222 const QuadGrid& m_quadGrid;
225 typedef void (*ShaderEvalFunc) (ShaderEvalContext& c);
227 inline void evalCoordsPassthroughX (ShaderEvalContext& c) { c.color.x() = c.coords.x(); }
228 inline void evalCoordsPassthroughXY (ShaderEvalContext& c) { c.color.xy() = c.coords.swizzle(0,1); }
229 inline void evalCoordsPassthroughXYZ (ShaderEvalContext& c) { c.color.xyz() = c.coords.swizzle(0,1,2); }
230 inline void evalCoordsPassthrough (ShaderEvalContext& c) { c.color = c.coords; }
231 inline void evalCoordsSwizzleWZYX (ShaderEvalContext& c) { c.color = c.coords.swizzle(3,2,1,0); }
234 // Either inherit a class with overridden evaluate() or just pass in an evalFunc.
236 class ShaderEvaluator
239 ShaderEvaluator (void);
240 ShaderEvaluator (const ShaderEvalFunc evalFunc);
241 virtual ~ShaderEvaluator (void);
243 virtual void evaluate (ShaderEvalContext& ctx) const;
246 ShaderEvaluator (const ShaderEvaluator&); // not allowed!
247 ShaderEvaluator& operator= (const ShaderEvaluator&); // not allowed!
249 const ShaderEvalFunc m_evalFunc;
254 typedef void (*UniformSetupFunc) (ShaderRenderCaseInstance& instance, const tcu::Vec4& constCoords);
260 UniformSetup (const UniformSetupFunc setup);
261 virtual ~UniformSetup (void);
262 virtual void setup (ShaderRenderCaseInstance& instance, const tcu::Vec4& constCoords) const;
265 UniformSetup (const UniformSetup&); // not allowed!
266 UniformSetup& operator= (const UniformSetup&); // not allowed!
268 const UniformSetupFunc m_setupFunc;
271 typedef void (*AttributeSetupFunc) (ShaderRenderCaseInstance& instance, deUint32 numVertices);
273 class ShaderRenderCase : public vkt::TestCase
276 ShaderRenderCase (tcu::TestContext& testCtx,
277 const std::string& name,
278 const std::string& description,
279 const bool isVertexCase,
280 const ShaderEvalFunc evalFunc,
281 const UniformSetup* uniformSetup,
282 const AttributeSetupFunc attribFunc);
284 ShaderRenderCase (tcu::TestContext& testCtx,
285 const std::string& name,
286 const std::string& description,
287 const bool isVertexCase,
288 const ShaderEvaluator* evaluator,
289 const UniformSetup* uniformSetup,
290 const AttributeSetupFunc attribFunc);
292 virtual ~ShaderRenderCase (void);
293 virtual void initPrograms (vk::SourceCollections& programCollection) const;
294 virtual TestInstance* createInstance (Context& context) const;
297 std::string m_vertShaderSource;
298 std::string m_fragShaderSource;
300 const bool m_isVertexCase;
301 const de::UniquePtr<const ShaderEvaluator> m_evaluator;
302 const de::UniquePtr<const UniformSetup> m_uniformSetup;
303 const AttributeSetupFunc m_attribFunc;
409 enum BaseAttributeType
429 // ShaderRenderCaseInstance.
431 class ShaderRenderCaseInstance : public vkt::TestInstance
434 enum ImageBackingMode
436 IMAGE_BACKING_MODE_REGULAR = 0,
437 IMAGE_BACKING_MODE_SPARSE,
440 // Default wertex and fragment grid sizes are used by a large collection of tests
441 // to generate input sets. Some tests might change their behavior if the
442 // default grid size values are altered, so care should be taken to confirm that
443 // any changes to default values do not produce regressions.
444 // If a particular tests needs to use a different grid size value, rather than
445 // modifying the default grid size values for all tests, it is recommended that
446 // the test specifies the required grid size using the gridSize parameter in the
447 // ShaderRenderCaseInstance constuctor instead.
450 GRID_SIZE_DEFAULTS = 0,
451 GRID_SIZE_DEFAULT_VERTEX = 90,
452 GRID_SIZE_DEFAULT_FRAGMENT = 4,
455 ShaderRenderCaseInstance (Context& context);
456 ShaderRenderCaseInstance (Context& context,
457 const bool isVertexCase,
458 const ShaderEvaluator& evaluator,
459 const UniformSetup& uniformSetup,
460 const AttributeSetupFunc attribFunc,
461 const ImageBackingMode imageBackingMode = IMAGE_BACKING_MODE_REGULAR,
462 const deUint32 gridSize = static_cast<deUint32>(GRID_SIZE_DEFAULTS));
464 virtual ~ShaderRenderCaseInstance (void);
465 virtual tcu::TestStatus iterate (void);
467 void addAttribute (deUint32 bindingLocation,
469 deUint32 sizePerElement,
472 void useAttribute (deUint32 bindingLocation,
473 BaseAttributeType type);
476 void addUniform (deUint32 bindingLocation,
477 vk::VkDescriptorType descriptorType,
479 void addUniform (deUint32 bindingLocation,
480 vk::VkDescriptorType descriptorType,
483 void useUniform (deUint32 bindingLocation,
484 BaseUniformType type);
485 void useSampler (deUint32 bindingLocation,
488 static const tcu::Vec4 getDefaultConstCoords (void) { return tcu::Vec4(0.125f, 0.25f, 0.5f, 1.0f); }
489 void setPushConstantRanges (const deUint32 rangeCount, const vk::VkPushConstantRange* const pcRanges);
490 virtual void updatePushConstants (vk::VkCommandBuffer commandBuffer, vk::VkPipelineLayout pipelineLayout);
493 ShaderRenderCaseInstance (Context& context,
494 const bool isVertexCase,
495 const ShaderEvaluator* evaluator,
496 const UniformSetup* uniformSetup,
497 const AttributeSetupFunc attribFunc,
498 const ImageBackingMode imageBackingMode = IMAGE_BACKING_MODE_REGULAR,
499 const deUint32 gridSize = static_cast<deUint32>(GRID_SIZE_DEFAULTS));
501 virtual void setup (void);
502 virtual void setupUniforms (const tcu::Vec4& constCoords);
503 virtual void setupDefaultInputs (void);
505 void render (deUint32 numVertices,
506 deUint32 numTriangles,
507 const deUint16* indices,
508 const tcu::Vec4& constCoords = getDefaultConstCoords());
510 void render (deUint32 numVertices,
512 const deUint16* indices,
513 vk::VkPrimitiveTopology topology,
514 const tcu::Vec4& constCoords = getDefaultConstCoords());
516 const tcu::TextureLevel& getResultImage (void) const { return m_resultImage; }
518 const tcu::UVec2 getViewportSize (void) const;
520 void setSampleCount (vk::VkSampleCountFlagBits sampleCount);
522 bool isMultiSampling (void) const;
524 ImageBackingMode m_imageBackingMode;
526 deUint32 m_quadGridSize;
531 SparseContext (vkt::Context& context);
533 vkt::Context& m_context;
534 const deUint32 m_queueFamilyIndex;
535 vk::Unique<vk::VkDevice> m_device;
536 vk::DeviceDriver m_deviceInterface;
537 const vk::VkQueue m_queue;
538 const de::UniquePtr<vk::Allocator> m_allocator;
540 vk::Move<vk::VkDevice> createDevice (void) const;
541 vk::Allocator* createAllocator (void) const;
545 de::UniquePtr<SparseContext> m_sparseContext;
547 vk::Allocator& m_memAlloc;
548 const tcu::Vec4 m_clearColor;
549 const bool m_isVertexCase;
551 std::vector<tcu::Mat4> m_userAttribTransforms;
552 std::vector<TextureBindingSp> m_textures;
554 std::string m_vertexShaderName;
555 std::string m_fragmentShaderName;
556 tcu::UVec2 m_renderSize;
557 vk::VkFormat m_colorFormat;
560 typedef std::vector<tcu::ConstPixelBufferAccess> TextureLayerData;
561 typedef std::vector<TextureLayerData> TextureData;
563 void uploadImage (const tcu::TextureFormat& texFormat,
564 const TextureData& textureData,
565 const tcu::Sampler& refSampler,
567 deUint32 arrayLayers,
568 vk::VkImage destImage);
570 void clearImage (const tcu::Sampler& refSampler,
572 deUint32 arrayLayers,
573 vk::VkImage destImage);
575 void checkSparseSupport (const vk::VkImageCreateInfo& imageInfo) const;
577 void uploadSparseImage (const tcu::TextureFormat& texFormat,
578 const TextureData& textureData,
579 const tcu::Sampler& refSampler,
580 const deUint32 mipLevels,
581 const deUint32 arrayLayers,
582 const vk::VkImage sparseImage,
583 const vk::VkImageCreateInfo& imageCreateInfo,
584 const tcu::UVec3 texSize);
586 void createSamplerUniform (deUint32 bindingLocation,
587 TextureBinding::Type textureType,
588 TextureBinding::Init textureInit,
589 const tcu::TextureFormat& texFormat,
590 const tcu::UVec3 texSize,
591 const TextureData& textureData,
592 const tcu::Sampler& refSampler,
594 deUint32 arrayLayers,
595 TextureBinding::Parameters textureParams);
597 void setupUniformData (deUint32 bindingLocation, size_t size, const void* dataPtr);
599 void computeVertexReference (tcu::Surface& result, const QuadGrid& quadGrid);
600 void computeFragmentReference (tcu::Surface& result, const QuadGrid& quadGrid);
601 bool compareImages (const tcu::Surface& resImage,
602 const tcu::Surface& refImage,
603 float errorThreshold);
606 const ShaderEvaluator* m_evaluator;
607 const UniformSetup* m_uniformSetup;
608 const AttributeSetupFunc m_attribFunc;
609 de::MovePtr<QuadGrid> m_quadGrid;
610 tcu::TextureLevel m_resultImage;
612 struct EnabledBaseAttribute
615 BaseAttributeType type;
617 std::vector<EnabledBaseAttribute> m_enabledBaseAttributes;
619 de::MovePtr<vk::DescriptorSetLayoutBuilder> m_descriptorSetLayoutBuilder;
620 de::MovePtr<vk::DescriptorPoolBuilder> m_descriptorPoolBuilder;
621 de::MovePtr<vk::DescriptorSetUpdateBuilder> m_descriptorSetUpdateBuilder;
623 typedef de::SharedPtr<vk::Unique<vk::VkBuffer> > VkBufferSp;
624 typedef de::SharedPtr<vk::Unique<vk::VkImage> > VkImageSp;
625 typedef de::SharedPtr<vk::Unique<vk::VkImageView> > VkImageViewSp;
626 typedef de::SharedPtr<vk::Unique<vk::VkSampler> > VkSamplerSp;
627 typedef de::SharedPtr<vk::Allocation> AllocationSp;
632 UniformInfo (void) {}
633 virtual ~UniformInfo (void) {}
635 vk::VkDescriptorType type;
639 class BufferUniform : public UniformInfo
642 BufferUniform (void) {}
643 virtual ~BufferUniform (void) {}
647 vk::VkDescriptorBufferInfo descriptor;
650 class SamplerUniform : public UniformInfo
653 SamplerUniform (void) {}
654 virtual ~SamplerUniform (void) {}
657 VkImageViewSp imageView;
660 vk::VkDescriptorImageInfo descriptor;
663 typedef de::SharedPtr<de::UniquePtr<UniformInfo> > UniformInfoSp;
664 std::vector<UniformInfoSp> m_uniformInfos;
666 std::vector< de::SharedPtr<vk::Allocation> > m_allocations;
668 std::vector<vk::VkVertexInputBindingDescription> m_vertexBindingDescription;
669 std::vector<vk::VkVertexInputAttributeDescription> m_vertexAttributeDescription;
671 std::vector<VkBufferSp> m_vertexBuffers;
672 std::vector<AllocationSp> m_vertexBufferAllocs;
674 vk::VkSampleCountFlagBits m_sampleCount;
675 std::vector<vk::VkPushConstantRange> m_pushConstantRanges;
677 // Wrapper functions around m_context calls to support sparse cases.
678 vk::VkDevice getDevice (void) const;
679 deUint32 getUniversalQueueFamilyIndex (void) const;
680 const vk::DeviceInterface& getDeviceInterface (void) const;
681 vk::VkQueue getUniversalQueue (void) const;
682 vk::VkPhysicalDevice getPhysicalDevice (void) const;
683 const vk::InstanceInterface& getInstanceInterface (void) const;
684 SparseContext* createSparseContext (void) const;
685 vk::Allocator& getAllocator (void) const;
689 void ShaderRenderCaseInstance::addUniform (deUint32 bindingLocation, vk::VkDescriptorType descriptorType, const T& data)
691 addUniform(bindingLocation, descriptorType, sizeof(T), &data);
697 #endif // _VKTSHADERRENDER_HPP