Safe Haskell	None
Language	Haskell2010

Graphics.Netpbm

Description

Parsing the netpbm image formates (PBM, PGM and PPM, both ASCII and binary) from ByteStrings.

All netpbm image formats are implemented (P1 - P6).

To parse one of these formats, use parsePPM.

Synopsis

Documentation

data PPMType Source #

The netpbm image type of an image.

Constructors

P1	ASCII bitmap
P2	ASCII greymap
P3	ASCII pixmap (color)
P4	binary bitmap
P5	binary greymap
P6	binary pixmap (color)

Instances

Enum PPMType Source #
Methods succ :: PPMType -> PPMType # pred :: PPMType -> PPMType # toEnum :: Int -> PPMType # fromEnum :: PPMType -> Int # enumFrom :: PPMType -> [PPMType] # enumFromThen :: PPMType -> PPMType -> [PPMType] # enumFromTo :: PPMType -> PPMType -> [PPMType] # enumFromThenTo :: PPMType -> PPMType -> PPMType -> [PPMType] #
Eq PPMType Source #
Methods (==) :: PPMType -> PPMType -> Bool # (/=) :: PPMType -> PPMType -> Bool #
Ord PPMType Source #
Methods compare :: PPMType -> PPMType -> Ordering # (<) :: PPMType -> PPMType -> Bool # (<=) :: PPMType -> PPMType -> Bool # (>) :: PPMType -> PPMType -> Bool # (>=) :: PPMType -> PPMType -> Bool # max :: PPMType -> PPMType -> PPMType # min :: PPMType -> PPMType -> PPMType #
Show PPMType Source #
Methods showsPrec :: Int -> PPMType -> ShowS # show :: PPMType -> String # showList :: [PPMType] -> ShowS #

data PPM Source #

A PPM file with type, dimensions, and image data.

Constructors

PPM
Fields ppmHeader :: PPMHeader ppmData :: PpmPixelData

Instances

Show PPM Source #
Methods showsPrec :: Int -> PPM -> ShowS # show :: PPM -> String # showList :: [PPM] -> ShowS #

data PpmPixelRGB8 Source #

A pixel containing three 8-bit color components, RGB.

Constructors

PpmPixelRGB8 !Word8 !Word8 !Word8

Instances

Eq PpmPixelRGB8 Source #
Methods (==) :: PpmPixelRGB8 -> PpmPixelRGB8 -> Bool # (/=) :: PpmPixelRGB8 -> PpmPixelRGB8 -> Bool #
Show PpmPixelRGB8 Source #
Methods showsPrec :: Int -> PpmPixelRGB8 -> ShowS # show :: PpmPixelRGB8 -> String # showList :: [PpmPixelRGB8] -> ShowS #
Storable PpmPixelRGB8 Source #
Methods sizeOf :: PpmPixelRGB8 -> Int # alignment :: PpmPixelRGB8 -> Int # peekElemOff :: Ptr PpmPixelRGB8 -> Int -> IO PpmPixelRGB8 # pokeElemOff :: Ptr PpmPixelRGB8 -> Int -> PpmPixelRGB8 -> IO () # peekByteOff :: Ptr b -> Int -> IO PpmPixelRGB8 # pokeByteOff :: Ptr b -> Int -> PpmPixelRGB8 -> IO () # peek :: Ptr PpmPixelRGB8 -> IO PpmPixelRGB8 # poke :: Ptr PpmPixelRGB8 -> PpmPixelRGB8 -> IO () #
Unbox PpmPixelRGB8 Source #

