le2d v0.4.6
2D game engine framework
 
Loading...
Searching...
No Matches
le::IRenderPass Class Referenceabstract

Opaque interface for 2D render pass, owns a multi-sampled color RenderTarget. More...

#include <le2d/render_pass.hpp>

Inheritance diagram for le::IRenderPass:

Public Member Functions

virtual auto get_render_device () const -> kvf::RenderDevice &=0
 
virtual auto get_render_target () const -> kvf::RenderTarget const &=0
 
virtual auto get_samples () const -> vk::SampleCountFlagBits=0
 
virtual auto render_texture () const -> RenderTexture=0
 
virtual void set_clear_color (kvf::Color color)=0
 Set clear color for next pass.
 
virtual void recreate (vk::SampleCountFlagBits samples)=0
 Recreate RenderTargets with possibly different MSAA samples.
 
virtual auto create_renderer () -> std::unique_ptr< IRenderer >=0
 

Static Public Attributes

static constexpr auto min_size_v {32}
 
static constexpr auto max_size_v {4 * 4096}
 

Detailed Description

Opaque interface for 2D render pass, owns a multi-sampled color RenderTarget.

Member Function Documentation

◆ create_renderer()

virtual auto le::IRenderPass::create_renderer ( ) -> std::unique_ptr< IRenderer >
pure virtual
Returns
Concrete Renderer for this Render Pass instance.

◆ get_render_device()

virtual auto le::IRenderPass::get_render_device ( ) const -> kvf::RenderDevice &
pure virtual

◆ get_render_target()

virtual auto le::IRenderPass::get_render_target ( ) const -> kvf::RenderTarget const &
pure virtual
Returns
Reference to latest RenderTarget.

◆ get_samples()

virtual auto le::IRenderPass::get_samples ( ) const -> vk::SampleCountFlagBits
pure virtual
Returns
Multi-sampling count.

◆ recreate()

virtual void le::IRenderPass::recreate ( vk::SampleCountFlagBits  samples)
pure virtual

Recreate RenderTargets with possibly different MSAA samples.

◆ render_texture()

virtual auto le::IRenderPass::render_texture ( ) const -> RenderTexture
pure virtual
Returns
RenderTarget as a texture. Must not outlive RenderPass.

◆ set_clear_color()

virtual void le::IRenderPass::set_clear_color ( kvf::Color  color)
pure virtual

Set clear color for next pass.

Parameters
colorClear color.

Member Data Documentation

◆ max_size_v

constexpr auto le::IRenderPass::max_size_v {4 * 4096}
staticconstexpr

◆ min_size_v

constexpr auto le::IRenderPass::min_size_v {32}
staticconstexpr

The documentation for this class was generated from the following file: