Load an image file without even thinking about it, it does everything as decodeImage

Equivalent to readImage but also providing metadatas.

If you want to decode an image in a bytestring without even thinking in term of format or whatever, this is the function to use. It will try to decode in each known format and if one decoding succeeds, it will return the decoded image in it's own colorspace.

Equivalent to decodeImage, but also provide potential metadatas present in the given file.

Equivalent to decodeImage, but also provide potential metadatas present in the given file and the palettes if the format provides them.

map equivalent for an image, working at the pixel level. Little example : a brightness function for an rgb image

brightnessRGB8 :: Int -> Image PixelRGB8 -> Image PixelRGB8
brightnessRGB8 add = pixelMap brightFunction
     where up v = fromIntegral (fromIntegral v + add)
           brightFunction (PixelRGB8 r g b) =
                   PixelRGB8 (up r) (up g) (up b)

Helper function to help extract information from dynamic image. To get the width of a dynamic image, you can use the following snippet:

dynWidth :: DynamicImage -> Int
dynWidth img = dynamicMap imageWidth img

Equivalent of the pixelMap function for the dynamic images. You can perform pixel colorspace independant operations with this function.

For instance, if you want to extract a square crop of any image, without caring about colorspace, you can use the following snippet.

dynSquare :: DynamicImage -> DynamicImage
dynSquare = dynamicPixelMap squareImage

squareImage :: Pixel a => Image a -> Image a
squareImage img = generateImage (\x y -> pixelAt img x y) edge edge
   where edge = min (imageWidth img) (imageHeight img)

Create an image given a function to generate pixels. The function will receive values from 0 to width-1 for the x parameter and 0 to height-1 for the y parameter. The coordinates 0,0 are the upper left corner of the image, and (width-1, height-1) the lower right corner.

for example, to create a small gradient image:

imageCreator :: String -> IO ()
imageCreator path = writePng path $ generateImage pixelRenderer 250 300
   where pixelRenderer x y = PixelRGB8 (fromIntegral x) (fromIntegral y) 128

Create an image given a function to generate pixels. The function will receive values from 0 to width-1 for the x parameter and 0 to height-1 for the y parameter. The coordinates 0,0 are the upper left corner of the image, and (width-1, height-1) the lower right corner.

the acc parameter is a user defined one.

The function is called for each pixel in the line from left to right (0 to width - 1) and for each line (0 to height - 1).

Create an image using a monadic initializer function. The function will receive values from 0 to width-1 for the x parameter and 0 to height-1 for the y parameter. The coordinates 0,0 are the upper left corner of the image, and (width-1, height-1) the lower right corner.

The function is called for each pixel in the line from left to right (0 to width - 1) and for each line (0 to height - 1).

Flatten a PalettedImage to a DynamicImage

Convert by any means possible a dynamic image to an image in RGB. The process can lose precision while converting from 16bits pixels or Floating point pixels. Any alpha layer will be dropped

Convert by any means possible a dynamic image to an image in RGB. The process can lose precision while converting from 32bits pixels or Floating point pixels. Any alpha layer will be dropped

Convert by any means possible a dynamic image to an image in RGBA. The process can lose precision while converting from 16bits pixels or Floating point pixels.

Traversal type matching the definition in the Lens package.

Traversal in "raster" order, from left to right the top to bottom. This traversal is matching pixelMap in spirit.

Since 3.2.4

Traversal providing the pixel position with it's value. The traversal in raster order, from lef to right, then top to bottom. The traversal match pixelMapXY in spirit.

Since 3.2.4

Save an image to a '.bmp' file, will do everything it can to save an image.

Save an image to a '.jpg' file, will do everything it can to save an image.

Save an image to a '.gif' file, will do everything it can to save it.

Save an image to a '.png' file, will do everything it can to save an image. For example, a simple transcoder to png

transcodeToPng :: FilePath -> FilePath -> IO ()
transcodeToPng pathIn pathOut = do
   eitherImg <- readImage pathIn
   case eitherImg of
       Left _ -> return ()
       Right img -> savePngImage pathOut img

Save an image to a '.tiff' file, will do everything it can to save an image.

Save an image to a '.hdr' file, will do everything it can to save an image.

All the instance of this class can be written as a bitmap file using this library.

Write an image in a file use the bitmap format.

Encode an image into a bytestring in .bmp format ready to be written on disk.

Try to load a .bmp file. The colorspace would be RGB, RGBA or Y.

Try to decode a bitmap image. Right now this function can output the following image:

• ImageY8
• ImageRGB8
• ImageRGBA8

Encode a dynamic image in BMP if possible, supported images are:

• ImageY8
• ImageRGB8
• ImageRGBA8

Write a dynamic image in a .bmp image file if possible. The same restriction as encodeDynamicBitmap apply.

Helper function trying to load a gif file from a file on disk.

Helper function trying to load all the images of an animated gif file.

Transform a raw gif image to an image, without modifying the pixels. This function can output the following images:

• ImageRGB8
• ImageRGBA8

Transform a raw gif to a list of images, representing all the images of an animation.

Encode a greyscale image to a bytestring.

Write a greyscale in a gif file on the disk.

Encode an image with a given palette. Can return errors if the palette is ill-formed.

