Data.Massiv.Array.IO

Reading

readArray

Arguments

:: Readable f arr

=> f

File format that should be used while decoding the file

-> ReadOptions f

Any file format related decoding options. Use def for default.

-> FilePath

Path to the file

-> IO arr

Read an array from one of the supported file formats.

readImage

Arguments

:: (Source S Ix2 (Pixel cs e), ColorSpace cs e)

=> FilePath

File path for an image

-> IO (Image S cs e)

Try to guess an image format from file's extension, then attempt to decode it as such. In order to supply the format manually and thus avoid this guessing technique, use readArray instead. Color space and precision of the result array must match exactly that of the actual image, in order to apply auto conversion use readImageAuto instead.

Might throw ConvertError, DecodeError and other standard errors related to file IO.

Result image will be read as specified by the type signature:

>>> frog <- readImage "files/frog.jpg" :: IO (Image S YCbCr Word8)
>>> displayImage frog

In case when the result image type does not match the color space or precision of the actual image file, ConvertError will be thrown.

>>> frog <- readImage "files/frog.jpg" :: IO (Image S CMYK Word8)
>>> displayImage frog
*** Exception: ConvertError "Cannot decode JPG image <Image S YCbCr Word8> as <Image S CMYK Word8>"

Whenever image is not in the color space or precision that we need, either use readImageAuto or manually convert to the desired one by using the appropriate conversion functions:

>>> frogCMYK <- readImageAuto "files/frog.jpg" :: IO (Image S CMYK Double)
>>> displayImage frogCMYK

readImageAuto

Arguments

:: (Mutable r Ix2 (Pixel cs e), ColorSpace cs e)

=> FilePath

File path for an image

-> IO (Image r cs e)

Same as readImage, but will perform any possible color space and precision conversions in order to match the result image type. Very useful whenever image format isn't known at compile time.

Writing

writeArray

Arguments

:: Writable f arr

=> f

Format to use while encoding the array

-> WriteOptions f

Any file format related encoding options. Use def for default.

-> FilePath

-> arr

-> IO ()

writeImage :: (Source r Ix2 (Pixel cs e), ColorSpace cs e) => FilePath -> Image r cs e -> IO ()

Inverse of the readImage, but similarly to it, will guess an output file format from the file extension and will write to file any image with the colorspace that is supported by that format. Precision of the image might be adjusted using Elevator if precision of the source array is not supported by the image file format. For instance, @r@ 'RGBA' 'Double' being saved as PNG file would be written as @r@ 'RGBA' 'Word16', thus using highest supported precision Word16 for that format. If automatic colors space is also desired, writeImageAuto can be used instead.

Can throw ConvertError, EncodeError and other usual IO errors.

writeImageAuto :: (Source r Ix2 (Pixel cs e), ColorSpace cs e, ToYA cs e, ToRGBA cs e, ToYCbCr cs e, ToCMYK cs e) => FilePath -> Image r cs e -> IO ()

Displaying

data ExternalViewer

External viewing application to use for displaying images.

Constructors

ExternalViewer FilePath [String] Int

Any custom viewer, which can be specified:

• FilePath - to the actual viewer executable.
• [String] - command line arguments that will be passed to the executable.
• Int - position index in the above list where FilePath to an image should be injected

Instances

Show ExternalViewer

Methods

showsPrec :: Int -> ExternalViewer -> ShowS

show :: ExternalViewer -> String

showList :: [ExternalViewer] -> ShowS

displayImage :: Writable (Auto TIF) (Image r cs e) => Image r cs e -> IO ()

Makes a call to an external viewer that is set as a default image viewer by the OS. This is a non-blocking function call, so it might take some time before an image will appear.

displayImageUsing

Arguments

:: Writable (Auto TIF) (Image r cs e)

=> ExternalViewer

Image viewer program

-> Bool

Should a call block the cuurrent thread untul viewer is closed.

-> Image r cs e

-> IO ()

An image is written as a .tiff file into an operating system's temporary directory and passed as an argument to the external viewer program. displayImageUsing :: Writable (Auto TIF) (Image r cs e) => ExternalViewer -- ^ Image viewer program -> Bool -- ^ Should a call block the cuurrent thread untul viewer is closed. -> Image r cs e -> IO ()

displayImageFile :: ExternalViewer -> FilePath -> IO ()

Displays an image file by calling an external image viewer.

Common viewers

defaultViewer :: ExternalViewer

Default viewer is inferred from the operating system.

eogViewer :: ExternalViewer

eog /tmp/hip/img.tiff

Eye of GNOME

gpicviewViewer :: ExternalViewer

gpicview /tmp/hip/img.tiff

GPicView

fehViewer :: ExternalViewer

feh --fullscreen --auto-zoom /tmp/hip/img.tiff

FEH

gimpViewer :: ExternalViewer

gimp /tmp/hip/img.tiff

GIMP

Supported Image Formats

class (Default (ReadOptions f), Default (WriteOptions f), Show f) => FileFormat f where

File format. Helps in guessing file format from a file extension, as well as supplying format specific options during saving the file.

Minimal complete definition

ext

Associated Types

type ReadOptions f

Options that can be used during reading a file in this format.

type WriteOptions f

Options that can be used during writing a file in this format.

Methods

ext :: f -> String

Default file extension for this file format.

exts :: f -> [String]

Other known file extensions for this file format, eg. ".jpeg", ".jpg".

isFormat :: String -> f -> Bool

Checks if a file extension corresponds to the format, eg. isFormat ".png" PNG == True

Instances

FileFormat TIF

Associated Types

type ReadOptions TIF :: *

type WriteOptions TIF :: *

Methods

ext :: TIF -> String

exts :: TIF -> [String]

isFormat :: String -> TIF -> Bool

FileFormat TGA

Associated Types

type ReadOptions TGA :: *

type WriteOptions TGA :: *

Methods

ext :: TGA -> String

exts :: TGA -> [String]

isFormat :: String -> TGA -> Bool

FileFormat JPG

Associated Types

type ReadOptions JPG :: *

type WriteOptions JPG :: *

Methods

ext :: JPG -> String

exts :: JPG -> [String]

isFormat :: String -> JPG -> Bool

FileFormat HDR

Associated Types

type ReadOptions HDR :: *

type WriteOptions HDR :: *

Methods

ext :: HDR -> String

exts :: HDR -> [String]

isFormat :: String -> HDR -> Bool

FileFormat GIF

Associated Types

type ReadOptions GIF :: *

type WriteOptions GIF :: *

Methods

ext :: GIF -> String

exts :: GIF -> [String]

isFormat :: String -> GIF -> Bool

FileFormat PNG

Associated Types

type ReadOptions PNG :: *

type WriteOptions PNG :: *

Methods

ext :: PNG -> String

exts :: PNG -> [String]

isFormat :: String -> PNG -> Bool

FileFormat BMP

Associated Types

type ReadOptions BMP :: *

type WriteOptions BMP :: *

Methods

ext :: BMP -> String

exts :: BMP -> [String]

isFormat :: String -> BMP -> Bool

FileFormat PPM

Associated Types

type ReadOptions PPM :: *

