Shader.h

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  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.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */
 
#pragma once
 
 
#include "../../../Primitives/interface/FileStream.h"
#include "../../../Primitives/interface/FlagEnum.h"
#include "DeviceObject.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {2989B45C-143D-4886-B89C-C3271C2DCC5D}
static const INTERFACE_ID IID_Shader =
    {0x2989b45c, 0x143d, 0x4886, {0xb8, 0x9c, 0xc3, 0x27, 0x1c, 0x2d, 0xcc, 0x5d}};
 
// clang-format off
 
DILIGENT_TYPED_ENUM(SHADER_SOURCE_LANGUAGE, Uint32)
{
    SHADER_SOURCE_LANGUAGE_DEFAULT = 0,
 
    SHADER_SOURCE_LANGUAGE_HLSL,
 
    SHADER_SOURCE_LANGUAGE_GLSL,
 
    SHADER_SOURCE_LANGUAGE_MSL,
 
 
    SHADER_SOURCE_LANGUAGE_GLSL_VERBATIM
};
 
 
DILIGENT_TYPED_ENUM(SHADER_COMPILER, Uint32)
{
    SHADER_COMPILER_DEFAULT = 0,
 
    SHADER_COMPILER_GLSLANG,
 
    SHADER_COMPILER_DXC,
        
    SHADER_COMPILER_FXC,
 
    SHADER_COMPILER_LAST = SHADER_COMPILER_FXC
};
 
 
DILIGENT_TYPED_ENUM(CREATE_SHADER_SOURCE_INPUT_STREAM_FLAGS, Uint32)
{
    CREATE_SHADER_SOURCE_INPUT_STREAM_FLAG_NONE = 0x00,
 
    CREATE_SHADER_SOURCE_INPUT_STREAM_FLAG_SILENT = 0x01,
};
DEFINE_FLAG_ENUM_OPERATORS(CREATE_SHADER_SOURCE_INPUT_STREAM_FLAGS);
 
struct ShaderDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    SHADER_TYPE ShaderType DEFAULT_INITIALIZER(SHADER_TYPE_UNKNOWN);
};
typedef struct ShaderDesc ShaderDesc;
 
// clang-format on
 
// {3EA98781-082F-4413-8C30-B9BA6D82DBB7}
static const INTERFACE_ID IID_IShaderSourceInputStreamFactory =
    {0x3ea98781, 0x82f, 0x4413, {0x8c, 0x30, 0xb9, 0xba, 0x6d, 0x82, 0xdb, 0xb7}};
 
 
// clang-format off
 
#define DILIGENT_INTERFACE_NAME IShaderSourceInputStreamFactory
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IShaderSourceInputStreamFactoryInclusiveMethods \
    IObjectInclusiveMethods;                            \
    IShaderSourceInputStreamFactoryMethods ShaderSourceInputStreamFactory
 
