Development

Renderer/PassCore/Passes/Contexts/PassSetupContext.h

Public include <Renderer/PassCore/Passes/Contexts/PassSetupContext.h>. SnBuild module PassCore.

SnAPI::Renderer::PassSetupContext

class SnAPI::Renderer::PassSetupContext

SnAPI::Renderer::PassSetupContext::PassSetupContext

SnAPI::Renderer::PassSetupContext::PassSetupContext(PassExecutionServices &services, const CompiledFrameGraphPass &pass, const RenderView &view, const FrameGraphExecutionResources &resources, FrameGraphPassCommands &commands)

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::CompiledFrameGraphPass, SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphPassCommands, SnAPI::Renderer::PassExecutionServices, SnAPI::Renderer::RenderView.

SnAPI::Renderer::PassSetupContext::RecordFailure

void SnAPI::Renderer::PassSetupContext::RecordFailure(RendererError error) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::RendererError.

SnAPI::Renderer::PassSetupContext::Services

PassExecutionServices & SnAPI::Renderer::PassSetupContext::Services() const noexcept

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::PassExecutionServices.

SnAPI::Renderer::PassSetupContext::Pass

const CompiledFrameGraphPass & SnAPI::Renderer::PassSetupContext::Pass() const noexcept

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::CompiledFrameGraphPass.

SnAPI::Renderer::PassSetupContext::View

const RenderView & SnAPI::Renderer::PassSetupContext::View() const noexcept

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::RenderView.

SnAPI::Renderer::PassSetupContext::Resources

const FrameGraphExecutionResources & SnAPI::Renderer::PassSetupContext::Resources() const noexcept

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphExecutionResources.

SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan

TResult< MaterialDescriptorPlan > SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::span< const FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::span< const FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings={}) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan

TResult< MaterialDescriptorPlan > SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::span< const FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::span< const FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings, std::span< const FrameGraphSampledTextureBindingOverride > sampledTextureBindings, std::span< const FrameGraphStorageTextureBindingOverride > storageTextureBindings, std::span< const FrameGraphConstantBufferBindingOverride > constantBufferBindings={}) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphConstantBufferBindingOverride, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphSampledTextureBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageTextureBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan

TResult< MaterialDescriptorPlan > SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::initializer_list< FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::initializer_list< FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings={}) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan

TResult< MaterialDescriptorPlan > SnAPI::Renderer::PassSetupContext::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::initializer_list< FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::initializer_list< FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings, std::initializer_list< FrameGraphSampledTextureBindingOverride > sampledTextureBindings, std::initializer_list< FrameGraphStorageTextureBindingOverride > storageTextureBindings, std::initializer_list< FrameGraphConstantBufferBindingOverride > constantBufferBindings={}) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphConstantBufferBindingOverride, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphSampledTextureBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageTextureBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::Commands

FrameGraphPassCommands & SnAPI::Renderer::PassSetupContext::Commands() const noexcept

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphPassCommands.

SnAPI::Renderer::PassSetupContext::ImportTexture

TResult< std::optional< FrameGraphExternalTextureBinding > > SnAPI::Renderer::PassSetupContext::ImportTexture(const InterFrameGraphTextureImportDesc &desc) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphExternalTextureBinding, SnAPI::Renderer::InterFrameGraphTextureImportDesc, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ImportRenderTarget

TResult< std::optional< FrameGraphExternalRenderTargetBinding > > SnAPI::Renderer::PassSetupContext::ImportRenderTarget(const InterFrameGraphRenderTargetImportDesc &desc) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::FrameGraphExternalRenderTargetBinding, SnAPI::Renderer::InterFrameGraphRenderTargetImportDesc, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ExportTexture

TResult< void > SnAPI::Renderer::PassSetupContext::ExportTexture(ResourceName exportedResourceName, const FrameGraphTextureRef &resource, EInterFrameGraphResourceAccess access=EInterFrameGraphResourceAccess::ReadOnly) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::EInterFrameGraphResourceAccess, SnAPI::Renderer::FrameGraphTextureRef, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.

SnAPI::Renderer::PassSetupContext::ExportRenderTarget

TResult< void > SnAPI::Renderer::PassSetupContext::ExportRenderTarget(ResourceName exportedResourceName, const FrameGraphRenderTargetRef &resource, EInterFrameGraphResourceAccess access=EInterFrameGraphResourceAccess::ReadOnly) const

See also SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::EInterFrameGraphResourceAccess, SnAPI::Renderer::FrameGraphRenderTargetRef, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.