Vector Vector PpmPixelRGB8 Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) PpmPixelRGB8 -> m (Vector PpmPixelRGB8) # basicUnsafeThaw :: PrimMonad m => Vector PpmPixelRGB8 -> m (Mutable Vector (PrimState m) PpmPixelRGB8) # basicLength :: Vector PpmPixelRGB8 -> Int # basicUnsafeSlice :: Int -> Int -> Vector PpmPixelRGB8 -> Vector PpmPixelRGB8 # basicUnsafeIndexM :: Monad m => Vector PpmPixelRGB8 -> Int -> m PpmPixelRGB8 # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) PpmPixelRGB8 -> Vector PpmPixelRGB8 -> m () # elemseq :: Vector PpmPixelRGB8 -> PpmPixelRGB8 -> b -> b #
MVector MVector PpmPixelRGB8 Source #
Methods basicLength :: MVector s PpmPixelRGB8 -> Int # basicUnsafeSlice :: Int -> Int -> MVector s PpmPixelRGB8 -> MVector s PpmPixelRGB8 # basicOverlaps :: MVector s PpmPixelRGB8 -> MVector s PpmPixelRGB8 -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) PpmPixelRGB8) # basicInitialize :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> PpmPixelRGB8 -> m (MVector (PrimState m) PpmPixelRGB8) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> Int -> m PpmPixelRGB8 # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> Int -> PpmPixelRGB8 -> m () # basicClear :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> m () # basicSet :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> PpmPixelRGB8 -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> MVector (PrimState m) PpmPixelRGB8 -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> MVector (PrimState m) PpmPixelRGB8 -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) PpmPixelRGB8 -> Int -> m (MVector (PrimState m) PpmPixelRGB8) #
data Vector PpmPixelRGB8 Source #
data Vector PpmPixelRGB8 = V_PpmPixelRGB8 (Vector (Word8, Word8, Word8))
data MVector s PpmPixelRGB8 Source #
data MVector s PpmPixelRGB8 = MV_PpmPixelRGB8 (MVector s (Word8, Word8, Word8))

data PpmPixelRGB16 Source #

A pixel containing three 16-bit color components, RGB.

Constructors

PpmPixelRGB16 !Word16 !Word16 !Word16

Instances

Eq PpmPixelRGB16 Source #
Methods (==) :: PpmPixelRGB16 -> PpmPixelRGB16 -> Bool # (/=) :: PpmPixelRGB16 -> PpmPixelRGB16 -> Bool #
Show PpmPixelRGB16 Source #
Methods showsPrec :: Int -> PpmPixelRGB16 -> ShowS # show :: PpmPixelRGB16 -> String # showList :: [PpmPixelRGB16] -> ShowS #
Storable PpmPixelRGB16 Source #
Methods sizeOf :: PpmPixelRGB16 -> Int # alignment :: PpmPixelRGB16 -> Int # peekElemOff :: Ptr PpmPixelRGB16 -> Int -> IO PpmPixelRGB16 # pokeElemOff :: Ptr PpmPixelRGB16 -> Int -> PpmPixelRGB16 -> IO () # peekByteOff :: Ptr b -> Int -> IO PpmPixelRGB16 # pokeByteOff :: Ptr b -> Int -> PpmPixelRGB16 -> IO () # peek :: Ptr PpmPixelRGB16 -> IO PpmPixelRGB16 # poke :: Ptr PpmPixelRGB16 -> PpmPixelRGB16 -> IO () #
Unbox PpmPixelRGB16 Source #