DILIGENT_BEGIN_INTERFACE(IShaderSourceInputStreamFactory, IObject)
{
    VIRTUAL void METHOD(CreateInputStream)(THIS_
                                           const Char*   Name,
                                           IFileStream** ppStream) PURE;
 
    VIRTUAL void METHOD(CreateInputStream2)(THIS_
                                            const Char*                             Name,
                                            CREATE_SHADER_SOURCE_INPUT_STREAM_FLAGS Flags,
                                            IFileStream**                           ppStream) PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format on
 
#    define IShaderSourceInputStreamFactory_CreateInputStream(This, ...)  CALL_IFACE_METHOD(ShaderSourceInputStreamFactory, CreateInputStream, This, __VA_ARGS__)
#    define IShaderSourceInputStreamFactory_CreateInputStream2(This, ...) CALL_IFACE_METHOD(ShaderSourceInputStreamFactory, CreateInputStream2, This, __VA_ARGS__)
 
#endif
 
 
struct ShaderMacro
{
    const Char* Name       DEFAULT_INITIALIZER(nullptr);
    const Char* Definition DEFAULT_INITIALIZER(nullptr);
 
#if DILIGENT_CPP_INTERFACE
    ShaderMacro() noexcept
    {}
    ShaderMacro(const Char* _Name,
                const Char* _Def) noexcept :
        Name{_Name},
        Definition{_Def}
    {}
#endif
};
typedef struct ShaderMacro ShaderMacro;
 
struct ShaderVersion
{
    Uint8 Major DEFAULT_INITIALIZER(0);
 
    Uint8 Minor DEFAULT_INITIALIZER(0);
 
#if DILIGENT_CPP_INTERFACE
    ShaderVersion() noexcept
    {}
    ShaderVersion(Uint8 _Major, Uint8 _Minor) noexcept :
        Major{_Major},
        Minor{_Minor}
    {}
 
    bool operator==(const ShaderVersion& rhs) const
    {
        return Major == rhs.Major && Minor == rhs.Minor;
    }
 
    bool operator>(const ShaderVersion& rhs) const
    {
        return Major == rhs.Major ? Minor > rhs.Minor : Major > rhs.Major;
    }
 
    bool operator>=(const ShaderVersion& rhs) const
    {
        return Major == rhs.Major ? Minor >= rhs.Minor : Major >= rhs.Major;
    }
 
    bool operator<(const ShaderVersion& rhs) const
    {
        return Major == rhs.Major ? Minor < rhs.Minor : Major < rhs.Major;
    }
 
    bool operator<=(const ShaderVersion& rhs) const
    {
        return Major == rhs.Major ? Minor <= rhs.Minor : Major <= rhs.Major;
    }
#endif
};
typedef struct ShaderVersion ShaderVersion;
 
 
// clang-format off
 
DILIGENT_TYPED_ENUM(SHADER_COMPILE_FLAGS, Uint32)
{
    SHADER_COMPILE_FLAG_NONE = 0x0,
 
    SHADER_COMPILE_FLAG_ENABLE_UNBOUNDED_ARRAYS = 0x01,
 
    SHADER_COMPILE_FLAG_LAST = SHADER_COMPILE_FLAG_ENABLE_UNBOUNDED_ARRAYS
};
DEFINE_FLAG_ENUM_OPERATORS(SHADER_COMPILE_FLAGS);
 
// clang-format on
 
 
struct ShaderCreateInfo
{
 
    const Char* FilePath DEFAULT_INITIALIZER(nullptr);
 
 
    IShaderSourceInputStreamFactory* pShaderSourceStreamFactory DEFAULT_INITIALIZER(nullptr);
 
 
    struct IHLSL2GLSLConversionStream** ppConversionStream DEFAULT_INITIALIZER(nullptr);
 
 
    const Char* Source DEFAULT_INITIALIZER(nullptr);
 
 
    const void* ByteCode DEFAULT_INITIALIZER(nullptr);
 
 
    size_t ByteCodeSize DEFAULT_INITIALIZER(0);
 
 
    const Char* EntryPoint DEFAULT_INITIALIZER("main");
 
 
    const ShaderMacro* Macros DEFAULT_INITIALIZER(nullptr);
 
    bool UseCombinedTextureSamplers DEFAULT_INITIALIZER(false);
 
    const Char* CombinedSamplerSuffix DEFAULT_INITIALIZER("_sampler");
 
    ShaderDesc Desc;
 
    SHADER_SOURCE_LANGUAGE SourceLanguage DEFAULT_INITIALIZER(SHADER_SOURCE_LANGUAGE_DEFAULT);
 
    SHADER_COMPILER ShaderCompiler DEFAULT_INITIALIZER(SHADER_COMPILER_DEFAULT);
 
    ShaderVersion HLSLVersion DEFAULT_INITIALIZER({});
 
    ShaderVersion GLSLVersion DEFAULT_INITIALIZER({});
 
    ShaderVersion GLESSLVersion DEFAULT_INITIALIZER({});
 
    SHADER_COMPILE_FLAGS CompileFlags DEFAULT_INITIALIZER(SHADER_COMPILE_FLAG_NONE);
 
 
    IDataBlob** ppCompilerOutput DEFAULT_INITIALIZER(nullptr);
};
typedef struct ShaderCreateInfo ShaderCreateInfo;
 
// clang-format off
DILIGENT_TYPED_ENUM(SHADER_RESOURCE_TYPE, Uint8)
{
    SHADER_RESOURCE_TYPE_UNKNOWN = 0,
 
    SHADER_RESOURCE_TYPE_CONSTANT_BUFFER,
 
    SHADER_RESOURCE_TYPE_TEXTURE_SRV,
 
    SHADER_RESOURCE_TYPE_BUFFER_SRV,
 
    SHADER_RESOURCE_TYPE_TEXTURE_UAV,
 
    SHADER_RESOURCE_TYPE_BUFFER_UAV,
 
    SHADER_RESOURCE_TYPE_SAMPLER,
 
    SHADER_RESOURCE_TYPE_INPUT_ATTACHMENT,
 
    SHADER_RESOURCE_TYPE_ACCEL_STRUCT,
    
    SHADER_RESOURCE_TYPE_LAST = SHADER_RESOURCE_TYPE_ACCEL_STRUCT
};
// clang-format on
 
struct ShaderResourceDesc
{
#if DILIGENT_CPP_INTERFACE
    ShaderResourceDesc() noexcept
    {}
 
    ShaderResourceDesc(const char*          _Name,
                       SHADER_RESOURCE_TYPE _Type,
                       Uint32               _ArraySize) noexcept :
        Name{_Name},
        Type{_Type},
        ArraySize{_ArraySize}
    {}
#endif
 
    // clang-format off
    const char*          Name      DEFAULT_INITIALIZER(nullptr);
 
    SHADER_RESOURCE_TYPE Type      DEFAULT_INITIALIZER(SHADER_RESOURCE_TYPE_UNKNOWN);
 
    Uint32               ArraySize DEFAULT_INITIALIZER(0);
    // clang-format on
};
typedef struct ShaderResourceDesc ShaderResourceDesc;
 
#define DILIGENT_INTERFACE_NAME IShader
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IShaderInclusiveMethods    \
    IDeviceObjectInclusiveMethods; \
    IShaderMethods Shader
 
// clang-format off
 
DILIGENT_BEGIN_INTERFACE(IShader, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const ShaderDesc& METHOD(GetDesc)() const override = 0;
#endif
 
    VIRTUAL Uint32 METHOD(GetResourceCount)(THIS) CONST PURE;
 
    VIRTUAL void METHOD(GetResourceDesc)(THIS_
                                         Uint32 Index,
                                         ShaderResourceDesc REF ResourceDesc) CONST PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IShader_GetDesc(This) (const struct ShaderDesc*)IDeviceObject_GetDesc(This)
 
#    define IShader_GetResourceCount(This)     CALL_IFACE_METHOD(Shader, GetResourceCount, This)
#    define IShader_GetResourceDesc(This, ...) CALL_IFACE_METHOD(Shader, GetResourceDesc,  This, __VA_ARGS__)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent