Renderer/FrameGraphContracts/Passes/FrameGraph/FrameGraphExecutionResources.h¶
Public include <Renderer/FrameGraphContracts/Passes/FrameGraph/FrameGraphExecutionResources.h>. SnBuild module FrameGraphContracts.
SnAPI::Renderer::FrameGraphExecutionResources¶
class SnAPI::Renderer::FrameGraphExecutionResources
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget¶
struct SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::ResourceName¶
Name SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::ResourceName
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget, SnAPI::Renderer::Name.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::Handle¶
RenderTargetHandle SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::Handle
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget, SnAPI::Renderer::RenderTargetHandle.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::ColorAttachmentCount¶
std::size_t SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::ColorAttachmentCount = 1
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::MipCount¶
std::uint32_t SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::MipCount = 1
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::HasDepth¶
bool SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::HasDepth = false
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::AllowsStorageTextureBinding¶
bool SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::AllowsStorageTextureBinding = false
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget.
SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::Extent¶
std::optional<Extent2D> SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget::Extent {}
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedRenderTarget, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture¶
struct SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture
SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::ResourceName¶
Name SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::ResourceName
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture, SnAPI::Renderer::Name.
SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::Handle¶
TextureHandle SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::Handle
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture, SnAPI::Renderer::TextureHandle.
SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::Metadata¶
std::optional<FrameGraphTextureMetadata> SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture::Metadata {}
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture, SnAPI::Renderer::FrameGraphTextureMetadata.
SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer¶
struct SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer
SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::ResourceName¶
Name SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::ResourceName
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer, SnAPI::Renderer::Name.
SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::View¶
FrameGraphBufferView SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::View
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer, SnAPI::Renderer::FrameGraphBufferView.
SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::Writable¶
bool SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer::Writable
See also SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer.
SnAPI::Renderer::FrameGraphExecutionResources::ExternalBuffers¶
std::span< const NamedBuffer > SnAPI::Renderer::FrameGraphExecutionResources::ExternalBuffers() const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphExecutionResources::NamedBuffer.
SnAPI::Renderer::FrameGraphExecutionResources::ExternalTextures¶
std::span< const NamedTexture > SnAPI::Renderer::FrameGraphExecutionResources::ExternalTextures() const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphExecutionResources::NamedTexture.
SnAPI::Renderer::FrameGraphExecutionResources::FindBufferView¶
TResult< FrameGraphBufferView > SnAPI::Renderer::FrameGraphExecutionResources::FindBufferView(const FrameGraphBufferRef &resource) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphBufferRef, SnAPI::Renderer::FrameGraphBufferView, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::BindBuffer¶
TResult< void > SnAPI::Renderer::FrameGraphExecutionResources::BindBuffer(ResourceName name, FrameGraphBufferView view, bool writable=true)
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphBufferView, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::HasRenderTarget¶
bool SnAPI::Renderer::FrameGraphExecutionResources::HasRenderTarget(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::HasRenderTarget¶
bool SnAPI::Renderer::FrameGraphExecutionResources::HasRenderTarget(const FrameGraphRenderTargetRef &resource) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphRenderTargetRef.
SnAPI::Renderer::FrameGraphExecutionResources::RenderTarget¶
RenderTargetHandle SnAPI::Renderer::FrameGraphExecutionResources::RenderTarget(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::RenderTargetHandle, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::RenderTarget¶
RenderTargetHandle SnAPI::Renderer::FrameGraphExecutionResources::RenderTarget(const FrameGraphRenderTargetRef &resource) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphRenderTargetRef, SnAPI::Renderer::RenderTargetHandle.
SnAPI::Renderer::FrameGraphExecutionResources::FindRenderTargetExtent¶
TResult< Extent2D > SnAPI::Renderer::FrameGraphExecutionResources::FindRenderTargetExtent(ResourceName resourceName, std::uint32_t mipLevel=0) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::Extent2D, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::FindTextureMetadata¶
TResult< FrameGraphTextureMetadata > SnAPI::Renderer::FrameGraphExecutionResources::FindTextureMetadata(ResourceName resourceName) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphTextureMetadata, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::FindTextureExtent¶
TResult< Extent2D > SnAPI::Renderer::FrameGraphExecutionResources::FindTextureExtent(ResourceName resourceName, std::uint32_t mipLevel=0) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::Extent2D, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::HasTexture¶
bool SnAPI::Renderer::FrameGraphExecutionResources::HasTexture(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::HasTexture¶
bool SnAPI::Renderer::FrameGraphExecutionResources::HasTexture(const FrameGraphTextureRef &resource) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphTextureRef.
SnAPI::Renderer::FrameGraphExecutionResources::Texture¶
TextureHandle SnAPI::Renderer::FrameGraphExecutionResources::Texture(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TextureHandle.
SnAPI::Renderer::FrameGraphExecutionResources::Texture¶
TextureHandle SnAPI::Renderer::FrameGraphExecutionResources::Texture(const FrameGraphTextureRef &resource) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphTextureRef, SnAPI::Renderer::TextureHandle.
SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetColorAttachmentCount¶
std::size_t SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetColorAttachmentCount(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetHasDepth¶
bool SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetHasDepth(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetMipCount¶
std::uint32_t SnAPI::Renderer::FrameGraphExecutionResources::RenderTargetMipCount(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlanInternal¶
TResult< MaterialDescriptorPlan > SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlanInternal(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, std::span< const FrameGraphBufferBindingOverride > bufferBindings={}) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphBufferBindingOverride, SnAPI::Renderer::FrameGraphConstantBufferBindingOverride, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphSampledTextureBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageTextureBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan¶
TResult< MaterialDescriptorPlan > SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::span< const FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::span< const FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings={}) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan¶
TResult< MaterialDescriptorPlan > SnAPI::Renderer::FrameGraphExecutionResources::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={}, std::span< const FrameGraphBufferBindingOverride > bufferBindings={}) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphBufferBindingOverride, SnAPI::Renderer::FrameGraphConstantBufferBindingOverride, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphSampledTextureBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageTextureBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan¶
TResult< MaterialDescriptorPlan > SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan(const MaterialDescriptorPlan &descriptorPlan, std::initializer_list< FrameGraphSampledRenderTargetBindingOverride > sampledRenderTargetBindings, std::initializer_list< FrameGraphStorageRenderTargetBindingOverride > storageRenderTargetBindings={}) const
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::ResolveDescriptorPlan¶
TResult< MaterialDescriptorPlan > SnAPI::Renderer::FrameGraphExecutionResources::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::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphConstantBufferBindingOverride, SnAPI::Renderer::FrameGraphSampledRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphSampledTextureBindingOverride, SnAPI::Renderer::FrameGraphStorageRenderTargetBindingOverride, SnAPI::Renderer::FrameGraphStorageTextureBindingOverride, SnAPI::Renderer::MaterialDescriptorPlan, SnAPI::Renderer::TResult.
SnAPI::Renderer::FrameGraphExecutionResources::BindRenderTarget¶
void SnAPI::Renderer::FrameGraphExecutionResources::BindRenderTarget(ResourceName resourceName, RenderTargetHandle renderTarget, std::size_t colorAttachmentCount=1, std::uint32_t mipCount=1, bool hasDepth=false, bool allowsStorageTextureBinding=false, std::optional< Extent2D > extent=std::nullopt)
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::Extent2D, SnAPI::Renderer::RenderTargetHandle, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::BindTexture¶
void SnAPI::Renderer::FrameGraphExecutionResources::BindTexture(ResourceName resourceName, TextureHandle texture, std::optional< FrameGraphTextureMetadata > metadata=std::nullopt)
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphTextureMetadata, SnAPI::Renderer::ResourceName, SnAPI::Renderer::TextureHandle.
SnAPI::Renderer::FrameGraphExecutionResources::HistoryReadMetadata¶
std::optional< FrameGraphHistoryReadMetadata > SnAPI::Renderer::FrameGraphExecutionResources::HistoryReadMetadata(ResourceName resourceName) const noexcept
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphHistoryReadMetadata, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::FrameGraphExecutionResources::BindHistoryReadMetadata¶
void SnAPI::Renderer::FrameGraphExecutionResources::BindHistoryReadMetadata(ResourceName resourceName, FrameGraphHistoryReadMetadata metadata)
See also SnAPI::Renderer::FrameGraphExecutionResources, SnAPI::Renderer::FrameGraphHistoryReadMetadata, SnAPI::Renderer::ResourceName.