magnum/src/Magnum/Vk/Result.h

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

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>

    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 Enum @ref Magnum::Vk::Result
 * @m_since_latest
 */

#include "Magnum/Magnum.h"
#include "Magnum/Vk/visibility.h"
#include "Magnum/Vk/Vulkan.h"

namespace Magnum { namespace Vk {

/**
@brief Result
@m_since_latest

Wraps a @type_vk_keyword{Result}.
@m_enum_values_as_keywords
@see @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(),
    @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR()
*/
enum class Result: Int {
    /** Command successfully completed */
    Success = VK_SUCCESS,

    /** A fence or query has not yet completed */
    NotReady = VK_NOT_READY,

    /** A wait operation has not completed in the specified time */
    Timeout = VK_TIMEOUT,

    /** An event is signaled */
    EventSet = VK_EVENT_SET,

    /** An event is unsignaled */
    EventReset = VK_EVENT_RESET,

    /** A return array was too small for the result */
    Incomplete = VK_INCOMPLETE,

    /**
     * A deferred operation is not complete but there is currently no work for
     * this thread to do at the time of this call.
     * @requires_vk_extension Extension @vk_extension{KHR,deferred_host_operations}
     */
    ThreadIdle = VK_THREAD_IDLE_KHR,

    /**
     * A deferred operation is not complete but there is no work remaining to
     * assign to additional threads.
     * @requires_vk_extension Extension @vk_extension{KHR,deferred_host_operations}
     */
    ThreadDone = VK_THREAD_DONE_KHR,

    /**
     * A deferred operation was requested and at least some of the work was
     * deferred.
     * @requires_vk_extension Extension @vk_extension{KHR,deferred_host_operations}
     */
    OperationDeferred = VK_OPERATION_DEFERRED_KHR,

    /**
     * A deferred operation was requested and no operations were deferred.
     * @requires_vk_extension Extension @vk_extension{KHR,deferred_host_operations}
     */
    OperationNotDeferred = VK_OPERATION_NOT_DEFERRED_KHR,

    /**
     * A host memory allocation has failed.
     * @see @ref Result::ErrorOutOfDeviceMemory,
     *      @ref Result::ErrorOutOfPoolMemory
     */
    ErrorOutOfHostMemory = VK_ERROR_OUT_OF_HOST_MEMORY,

    /**
     * A device memory allocation has failed.
     * @see @ref Result::ErrorOutOfHostMemory,
     *      @ref Result::ErrorOutOfPoolMemory
     */
    ErrorOutOfDeviceMemory = VK_ERROR_OUT_OF_DEVICE_MEMORY,

    /**
     * Initialization of an object could not be completed for
     * implementation-specific reasons
     */
    ErrorInitializationFailed = VK_ERROR_INITIALIZATION_FAILED,

    /** The logical or physical device has been lost */
    ErrorDeviceLost = VK_ERROR_DEVICE_LOST,

    /** Mapping of a memory object has failed */
    ErrorMemoryMapFailed = VK_ERROR_MEMORY_MAP_FAILED,

    /** A requested layer is not present or could not be loaded */
    ErrorLayerNotPresent = VK_ERROR_LAYER_NOT_PRESENT,

    /** A requested extension is not supported */
    ErrorExtensionNotPresent = VK_ERROR_EXTENSION_NOT_PRESENT,

    /** A requested feature is not supported */
    ErrorFeatureNotPresent = VK_ERROR_FEATURE_NOT_PRESENT,

    /**
     * The requested version of Vulkan is not supported by the driver or is
     * otherwise incompatible for implementation-specific reasons
     */
    ErrorIncompatibleDriver = VK_ERROR_INCOMPATIBLE_DRIVER,

    /** Too many objects of the type have already been created */
    ErrorTooManyObjects = VK_ERROR_TOO_MANY_OBJECTS,

    /** A requested format is not supported on this device */
    ErrorFormatNotSupported = VK_ERROR_FORMAT_NOT_SUPPORTED,

    /**
     * A pool allocation has failed due to fragmentation of the pool's memory.
     * @see @ref DescriptorPool::allocate(),
     *      @ref DescriptorPoolCreateInfo::Flag::FreeDescriptorSet
     */
    ErrorFragmentedPool = VK_ERROR_FRAGMENTED_POOL,

    /**
     * An unknown error has occurred; either the application has provided
     * invalid input, or an implementation failure has occurred
     */
    ErrorUnknown = VK_ERROR_UNKNOWN,

    /**
     * A pool memory allocation has failed.
     * @see @ref Result::ErrorOutOfHostMemory,
     *      @ref Result::ErrorOutOfDeviceMemory,
     *      @ref DescriptorPool::allocate()
     * @requires_vk11 Extension @vk_extension{KHR,maintenance1}
     */
    ErrorOutOfPoolMemory = VK_ERROR_OUT_OF_POOL_MEMORY,

    /**
     * An external handle is not a valid handle of the specified type.
     * @requires_vk11 Extension @vk_extension{KHR,external_memory}
     */
    ErrorInvalidExternalHandle = VK_ERROR_INVALID_EXTERNAL_HANDLE,

    /**
     * A descriptor pool creation has failed due to fragmentation.
     * @requires_vk12 Extension @vk_extension{EXT,descriptor_indexing}
     */
    ErrorFragmentation = VK_ERROR_FRAGMENTATION,

    /**
     * A buffer creation or memory allocation failed because the requested
     * address is not available. A shader group handle assignment failed
     * because the requested shader group handle information is no longer
     * valid.
     * @requires_vk12 Extension @vk_extension{EXT,buffer_device_address}
     */
    ErrorInvalidOpaqueCaptureAddress = VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS,

    /**
     * Validation failed.
     * @todoc it's nice that docs for deprecated extensions are GONE from the
     *      spec, how the fuck am I supposed to support these on old devices
     *      then?!
     * @requires_vk_extension Extension @vk_extension{EXT,debug_report}
     */
    ErrorValidationFailed = VK_ERROR_VALIDATION_FAILED_EXT
};

/**
@debugoperatorenum{Result}
@m_since_latest
*/
MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, Result value);

}}

#endif