Renderer/Pipelines/PipelineSystem.h¶
Public include <Renderer/Pipelines/PipelineSystem.h>. SnBuild module Pipelines.
SnAPI::Renderer::PipelineSystem¶
class SnAPI::Renderer::PipelineSystem
SnAPI::Renderer::PipelineSystem::PipelineSystem¶
explicit SnAPI::Renderer::PipelineSystem::PipelineSystem(IPipelineSystem &pipelineObjects)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::IPipelineSystem.
SnAPI::Renderer::PipelineSystem::ImportNativeCache¶
TResult< void > SnAPI::Renderer::PipelineSystem::ImportNativeCache(std::span< const std::byte > bytes)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::CopyNativeCache¶
TResult< std::vector< std::byte > > SnAPI::Renderer::PipelineSystem::CopyNativeCache() const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::CopyExecutableStatistics¶
TResult< std::vector< PipelineExecutableStatistics > > SnAPI::Renderer::PipelineSystem::CopyExecutableStatistics(EPipelineKind kind, PipelineHandle pipeline) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::EPipelineKind, SnAPI::Renderer::PipelineExecutableStatistics, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::CopyComputePipelineRecords¶
TResult< std::vector< ComputePipelineRecord > > SnAPI::Renderer::PipelineSystem::CopyComputePipelineRecords() const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ComputePipelineRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::CopyRasterPipelineRecords¶
TResult< std::vector< RasterPipelineRecord > > SnAPI::Renderer::PipelineSystem::CopyRasterPipelineRecords() const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::RasterPipelineRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::CopyRayTracingPipelineRecords¶
TResult< std::vector< RayTracingPipelineRecord > > SnAPI::Renderer::PipelineSystem::CopyRayTracingPipelineRecords() const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::RayTracingPipelineRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::BuildComputeDesc¶
TResult< ComputePipelineDesc > SnAPI::Renderer::PipelineSystem::BuildComputeDesc(const ShaderProgramBundle &shaderProgramBundle) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ComputePipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateComputePipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::FindOrCreateComputePipeline(const ShaderProgramBundle &shaderProgramBundle)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::BuildRasterDesc¶
TResult< RasterPipelineDesc > SnAPI::Renderer::PipelineSystem::BuildRasterDesc(const ShaderProgramBundle &vertexShaderProgramBundle, const ShaderProgramBundle &fragmentShaderProgramBundle, std::vector< ETextureFormat > colorFormats, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true, bool enableColorWrite=true, ERasterColorBlendMode colorBlendMode=ERasterColorBlendMode::Disabled, bool reverseZ=true) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterColorBlendMode, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::RasterPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::BuildVertexOnlyRasterDesc¶
TResult< RasterPipelineDesc > SnAPI::Renderer::PipelineSystem::BuildVertexOnlyRasterDesc(const ShaderProgramBundle &vertexShaderProgramBundle, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::RasterPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::BuildRasterDesc¶
TResult< RasterPipelineDesc > SnAPI::Renderer::PipelineSystem::BuildRasterDesc(const ShaderProgramBundle &vertexShaderProgramBundle, const ShaderProgramBundle &fragmentShaderProgramBundle, ETextureFormat colorFormat, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true, bool enableColorWrite=true, ERasterColorBlendMode colorBlendMode=ERasterColorBlendMode::Disabled, bool reverseZ=true) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterColorBlendMode, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::RasterPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipeline(const ShaderProgramBundle &vertexShaderProgramBundle, const ShaderProgramBundle &fragmentShaderProgramBundle, std::vector< ETextureFormat > colorFormats, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true, bool enableColorWrite=true, ERasterColorBlendMode colorBlendMode=ERasterColorBlendMode::Disabled, bool reverseZ=true)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterColorBlendMode, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::FindOrCreateVertexOnlyRasterPipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::FindOrCreateVertexOnlyRasterPipeline(const ShaderProgramBundle &vertexShaderProgramBundle, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::BuildObjectPassRasterDesc¶
TResult< RasterPipelineDesc > SnAPI::Renderer::PipelineSystem::BuildObjectPassRasterDesc(const ObjectPassRasterPipelineRequest &request) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ObjectPassRasterPipelineRequest, SnAPI::Renderer::RasterPipelineDesc, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateObjectPassRasterPipeline¶
TResult< ObjectPassRasterPipelineResolution > SnAPI::Renderer::PipelineSystem::FindOrCreateObjectPassRasterPipeline(const ObjectPassRasterPipelineRequest &request)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ObjectPassRasterPipelineRequest, SnAPI::Renderer::ObjectPassRasterPipelineResolution, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindObjectPassRasterPipeline¶
TResult< ObjectPassRasterPipelineResolution > SnAPI::Renderer::PipelineSystem::FindObjectPassRasterPipeline(const ObjectPassRasterPipelineRequest &request) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ObjectPassRasterPipelineRequest, SnAPI::Renderer::ObjectPassRasterPipelineResolution, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::PrepareObjectPassRasterPipelineAsync¶
template <SnAPI::Core::TExecutor TOwnerExecutor>
SnAPI::Core::TTask< TResult< ObjectPassRasterPipelineResolution > > SnAPI::Renderer::PipelineSystem::PrepareObjectPassRasterPipelineAsync(ObjectPassRasterPipelineRequest request, SnAPI::Core::TExecutorRef< SnAPI::Core::WorkerPoolExecutor > workers, SnAPI::Core::TExecutorRef< TOwnerExecutor > owner, SnAPI::Core::CancellationToken cancellation={}, bool requireCacheHit=false)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ObjectPassRasterPipelineRequest, SnAPI::Renderer::ObjectPassRasterPipelineResolution, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateRayTracingPipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::FindOrCreateRayTracingPipeline(const RayTracingPipelineDesc &rayTracingPipelineDesc, std::span< const ShaderProgramBundle > shaderProgramBundles)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::RayTracingPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipeline(const ShaderProgramBundle &vertexShaderProgramBundle, const ShaderProgramBundle &fragmentShaderProgramBundle, ETextureFormat colorFormat, bool useDepth=false, ETextureFormat depthFormat=ETextureFormat::Depth32Float, bool usesVertexBuffer=false, std::uint32_t vertexStrideBytes=0, std::optional< VertexLayoutDesc > vertexLayoutOverride=std::nullopt, ERasterCullMode cullMode=ERasterCullMode::Back, ERasterFrontFace frontFace=ERasterFrontFace::CounterClockwise, ERasterFillMode fillMode=ERasterFillMode::Fill, bool enableDepthTest=true, bool enableDepthWrite=true, bool enableColorWrite=true, ERasterColorBlendMode colorBlendMode=ERasterColorBlendMode::Disabled, bool reverseZ=true)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ERasterColorBlendMode, SnAPI::Renderer::ERasterCullMode, SnAPI::Renderer::ERasterFillMode, SnAPI::Renderer::ERasterFrontFace, SnAPI::Renderer::ETextureFormat, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult, SnAPI::Renderer::VertexLayoutDesc.
SnAPI::Renderer::PipelineSystem::FindComputePipeline¶
TResult< ComputePipelineRecord > SnAPI::Renderer::PipelineSystem::FindComputePipeline(PipelineHandle pipeline) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ComputePipelineRecord, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::DestroyComputePipeline¶
TResult< void > SnAPI::Renderer::PipelineSystem::DestroyComputePipeline(PipelineHandle pipeline)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindRasterPipeline¶
TResult< RasterPipelineRecord > SnAPI::Renderer::PipelineSystem::FindRasterPipeline(PipelineHandle pipeline) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::RasterPipelineRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::DestroyRasterPipeline¶
TResult< void > SnAPI::Renderer::PipelineSystem::DestroyRasterPipeline(PipelineHandle pipeline)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindRayTracingPipeline¶
TResult< RayTracingPipelineRecord > SnAPI::Renderer::PipelineSystem::FindRayTracingPipeline(PipelineHandle pipeline) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::RayTracingPipelineRecord, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::DestroyRayTracingPipeline¶
TResult< void > SnAPI::Renderer::PipelineSystem::DestroyRayTracingPipeline(PipelineHandle pipeline)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::Contains¶
bool SnAPI::Renderer::PipelineSystem::Contains(const ComputePipelineDesc &computePipelineDesc) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ComputePipelineDesc.
SnAPI::Renderer::PipelineSystem::Contains¶
bool SnAPI::Renderer::PipelineSystem::Contains(const RayTracingPipelineDesc &rayTracingPipelineDesc) const
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::RayTracingPipelineDesc.
SnAPI::Renderer::PipelineSystem::ComputePipelineCount¶
std::size_t SnAPI::Renderer::PipelineSystem::ComputePipelineCount() const
See also SnAPI::Renderer::PipelineSystem.
SnAPI::Renderer::PipelineSystem::RasterPipelineCount¶
std::size_t SnAPI::Renderer::PipelineSystem::RasterPipelineCount() const
See also SnAPI::Renderer::PipelineSystem.
SnAPI::Renderer::PipelineSystem::RayTracingPipelineCount¶
std::size_t SnAPI::Renderer::PipelineSystem::RayTracingPipelineCount() const
See also SnAPI::Renderer::PipelineSystem.
SnAPI::Renderer::PipelineSystem::FindOrCreateComputePipelineAsync¶
template <SnAPI::Core::TExecutor TOwnerExecutor>
SnAPI::Core::TTask< TResult< PipelineHandle > > SnAPI::Renderer::PipelineSystem::FindOrCreateComputePipelineAsync(ComputePipelineDesc desc, ShaderProgramBundle shader, SnAPI::Core::TExecutorRef< SnAPI::Core::WorkerPoolExecutor > workers, SnAPI::Core::TExecutorRef< TOwnerExecutor > owner, SnAPI::Core::CancellationToken cancellation={})
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::ComputePipelineDesc, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipelineAsync¶
template <SnAPI::Core::TExecutor TOwnerExecutor>
SnAPI::Core::TTask< TResult< PipelineHandle > > SnAPI::Renderer::PipelineSystem::FindOrCreateRasterPipelineAsync(RasterPipelineDesc desc, ShaderProgramBundle vertex, std::optional< ShaderProgramBundle > fragment, SnAPI::Core::TExecutorRef< SnAPI::Core::WorkerPoolExecutor > workers, SnAPI::Core::TExecutorRef< TOwnerExecutor > owner, SnAPI::Core::CancellationToken cancellation={}, bool requireCacheHit=false)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::RasterPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::FindOrCreateRayTracingPipelineAsync¶
template <SnAPI::Core::TExecutor TOwnerExecutor>
SnAPI::Core::TTask< TResult< PipelineHandle > > SnAPI::Renderer::PipelineSystem::FindOrCreateRayTracingPipelineAsync(RayTracingPipelineDesc desc, std::vector< ShaderProgramBundle > shaders, SnAPI::Core::TExecutorRef< SnAPI::Core::WorkerPoolExecutor > workers, SnAPI::Core::TExecutorRef< TOwnerExecutor > owner, SnAPI::Core::CancellationToken cancellation={})
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::RayTracingPipelineDesc, SnAPI::Renderer::ShaderProgramBundle, SnAPI::Renderer::TResult.
SnAPI::Renderer::PipelineSystem::PublishPreparedPipeline¶
TResult< PipelineHandle > SnAPI::Renderer::PipelineSystem::PublishPreparedPipeline(IPipelinePreparation &preparation)
See also SnAPI::Renderer::PipelineSystem, SnAPI::Renderer::IPipelinePreparation, SnAPI::Renderer::PipelineHandle, SnAPI::Renderer::TResult.