This is the documentation for Enlighten.

class Enlighten FixedTimeLimiter

class Enlighten::FixedTimeLimiter

    └>Enlighten::ILimiter
        └>Geo::IGeoReleasable

Simple implementation of ILimiter which prevents new tasks from starting after a fixed time has elapsed from the start of UpdateRadiosity().

Functions

Name Description
FixedTimeLimiter(double)

Constructor.

NonCopyable(NonCopyable &&)

Defaulted to allow move.

operator=(NonCopyable &&)

Defaulted to allow move.

Release()

This function will be called when MultithreadCpuWorker is destroyed.

Release()

This function will be called when MultithreadCpuWorker is destroyed.

Release()

Free this object that was created within the Enlighten libraries.

Reset()

Reset will be called before Enlighten processing begins.

Reset()

Reset will be called before Enlighten processing begins.

Timeout()

Timeout should return FALSE if processing should continue and TRUE if processing should stop.

Timeout()

Timeout should return FALSE if processing should continue and TRUE if processing should stop.


Enlighten::FixedTimeLimiter::FixedTimeLimiter


public: FixedTimeLimiter
(
    double timeLimitInSeconds
)


Constructor.


Geo::NonCopyable::NonCopyable


public: NonCopyable
(
    NonCopyable &&
)


Defaulted to allow move.


NonCopyable& Geo::NonCopyable::operator=


public: NonCopyable & operator=
(
    NonCopyable &&
)


Defaulted to allow move.


virtual void Enlighten::FixedTimeLimiter::Release


public: virtual void Release()


This function will be called when MultithreadCpuWorker is destroyed.


virtual void Enlighten::ILimiter::Release


public: void Release()


This function will be called when MultithreadCpuWorker is destroyed.


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual void Enlighten::FixedTimeLimiter::Reset


public: virtual void Reset()


Reset will be called before Enlighten processing begins.


virtual void Enlighten::ILimiter::Reset


public: void Reset()


Reset will be called before Enlighten processing begins.


virtual bool Enlighten::FixedTimeLimiter::Timeout


public: virtual bool Timeout()


Timeout should return FALSE if processing should continue and TRUE if processing should stop.


virtual bool Enlighten::ILimiter::Timeout


public: bool Timeout()


Timeout should return FALSE if processing should continue and TRUE if processing should stop.