Graphics.Image.IO.Formats

Documentation

data BMP

Bitmap image with .bmp extension.

Constructors

BMP

Instances

ImageFormat BMP

Associated Types

data SaveOption BMP :: *

Methods

ext :: BMP -> String

exts :: BMP -> [String]

isFormat :: String -> BMP -> Bool

data SaveOption BMP

data SaveOption BMP

data GIF

Graphics Interchange Format image with .gif extension.

Constructors

GIF

Instances

ImageFormat GIF

Associated Types

data SaveOption GIF :: *

Methods

ext :: GIF -> String

exts :: GIF -> [String]

isFormat :: String -> GIF -> Bool

data SaveOption GIF

data SaveOption GIF = GIFPalette PaletteOptions

data GIFA

Constructors

GIFA

Instances

ImageFormat GIFA

Associated Types

data SaveOption GIFA :: *

Methods

ext :: GIFA -> String

exts :: GIFA -> [String]

isFormat :: String -> GIFA -> Bool

data SaveOption GIFA

data SaveOption GIFA

• = GIFAPalette PaletteOptions
• | GIFALooping GifLooping

type GifDelay = Int

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

data GifLooping :: *

Help to control the behaviour of GIF animation looping.

Constructors

LoopingNever

The animation will stop once the end is reached

LoopingForever

The animation will restart once the end is reached

LoopingRepeat Word16

The animation will repeat n times before stoping

data PaletteOptions :: *

To specify how the palette will be created.

Constructors

PaletteOptions

Fields

• paletteCreationMethod :: PaletteCreationMethod

  Algorithm used to find the palette

• enableImageDithering :: Bool

  Do we want to apply the dithering to the image. Enabling it often reduce compression ratio but enhance the perceived quality of the final image.

• paletteColorCount :: Int

  Maximum number of color we want in the palette

data PaletteCreationMethod :: *

Define which palette creation method is used.

Constructors

MedianMeanCut

MedianMeanCut method, provide the best results (visualy) at the cost of increased calculations.

Uniform

Very fast algorithm (one pass), doesn't provide good looking results.

data HDR

High-dynamic-range image with .hdr or .pic extension.

Constructors

HDR

Instances

ImageFormat HDR

Associated Types

data SaveOption HDR :: *

Methods

ext :: HDR -> String

exts :: HDR -> [String]

isFormat :: String -> HDR -> Bool

data SaveOption HDR

data SaveOption HDR

data JPG

Joint Photographic Experts Group image with .jpg or .jpeg extension.

Constructors

JPG

Instances

ImageFormat JPG

Associated Types

data SaveOption JPG :: *

Methods

ext :: JPG -> String

exts :: JPG -> [String]

isFormat :: String -> JPG -> Bool

data SaveOption JPG

data SaveOption JPG = JPGQuality Word8

data PNG

Portable Network Graphics image with .png extension.

Constructors

PNG

Instances

ImageFormat PNG

Associated Types

data SaveOption PNG :: *

Methods

ext :: PNG -> String

exts :: PNG -> [String]

isFormat :: String -> PNG -> Bool

data SaveOption PNG

data SaveOption PNG

data TGA

Truevision Graphics Adapter image with .tga extension.

Constructors

TGA

Instances

ImageFormat TGA

Associated Types

data SaveOption TGA :: *

Methods

ext :: TGA -> String

exts :: TGA -> [String]

isFormat :: String -> TGA -> Bool

data SaveOption TGA

data SaveOption TGA

data TIF

Tagged Image File Format image with .tif or .tiff extension.

Constructors

TIF

Instances

ImageFormat TIF

Associated Types

data SaveOption TIF :: *

Methods

ext :: TIF -> String

exts :: TIF -> [String]

isFormat :: String -> TIF -> Bool

data SaveOption TIF

data SaveOption TIF

data PBM

Netpbm: portable bitmap image with .pbm extension.

Constructors

PBM

Instances

ImageFormat PBM

Associated Types

data SaveOption PBM :: *

Methods

ext :: PBM -> String

exts :: PBM -> [String]

isFormat :: String -> PBM -> Bool

ImageFormat [PBM]

Associated Types

data SaveOption [PBM] :: *

Methods

ext :: [PBM] -> String

exts :: [PBM] -> [String]

isFormat :: String -> [PBM] -> Bool

Readable [Image VS Binary Bit] [PBM]

Methods

decode :: [PBM] -> ByteString -> Either String [Image VS Binary Bit]

Readable (Image VS Y Double) PBM

Methods

decode :: PBM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS Binary Bit) PBM

Methods

