formats.pngencoder - ICE 0.1 API documentation

ICE 0.1 API documentation

# formats.pngencoder

License:
Copyright (c) 2005-2007 Lode Vandevenne All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Lode Vandevenne nor the names of his contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Authors:
Lode Vandevenne (original version in C++), Lutger Blijdestijn (D version) : lutger dot blijdestijn at gmail dot com, Ferdinand Majerech (Refactoring) PNG encoder.

struct PNGEncoder;

  Encodes image data to PNG format.

  @property void level(const ubyte level);

    Set compression level. Can't be greater than 9.

  @property void compression(const CompressionStrategy compression);

    Set Zlib compression strategy.

  @property void filter(const PNGFilter filter);

    Set PNG filter strategy.

  @property void compressText(const bool compress);

    Compress text data? (on by default)

  ubyte[] encode(const PNGInfo info, const ubyte[] source);

    Encode image data to PNG format.

    Only 24bit RGB and 32bit RGBA formats are supported at the moment.

    Parameters:

    PNGInfo info | PNG information to encode.
    ubyte[] source | Image data to encode. Must correspond to width, height and color type in info.

    Returns:
    Manually allocated array with encoded PNG data. Must be manually freed.
    Throws:
    PNGException on failure.
void addUint(T)(ref T buffer, const uint i);

  Append a uint to specified ubyte buffer (vector or array).

  Parameters:

  buffer | Buffer to append to.
  i | uint to append.

Copyright © Ferdinand Majerech 2011. | Page generated by AutoDDoc and Ddoc.