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

Data.STBImage

Contents

The Color Typeclass
Images and their utilities
Individual color types

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
showColor :: Color a => a -> String
data Image a = Image {
- _pixels :: Vector a
- _width :: Int
- _height :: Int
}
flipImage :: Storable a => Image a -> Image a
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
}

The `Color` Typeclass

class Storable a => Color a where Source #

Associated Types

data ColorFlag a :: * Source #

Methods

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

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

writePNG :: FilePath -> Image a -> IO () Source #

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 () Source #

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 () Source #

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

red :: a -> Word8 Source #

green :: a -> Word8 Source #

blue :: a -> Word8 Source #

alpha :: a -> Word8 Source #

Instances

Instances details

Color RGBAColor Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBAColor Source # Methods loadImage :: ColorFlag RGBAColor -> FilePath -> IO (Either String (Image RGBAColor)) Source # writePNG :: FilePath -> Image RGBAColor -> IO () Source # writeBMP :: FilePath -> Image RGBAColor -> IO () Source # writeTGA :: FilePath -> Image RGBAColor -> IO () Source # red :: RGBAColor -> Word8 Source # green :: RGBAColor -> Word8 Source # blue :: RGBAColor -> Word8 Source # alpha :: RGBAColor -> Word8 Source #
Color RGBColor Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBColor Source # Methods loadImage :: ColorFlag RGBColor -> FilePath -> IO (Either String (Image RGBColor)) Source # writePNG :: FilePath -> Image RGBColor -> IO () Source # writeBMP :: FilePath -> Image RGBColor -> IO () Source # writeTGA :: FilePath -> Image RGBColor -> IO () Source # red :: RGBColor -> Word8 Source # green :: RGBColor -> Word8 Source # blue :: RGBColor -> Word8 Source # alpha :: RGBColor -> Word8 Source #
Color YAColor Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YAColor Source # Methods loadImage :: ColorFlag YAColor -> FilePath -> IO (Either String (Image YAColor)) Source # writePNG :: FilePath -> Image YAColor -> IO () Source # writeBMP :: FilePath -> Image YAColor -> IO () Source # writeTGA :: FilePath -> Image YAColor -> IO () Source # red :: YAColor -> Word8 Source # green :: YAColor -> Word8 Source # blue :: YAColor -> Word8 Source # alpha :: YAColor -> Word8 Source #
Color YColor Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YColor Source # Methods loadImage :: ColorFlag YColor -> FilePath -> IO (Either String (Image YColor)) Source # writePNG :: FilePath -> Image YColor -> IO () Source # writeBMP :: FilePath -> Image YColor -> IO () Source # writeTGA :: FilePath -> Image YColor -> IO () Source # red :: YColor -> Word8 Source # green :: YColor -> Word8 Source # blue :: YColor -> Word8 Source # alpha :: YColor -> Word8 Source #

showColor :: Color a => a -> String Source #

showColor is a default implementation of Show for any instance of the Color typeclass.

`Image`s and their utilities

data Image a Source #

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

Instances details

