Diligent Engine  v.2.4.g
ShaderToolsCommon.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 Diligent Graphics LLC
3  * Copyright 2015-2019 Egor Yusov
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * In no event and under no legal theory, whether in tort (including negligence),
18  * contract, or otherwise, unless required by applicable law (such as deliberate
19  * and grossly negligent acts) or agreed to in writing, shall any Contributor be
20  * liable for any damages, including any direct, indirect, special, incidental,
21  * or consequential damages of any character arising as a result of this License or
22  * out of the use or inability to use the software (including but not limited to damages
23  * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
24  * all other commercial damages or losses), even if such Contributor has been advised
25  * of the possibility of such damages.
26  */
27 
28 #pragma once
29 
30 #include "GraphicsTypes.h"
31 #include "Shader.h"
32 #include "RefCntAutoPtr.hpp"
33 #include "DataBlob.h"
34 
35 namespace Diligent
36 {
37 
48 
49 
55 void AppendShaderMacros(std::string& Source, const ShaderMacro* Macros);
56 
57 
68 void AppendShaderTypeDefinitions(std::string& Source, SHADER_TYPE Type);
69 
70 
72 const char* ReadShaderSourceFile(const char* SourceCode,
73  IShaderSourceInputStreamFactory* pShaderSourceStreamFactory,
74  const char* FilePath,
75  RefCntAutoPtr<IDataBlob>& pFileData,
76  size_t& SourceCodeLen) noexcept(false);
77 
79 void AppendShaderSourceCode(std::string& Source, const ShaderCreateInfo& ShaderCI) noexcept(false);
80 
81 
82 } // namespace Diligent
Diligent::SHADER_TYPE
SHADER_TYPE
Describes the shader type.
Definition: GraphicsTypes.h:65
Shader.h
Diligent::ReadShaderSourceFile
const char * ReadShaderSourceFile(const char *SourceCode, IShaderSourceInputStreamFactory *pShaderSourceStreamFactory, const char *FilePath, RefCntAutoPtr< IDataBlob > &pFileData, size_t &SourceCodeLen) noexcept(false)
Reads shader source code from a file or uses the one from the shader create info.
Definition: ShaderToolsCommon.cpp:103
Diligent::AppendShaderTypeDefinitions
void AppendShaderTypeDefinitions(std::string &Source, SHADER_TYPE Type)
Appends the shader type definition macro(s), e.g., for a vertex shader:
Definition: ShaderToolsCommon.cpp:97
DataBlob.h
Diligent::ShaderMacro
struct ShaderMacro ShaderMacro
Definition: Shader.h:174
Type
const D3D12_PIPELINE_STATE_SUBOBJECT_TYPE Type
Definition: PipelineStateD3D12Impl.cpp:69
Diligent::ShaderCreateInfo
struct ShaderCreateInfo ShaderCreateInfo
Definition: Shader.h:352
Diligent::AppendShaderMacros
void AppendShaderMacros(std::string &Source, const ShaderMacro *Macros)
Appends shader macro definitions to the end of the source string:
Definition: ShaderToolsCommon.cpp:82
Diligent::AppendShaderSourceCode
void AppendShaderSourceCode(std::string &Source, const ShaderCreateInfo &ShaderCI) noexcept(false)
Appends shader source code to the source string.
Definition: ShaderToolsCommon.cpp:145
RefCntAutoPtr.hpp
GraphicsTypes.h
Diligent::GetShaderTypeMacros
const ShaderMacro * GetShaderTypeMacros(SHADER_TYPE Type)
Returns shader type definition macro(s), e.g., for a vertex shader:
Definition: ShaderToolsCommon.cpp:55
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37