LibGalloc Documentation

This document describes the API and usage of LibGalloc, a graphics target resource allocator for LibGGI and its various extensions.


Table of Contents
Preface
I. Introduction
1. Introduction
2. How to compile and install LibGAlloc
II. LibGAlloc Documentation
3. Resources
Types of Resources
Variants: Motors, Tanks, and Carbs
The Request List
The Resource State
4. Resource Properties
Fields Common to Most Resources
The Storage Type
Motor Resource Properties
Tank Resource Properties
Carb Resource Properties
5. LibGAlloc Usage
Overview of typical LibGAlloc usage
Tips and Tricks
III. LibGAlloc APIs
I. LibGAlloc API
ggiGAInit -- Extension management functions for LibGAlloc.
ggiGAAdd -- Add a resource given properties to a LibGAlloc request list
ggiGAGet -- Send and retreive a LibGAlloc request list to/from a visual.
ggiGAanprintf -- Get a human readable string from a LibGAlloc resource list
ggiGAEmptyList -- Free LibGAlloc resource list structure
ggiGARelease -- Release resources allocated by LibGAlloc
ggiGAGetProperties -- Get a pointer to properties in a LibGAlloc request list
ggiGAIsFailed -- Get peices of information from a LibGAlloc resource handle
ggiGAAddSimpleMode -- Simplified forms of ggiGAAddMode
ggiGAGetType -- Get or set the allocation state of a resource.
ggiGAGetState -- Get or set the allocation state of a resource.
IV. Frequently Asked Questions
6. LibGAlloc Frequently Asked Questions
List of Examples
1. ggiGAInit/ggiGAAttach/ggiGADetach/ggiGAExit Example
1. ggiGAAdd/ggiGAAddMode Example
1. ggiGAGet/ggiGACheck/ggiGASet Example
1. ggiGAanprintf Example
1. ggiGAEmptyList Example
1. ggiGARelease/ggiGARelease Example
1. ggiGAGetProperties/ggiGAGetggiMode/ggiGAGetggiDB Example
1. ggiGAGetType Example
1. ggiGAGetState/ggiGASetState Example