Development

Renderer/UIOverlay/UiOverlayPass.h

Public include <Renderer/UIOverlay/UiOverlayPass.h>. SnBuild module UIOverlay.

SnAPI::Renderer::UiOverlayPassInputs

struct SnAPI::Renderer::UiOverlayPassInputs

SnAPI::Renderer::UiOverlayPassInputs::ClearOutput

bool SnAPI::Renderer::UiOverlayPassInputs::ClearOutput {false}

See also SnAPI::Renderer::UiOverlayPassInputs.

SnAPI::Renderer::UiOverlayPassInputs::ClearColor

std::array<float, 4> SnAPI::Renderer::UiOverlayPassInputs::ClearColor {0.0f, 0.0f, 0.0f, 0.0f}

See also SnAPI::Renderer::UiOverlayPassInputs.

SnAPI::Renderer::UiOverlayPassOutputs

struct SnAPI::Renderer::UiOverlayPassOutputs

SnAPI::Renderer::UiOverlayPassOutputs::Output

FrameGraphRenderTargetRef SnAPI::Renderer::UiOverlayPassOutputs::Output

See also SnAPI::Renderer::UiOverlayPassOutputs, SnAPI::Renderer::FrameGraphRenderTargetRef.

SnAPI::Renderer::UiOverlayPassOutputs::Depth

FrameGraphRenderTargetRef SnAPI::Renderer::UiOverlayPassOutputs::Depth

See also SnAPI::Renderer::UiOverlayPassOutputs, SnAPI::Renderer::FrameGraphRenderTargetRef.

SnAPI::Renderer::UiOverlayPassCreateInfo

struct SnAPI::Renderer::UiOverlayPassCreateInfo

SnAPI::Renderer::UiOverlayPassCreateInfo::OutputTargetDesc

RenderTargetDesc SnAPI::Renderer::UiOverlayPassCreateInfo::OutputTargetDesc {}

See also SnAPI::Renderer::UiOverlayPassCreateInfo, SnAPI::Renderer::RenderTargetDesc.

SnAPI::Renderer::UiOverlayDrawCommand

struct SnAPI::Renderer::UiOverlayDrawCommand

SnAPI::Renderer::UiOverlayDrawCommand::Pipeline

EUiPacketPipeline SnAPI::Renderer::UiOverlayDrawCommand::Pipeline {EUiPacketPipeline::SolidColor}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::EUiPacketPipeline.

SnAPI::Renderer::UiOverlayDrawCommand::Texture

