HPS::Memory Class Reference

The Memory class contains functions for allocating and freeing memory in the Visualize memory space. More...

#include <hps.h>

Static Public Member Functions
static void *	Allocate (size_t in_bytes, bool in_clear_memory=true)
	Allocates memory in the Visualize memory space and returns a pointer to the user. More...
static void	Free (void *in_pointer)
	Frees memory that has previously been allocated in the Visualize memory space. More...

Private Member Functions
	Memory ()
	Private default constructor to prevent instantiation. More...

Detailed Description

The Memory class contains functions for allocating and freeing memory in the Visualize memory space.

Constructor & Destructor Documentation

Memory()

HPS::Memory::Memory ( )

private

Private default constructor to prevent instantiation.

Member Function Documentation

Allocate()

static void* HPS::Memory::Allocate ( size_t  in_bytes, bool  in_clear_memory = true  )

static

Allocates memory in the Visualize memory space and returns a pointer to the user.

Parameters

in_bytes	The amount of memory requested.
in_clear_memory	If this flag is set, the memory will be nulled before being returned.

Returns

A pointer to the allocated memory.

Here is the caller graph for this function:

Free()

static void HPS::Memory::Free ( void *  in_pointer )

static

Frees memory that has previously been allocated in the Visualize memory space.

Calling this function to free memory allocated in any another way has undefined behavior.

Parameters

in_pointer

A pointer to memory previously allocated in the Visualize memory space.

Here is the caller graph for this function:

---

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

• hps.h