magnum/src/Magnum/Vk/Shader.h

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

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021, 2022, 2023 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 Class @ref Magnum::Vk::Shader, enum @ref Magnum::Vk::ShaderStage, enum set @ref Magnum::Vk::ShaderStages
 * @m_since_latest
 */

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

namespace Magnum { namespace Vk {

namespace Implementation { struct DeviceState; }

/**
@brief Shader stage
@m_since_latest

Wraps @type_vk_keyword{ShaderStageFlagBits}.
@m_enum_values_as_keywords
@see @ref ShaderStages, @ref ShaderSet::addShader()
*/
enum class ShaderStage: UnsignedInt {
    /** Vertex stage */
    Vertex = VK_SHADER_STAGE_VERTEX_BIT,

    /** Fragment stage */
    Fragment = VK_SHADER_STAGE_FRAGMENT_BIT,

    /**
     * Geometry stage
     * @requires_vk_feature @ref DeviceFeature::GeometryShader
     */
    Geometry = VK_SHADER_STAGE_GEOMETRY_BIT,

    /**
     * Tessellation control stage
     * @requires_vk_feature @ref DeviceFeature::TessellationShader
     */
    TessellationControl = VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT,

    /**
     * Tessellation evaluation stage
     * @requires_vk_feature @ref DeviceFeature::TessellationShader
     */
    TessellationEvaluation = VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT,

    /** Compute stage */
    Compute = VK_SHADER_STAGE_COMPUTE_BIT,

    /**
     * Ray generation stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayGeneration = VK_SHADER_STAGE_RAYGEN_BIT_KHR,

    /**
     * Ray any hit stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayAnyHit = VK_SHADER_STAGE_ANY_HIT_BIT_KHR,

    /**
     * Ray closest hit stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayClosestHit = VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR,

    /**
     * Ray miss stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayMiss = VK_SHADER_STAGE_MISS_BIT_KHR,

    /**
     * Ray intersection stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayIntersection = VK_SHADER_STAGE_INTERSECTION_BIT_KHR,

    /**
     * Ray callable stage
     * @requires_vk_feature @ref DeviceFeature::RayTracingPipeline
     */
    RayCallable = VK_SHADER_STAGE_CALLABLE_BIT_KHR
};

/**
@brief Shader stages
@m_since_latest

Type-safe wrapper for @type_vk_keyword{ShaderStageFlags}. Note that
@cpp ~Vk::ShaderStages{} @ce can be used for @val_vk_keyword{SHADER_STAGE_ALL,ShaderStageFlagBits}.
*/
typedef Containers::EnumSet<ShaderStage, VK_SHADER_STAGE_ALL> ShaderStages;

CORRADE_ENUMSET_OPERATORS(ShaderStages)

/**
@brief Shader
@m_since_latest

Wraps a @type_vk_keyword{ShaderModule}, which contains a SPIR-V binary with one
or more shader entrypoints.

@section Vk-Shader-creation Shader creation

The @ref ShaderCreateInfo structure takes a single required parameter, which is
the SPIR-V binary. Besides accepting a @ref Corrade::Containers::ArrayView<const void>,
to which any container is convertible, it can also take ownership of a
@ref Corrade::Containers::Array, which means you don't need to worry about
keeping a loaded file in scope until it's consumed by the @ref Shader
constructor:

@snippet MagnumVk.cpp Shader-creation

@see @ref CORRADE_INTERNAL_ASSERT_EXPRESSION()
*/
class MAGNUM_VK_EXPORT Shader {
    public:
        /**
         * @brief Wrap existing Vulkan handle
         * @param device    Vulkan device the shader is created on
         * @param handle    The @type_vk{ShaderModule} handle
         * @param flags     Handle flags
         *
         * The @p handle is expected to be originating from @p device. Unlike
         * a shader created using a constructor, the Vulkan shader is by
         * default not deleted on destruction, use @p flags for different
         * behavior.
         * @see @ref release()
         */
        static Shader wrap(Device& device, VkShaderModule handle, HandleFlags flags = {});

        /**
         * @brief Constructor
         * @param device    Vulkan device to create the shader on
         * @param info      Shader creation info
         *
         * @see @fn_vk_keyword{CreateShaderModule}
         */
        explicit Shader(Device& device, const ShaderCreateInfo& info);

        /**
         * @brief Construct without creating the shader
         *
         * The constructed instance is equivalent to moved-from state. Useful
         * in cases where you will overwrite the instance later anyway. Move
         * another object over it to make it useful.
         */
        explicit Shader(NoCreateT);

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

        /** @brief Move constructor */
        Shader(Shader&& other) noexcept;

        /**
         * @brief Destructor
         *
         * Destroys associated @type_vk{ShaderModule} handle, unless the
         * instance was created using @ref wrap() without
         * @ref HandleFlag::DestroyOnDestruction specified.
         * @see @fn_vk_keyword{DestroyShaderModule}, @ref release()
         */
        ~Shader();

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

        /** @brief Move assignment */
        Shader& operator=(Shader&& other) noexcept;

        /** @brief Underlying @type_vk{Buffer} handle */
        VkShaderModule handle() { return _handle; }
        /** @overload */
        operator VkShaderModule() { return _handle; }

        /** @brief Handle flags */
        HandleFlags handleFlags() const { return _flags; }

        /**
         * @brief Release the underlying Vulkan shader
         *
         * Releases ownership of the Vulkan shader and returns its handle so
         * @fn_vk{DestroyShaderModule} is not called on destruction. The
         * internal state is then equivalent to moved-from state.
         * @see @ref wrap()
         */
        VkShaderModule release();

    private:
        friend Implementation::DeviceState;

        MAGNUM_VK_LOCAL static VkResult createImplementationDefault(Device& device, const VkShaderModuleCreateInfo& info, const VkAllocationCallbacks* callbacks, VkShaderModule& handle);
        MAGNUM_VK_LOCAL static VkResult createImplementationSwiftShaderMultiEntryPointPatching(Device& device, const VkShaderModuleCreateInfo& info, const VkAllocationCallbacks* callbacks, VkShaderModule& handle);

        /* Can't be a reference because of the NoCreate constructor */
        Device* _device;

        VkShaderModule _handle;
        HandleFlags _flags;
};

}}

#endif