TextureHandle SnAPI::Renderer::UiOverlayDrawCommand::Texture {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::TextureHandle.

SnAPI::Renderer::UiOverlayDrawCommand::TextureResourceName

ResourceName SnAPI::Renderer::UiOverlayDrawCommand::TextureResourceName {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::ResourceName.

SnAPI::Renderer::UiOverlayDrawCommand::RenderTarget

RenderTargetHandle SnAPI::Renderer::UiOverlayDrawCommand::RenderTarget {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::RenderTargetHandle.

SnAPI::Renderer::UiOverlayDrawCommand::RenderTargetResourceName

ResourceName SnAPI::Renderer::UiOverlayDrawCommand::RenderTargetResourceName {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::ResourceName.

SnAPI::Renderer::UiOverlayDrawCommand::Sampler

SamplerHandle SnAPI::Renderer::UiOverlayDrawCommand::Sampler {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::SamplerHandle.

SnAPI::Renderer::UiOverlayDrawCommand::BlendMode

EUiBlendMode SnAPI::Renderer::UiOverlayDrawCommand::BlendMode {EUiBlendMode::Alpha}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::EUiBlendMode.

SnAPI::Renderer::UiOverlayDrawCommand::Scissor

UiScissorRect SnAPI::Renderer::UiOverlayDrawCommand::Scissor {}

See also SnAPI::Renderer::UiOverlayDrawCommand, SnAPI::Renderer::UiScissorRect.

SnAPI::Renderer::UiOverlayDrawCommand::FirstVertex

std::uint32_t SnAPI::Renderer::UiOverlayDrawCommand::FirstVertex {0u}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::VertexCount

std::uint32_t SnAPI::Renderer::UiOverlayDrawCommand::VertexCount {0u}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::DrawOrderDepth

float SnAPI::Renderer::UiOverlayDrawCommand::DrawOrderDepth {0.0f}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::FirstInstance

std::uint32_t SnAPI::Renderer::UiOverlayDrawCommand::FirstInstance {0u}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::InstanceCount

std::uint32_t SnAPI::Renderer::UiOverlayDrawCommand::InstanceCount {1u}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::UseQuadInstances

bool SnAPI::Renderer::UiOverlayDrawCommand::UseQuadInstances {false}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::UseGradientInstances

bool SnAPI::Renderer::UiOverlayDrawCommand::UseGradientInstances {false}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::UseTriangleInstances

bool SnAPI::Renderer::UiOverlayDrawCommand::UseTriangleInstances {false}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::UseCircleInstances

bool SnAPI::Renderer::UiOverlayDrawCommand::UseCircleInstances {false}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayDrawCommand::UseShadowInstances

bool SnAPI::Renderer::UiOverlayDrawCommand::UseShadowInstances {false}

See also SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayPass

class SnAPI::Renderer::UiOverlayPass : public SnAPI::Renderer::TRasterPass< UiOverlayPassInputs, UiOverlayPassOutputs >

See also SnAPI::Renderer::TRasterPass.

SnAPI::Renderer::UiOverlayPass::SupportsConcurrentPreparation

static constexpr bool SnAPI::Renderer::UiOverlayPass::SupportsConcurrentPreparation = true

See also SnAPI::Renderer::UiOverlayPass.

SnAPI::Renderer::UiOverlayPass::BuildPassMetadata

static FrameGraphPassMetadata SnAPI::Renderer::UiOverlayPass::BuildPassMetadata()

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::FrameGraphPassMetadata.

SnAPI::Renderer::UiOverlayPass::BuildDrawCommandsForDiagnostics

static std::vector< UiOverlayDrawCommand > SnAPI::Renderer::UiOverlayPass::BuildDrawCommandsForDiagnostics(const UiFramePacket &framePacket, Extent2D outputExtent)

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::Extent2D, SnAPI::Renderer::UiFramePacket, SnAPI::Renderer::UiOverlayDrawCommand.

SnAPI::Renderer::UiOverlayPass::UiOverlayPass

explicit SnAPI::Renderer::UiOverlayPass::UiOverlayPass(UiOverlayPassCreateInfo createInfo)

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::UiOverlayPassCreateInfo.

SnAPI::Renderer::UiOverlayPass::~UiOverlayPass

SnAPI::Renderer::UiOverlayPass::~UiOverlayPass() override

See also SnAPI::Renderer::UiOverlayPass.

SnAPI::Renderer::UiOverlayPass::DeclareResources

void SnAPI::Renderer::UiOverlayPass::DeclareResources(ResourceBuilder &resourceBuilder, const UiOverlayPassInputs &inputs) override

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::ResourceBuilder, SnAPI::Renderer::UiOverlayPassInputs.

SnAPI::Renderer::UiOverlayPass::DeclareResources

void SnAPI::Renderer::UiOverlayPass::DeclareResources(ResourceBuilder &resourceBuilder, const UiOverlayPassInputs &inputs, const UiOverlayPassOutputs &outputs)

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::ResourceBuilder, SnAPI::Renderer::UiOverlayPassInputs, SnAPI::Renderer::UiOverlayPassOutputs.

SnAPI::Renderer::UiOverlayPass::PrepareAsync

SnAPI::Core::TTask< TResult< void > > SnAPI::Renderer::UiOverlayPass::PrepareAsync(PassExecutionServices &runtime, PassResourcePreparationContext context) override

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::PassExecutionServices, SnAPI::Renderer::PassResourcePreparationContext, SnAPI::Renderer::TResult.

SnAPI::Renderer::UiOverlayPass::Setup

void SnAPI::Renderer::UiOverlayPass::Setup(const PassSetupContext &setupContext, const UiOverlayPassInputs &inputs) override

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::PassSetupContext, SnAPI::Renderer::UiOverlayPassInputs.

SnAPI::Renderer::UiOverlayPass::Record

void SnAPI::Renderer::UiOverlayPass::Record(const RasterPassRecordContext &recordContext, const UiOverlayPassInputs &inputs, const UiOverlayPassOutputs &outputs) override

See also SnAPI::Renderer::UiOverlayPass, SnAPI::Renderer::RasterPassRecordContext, SnAPI::Renderer::UiOverlayPassInputs, SnAPI::Renderer::UiOverlayPassOutputs.