src/testBase.h

// Copyright 2019 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef __VKBENCH_TESTBASE_H__
#define __VKBENCH_TESTBASE_H__

#include <vector>
#include <vulkan/vulkan.hpp>

#include "filepath.h"
#include "vkBase.h"
#include "utils.h"

namespace vkbench {
class testBase {
 public:
  virtual ~testBase() {}
  // Name of test.
  virtual const char* Name() const = 0;
  // Description of the test.
  virtual const char* Desp() const = 0;
  // Unit for formatted measurement.
  virtual const char* Unit() const = 0;
  // Given time elapse per iteration, format it into meaningful numbers.
  virtual double FormatMeasurement(double time) { return time; }

  // SaveImage saves the rendered image to file_name.
  virtual void SaveImage(FilePath file_path) const {
    throw std::runtime_error("Not Implemented!");
  };

  // Test related resources allocation. The resources allocated here would be
  // shared by all Run iterations. Time spent here will not be recorded.
  virtual void Initialize() {}
  // Test configuration before running the test. This will run once before
  // each Run loop. Time spent here will be recorded.
  virtual void Setup() {}
  // Test body. Time spent will be recorded.
  virtual void Run() = 0;
  // Test cleanup after looping Run. Time spent here will be recorded.
  virtual void Cleanup(){};
  // Free and Destroy any resources allocated during Initialize. Time
  // spent here will not be recorded.
  virtual void Destroy() = 0;

  vkbench::vkBase* vk;
};

}  // namespace vkbench
#endif