LibCarna Version 3.4.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
LibCarna::helpers::FrameRendererHelper< RenderStageOrder > Class Template Reference

Adds rendering stages to a base::FrameRenderer object according to RenderStageOrder. More...

#include <FrameRendererHelper.hpp>

+ Collaboration diagram for LibCarna::helpers::FrameRendererHelper< RenderStageOrder >:

Public Member Functions

 FrameRendererHelper (base::RenderStageSequence &renderer)
 Instantiates helper for renderer.
 
 ~FrameRendererHelper ()
 Deletes.
 
FrameRendererHelper< RenderStageOrder > & operator<< (base::RenderStage *rs)
 Takes possession of rs and adds it to the renderer when commit is invoked.
 
void reset ()
 Resets changes that have been made since the last invocation of commit.
 
void commit (bool clear=true)
 Commits recorded changes to the associated renderer. Removes all previosly committed stages if clear is true.
 

Public Attributes

base::RenderStageSequencerenderer
 References the configured renderer.
 

Detailed Description

template<typename RenderStageOrder>
class LibCarna::helpers::FrameRendererHelper< RenderStageOrder >

Adds rendering stages to a base::FrameRenderer object according to RenderStageOrder.

Todo:
Finish this.
Author
Leonid Kostrykin

Definition at line 80 of file FrameRendererHelper.hpp.

Constructor & Destructor Documentation

◆ FrameRendererHelper()

template<typename RenderStageOrder >
LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::FrameRendererHelper ( base::RenderStageSequence renderer)
explicit

Instantiates helper for renderer.

Definition at line 125 of file FrameRendererHelper.hpp.

◆ ~FrameRendererHelper()

template<typename RenderStageOrder >
LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::~FrameRendererHelper ( )

Deletes.

Definition at line 132 of file FrameRendererHelper.hpp.

Member Function Documentation

◆ commit()

template<typename RenderStageOrder >
void LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::commit ( bool  clear = true)

Commits recorded changes to the associated renderer. Removes all previosly committed stages if clear is true.

Definition at line 147 of file FrameRendererHelper.hpp.

◆ operator<<()

template<typename RenderStageOrder >
LibCarna::helpers::FrameRendererHelper< RenderStageOrder > & LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::operator<< ( base::RenderStage rs)

Takes possession of rs and adds it to the renderer when commit is invoked.

Definition at line 147 of file FrameRendererHelper.hpp.

◆ reset()

template<typename RenderStageOrder >
void LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::reset ( )

Resets changes that have been made since the last invocation of commit.

Definition at line 139 of file FrameRendererHelper.hpp.

Member Data Documentation

◆ renderer

template<typename RenderStageOrder >
base::RenderStageSequence& LibCarna::helpers::FrameRendererHelper< RenderStageOrder >::renderer

References the configured renderer.

Definition at line 108 of file FrameRendererHelper.hpp.


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