type WriteOptions PPM :: *

Methods

ext :: PPM -> String

exts :: PPM -> [String]

isFormat :: String -> PPM -> Bool

FileFormat PGM

Associated Types

type ReadOptions PGM :: *

type WriteOptions PGM :: *

Methods

ext :: PGM -> String

exts :: PGM -> [String]

isFormat :: String -> PGM -> Bool

FileFormat PBM

Associated Types

type ReadOptions PBM :: *

type WriteOptions PBM :: *

Methods

ext :: PBM -> String

exts :: PBM -> [String]

isFormat :: String -> PBM -> Bool

FileFormat f => FileFormat (Auto f)

Associated Types

type ReadOptions (Auto f) :: *

type WriteOptions (Auto f) :: *

Methods

ext :: Auto f -> String

exts :: Auto f -> [String]

isFormat :: String -> Auto f -> Bool

FileFormat (Sequence (Auto GIF))

Associated Types

type ReadOptions (Sequence (Auto GIF)) :: *

type WriteOptions (Sequence (Auto GIF)) :: *

Methods

ext :: Sequence (Auto GIF) -> String

exts :: Sequence (Auto GIF) -> [String]

isFormat :: String -> Sequence (Auto GIF) -> Bool

FileFormat (Sequence (Auto PPM))

Associated Types

type ReadOptions (Sequence (Auto PPM)) :: *

type WriteOptions (Sequence (Auto PPM)) :: *

Methods

ext :: Sequence (Auto PPM) -> String

exts :: Sequence (Auto PPM) -> [String]

isFormat :: String -> Sequence (Auto PPM) -> Bool

FileFormat (Sequence (Auto PGM))

Associated Types

type ReadOptions (Sequence (Auto PGM)) :: *

type WriteOptions (Sequence (Auto PGM)) :: *

Methods

ext :: Sequence (Auto PGM) -> String

exts :: Sequence (Auto PGM) -> [String]

isFormat :: String -> Sequence (Auto PGM) -> Bool

FileFormat (Sequence (Auto PBM))

Associated Types

type ReadOptions (Sequence (Auto PBM)) :: *

type WriteOptions (Sequence (Auto PBM)) :: *

Methods

ext :: Sequence (Auto PBM) -> String

exts :: Sequence (Auto PBM) -> [String]

isFormat :: String -> Sequence (Auto PBM) -> Bool

FileFormat (Sequence GIF)

Associated Types

type ReadOptions (Sequence GIF) :: *

type WriteOptions (Sequence GIF) :: *

Methods

ext :: Sequence GIF -> String

exts :: Sequence GIF -> [String]

isFormat :: String -> Sequence GIF -> Bool

FileFormat (Sequence PPM)

Associated Types

type ReadOptions (Sequence PPM) :: *

type WriteOptions (Sequence PPM) :: *

Methods

ext :: Sequence PPM -> String

exts :: Sequence PPM -> [String]

isFormat :: String -> Sequence PPM -> Bool

FileFormat (Sequence PGM)

Associated Types

type ReadOptions (Sequence PGM) :: *

type WriteOptions (Sequence PGM) :: *

Methods

ext :: Sequence PGM -> String

exts :: Sequence PGM -> [String]

isFormat :: String -> Sequence PGM -> Bool

FileFormat (Sequence PBM)

Associated Types

type ReadOptions (Sequence PBM) :: *

type WriteOptions (Sequence PBM) :: *

Methods

ext :: Sequence PBM -> String

exts :: Sequence PBM -> [String]

isFormat :: String -> Sequence PBM -> Bool

FileFormat (Decode (Image r cs e))

Associated Types

type ReadOptions (Decode (Image r cs e)) :: *

type WriteOptions (Decode (Image r cs e)) :: *

Methods

ext :: Decode (Image r cs e) -> String

exts :: Decode (Image r cs e) -> [String]

isFormat :: String -> Decode (Image r cs e) -> Bool

FileFormat (Encode (Image r cs e))

Associated Types

type ReadOptions (Encode (Image r cs e)) :: *

type WriteOptions (Encode (Image r cs e)) :: *

Methods

ext :: Encode (Image r cs e) -> String

exts :: Encode (Image r cs e) -> [String]

isFormat :: String -> Encode (Image r cs e) -> Bool

class Readable f arr where

File formats that can be read into an Array.

Minimal complete definition

decode

Methods

decode :: f -> ReadOptions f -> ByteString -> arr

Decode a ByteString into an Array.

Instances

ColorSpace cs e => Readable TIF (Image S cs e)

Methods

decode :: TIF -> ReadOptions TIF -> ByteString -> Image S cs e

ColorSpace cs e => Readable TGA (Image S cs e)

Methods

decode :: TGA -> ReadOptions TGA -> ByteString -> Image S cs e

ColorSpace cs e => Readable JPG (Image S cs e)

Methods

decode :: JPG -> ReadOptions JPG -> ByteString -> Image S cs e

ColorSpace cs e => Readable HDR (Image S cs e)

Methods

decode :: HDR -> ReadOptions HDR -> ByteString -> Image S cs e

ColorSpace cs e => Readable GIF (Image S cs e)

Methods

decode :: GIF -> ReadOptions GIF -> ByteString -> Image S cs e

ColorSpace cs e => Readable PNG (Image S cs e)

Methods

decode :: PNG -> ReadOptions PNG -> ByteString -> Image S cs e

ColorSpace cs e => Readable BMP (Image S cs e)

Methods

decode :: BMP -> ReadOptions BMP -> ByteString -> Image S cs e

ColorSpace cs e => Readable PPM (Image S cs e)

Methods

decode :: PPM -> ReadOptions PPM -> ByteString -> Image S cs e

ColorSpace cs e => Readable PGM (Image S cs e)

Methods

decode :: PGM -> ReadOptions PGM -> ByteString -> Image S cs e

ColorSpace cs e => Readable PBM (Image S cs e)

Methods

decode :: PBM -> ReadOptions PBM -> ByteString -> Image S cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TIF) (Image r cs e)

Methods

decode :: Auto TIF -> ReadOptions (Auto TIF) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TGA) (Image r cs e)

Methods

decode :: Auto TGA -> ReadOptions (Auto TGA) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto JPG) (Image r cs e)

Methods

decode :: Auto JPG -> ReadOptions (Auto JPG) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto HDR) (Image r cs e)

Methods

decode :: Auto HDR -> ReadOptions (Auto HDR) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto GIF) (Image r cs e)

Methods

decode :: Auto GIF -> ReadOptions (Auto GIF) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PNG) (Image r cs e)

Methods

decode :: Auto PNG -> ReadOptions (Auto PNG) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto BMP) (Image r cs e)

Methods

decode :: Auto BMP -> ReadOptions (Auto BMP) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PPM) (Image r cs e)

Methods

decode :: Auto PPM -> ReadOptions (Auto PPM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PGM) (Image r cs e)

Methods

decode :: Auto PGM -> ReadOptions (Auto PGM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PBM) (Image r cs e)

Methods

