RenderAPI.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "Common.hpp"
 
#include "GPUBuffer.hpp"
#include "GPUCommandBuffer.hpp"
#include "GPUCommandQueue.hpp"
#include "GPUComputePipeline.hpp"
#include "GPUDevice.hpp"
#include "GPUFence.hpp"
#include "GPUFormat.hpp"
#include "GPUGraphicsPipeline.hpp"
#include "GPUImage.hpp"
#include "GPUPipelineLayout.hpp"
#include "GPUQuery.hpp"
#include "GPURenderPass.hpp"
#include "GPURenderTarget.hpp"
#include "GPUResourceSet.hpp"
#include "GPUSampler.hpp"
#include "GPUShader.hpp"
#include "GPUVertexFormat.hpp"
 
#include "CeresEngine/DataTypes.hpp"
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/Any.hpp"
#include "CeresEngine/Foundation/SmartPtr.hpp"
 
#include <any>
#include <functional>
 
namespace CeresEngine {
 
    using DebugMessageCallback = std::function<bool(const String& type, const String& message)>;
 
    struct CE_SCRIPT_EXPORT() RenderAPIApplicationDescriptor final {
        CE_SCRIPT_EXPORT()
        String applicationName;
 
        CE_SCRIPT_EXPORT()
        UInt32 applicationVersion;
    };
 
    struct CE_SCRIPT_EXPORT() RenderAPIDescriptor final {
        CE_SCRIPT_EXPORT()
        RenderAPIApplicationDescriptor application;
 
        DebugMessageCallback debugMessageCallback;
 
        Any rendererDescriptor;
    };
 
    using DevicePickerFunc = std::function<bool(const GPUDeviceInfo&, const GPURenderingCapabilities&)>;
 
    class CE_SCRIPT_EXPORT() RenderAPI {
    public:
        RenderAPI() = default;
 
        virtual ~RenderAPI() = default;
 
        RenderAPI(const RenderAPI&) = delete;
        RenderAPI& operator=(const RenderAPI&) = delete;
 
        RenderAPI(RenderAPI&&) = delete;
        RenderAPI& operator=(RenderAPI&&) = delete;
 
    public:
        [[nodiscard]] virtual GPUDevicePtr createDevice(const GPUDeviceDescriptor& descriptor, const DevicePickerFunc& pickerFunc = nullptr) = 0;
 
        [[nodiscard]] CE_SCRIPT_EXPORT()
        virtual GPUDevicePtr getDefaultDevice() = 0;
 
    public:
        virtual void update() = 0;
    };
 
} // namespace CeresEngine