Toast Engine
Loading...
Searching...
No Matches
ui::WorldUIPass Class Reference
Inheritance diagram for ui::WorldUIPass:
Collaboration diagram for ui::WorldUIPass:

Public Types

enum class  Layer : uint8_t { world , overlay }

Public Member Functions

 WorldUIPass (const renderer::VulkanCore &core, vk::Format color_format, vk::Format depth_format, vk::Extent2D extent, Layer layer=Layer::world)
auto name () const -> std::string_view override
auto stage () const -> RenderStage override
void recordPre (vk::CommandBuffer cmd, uint32_t frame_index, uint32_t image_index) override
 Records outside any rendering scope before the main scope opens.
void record (vk::CommandBuffer cmd, uint32_t frame_index, uint32_t image_index) override
Public Member Functions inherited from IRenderPass
virtual void update (uint32_t frame_index, float dt)
void setEnabled (bool enabled) noexcept
auto isEnabled () const noexcept -> bool

Member Enumeration Documentation

◆ Layer

enum class ui::WorldUIPass::Layer : uint8_t
strong

world draws the depth tested panels into the scene overlay draws the always_on_top ones after the tonemap

Member Function Documentation

◆ name()

auto ui::WorldUIPass::name ( ) const -> std::string_view
inlinenodiscardoverridevirtual

Reimplemented from IRenderPass.

◆ record()

void ui::WorldUIPass::record ( vk::CommandBuffer cmd,
uint32_t frame_index,
uint32_t image_index )
overridevirtual

Implements IRenderPass.

◆ recordPre()

void ui::WorldUIPass::recordPre ( vk::CommandBuffer cmd,
uint32_t frame_index,
uint32_t image_index )
overridevirtual

Records outside any rendering scope before the main scope opens.

Reimplemented from IRenderPass.

Here is the caller graph for this function:

◆ stage()

auto ui::WorldUIPass::stage ( ) const -> RenderStage
inlinenodiscardoverridevirtual

Reimplemented from IRenderPass.


The documentation for this class was generated from the following files:
  • engine/src/toast/ui/render/world_ui_pass.hpp
  • engine/src/toast/ui/render/world_ui_pass.cpp