decode :: Auto PBM -> ReadOptions (Auto PBM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto GIF)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto GIF) -> ReadOptions (Sequence (Auto GIF)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PPM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PPM) -> ReadOptions (Sequence (Auto PPM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PGM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PGM) -> ReadOptions (Sequence (Auto PGM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PBM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PBM) -> ReadOptions (Sequence (Auto PBM)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (GifDelay, Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (GifDelay, Image S cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PPM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PPM -> ReadOptions (Sequence PPM) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PGM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PGM -> ReadOptions (Sequence PGM) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PBM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PBM -> ReadOptions (Sequence PBM) -> ByteString -> Array B Ix1 (Image S cs e)

Readable (Decode (Image r cs e)) (Image r cs e)

Methods

decode :: Decode (Image r cs e) -> ReadOptions (Decode (Image r cs e)) -> ByteString -> Image r cs e

class Writable f arr where

Arrays that can be written into a file.

Minimal complete definition

encode

Methods

encode :: f -> WriteOptions f -> arr -> ByteString

Encode an array into a ByteString.

Instances

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable TIF (Image r cs e)

Methods

encode :: TIF -> WriteOptions TIF -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable TGA (Image r cs e)

Methods

encode :: TGA -> WriteOptions TGA -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable JPG (Image r cs e)

Methods

encode :: JPG -> WriteOptions JPG -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable HDR (Image r cs e)

Methods

encode :: HDR -> WriteOptions HDR -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable GIF (Image r cs e)

Methods

encode :: GIF -> WriteOptions GIF -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable PNG (Image r cs e)

Methods

encode :: PNG -> WriteOptions PNG -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable BMP (Image r cs e)

Methods

encode :: BMP -> WriteOptions BMP -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TIF) (Image r cs e)

Methods

encode :: Auto TIF -> WriteOptions (Auto TIF) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TGA) (Image r cs e)

Methods

encode :: Auto TGA -> WriteOptions (Auto TGA) -> Image r cs e -> ByteString

(ColorSpace cs e, ToYCbCr cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto JPG) (Image r cs e)

Methods

encode :: Auto JPG -> WriteOptions (Auto JPG) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto HDR) (Image r cs e)

Methods

encode :: Auto HDR -> WriteOptions (Auto HDR) -> Image r cs e -> ByteString

(ColorSpace cs e, ToY cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto GIF) (Image r cs e)

Methods

encode :: Auto GIF -> WriteOptions (Auto GIF) -> Image r cs e -> ByteString

(ColorSpace cs e, ToYA cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto PNG) (Image r cs e)

Methods

encode :: Auto PNG -> WriteOptions (Auto PNG) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto BMP) (Image r cs e)

Methods

encode :: Auto BMP -> WriteOptions (Auto BMP) -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable (Sequence GIF) (Array B Ix1 (GifDelay, Image r cs e))

Methods

encode :: Sequence GIF -> WriteOptions (Sequence GIF) -> Array B Ix1 (GifDelay, Image r cs e) -> ByteString

Writable (Encode (Image r cs e)) (Image r cs e)

Methods

encode :: Encode (Image r cs e) -> WriteOptions (Encode (Image r cs e)) -> Image r cs e -> ByteString

newtype ConvertError

Conversion error, which is thrown when there is a mismatch between the expected array type and the one supported by the file format. It is also thrown upon a failure of automatic conversion between those types, in case such conversion is utilized.

Constructors

ConvertError String

Instances

Show ConvertError

Methods

showsPrec :: Int -> ConvertError -> ShowS

show :: ConvertError -> String

showList :: [ConvertError] -> ShowS

Exception ConvertError

Methods

toException :: ConvertError -> SomeException

fromException :: SomeException -> Maybe ConvertError

displayException :: ConvertError -> String

newtype EncodeError

This exception can be thrown while writing/encoding into a file and indicates an error in an array that is being encoded.

Constructors

EncodeError String

Instances

Show EncodeError

Methods

showsPrec :: Int -> EncodeError -> ShowS

show :: EncodeError -> String

showList :: [EncodeError] -> ShowS

Exception EncodeError

Methods

toException :: EncodeError -> SomeException

fromException :: SomeException -> Maybe EncodeError

displayException :: EncodeError -> String

newtype DecodeError

This exception can be thrown while reading/decoding a file and indicates an error in the file itself.

Constructors

DecodeError String

Instances

Show DecodeError

Methods

showsPrec :: Int -> DecodeError -> ShowS

show :: DecodeError -> String

showList :: [DecodeError] -> ShowS

Exception DecodeError

Methods

toException :: DecodeError -> SomeException

fromException :: SomeException -> Maybe DecodeError

displayException :: DecodeError -> String

newtype Sequence f

Special wrapper for formats that support encoding/decoding sequence of array.

Constructors

Sequence f

Instances

Show f => Show (Sequence f)

Methods

showsPrec :: Int -> Sequence f -> ShowS

show :: Sequence f -> String

showList :: [Sequence f] -> ShowS

FileFormat (Sequence (Auto GIF))

Associated Types

type ReadOptions (Sequence (Auto GIF)) :: *

type WriteOptions (Sequence (Auto GIF)) :: *

Methods

ext :: Sequence (Auto GIF) -> String

exts :: Sequence (Auto GIF) -> [String]

isFormat :: String -> Sequence (Auto GIF) -> Bool

FileFormat (Sequence (Auto PPM))

Associated Types

type ReadOptions (Sequence (Auto PPM)) :: *

type WriteOptions (Sequence (Auto PPM)) :: *

Methods

ext :: Sequence (Auto PPM) -> String

exts :: Sequence (Auto PPM) -> [String]

isFormat :: String -> Sequence (Auto PPM) -> Bool

FileFormat (Sequence (Auto PGM))

Associated Types

type ReadOptions (Sequence (Auto PGM)) :: *

type WriteOptions (Sequence (Auto PGM)) :: *

Methods

ext :: Sequence (Auto PGM) -> String

exts :: Sequence (Auto PGM) -> [String]

isFormat :: String -> Sequence (Auto PGM) -> Bool

FileFormat (Sequence (Auto PBM))

Associated Types

type ReadOptions (Sequence (Auto PBM)) :: *

type WriteOptions (Sequence (Auto PBM)) :: *

Methods

ext :: Sequence (Auto PBM) -> String

exts :: Sequence (Auto PBM) -> [String]

isFormat :: String -> Sequence (Auto PBM) -> Bool

FileFormat (Sequence GIF)

Associated Types

type ReadOptions (Sequence GIF) :: *

type WriteOptions (Sequence GIF) :: *

Methods

ext :: Sequence GIF -> String

exts :: Sequence GIF -> [String]

isFormat :: String -> Sequence GIF -> Bool

FileFormat (Sequence PPM)

Associated Types

type ReadOptions (Sequence PPM) :: *

type WriteOptions (Sequence PPM) :: *

Methods

ext :: Sequence PPM -> String

exts :: Sequence PPM -> [String]

isFormat :: String -> Sequence PPM -> Bool

FileFormat (Sequence PGM)

Associated Types

type ReadOptions (Sequence PGM) :: *

type WriteOptions (Sequence PGM) :: *

Methods

ext :: Sequence PGM -> String

exts :: Sequence PGM -> [String]

isFormat :: String -> Sequence PGM -> Bool

FileFormat (Sequence PBM)

Associated Types

type ReadOptions (Sequence PBM) :: *

type WriteOptions (Sequence PBM) :: *

Methods

ext :: Sequence PBM -> String

exts :: Sequence PBM -> [String]

isFormat :: String -> Sequence PBM -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable (Sequence GIF) (Array B Ix1 (GifDelay, Image r cs e))

Methods

encode :: Sequence GIF -> WriteOptions (Sequence GIF) -> Array B Ix1 (GifDelay, Image r cs e) -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto GIF)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto GIF) -> ReadOptions (Sequence (Auto GIF)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PPM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PPM) -> ReadOptions (Sequence (Auto PPM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PGM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PGM) -> ReadOptions (Sequence (Auto PGM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PBM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PBM) -> ReadOptions (Sequence (Auto PBM)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (GifDelay, Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (GifDelay, Image S cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PPM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PPM -> ReadOptions (Sequence PPM) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PGM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PGM -> ReadOptions (Sequence PGM) -> ByteString -> Array B Ix1 (Image S cs e)

ColorSpace cs e => Readable (Sequence PBM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PBM -> ReadOptions (Sequence PBM) -> ByteString -> Array B Ix1 (Image S cs e)

type ReadOptions (Sequence (Auto GIF))

type ReadOptions (Sequence (Auto GIF)) = ()

type ReadOptions (Sequence (Auto PPM))

type ReadOptions (Sequence (Auto PPM)) = ()

type ReadOptions (Sequence (Auto PGM))

type ReadOptions (Sequence (Auto PGM)) = ()

type ReadOptions (Sequence (Auto PBM))

type ReadOptions (Sequence (Auto PBM)) = ()

type ReadOptions (Sequence GIF)

type ReadOptions (Sequence GIF) = ()

type ReadOptions (Sequence PPM)

type ReadOptions (Sequence PPM) = ()

type ReadOptions (Sequence PGM)

type ReadOptions (Sequence PGM) = ()

type ReadOptions (Sequence PBM)

type ReadOptions (Sequence PBM) = ()

type WriteOptions (Sequence (Auto GIF))

type WriteOptions (Sequence (Auto GIF)) = WriteOptions (Sequence GIF)

type WriteOptions (Sequence (Auto PPM))

type WriteOptions (Sequence (Auto PPM)) = WriteOptions PPM

type WriteOptions (Sequence (Auto PGM))

type WriteOptions (Sequence (Auto PGM)) = WriteOptions PGM

type WriteOptions (Sequence (Auto PBM))

type WriteOptions (Sequence (Auto PBM)) = WriteOptions PBM

type WriteOptions (Sequence GIF)

type WriteOptions (Sequence GIF) = WriteOptionsSequenceGIF

type WriteOptions (Sequence PPM)

type WriteOptions (Sequence PPM) = WriteOptions PPM

type WriteOptions (Sequence PGM)

type WriteOptions (Sequence PGM) = WriteOptions PGM

type WriteOptions (Sequence PBM)

type WriteOptions (Sequence PBM) = WriteOptions PBM

newtype Auto f

Constructors

Auto f

Instances

Show f => Show (Auto f)

Methods

showsPrec :: Int -> Auto f -> ShowS

show :: Auto f -> String

showList :: [Auto f] -> ShowS

FileFormat f => FileFormat (Auto f)

Associated Types

type ReadOptions (Auto f) :: *

type WriteOptions (Auto f) :: *

Methods

ext :: Auto f -> String

exts :: Auto f -> [String]

isFormat :: String -> Auto f -> Bool

FileFormat (Sequence (Auto GIF))

Associated Types

type ReadOptions (Sequence (Auto GIF)) :: *

type WriteOptions (Sequence (Auto GIF)) :: *

Methods

ext :: Sequence (Auto GIF) -> String

exts :: Sequence (Auto GIF) -> [String]

isFormat :: String -> Sequence (Auto GIF) -> Bool

FileFormat (Sequence (Auto PPM))

Associated Types

type ReadOptions (Sequence (Auto PPM)) :: *

type WriteOptions (Sequence (Auto PPM)) :: *

Methods

ext :: Sequence (Auto PPM) -> String

exts :: Sequence (Auto PPM) -> [String]

isFormat :: String -> Sequence (Auto PPM) -> Bool

FileFormat (Sequence (Auto PGM))

Associated Types

type ReadOptions (Sequence (Auto PGM)) :: *

type WriteOptions (Sequence (Auto PGM)) :: *

Methods

ext :: Sequence (Auto PGM) -> String

exts :: Sequence (Auto PGM) -> [String]

isFormat :: String -> Sequence (Auto PGM) -> Bool

FileFormat (Sequence (Auto PBM))

Associated Types

type ReadOptions (Sequence (Auto PBM)) :: *

type WriteOptions (Sequence (Auto PBM)) :: *

Methods

ext :: Sequence (Auto PBM) -> String

exts :: Sequence (Auto PBM) -> [String]

isFormat :: String -> Sequence (Auto PBM) -> Bool

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TIF) (Image r cs e)

Methods

encode :: Auto TIF -> WriteOptions (Auto TIF) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TGA) (Image r cs e)

Methods

encode :: Auto TGA -> WriteOptions (Auto TGA) -> Image r cs e -> ByteString

(ColorSpace cs e, ToYCbCr cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto JPG) (Image r cs e)

Methods

encode :: Auto JPG -> WriteOptions (Auto JPG) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto HDR) (Image r cs e)

Methods

encode :: Auto HDR -> WriteOptions (Auto HDR) -> Image r cs e -> ByteString

(ColorSpace cs e, ToY cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto GIF) (Image r cs e)

Methods

encode :: Auto GIF -> WriteOptions (Auto GIF) -> Image r cs e -> ByteString

(ColorSpace cs e, ToYA cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto PNG) (Image r cs e)

Methods

encode :: Auto PNG -> WriteOptions (Auto PNG) -> Image r cs e -> ByteString

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto BMP) (Image r cs e)

Methods

encode :: Auto BMP -> WriteOptions (Auto BMP) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TIF) (Image r cs e)

Methods

decode :: Auto TIF -> ReadOptions (Auto TIF) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TGA) (Image r cs e)

