"Fossies" - the Fresh Open Source Software Archive

Member "libgd-2.3.2/docs/naturaldocs/html/files/gd_png-c.html" (5 Mar 2021, 38555 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.

PNG IO

Read and write PNG images.

Summary
PNG IORead and write PNG images.
Functions
gdImageCreateFromPnggdImageCreateFromPng is called to load images from PNG format files.
gdImageCreateFromPngPtrSee gdImageCreateFromPng.
gdImageCreateFromPngCtxSee gdImageCreateFromPng.
gdImagePngExgdImagePngEx outputs the specified image to the specified file in PNG format.
gdImagePngEquivalent to calling gdImagePngEx with compression of -1.
gdImagePngPtrEquivalent to calling gdImagePngPtrEx with compression of -1.
gdImagePngPtrExIdentical to gdImagePngEx except that it returns a pointer to a memory area with the PNG data.
gdImagePngCtxEquivalent to calling gdImagePngCtxEx with compression of -1.
gdImagePngCtxExOutputs the given image as PNG data, but using a gdIOCtx instead of a file.

Functions

gdImageCreateFromPng

gdImagePtr gdImageCreateFromPng (FILE *inFile)

gdImageCreateFromPng is called to load images from PNG format files.  Invoke gdImageCreateFromPng with an already opened pointer to a FILE containing the desired image.  gdImageCreateFromPng 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 PNG image).  gdImageCreateFromPng 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().

If the PNG image being loaded is a truecolor image, the resulting gdImagePtr will refer to a truecolor image.  If the PNG image being loaded is a palette or grayscale image, the resulting gdImagePtr will refer to a palette image. gd retains only 8 bits of resolution for each of the red, green and blue channels, and only 7 bits of resolution for the alpha channel.  The former restriction affects only a handful of very rare 48-bit color and 16-bit grayscale PNG images.  The second restriction affects all semitransparent PNG images, but the difference is essentially invisible to the eye.  7 bits of alpha channel resolution is, in practice, quite a lot.

Variants

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

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

gdImageCreateFromPngSource is similar to gdImageCreateFromPngCtx but uses the old gdSource interface.  It is obsolete.

Parameters

infileThe input FILE pointer.

Returns

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

Example

gdImagePtr im;
... inside a function ...
FILE *in;
in = fopen("mypng.png", "rb");
im = gdImageCreateFromPng(in);
fclose(in);
// ... Use the image ...
gdImageDestroy(im);

gdImageCreateFromPngPtr

gdImagePtr gdImageCreateFromPngPtr (int size,
void *data)

See gdImageCreateFromPng.

gdImageCreateFromPngCtx

gdImagePtr gdImageCreateFromPngCtx (gdIOCtx *infile)

See gdImageCreateFromPng.

gdImagePngEx

void gdImagePngEx (gdImagePtr im,
FILE *outFile,
int level)

gdImagePngEx outputs the specified image to the specified file in PNG format.  The file must be open for writing.  Under MSDOS and all versions of Windows, it is important to use “wb” as opposed to simply “w” as the mode when opening the file, and under Unix there is no penalty for doing so.  gdImagePngEx does not close the file; your code must do so.

In addition, gdImagePngEx allows the level of compression to be specified.  A compression level of 0 means “no compression.”  A compression level of 1 means “compressed, but as quickly as possible.”  A compression level of 9 means “compressed as much as possible to produce the smallest possible file.”  A compression level of -1 will use the default compression level at the time zlib was compiled on your system.

Variants

gdImagePng is equivalent to calling gdImagePngEx with compression of -1.

gdImagePngCtx and gdImagePngCtxEx write via a gdIOCtx instead of a file handle.

gdImagePngPtr and gdImagePngPtrEx store the image file to memory.

Parameters

imthe image to write
outFilethe output FILE* object.
levelcompression level: 0 -> none, 1-9 -> level, -1 -> default

Returns

Nothing.

Example

gdImagePtr im;
int black, white;
FILE *out;

