Render Graph

Render Graph (RG) module provides functions to construct render pass dependency graph to automatically reuse in-frame transient render resources to reduce memory comsumption.

Types

• Luna::RG::RenderGraphPassNode

  Describes one render pass node in one render graph.

• Luna::RG::RenderGraphResourceNode

  Describes one resource node in one render graph.

• Luna::RG::RenderGraphConnection

  Describes one input or output connection between the resource node and the render pass node in one render graph.

• Luna::RG::RenderGraphDesc

  Describes one render graph.

• Luna::RG::RenderGraphCompileConfig

  Describes render graph compiling configurations.

• Luna::RG::IRenderGraph

  Represents one render graph that can be used to schedule render passes and reuse in-frame transient render resources to reduce memory comsumption.

• Luna::RG::ResourceDesc

  Describes one render graph resource.

• Luna::RG::IRenderPassContext

  Represents one render graph execution context. This is used only as the parameter of IRenderPass::execute.

• Luna::RG::IRenderPass

  Represents one user-implemented render pass.

• Luna::RG::IRenderGraphCompiler

  The render graph compile context. This is used only as the parameter for render_pass_compile_func_t.

• Luna::RG::RenderPassTypeParameter

  Describes one parameter of one render pass.

• Luna::RG::RenderPassTypeDesc

  Describes one render pass type.

Enumerations

• Luna::RG::RenderGraphResourceType

  Specifies the residency type of one resource in one render graph.

• Luna::RG::RenderGraphResourceFlag

  Specifies flags of one resource in one render graph.

• Luna::RG::ResourceType

  Specifies one resource type in render graph.

Alias types

• using render_pass_compile_func_t = RV(object_t userdata, IRenderGraphCompiler* compiler)

  The function called by the render graph to produce the render pass object using input and output resources.

Constants

• constexpr usize INVALID_RESOURCE

  A specifal value that identifies one invalid resource name in IRenderGraphCompiler.

Functions

• Ref< IRenderGraph > new_render_graph(RHI::IDevice *device)

  Creates one new render graph.

• void register_render_pass_type(const RenderPassTypeDesc &desc)

  Registers one new render pass type.

• void get_render_pass_types(Vector< Name > &out_render_pass_types)

  Gets a list of render pass types registered to the system.

• R< RenderPassTypeDesc > get_render_pass_type_desc(const Name &render_pass)

  Gets the descriptor of the specified render pass.