VRAM Library


Functions

void * pgeVramRelativePointer (void *ptr)
void * pgeVramAbsolutePointer (void *ptr)
void * pgeVramAlloc (unsigned long size)
void pgeVramFree (void *ptr)
unsigned long pgeVramAvailable ()
unsigned long pgeVramLargestBlock ()

Function Documentation

void* pgeVramAbsolutePointer ( void *  ptr  ) 

Make a pointer absolute (usable by CPU).

Note:
A relative NULL pointer is NOT illegal!
Parameters:
ptr - Pointer to make absolute
Returns:
absolute pointer matching ptr

void* pgeVramAlloc ( unsigned long  size  ) 

Allocate memory from VRAM.

Parameters:
size - Number of bytes to allocate
Returns:
Absolute pointer on success, NULL on failure

unsigned long pgeVramAvailable (  ) 

Return remaining unallocated VRAM.

Returns:
Size of remaining VRAM in bytes

void pgeVramFree ( void *  ptr  ) 

Free allocated memory from VRAM.

Parameters:
ptr - Previously allocated pointer

unsigned long pgeVramLargestBlock (  ) 

Return largest free memory block in VRAM.

Returns:
Size of largest free block in bytes

void* pgeVramRelativePointer ( void *  ptr  ) 

Make a pointer relative to VRAM base

Note:
A relative NULL pointer is NOT illegal!
Parameters:
ptr - Pointer to make relative
Returns:
relative pointer matching ptr


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5