Blame docs/naturaldocs/html/files/gd_io-h.html

Packit ed3af9
Packit ed3af9
Packit ed3af9
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>/parent/libgd/docs/naturaldocs/tmp/gd_io.h</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript>
Packit ed3af9
if (browserType) {document.write("
");if (browserVer) {document.write("
"); }}// --></script>
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9

gd_io.h

Summary
gd_io.h
Types
gdIOCtxgdIOCtx structures hold function pointers for doing image IO.
Packit ed3af9
Packit ed3af9

Types

Packit ed3af9
Packit ed3af9

gdIOCtx

gdIOCtx structures hold function pointers for doing image IO.

Most of the gd functions that read and write files, such as gdImagePng also have variants that accept a gdIOCtx structure; see gdImagePngCtx and gdImageCreateFromJpegCtx.

Those who wish to provide their own custom routines to read and write images can populate a gdIOCtx structure with functions of their own devising to to read and write data.  For image reading, the only mandatory functions are getC and getBuf, which must return the number of characters actually read, or a negative value on error or EOF.  These functions must read the number of characters requested unless at the end of the file.

For image writing, the only mandatory functions are putC and putBuf, which return the number of characters written; these functions must write the number of characters requested except in the event of an error.  The seek and tell functions are only required in conjunction with the gd2 file format, which supports quick loading of partial images.  The gd_free function will not be invoked when calling the standard Ctx functions; it is an implementation convenience when adding new data types to gd.  For examples, see gd_png.c, gd_gd2.c, gd_jpeg.c, etc., all of which rely on gdIOCtx to implement the standard image read and write functions.

typedef struct gdIOCtx
Packit ed3af9
{
Packit ed3af9
  int (*getC) (struct gdIOCtx *);
Packit ed3af9
  int (*getBuf) (struct gdIOCtx *, void *, int wanted);
Packit ed3af9
Packit ed3af9
  void (*putC) (struct gdIOCtx *, int);
Packit ed3af9
  int (*putBuf) (struct gdIOCtx *, const void *, int wanted);
Packit ed3af9
Packit ed3af9
  // seek must return 1 on SUCCESS, 0 on FAILURE. Unlike fseek!
Packit ed3af9
  int (*seek) (struct gdIOCtx *, const int);
Packit ed3af9
  long (*tell) (struct gdIOCtx *);
Packit ed3af9
Packit ed3af9
  void (*gd_free) (struct gdIOCtx *);
Packit ed3af9
} gdIOCtx;
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
Packit ed3af9
--></script>
<input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Constants">Constants</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Macros">Macros</option><option value="Types">Types</option></select>
<script language=JavaScript>
Packit ed3af9
HideAllBut([], 4);// --></script>
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
void gdImagePng (gdImagePtr im,
FILE *outFile)
Equivalent to calling gdImagePngEx with compression of -1.
gdIOCtx structures hold function pointers for doing image IO.
void gdImagePngCtx (gdImagePtr im,
gdIOCtx *outfile)
Equivalent to calling gdImagePngCtxEx with compression of -1.
gdImagePtr gdImageCreateFromJpegCtx(gdIOCtx *infile)
See gdImageCreateFromJpeg.
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
Packit ed3af9
<iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe>Close
Packit ed3af9
Packit ed3af9
Packit ed3af9
<script language=JavaScript>
Packit ed3af9
if (browserType) {if (browserVer) {document.write(""); }document.write("");}// --></script></body></html>