(Storable a, Eq a) => Eq (Image a) Source #
Instance details Defined in Data.STBImage.Immutable Methods (==) :: Image a -> Image a -> Bool # (/=) :: Image a -> Image a -> Bool #
Show (Image a) Source #
Instance details Defined in Data.STBImage.Immutable Methods showsPrec :: Int -> Image a -> ShowS # show :: Image a -> String # showList :: [Image a] -> ShowS #
Generic (Image a) Source #
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) Source #
Instance details Defined in Data.STBImage.Immutable type Rep (Image a) = D1 ('MetaData "Image" "Data.STBImage.Immutable" "stb-image-redux-0.2.1.3-inplace" '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 Source #

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

Individual color types

data YColor Source #

Constructors

YColor
Fields _yGreyscale :: Word8

Instances

Instances details

Eq YColor Source #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: YColor -> YColor -> Bool # (/=) :: YColor -> YColor -> Bool #
Show YColor Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> YColor -> ShowS # show :: YColor -> String # showList :: [YColor] -> ShowS #
Generic YColor Source #
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 Source #
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 Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YColor Source # Methods loadImage :: ColorFlag YColor -> FilePath -> IO (Either String (Image YColor)) Source # writePNG :: FilePath -> Image YColor -> IO () Source # writeBMP :: FilePath -> Image YColor -> IO () Source # writeTGA :: FilePath -> Image YColor -> IO () Source # red :: YColor -> Word8 Source # green :: YColor -> Word8 Source # blue :: YColor -> Word8 Source # alpha :: YColor -> Word8 Source #
Show (ColorFlag YColor) Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag YColor -> ShowS # show :: ColorFlag YColor -> String # showList :: [ColorFlag YColor] -> ShowS #
type Rep YColor Source #
Instance details Defined in Data.STBImage.ColorTypes type Rep YColor = D1 ('MetaData "YColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.3-inplace" 'False) (C1 ('MetaCons "YColor" 'PrefixI 'True) (S1 ('MetaSel ('Just "_yGreyscale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))
data ColorFlag YColor Source #
Instance details Defined in Data.STBImage.Color data ColorFlag YColor = Y

data YAColor Source #

Constructors

YAColor
Fields _yaGreyscale :: Word8 _yaAlpha :: Word8

Instances

Instances details

Eq YAColor Source #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: YAColor -> YAColor -> Bool # (/=) :: YAColor -> YAColor -> Bool #
Show YAColor Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> YAColor -> ShowS # show :: YAColor -> String # showList :: [YAColor] -> ShowS #
Generic YAColor Source #
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 Source #
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 Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag YAColor Source # Methods loadImage :: ColorFlag YAColor -> FilePath -> IO (Either String (Image YAColor)) Source # writePNG :: FilePath -> Image YAColor -> IO () Source # writeBMP :: FilePath -> Image YAColor -> IO () Source # writeTGA :: FilePath -> Image YAColor -> IO () Source # red :: YAColor -> Word8 Source # green :: YAColor -> Word8 Source # blue :: YAColor -> Word8 Source # alpha :: YAColor -> Word8 Source #
Show (ColorFlag YAColor) Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag YAColor -> ShowS # show :: ColorFlag YAColor -> String # showList :: [ColorFlag YAColor] -> ShowS #
type Rep YAColor Source #
Instance details Defined in Data.STBImage.ColorTypes type Rep YAColor = D1 ('MetaData "YAColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.3-inplace" '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 Source #
Instance details Defined in Data.STBImage.Color data ColorFlag YAColor = YA

data RGBColor Source #

Constructors

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

Instances

Instances details

Eq RGBColor Source #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: RGBColor -> RGBColor -> Bool # (/=) :: RGBColor -> RGBColor -> Bool #
Show RGBColor Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> RGBColor -> ShowS # show :: RGBColor -> String # showList :: [RGBColor] -> ShowS #
Generic RGBColor Source #
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 Source #
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 Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBColor Source # Methods loadImage :: ColorFlag RGBColor -> FilePath -> IO (Either String (Image RGBColor)) Source # writePNG :: FilePath -> Image RGBColor -> IO () Source # writeBMP :: FilePath -> Image RGBColor -> IO () Source # writeTGA :: FilePath -> Image RGBColor -> IO () Source # red :: RGBColor -> Word8 Source # green :: RGBColor -> Word8 Source # blue :: RGBColor -> Word8 Source # alpha :: RGBColor -> Word8 Source #
Show (ColorFlag RGBColor) Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag RGBColor -> ShowS # show :: ColorFlag RGBColor -> String # showList :: [ColorFlag RGBColor] -> ShowS #
type Rep RGBColor Source #
Instance details Defined in Data.STBImage.ColorTypes type Rep RGBColor = D1 ('MetaData "RGBColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.3-inplace" '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 Source #
Instance details Defined in Data.STBImage.Color data ColorFlag RGBColor = RGB

data RGBAColor Source #

Constructors

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

Instances

Instances details

Eq RGBAColor Source #
Instance details Defined in Data.STBImage.ColorTypes Methods (==) :: RGBAColor -> RGBAColor -> Bool # (/=) :: RGBAColor -> RGBAColor -> Bool #
Show RGBAColor Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> RGBAColor -> ShowS # show :: RGBAColor -> String # showList :: [RGBAColor] -> ShowS #
Generic RGBAColor Source #
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 Source #
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 Source #
Instance details Defined in Data.STBImage.Color Associated Types data ColorFlag RGBAColor Source # Methods loadImage :: ColorFlag RGBAColor -> FilePath -> IO (Either String (Image RGBAColor)) Source # writePNG :: FilePath -> Image RGBAColor -> IO () Source # writeBMP :: FilePath -> Image RGBAColor -> IO () Source # writeTGA :: FilePath -> Image RGBAColor -> IO () Source # red :: RGBAColor -> Word8 Source # green :: RGBAColor -> Word8 Source # blue :: RGBAColor -> Word8 Source # alpha :: RGBAColor -> Word8 Source #
Show (ColorFlag RGBAColor) Source #
Instance details Defined in Data.STBImage.Color Methods showsPrec :: Int -> ColorFlag RGBAColor -> ShowS # show :: ColorFlag RGBAColor -> String # showList :: [ColorFlag RGBAColor] -> ShowS #
type Rep RGBAColor Source #
Instance details Defined in Data.STBImage.ColorTypes type Rep RGBAColor = D1 ('MetaData "RGBAColor" "Data.STBImage.ColorTypes" "stb-image-redux-0.2.1.3-inplace" '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 Source #
Instance details Defined in Data.STBImage.Color data ColorFlag RGBAColor = RGBA

The Color Typeclass

Instances

Images and their utilities

Instances

Individual color types

Instances

Instances

Instances

Instances

The `Color` Typeclass

`Image`s and their utilities