"Fossies" - the Fresh Open Source Software Archive

Member "libgd-2.3.2/docs/naturaldocs/html/files/gd_wbmp-c.html" (5 Mar 2021, 23649 Bytes) of package /linux/www/libgd-2.3.2.tar.gz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the project site itself.

WBMP IO

Read and write WBMP images.

Summary
WBMP IORead and write WBMP images.
Functions
gdImageWBMPCtxWrite the image as a wbmp file
gdImageCreateFromWBMPCtxReads in a WBMP image via a gdIOCtx struct.
gdImageCreateFromWBMPgdImageCreateFromWBMP is called to load images from WBMP format files.
gdImageCreateFromWBMPPtr
gdImageWBMP
gdImageWBMPPtr

Functions

gdImageWBMPCtx

void gdImageWBMPCtx(gdImagePtr image,
int fg,
gdIOCtx *out)

Write the image as a wbmp file

Parameters

imagegd image structure
fgthe index of the foreground color. any other value will be considered as background and will not be written
outthe stream where to write

gdImageCreateFromWBMPCtx

gdImagePtr gdImageCreateFromWBMPCtx(gdIOCtx *infile)

Reads in a WBMP image via a gdIOCtx struct.  See gdImageCreateFromWBMP.

gdImageCreateFromWBMP

gdImagePtr gdImageCreateFromWBMP(FILE *inFile)

gdImageCreateFromWBMP is called to load images from WBMP format files.  Invoke gdImageCreateFromWBMP with an already opened pointer to a file containing the desired image.  gdImageCreateFromWBMP returns a gdImagePtr to the new image, or NULL if unable to load the image (most often because the file is corrupt or does not contain a WBMP image).  gdImageCreateFromWBMP does not close the file.  You can inspect the sx and sy members of the image to determine its size.  The image must eventually be destroyed using gdImageDestroy.

Variants

gdImageCreateFromWBMPPtr creates an image from WBMP data (i.e. the contents of a WBMP file) already in memory.

gdImageCreateFromWBMPCtx reads in an image using the functions in a gdIOCtx struct.

Parameters

infileThe input FILE pointer

Returns

A pointer to the new image or NULL if an error occurred.

Example

gdImagePtr im;
FILE *in;
in = fopen("mywbmp.wbmp", "rb");
im = gdImageCreateFromWBMP(in);
fclose(in);
// ... Use the image ...
gdImageDestroy(im);

gdImageCreateFromWBMPPtr

gdImagePtr gdImageCreateFromWBMPPtr(int size,
void *data)

Parameters

sizesize of WBMP data in bytes.
dataWBMP data (i.e. contents of a WBMP file).

See gdImageCreateFromWBMP.

gdImageWBMP

void gdImageWBMP(gdImagePtr im,
int fg,
FILE *outFile)

gdImageWBMPPtr

void * gdImageWBMPPtr(gdImagePtr im,
int *size,
int fg)
void gdImageWBMPCtx(gdImagePtr image,
int fg,
gdIOCtx *out)
Write the image as a wbmp file
gdImagePtr gdImageCreateFromWBMPCtx(gdIOCtx *infile)
Reads in a WBMP image via a gdIOCtx struct.
gdIOCtx structures hold function pointers for doing image IO.
gdImagePtr gdImageCreateFromWBMP(FILE *inFile)
gdImageCreateFromWBMP is called to load images from WBMP format files.
gdImagePtr gdImageCreateFromWBMPPtr(int size,
void *data)
void gdImageWBMP(gdImagePtr im,
int fg,
FILE *outFile)
void * gdImageWBMPPtr(gdImagePtr im,
int *size,
int fg)
void gdImageDestroy (gdImagePtr im)
gdImageDestroy is used to free the memory associated with an image.
Close