ph::WorkUnit Class Reference

Represents some amount of work. More...

#include <WorkUnit.h>

Public Member Functions
	WorkUnit ()
	Represents zero amount of work.
	WorkUnit (const Region &region)
	Represents a rectangular region of work with unit depth.
	WorkUnit (const Region &region, std::size_t depth)
	Represents a volume of work with specified dimensions.
Region	getRegion () const
int64	getWidth () const
int64	getHeight () const
std::size_t	getDepth () const
std::size_t	getVolume () const
float64	getAspectRatio () const
std::string	toString () const

Detailed Description

Represents some amount of work.

Represents some amount of work as a volume with specific dimensions. The actual units of the dimensions are depend on the use case.

Constructor & Destructor Documentation

WorkUnit() [1/3]

ph::WorkUnit::WorkUnit ( )

inline

Represents zero amount of work.

WorkUnit() [2/3]

ph::WorkUnit::WorkUnit ( const Region & region )

inlineexplicit

Represents a rectangular region of work with unit depth.

WorkUnit() [3/3]

ph::WorkUnit::WorkUnit ( const Region & region, std::size_t depth )

inline

Represents a volume of work with specified dimensions.

Member Function Documentation

getAspectRatio()

float64 ph::WorkUnit::getAspectRatio ( ) const

inline

getDepth()

std::size_t ph::WorkUnit::getDepth ( ) const

inline

getHeight()

int64 ph::WorkUnit::getHeight ( ) const

inline

getRegion()

Region ph::WorkUnit::getRegion ( ) const

inline

getVolume()

std::size_t ph::WorkUnit::getVolume ( ) const

inline

getWidth()

int64 ph::WorkUnit::getWidth ( ) const

inline

toString()

std::string ph::WorkUnit::toString ( ) const

inline

---

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

• Source/Core/Scheduler/WorkUnit.h