Data.STBImage

Much like the original library, the focus of this library is placed on ease of use rather than richness of feature set, thus the rather spartan interface.

Data types

data Color

The Color type is used to represented the colors that are read out of the image file.

Currently, all images will be read out as RGBA, which is rather storage inefficient, but it's what I need for my application right now and a tagging scheme (to allow a Storable instance for the multiple-form datatype) would be a significant penalty to speed and reduce the space win significantly, and actively penalize the most common case for me.

Constructors

RGBA

Fields

• _red :: Word8
• _green :: Word8
• _blue :: Word8
• _alpha :: Word8

Instances

Eq Color

Methods

(==) :: Color -> Color -> Bool

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

Show Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Storable Color

Methods

sizeOf :: Color -> Int

alignment :: Color -> Int

peekElemOff :: Ptr Color -> Int -> IO Color

pokeElemOff :: Ptr Color -> Int -> Color -> IO ()

peekByteOff :: Ptr b -> Int -> IO Color

pokeByteOff :: Ptr b -> Int -> Color -> IO ()

peek :: Ptr Color -> IO Color

poke :: Ptr Color -> Color -> IO ()

data Image

Image is the least opinionated reasonable type to represent an image, just a vector of pixel Colors (laid out top-to-bottom, left-to-right) and a size.

Constructors

Image

Fields

• _pixels :: Vector Color
• _width :: Int
• _height :: Int

Instances

Eq Image

Methods

(==) :: Image -> Image -> Bool

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

Show Image

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

Loading images

loadImage :: FilePath -> IO (Either String Image)

loadImage loads the image file at path and returns either an error message from the underlying library or the Image that is stored in the file.

Writing images

writePNG :: FilePath -> Image -> IO ()

writePNG writes the image passed to it out at the path path in PNG format. The path must include the extension.

writeBMP :: FilePath -> Image -> IO ()

writeBMP writes the image passed to it out at the path path in BMP format. The path must include the extension.

writeTGA :: FilePath -> Image -> IO ()

writeTGA writes the image passed to it out at the path path in TGA format. The path must include the extension.