xref: /aosp_15_r20/external/skia/tools/skqp/src/skqp.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker /*
2*c8dee2aaSAndroid Build Coastguard Worker  * Copyright 2018 Google Inc.
3*c8dee2aaSAndroid Build Coastguard Worker  *
4*c8dee2aaSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
5*c8dee2aaSAndroid Build Coastguard Worker  * found in the LICENSE file.
6*c8dee2aaSAndroid Build Coastguard Worker  */
7*c8dee2aaSAndroid Build Coastguard Worker 
8*c8dee2aaSAndroid Build Coastguard Worker #ifndef skqp_DEFINED
9*c8dee2aaSAndroid Build Coastguard Worker #define skqp_DEFINED
10*c8dee2aaSAndroid Build Coastguard Worker 
11*c8dee2aaSAndroid Build Coastguard Worker #include <cstdint>
12*c8dee2aaSAndroid Build Coastguard Worker #include <memory>
13*c8dee2aaSAndroid Build Coastguard Worker #include <string>
14*c8dee2aaSAndroid Build Coastguard Worker #include <vector>
15*c8dee2aaSAndroid Build Coastguard Worker 
16*c8dee2aaSAndroid Build Coastguard Worker class SkData;
17*c8dee2aaSAndroid Build Coastguard Worker template <typename T> class sk_sp;
18*c8dee2aaSAndroid Build Coastguard Worker 
19*c8dee2aaSAndroid Build Coastguard Worker namespace skiagm {
20*c8dee2aaSAndroid Build Coastguard Worker class GM;
21*c8dee2aaSAndroid Build Coastguard Worker }  // namespace skiagm
22*c8dee2aaSAndroid Build Coastguard Worker 
23*c8dee2aaSAndroid Build Coastguard Worker namespace skiatest {
24*c8dee2aaSAndroid Build Coastguard Worker struct Test;
25*c8dee2aaSAndroid Build Coastguard Worker }  // namespace skiatest
26*c8dee2aaSAndroid Build Coastguard Worker 
27*c8dee2aaSAndroid Build Coastguard Worker class SkStreamAsset;
28*c8dee2aaSAndroid Build Coastguard Worker 
29*c8dee2aaSAndroid Build Coastguard Worker ////////////////////////////////////////////////////////////////////////////////
30*c8dee2aaSAndroid Build Coastguard Worker class SkQPAssetManager {
31*c8dee2aaSAndroid Build Coastguard Worker public:
SkQPAssetManager()32*c8dee2aaSAndroid Build Coastguard Worker     SkQPAssetManager() {}
~SkQPAssetManager()33*c8dee2aaSAndroid Build Coastguard Worker     virtual ~SkQPAssetManager() {}
34*c8dee2aaSAndroid Build Coastguard Worker     virtual sk_sp<SkData> open(const char* path) = 0;
35*c8dee2aaSAndroid Build Coastguard Worker     virtual std::vector<std::string> iterateDir(const char* directory, const char* extension) = 0;
36*c8dee2aaSAndroid Build Coastguard Worker 
37*c8dee2aaSAndroid Build Coastguard Worker private:
38*c8dee2aaSAndroid Build Coastguard Worker     SkQPAssetManager(const SkQPAssetManager&) = delete;
39*c8dee2aaSAndroid Build Coastguard Worker     SkQPAssetManager& operator=(const SkQPAssetManager&) = delete;
40*c8dee2aaSAndroid Build Coastguard Worker };
41*c8dee2aaSAndroid Build Coastguard Worker 
42*c8dee2aaSAndroid Build Coastguard Worker class SkQP {
43*c8dee2aaSAndroid Build Coastguard Worker public:
44*c8dee2aaSAndroid Build Coastguard Worker     using UnitTest = const skiatest::Test*;
45*c8dee2aaSAndroid Build Coastguard Worker 
46*c8dee2aaSAndroid Build Coastguard Worker     struct SkSLErrorTest {
47*c8dee2aaSAndroid Build Coastguard Worker         std::string name;
48*c8dee2aaSAndroid Build Coastguard Worker         std::string shaderText;
49*c8dee2aaSAndroid Build Coastguard Worker     };
50*c8dee2aaSAndroid Build Coastguard Worker 
51*c8dee2aaSAndroid Build Coastguard Worker     ////////////////////////////////////////////////////////////////////////////
52*c8dee2aaSAndroid Build Coastguard Worker 
53*c8dee2aaSAndroid Build Coastguard Worker     /** These functions provide a descriptive name for the given value.*/
54*c8dee2aaSAndroid Build Coastguard Worker     static const char* GetUnitTestName(UnitTest);
55*c8dee2aaSAndroid Build Coastguard Worker 
56*c8dee2aaSAndroid Build Coastguard Worker     SkQP();
57*c8dee2aaSAndroid Build Coastguard Worker     ~SkQP();
58*c8dee2aaSAndroid Build Coastguard Worker 
59*c8dee2aaSAndroid Build Coastguard Worker     /**
60*c8dee2aaSAndroid Build Coastguard Worker         Initialize Skia and the SkQP.  Should be executed only once.
61*c8dee2aaSAndroid Build Coastguard Worker 
62*c8dee2aaSAndroid Build Coastguard Worker         @param assetManager - provides assets for the models.  Does not take ownership.
63*c8dee2aaSAndroid Build Coastguard Worker         @param reportDirectory - where to write out report.
64*c8dee2aaSAndroid Build Coastguard Worker     */
65*c8dee2aaSAndroid Build Coastguard Worker     void init(SkQPAssetManager* assetManager, const char* reportDirectory);
66*c8dee2aaSAndroid Build Coastguard Worker 
67*c8dee2aaSAndroid Build Coastguard Worker     /** @return a (hopefully empty) list of errors produced by this unit test.  */
68*c8dee2aaSAndroid Build Coastguard Worker     std::vector<std::string> executeTest(UnitTest);
69*c8dee2aaSAndroid Build Coastguard Worker 
70*c8dee2aaSAndroid Build Coastguard Worker     /** Call this after running all checks to write a report into the given report directory. */
71*c8dee2aaSAndroid Build Coastguard Worker     void makeReport();
72*c8dee2aaSAndroid Build Coastguard Worker 
73*c8dee2aaSAndroid Build Coastguard Worker     /** @return a sorted list of all Skia GPU unit tests */
getUnitTests()74*c8dee2aaSAndroid Build Coastguard Worker     const std::vector<UnitTest>& getUnitTests() const { return fUnitTests; }
75*c8dee2aaSAndroid Build Coastguard Worker 
76*c8dee2aaSAndroid Build Coastguard Worker     /** @return a sorted list of all SkSL error tests */
getSkSLErrorTests()77*c8dee2aaSAndroid Build Coastguard Worker     const std::vector<SkSLErrorTest>& getSkSLErrorTests() const { return fSkSLErrorTests; }
78*c8dee2aaSAndroid Build Coastguard Worker 
79*c8dee2aaSAndroid Build Coastguard Worker     ////////////////////////////////////////////////////////////////////////////
80*c8dee2aaSAndroid Build Coastguard Worker 
81*c8dee2aaSAndroid Build Coastguard Worker private:
82*c8dee2aaSAndroid Build Coastguard Worker     struct TestResult {
83*c8dee2aaSAndroid Build Coastguard Worker         std::string name;
84*c8dee2aaSAndroid Build Coastguard Worker         std::vector<std::string> errors;
85*c8dee2aaSAndroid Build Coastguard Worker     };
86*c8dee2aaSAndroid Build Coastguard Worker     std::vector<TestResult> fTestResults;
87*c8dee2aaSAndroid Build Coastguard Worker     std::string fReportDirectory;
88*c8dee2aaSAndroid Build Coastguard Worker     std::vector<UnitTest> fUnitTests;
89*c8dee2aaSAndroid Build Coastguard Worker     std::vector<SkSLErrorTest> fSkSLErrorTests;
90*c8dee2aaSAndroid Build Coastguard Worker 
91*c8dee2aaSAndroid Build Coastguard Worker     // Defaults to zero since most checks care if it is greater than a specific value. So this will
92*c8dee2aaSAndroid Build Coastguard Worker     // just default to it being less.
93*c8dee2aaSAndroid Build Coastguard Worker     int fEnforcedAndroidAPILevel = 0;
94*c8dee2aaSAndroid Build Coastguard Worker 
95*c8dee2aaSAndroid Build Coastguard Worker     SkQP(const SkQP&) = delete;
96*c8dee2aaSAndroid Build Coastguard Worker     SkQP& operator=(const SkQP&) = delete;
97*c8dee2aaSAndroid Build Coastguard Worker     void printBackendInfo(const char* dstPath);
98*c8dee2aaSAndroid Build Coastguard Worker };
99*c8dee2aaSAndroid Build Coastguard Worker #endif  // skqp_DEFINED
100*c8dee2aaSAndroid Build Coastguard Worker 
101