hx3d  1
2D/3D Simple Game Framework
Public Member Functions | List of all members
hx3d::Pool< T > Class Template Reference

Manage poolable elements. More...

#include <pool.hpp>

Public Member Functions

template<class... Args>
 Pool (unsigned int size, Args...args)
 Construct a pool with a size and arguments. More...
 
const Ptr< T > & take ()
 Fetch a free poolable element. More...
 
void release (const Ptr< T > &ptr)
 Release a poolable element. More...
 
const std::set< Ptr< T > > & getWorking ()
 Get the locked elements. More...
 

Detailed Description

template<class T>
class hx3d::Pool< T >

Manage poolable elements.

Definition at line 35 of file pool.hpp.

Constructor & Destructor Documentation

template<class T >
template<class... Args>
hx3d::Pool< T >::Pool ( unsigned int  size,
Args...  args 
)

Construct a pool with a size and arguments.

Parameters
sizeSize
argsArguments

Definition at line 27 of file pool.inl.hpp.

Member Function Documentation

template<class T >
const std::set< Ptr< T > > & hx3d::Pool< T >::getWorking ( )

Get the locked elements.

Returns
Set of elements

Definition at line 70 of file pool.inl.hpp.

template<class T>
void hx3d::Pool< T >::release ( const Ptr< T > &  ptr)

Release a poolable element.

Parameters
ptrPoolable (Ptr)

Definition at line 55 of file pool.inl.hpp.

template<class T >
const Ptr< T > & hx3d::Pool< T >::take ( )

Fetch a free poolable element.

Returns
Poolable element

Definition at line 41 of file pool.inl.hpp.


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