decode :: PBM -> ByteString -> Either String (Image VS Binary Bit)

data SaveOption PBM

data SaveOption PBM

data SaveOption [PBM]

data SaveOption [PBM]

data PGM

Netpbm: portable graymap image with .pgm extension.

Constructors

PGM

Instances

ImageFormat PGM

Associated Types

data SaveOption PGM :: *

Methods

ext :: PGM -> String

exts :: PGM -> [String]

isFormat :: String -> PGM -> Bool

ImageFormat [PGM]

Associated Types

data SaveOption [PGM] :: *

Methods

ext :: [PGM] -> String

exts :: [PGM] -> [String]

isFormat :: String -> [PGM] -> Bool

Readable [Image VS Y Word8] [PGM]

Methods

decode :: [PGM] -> ByteString -> Either String [Image VS Y Word8]

Readable [Image VS Y Word16] [PGM]

Methods

decode :: [PGM] -> ByteString -> Either String [Image VS Y Word16]

Readable (Image VS Y Double) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS Y Word8) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Word8)

Readable (Image VS Y Word16) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Word16)

data SaveOption PGM

data SaveOption PGM

data SaveOption [PGM]

data SaveOption [PGM]

data PPM

Netpbm: portable pixmap image with .ppm extension.

Constructors

PPM

Instances

ImageFormat PPM

Associated Types

data SaveOption PPM :: *

Methods

ext :: PPM -> String

exts :: PPM -> [String]

isFormat :: String -> PPM -> Bool

ImageFormat [PPM]

Associated Types

data SaveOption [PPM] :: *

Methods

ext :: [PPM] -> String

exts :: [PPM] -> [String]

isFormat :: String -> [PPM] -> Bool

Readable [Image VS RGB Word8] [PPM]

Methods

decode :: [PPM] -> ByteString -> Either String [Image VS RGB Word8]

Readable [Image VS RGB Word16] [PPM]

Methods

decode :: [PPM] -> ByteString -> Either String [Image VS RGB Word16]

Readable (Image VS YA Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS YA Double)

Readable (Image VS Y Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS RGBA Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGBA Double)

Readable (Image VS RGB Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Double)

Readable (Image VS RGB Word8) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Word8)

Readable (Image VS RGB Word16) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Word16)

data SaveOption PPM

data SaveOption PPM

data SaveOption [PPM]

data SaveOption [PPM]

data InputFormat

A collection of all image formats that can be read into HIP images.

Constructors

InputBMP

InputGIF

InputHDR

InputJPG

InputPNG

InputTIF

InputPNM

InputTGA

Instances

Bounded InputFormat

Methods

minBound :: InputFormat

maxBound :: InputFormat

Enum InputFormat

Methods

succ :: InputFormat -> InputFormat

pred :: InputFormat -> InputFormat

toEnum :: Int -> InputFormat

fromEnum :: InputFormat -> Int

enumFrom :: InputFormat -> [InputFormat]

enumFromThen :: InputFormat -> InputFormat -> [InputFormat]

enumFromTo :: InputFormat -> InputFormat -> [InputFormat]

enumFromThenTo :: InputFormat -> InputFormat -> InputFormat -> [InputFormat]

Eq InputFormat

Methods

(==) :: InputFormat -> InputFormat -> Bool

(/=) :: InputFormat -> InputFormat -> Bool

Show InputFormat

Methods

showsPrec :: Int -> InputFormat -> ShowS

show :: InputFormat -> String

showList :: [InputFormat] -> ShowS

ImageFormat InputFormat

Associated Types

data SaveOption InputFormat :: *

Methods

ext :: InputFormat -> String

exts :: InputFormat -> [String]

isFormat :: String -> InputFormat -> Bool

(Readable (Image arr cs Double) BMP, Readable (Image arr cs Double) GIF, Readable (Image arr cs Double) HDR, Readable (Image arr cs Double) JPG, Readable (Image arr cs Double) PNG, Readable (Image arr cs Double) TGA, Readable (Image arr cs Double) TIF, Readable (Image arr cs Double) PPM) => Readable (Image arr cs Double) InputFormat

Methods

decode :: InputFormat -> ByteString -> Either String (Image arr cs Double)

data SaveOption InputFormat

data SaveOption InputFormat

data OutputFormat

A collection of all image formats that can be written to file using images with Double precision pixels.

Constructors

OutputBMP

OutputGIF

OutputHDR

OutputJPG

OutputPNG

OutputTIF

OutputTGA

Instances

Bounded OutputFormat

Methods

minBound :: OutputFormat

maxBound :: OutputFormat

Enum OutputFormat

Methods

