Home | History | Annotate | Download | only in man3
      1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
      2 <!--ArborText, Inc., 1988-1999, v.4002-->
      3 <!--ARC : LSARC 2003/085 libtiff, libjpeg, and libpng-->
      4 <!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. 
      5 Copyright (c) 1998 Addison Wesley Longman, Inc.
      6  All Rights Reserved.">
      7 <!ENTITY cmd "libpngpf">
      8 <!ENTITY % commonents SYSTEM "smancommon.ent">
      9 %commonents;
     10 <!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
     11 %gnomecommonents;
     12 <!ENTITY % booktitles SYSTEM "booktitles.ent">
     13 %booktitles;
     14 ]>
     15 <?Pub UDT _bookmark _target>
     16 <?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
     17  laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen lt gt minus
     18  equals bsol sol amp>
     19 <?Pub Inc>
     20 <refentry id="libpngpf-3">
     21 <!-- %Z%%M% %I% %E% SMI; -->
     22 <refmeta><refentrytitle>libpngpf</refentrytitle><manvolnum>3</manvolnum>
     23 <refmiscinfo class="date">26 Mar 2004</refmiscinfo>
     24 <refmiscinfo class="sectdesc">&man3;</refmiscinfo>
     25 <refmiscinfo class="software">&release;</refmiscinfo>
     26 <refmiscinfo class="arch">generic</refmiscinfo>
     27 <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
     28 </refmeta>
     29 <indexterm><primary>libpngpf</primary></indexterm><indexterm><primary>Portable
     30 Network Graphics (PNG) Reference Library 1.0.12 (private functions)</primary>
     31 </indexterm>
     32 <refnamediv id="libpngpf-3-name"><refname>libpng</refname><refpurpose>Portable
     33 Network Graphics (PNG) Reference Library 1.0.12 (private functions)</refpurpose>
     34 </refnamediv>
     35 <refsect1 id="libpngpf-3-synp"><title>&synp-tt;</title>
     36 <programlisting>#include &lt;png.h>
     37 
     38 cc [ flag ...] -I/usr/sfw/include file [  library  ...  ]  -
     39 L/usr/sfw/lib -R/usr/sfw/lib -lpng
     40 
     41 void png_build_gamma_table (png_structp png_ptr);
     42 
     43 void png_build_grayscale_palette (int bit_depth,  png_colorp
     44 palette);
     45 
     46 void png_calculate_crc (png_structp png_ptr, png_bytep  ptr,
     47 png_size_t length);
     48 
     49 void png_check_chunk_name  (png_structp  png_ptr,  png_bytep
     50 chunk_name);
     51 
     52 png_size_t png_check_keyword (png_structp png_ptr, png_charp
     53 key, png_charpp new_key);
     54 
     55 void png_combine_row (png_structp  png_ptr,  png_bytep  row,
     56 int mask);
     57 
     58 void png_correct_palette  (png_structp  png_ptr,  png_colorp
     59 palette, int num_palette);
     60 
     61 int png_crc_error (png_structp png_ptr);
     62 
     63 int png_crc_finish (png_structp png_ptr, png_uint_32 skip);
     64 
     65 void  png_crc_read  (png_structp  png_ptr,  png_bytep   buf,
     66 png_size_t length);
     67 
     68 png_voidp  png_create_struct   (int   type,   png_malloc_ptr
     69 malloc_fn);
     70 
     71 png_voidp png_create_struct_2 (int type);
     72 
     73 png_charp  png_decompress_chunk  (png_structp  png_ptr,  int
     74 comp_type,   png_charp  chunkdata,  png_size_t  chunklength,
     75 png_size_t prefix_length, png_size_t *data_length);
     76 
     77 void png_destroy_struct (png_voidp struct_ptr);
     78 
     79 void     png_destroy_struct_2     (png_voidp     struct_ptr,
     80 png_free_ptr free_fn);
     81 
     82 void png_do_background  (png_row_infop  row_info,  png_bytep
     83 row,  png_color_16p  trans_values, png_color_16p background,
     84 png_color_16p background_1, png_bytep gamma_table, png_bytep
     85 gamma_from_1,  png_bytep gamma_to_1, png_uint_16pp gamma_16,
     86 png_uint_16pp gamma_16_from_1, png_uint_16pp  gamma_16_to_1,
     87 int gamma_shift);
     88 
     89 void png_do_bgr (png_row_infop row_info, png_bytep row);
     90 
     91 void png_do_chop (png_row_infop row_info, png_bytep row);
     92 
     93 void png_do_dither (png_row_infop row_info,  png_bytep  row,
     94 png_bytep palette_lookup, png_bytep dither_lookup);
     95 
     96 void png_do_expand (png_row_infop row_info,  png_bytep  row,
     97 
     98 png_color_16p trans_value);
     99 
    100 void    png_do_expand_palette    (png_row_infop    row_info,
    101 png_bytep  row,  png_colorp  palette,  png_bytep  trans, int
    102 num_trans);
    103 
    104 void png_do_gamma (png_row_infop  row_info,  png_bytep  row,
    105 png_bytep  gamma_table,  png_uint_16pp  gamma_16_table,  int
    106 gamma_shift);
    107 
    108 void png_do_gray_to_rgb (png_row_infop  row_info,  png_bytep
    109 row);
    110 
    111 void png_do_invert (png_row_infop row_info, png_bytep row);
    112 
    113 void png_do_pack  (png_row_infop  row_info,  png_bytep  row,
    114 png_uint_32 bit_depth);
    115 
    116 void  png_do_packswap  (png_row_infop  row_info,   png_bytep
    117 row);
    118 
    119 void png_do_read_filler (png_row_infop  row_info,  png_bytep
    120 row, png_uint_32 filler, png_uint_32 flags);
    121 
    122 void    png_do_read_interlace    (png_row_infop    row_info,
    123 png_bytep row, int pass, png_uint_32 transformations);
    124 
    125 void   png_do_read_invert_alpha   (png_row_infop   row_info,
    126 png_bytep row);
    127 
    128 void   png_do_read_swap_alpha    (png_row_infop    row_info,
    129 png_bytep row);
    130 
    131 void png_do_read_transformations (png_structp png_ptr);
    132 
    133 int png_do_rgb_to_gray  (png_row_infop  row_info,  png_bytep
    134 row);
    135 
    136 void png_do_shift (png_row_infop  row_info,  png_bytep  row,
    137 png_color_8p bit_depth);
    138 
    139 void png_do_strip_filler (png_row_infop row_info,  png_bytep
    140 row, png_uint_32 flags);
    141 
    142 void png_do_swap (png_row_infop row_info, png_bytep row);
    143 
    144 void png_do_unpack (png_row_infop row_info, png_bytep row);
    145 
    146 void png_do_unshift (png_row_infop row_info, png_bytep  row,
    147 png_color_8p sig_bits);
    148 
    149 void   png_do_write_interlace    (png_row_infop    row_info,
    150 png_bytep row, int pass);
    151 
    152 void  png_do_write_invert_alpha   (png_row_infop   row_info,
    153 png_bytep row);
    154 
    155 void   png_do_write_swap_alpha   (png_row_infop    row_info,
    156 png_bytep row);
    157 
    158 void png_do_write_transformations (png_structp png_ptr);
    159 
    160 void *png_far_to_near  (png_structp  png_ptr,png_voidp  ptr,
    161 int check);
    162 
    163 void png_flush (png_structp png_ptr);
    164 
    165 png_int_32 png_get_int_32 (png_bytep buf);
    166 
    167 png_uint_16 png_get_uint_16 (png_bytep buf);
    168 
    169 png_uint_32 png_get_uint_32 (png_bytep buf);
    170 
    171 int png_handle_as_unknown  (png_structp  png_ptr,  png_bytep
    172 chunk_name);
    173 
    174 void   png_handle_bKGD   (png_structp   png_ptr,   png_infop
    175 info_ptr, png_uint_32 length);
    176 
    177 void   png_handle_cHRM   (png_structp   png_ptr,   png_infop
    178 info_ptr, png_uint_32 length);
    179 
    180 void   png_handle_gAMA   (png_structp   png_ptr,   png_infop
    181 info_ptr, png_uint_32 length);
    182 
    183 void   png_handle_hIST   (png_structp   png_ptr,   png_infop
    184 info_ptr, png_uint_32 length);
    185 
    186 void   png_handle_IEND   (png_structp   png_ptr,   png_infop
    187 info_ptr, png_uint_32 length);
    188 
    189 void   png_handle_IHDR   (png_structp   png_ptr,   png_infop
    190 info_ptr, png_uint_32 length);
    191 
    192 void   png_handle_iCCP   (png_structp   png_ptr,   png_infop
    193 info_ptr, png_uint_32 length);
    194 
    195 void   png_handle_iTXt   (png_structp   png_ptr,   png_infop
    196 info_ptr, png_uint_32 length);
    197 
    198 void   png_handle_oFFs   (png_structp   png_ptr,   png_infop
    199 info_ptr, png_uint_32 length);
    200 
    201 void   png_handle_pCAL   (png_structp   png_ptr,   png_infop
    202 info_ptr, png_uint_32 length);
    203 
    204 void   png_handle_pHYs   (png_structp   png_ptr,   png_infop
    205 info_ptr, png_uint_32 length);
    206 
    207 void   png_handle_PLTE   (png_structp   png_ptr,   png_infop
    208 info_ptr, png_uint_32 length);
    209 
    210 void   png_handle_sBIT   (png_structp   png_ptr,   png_infop
    211 info_ptr, png_uint_32 length);
    212 
    213 void   png_handle_sCAL   (png_structp   png_ptr,   png_infop
    214 info_ptr, png_uint_32 length);
    215 
    216 void   png_handle_sPLT   (png_structp   png_ptr,   png_infop
    217 info_ptr, png_uint_32 length);
    218 
    219 void   png_handle_sRGB   (png_structp   png_ptr,   png_infop
    220 info_ptr, png_uint_32 length);
    221 
    222 void   png_handle_tEXt   (png_structp   png_ptr,   png_infop
    223 info_ptr, png_uint_32 length);
    224 
    225 void   png_handle_tIME   (png_structp   png_ptr,   png_infop
    226 info_ptr, png_uint_32 length);
    227 
    228 void   png_handle_tRNS   (png_structp   png_ptr,   png_infop
    229 info_ptr, png_uint_32 length);
    230 
    231 void  png_handle_unknown  (png_structp  png_ptr,   png_infop
    232 info_ptr, png_uint_32 length);
    233 
    234 void   png_handle_zTXt   (png_structp   png_ptr,   png_infop
    235 info_ptr, png_uint_32 length);
    236 
    237 void  png_info_destroy   (png_structp   png_ptr,   png_infop
    238 info_ptr);
    239 
    240 void png_init_read_transformations (png_structp png_ptr);
    241 
    242 void png_process_IDAT_data (png_structp  png_ptr,  png_bytep
    243 buffer, png_size_t buffer_length);
    244 
    245 void png_process_some_data (png_structp  png_ptr,  png_infop
    246 info_ptr);
    247 
    248 void png_push_check_crc (png_structp png_ptr);
    249 
    250 void png_push_crc_finish (png_structp png_ptr);
    251 
    252 void  png_push_crc_skip  (png_structp  png_ptr,  png_uint_32
    253 length);
    254 
    255 void png_push_fill_buffer  (png_structp  png_ptr,  png_bytep
    256 buffer, png_size_t length);
    257 
    258 void png_push_handle_tEXt  (png_structp  png_ptr,  png_infop
    259 info_ptr, png_uint_32 length);
    260 
    261 void png_push_handle_unknown (png_structp png_ptr, png_infop
    262 info_ptr, png_uint_32 length);
    263 
    264 void png_push_handle_zTXt  (png_structp  png_ptr,  png_infop
    265 info_ptr, png_uint_32 length);
    266 
    267 void  png_push_have_end  (png_structp   png_ptr,   png_infop
    268 info_ptr);
    269 
    270 void  png_push_have_info  (png_structp  png_ptr,   png_infop
    271 info_ptr);
    272 
    273 void png_push_have_row (png_structp png_ptr, png_bytep row);
    274 
    275 void png_push_process_row (png_structp png_ptr);
    276 
    277 void  png_push_read_chunk  (png_structp  png_ptr,  png_infop
    278 info_ptr);
    279 
    280 void  png_push_read_end  (png_structp   png_ptr,   png_infop
    281 info_ptr);
    282 
    283 void png_push_read_IDAT (png_structp png_ptr);
    284 
    285 void  png_push_read_sig  (png_structp   png_ptr,   png_infop
    286 info_ptr);
    287 
    288 void  png_push_read_tEXt  (png_structp  png_ptr,   png_infop
    289 info_ptr);
    290 
    291 void  png_push_read_zTXt  (png_structp  png_ptr,   png_infop
    292 info_ptr);
    293 
    294 void png_push_restore_buffer (png_structp png_ptr, png_bytep
    295 buffer, png_size_t buffer_length);
    296 
    297 void png_push_save_buffer (png_structp png_ptr);
    298 
    299 void png_read_data  (png_structp  png_ptr,  png_bytep  data,
    300 png_size_t length);
    301 
    302 void png_read_filter_row (png_structp png_ptr, png_row_infop
    303 row_info, png_bytep row, png_bytep prev_row, int filter);
    304 
    305 void png_read_finish_row (png_structp png_ptr);
    306 
    307 void png_read_push_finish_row (png_structp png_ptr);
    308 
    309 void png_read_start_row (png_structp png_ptr);
    310 
    311 void png_read_transform_info (png_structp png_ptr, png_infop
    312 info_ptr);
    313 
    314 void png_reset_crc (png_structp png_ptr);
    315 
    316 void png_save_int_32 (png_bytep buf, png_int_32 i);
    317 
    318 void png_save_uint_16 (png_bytep buf, unsigned int i);
    319 
    320 void png_save_uint_32 (png_bytep buf, png_uint_32 i);
    321 
    322 void  png_write_bKGD  (png_structp  png_ptr,   png_color_16p
    323 values, int color_type);
    324 
    325 void png_write_cHRM (png_structp  png_ptr,  double  white_x,
    326 double  white_y, double red_x, double red_y, double green_x,
    327 double green_y, double blue_x, double blue_y);
    328 
    329 void png_write_cHRM_fixed (png_structp png_ptr,  png_uint_32
    330 white_x, png_uint_32 white_y, png_uint_32 red_x, png_uint_32
    331 red_y, png_uint_32 green_x, png_uint_32 green_y, png_uint_32
    332 blue_x, png_uint_32 blue_y);
    333 
    334 void png_write_data (png_structp  png_ptr,  png_bytep  data,
    335 png_size_t length);
    336 
    337 void png_write_filtered_row (png_structp png_ptr,  png_bytep
    338 filtered_row);
    339 
    340 void     png_write_find_filter     (png_structp     png_ptr,
    341 png_row_infop row_info);
    342 
    343 void png_write_finish_row (png_structp png_ptr);
    344 
    345 void    png_write_gAMA    (png_structp    png_ptr,    double
    346 file_gamma);
    347 
    348 void png_write_gAMA_fixed (png_structp png_ptr,  png_uint_32
    349 int_file_gamma);
    350 
    351 void png_write_hIST (png_structp png_ptr, png_uint_16p hist,
    352 int num_hist);
    353 
    354 void png_write_iCCP (png_structp  png_ptr,  png_charp  name,
    355 int compression_type, png_charp profile, int proflen);
    356 
    357 void png_write_IDAT (png_structp  png_ptr,  png_bytep  data,
    358 png_size_t length);
    359 
    360 void png_write_IEND (png_structp png_ptr);
    361 
    362 void png_write_IHDR (png_structp png_ptr, png_uint_32 width,
    363 png_uint_32  height,  int  bit_depth,  int  color_type,  int
    364 compression_type, int filter_type, int interlace_type);
    365 
    366 void png_write_iTXt (png_structp png_ptr,  int  compression,
    367 png_charp  key,  png_charp  lang,  png_charp translated_key,
    368 png_charp text));
    369 
    370 void  png_write_oFFs   (png_structp   png_ptr,   png_uint_32
    371 x_offset, png_uint_32 y_offset, int unit_type);
    372 
    373 void png_write_pCAL (png_structp png_ptr, png_charp purpose,
    374 png_int_32   X0,  png_int_32  X1,  int  type,  int  nparams,
    375 png_charp units, png_charpp params);
    376 
    377 void  png_write_pHYs   (png_structp   png_ptr,   png_uint_32
    378 x_pixels_per_unit,    png_uint_32   y_pixels_per_unit,   int
    379 unit_type);
    380 
    381 void   png_write_PLTE   (png_structp   png_ptr,   png_colorp
    382 palette, png_uint_32 num_pal);
    383 
    384 void png_write_sBIT (png_structp png_ptr, png_color_8p sbit,
    385 int color_type);
    386 
    387 void png_write_sCAL (png_structp  png_ptr,  png_charp  unit,
    388 double width, double height);
    389 
    390 void png_write_sCAL_s (png_structp png_ptr, png_charp  unit,
    391 png_charp width, png_charp height);
    392 
    393 void png_write_sig (png_structp png_ptr);
    394 
    395 void png_write_sRGB (png_structp png_ptr, int intent);
    396 
    397 void  png_write_sPLT  (png_structp  png_ptr,  png_spalette_p
    398 palette);
    399 
    400 void png_write_start_row (png_structp png_ptr);
    401 
    402 void png_write_tEXt  (png_structp  png_ptr,  png_charp  key,
    403 png_charp text, png_size_t text_len);
    404 
    405 void   png_write_tIME   (png_structp   png_ptr,    png_timep
    406 mod_time);
    407 
    408 void png_write_tRNS (png_structp png_ptr,  png_bytep  trans,
    409 png_color_16p values, int number, int color_type);
    410 
    411 void png_write_zTXt  (png_structp  png_ptr,  png_charp  key,
    412 png_charp text, png_size_t text_len, int compression);
    413 
    414 voidpf png_zalloc (voidpf png_ptr, uInt items, uInt size);
    415 
    416 void png_zfree (voidpf png_ptr, voidpf ptr);
    417 
    418 </programlisting>
    419 </refsect1>
    420 <refsect1 id="libpngpf-3-desc"><title>&desc-tt;</title>
    421 <para>The functions listed above are used privately by <filename>libpng</filename>
    422 and are not recommended for use by applications. The functions are listed
    423 alphabetically here as an aid to <filename>libpng</filename> maintainers.
    424 See <filename>png.h</filename> for more information about these functions.
    425 </para>
    426 </refsect1>
    427 <refsect1 id="libpngpf-3-attr"><title>&attr-tt;</title>
    428 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
    429 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
    430 for descriptions of the following attributes:</para>
    431 <informaltable frame="all">
    432 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
    433 <colspec colname="COLSPEC1" colwidth="1*">
    434 <thead>
    435 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
    436 valign="middle">ATTRIBUTE VALUE</entry></row>
    437 </thead>
    438 <tbody>
    439 <row><entry><para>Availability</para></entry><entry><para>SUNWpng</para></entry>
    440 </row>
    441 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
    442 colname="COLSPEC1"><para>Uncommitted</para></entry></row>
    443 </tbody>
    444 </tgroup>
    445 </informaltable>
    446 </refsect1>
    447 <refsect1 id="libpngpf-3-also"><title>&also-tt;</title>
    448 <!--Reference to another man page-->
    449 <!--Reference to a Help manual-->
    450 <!--Reference to a book.-->
    451 <para>
    452 <citerefentry><refentrytitle>libpng</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    453 <citerefentry><refentrytitle>png</refentrytitle><manvolnum>4</manvolnum></citerefentry>,
    454 <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    455 </para>
    456 </refsect1>
    457 <refsect1 id="libpngpf-3-note"><title>&note-tt;</title>
    458 <para>This man page was originally written by Glenn Randers-Pehrson. Updated
    459 by Breda McColgan, Sun Microsystems Inc., 2004.</para>
    460 </refsect1>
    461 </refentry>
    462