• A palette must have between 1 and 256 colors

Write a gif image with a palette to a file.

• A palette must have between 1 and 256 colors

Encode a full color image to a gif by applying a color quantization algorithm on it.

Write a full color image to a gif by applying a color quantization algorithm on it.

Encode a gif animation to a bytestring.

• Every image must have the same size
• Every palette must have between one and 256 colors.

Write a list of images as a gif animation in a file.

• Every image must have the same size
• Every palette must have between one and 256 colors.

Delay to wait before showing the next Gif image. The delay is expressed in 100th of seconds.

Help to control the behaviour of GIF animation looping.

Helper function to create a gif animation. All the images of the animation are separated by the same delay.

Helper function to write a gif animation on disk. See encodeGifAnimation

Try to load a jpeg file and decompress. The colorspace is still YCbCr if you want to perform computation on the luma part. You can convert it to RGB using colorSpaceConversion.

Try to decompress and decode a jpeg file. The colorspace is still YCbCr if you want to perform computation on the luma part. You can convert it to RGB using convertImage from the ColorSpaceConvertible typeclass.

This function can output the following images:

• ImageY8
• ImageYA8
• ImageRGB8
• ImageCMYK8
• ImageYCbCr8

Encode an image in jpeg at a reasonnable quality level. If you want better quality or reduced file size, you should use encodeJpegAtQuality

Function to call to encode an image to jpeg. The quality factor should be between 0 and 100 (100 being the best quality).

Encode an image into a png if possible.

Helper function trying to load a png file from a file on disk.

Transform a raw png image to an image, without modifying the underlying pixel type. If the image is greyscale and < 8 bits, a transformation to RGBA8 is performed. This should change in the future. The resulting image let you manage the pixel types.

This function can output the following images:

• ImageY8
• ImageY16
• ImageYA8
• ImageYA16
• ImageRGB8
• ImageRGB16
• ImageRGBA8
• ImageRGBA16

Helper function to directly write an image as a png on disk.

Encode a paletted image as a color indexed 8-bit PNG. the palette must have between 1 and 256 values in it. Accepts PixelRGB8 and PixelRGBA8 as palette pixel type

Encode a dynamic image in PNG if possible, supported images are:

• ImageY8
• ImageY16
• ImageYA8
• ImageYA16
• ImageRGB8
• ImageRGB16
• ImageRGBA8
• ImageRGBA16

Write a dynamic image in a .png image file if possible. The same restriction as encodeDynamicPng apply.

Try to load a .tga file from disk.

Transform a raw tga image to an image, without modifying the underlying pixel type.

This function can output the following images:

• ImageY8
• ImageRGB8
• ImageRGBA8

This typeclass determine if a pixel can be saved in the TGA format.

Transform a compatible image to a raw bytestring representing a Targa file.

Helper function to directly write an image a tga on disk.

Helper function trying to load tiff file from a file on disk.

Class defining which pixel types can be serialized in a Tiff file.

Decode a tiff encoded image while preserving the underlying pixel type (except for Y32 which is truncated to 16 bits).

This function can output the following images:

• ImageY8
• ImageY16
• ImageY32
• ImageYF
• ImageYA8
• ImageYA16
• ImageRGB8
• ImageRGB16
• ImageRGBA8
• ImageRGBA16
• ImageCMYK8
• ImageCMYK16

Transform an image into a Tiff encoded bytestring, ready to be written as a file.

Helper function to directly write an image as a tiff on disk.

Try to load a .pic file. The colorspace can only be RGB with floating point precision.

Decode an HDR (radiance) image, the resulting image can be:

• ImageRGBF

Encode an High dynamic range image into a radiance image file format. Alias for encodeRawHDR

Write an High dynamic range image into a radiance image file on disk.

Define which palette creation method is used.

To specify how the palette will be created.

Reduces an image to a color palette according to PaletteOptions and returns the indices image along with its Palette.

The main type of this package, one that most functions work on, is Image.

Parameterized by the underlying pixel format it forms a rigid type. If you wish to store images of different or unknown pixel formats use DynamicImage.

Image is essentially a rectangular pixel buffer of specified width and height. The coordinates are assumed to start from the upper-left corner of the image, with the horizontal position first and vertical second.

Image type enumerating all predefined pixel types. It enables loading and use of images of different pixel types.

Type for the palette used in Gif & PNG files.

Definition of pixels used in images. Each pixel has a color space, and a representative component (Word8 or Float).

Type alias for 8bit greyscale pixels. For simplicity, greyscale pixels use plain numbers instead of a separate type.

Type alias for 16bit greyscale pixels.

Type alias for 32bit greyscale pixels.

Type alias for 32bit floating point greyscale pixels. The standard bounded value range is mapped to the closed interval [0,1] i.e.

map promotePixel [0, 1 .. 255 :: Pixel8] == [0/255, 1/255 .. 1.0 :: PixelF]

Pixel type storing 8bit Luminance (Y) and alpha (A) information. Values are stored in the following order:

• Luminance
• Alpha

Pixel type storing 16bit Luminance (Y) and alpha (A) information. Values are stored in the following order:

• Luminance
• Alpha

Classic pixel type storing 8bit red, green and blue (RGB) information. Values are stored in the following order:

• Red
• Green
• Blue