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.

Documentation

class Color a where

Minimal complete definition

loadImage, writePNG, writeBMP, writeTGA, red, green, blue, alpha

Associated Types

data ColorFlag a :: *

Methods

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

loadImage reads the image (with ColorFlag Y, YA, RGB, or RGBA) at the supplied path.

writePNG :: FilePath -> Image a -> 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 a -> 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 a -> IO ()

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

red :: a -> Word8

green :: a -> Word8

blue :: a -> Word8

alpha :: a -> Word8

Instances

Color RGBAColor

Associated Types

data ColorFlag RGBAColor :: *

Methods

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

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

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

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

red :: RGBAColor -> Word8

green :: RGBAColor -> Word8

blue :: RGBAColor -> Word8

alpha :: RGBAColor -> Word8

Color RGBColor

Associated Types

data ColorFlag RGBColor :: *

Methods

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

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

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

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

red :: RGBColor -> Word8

green :: RGBColor -> Word8

blue :: RGBColor -> Word8

alpha :: RGBColor -> Word8

Color YAColor

Associated Types

data ColorFlag YAColor :: *

Methods

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

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

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

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

red :: YAColor -> Word8

green :: YAColor -> Word8

blue :: YAColor -> Word8

alpha :: YAColor -> Word8

Color YColor

Associated Types

data ColorFlag YColor :: *

Methods

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

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

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

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

red :: YColor -> Word8

green :: YColor -> Word8

blue :: YColor -> Word8

alpha :: YColor -> Word8

data YColor

Constructors

YColor

Fields

• _yGreyscale :: Word8

Instances

Eq YColor

Methods

(==) :: YColor -> YColor -> Bool

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

Storable YColor

Methods

sizeOf :: YColor -> Int

alignment :: YColor -> Int

peekElemOff :: Ptr YColor -> Int -> IO YColor

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

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

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

peek :: Ptr YColor -> IO YColor

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

Color YColor

Associated Types

data ColorFlag YColor :: *

Methods

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

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

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

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

red :: YColor -> Word8

green :: YColor -> Word8

blue :: YColor -> Word8

alpha :: YColor -> Word8

Show (ColorFlag YColor)

Methods

showsPrec :: Int -> ColorFlag YColor -> ShowS

show :: ColorFlag YColor -> String

showList :: [ColorFlag YColor] -> ShowS

data ColorFlag YColor

data ColorFlag YColor = Y

data YAColor

Constructors

YAColor

Fields

• _yaGreyscale :: Word8
• _yaAlpha :: Word8

Instances

Eq YAColor

Methods

(==) :: YAColor -> YAColor -> Bool

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

Storable YAColor

Methods

sizeOf :: YAColor -> Int

alignment :: YAColor -> Int

peekElemOff :: Ptr YAColor -> Int -> IO YAColor

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

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

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

peek :: Ptr YAColor -> IO YAColor

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

Color YAColor

Associated Types

data ColorFlag YAColor :: *

Methods

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

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

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

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

red :: YAColor -> Word8

green :: YAColor -> Word8

blue :: YAColor -> Word8

alpha :: YAColor -> Word8

Show (ColorFlag YAColor)

Methods

showsPrec :: Int -> ColorFlag YAColor -> ShowS

show :: ColorFlag YAColor -> String

showList :: [ColorFlag YAColor] -> ShowS

data ColorFlag YAColor

data ColorFlag YAColor = YA

data RGBColor

Constructors

RGBColor

Fields

• _rgbRed :: Word8
• _rgbGreen :: Word8
• _rgbBlue :: Word8

Instances

Eq RGBColor

Methods

(==) :: RGBColor -> RGBColor -> Bool

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

Storable RGBColor

Methods

sizeOf :: RGBColor -> Int

alignment :: RGBColor -> Int

peekElemOff :: Ptr RGBColor -> Int -> IO RGBColor

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

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

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

peek :: Ptr RGBColor -> IO RGBColor

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

Color RGBColor

Associated Types

data ColorFlag RGBColor :: *

Methods

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

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

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

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

red :: RGBColor -> Word8

green :: RGBColor -> Word8

blue :: RGBColor -> Word8

alpha :: RGBColor -> Word8

Show (ColorFlag RGBColor)

Methods

showsPrec :: Int -> ColorFlag RGBColor -> ShowS

show :: ColorFlag RGBColor -> String

showList :: [ColorFlag RGBColor] -> ShowS

data ColorFlag RGBColor

data ColorFlag RGBColor = RGB

data RGBAColor

Constructors

RGBAColor

Fields

• _rgbaRed :: Word8
• _rgbaGreen :: Word8
• _rgbaBlue :: Word8
• _rgbaAlpha :: Word8

Instances

Eq RGBAColor

Methods

(==) :: RGBAColor -> RGBAColor -> Bool

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

Storable RGBAColor

Methods

sizeOf :: RGBAColor -> Int

alignment :: RGBAColor -> Int

peekElemOff :: Ptr RGBAColor -> Int -> IO RGBAColor

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

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

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

peek :: Ptr RGBAColor -> IO RGBAColor

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

Color RGBAColor

Associated Types

data ColorFlag RGBAColor :: *

Methods

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

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

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

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

red :: RGBAColor -> Word8

green :: RGBAColor -> Word8

blue :: RGBAColor -> Word8

alpha :: RGBAColor -> Word8

Show (ColorFlag RGBAColor)

Methods

showsPrec :: Int -> ColorFlag RGBAColor -> ShowS

show :: ColorFlag RGBAColor -> String

showList :: [ColorFlag RGBAColor] -> ShowS

data ColorFlag RGBAColor

data ColorFlag RGBAColor = RGBA

data Image a

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 a
• _width :: Int
• _height :: Int

Instances

(Eq a, Storable a) => Eq (Image a)

Methods

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

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

Show (Image a)

Methods

showsPrec :: Int -> Image a -> ShowS

show :: Image a -> String

showList :: [Image a] -> ShowS