Copyright	(c) Alexis Williams 2016
License	BSD3
Maintainer	sasinestro@gmail.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Data.STBImage

Description

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.

Synopsis

class Storable a => Color a where
- data ColorFlag a :: *
- loadImage :: ColorFlag a -> FilePath -> IO (Either String (Image a))
- writePNG :: FilePath -> Image a -> IO ()
- writeBMP :: FilePath -> Image a -> IO ()
- writeTGA :: FilePath -> Image a -> IO ()
- red :: a -> Word8
- green :: a -> Word8
- blue :: a -> Word8
- alpha :: a -> Word8
data YColor = YColor {
- _yGreyscale :: Word8
}
data YAColor = YAColor {
- _yaGreyscale :: Word8
- _yaAlpha :: Word8
}
data RGBColor = RGBColor {
- _rgbRed :: Word8
- _rgbGreen :: Word8
- _rgbBlue :: Word8
}
data RGBAColor = RGBAColor {
- _rgbaRed :: Word8
- _rgbaGreen :: Word8
- _rgbaBlue :: Word8
- _rgbaAlpha :: Word8
}
data Image a = Image {
- _pixels :: Vector a
- _width :: Int
- _height :: Int
}
flipImage :: Storable a => Image a -> Image a

Documentation

class Storable a => Color a where #

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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBAColor :: Type # 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBColor :: Type # 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YAColor :: Type # 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YColor :: Type # 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 #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: YColor -> YColor -> Bool # (/=) :: YColor -> YColor -> Bool #
Generic YColor #
Instance details Defined in Data.STBImage.ColorTypes Associated Types type Rep YColor :: Type -> Type # Methods from :: YColor -> Rep YColor x # to :: Rep YColor x -> YColor #
Storable YColor #
Instance details Defined in Data.STBImage.ColorTypes 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YColor :: Type # 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) #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag YColor -> ShowS # show :: ColorFlag YColor -> String # showList :: [ColorFlag YColor] -> ShowS #
type Rep YColor #
Instance details Defined in Data.STBImage.ColorTypes type Rep YColor = D1 (MetaData "YColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.2-E7S9cUsCYO6HDGz9siXvk8" False) (C1 (MetaCons "YColor" PrefixI True) (S1 (MetaSel (Just "_yGreyscale") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8)))
data ColorFlag YColor #
Instance details Defined in Data.STBImage.Color data ColorFlag YColor = Y

data YAColor #

Constructors

YAColor
Fields _yaGreyscale :: Word8 _yaAlpha :: Word8

Instances

Eq YAColor #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: YAColor -> YAColor -> Bool # (/=) :: YAColor -> YAColor -> Bool #
Generic YAColor #
Instance details Defined in Data.STBImage.ColorTypes Associated Types type Rep YAColor :: Type -> Type # Methods from :: YAColor -> Rep YAColor x # to :: Rep YAColor x -> YAColor #
Storable YAColor #
Instance details Defined in Data.STBImage.ColorTypes 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YAColor :: Type # 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) #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag YAColor -> ShowS # show :: ColorFlag YAColor -> String # showList :: [ColorFlag YAColor] -> ShowS #
type Rep YAColor #
Instance details Defined in Data.STBImage.ColorTypes type Rep YAColor = D1 (MetaData "YAColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.2-E7S9cUsCYO6HDGz9siXvk8" False) (C1 (MetaCons "YAColor" PrefixI True) (S1 (MetaSel (Just "_yaGreyscale") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8) :*: S1 (MetaSel (Just "_yaAlpha") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8)))
data ColorFlag YAColor #
Instance details Defined in Data.STBImage.Color data ColorFlag YAColor = YA

data RGBColor #

Constructors

RGBColor
Fields _rgbRed :: Word8 _rgbGreen :: Word8 _rgbBlue :: Word8

Instances