succ :: OutputFormat -> OutputFormat

pred :: OutputFormat -> OutputFormat

toEnum :: Int -> OutputFormat

fromEnum :: OutputFormat -> Int

enumFrom :: OutputFormat -> [OutputFormat]

enumFromThen :: OutputFormat -> OutputFormat -> [OutputFormat]

enumFromTo :: OutputFormat -> OutputFormat -> [OutputFormat]

enumFromThenTo :: OutputFormat -> OutputFormat -> OutputFormat -> [OutputFormat]

Eq OutputFormat

Methods

(==) :: OutputFormat -> OutputFormat -> Bool

(/=) :: OutputFormat -> OutputFormat -> Bool

Show OutputFormat

Methods

showsPrec :: Int -> OutputFormat -> ShowS

show :: OutputFormat -> String

showList :: [OutputFormat] -> ShowS

ImageFormat OutputFormat

Associated Types

data SaveOption OutputFormat :: *

Methods

ext :: OutputFormat -> String

exts :: OutputFormat -> [String]

isFormat :: String -> OutputFormat -> Bool

(Writable (Image arr cs Double) BMP, Writable (Image arr cs Double) GIF, Writable (Image arr cs Double) HDR, Writable (Image arr cs Double) JPG, Writable (Image arr cs Double) PNG, Writable (Image arr cs Double) TGA, Writable (Image arr cs Double) TIF) => Writable (Image arr cs Double) OutputFormat

Methods

encode :: OutputFormat -> [SaveOption OutputFormat] -> Image arr cs Double -> ByteString

data SaveOption OutputFormat

data SaveOption OutputFormat

class ImageFormat format => Readable img format where

Image formats that can be read from file.

Minimal complete definition

decode

Methods

decode :: format -> ByteString -> Either String img

Decode an image from ByteString.

Instances

Readable [Image VS Y Word8] [PGM]

Methods

decode :: [PGM] -> ByteString -> Either String [Image VS Y Word8]

Readable [Image VS Y Word16] [PGM]

Methods

decode :: [PGM] -> ByteString -> Either String [Image VS Y Word16]

Readable [Image VS RGB Word8] [PPM]

Methods

decode :: [PPM] -> ByteString -> Either String [Image VS RGB Word8]

Readable [Image VS RGB Word16] [PPM]

Methods

decode :: [PPM] -> ByteString -> Either String [Image VS RGB Word16]

Readable [Image VS Binary Bit] [PBM]

Methods

decode :: [PBM] -> ByteString -> Either String [Image VS Binary Bit]

(Readable (Image arr cs Double) BMP, Readable (Image arr cs Double) GIF, Readable (Image arr cs Double) HDR, Readable (Image arr cs Double) JPG, Readable (Image arr cs Double) PNG, Readable (Image arr cs Double) TGA, Readable (Image arr cs Double) TIF, Readable (Image arr cs Double) PPM) => Readable (Image arr cs Double) InputFormat

Methods

decode :: InputFormat -> ByteString -> Either String (Image arr cs Double)

Readable (Image VS YA Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS YA Double)

Readable (Image VS Y Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS Y Double) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS Y Double) PBM

Methods

decode :: PBM -> ByteString -> Either String (Image VS Y Double)

Readable (Image VS Y Word8) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Word8)

Readable (Image VS Y Word16) PGM

Methods

decode :: PGM -> ByteString -> Either String (Image VS Y Word16)

Readable (Image VS RGBA Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGBA Double)

Readable (Image VS RGB Double) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Double)

Readable (Image VS RGB Word8) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Word8)

Readable (Image VS RGB Word16) PPM

Methods

decode :: PPM -> ByteString -> Either String (Image VS RGB Word16)

Readable (Image VS Binary Bit) PBM

Methods

decode :: PBM -> ByteString -> Either String (Image VS Binary Bit)

class ImageFormat format => Writable img format where

Image formats that can be written to file.

Minimal complete definition

encode

Methods

encode :: format -> [SaveOption format] -> img -> ByteString

Encode an image to ByteString.

Instances

(Writable (Image arr cs Double) BMP, Writable (Image arr cs Double) GIF, Writable (Image arr cs Double) HDR, Writable (Image arr cs Double) JPG, Writable (Image arr cs Double) PNG, Writable (Image arr cs Double) TGA, Writable (Image arr cs Double) TIF) => Writable (Image arr cs Double) OutputFormat

Methods

encode :: OutputFormat -> [SaveOption OutputFormat] -> Image arr cs Double -> ByteString

class ImageFormat format where

Image file format. Helps in guessing image format using a file extension, as well as supplying format specific options during saving an image.