Methods

decode :: Auto TGA -> ReadOptions (Auto TGA) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto JPG) (Image r cs e)

Methods

decode :: Auto JPG -> ReadOptions (Auto JPG) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto HDR) (Image r cs e)

Methods

decode :: Auto HDR -> ReadOptions (Auto HDR) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto GIF) (Image r cs e)

Methods

decode :: Auto GIF -> ReadOptions (Auto GIF) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PNG) (Image r cs e)

Methods

decode :: Auto PNG -> ReadOptions (Auto PNG) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto BMP) (Image r cs e)

Methods

decode :: Auto BMP -> ReadOptions (Auto BMP) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PPM) (Image r cs e)

Methods

decode :: Auto PPM -> ReadOptions (Auto PPM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PGM) (Image r cs e)

Methods

decode :: Auto PGM -> ReadOptions (Auto PGM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PBM) (Image r cs e)

Methods

decode :: Auto PBM -> ReadOptions (Auto PBM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto GIF)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto GIF) -> ReadOptions (Sequence (Auto GIF)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PPM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PPM) -> ReadOptions (Sequence (Auto PPM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PGM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PGM) -> ReadOptions (Sequence (Auto PGM)) -> ByteString -> Array B Ix1 (Image r cs e)

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PBM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PBM) -> ReadOptions (Sequence (Auto PBM)) -> ByteString -> Array B Ix1 (Image r cs e)

