Module image::codecs[][src]

Encoding and decoding for various image file formats.

Supported formats

FormatDecodingEncoding
PNGAll supported color typesSame as decoding
JPEGBaseline and progressiveBaseline JPEG
GIFYesYes
BMPYesRGB8, RGBA8, Gray8, GrayA8
ICOYesYes
TIFFBaseline(no fax support) + LZW + PackBitsRGB8, RGBA8, Gray8
WebPLossy(Luma channel only)No
AVIFOnly 8-bitLossy
PNMPBM, PGM, PPM, standard PAMYes
DDSDXT1, DXT3, DXT5No
TGAYesRGB8, RGBA8, BGR8, BGRA8, Gray8, GrayA8
farbfeldYesYes

A note on format specific features

One of the main goals of image is stability, in runtime but also for programmers. This ensures that performance as well as safety fixes reach a majority of its user base with little effort. Re-exporting all details of its dependencies would run counter to this goal as it linked all major version bumps between them and image. As such, we are wary of exposing too many details, or configuration options, that are not shared between different image formats.

Nevertheless, the advantage of precise control is hard to ignore. We will thus consider wrappers, not direct re-exports, in either of the following cases:

  1. A standard specifies that configuration x is required for decoders/encoders and there exists an essentially canonical way to control it.
  2. At least two different implementations agree on some (sub-)set of features in practice.
  3. A technical argument including measurements of the performance, space benefits, or otherwise objectively quantified benefits can be made, and the added interface is unlikely to require breaking changes.

Features that fulfill two or more criteria are preferred.

Re-exports of dependencies that reach version 1 will be discussed when it happens.

Modules

bmp

Decoding and Encoding of BMP Images

dds

Decoding of DDS images

dxt

Decoding of DXT (S3TC) compression

farbfeld

Decoding of farbfeld images

gif

Decoding of GIF Images

hdr

Decoding of Radiance HDR Images

ico

Decoding and Encoding of ICO files

jpeg

Decoding and Encoding of JPEG Images

png

Decoding and Encoding of PNG Images

pnm

Decoding of netpbm image formats (pbm, pgm, ppm and pam).

tga

Decoding of TGA Images

tiff

Decoding and Encoding of TIFF Images

webp

Decoding of WebP Images