Renderer/SceneContracts/Scene/RenderView.h¶
Public include <Renderer/SceneContracts/Scene/RenderView.h>. SnBuild module SceneContracts.
SnAPI::Renderer::PhysicalCameraSettings¶
struct SnAPI::Renderer::PhysicalCameraSettings
SnAPI::Renderer::PhysicalCameraSettings::ApertureFNumber¶
float SnAPI::Renderer::PhysicalCameraSettings::ApertureFNumber = 8.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::ShutterTimeSeconds¶
float SnAPI::Renderer::PhysicalCameraSettings::ShutterTimeSeconds = 1.0f / 125.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::Iso¶
float SnAPI::Renderer::PhysicalCameraSettings::Iso = 100.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::ExposureCompensationEV¶
float SnAPI::Renderer::PhysicalCameraSettings::ExposureCompensationEV = 0.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::CalibrationConstant¶
float SnAPI::Renderer::PhysicalCameraSettings::CalibrationConstant = 12.5f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::LensTransmittance¶
float SnAPI::Renderer::PhysicalCameraSettings::LensTransmittance = 1.0f / 1.2f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::MinEV100¶
float SnAPI::Renderer::PhysicalCameraSettings::MinEV100 = 0.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::PhysicalCameraSettings::MaxEV100¶
float SnAPI::Renderer::PhysicalCameraSettings::MaxEV100 = 16.0f
See also SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::RenderView¶
struct SnAPI::Renderer::RenderView
SnAPI::Renderer::RenderView::DebugName¶
std::string SnAPI::Renderer::RenderView::DebugName {}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::PlatformPresentationExtent¶
Extent2D SnAPI::Renderer::RenderView::PlatformPresentationExtent {.Width = 0, .Height = 0}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::OutputExtent¶
Extent2D SnAPI::Renderer::RenderView::OutputExtent {.Width = 0, .Height = 0}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::InternalRenderExtent¶
Extent2D SnAPI::Renderer::RenderView::InternalRenderExtent {.Width = 0, .Height = 0}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::Width¶
std::uint32_t SnAPI::Renderer::RenderView::Width {1}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::Height¶
std::uint32_t SnAPI::Renderer::RenderView::Height {1}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::CameraRelative¶
bool SnAPI::Renderer::RenderView::CameraRelative {true}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::ReverseZ¶
bool SnAPI::Renderer::RenderView::ReverseZ {true}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::NearPlane¶
double SnAPI::Renderer::RenderView::NearPlane {0.01}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::Projection¶
RenderProjection SnAPI::Renderer::RenderView::Projection {}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::RenderProjection.
SnAPI::Renderer::RenderView::FixedAspectRatio¶
std::optional<double> SnAPI::Renderer::RenderView::FixedAspectRatio {}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::TemporalCameraStateValid¶
bool SnAPI::Renderer::RenderView::TemporalCameraStateValid {false}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::CameraWorldPosition¶
Point3 SnAPI::Renderer::RenderView::CameraWorldPosition {Point3::Zero()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Point3.
SnAPI::Renderer::RenderView::PhysicalCamera¶
PhysicalCameraSettings SnAPI::Renderer::RenderView::PhysicalCamera {}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::PhysicalCameraSettings.
SnAPI::Renderer::RenderView::Timing¶
FrameTimingInfo SnAPI::Renderer::RenderView::Timing {}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::FrameTimingInfo.
SnAPI::Renderer::RenderView::TemporalViewKey¶
std::string SnAPI::Renderer::RenderView::TemporalViewKey {}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::TemporalHistoryValid¶
bool SnAPI::Renderer::RenderView::TemporalHistoryValid {false}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::ResetTemporalHistory¶
bool SnAPI::Renderer::RenderView::ResetTemporalHistory {false}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::TemporalUpscalerHistoryValid¶
std::optional<bool> SnAPI::Renderer::RenderView::TemporalUpscalerHistoryValid {}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::TemporalSampleIndex¶
std::uint64_t SnAPI::Renderer::RenderView::TemporalSampleIndex {0}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::JitterPixels¶
std::array<double, 2> SnAPI::Renderer::RenderView::JitterPixels {0.0, 0.0}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::PreviousJitterPixels¶
std::array<double, 2> SnAPI::Renderer::RenderView::PreviousJitterPixels {0.0, 0.0}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::HasExplicitClipFromViewUnjittered¶
bool SnAPI::Renderer::RenderView::HasExplicitClipFromViewUnjittered {false}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::ClipFromViewUnjittered¶
UnjitteredClipFromViewTransform SnAPI::Renderer::RenderView::ClipFromViewUnjittered {UnjitteredClipFromViewTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::UnjitteredClipFromViewTransform.
SnAPI::Renderer::RenderView::HasExplicitViewFromWorld¶
bool SnAPI::Renderer::RenderView::HasExplicitViewFromWorld {false}
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::ViewFromWorld¶
ViewFromWorldTransform SnAPI::Renderer::RenderView::ViewFromWorld {ViewFromWorldTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::ViewFromWorldTransform.
SnAPI::Renderer::RenderView::ClipFromWorldUnjittered¶
UnjitteredClipFromWorldTransform SnAPI::Renderer::RenderView::ClipFromWorldUnjittered {UnjitteredClipFromWorldTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::UnjitteredClipFromWorldTransform.
SnAPI::Renderer::RenderView::PreviousClipFromWorldUnjittered¶
UnjitteredClipFromWorldTransform SnAPI::Renderer::RenderView::PreviousClipFromWorldUnjittered {UnjitteredClipFromWorldTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::UnjitteredClipFromWorldTransform.
SnAPI::Renderer::RenderView::ClipFromWorldJittered¶
JitteredClipFromWorldTransform SnAPI::Renderer::RenderView::ClipFromWorldJittered {JitteredClipFromWorldTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::JitteredClipFromWorldTransform.
SnAPI::Renderer::RenderView::PreviousClipFromWorldJittered¶
JitteredClipFromWorldTransform SnAPI::Renderer::RenderView::PreviousClipFromWorldJittered {JitteredClipFromWorldTransform::Identity()}
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::JitteredClipFromWorldTransform.
SnAPI::Renderer::RenderView::ResolvedPlatformPresentationExtent¶
Extent2D SnAPI::Renderer::RenderView::ResolvedPlatformPresentationExtent() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::ResolvedOutputCanvasExtent¶
Extent2D SnAPI::Renderer::RenderView::ResolvedOutputCanvasExtent() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::ResolvedOutputExtent¶
Extent2D SnAPI::Renderer::RenderView::ResolvedOutputExtent() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::ResolvedInternalRenderExtent¶
Extent2D SnAPI::Renderer::RenderView::ResolvedInternalRenderExtent() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::Extent2D.
SnAPI::Renderer::RenderView::HasValidFixedAspectRatio¶
bool SnAPI::Renderer::RenderView::HasValidFixedAspectRatio() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::ResolvedProjectionAspectRatio¶
double SnAPI::Renderer::RenderView::ResolvedProjectionAspectRatio() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::OutputContentLayout¶
std::optional< ViewBoxLayout > SnAPI::Renderer::RenderView::OutputContentLayout() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::ViewBoxLayout.
SnAPI::Renderer::RenderView::PlatformPresentationContentLayout¶
std::optional< ViewBoxLayout > SnAPI::Renderer::RenderView::PlatformPresentationContentLayout() const noexcept
See also SnAPI::Renderer::RenderView, SnAPI::Renderer::ViewBoxLayout.
SnAPI::Renderer::RenderView::PlatformPresentationWidth¶
std::uint32_t SnAPI::Renderer::RenderView::PlatformPresentationWidth() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::PlatformPresentationHeight¶
std::uint32_t SnAPI::Renderer::RenderView::PlatformPresentationHeight() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::OutputWidth¶
std::uint32_t SnAPI::Renderer::RenderView::OutputWidth() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::OutputHeight¶
std::uint32_t SnAPI::Renderer::RenderView::OutputHeight() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::InternalRenderWidth¶
std::uint32_t SnAPI::Renderer::RenderView::InternalRenderWidth() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::RenderView::InternalRenderHeight¶
std::uint32_t SnAPI::Renderer::RenderView::InternalRenderHeight() const noexcept
See also SnAPI::Renderer::RenderView.
SnAPI::Renderer::FrameBeginDesc¶
struct SnAPI::Renderer::FrameBeginDesc
SnAPI::Renderer::FrameBeginDesc::FrameIndex¶
std::uint64_t SnAPI::Renderer::FrameBeginDesc::FrameIndex = 0
See also SnAPI::Renderer::FrameBeginDesc.
SnAPI::Renderer::FrameBeginDesc::DeltaTimeSeconds¶
double SnAPI::Renderer::FrameBeginDesc::DeltaTimeSeconds = 0.0
See also SnAPI::Renderer::FrameBeginDesc.
SnAPI::Renderer::FrameBeginDesc::Timing¶
FrameTimingInfo SnAPI::Renderer::FrameBeginDesc::Timing
See also SnAPI::Renderer::FrameBeginDesc, SnAPI::Renderer::FrameTimingInfo.
SnAPI::Renderer::SurfaceViewSubmission¶
struct SnAPI::Renderer::SurfaceViewSubmission
SnAPI::Renderer::SurfaceViewSubmission::Surface¶
SurfaceHandle SnAPI::Renderer::SurfaceViewSubmission::Surface {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::SurfaceHandle.
SnAPI::Renderer::SurfaceViewSubmission::View¶
RenderView SnAPI::Renderer::SurfaceViewSubmission::View {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::RenderView.
SnAPI::Renderer::SurfaceViewSubmission::Profile¶
RenderProfileHandle SnAPI::Renderer::SurfaceViewSubmission::Profile {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::RenderProfileHandle.
SnAPI::Renderer::SurfaceViewSubmission::ExternalRenderTargets¶
std::vector<FrameGraphExternalRenderTargetBinding> SnAPI::Renderer::SurfaceViewSubmission::ExternalRenderTargets {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::FrameGraphExternalRenderTargetBinding.
SnAPI::Renderer::SurfaceViewSubmission::ExternalTextures¶
std::vector<FrameGraphExternalTextureBinding> SnAPI::Renderer::SurfaceViewSubmission::ExternalTextures {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::FrameGraphExternalTextureBinding.
SnAPI::Renderer::SurfaceViewSubmission::ExternalBuffers¶
std::vector<FrameGraphExternalBufferBinding> SnAPI::Renderer::SurfaceViewSubmission::ExternalBuffers {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::FrameGraphExternalBufferBinding.
SnAPI::Renderer::SurfaceViewSubmission::FrameGraphOutputResourceName¶
ResourceName SnAPI::Renderer::SurfaceViewSubmission::FrameGraphOutputResourceName {}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::ResourceName.
SnAPI::Renderer::SurfaceViewSubmission::PresentationReadbackOutput¶
TextureReadbackPayload* SnAPI::Renderer::SurfaceViewSubmission::PresentationReadbackOutput {nullptr}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::TextureReadbackPayload.
SnAPI::Renderer::SurfaceViewSubmission::AcquireMode¶
ESurfaceAcquireMode SnAPI::Renderer::SurfaceViewSubmission::AcquireMode {ESurfaceAcquireMode::Wait}
See also SnAPI::Renderer::SurfaceViewSubmission, SnAPI::Renderer::ESurfaceAcquireMode.
SnAPI::Renderer::TargetViewSubmission¶
struct SnAPI::Renderer::TargetViewSubmission
SnAPI::Renderer::TargetViewSubmission::Target¶
RenderTargetHandle SnAPI::Renderer::TargetViewSubmission::Target {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::RenderTargetHandle.
SnAPI::Renderer::TargetViewSubmission::View¶
RenderView SnAPI::Renderer::TargetViewSubmission::View {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::RenderView.
SnAPI::Renderer::TargetViewSubmission::Profile¶
RenderProfileHandle SnAPI::Renderer::TargetViewSubmission::Profile {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::RenderProfileHandle.
SnAPI::Renderer::TargetViewSubmission::ExternalRenderTargets¶
std::vector<FrameGraphExternalRenderTargetBinding> SnAPI::Renderer::TargetViewSubmission::ExternalRenderTargets {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::FrameGraphExternalRenderTargetBinding.
SnAPI::Renderer::TargetViewSubmission::ExternalTextures¶
std::vector<FrameGraphExternalTextureBinding> SnAPI::Renderer::TargetViewSubmission::ExternalTextures {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::FrameGraphExternalTextureBinding.
SnAPI::Renderer::TargetViewSubmission::ExternalBuffers¶
std::vector<FrameGraphExternalBufferBinding> SnAPI::Renderer::TargetViewSubmission::ExternalBuffers {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::FrameGraphExternalBufferBinding.
SnAPI::Renderer::TargetViewSubmission::FrameGraphOutputResourceName¶
ResourceName SnAPI::Renderer::TargetViewSubmission::FrameGraphOutputResourceName {}
See also SnAPI::Renderer::TargetViewSubmission, SnAPI::Renderer::ResourceName.