mewin/libpng
1
0
Fork 0
mirror of https://git.code.sf.net/p/libpng/code.git synced 2025-07-10 18:04:09 +02:00
Code Issues Projects Releases Wiki Activity

[libpng16] Updated simplified API synopses and description of the png_image

Browse Source 
structure in the manual.
This commit is contained in:
Glenn Randers-Pehrson 2012-09-01 08:16:51 -05:00
parent b2aba47a6d
commit 97a77a6f7b
4 changed files with 70 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ANNOUNCE
View File

@ -486,6 +486,8 @@ Version 1.6.0beta29 [September 1, 2012]
Fixed the simplified API example programs and improved the error message Fixed the simplified API example programs and improved the error message
if the version field is not set. if the version field is not set.
Added contrib/examples/* to the *.zip and *.7z distributions. Added contrib/examples/* to the *.zip and *.7z distributions.
Updated simplified API synopses and description of the png_image structure
in the manual.
Send comments/corrections/commendations to png-mng-implement at lists.sf.net Send comments/corrections/commendations to png-mng-implement at lists.sf.net
(subscription required; visit (subscription required; visit

7
CHANGES
View File

@ -4234,9 +4234,12 @@ Version 1.6.0beta28 [August 29, 2012]
spec). Removed unused PNG_STATIC from pngpriv.h. spec). Removed unused PNG_STATIC from pngpriv.h.
Version 1.6.0beta29 [September 1, 2012] Version 1.6.0beta29 [September 1, 2012]
Fixed the simplified API example programs and improved the error message Fixed the simplified API example programs to add the *colormap parameter
if the version field is not set. to several of he API and improved the error message if the version field
is not set.
Added contrib/examples/* to the *.zip and *.7z distributions. Added contrib/examples/* to the *.zip and *.7z distributions.
Updated simplified API synopses and description of the png_image structure
in the manual.
Send comments/corrections/commendations to png-mng-implement at lists.sf.net Send comments/corrections/commendations to png-mng-implement at lists.sf.net
(subscription required; visit (subscription required; visit

35
libpng-manual.txt
View File

@ -1,6 +1,6 @@
libpng-manual.txt - A description on how to use and modify libpng libpng-manual.txt - A description on how to use and modify libpng
libpng version 1.6.0beta29 - August 29, 2012 libpng version 1.6.0beta29 - September 1, 2012
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
<glennrp at users.sourceforge.net> <glennrp at users.sourceforge.net>
Copyright (c) 1998-2011 Glenn Randers-Pehrson Copyright (c) 1998-2011 Glenn Randers-Pehrson
@ -11,7 +11,7 @@ libpng-manual.txt - A description on how to use and modify libpng
Based on: Based on:
libpng versions 0.97, January 1998, through 1.6.0beta29 - August 29, 2012 libpng versions 0.97, January 1998, through 1.6.0beta29 - September 1, 2012
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
Copyright (c) 1998-2011 Glenn Randers-Pehrson Copyright (c) 1998-2011 Glenn Randers-Pehrson
@ -3524,12 +3524,13 @@ png_image is a structure that describes the in-memory format of an image
when it is being read or define the in-memory format of an image that you when it is being read or define the in-memory format of an image that you
need to write. The "png_image" structure contains the following members: need to write. The "png_image" structure contains the following members:
png_uint_32 version Set to PNG_IMAGE_VERSION
png_uint_32 width Image width in pixels (columns) png_uint_32 width Image width in pixels (columns)
png_uint_32 height Image height in pixels (rows) png_uint_32 height Image height in pixels (rows)
png_uint_32 format Image format as defined below png_uint_32 format Image format as defined below
png_uint_32 flags A bit mask containing informational flags png_uint_32 flags A bit mask containing informational flags
png_controlp opaque Initialize to NULL, free with png_image_free png_controlp opaque Initialize to NULL, free with png_image_free
png_const_bytep colormap A pointer to the application color-map png_uint_32 colormap_entries; Number of entries in the color-map
png_uint_32 warning_or_error; png_uint_32 warning_or_error;
char message[64]; char message[64];
@ -3689,6 +3690,22 @@ First the information about the samples.
a fixed number determined by the format so can easily be allocated on the a fixed number determined by the format so can easily be allocated on the
stack if necessary. stack if necessary.
#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
/* The maximum size of the color-map required by the format expressed in a
* count of components. This can be used to compile-time allocate a
* color-map:
*
* png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
*
* png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
*
* Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
* information from one of the png_image_begin_read_ APIs and dynamically
* allocate the required memory.
*/
Corresponding information about the pixels Corresponding information about the pixels
PNG_IMAGE_PIXEL_(test,fmt) PNG_IMAGE_PIXEL_(test,fmt)
@ -3747,7 +3764,8 @@ READ APIs
The PNG header is read from the given memory buffer. The PNG header is read from the given memory buffer.
int png_image_finish_read(png_imagep image, int png_image_finish_read(png_imagep image,
png_colorp background, void *buffer, png_int_32 row_stride)); png_colorp background, void *buffer,
png_int_32 row_stride, void *colormap));
Finish reading the image into the supplied buffer and Finish reading the image into the supplied buffer and
clean up the png_image structure. clean up the png_image structure.
@ -3784,6 +3802,7 @@ WRITE APIS
For write you must initialize a png_image structure to describe the image to For write you must initialize a png_image structure to describe the image to
be written: be written:
version: must be set to PNG_IMAGE_VERSION
opaque: must be initialized to NULL opaque: must be initialized to NULL
width: image width in pixels width: image width in pixels
height: image height in rows height: image height in rows
@ -3791,15 +3810,17 @@ be written:
flags: set to 0 unless one of the defined flags applies; set flags: set to 0 unless one of the defined flags applies; set
PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images
where the RGB values do not correspond to the colors in sRGB. where the RGB values do not correspond to the colors in sRGB.
colormap_entries: set to the number of entries in the color-map (0 to 256)
int png_image_write_to_file, (png_imagep image, int png_image_write_to_file, (png_imagep image,
const char *file, int convert_to_8bit, const void *buffer, const char *file, int convert_to_8bit, const void *buffer,
png_int_32 row_stride)); png_int_32 row_stride, const void *colormap));
Write the image to the named file. Write the image to the named file.
int png_image_write_to_stdio(png_imagep image, FILE *file, int png_image_write_to_stdio(png_imagep image, FILE *file,
int convert_to_8_bit, const void *buffer, png_int_32 row_stride) int convert_to_8_bit, const void *buffer,
png_int_32 row_stride, const void *colormap)
Write the image to the given (FILE*). Write the image to the given (FILE*).
@ -5043,7 +5064,7 @@ Other rules can be inferred by inspecting the libpng source.
XVI. Y2K Compliance in libpng XVI. Y2K Compliance in libpng
August 29, 2012 September 1, 2012
Since the PNG Development group is an ad-hoc body, we can't make Since the PNG Development group is an ad-hoc body, we can't make
an official declaration. an official declaration.

