C_instance.hpp

/*
 * Copyright 2024 Guillaume Guillet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _FGE_VULKAN_C_INSTANCE_HPP_INCLUDED
#define _FGE_VULKAN_C_INSTANCE_HPP_INCLUDED
 
#include "FastEngine/fge_extern.hpp"
#include "volk.h"
#include "C_physicalDevice.hpp"
#include "tinyutf8.h"
#include <optional>
#include <string>
#include <vector>
 
namespace fge::vulkan
{
 
class FGE_API Instance
{
public:
    Instance();
    explicit Instance(std::string_view applicationName,
                      uint16_t versionMajor = 1,
                      uint16_t versionMinor = 0,
                      uint16_t versionPatch = 0);
    Instance(Instance const& r) = delete;
    Instance(Instance&& r) noexcept;
    ~Instance();
 
    Instance& operator=(Instance const& r) = delete;
    Instance& operator=(Instance&& r) noexcept = delete;
 
    void create(std::string_view applicationName,
                uint16_t versionMajor = 1,
                uint16_t versionMinor = 0,
                uint16_t versionPatch = 0);
    void destroy();
 
    [[nodiscard]] tiny_utf8::string const& getApplicationName() const;
 
    [[nodiscard]] VkInstance get() const;
 
    [[nodiscard]] std::vector<PhysicalDevice> const& getPhysicalDevices() const;
    [[nodiscard]] std::optional<PhysicalDevice> pickPhysicalDevice(VkSurfaceKHR surface) const;
 
private:
    void enumeratePhysicalDevices();
 
    VkInstance g_instance;
    tiny_utf8::string g_applicationName;
 
    std::vector<PhysicalDevice> g_physicalDevices;
};
 
} // namespace fge::vulkan
 
#endif //_FGE_VULKAN_C_INSTANCE_HPP_INCLUDED