Ignition Rendering

API Reference

6.3.1
RenderEnginePlugin Class Referenceabstract

Base plugin class for render engines. More...

#include <RenderEnginePlugin.hh>

Public Member Functions

 RenderEnginePlugin ()
 Constructor. More...
 
virtual ~RenderEnginePlugin ()
 Destructor. More...
 
virtual RenderEngineEngine () const =0
 Get a pointer to the render engine. More...
 
virtual std::string Name () const =0
 Get the name of render engine. More...
 

Public Attributes

std::unique_ptr< RenderEnginePluginPrivate > dataPtr
 Pointer to private data class. More...
 

Detailed Description

Base plugin class for render engines.

Constructor & Destructor Documentation

◆ RenderEnginePlugin()

Constructor.

◆ ~RenderEnginePlugin()

virtual ~RenderEnginePlugin ( )
virtual

Destructor.

Member Function Documentation

◆ Engine()

virtual RenderEngine* Engine ( ) const
pure virtual

Get a pointer to the render engine.

Returns
Render engine instance

Implemented in OgreRenderEnginePlugin.

◆ Name()

virtual std::string Name ( ) const
pure virtual

Get the name of render engine.

Returns
Name of render engine

Implemented in OgreRenderEnginePlugin.

Member Data Documentation

◆ dataPtr

std::unique_ptr<RenderEnginePluginPrivate> dataPtr

Pointer to private data class.


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