Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Graphics::RenderWorkUnit Class Reference

This does the main loop processing for required to make the Graphics Manager function. More...

#include <graphicsmanager.h>

+ Inheritance diagram for Mezzanine::Graphics::RenderWorkUnit:
+ Collaboration diagram for Mezzanine::Graphics::RenderWorkUnit:

Public Member Functions

 RenderWorkUnit (GraphicsManager *Target)
 Create a GraphicsWorkUnit. More...
 
virtual ~RenderWorkUnit ()
 virtual deconstructor
 
virtual void DoWork (Threading::DefaultThreadSpecificStorage::Type &CurrentThreadStorage)
 This does any required update of the Graphical Scene graph and REnders one frame.
 
virtual void UseThreads (const Whole &AmountToUse)
 Once The graphics is properly multithread, this will set the amount of threads it should use. More...
 
virtual Whole UsingThreadCount ()
 Get the amount of threads this will attempt to sue. More...
 
- Public Member Functions inherited from Mezzanine::Threading::MonopolyWorkUnit
virtual ~MonopolyWorkUnit ()
 A virtual destructor, currently empty.
 
- Public Member Functions inherited from Mezzanine::Threading::DefaultWorkUnit
 DefaultWorkUnit ()
 Simple constructor.
 
virtual ~DefaultWorkUnit ()
 Virtual destructor, doesn't actually do much.
 
virtual void AddDependency (iWorkUnit *NewDependency)
 Force this WorkUnit to Start after another has completed. More...
 
virtual void ClearDependencies ()
 Drop any information about what work units this one depends on.
 
virtual iWorkUnitGetDependency (Whole Index) const
 This is used to iterate of all the dependencies. More...
 
virtual Whole GetDependencyCount () const
 How many other WorkUnits does this one depend on? More...
 
virtual Whole GetDependentCount (FrameScheduler &SchedulerToCount)
 This returns the count workunits that depend on this work unit. More...
 
virtual Whole GetImmediateDependencyCount () const
 Get the amount of dependencies that directly count on this for access purposes. More...
 
virtual Whole GetPerformance () const
 Get the internal rolling average for querying. More...
 
virtual RollingAverage< Whole > & GetPerformanceLog ()
 Get the internal rolling average for querying. More...
 
virtual RunningState GetRunningState () const
 Retrieves the current RunningState of the thread. More...
 
virtual WorkUnitKey GetSortingKey (FrameScheduler &SchedulerToCount)
 Get the sorting metadata. More...
 
virtual bool IsEveryDependencyComplete ()
 Check if this WorkUnit could concievably run right now. More...
 
virtual void operator() (DefaultThreadSpecificStorage::Type &CurrentThreadStorage)
 This does everything required to track metadata and log work. More...
 
virtual void PrepareForNextFrame ()
 This resets the running state and takes any further action required to use the WorkUnit again.
 
virtual void RemoveDependency (iWorkUnit *RemoveDependency)
 Remove a dependency. More...
 
virtual RunningState TakeOwnerShip ()
 Attempts to atomically start the work unit in the current thread. More...
 
- Public Member Functions inherited from Mezzanine::Threading::iWorkUnit
virtual ~iWorkUnit ()
 Virtual destructor.
 

Additional Inherited Members

- Protected Attributes inherited from Mezzanine::Threading::DefaultWorkUnit
Int32 CurrentRunningState
 This controls do work with this after it has.
 
std::vector< iWorkUnit * > Dependencies
 A collection of of workunits that must be complete before this one can start.
 
DefaultRollingAverage< Whole >::Type PerformanceLog
 A rolling average of execution times.
 

Detailed Description

This does the main loop processing for required to make the Graphics Manager function.

Definition at line 75 of file graphicsmanager.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::RenderWorkUnit::RenderWorkUnit ( GraphicsManager Target)

Create a GraphicsWorkUnit.

Parameters
WhichGraphicsManagerThis is the Manager that this Work unit must work with.

Definition at line 91 of file graphicsmanager.cpp.

Member Function Documentation

void Mezzanine::Graphics::RenderWorkUnit::UseThreads ( const Whole AmountToUse)
virtual

Once The graphics is properly multithread, this will set the amount of threads it should use.

Parameters
AmountToUseCurrently Ignored.

Implements Mezzanine::Threading::MonopolyWorkUnit.

Definition at line 98 of file graphicsmanager.cpp.

Whole Mezzanine::Graphics::RenderWorkUnit::UsingThreadCount ( )
virtual

Get the amount of threads this will attempt to sue.

Returns
1, this will return 1 until this Ogre threading is implemented.

Implements Mezzanine::Threading::MonopolyWorkUnit.

Definition at line 103 of file graphicsmanager.cpp.


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