Minimal complete definition

ext

Associated Types

data SaveOption format

Options that can be used during writing an image in this format.

Methods

ext :: format -> String

Default file extension for this image format.

exts :: format -> [String]

Known extensions for this image format.

isFormat :: String -> format -> Bool

Returns True if a file extension (ex. ".png") corresponds to this format.

Instances

ImageFormat TIF

Associated Types

data SaveOption TIF :: *

Methods

ext :: TIF -> String

exts :: TIF -> [String]

isFormat :: String -> TIF -> Bool

ImageFormat TGA

Associated Types

data SaveOption TGA :: *

Methods

ext :: TGA -> String

exts :: TGA -> [String]

isFormat :: String -> TGA -> Bool

ImageFormat PNG

Associated Types

data SaveOption PNG :: *

Methods

ext :: PNG -> String

exts :: PNG -> [String]

isFormat :: String -> PNG -> Bool

ImageFormat JPG

Associated Types

data SaveOption JPG :: *

Methods

ext :: JPG -> String

exts :: JPG -> [String]

isFormat :: String -> JPG -> Bool

ImageFormat HDR

Associated Types

data SaveOption HDR :: *

Methods

ext :: HDR -> String

exts :: HDR -> [String]

isFormat :: String -> HDR -> Bool

ImageFormat GIFA

Associated Types

data SaveOption GIFA :: *

Methods

ext :: GIFA -> String

exts :: GIFA -> [String]

isFormat :: String -> GIFA -> Bool

ImageFormat GIF

Associated Types

data SaveOption GIF :: *

Methods

ext :: GIF -> String

exts :: GIF -> [String]

isFormat :: String -> GIF -> Bool

ImageFormat BMP

Associated Types

data SaveOption BMP :: *

Methods

ext :: BMP -> String

exts :: BMP -> [String]

isFormat :: String -> BMP -> Bool

ImageFormat PPM

Associated Types

data SaveOption PPM :: *

Methods

ext :: PPM -> String

exts :: PPM -> [String]

isFormat :: String -> PPM -> Bool

ImageFormat PGM

Associated Types

data SaveOption PGM :: *

Methods

ext :: PGM -> String

exts :: PGM -> [String]

isFormat :: String -> PGM -> Bool

ImageFormat PBM

Associated Types

data SaveOption PBM :: *

Methods

ext :: PBM -> String

exts :: PBM -> [String]

isFormat :: String -> PBM -> Bool

ImageFormat OutputFormat

Associated Types

data SaveOption OutputFormat :: *

Methods

ext :: OutputFormat -> String

exts :: OutputFormat -> [String]

isFormat :: String -> OutputFormat -> Bool

ImageFormat InputFormat

Associated Types

data SaveOption InputFormat :: *

Methods

ext :: InputFormat -> String

exts :: InputFormat -> [String]

isFormat :: String -> InputFormat -> Bool

ImageFormat [PPM]

Associated Types

data SaveOption [PPM] :: *

Methods

ext :: [PPM] -> String

exts :: [PPM] -> [String]

isFormat :: String -> [PPM] -> Bool

ImageFormat [PGM]

Associated Types

data SaveOption [PGM] :: *

Methods

ext :: [PGM] -> String

exts :: [PGM] -> [String]

isFormat :: String -> [PGM] -> Bool

ImageFormat [PBM]

Associated Types

data SaveOption [PBM] :: *

Methods

ext :: [PBM] -> String

exts :: [PBM] -> [String]

isFormat :: String -> [PBM] -> Bool

class Convertible a b where

Used during converting pixels between libraries.

Minimal complete definition

convert

Methods

convert :: a -> b

Instances

ToRGBA cs e => Convertible (Pixel cs e) (Pixel RGBA Double)

Methods

convert :: Pixel cs e -> Pixel RGBA Double

ToRGB cs e => Convertible (Pixel cs e) (Pixel RGB Double)

Methods

convert :: Pixel cs e -> Pixel RGB Double

ToYA cs e => Convertible (Pixel cs e) (Pixel YA Double)

Methods

convert :: Pixel cs e -> Pixel YA Double

ToY cs e => Convertible (Pixel cs e) (Pixel Y Double)

Methods

convert :: Pixel cs e -> Pixel Y Double

Orphan instances

(Array arr cs e, Array arr cs (Complex e), RealFloat e, Applicative (Pixel cs), Writable (Image arr cs e) format) => Writable (Image arr cs (Complex e)) format

Methods

encode :: format -> [SaveOption format] -> Image arr cs (Complex e) -> ByteString