Eq RGBColor #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: RGBColor -> RGBColor -> Bool # (/=) :: RGBColor -> RGBColor -> Bool #
Generic RGBColor #
Instance details Defined in Data.STBImage.ColorTypes Associated Types type Rep RGBColor :: Type -> Type # Methods from :: RGBColor -> Rep RGBColor x # to :: Rep RGBColor x -> RGBColor #
Storable RGBColor #
Instance details Defined in Data.STBImage.ColorTypes 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBColor :: Type # 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) #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag RGBColor -> ShowS # show :: ColorFlag RGBColor -> String # showList :: [ColorFlag RGBColor] -> ShowS #
type Rep RGBColor #
Instance details Defined in Data.STBImage.ColorTypes type Rep RGBColor = D1 (MetaData "RGBColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.2-E7S9cUsCYO6HDGz9siXvk8" False) (C1 (MetaCons "RGBColor" PrefixI True) (S1 (MetaSel (Just "_rgbRed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8) :: (S1 (MetaSel (Just "_rgbGreen") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8) :: S1 (MetaSel (Just "_rgbBlue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8))))
data ColorFlag RGBColor #
Instance details Defined in Data.STBImage.Color data ColorFlag RGBColor = RGB

data RGBAColor #

Constructors

RGBAColor
Fields _rgbaRed :: Word8 _rgbaGreen :: Word8 _rgbaBlue :: Word8 _rgbaAlpha :: Word8

Instances

Eq RGBAColor #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: RGBAColor -> RGBAColor -> Bool # (/=) :: RGBAColor -> RGBAColor -> Bool #
Generic RGBAColor #
Instance details Defined in Data.STBImage.ColorTypes Associated Types type Rep RGBAColor :: Type -> Type # Methods from :: RGBAColor -> Rep RGBAColor x # to :: Rep RGBAColor x -> RGBAColor #
Storable RGBAColor #
Instance details Defined in Data.STBImage.ColorTypes 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 #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBAColor :: Type # 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) #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag RGBAColor -> ShowS # show :: ColorFlag RGBAColor -> String # showList :: [ColorFlag RGBAColor] -> ShowS #
type Rep RGBAColor #
Instance details Defined in Data.STBImage.ColorTypes type Rep RGBAColor = D1 (MetaData "RGBAColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.2-E7S9cUsCYO6HDGz9siXvk8" False) (C1 (MetaCons "RGBAColor" PrefixI True) ((S1 (MetaSel (Just "_rgbaRed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8) :: S1 (MetaSel (Just "_rgbaGreen") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8)) :: (S1 (MetaSel (Just "_rgbaBlue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8) :*: S1 (MetaSel (Just "_rgbaAlpha") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word8))))
data ColorFlag RGBAColor #
Instance details Defined in Data.STBImage.Color 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

(Storable a, Eq a) => Eq (Image a) #
Instance details Defined in Data.STBImage.Immutable Methods (==) :: Image a -> Image a -> Bool # (/=) :: Image a -> Image a -> Bool #
Show (Image a) #
Instance details Defined in Data.STBImage.Immutable Methods showsPrec :: Int -> Image a -> ShowS # show :: Image a -> String # showList :: [Image a] -> ShowS #
Generic (Image a) #
Instance details Defined in Data.STBImage.Immutable Associated Types type Rep (Image a) :: Type -> Type # Methods from :: Image a -> Rep (Image a) x # to :: Rep (Image a) x -> Image a #
type Rep (Image a) #
Instance details Defined in Data.STBImage.Immutable type Rep (Image a) = D1 (MetaData "Image" "Data.STBImage.Immutable" "stb-image-redux-0.2.1.2-E7S9cUsCYO6HDGz9siXvk8" False) (C1 (MetaCons "Image" PrefixI True) (S1 (MetaSel (Just "_pixels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector a)) :: (S1 (MetaSel (Just "_width") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "_height") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))

flipImage :: Storable a => Image a -> Image a #

Utility function to flip images, e.g. for use with OpenGL