type ReadOptions (Auto f)

type ReadOptions (Auto f) = ReadOptions f

type ReadOptions (Sequence (Auto GIF))

type ReadOptions (Sequence (Auto GIF)) = ()

type ReadOptions (Sequence (Auto PPM))

type ReadOptions (Sequence (Auto PPM)) = ()

type ReadOptions (Sequence (Auto PGM))

type ReadOptions (Sequence (Auto PGM)) = ()

type ReadOptions (Sequence (Auto PBM))

type ReadOptions (Sequence (Auto PBM)) = ()

type WriteOptions (Auto f)

type WriteOptions (Auto f) = WriteOptions f

type WriteOptions (Sequence (Auto GIF))

type WriteOptions (Sequence (Auto GIF)) = WriteOptions (Sequence GIF)

type WriteOptions (Sequence (Auto PPM))

type WriteOptions (Sequence (Auto PPM)) = WriteOptions PPM

type WriteOptions (Sequence (Auto PGM))

type WriteOptions (Sequence (Auto PGM)) = WriteOptions PGM

type WriteOptions (Sequence (Auto PBM))

type WriteOptions (Sequence (Auto PBM)) = WriteOptions PBM

type Image r cs e = Array r Ix2 (Pixel cs e)

defaultReadOptions :: FileFormat f => f -> ReadOptions f

Generate default read options for a file format

defaultWriteOptions :: FileFormat f => f -> WriteOptions f

Generate default write options for a file format

toProxy :: a -> Proxy a

Helper function to create a Proxy from the value.

fromMaybeEncode :: forall f r cs e b. (ColorSpace cs e, FileFormat f, Typeable r) => f -> Proxy (Image r cs e) -> Maybe b -> b

Encode an image using the supplied function or throw an error in case of failure.

fromEitherDecode :: forall r cs e a f. (ColorSpace cs e, FileFormat f, Typeable r) => f -> (a -> String) -> (a -> Maybe (Image r cs e)) -> Either String a -> Image r cs e

Decode an image using the supplied function or throw an error in case of failure.

convertEither :: forall r cs e a f. (ColorSpace cs e, FileFormat f, Typeable r) => f -> (a -> String) -> (a -> Maybe (Image r cs e)) -> a -> Either ConvertError (Image r cs e)

Convert an image using the supplied function and return ConvertError error in case of failure.

data Encode out

Instances

Show (Encode out)

Methods

showsPrec :: Int -> Encode out -> ShowS

show :: Encode out -> String

showList :: [Encode out] -> ShowS

FileFormat (Encode (Image r cs e))

Associated Types

type ReadOptions (Encode (Image r cs e)) :: *

type WriteOptions (Encode (Image r cs e)) :: *

Methods

ext :: Encode (Image r cs e) -> String

exts :: Encode (Image r cs e) -> [String]

isFormat :: String -> Encode (Image r cs e) -> Bool

Writable (Encode (Image r cs e)) (Image r cs e)

Methods

encode :: Encode (Image r cs e) -> WriteOptions (Encode (Image r cs e)) -> Image r cs e -> ByteString

type ReadOptions (Encode (Image r cs e))

type ReadOptions (Encode (Image r cs e)) = ()

type WriteOptions (Encode (Image r cs e))

type WriteOptions (Encode (Image r cs e)) = ()

encodeImage :: (Source r Ix2 (Pixel cs e), ColorSpace cs e) => [Encode (Image r cs e)] -> FilePath -> Image r cs e -> ByteString

imageWriteFormats :: (Source r Ix2 (Pixel cs e), ColorSpace cs e) => [Encode (Image r cs e)]

imageWriteAutoFormats :: (Source r Ix2 (Pixel cs e), ColorSpace cs e, ToYA cs e, ToRGBA cs e, ToYCbCr cs e, ToCMYK cs e) => [Encode (Image r cs e)]

data Decode out

Instances

Show (Decode out)

Methods

showsPrec :: Int -> Decode out -> ShowS

show :: Decode out -> String

showList :: [Decode out] -> ShowS

FileFormat (Decode (Image r cs e))

Associated Types

type ReadOptions (Decode (Image r cs e)) :: *

type WriteOptions (Decode (Image r cs e)) :: *

Methods

ext :: Decode (Image r cs e) -> String

exts :: Decode (Image r cs e) -> [String]

isFormat :: String -> Decode (Image r cs e) -> Bool

Readable (Decode (Image r cs e)) (Image r cs e)

Methods

decode :: Decode (Image r cs e) -> ReadOptions (Decode (Image r cs e)) -> ByteString -> Image r cs e

type ReadOptions (Decode (Image r cs e))

type ReadOptions (Decode (Image r cs e)) = ()

type WriteOptions (Decode (Image r cs e))

type WriteOptions (Decode (Image r cs e)) = ()

decodeImage :: (Source r Ix2 (Pixel cs e), ColorSpace cs e) => [Decode (Image r cs e)] -> FilePath -> ByteString -> Image r cs e

imageReadFormats :: (Source S Ix2 (Pixel cs e), ColorSpace cs e) => [Decode (Image S cs e)]

imageReadAutoFormats :: (Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => [Decode (Image r cs e)]

JuicyPixels formats

BMP

data BMP

Bitmap image with .bmp extension.

Constructors

BMP

Instances

Show BMP

Methods

showsPrec :: Int -> BMP -> ShowS

show :: BMP -> String

showList :: [BMP] -> ShowS

FileFormat BMP

Associated Types

type ReadOptions BMP :: *

type WriteOptions BMP :: *

Methods

ext :: BMP -> String

exts :: BMP -> [String]

isFormat :: String -> BMP -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable BMP (Image r cs e)

Methods

encode :: BMP -> WriteOptions BMP -> Image r cs e -> ByteString

ColorSpace cs e => Readable BMP (Image S cs e)

Methods

decode :: BMP -> ReadOptions BMP -> ByteString -> Image S cs e

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto BMP) (Image r cs e)

Methods

encode :: Auto BMP -> WriteOptions (Auto BMP) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto BMP) (Image r cs e)

Methods

decode :: Auto BMP -> ReadOptions (Auto BMP) -> ByteString -> Image r cs e

type ReadOptions BMP

type ReadOptions BMP = ()

type WriteOptions BMP

type WriteOptions BMP = ()

GIF

data GIF

Graphics Interchange Format image with .gif extension.

Constructors

GIF

Instances

Show GIF

Methods

showsPrec :: Int -> GIF -> ShowS

show :: GIF -> String