Vector Vector PpmPixelRGB16 Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) PpmPixelRGB16 -> m (Vector PpmPixelRGB16) # basicUnsafeThaw :: PrimMonad m => Vector PpmPixelRGB16 -> m (Mutable Vector (PrimState m) PpmPixelRGB16) # basicLength :: Vector PpmPixelRGB16 -> Int # basicUnsafeSlice :: Int -> Int -> Vector PpmPixelRGB16 -> Vector PpmPixelRGB16 # basicUnsafeIndexM :: Monad m => Vector PpmPixelRGB16 -> Int -> m PpmPixelRGB16 # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) PpmPixelRGB16 -> Vector PpmPixelRGB16 -> m () # elemseq :: Vector PpmPixelRGB16 -> PpmPixelRGB16 -> b -> b #
MVector MVector PpmPixelRGB16 Source #
Methods basicLength :: MVector s PpmPixelRGB16 -> Int # basicUnsafeSlice :: Int -> Int -> MVector s PpmPixelRGB16 -> MVector s PpmPixelRGB16 # basicOverlaps :: MVector s PpmPixelRGB16 -> MVector s PpmPixelRGB16 -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) PpmPixelRGB16) # basicInitialize :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> PpmPixelRGB16 -> m (MVector (PrimState m) PpmPixelRGB16) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> Int -> m PpmPixelRGB16 # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> Int -> PpmPixelRGB16 -> m () # basicClear :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> m () # basicSet :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> PpmPixelRGB16 -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> MVector (PrimState m) PpmPixelRGB16 -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> MVector (PrimState m) PpmPixelRGB16 -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) PpmPixelRGB16 -> Int -> m (MVector (PrimState m) PpmPixelRGB16) #
data Vector PpmPixelRGB16 Source #
data Vector PpmPixelRGB16 = V_PpmPixelRGB16 (Vector (Word16, Word16, Word16))
data MVector s PpmPixelRGB16 Source #
data MVector s PpmPixelRGB16 = MV_PpmPixelRGB16 (MVector s (Word16, Word16, Word16))

newtype PbmPixel Source #

A pixel containing black or white.

Constructors

PbmPixel Bool

Instances

Eq PbmPixel Source #
Methods (==) :: PbmPixel -> PbmPixel -> Bool # (/=) :: PbmPixel -> PbmPixel -> Bool #
Show PbmPixel Source #
Methods showsPrec :: Int -> PbmPixel -> ShowS # show :: PbmPixel -> String # showList :: [PbmPixel] -> ShowS #
Storable PbmPixel Source #
Methods sizeOf :: PbmPixel -> Int # alignment :: PbmPixel -> Int # peekElemOff :: Ptr PbmPixel -> Int -> IO PbmPixel # pokeElemOff :: Ptr PbmPixel -> Int -> PbmPixel -> IO () # peekByteOff :: Ptr b -> Int -> IO PbmPixel # pokeByteOff :: Ptr b -> Int -> PbmPixel -> IO () # peek :: Ptr PbmPixel -> IO PbmPixel # poke :: Ptr PbmPixel -> PbmPixel -> IO () #
Unbox PbmPixel Source #

Vector Vector PbmPixel Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) PbmPixel -> m (Vector PbmPixel) # basicUnsafeThaw :: PrimMonad m => Vector PbmPixel -> m (Mutable Vector (PrimState m) PbmPixel) # basicLength :: Vector PbmPixel -> Int # basicUnsafeSlice :: Int -> Int -> Vector PbmPixel -> Vector PbmPixel # basicUnsafeIndexM :: Monad m => Vector PbmPixel -> Int -> m PbmPixel # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) PbmPixel -> Vector PbmPixel -> m () # elemseq :: Vector PbmPixel -> PbmPixel -> b -> b #
MVector MVector PbmPixel Source #
Methods basicLength :: MVector s PbmPixel -> Int # basicUnsafeSlice :: Int -> Int -> MVector s PbmPixel -> MVector s PbmPixel # basicOverlaps :: MVector s PbmPixel -> MVector s PbmPixel -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) PbmPixel) # basicInitialize :: PrimMonad m => MVector (PrimState m) PbmPixel -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> PbmPixel -> m (MVector (PrimState m) PbmPixel) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) PbmPixel -> Int -> m PbmPixel # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) PbmPixel -> Int -> PbmPixel -> m () # basicClear :: PrimMonad m => MVector (PrimState m) PbmPixel -> m () # basicSet :: PrimMonad m => MVector (PrimState m) PbmPixel -> PbmPixel -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) PbmPixel -> MVector (PrimState m) PbmPixel -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) PbmPixel -> MVector (PrimState m) PbmPixel -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) PbmPixel -> Int -> m (MVector (PrimState m) PbmPixel) #
data Vector PbmPixel Source #
data Vector PbmPixel = V_PbmPixel (Vector Bool)
data MVector s PbmPixel Source #
data MVector s PbmPixel = MV_PbmPixel (MVector s Bool)

