Codec.Picture.Bitmap

Modules used for Bitmap file (.bmp) file loading and writing

Functions

writeBitmap :: BmpEncodable pixel => FilePath -> Image pixel -> IO ()

Write an image in a file use the bitmap format.

encodeBitmap :: forall pixel. BmpEncodable pixel => Image pixel -> ByteString

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

encodeBitmapWithMetadata :: forall pixel. BmpEncodable pixel => Metadatas -> Image pixel -> ByteString

Equivalent to encodeBitmap but also store the following metadatas:

• DpiX
• DpiY

decodeBitmap :: ByteString -> Either String DynamicImage

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

• ImageY8
• ImageRGB8
• ImageRGBA8

decodeBitmapWithMetadata :: ByteString -> Either String (DynamicImage, Metadatas)

Same as decodeBitmap but also extracts metadata.

decodeBitmapWithPaletteAndMetadata :: ByteString -> Either String (PalettedImage, Metadatas)

Same as decodeBitmap but also extracts metadata and provide separated palette.

encodeDynamicBitmap :: DynamicImage -> Either String ByteString

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

• ImageY8
• ImageRGB8
• ImageRGBA8

encodeBitmapWithPaletteAndMetadata :: forall pixel. BmpEncodable pixel => Metadatas -> BmpPalette -> Image pixel -> ByteString

Equivalent to encodeBitmapWithPalette but also store the following metadatas:

• DpiX
• DpiY

writeDynamicBitmap :: FilePath -> DynamicImage -> IO (Either String Bool)

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

Accepted format in output

class BmpEncodable pixel

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

Minimal complete definition

bitsPerPixel, bmpEncode

Instances

BmpEncodable PixelRGBA8

Defined in Codec.Picture.Bitmap

Methods

bitsPerPixel :: PixelRGBA8 -> Int

bmpEncode :: Image PixelRGBA8 -> Put

defaultPalette :: PixelRGBA8 -> BmpPalette

BmpEncodable PixelRGB8

Defined in Codec.Picture.Bitmap

Methods

bitsPerPixel :: PixelRGB8 -> Int

bmpEncode :: Image PixelRGB8 -> Put

defaultPalette :: PixelRGB8 -> BmpPalette

BmpEncodable Pixel8

Defined in Codec.Picture.Bitmap

Methods

bitsPerPixel :: Pixel8 -> Int

bmpEncode :: Image Pixel8 -> Put

defaultPalette :: Pixel8 -> BmpPalette