showList :: [GIF] -> ShowS

FileFormat GIF

Associated Types

type ReadOptions GIF :: *

type WriteOptions GIF :: *

Methods

ext :: GIF -> String

exts :: GIF -> [String]

isFormat :: String -> GIF -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable GIF (Image r cs e)

Methods

encode :: GIF -> WriteOptions GIF -> Image r cs e -> ByteString

ColorSpace cs e => Readable GIF (Image S cs e)

Methods

decode :: GIF -> ReadOptions GIF -> ByteString -> Image S cs e

FileFormat (Sequence (Auto GIF))

Associated Types

type ReadOptions (Sequence (Auto GIF)) :: *

type WriteOptions (Sequence (Auto GIF)) :: *

Methods

ext :: Sequence (Auto GIF) -> String

exts :: Sequence (Auto GIF) -> [String]

isFormat :: String -> Sequence (Auto GIF) -> Bool

FileFormat (Sequence GIF)

Associated Types

type ReadOptions (Sequence GIF) :: *

type WriteOptions (Sequence GIF) :: *

Methods

ext :: Sequence GIF -> String

exts :: Sequence GIF -> [String]

isFormat :: String -> Sequence GIF -> Bool

(ColorSpace cs e, ToY cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto GIF) (Image r cs e)

Methods

encode :: Auto GIF -> WriteOptions (Auto GIF) -> Image r cs e -> ByteString

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable (Sequence GIF) (Array B Ix1 (GifDelay, Image r cs e))

Methods

encode :: Sequence GIF -> WriteOptions (Sequence GIF) -> Array B Ix1 (GifDelay, Image r cs e) -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto GIF) (Image r cs e)

Methods

decode :: Auto GIF -> ReadOptions (Auto GIF) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto GIF)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto GIF) -> ReadOptions (Sequence (Auto GIF)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (GifDelay, Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (GifDelay, Image S cs e)

ColorSpace cs e => Readable (Sequence GIF) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence GIF -> ReadOptions (Sequence GIF) -> ByteString -> Array B Ix1 (Image S cs e)

type ReadOptions GIF

type ReadOptions GIF = ()

type WriteOptions GIF

type WriteOptions GIF = WriteOptionsGIF

type ReadOptions (Sequence (Auto GIF))

type ReadOptions (Sequence (Auto GIF)) = ()

type ReadOptions (Sequence GIF)

type ReadOptions (Sequence GIF) = ()

type WriteOptions (Sequence (Auto GIF))

type WriteOptions (Sequence (Auto GIF)) = WriteOptions (Sequence GIF)

type WriteOptions (Sequence GIF)

type WriteOptions (Sequence GIF) = WriteOptionsSequenceGIF

data WriteOptionsGIF

Instances

Default WriteOptionsGIF

Methods

def :: WriteOptionsGIF

woGetPaletteOptionsGIF :: WriteOptionsGIF -> PaletteOptions

woSetPaletteOptionsGIF :: PaletteOptions -> WriteOptionsGIF -> WriteOptionsGIF

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.

Animated

data WriteOptionsSequenceGIF

Instances

Default WriteOptionsSequenceGIF

Methods

def :: WriteOptionsSequenceGIF

woGetGifLoopingGIFs :: WriteOptionsSequenceGIF -> GifLooping

woGetPaletteOptionsGIFs :: WriteOptionsSequenceGIF -> PaletteOptions

woSetGifLoopingGIFs :: GifLooping -> WriteOptionsSequenceGIF -> WriteOptionsSequenceGIF

woSetPaletteOptionsGIFs :: PaletteOptions -> WriteOptionsSequenceGIF -> WriteOptionsSequenceGIF

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

HDR

data HDR

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

Constructors

HDR

Instances

Show HDR

Methods

showsPrec :: Int -> HDR -> ShowS

show :: HDR -> String

showList :: [HDR] -> ShowS

FileFormat HDR

Associated Types

type ReadOptions HDR :: *

type WriteOptions HDR :: *

Methods

ext :: HDR -> String

exts :: HDR -> [String]

isFormat :: String -> HDR -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable HDR (Image r cs e)

Methods

encode :: HDR -> WriteOptions HDR -> Image r cs e -> ByteString

ColorSpace cs e => Readable HDR (Image S cs e)

Methods

decode :: HDR -> ReadOptions HDR -> ByteString -> Image S cs e

(ColorSpace cs e, ToRGB cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto HDR) (Image r cs e)

Methods

encode :: Auto HDR -> WriteOptions (Auto HDR) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto HDR) (Image r cs e)

Methods

decode :: Auto HDR -> ReadOptions (Auto HDR) -> ByteString -> Image r cs e

type ReadOptions HDR

type ReadOptions HDR = ()

type WriteOptions HDR

type WriteOptions HDR = ()

JPG

data JPG

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

Constructors

JPG

Instances

Show JPG

Methods

showsPrec :: Int -> JPG -> ShowS

show :: JPG -> String

showList :: [JPG] -> ShowS

FileFormat JPG

Associated Types

type ReadOptions JPG :: *

type WriteOptions JPG :: *

Methods

ext :: JPG -> String

exts :: JPG -> [String]

isFormat :: String -> JPG -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable JPG (Image r cs e)

Methods

encode :: JPG -> WriteOptions JPG -> Image r cs e -> ByteString

ColorSpace cs e => Readable JPG (Image S cs e)

Methods

decode :: JPG -> ReadOptions JPG -> ByteString -> Image S cs e

(ColorSpace cs e, ToYCbCr cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto JPG) (Image r cs e)

Methods

encode :: Auto JPG -> WriteOptions (Auto JPG) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto JPG) (Image r cs e)

Methods

decode :: Auto JPG -> ReadOptions (Auto JPG) -> ByteString -> Image r cs e

type ReadOptions JPG

type ReadOptions JPG = ()

type WriteOptions JPG

type WriteOptions JPG = WriteOptionsJPG

data WriteOptionsJPG

Instances

Show WriteOptionsJPG

Methods

showsPrec :: Int -> WriteOptionsJPG -> ShowS

show :: WriteOptionsJPG -> String

showList :: [WriteOptionsJPG] -> ShowS

Default WriteOptionsJPG

Methods

def :: WriteOptionsJPG

woGetQualityJPG :: WriteOptionsJPG -> Word8

woSetQualityJPG :: Word8 -> WriteOptionsJPG -> WriteOptionsJPG

Set the image quality, supplied value will be clamped to [0, 100] range. This setting directly affects the Jpeg compression level.

PNG

data PNG

Portable Network Graphics image with .png extension.

Constructors

PNG

Instances

Show PNG

Methods

showsPrec :: Int -> PNG -> ShowS

show :: PNG -> String

showList :: [PNG] -> ShowS

FileFormat PNG

Associated Types

type ReadOptions PNG :: *

type WriteOptions PNG :: *

Methods

ext :: PNG -> String

exts :: PNG -> [String]

isFormat :: String -> PNG -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable PNG (Image r cs e)

Methods

encode :: PNG -> WriteOptions PNG -> Image r cs e -> ByteString