51
libpng.3
View File

@ -1,4 +1,4 @@
.TH LIBPNG 3 "August 29, 2012" .TH LIBPNG 3 "September 1, 2012"
.SH NAME .SH NAME
libpng \- Portable Network Graphics (PNG) Reference Library 1.6.0beta29 libpng \- Portable Network Graphics (PNG) Reference Library 1.6.0beta29
.SH SYNOPSIS .SH SYNOPSIS
@ -440,7 +440,7 @@ libpng \- Portable Network Graphics (PNG) Reference Library 1.6.0beta29
\fI\fB \fI\fB
\fBint png_image_finish_read (png_imagep \fP\fIimage\fP\fB, png_colorp \fP\fIbackground\fP\fB, void \fP\fI*buffer\fP\fB, png_int_32 \fIrow_stride\fP\fB);\fP \fBint png_image_finish_read (png_imagep \fP\fIimage\fP\fB, png_colorp \fP\fIbackground\fP\fB, void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
\fI\fB \fI\fB
@ -448,13 +448,11 @@ libpng \- Portable Network Graphics (PNG) Reference Library 1.6.0beta29
\fI\fB \fI\fB
\fBint png_image_write_to_file (png_imagep \fP\fIimage\fP\fB, const char \fP\fI*file\fP\fB, int \fP\fIconvert_to_8bit\fP\fB, const void \fI*buffer, \fBint png_image_write_to_file (png_imagep \fP\fIimage\fP\fB, const char \fP\fI*file\fP\fB, int \fP\fIconvert_to_8bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
\fBpng_int_32 \fIrow_stride\fP\fB);\fP
\fI\fB \fI\fB
\fBint png_image_write_to_stdio (png_imagep \fP\fIimage\fP\fB, FILE \fP\fI*file\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fIrow_stride)\fP\fB);\fP \fBint png_image_write_to_stdio (png_imagep \fP\fIimage\fP\fB, FILE \fP\fI*file\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap)\fP\fB);\fP
\fI\fB \fI\fB
@ -999,7 +997,7 @@ Following is a copy of the libpng-manual.txt file that accompanies libpng.
.SH LIBPNG.TXT .SH LIBPNG.TXT
libpng-manual.txt - A description on how to use and modify libpng libpng-manual.txt - A description on how to use and modify libpng
libpng version 1.6.0beta29 - August 29, 2012 libpng version 1.6.0beta29 - September 1, 2012
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
<glennrp at users.sourceforge.net> <glennrp at users.sourceforge.net>
Copyright (c) 1998-2011 Glenn Randers-Pehrson Copyright (c) 1998-2011 Glenn Randers-Pehrson
@ -1010,7 +1008,7 @@ libpng-manual.txt - A description on how to use and modify libpng
Based on: Based on:
libpng versions 0.97, January 1998, through 1.6.0beta29 - August 29, 2012 libpng versions 0.97, January 1998, through 1.6.0beta29 - September 1, 2012
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
Copyright (c) 1998-2011 Glenn Randers-Pehrson Copyright (c) 1998-2011 Glenn Randers-Pehrson
@ -4523,12 +4521,13 @@ png_image is a structure that describes the in-memory format of an image
when it is being read or define the in-memory format of an image that you when it is being read or define the in-memory format of an image that you
need to write. The "png_image" structure contains the following members: need to write. The "png_image" structure contains the following members:
png_uint_32 version Set to PNG_IMAGE_VERSION
png_uint_32 width Image width in pixels (columns) png_uint_32 width Image width in pixels (columns)
png_uint_32 height Image height in pixels (rows) png_uint_32 height Image height in pixels (rows)
png_uint_32 format Image format as defined below png_uint_32 format Image format as defined below
png_uint_32 flags A bit mask containing informational flags png_uint_32 flags A bit mask containing informational flags
png_controlp opaque Initialize to NULL, free with png_image_free png_controlp opaque Initialize to NULL, free with png_image_free
png_const_bytep colormap A pointer to the application color-map png_uint_32 colormap_entries; Number of entries in the color-map
png_uint_32 warning_or_error; png_uint_32 warning_or_error;
char message[64]; char message[64];
@ -4688,6 +4687,22 @@ First the information about the samples.
a fixed number determined by the format so can easily be allocated on the a fixed number determined by the format so can easily be allocated on the
stack if necessary. stack if necessary.
#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
/* The maximum size of the color-map required by the format expressed in a
* count of components. This can be used to compile-time allocate a
* color-map:
*
* png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
*
* png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
*
* Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
* information from one of the png_image_begin_read_ APIs and dynamically
* allocate the required memory.
*/
Corresponding information about the pixels Corresponding information about the pixels
PNG_IMAGE_PIXEL_(test,fmt) PNG_IMAGE_PIXEL_(test,fmt)
@ -4746,7 +4761,8 @@ READ APIs
The PNG header is read from the given memory buffer. The PNG header is read from the given memory buffer.
int png_image_finish_read(png_imagep image, int png_image_finish_read(png_imagep image,
png_colorp background, void *buffer, png_int_32 row_stride)); png_colorp background, void *buffer,
png_int_32 row_stride, void *colormap));
Finish reading the image into the supplied buffer and Finish reading the image into the supplied buffer and
clean up the png_image structure. clean up the png_image structure.
@ -4783,6 +4799,7 @@ WRITE APIS
For write you must initialize a png_image structure to describe the image to For write you must initialize a png_image structure to describe the image to
be written: be written:
version: must be set to PNG_IMAGE_VERSION
opaque: must be initialized to NULL opaque: must be initialized to NULL
width: image width in pixels width: image width in pixels
height: image height in rows height: image height in rows
@ -4790,15 +4807,17 @@ be written:
flags: set to 0 unless one of the defined flags applies; set flags: set to 0 unless one of the defined flags applies; set
PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images
where the RGB values do not correspond to the colors in sRGB. where the RGB values do not correspond to the colors in sRGB.
colormap_entries: set to the number of entries in the color-map (0 to 256)
int png_image_write_to_file, (png_imagep image, int png_image_write_to_file, (png_imagep image,
const char *file, int convert_to_8bit, const void *buffer, const char *file, int convert_to_8bit, const void *buffer,
png_int_32 row_stride)); png_int_32 row_stride, const void *colormap));
Write the image to the named file. Write the image to the named file.
int png_image_write_to_stdio(png_imagep image, FILE *file, int png_image_write_to_stdio(png_imagep image, FILE *file,
int convert_to_8_bit, const void *buffer, png_int_32 row_stride) int convert_to_8_bit, const void *buffer,
png_int_32 row_stride, const void *colormap)
Write the image to the given (FILE*). Write the image to the given (FILE*).
@ -6043,7 +6062,7 @@ Other rules can be inferred by inspecting the libpng source.
.SH XVI. Y2K Compliance in libpng .SH XVI. Y2K Compliance in libpng
August 29, 2012 September 1, 2012
Since the PNG Development group is an ad-hoc body, we can't make Since the PNG Development group is an ad-hoc body, we can't make
an official declaration. an official declaration.
@ -6311,7 +6330,7 @@ possible without all of you.
Thanks to Frank J. T. Wojcik for helping with the documentation. Thanks to Frank J. T. Wojcik for helping with the documentation.
Libpng version 1.6.0beta29 - August 29, 2012: Libpng version 1.6.0beta29 - September 1, 2012:
Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc. Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net). Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
@ -6334,7 +6353,7 @@ this sentence.
This code is released under the libpng license. This code is released under the libpng license.
libpng versions 1.2.6, August 15, 2004, through 1.6.0beta29, August 29, 2012, are libpng versions 1.2.6, August 15, 2004, through 1.6.0beta29, September 1, 2012, are
Copyright (c) 2004,2006-2007 Glenn Randers-Pehrson, and are Copyright (c) 2004,2006-2007 Glenn Randers-Pehrson, and are
distributed according to the same disclaimer and license as libpng-1.2.5 distributed according to the same disclaimer and license as libpng-1.2.5
with the following individual added to the list of Contributing Authors with the following individual added to the list of Contributing Authors
@ -6433,7 +6452,7 @@ certification mark of the Open Source Initiative.
Glenn Randers-Pehrson Glenn Randers-Pehrson
glennrp at users.sourceforge.net glennrp at users.sourceforge.net
August 29, 2012 September 1, 2012
.\" end of man page .\" end of man page