data PgmPixel8 Source #

A pixel containing an 8-bit greyscale value.

Constructors

PgmPixel8 !Word8

Instances

Eq PgmPixel8 Source #
Methods (==) :: PgmPixel8 -> PgmPixel8 -> Bool # (/=) :: PgmPixel8 -> PgmPixel8 -> Bool #
Show PgmPixel8 Source #
Methods showsPrec :: Int -> PgmPixel8 -> ShowS # show :: PgmPixel8 -> String # showList :: [PgmPixel8] -> ShowS #
Storable PgmPixel8 Source #
Methods sizeOf :: PgmPixel8 -> Int # alignment :: PgmPixel8 -> Int # peekElemOff :: Ptr PgmPixel8 -> Int -> IO PgmPixel8 # pokeElemOff :: Ptr PgmPixel8 -> Int -> PgmPixel8 -> IO () # peekByteOff :: Ptr b -> Int -> IO PgmPixel8 # pokeByteOff :: Ptr b -> Int -> PgmPixel8 -> IO () # peek :: Ptr PgmPixel8 -> IO PgmPixel8 # poke :: Ptr PgmPixel8 -> PgmPixel8 -> IO () #
Unbox PgmPixel8 Source #

Vector Vector PgmPixel8 Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) PgmPixel8 -> m (Vector PgmPixel8) # basicUnsafeThaw :: PrimMonad m => Vector PgmPixel8 -> m (Mutable Vector (PrimState m) PgmPixel8) # basicLength :: Vector PgmPixel8 -> Int # basicUnsafeSlice :: Int -> Int -> Vector PgmPixel8 -> Vector PgmPixel8 # basicUnsafeIndexM :: Monad m => Vector PgmPixel8 -> Int -> m PgmPixel8 # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) PgmPixel8 -> Vector PgmPixel8 -> m () # elemseq :: Vector PgmPixel8 -> PgmPixel8 -> b -> b #
MVector MVector PgmPixel8 Source #
Methods basicLength :: MVector s PgmPixel8 -> Int # basicUnsafeSlice :: Int -> Int -> MVector s PgmPixel8 -> MVector s PgmPixel8 # basicOverlaps :: MVector s PgmPixel8 -> MVector s PgmPixel8 -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) PgmPixel8) # basicInitialize :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> PgmPixel8 -> m (MVector (PrimState m) PgmPixel8) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> Int -> m PgmPixel8 # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> Int -> PgmPixel8 -> m () # basicClear :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> m () # basicSet :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> PgmPixel8 -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> MVector (PrimState m) PgmPixel8 -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> MVector (PrimState m) PgmPixel8 -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) PgmPixel8 -> Int -> m (MVector (PrimState m) PgmPixel8) #
data Vector PgmPixel8 Source #
data Vector PgmPixel8 = V_PgmPixel8 (Vector Word8)
data MVector s PgmPixel8 Source #
data MVector s PgmPixel8 = MV_PgmPixel8 (MVector s Word8)

data PgmPixel16 Source #

A pixel containing a 16-bit greyscale value.

Constructors

PgmPixel16 !Word16

Instances

Eq PgmPixel16 Source #
Methods (==) :: PgmPixel16 -> PgmPixel16 -> Bool # (/=) :: PgmPixel16 -> PgmPixel16 -> Bool #
Show PgmPixel16 Source #
Methods showsPrec :: Int -> PgmPixel16 -> ShowS # show :: PgmPixel16 -> String # showList :: [PgmPixel16] -> ShowS #
Storable PgmPixel16 Source #
Methods sizeOf :: PgmPixel16 -> Int # alignment :: PgmPixel16 -> Int # peekElemOff :: Ptr PgmPixel16 -> Int -> IO PgmPixel16 # pokeElemOff :: Ptr PgmPixel16 -> Int -> PgmPixel16 -> IO () # peekByteOff :: Ptr b -> Int -> IO PgmPixel16 # pokeByteOff :: Ptr b -> Int -> PgmPixel16 -> IO () # peek :: Ptr PgmPixel16 -> IO PgmPixel16 # poke :: Ptr PgmPixel16 -> PgmPixel16 -> IO () #
Unbox PgmPixel16 Source #