im = gdImageCreate(100, 100);              // Create the image
white = gdImageColorAllocate(im, 255, 255, 255); // Alloc background
black = gdImageColorAllocate(im, 0, 0, 0); // Allocate drawing color
gdImageRectangle(im, 0, 0, 99, 99, black); // Draw rectangle
out = fopen("rect.png", "wb");             // Open output file (binary)
gdImagePngEx(im, out, 9);                  // Write PNG, max compression
fclose(out);                               // Close file
gdImageDestroy(im);                        // Destroy image

gdImagePng

void gdImagePng (gdImagePtr im,
FILE *outFile)

Equivalent to calling gdImagePngEx with compression of -1.

Parameters

imthe image to save.
outFilethe output FILE*.

Returns

Nothing.

gdImagePngPtr

void * gdImagePngPtr (gdImagePtr im,
int *size)

Equivalent to calling gdImagePngPtrEx with compression of -1.

See gdImagePngEx for more information.

Parameters

imthe image to save.
sizeOutput: size in bytes of the result.

Returns

A pointer to memory containing the image data or NULL on error.

gdImagePngPtrEx

void * gdImagePngPtrEx (gdImagePtr im,
int *size,
int level)

Identical to gdImagePngEx except that it returns a pointer to a memory area with the PNG data.  This memory must be freed by the caller when it is no longer needed.  **The caller must invoke gdFree(), not free()**

The ‘size’ parameter receives the total size of the block of memory.

See gdImagePngEx for more information.

Parameters

imthe image to save.
sizeOutput: size in bytes of the result.
levelcompression level: 0 -> none, 1-9 -> level, -1 -> default

Returns

A pointer to memory containing the image data or NULL on error.

gdImagePngCtx

void gdImagePngCtx (gdImagePtr im,
gdIOCtx *outfile)

Equivalent to calling gdImagePngCtxEx with compression of -1.  See gdImagePngEx for more information.

Parameters

imthe image to save.
outfilethe gdIOCtx to write to.

Returns

Nothing.

gdImagePngCtxEx

void gdImagePngCtxEx (gdImagePtr im,
gdIOCtx *outfile,
int level)

Outputs the given image as PNG data, but using a gdIOCtx instead of a file.  See <gdIamgePnEx>.

Parameters

imthe image to save.
outfilethe gdIOCtx to write to.
levelcompression level: 0 -> none, 1-9 -> level, -1 -> default

Returns

Nothing.

gdImagePtr gdImageCreateFromPng (FILE *inFile)
gdImageCreateFromPng is called to load images from PNG format files.
gdImagePtr gdImageCreateFromPngPtr (int size,
void *data)
See gdImageCreateFromPng.
gdImagePtr gdImageCreateFromPngCtx (gdIOCtx *infile)
See gdImageCreateFromPng.
void gdImagePngEx (gdImagePtr im,
FILE *outFile,
int level)
gdImagePngEx outputs the specified image to the specified file in PNG format.
void gdImagePng (gdImagePtr im,
FILE *outFile)
Equivalent to calling gdImagePngEx with compression of -1.
void * gdImagePngPtr (gdImagePtr im,
int *size)
Equivalent to calling gdImagePngPtrEx with compression of -1.
void * gdImagePngPtrEx (gdImagePtr im,
int *size,
int level)
Identical to gdImagePngEx except that it returns a pointer to a memory area with the PNG data.
void gdImagePngCtx (gdImagePtr im,
gdIOCtx *outfile)
Equivalent to calling gdImagePngCtxEx with compression of -1.
void gdImagePngCtxEx (gdImagePtr im,
gdIOCtx *outfile,
int level)
Outputs the given image as PNG data, but using a gdIOCtx instead of a file.
gdIOCtx structures hold function pointers for doing image IO.
The data structure in which gd stores images.
gdImagePtr gdImageCreateFromPngSource (gdSourcePtr inSource)
See gdImageCreateFromPng for documentation.
Close