magnum/src/Magnum/Vk/Instance.h

#ifndef Magnum_Vk_Instance_h
#define Magnum_Vk_Instance_h
/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016
              Vladimír Vondruš <mosra@centrum.cz>
    Copyright © 2016 Jonathan Hale <squareys@googlemail.com>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

/** @file
 * @brief Class @ref Magnum::Vk::Instance
 */

#include <vulkan.h>

#include <cstdlib>
#include <array>
#include <bitset>
#include <vector>
#include <Corrade/Containers/EnumSet.h>
#include <Corrade/Utility/Debug.h>

#include "Magnum/Tags.h"
#include "Magnum/Magnum.h"
#include "Magnum/Vk/PhysicalDevice.h"
#include "Magnum/Vk/visibility.h"
#include "MagnumExternal/Optional/optional.hpp"

namespace Magnum { namespace Vk {

enum class Version: UnsignedInt {
    None, /**< No version */
    Vulkan_1_0 = VK_API_VERSION_1_0, /**< Vulkan 1.0 */
};

#define MAGNUM_VK_ASSERT_ERROR(err) \
    do {                                                   \
        const VkResult r = err;                            \
        if(r != VK_SUCCESS) {                              \
            Error() << "(File:" << __FILE__                \
                    << ", Line:" << __LINE__               \
                    << ") Vulkan error:" << Vk::Result(r); \
            abort();                                       \
        }                                                  \
    } while(false)

#define VK_ERROR_INVALID_PARAMETER_NV -1000013000
#define VK_ERROR_INVALID_ALIGNMENT_NV -1000013001

enum class Result: Int {
    Success = VK_SUCCESS,           /**< Success */
    NotReady = VK_NOT_READY,        /**< Not ready */
    Timeout = VK_TIMEOUT,           /**< Timeout */
    EventSet = VK_EVENT_SET,        /**< Event set */
    EventReset = VK_EVENT_RESET,    /**< Event reset */
    Incomplete = VK_INCOMPLETE,     /**< Incomplete */
    ErrorOutOfHostMemory = VK_ERROR_OUT_OF_HOST_MEMORY,             /**< Out of host memory */
    ErrorOutOfDevieMemory = VK_ERROR_OUT_OF_DEVICE_MEMORY,          /**< Out of device memory */
    ErrorInitializationFailed = VK_ERROR_INITIALIZATION_FAILED,     /**< Initialization failed */
    ErrorDeviceLost = VK_ERROR_DEVICE_LOST,                         /**< Device lost */
    ErrorMemoryMapFailed = VK_ERROR_MEMORY_MAP_FAILED,              /**< Memory map failed */
    ErrorLayerNotPresent = VK_ERROR_LAYER_NOT_PRESENT,              /**< Layer not present */
    ErrorExtensionNotPresent = VK_ERROR_EXTENSION_NOT_PRESENT,      /**< Extension not present */
    ErrorFeatureNotPresent = VK_ERROR_FEATURE_NOT_PRESENT,          /**< Feature not present */
    ErrorIncompatibleDriver = VK_ERROR_INCOMPATIBLE_DRIVER,         /**< Incompatible driver */
    ErrorTooManyObjects = VK_ERROR_TOO_MANY_OBJECTS,                /**< Too many objects */
    ErrorFormatNotSupported = VK_ERROR_FORMAT_NOT_SUPPORTED,        /**< Format not supported */
    ErrorSurfaceLost = VK_ERROR_SURFACE_LOST_KHR,                   /**< Surface lost */
    ErrorNativeWindowInUse = VK_ERROR_NATIVE_WINDOW_IN_USE_KHR,     /**< Native window in use */
    Suboptimal = VK_SUBOPTIMAL_KHR,                                 /**< Suboptimal */
    ErrorOutOfDate = VK_ERROR_OUT_OF_DATE_KHR,                      /**< Out of date */
    ErrorIncompatibleDisplay = VK_ERROR_INCOMPATIBLE_DISPLAY_KHR,   /**< Incompatible display */
    ErrorValidationFailed = VK_ERROR_VALIDATION_FAILED_EXT,         /**< Validation failed */
    ErrorInvalidShader = VK_ERROR_INVALID_SHADER_NV,                /**< Invalid shader */
    ErrorInvalidParameter = VK_ERROR_INVALID_PARAMETER_NV,          /**< Invalid Parameter, only on Nvidia */
    ErrorInvalidAlignment = VK_ERROR_INVALID_ALIGNMENT_NV,          /**< Invalid Alignment, only on Nvidia */
};

/**
@brief Magnum Instance

Provides access to version and extension information. Instance available
through @ref Instance::current() is automatically created during construction of
`*Application` classes in @ref Platform namespace. You can safely assume that
the instance is available during whole lifetime of `*Application` object. It's
also possible to create the Instance without using any `*Application` class
using @ref Platform::Instance subclass, see @ref platform documentation for more
information.

## Command-line options

The Instance is configurable through command-line options, that are passed
either from the `Platform::*Application` classes or from the @ref Platform::Instance
class. Usage:

    <application> [--magnum-help] ...

Arguments:

-   `...` -- main application arguments (see `-h` or `--help` for details)
-   `--magnum-help` -- display this help message and exit
*/
class MAGNUM_VK_EXPORT Instance {
    public:
        /**
         * @brief Instance flag
         *
         * @see @ref Flags, @ref flags(),
         *      @ref Platform::Sdl2Application::Configuration::setFlags() "Platform::*Application::Configuration::setFlags()"
         */
        enum class Flag: Int {
            EnableValidation = 1, /**< Enable validation layer */
        };

        /**
         * @brief Instance flags
         *
         * @see @ref flags()
         */
        typedef Containers::EnumSet<Flag> Flags;

        /**
         * @brief Whether there is any current Instance
         *
         * @see @ref current()
         */
        static bool hasCurrent();

        /**
         * @brief Current Instance
         *
         * Expect that there is current Instance.
         * @see @ref hasCurrent()
         */
        static Instance& current();

        /** @brief Constructor */
        Instance();

        /**
         * @brief Constructor with flags
         */
        Instance(Flags flags);

        /** @brief Copying is not allowed */
        Instance(const Instance&) = delete;

        /** @brief Move constructor */
        Instance(Instance&& other);

        /**
         * @brief Destructor
         *
         * @see @fn_vk{DestroyInstance}
         */
        ~Instance();

        /** @brief Copying is not allowed */
        Instance& operator=(const Instance&) = delete;

        /** @brief Move assignment is not allowed */
        Instance& operator=(Instance&&) = delete;

        /** @brief Vulkan version */
        Version version() const { return _version; }

        /** @brief Instance flags */
        Flags flags() const { return _flags; }

        /**
         * @brief Whether given Vulkan version is supported
         *
         * @see @ref MAGNUM_ASSERT_VERSION_SUPPORTED()
         */
        bool isVersionSupported(Version version) const;

        operator VkInstance() {
            return _instance;
        }

        Containers::Array<PhysicalDevice> enumeratePhysicalDevices();

    private:
        MAGNUM_VK_LOCAL static Instance* _current;

        explicit Instance(NoCreateT, Int argc, char** argv, void functionLoader());

        bool tryCreate();
        void create();

        void(*_functionLoader)();
        Version _version;
        Flags _flags;

        VkInstance _instance;
        VkDebugReportCallbackEXT _callback;
};

MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, Result value);
MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, Instance::Flag value);
MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, Version value);

}}

#endif