GOLFree Function

Microchip Graphics Library

Microchip Graphics Library
GOLFree Function
C
void GOLFree();
Overview

This function frees all the memory used by objects in the active list and initializes _pGolObjects pointer to NULL to start a new empty list. This function must be called only inside the GOLDrawCallback()function when using GOLDraw() and GOLMsg() functions. This requirement assures that primitive rendering settings are not altered by the rendering state machines of the objects.

Returns

none

Preconditions

none

Side Effects

All objects in the active list are deleted from memory.

Example
void DeletePage(OBJ_HEADER *pPage) {
    OBJ_HEADER *pTemp;
    
    // assuming pPage is different from the current active list
    pTemp = GOLGetList();               // save the active list
    GOLSetList(pPage);                  // set list as active list
    GolFree();                          // pPage objects are deleted
    
    GOLSetList(pTemp);                  // restore the active list
}
Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved