Development

Renderer/Scene/Submission/SceneSubmissionSystem.h

Public include <Renderer/Scene/Submission/SceneSubmissionSystem.h>. SnBuild module Scene.

SnAPI::Renderer::SceneSubmissionSystem

class SnAPI::Renderer::SceneSubmissionSystem

SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem

explicit SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem(MeshSystem &meshSystem, PipelineSystem *pipelineSystem=nullptr, InstanceDataSystem *instanceDataSystem=nullptr, MaterialSystem *materialSystem=nullptr, const IShaderProgramResolver *shaderProgramResolver=nullptr, const IDescriptorSystem *descriptorSystem=nullptr) noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::IDescriptorSystem, SnAPI::Renderer::IShaderProgramResolver, SnAPI::Renderer::InstanceDataSystem, SnAPI::Renderer::MaterialSystem, SnAPI::Renderer::MeshSystem, SnAPI::Renderer::PipelineSystem.

SnAPI::Renderer::SceneSubmissionSystem::~SceneSubmissionSystem

SnAPI::Renderer::SceneSubmissionSystem::~SceneSubmissionSystem()

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem

SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem(const SceneSubmissionSystem &)=delete

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::operator=

SceneSubmissionSystem & SnAPI::Renderer::SceneSubmissionSystem::operator=(const SceneSubmissionSystem &)=delete

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem

SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem(SceneSubmissionSystem &&)=delete

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::operator=

SceneSubmissionSystem & SnAPI::Renderer::SceneSubmissionSystem::operator=(SceneSubmissionSystem &&)=delete

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::SceneSubmissionSystem::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::SetFrameScheduling

void SnAPI::Renderer::SceneSubmissionSystem::SetFrameScheduling(std::uint64_t frameNumber, std::uint32_t maximumFramesInFlight) noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::SubmitStaticMesh

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitStaticMesh(const StaticMeshSceneSubmission &staticMeshSceneSubmission)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshSceneSubmission, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::ValidatePassDerivedStaticMeshSubmission

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::ValidatePassDerivedStaticMeshSubmission(const StaticMeshSceneSubmission &staticMeshSceneSubmission) const

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshSceneSubmission, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::ValidateTransientObjectIdentityCapacity

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::ValidateTransientObjectIdentityCapacity(std::uint64_t instanceCount) const

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMesh

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMesh(const StaticMeshSceneSubmission &staticMeshSceneSubmission)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshSceneSubmission, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMeshInstances

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMeshInstances(const StaticMeshSceneSubmission &staticMeshSceneSubmission, std::span< const RenderObjectTemporalState > objectTemporalStates)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RenderObjectTemporalState, SnAPI::Renderer::StaticMeshSceneSubmission, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMeshInstances

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitPassDerivedStaticMeshInstances(const StaticMeshSceneSubmission &staticMeshSceneSubmission, std::vector< RenderObjectTemporalState > &&objectTemporalStates)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RenderObjectTemporalState, SnAPI::Renderer::StaticMeshSceneSubmission, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::ClearTransientStaticMeshesWithFeatureChannel

void SnAPI::Renderer::SceneSubmissionSystem::ClearTransientStaticMeshesWithFeatureChannel(ERenderFeatureChannel channel)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::ERenderFeatureChannel.

SnAPI::Renderer::SceneSubmissionSystem::RetainedObjectRevision

std::uint64_t SnAPI::Renderer::SceneSubmissionSystem::RetainedObjectRevision() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedStaticMeshes

RetainedStaticMeshSceneSnapshot SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedStaticMeshes() const

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RetainedStaticMeshSceneSnapshot.

SnAPI::Renderer::SceneSubmissionSystem::CreateStaticMeshObject

TResult< RenderObjectHandle > SnAPI::Renderer::SceneSubmissionSystem::CreateStaticMeshObject(const RetainedStaticMeshObjectDesc &objectDesc)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::RetainedStaticMeshObjectDesc, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::DestroyObject

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::DestroyObject(RenderObjectHandle object)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SetObjectTransform

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SetObjectTransform(RenderObjectHandle object, const Matrix4 &worldFromLocal)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::Matrix4, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::GetObjectTemporalState

TResult< RenderObjectTemporalState > SnAPI::Renderer::SceneSubmissionSystem::GetObjectTemporalState(RenderObjectHandle object) const

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::RenderObjectTemporalState, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SetObjectMaterialInstance

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SetObjectMaterialInstance(RenderObjectHandle object, MaterialInstanceHandle materialInstance)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::MaterialInstanceHandle, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SetObjectMaterialInstance

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SetObjectMaterialInstance(RenderObjectHandle object, MaterialInstanceHandle materialInstance, RenderFeatureChannelMask channels)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::MaterialInstanceHandle, SnAPI::Renderer::RenderFeatureChannelMask, SnAPI::Renderer::RenderObjectHandle, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SetDefaultStaticMeshSubmissionDerivation

void SnAPI::Renderer::SceneSubmissionSystem::SetDefaultStaticMeshSubmissionDerivation(StaticMeshSubmissionDerivationConfig defaults)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshSubmissionDerivationConfig.

SnAPI::Renderer::SceneSubmissionSystem::ClearDefaultStaticMeshSubmissionDerivation

void SnAPI::Renderer::SceneSubmissionSystem::ClearDefaultStaticMeshSubmissionDerivation()

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::DefaultStaticMeshSubmissionDerivation

const StaticMeshSubmissionDerivationConfig * SnAPI::Renderer::SceneSubmissionSystem::DefaultStaticMeshSubmissionDerivation() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshSubmissionDerivationConfig.

SnAPI::Renderer::SceneSubmissionSystem::ClearFramePackets