ColorSpace cs e => Readable PNG (Image S cs e)

Methods

decode :: PNG -> ReadOptions PNG -> ByteString -> Image S cs e

(ColorSpace cs e, ToYA cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto PNG) (Image r cs e)

Methods

encode :: Auto PNG -> WriteOptions (Auto PNG) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PNG) (Image r cs e)

Methods

decode :: Auto PNG -> ReadOptions (Auto PNG) -> ByteString -> Image r cs e

type ReadOptions PNG

type ReadOptions PNG = ()

type WriteOptions PNG

type WriteOptions PNG = ()

TGA

data TGA

Truevision Graphics Adapter image with .tga extension.

Constructors

TGA

Instances

Show TGA

Methods

showsPrec :: Int -> TGA -> ShowS

show :: TGA -> String

showList :: [TGA] -> ShowS

FileFormat TGA

Associated Types

type ReadOptions TGA :: *

type WriteOptions TGA :: *

Methods

ext :: TGA -> String

exts :: TGA -> [String]

isFormat :: String -> TGA -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable TGA (Image r cs e)

Methods

encode :: TGA -> WriteOptions TGA -> Image r cs e -> ByteString

ColorSpace cs e => Readable TGA (Image S cs e)

Methods

decode :: TGA -> ReadOptions TGA -> ByteString -> Image S cs e

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TGA) (Image r cs e)

Methods

encode :: Auto TGA -> WriteOptions (Auto TGA) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TGA) (Image r cs e)

Methods

decode :: Auto TGA -> ReadOptions (Auto TGA) -> ByteString -> Image r cs e

type ReadOptions TGA

type ReadOptions TGA = ()

type WriteOptions TGA

type WriteOptions TGA = ()

TIF

data TIF

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

Constructors

TIF

Instances

Show TIF

Methods

showsPrec :: Int -> TIF -> ShowS

show :: TIF -> String

showList :: [TIF] -> ShowS

FileFormat TIF

Associated Types

type ReadOptions TIF :: *

type WriteOptions TIF :: *

Methods

ext :: TIF -> String

exts :: TIF -> [String]

isFormat :: String -> TIF -> Bool

(ColorSpace cs e, Source r Ix2 (Pixel cs e)) => Writable TIF (Image r cs e)

Methods

encode :: TIF -> WriteOptions TIF -> Image r cs e -> ByteString

ColorSpace cs e => Readable TIF (Image S cs e)

Methods

decode :: TIF -> ReadOptions TIF -> ByteString -> Image S cs e

(ColorSpace cs e, ToRGBA cs e, Source r Ix2 (Pixel cs e)) => Writable (Auto TIF) (Image r cs e)

Methods

encode :: Auto TIF -> WriteOptions (Auto TIF) -> Image r cs e -> ByteString

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto TIF) (Image r cs e)

Methods

decode :: Auto TIF -> ReadOptions (Auto TIF) -> ByteString -> Image r cs e

type ReadOptions TIF

type ReadOptions TIF = ()

type WriteOptions TIF

type WriteOptions TIF = ()

JuciyPixels conversion

To JuicyPixels

toAnyCS :: forall r' cs' e' r cs e. (Source r' Ix2 (Pixel cs' e'), Mutable r Ix2 (Pixel cs e), Storable (Pixel cs e), ColorSpace cs e, ToYA cs' e', ToRGBA cs' e', ToHSIA cs' e', ToCMYKA cs' e', ToYCbCrA cs' e') => Image r' cs' e' -> Maybe (Image r cs e)

toJPImageY8 :: Source r Ix2 (Pixel Y Word8) => Image r Y Word8 -> Image Pixel8

toJPImageYA8 :: Source r Ix2 (Pixel YA Word8) => Image r YA Word8 -> Image PixelYA8

toJPImageY16 :: Source r Ix2 (Pixel Y Word16) => Image r Y Word16 -> Image Pixel16

toJPImageYA16 :: Source r Ix2 (Pixel YA Word16) => Image r YA Word16 -> Image PixelYA16

toJPImageYF :: Source r Ix2 (Pixel Y Float) => Image r Y Float -> Image PixelF

toJPImageRGB8 :: Source r Ix2 (Pixel RGB Word8) => Image r RGB Word8 -> Image PixelRGB8

toJPImageRGBA8 :: Source r Ix2 (Pixel RGBA Word8) => Image r RGBA Word8 -> Image PixelRGBA8

toJPImageRGB16 :: Source r Ix2 (Pixel RGB Word16) => Image r RGB Word16 -> Image PixelRGB16

toJPImageRGBA16 :: Source r Ix2 (Pixel RGBA Word16) => Image r RGBA Word16 -> Image PixelRGBA16

toJPImageRGBF :: Source r Ix2 (Pixel RGB Float) => Image r RGB Float -> Image PixelRGBF

toJPImageYCbCr8 :: Source r Ix2 (Pixel YCbCr Word8) => Image r YCbCr Word8 -> Image PixelYCbCr8

toJPImageCMYK8 :: Source r Ix2 (Pixel CMYK Word8) => Image r CMYK Word8 -> Image PixelCMYK8

From JuicyPixels

Netpbm formats

PBM

data PBM

Netpbm: portable bitmap image with .pbm extension.

Constructors

PBM

Instances

Show PBM

Methods

showsPrec :: Int -> PBM -> ShowS

show :: PBM -> String

showList :: [PBM] -> ShowS

FileFormat PBM

Associated Types

type ReadOptions PBM :: *

type WriteOptions PBM :: *

Methods

ext :: PBM -> String

exts :: PBM -> [String]

isFormat :: String -> PBM -> Bool

ColorSpace cs e => Readable PBM (Image S cs e)

Methods

decode :: PBM -> ReadOptions PBM -> ByteString -> Image S cs e

FileFormat (Sequence (Auto PBM))

Associated Types

type ReadOptions (Sequence (Auto PBM)) :: *

type WriteOptions (Sequence (Auto PBM)) :: *

Methods

ext :: Sequence (Auto PBM) -> String

exts :: Sequence (Auto PBM) -> [String]

isFormat :: String -> Sequence (Auto PBM) -> Bool

FileFormat (Sequence PBM)

Associated Types

type ReadOptions (Sequence PBM) :: *

type WriteOptions (Sequence PBM) :: *

Methods

ext :: Sequence PBM -> String

exts :: Sequence PBM -> [String]

isFormat :: String -> Sequence PBM -> Bool

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PBM) (Image r cs e)

Methods

