Partially implements a rendering stage that uses at least one render queue for rendering geometry from the scene graph. More...
#include <GeometryStage.h>
Inheritance diagram for Carna::base::GeometryStage< RenderableCompare >:
Collaboration diagram for Carna::base::GeometryStage< RenderableCompare >:
Public Member Functions | |
| GeometryStage (unsigned int geometryType, unsigned int geometryTypeMask=RenderQueue< RenderableCompare >::EXACT_MATCH_GEOMETRY_TYPE_MASK) | |
| Instantiates s.t. the predefined rendering queue enqueues such Carna::base::Geometry scene graph nodes, whose geometry type AND-linked with geometryTypeMask equals the geometryType specified here. | |
| virtual | ~GeometryStage () |
| Releases acquired video resources. | |
| virtual void | prepareFrame (Node &root) override |
| Called once before each frame. More... | |
| virtual void | renderPass (const math::Matrix4f &viewTransform, RenderTask &rt, const Viewport &vp) override |
| Called once per pass. More... | |
| std::size_t | renderedPassesCount () const |
| Tells the number of passes rendered so far since the beginning of the current frame. | |
| template<typename GeometryFeatureType > | |
| GeometryFeatureType::ManagedInterface & | videoResource (GeometryFeatureType &geometryFeature) const |
| Interfaces the geometryFeature video resources that were acquired by this rendering stage. | |
| template<typename GeometryFeatureType > | |
| const GeometryFeatureType::ManagedInterface & | videoResource (const GeometryFeatureType &geometryFeature) const |
| Public Member Functions inherited from Carna::base::RenderStage | |
| RenderStage () | |
| Instantiates in enabled-state. | |
| virtual | ~RenderStage () |
| Deletes. | |
| virtual RenderStage * | clone () const =0 |
Returns same RenderStage implementation with same configuration. More... | |
| void | setViewTransformFixed (bool viewTransformFixed) |
| Sets whether the view transform is pass-invariant for the duration of a single frame. More... | |
| bool | isViewTransformFixed () const |
| Tells whether the view transform is pass-invariant for the duration of a single frame. | |
| virtual void | reshape (FrameRenderer &fr, unsigned int width, unsigned int height) |
| Orders this stage to reshape its buffers according to the specified dimensions. More... | |
| bool | isInitialized () const |
| Tells whether this stage is ready for rendering. More... | |
| bool | isEnabled () const |
| Tells whether this stage is enabled. Disabled stages are not rendered by render tasks. | |
| void | setEnabled (bool) |
| Sets whether this stage is enabled. Disabled stages are not rendered by render tasks. | |
| base::FrameRenderer & | renderer () |
| References the renderer this stage belongs to. More... | |
| const base::FrameRenderer & | renderer () const |
| void | addRenderStageListener (RenderStageListener &listener) |
| Adds listener to the set of listeners this instance notifies in \(\mathcal O\left(\log n\right)\). | |
| void | removeRenderStageListener (RenderStageListener &listener) |
| Removes listener from the set of listeners this instance notifies in \(\mathcal O\left(\log n\right)\). | |
Public Attributes | |
| const unsigned int | geometryType |
| Renders such geometries whose type AND-linked with geometryTypeMask equals this. | |
| const unsigned int | geometryTypeMask |
| Renders such geometries whose type AND-linked with this equals geometryType. | |
Protected Member Functions | |
| void | activateGLContext () const |
| Ensures that the OpenGL context of the hosting Carna::base::FrameRenderer is the current one. | |
| virtual void | buildRenderQueues (Node &root, const math::Matrix4f &viewTransform) |
| Builds the rendering queues of this stage. | |
| virtual void | rewindRenderQueues () |
| Rewinds the rendering queues of this stage. | |
| virtual void | updateRenderQueues (const math::Matrix4f &viewTransform) |
| Recomputes the model-view transforms of the renderables enqueued by this stage. | |
| virtual void | render (const Renderable &renderable)=0 |
| Renders the renderable. | |
Protected Attributes | |
| RenderQueue< RenderableCompare > | rq |
| Holds the predefined rendering queue of this rendering stage. | |
Detailed Description
template<typename RenderableCompare>
class Carna::base::GeometryStage< RenderableCompare >
Partially implements a rendering stage that uses at least one render queue for rendering geometry from the scene graph.
- Parameters
-
RenderableCompare Defines partial order of renderables that is applied to the predefined rendering queue of this stage. Set this to voidif no particular order is required.
Override updateRenderQueues and rewindRenderQueues if you require further rendering queues.
- See also
- Refer to the documentation of the rendering process for further notes on how rendering stages operate.
- Date
- 21.2.15 - 6.3.15
Definition at line 59 of file GeometryStage.h.
Member Function Documentation
◆ prepareFrame()
|
overridevirtual |
Called once before each frame.
Reimplemented from Carna::base::RenderStage.
Definition at line 189 of file GeometryStage.h.
◆ renderPass()
|
overridevirtual |
Called once per pass.
If this rendering stage maintains one or more Carna::base::RenderQueue objects, than this is the right place to build them. Note that the queues need to be rebuilt only once per frame and not per pass, unless isViewTransformFixed is false. If it is true and this is not the first invocation of this method since the last time prepareFrame was called, rewinding the queue will be sufficient.
Implements Carna::base::RenderStage.
Reimplemented in Carna::presets::VolumeRenderingStage, Carna::presets::DVRStage, Carna::presets::DRRStage, Carna::presets::MeshColorCodingStage, Carna::base::MeshRenderingStage< RenderableCompare >, Carna::base::MeshRenderingStage< base::Renderable::BackToFront >, Carna::presets::MaskRenderingStage, Carna::presets::MIPStage, Carna::presets::CuttingPlanesStage, and Carna::presets::TransparentRenderingStage.
Definition at line 226 of file GeometryStage.h.
◆ videoResource()
| const GeometryFeatureType::ManagedInterface & Carna::base::GeometryStage< RenderableCompare >::videoResource | ( | const GeometryFeatureType & | geometryFeature | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 306 of file GeometryStage.h.
The documentation for this class was generated from the following file:
- include/Carna/base/GeometryStage.h