Vector Vector PgmPixel16 Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) PgmPixel16 -> m (Vector PgmPixel16) # basicUnsafeThaw :: PrimMonad m => Vector PgmPixel16 -> m (Mutable Vector (PrimState m) PgmPixel16) # basicLength :: Vector PgmPixel16 -> Int # basicUnsafeSlice :: Int -> Int -> Vector PgmPixel16 -> Vector PgmPixel16 # basicUnsafeIndexM :: Monad m => Vector PgmPixel16 -> Int -> m PgmPixel16 # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) PgmPixel16 -> Vector PgmPixel16 -> m () # elemseq :: Vector PgmPixel16 -> PgmPixel16 -> b -> b #
MVector MVector PgmPixel16 Source #
Methods basicLength :: MVector s PgmPixel16 -> Int # basicUnsafeSlice :: Int -> Int -> MVector s PgmPixel16 -> MVector s PgmPixel16 # basicOverlaps :: MVector s PgmPixel16 -> MVector s PgmPixel16 -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) PgmPixel16) # basicInitialize :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> PgmPixel16 -> m (MVector (PrimState m) PgmPixel16) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> Int -> m PgmPixel16 # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> Int -> PgmPixel16 -> m () # basicClear :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> m () # basicSet :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> PgmPixel16 -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> MVector (PrimState m) PgmPixel16 -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> MVector (PrimState m) PgmPixel16 -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) PgmPixel16 -> Int -> m (MVector (PrimState m) PgmPixel16) #
data Vector PgmPixel16 Source #
data Vector PgmPixel16 = V_PgmPixel16 (Vector Word16)
data MVector s PgmPixel16 Source #
data MVector s PgmPixel16 = MV_PgmPixel16 (MVector s Word16)

data PPMHeader Source #

Meta information about the image: The exact PPM format and dimensions.

Constructors

PPMHeader
Fields ppmType :: !PPMType ppmWidth :: !Int ppmHeight :: !Int

Instances

Eq PPMHeader Source #
Methods (==) :: PPMHeader -> PPMHeader -> Bool # (/=) :: PPMHeader -> PPMHeader -> Bool #
Show PPMHeader Source #
Methods showsPrec :: Int -> PPMHeader -> ShowS # show :: PPMHeader -> String # showList :: [PPMHeader] -> ShowS #

data PpmPixelData Source #

Image data, either 8 or 16 bits. TODO rename to PNM

Constructors

PpmPixelDataRGB8 (Vector PpmPixelRGB8)	For 8-bit PPMs.
PpmPixelDataRGB16 (Vector PpmPixelRGB16)	For 16-bit PPMs.
PbmPixelData (Vector PbmPixel)	For 1-bit PBMs.
PgmPixelData8 (Vector PgmPixel8)	For 8-bit PGMs.
PgmPixelData16 (Vector PgmPixel16)	For 16-bit PGMs.

pixelVectorToList :: Storable a => Vector a -> [a] Source #

Converts a vector of pixels to a list for convenience.

pixelDataToIntList :: PpmPixelData -> [Int] Source #

Converts pixel data to a list of positive Ints.

How big they can become depends on the bit depth of the pixel data.

parsePPM :: ByteString -> PpmParseResult Source #

Parses a PPM file from the given ByteString. On failure, Left error contains the error message. On success, Right (images, Maybe rest) contains the parsed images and potentially an unparsable rest input.

type PpmParseResult = Either String ([PPM], Maybe ByteString) Source #

The result of a PPM parse.

See parsePPM.