decode :: Auto PBM -> ReadOptions (Auto PBM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PBM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PBM) -> ReadOptions (Sequence (Auto PBM)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence PBM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PBM -> ReadOptions (Sequence PBM) -> ByteString -> Array B Ix1 (Image S cs e)

type ReadOptions PBM

type ReadOptions PBM = ()

type WriteOptions PBM

type WriteOptions PBM = ()

type ReadOptions (Sequence (Auto PBM))

type ReadOptions (Sequence (Auto PBM)) = ()

type ReadOptions (Sequence PBM)

type ReadOptions (Sequence PBM) = ()

type WriteOptions (Sequence (Auto PBM))

type WriteOptions (Sequence (Auto PBM)) = WriteOptions PBM

type WriteOptions (Sequence PBM)

type WriteOptions (Sequence PBM) = WriteOptions PBM

PGM

data PGM

Netpbm: portable graymap image with .pgm extension.

Constructors

PGM

Instances

Show PGM

Methods

showsPrec :: Int -> PGM -> ShowS

show :: PGM -> String

showList :: [PGM] -> ShowS

FileFormat PGM

Associated Types

type ReadOptions PGM :: *

type WriteOptions PGM :: *

Methods

ext :: PGM -> String

exts :: PGM -> [String]

isFormat :: String -> PGM -> Bool

ColorSpace cs e => Readable PGM (Image S cs e)

Methods

decode :: PGM -> ReadOptions PGM -> ByteString -> Image S cs e

FileFormat (Sequence (Auto PGM))

Associated Types

type ReadOptions (Sequence (Auto PGM)) :: *

type WriteOptions (Sequence (Auto PGM)) :: *

Methods

ext :: Sequence (Auto PGM) -> String

exts :: Sequence (Auto PGM) -> [String]

isFormat :: String -> Sequence (Auto PGM) -> Bool

FileFormat (Sequence PGM)

Associated Types

type ReadOptions (Sequence PGM) :: *

type WriteOptions (Sequence PGM) :: *

Methods

ext :: Sequence PGM -> String

exts :: Sequence PGM -> [String]

isFormat :: String -> Sequence PGM -> Bool

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PGM) (Image r cs e)

Methods

decode :: Auto PGM -> ReadOptions (Auto PGM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PGM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PGM) -> ReadOptions (Sequence (Auto PGM)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence PGM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PGM -> ReadOptions (Sequence PGM) -> ByteString -> Array B Ix1 (Image S cs e)

type ReadOptions PGM

type ReadOptions PGM = ()

type WriteOptions PGM

type WriteOptions PGM = ()

type ReadOptions (Sequence (Auto PGM))

type ReadOptions (Sequence (Auto PGM)) = ()

type ReadOptions (Sequence PGM)

type ReadOptions (Sequence PGM) = ()

type WriteOptions (Sequence (Auto PGM))

type WriteOptions (Sequence (Auto PGM)) = WriteOptions PGM

type WriteOptions (Sequence PGM)

type WriteOptions (Sequence PGM) = WriteOptions PGM

PPM

data PPM

Netpbm: portable pixmap image with .ppm extension.

Constructors

PPM

Instances

Show PPM

Methods

showsPrec :: Int -> PPM -> ShowS

show :: PPM -> String

showList :: [PPM] -> ShowS

FileFormat PPM

Associated Types

type ReadOptions PPM :: *

type WriteOptions PPM :: *

Methods

ext :: PPM -> String

exts :: PPM -> [String]

isFormat :: String -> PPM -> Bool

ColorSpace cs e => Readable PPM (Image S cs e)

Methods

decode :: PPM -> ReadOptions PPM -> ByteString -> Image S cs e

FileFormat (Sequence (Auto PPM))

Associated Types

type ReadOptions (Sequence (Auto PPM)) :: *

type WriteOptions (Sequence (Auto PPM)) :: *

Methods

ext :: Sequence (Auto PPM) -> String

exts :: Sequence (Auto PPM) -> [String]

isFormat :: String -> Sequence (Auto PPM) -> Bool

FileFormat (Sequence PPM)

Associated Types

type ReadOptions (Sequence PPM) :: *

type WriteOptions (Sequence PPM) :: *

Methods

ext :: Sequence PPM -> String

exts :: Sequence PPM -> [String]

isFormat :: String -> Sequence PPM -> Bool

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Auto PPM) (Image r cs e)

Methods

decode :: Auto PPM -> ReadOptions (Auto PPM) -> ByteString -> Image r cs e

(Mutable r Ix2 (Pixel cs e), ColorSpace cs e) => Readable (Sequence (Auto PPM)) (Array B Ix1 (Image r cs e))

Methods

decode :: Sequence (Auto PPM) -> ReadOptions (Sequence (Auto PPM)) -> ByteString -> Array B Ix1 (Image r cs e)

ColorSpace cs e => Readable (Sequence PPM) (Array B Ix1 (Image S cs e))

Methods

decode :: Sequence PPM -> ReadOptions (Sequence PPM) -> ByteString -> Array B Ix1 (Image S cs e)

type ReadOptions PPM

type ReadOptions PPM = ()

type WriteOptions PPM

type WriteOptions PPM = ()

type ReadOptions (Sequence (Auto PPM))

type ReadOptions (Sequence (Auto PPM)) = ()

type ReadOptions (Sequence PPM)

type ReadOptions (Sequence PPM) = ()

type WriteOptions (Sequence (Auto PPM))

type WriteOptions (Sequence (Auto PPM)) = WriteOptions PPM

type WriteOptions (Sequence PPM)

type WriteOptions (Sequence PPM) = WriteOptions PPM

Encoding and decoding of images is done using JuicyPixels and netpbm packages.

List of image formats that are currently supported, and their exact ColorSpaces and precision for reading and writing without an implicit conversion:

• BMP:

  • read: (Y Word8), (RGB Word8), (RGBA Word8)
  • write: (Y Word8), (RGB Word8), (RGBA Word8)

• GIF:

  • read: (RGB Word8), (RGBA Word8)
  • write: (RGB Word8)
  • Also supports reading and writing animated images, when used as GIFA

• HDR:

  • read: (RGB Float)
  • write: (RGB Float)

• JPG:

  • read: (Y Word8), (YA Word8), (RGB Word8), (CMYK Word8), (YCbCr, Word8)
  • write: (Y Word8), (YA, Word8), (RGB Word8), (CMYK Word8), (YCbCr, Word8)

• PNG:

  • read: (Y Word8), (Y Word16), (YA Word8), (YA Word16), (RGB Word8), (RGB Word16), (RGBA Word8), (RGBA Word16)
  • write: (Y Word8), (Y Word16), (YA Word8), (YA Word16), (RGB Word8), (RGB Word16), (RGBA Word8), (RGBA Word16)

• TGA:

  • read: (Y Word8), (RGB Word8), (RGBA Word8)
  • write: (Y Word8), (RGB Word8), (RGBA Word8)

• TIF:

  • read: (Y Word8), (Y Word16), (YA Word8), (YA Word16), (RGB Word8), (RGB Word16), (RGBA Word8), (RGBA Word16), (CMYK Word8), (CMYK Word16)
  • write: (Y Word8), (Y Word16), (YA Word8), (YA Word16), (RGB Word8), (RGB Word16), (RGBA Word8), (RGBA Word16) (CMYK Word8), (CMYK Word16), (YCbCr Word8)

• PBM:

  • read: (Binary Bit)
  • Also supports sequence of images in one file, when read as [PBM]

• PGM:

  • read: (Y Word8), (Y Word16)
  • Also supports sequence of images in one file, when read as [PGM]

• PPM:

  • read: (RGB Word8), (RGB Word16)
  • Also supports sequence of images in one file, when read as [PPM]