Dynui::ImguiRTPlugin Class Reference

#include <imguirtplugin.h>

Inherits RenderModules::RTPlugin.

Public Member Functions
	ImguiRTPlugin ()
	constructor
virtual	~ImguiRTPlugin ()
	destructor
virtual void	OnRegister ()
	called when plugin is registered on the render-thread side
virtual void	OnUnregister ()
	called when plugin is unregistered on the render-thread side
virtual void	OnRenderFrameBatch (const Ptr< Frame::FrameBatch > &frameBatch)
	called when rendering a frame batch
virtual void	OnWindowResized (IndexT windowId, SizeT width, SizeT height)
	called if the window size has changed
Public Member Functions inherited from RenderModules::RTPlugin
	RTPlugin ()
	constructor
virtual	~RTPlugin ()
	destructor
virtual void	OnStageCreated (const Ptr< Graphics::Stage > &stage)
	called when a new stage has been created
virtual void	OnDiscardStage (const Ptr< Graphics::Stage > &stage)
	called when a stage is discarded
virtual void	OnViewCreated (const Ptr< Graphics::View > &view)
	called when a new view has been created
virtual void	OnDiscardView (const Ptr< Graphics::View > &view)
	called when a view is being discarded
virtual void	OnAttachEntity (const Ptr< Graphics::GraphicsEntity > &entity)
	called when a graphics entity has been attached to a stage
virtual void	OnRemoveEntity (const Ptr< Graphics::GraphicsEntity > &entity)
	called when a graphics entity is being removed from a stage
virtual void	OnUpdateBefore (IndexT frameId, Timing::Time time)
	called before updating entities
virtual void	OnUpdateAfter (IndexT frameId, Timing::Time time)
	called after updating entities
virtual void	OnRenderBefore (IndexT frameId, Timing::Time time)
	called before rendering entities
virtual void	OnRenderAfter (IndexT frameId, Timing::Time time)
	called after rendering entities
virtual void	OnRender (const Util::StringAtom &filter)
	called when rendering a specific subset of plugins
virtual void	OnFrameBefore (IndexT frameId, Timing::Time time)
	called at the beginning of frame
virtual void	OnFrameAfter (IndexT frameId, Timing::Time time)
	called at the end of frame
virtual void	OnRenderFrame ()
	called when rendering from special frame tag
virtual void	OnRenderWithoutView (IndexT frameId, Timing::Time time)
	called if no view exists, and no default camera is set in view
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (ImguiRTPlugin)

Private Attributes
Ptr< ImguiRenderer >	renderer

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

ImguiRTPlugin()

Dynui::ImguiRTPlugin::ImguiRTPlugin

(

)

constructor

~ImguiRTPlugin()

Dynui::ImguiRTPlugin::~ImguiRTPlugin ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Dynui::ImguiRTPlugin::__DeclareClass ( ImguiRTPlugin )

private

OnRegister()

void Dynui::ImguiRTPlugin::OnRegister ( )

virtual

called when plugin is registered on the render-thread side

Reimplemented from RenderModules::RTPlugin.

OnRenderFrameBatch()

void Dynui::ImguiRTPlugin::OnRenderFrameBatch ( const Ptr< Frame::FrameBatch > & frameBatch )

virtual

called when rendering a frame batch

OnUnregister()

void Dynui::ImguiRTPlugin::OnUnregister ( )

virtual

called when plugin is unregistered on the render-thread side

Reimplemented from RenderModules::RTPlugin.

OnWindowResized()

void Dynui::ImguiRTPlugin::OnWindowResized ( IndexT windowId, SizeT width, SizeT height )

virtual

called if the window size has changed

Reimplemented from RenderModules::RTPlugin.

Member Data Documentation

renderer

Ptr<ImguiRenderer> Dynui::ImguiRTPlugin::renderer

private

---

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

• /github/workspace/code/addons/dynui/imguirtplugin.h
• /github/workspace/code/addons/dynui/imguirtplugin.cc