void SnAPI::Renderer::SceneSubmissionSystem::ClearFramePackets()

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::SubmitStaticMeshRasterPacket

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitStaticMeshRasterPacket(StaticMeshRasterPacket staticMeshRasterPacket)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshRasterPacket, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SubmitFullScreenRasterPacket

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitFullScreenRasterPacket(FullScreenRasterPacket fullScreenRasterPacket)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::FullScreenRasterPacket, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::SubmitComputeDispatchPacket

TResult< void > SnAPI::Renderer::SceneSubmissionSystem::SubmitComputeDispatchPacket(ComputeDispatchPacket computeDispatchPacket)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::ComputeDispatchPacket, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::StaticMeshRasterPackets

const std::vector< StaticMeshRasterPacket > & SnAPI::Renderer::SceneSubmissionSystem::StaticMeshRasterPackets() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::StaticMeshRasterPacket.

SnAPI::Renderer::SceneSubmissionSystem::FullScreenRasterPackets

const std::vector< FullScreenRasterPacket > & SnAPI::Renderer::SceneSubmissionSystem::FullScreenRasterPackets() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::FullScreenRasterPacket.

SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan

const RasterPacketSubmissionPlan & SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan()

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RasterPacketSubmissionPlan.

SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan

const RasterPacketSubmissionPlan & SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan(const RenderView &view)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RasterPacketSubmissionPlan, SnAPI::Renderer::RenderView.

SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan

const RasterPacketSubmissionPlan & SnAPI::Renderer::SceneSubmissionSystem::BuildRasterSubmissionPlan(const RenderView &view, const StaticMeshSubmissionDerivationConfig &derivation)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RasterPacketSubmissionPlan, SnAPI::Renderer::RenderView, SnAPI::Renderer::StaticMeshSubmissionDerivationConfig.

SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedStaticDrawObjects

std::vector< std::vector< RenderObjectHandle > > SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedStaticDrawObjects(const RasterPacketSubmissionPlan &plan) const

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::RasterPacketSubmissionPlan, SnAPI::Renderer::RenderObjectHandle.

SnAPI::Renderer::SceneSubmissionSystem::PrepareRasterSubmissionPlanAsync

SnAPI::Core::TTask< TResult< void > > SnAPI::Renderer::SceneSubmissionSystem::PrepareRasterSubmissionPlanAsync(RenderView view, StaticMeshSubmissionDerivationConfig derivation, PassResourcePreparationContext context, std::uint32_t maximumNativePreparations=1)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::PassResourcePreparationContext, SnAPI::Renderer::RenderView, SnAPI::Renderer::StaticMeshSubmissionDerivationConfig, SnAPI::Renderer::TResult.

SnAPI::Renderer::SceneSubmissionSystem::HasStaticMeshFeatureChannel

bool SnAPI::Renderer::SceneSubmissionSystem::HasStaticMeshFeatureChannel(ERenderFeatureChannel channel) const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::ERenderFeatureChannel.

SnAPI::Renderer::SceneSubmissionSystem::PrepareTraceableScene

TResult< TraceableSceneSubmissionBuildResult > SnAPI::Renderer::SceneSubmissionSystem::PrepareTraceableScene(IRayTracingSystem &rayTracing, const RenderView *view=nullptr)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::IRayTracingSystem, SnAPI::Renderer::RenderView, SnAPI::Renderer::TResult, SnAPI::Renderer::TraceableSceneSubmissionBuildResult.

SnAPI::Renderer::SceneSubmissionSystem::PrepareTraceableScene

TResult< TraceableSceneSubmissionBuildResult > SnAPI::Renderer::SceneSubmissionSystem::PrepareTraceableScene(IRayTracingSystem &rayTracing, const FrameGraphPassMetadata &materialPass, const RenderView *view=nullptr)

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::FrameGraphPassMetadata, SnAPI::Renderer::IRayTracingSystem, SnAPI::Renderer::RenderView, SnAPI::Renderer::TResult, SnAPI::Renderer::TraceableSceneSubmissionBuildResult.

SnAPI::Renderer::SceneSubmissionSystem::ComputeDispatchPackets

const std::vector< ComputeDispatchPacket > & SnAPI::Renderer::SceneSubmissionSystem::ComputeDispatchPackets() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem, SnAPI::Renderer::ComputeDispatchPacket.

SnAPI::Renderer::SceneSubmissionSystem::StaticMeshRasterPacketCount

std::size_t SnAPI::Renderer::SceneSubmissionSystem::StaticMeshRasterPacketCount() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::HasTransientStaticMeshSubmissions

bool SnAPI::Renderer::SceneSubmissionSystem::HasTransientStaticMeshSubmissions() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::RetainedObjectCount

std::size_t SnAPI::Renderer::SceneSubmissionSystem::RetainedObjectCount() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedObjectTransformsForSuccessfulView

void SnAPI::Renderer::SceneSubmissionSystem::CaptureRetainedObjectTransformsForSuccessfulView()

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::CommitRetainedObjectTransformsAfterSuccessfulFrame

void SnAPI::Renderer::SceneSubmissionSystem::CommitRetainedObjectTransformsAfterSuccessfulFrame()

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::DiscardPendingRetainedObjectTransformCommit

void SnAPI::Renderer::SceneSubmissionSystem::DiscardPendingRetainedObjectTransformCommit() noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::FullScreenRasterPacketCount

std::size_t SnAPI::Renderer::SceneSubmissionSystem::FullScreenRasterPacketCount() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.

SnAPI::Renderer::SceneSubmissionSystem::ComputeDispatchPacketCount

std::size_t SnAPI::Renderer::SceneSubmissionSystem::ComputeDispatchPacketCount() const noexcept

See also SnAPI::Renderer::SceneSubmissionSystem.