Lysa  0.0
Lysa 3D Engine
Public Member Functions | Protected Member Functions | List of all members
DisplayAttachment Class Reference

Detailed Description

Post-processing pass that copies a source attachment into the output surface. When no attachment is set the pass transitions the built-in color buffer instead.

+ Inheritance diagram for DisplayAttachment:

Public Member Functions

 DisplayAttachment (const RendererConfiguration &config, const vireo::ImageFormat outputFormat, const std::string &shader="", void *data=nullptr, const uint32 dataSize=0)
 
void setAttachment (const std::shared_ptr< vireo::Image > &attachment)
 
- Public Member Functions inherited from FullScreenCompute
 FullScreenCompute (const RendererConfiguration &config, vireo::ImageFormat outputFormat, const std::string &compShaderName, void *data=nullptr, uint32 dataSize=0, const std::string &name="")
 
void update (uint32 frameIndex) override
 
virtual void render (const std::shared_ptr< vireo::CommandList > &commandList, const std::shared_ptr< vireo::Image > &colorAttachment, uint32 frameIndex)
 
virtual void render (const std::shared_ptr< vireo::CommandList > &commandList, const std::shared_ptr< vireo::Image > &colorAttachment, const std::shared_ptr< vireo::Image > &depthAttachment, uint32 frameIndex)
 
virtual void render (const std::shared_ptr< vireo::CommandList > &commandList, const SceneFrameData &scene, const std::shared_ptr< vireo::Image > &depthAttachment, uint32 frameIndex)
 
void resize (const vireo::Extent &extent, const std::shared_ptr< vireo::CommandList > &commandList) override
 
std::shared_ptr< vireo::Image > getColorAttachment (const uint32 frameIndex) const
 
std::shared_ptr< vireo::RenderTarget > getColorRenderTarget (const uint32 frameIndex)
 
virtual vireo::ImageFormat getColorAttachmentFormat () const
 
const auto & getCompShaderName () const
 
- Public Member Functions inherited from Renderpass
 Renderpass (const RendererConfiguration &config, const std::string &name)
 
virtual ~Renderpass () = default
 
 Renderpass (Renderpass &) = delete
 
Renderpass & operator= (Renderpass &) = delete
 

Protected Member Functions

void render (const std::shared_ptr< vireo::CommandList > &commandList, const std::shared_ptr< vireo::Image > &, const std::shared_ptr< vireo::Image > &, const std::shared_ptr< vireo::Image > &, const uint32 frameIndex) override
 
- Protected Member Functions inherited from Renderpass
std::shared_ptr< vireo::ShaderModule > loadShader (const std::string &shaderName) const
 
void init (vireo::GraphicPipelineConfiguration &pipelineConfig, vireo::RenderingConfiguration &renderingConfig, const std::shared_ptr< vireo::DescriptorLayout > &descriptorLayout, bool withStencil)
 
void init (vireo::GraphicPipelineConfiguration &pipelineConfig, vireo::RenderingConfiguration &renderingConfig, bool withStencil) const
 
void initForScene (vireo::GraphicPipelineConfiguration &pipelineConfig, vireo::RenderingConfiguration &renderingConfig, bool withStencil) const
 
void initRendering (const std::shared_ptr< vireo::CommandList > &commandList, const std::shared_ptr< vireo::GraphicPipeline > &pipeline, const std::shared_ptr< vireo::DescriptorSet > &sceneDescriptorSet, const std::shared_ptr< vireo::DescriptorSet > &descriptorSet)
 
void initCompute (const std::shared_ptr< vireo::CommandList > &commandList, const std::shared_ptr< vireo::ComputePipeline > &pipeline, const std::shared_ptr< vireo::DescriptorSet > &sceneDescriptorSet, const std::shared_ptr< vireo::DescriptorSet > &descriptorSet)
 

Additional Inherited Members

- Static Public Member Functions inherited from Renderpass
static void destroyShaderModules ()
 
- Static Public Attributes inherited from FullScreenCompute
static constexpr vireo::DescriptorIndex BINDING_PARAMS {0}
 
static constexpr vireo::DescriptorIndex BINDING_DATA {1}
 
static constexpr vireo::DescriptorIndex BINDING_OUTPUT {2}
 
static constexpr vireo::DescriptorIndex BINDING_TEXTURES {3}
 
static constexpr int INPUT_BUFFER {0}
 
static constexpr int DEPTH_BUFFER {1}
 
static constexpr int BLOOM_BUFFER {2}
 
static constexpr int OPT1_BUFFER {3}
 
static constexpr int OPT2_BUFFER {4}
 
static constexpr int TEXTURES_COUNT {OPT2_BUFFER + 1}
 
static constexpr uint32 TILE_SIZE {16}
 
- Protected Attributes inherited from FullScreenCompute
const vireo::ImageFormat outputFormat
 
const std::string compShaderName
 
uint8 dummyData {0}
 
void * data {nullptr}
 
std::vector< FrameData > framesData
 
std::vector< std::shared_ptr< vireo::Image > > textures
 
std::shared_ptr< vireo::DescriptorLayout > descriptorLayout
 
std::shared_ptr< vireo::Pipeline > pipeline
 
- Protected Attributes inherited from Renderpass
const std::string name
 
const RendererConfiguration & config
 
- Static Protected Attributes inherited from Renderpass
static std::mutex shaderModulesMutex
 
static std::unordered_map< std::string, std::shared_ptr< vireo::ShaderModule > > shaderModules
 

Constructor & Destructor Documentation

DisplayAttachment ( const RendererConfiguration &  config,
const vireo::ImageFormat  outputFormat,
const std::string &  shader = "",
void *  data = nullptr,
const uint32  dataSize = 0 
)
inline

Constructs the pass.

Parameters
configRenderer configuration.
outputFormatPixel format of the output surface.
shaderCompute shader name; defaults to the built-in passthrough shader.
dataOptional push-constant data block.
dataSizeSize in bytes of the push-constant block.

Member Function Documentation

void render ( const std::shared_ptr< vireo::CommandList > &  commandList,
const std::shared_ptr< vireo::Image > &  ,
const std::shared_ptr< vireo::Image > &  ,
const std::shared_ptr< vireo::Image > &  ,
const uint32  frameIndex 
)
inlineoverrideprotectedvirtual

Reimplemented from lysa::FullScreenCompute::render()

void setAttachment ( const std::shared_ptr< vireo::Image > &  attachment)
inline

Sets the source image to display. Pass nullptr to fall back to the built-in color buffer.

Parameters
attachmentSource image, or nullptr.