gam::DoubleBuffer< T, A > Class Template Reference

Container for reading and writing arrays using front and back buffers. More...

#include <Containers.h>

Inheritance diagram for gam::DoubleBuffer< T, A >:

List of all members.

Public Member Functions
	DoubleBuffer (uint32_t singleBufSize=0)
T &	operator[] (uint32_t i)
	Set front buffer element.
const T &	operator[] (uint32_t i) const
	Get front buffer element.
T *	back ()
	Returns a pointer to the back (older) buffer.
T *	front ()
	Returns a pointer to the front (newer) buffer.
void	swap ()
	Swaps the front and back buffers.
void	copyAll (T *dst)
	Copy contents to dst, back buffer first then front.
ArrayBase &	assign (const T &v)
	Sets all elements to value.
ArrayBase &	assign (const T &v, uint32_t end, uint32_t stride=1, uint32_t start=0)
	Sets linear slice of elements to value.
T *	elems ()
	Get writable pointer to elements.
const T *	elems () const
	Get read-only pointer to elements.
uint32_t	size () const
	Returns number of elements in array.
void	clear ()
	Destroys all elements and frees memory.
void	own ()
	Ensures ownership of elements.
bool	isSoleOwner () const
	Returns true if we are the sole owner of data internally allocated.
void	resize (uint32_t newSize, const T &c=T())
	Resizes number of elements in array.
void	source (ArrayBase< T, SizeArray, A > &src)
	Sets source of array elements to another array.
void	source (T *src, uint32_t size)
	Sets source of array elements to another array.
Static Public Member Functions
static int	references (T *m)
	Returns number of pointers to memory address being managed.

---

Detailed Description

template<class T, class A = gam::Allocator<T>>
class gam::DoubleBuffer< T, A >

Container for reading and writing arrays using front and back buffers.

---

Constructor & Destructor Documentation

template<class T , class A >

gam::DoubleBuffer< T, A >::DoubleBuffer

(

uint32_t

singleBufSize = 0

)

[explicit]

Parameters:

[in]

singleBufSize

Number of elements in single buffer (allocated size will be twice this).

---

Member Function Documentation

ArrayBase& gam::ArrayBase< T, SizeArray , A >::assign	(	const T &	v,
		uint32_t	end,
		uint32_t	stride = 1,
		uint32_t	start = 0
	)		[inherited]

Sets linear slice of elements to value.

Parameters:

[in]	v	value to be copied as new content
[in]	end	end index (exclusive)
[in]	stride	index stride amount
[in]	start	start index (inclusive)

void gam::ArrayBase< T, SizeArray , A >::own

(

)

[inherited]

Ensures ownership of elements.

If the array is not already the sole owner, new memory is allocated and the previously referenced array elements are copied.

void gam::ArrayBase< T, SizeArray , A >::resize	(	uint32_t	newSize,
		const T &	c = T()
	)		[inherited]

Resizes number of elements in array.

If the new size is less than the old size, then elements are truncated. If the new size is greater than the old size, then the argument value is copied into the additional elements.

---

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

• /Users/ljp/code/gamma/trunk/Gamma/Containers.h