Safe Haskell	None

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
Eq PPMType
Ord PPMType
Show PPMType

data PPM Source

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

Constructors

PPM
Fields ppmHeader :: PPMHeader ppmData :: PpmPixelData

Instances

Show PPM

data PpmPixelRGB8 Source

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

Constructors

PpmPixelRGB8 !Word8 !Word8 !Word8

Instances

Eq PpmPixelRGB8
Show PpmPixelRGB8
Storable PpmPixelRGB8
Unbox PpmPixelRGB8
Vector Vector PpmPixelRGB8
MVector MVector PpmPixelRGB8

data PpmPixelRGB16 Source

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

Constructors

PpmPixelRGB16 !Word16 !Word16 !Word16

Instances

Eq PpmPixelRGB16
Show PpmPixelRGB16
Storable PpmPixelRGB16
Unbox PpmPixelRGB16
Vector Vector PpmPixelRGB16
MVector MVector PpmPixelRGB16

newtype PbmPixel Source

A pixel containing black or white.

Constructors

PbmPixel Bool

Instances

Eq PbmPixel
Show PbmPixel
Storable PbmPixel
Unbox PbmPixel
Vector Vector PbmPixel
MVector MVector PbmPixel

data PgmPixel8 Source

A pixel containing an 8-bit greyscale value.

Constructors

PgmPixel8 !Word8

Instances

Eq PgmPixel8
Show PgmPixel8
Storable PgmPixel8
Unbox PgmPixel8
Vector Vector PgmPixel8
MVector MVector PgmPixel8

data PgmPixel16 Source

A pixel containing a 16-bit greyscale value.

Constructors

PgmPixel16 !Word16

Instances

Eq PgmPixel16
Show PgmPixel16
Storable PgmPixel16
Unbox PgmPixel16
Vector Vector PgmPixel16
MVector MVector PgmPixel16

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
Show PPMHeader

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.