OSGK::GeckoMem Struct Reference

Gecko memory allocator access. More...

#include <OffscreenGecko/geckomem.h>

Inheritance diagram for OSGK::GeckoMem:

List of all members.

Public Member Functions
void *	Alloc (size_t size)
	Allocate some memory using Gecko's memory allocator.
void *	Clone (const void *p, size_t size)
	Allocate some memory using Gecko's memory allocator and copy some data into into it.
void	Free (void *p)
	Free memory allocated using Gecko's memory allocator.
	GeckoMem (WrappedType *obj)
GeckoMem &	operator= (const GeckoMem &other)
void *	Realloc (void *p, size_t size)
	Reallocate a block of memory allocated with Gecko's memory allocator with a new size.

---

Detailed Description

Gecko memory allocator access.

Using it is sometimes required when handing memory back to Gecko (e.g. from custom class implementations).

---

Constructor & Destructor Documentation

OSGK::GeckoMem::GeckoMem

(

WrappedType *

obj

)

[inline, explicit]

---

Member Function Documentation

void* OSGK::GeckoMem::Alloc

(

size_t

size

)

[inline]

Allocate some memory using Gecko's memory allocator.

Parameters:

size

Amount of memory to allocate.

Returns:

Allocated block of memory or 0 if out of memory.

void* OSGK::GeckoMem::Clone	(	const void *	p,
		size_t	size
	)			[inline]

Allocate some memory using Gecko's memory allocator and copy some data into into it.

Parameters:

	p	Data to copy.
	size	Amount of memory to allocate and size of data to copy.

Returns:

Allocated block of memory or 0 if out of memory.

void OSGK::GeckoMem::Free

(

void *

p

)

[inline]

Free memory allocated using Gecko's memory allocator.

Parameters:

p

Block of memory to free.

GeckoMem& OSGK::GeckoMem::operator=

(

const GeckoMem &

other

)

[inline]

void* OSGK::GeckoMem::Realloc	(	void *	p,
		size_t	size
	)			[inline]

Reallocate a block of memory allocated with Gecko's memory allocator with a new size.

Parameters:

	p	Block of memory to reallocate.
	size	New amount of memory.

Returns:

Re-allocated block of memory or 0 if the reallocation failed.

---

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

• include/OffscreenGecko/geckomem.h

---