Renderer/Shaders/ShaderSystem.h¶
Public include <Renderer/Shaders/ShaderSystem.h>. SnBuild module Shaders.
SnAPI::Renderer::ShaderSystem¶
class SnAPI::Renderer::ShaderSystem : public SnAPI::Renderer::IShaderProgramResolver
See also SnAPI::Renderer::IShaderProgramResolver.
SnAPI::Renderer::ShaderSystem::ShaderSystem¶
explicit SnAPI::Renderer::ShaderSystem::ShaderSystem(EShaderCompilePolicy compilePolicy=RendererShaderCompilePolicyByDefault(), ShaderCompilerContextLimits compilerLimits={}) noexcept
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EShaderCompilePolicy, SnAPI::Renderer::ShaderCompilerContextLimits.
SnAPI::Renderer::ShaderSystem::~ShaderSystem¶
SnAPI::Renderer::ShaderSystem::~ShaderSystem()
See also SnAPI::Renderer::ShaderSystem.
SnAPI::Renderer::ShaderSystem::BuildVariantKey¶
ShaderVariantKey SnAPI::Renderer::ShaderSystem::BuildVariantKey(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const noexcept
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::ShadingModelDefinition.
SnAPI::Renderer::ShaderSystem::BuildVariantKey¶
TResult< ShaderVariantKey > SnAPI::Renderer::ShaderSystem::BuildVariantKey(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EMaterialDomain domain, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::EMaterialDomain, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::BuildVariantKey¶
TResult< ShaderVariantKey > SnAPI::Renderer::ShaderSystem::BuildVariantKey(const MaterialDefinition &materialDefinition, EGraphicsBackend backend) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::MaterialDefinition, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateMetadataBundle¶
TResult< ShaderMetaBundle > SnAPI::Renderer::ShaderSystem::GenerateMetadataBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderMetaBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateMetadataBundle¶
TResult< ShaderMetaBundle > SnAPI::Renderer::ShaderSystem::GenerateMetadataBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EMaterialDomain domain) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EMaterialDomain, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderMetaBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EMaterialDomain domain, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::EMaterialDomain, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateProgramBundle(const MaterialDefinition &materialDefinition, EGraphicsBackend backend) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::MaterialDefinition, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::BuildCompilationSourceText¶
TResult< std::string > SnAPI::Renderer::ShaderSystem::BuildCompilationSourceText(const ShaderProgramBundle &bundle) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::CompileModule¶
TResult< CompiledShaderModuleSet > SnAPI::Renderer::ShaderSystem::CompileModule(const ShaderModuleDefinition &module, EGraphicsBackend backend, const ShaderCompileOptions &options={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::CompiledShaderModuleSet, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderModuleDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::RegisterCompiledModuleArtifacts¶
TResult< void > SnAPI::Renderer::ShaderSystem::RegisterCompiledModuleArtifacts(std::span< const std::shared_ptr< const CompiledShaderModule > > modules) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::CompiledShaderModule, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::CopyCompiledModuleArtifacts¶
TResult< std::vector< std::shared_ptr< const CompiledShaderModule > > > SnAPI::Renderer::ShaderSystem::CopyCompiledModuleArtifacts() const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::CompiledShaderModule, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::WriteGeneratedSourceFiles¶
TResult< GeneratedShaderSourceFiles > SnAPI::Renderer::ShaderSystem::WriteGeneratedSourceFiles(const ShaderProgramBundle &bundle, const std::filesystem::path &outputDirectory, bool writeCompilationSource=true) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::GeneratedShaderSourceFiles, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::CompileGeneratedBundleToBackendBlob¶
TResult< BackendProgramBlob > SnAPI::Renderer::ShaderSystem::CompileGeneratedBundleToBackendBlob(const ShaderProgramBundle &bundle) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::BackendProgramBlob, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::CompileGeneratedBundleToBackendBlob¶
TResult< BackendProgramBlob > SnAPI::Renderer::ShaderSystem::CompileGeneratedBundleToBackendBlob(const ShaderProgramBundle &bundle, const ShaderCompileOptions &compileOptions) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::BackendProgramBlob, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle(const MaterialDefinition &materialDefinition, EGraphicsBackend backend) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::MaterialDefinition, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EGraphicsBackend backend, RendererFeatureFlags featureMask, const ShaderCompileOptions &compileOptions) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, EMaterialDomain domain, EGraphicsBackend backend, RendererFeatureFlags featureMask={}, const ShaderCompileOptions &compileOptions={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::EMaterialDomain, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::BuildVariantKey¶
TResult< ShaderVariantKey > SnAPI::Renderer::ShaderSystem::BuildVariantKey(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, const ResolvedShadingModelProgram &selectedProgram, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ResolvedShadingModelProgram, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, const ResolvedShadingModelProgram &selectedProgram, EGraphicsBackend backend, RendererFeatureFlags featureMask={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ResolvedShadingModelProgram, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::GenerateCompiledProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, const ResolvedShadingModelProgram &selectedProgram, EGraphicsBackend backend, RendererFeatureFlags featureMask={}, const ShaderCompileOptions &compileOptions={}) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ResolvedShadingModelProgram, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::ResolveProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::ResolveProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, const ResolvedShadingModelProgram &selectedProgram, EGraphicsBackend backend, RendererFeatureFlags featureMask={}, const ShaderCompileOptions &compileOptions={}) const override
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ResolvedShadingModelProgram, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::FindProgramBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::FindProgramBundle(const ShadingModelDefinition &shadingModel, const ShaderGraph &graph, const ResolvedShadingModelProgram &selectedProgram, EGraphicsBackend backend, RendererFeatureFlags featureMask={}, const ShaderCompileOptions &compileOptions={}) const override
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend, SnAPI::Renderer::RendererFeatureFlags, SnAPI::Renderer::ResolvedShadingModelProgram, SnAPI::Renderer::ShaderCompileOptions, SnAPI::Renderer::ShaderGraph, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShadingModelDefinition, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::ResolveProgramBundles¶
std::vector< TResult< ShaderProgramBundle > > SnAPI::Renderer::ShaderSystem::ResolveProgramBundles(std::span< const ShaderProgramResolveRequest > requests) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShaderProgramResolveRequest, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::CompilerStatistics¶
ShaderCompilerStatistics SnAPI::Renderer::ShaderSystem::CompilerStatistics() const noexcept
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderCompilerStatistics.
SnAPI::Renderer::ShaderSystem::CompilerBuildTag¶
std::optional< std::string > SnAPI::Renderer::ShaderSystem::CompilerBuildTag() const
See also SnAPI::Renderer::ShaderSystem.
SnAPI::Renderer::ShaderSystem::FinalProgramArtifactCompatibility¶
std::optional< std::string > SnAPI::Renderer::ShaderSystem::FinalProgramArtifactCompatibility(EGraphicsBackend backend) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::EGraphicsBackend.
SnAPI::Renderer::ShaderSystem::RegisterGeneratedBundle¶
TResult< void > SnAPI::Renderer::ShaderSystem::RegisterGeneratedBundle(ShaderProgramBundle bundle)
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::RegisterPrecompiledVariant¶
TResult< void > SnAPI::Renderer::ShaderSystem::RegisterPrecompiledVariant(PrecompiledShaderVariantRecord record)
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::PrecompiledShaderVariantRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::ValidatePrecompiledVariant¶
static TResult< PrecompiledShaderVariantRecord > SnAPI::Renderer::ShaderSystem::ValidatePrecompiledVariant(PrecompiledShaderVariantRecord record)
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::PrecompiledShaderVariantRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::FindGeneratedBundle¶
TResult< ShaderProgramBundle > SnAPI::Renderer::ShaderSystem::FindGeneratedBundle(const ShaderVariantKey &key) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::FindPrecompiledVariant¶
TResult< PrecompiledShaderVariantRecord > SnAPI::Renderer::ShaderSystem::FindPrecompiledVariant(const ShaderVariantKey &key) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::PrecompiledShaderVariantRecord, SnAPI::Renderer::ShaderVariantKey, SnAPI::Renderer::TResult.
SnAPI::Renderer::ShaderSystem::Contains¶
bool SnAPI::Renderer::ShaderSystem::Contains(const ShaderVariantKey &key) const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::ShaderVariantKey.
SnAPI::Renderer::ShaderSystem::GeneratedBundleCount¶
std::size_t SnAPI::Renderer::ShaderSystem::GeneratedBundleCount() const
See also SnAPI::Renderer::ShaderSystem.
SnAPI::Renderer::ShaderSystem::PrecompiledVariantCount¶
std::size_t SnAPI::Renderer::ShaderSystem::PrecompiledVariantCount() const
See also SnAPI::Renderer::ShaderSystem.
SnAPI::Renderer::ShaderSystem::CopyCompiledProgramArtifacts¶
TResult< std::vector< PrecompiledShaderVariantRecord > > SnAPI::Renderer::ShaderSystem::CopyCompiledProgramArtifacts() const
See also SnAPI::Renderer::ShaderSystem, SnAPI::Renderer::PrecompiledShaderVariantRecord, SnAPI::Renderer::TResult.