[ prev :: next :: up ] libggibuf-current (3)

Add a request for an ancillary buffer to a LibGAlloc request list

Name

ggiBufAdd : Add a request for an ancillary buffer to a LibGAlloc request list

Synopsis

#include <ggi/buf.h>

int ggiBufAdd(ggi_visual_t vis,
              ggiGA_resource_list *reqlist,
              enum ggiGA_resource_type subtype,
              struct ggiGA_resource_props *props,
              enum ggiBuf_flags flags,
              ggiGA_resource_handle tothis,
              ggiGA_resource_handle *handle);

Description

The ggiBufAdd function is LibBuf's interface to LibGAlloc. Currently support for these functions is sporadic; it will be completed in a later stage of LibBuf's development.

The parameter :p:`reqlist` refers to a LibGAlloc request list, and a handle to the newly added request is returned in the parameter :p:`handle`.

System Message: ERROR/3 (../lowlevel/libbuf/doc/libggibuf.txt, line 322); backlink

Unknown interpreted text role "p".

System Message: ERROR/3 (../lowlevel/libbuf/doc/libggibuf.txt, line 322); backlink

Unknown interpreted text role "p".

ggiBufAdd attaches a request for an ancilary buffer defined by the properties in :p:`props`. The parameter :p:`subtype` designates the type of ancillary buffer desired. See the LibGAlloc documentation for a list of buffer types and the meanings of the properties structure. The parameter :p:`flags` is placed in the .flags member of an auto-generated carb resource. This function is provided for advanced users who are familiar with LibGAlloc.

System Message: ERROR/3 (../lowlevel/libbuf/doc/libggibuf.txt, line 326); backlink

Unknown interpreted text role "p".

System Message: ERROR/3 (../lowlevel/libbuf/doc/libggibuf.txt, line 326); backlink

Unknown interpreted text role "p".

System Message: ERROR/3 (../lowlevel/libbuf/doc/libggibuf.txt, line 326); backlink

Unknown interpreted text role "p".

Return value

ggiBufAdd returns 0 on success, or a negative value if an error occurred.

 
[ prev :: next :: up ] libggibuf-current (3)
2008/05/04 23:15:07