HPS::Memory Class Reference

#include <hps.h>

Static Public Member Functions

static void * Allocate (size_t in_bytes, bool in_clear_memory=true)
 
static void Free (void *in_pointer)
 

Detailed Description

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

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_bytesThe amount of memory requested.
in_clear_memoryIf this flag is set, the memory will be nulled before being returned.
Returns
A pointer to the allocated memory.

◆ 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_pointerA pointer to memory previously allocated in the Visualize memory space.

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