Safe Haskell	None
Language	Haskell2010

Codec.Ktx

Contents

Header
Key-value data
Images

Synopsis

fromByteString :: ByteString -> Either (ByteOffset, String) Ktx
fromFile :: FilePath -> IO (Either (ByteOffset, String) Ktx)
data Ktx = Ktx {
- header :: Header
- kvs :: KeyValueData
- images :: MipLevels
}
data Header = Header {
- identifier :: ByteString
- endianness :: Word32
- glType :: Word32
- glTypeSize :: Word32
- glFormat :: Word32
- glInternalFormat :: Word32
- glBaseInternalFormat :: Word32
- pixelWidth :: Word32
- pixelHeight :: Word32
- pixelDepth :: Word32
- numberOfArrayElements :: Word32
- numberOfFaces :: Word32
- numberOfMipmapLevels :: Word32
- bytesOfKeyValueData :: Word32
}
endiannessLE :: Word32
canonicalIdentifier :: ByteString
type KeyValueData = Map Key Value
newtype Key = Key Text
newtype Value = Value ByteString
getKeyValueData :: Header -> Get KeyValueData
putKeyValueData :: Map Key Value -> Put
type MipLevels = Vector MipLevel
data MipLevel = MipLevel {
- imageSize :: Word32
- arrayElements :: Vector ArrayElement
}
newtype ArrayElement = ArrayElement {
- faces :: Vector Face
}
newtype Face = Face {
- zSlices :: Vector ZSlice
}
newtype ZSlice = ZSlice {
- block :: ByteString
}
getImages :: Header -> Get MipLevels
putImages :: MipLevels -> Put

Documentation

fromByteString :: ByteString -> Either (ByteOffset, String) Ktx Source #

fromFile :: FilePath -> IO (Either (ByteOffset, String) Ktx) Source #

data Ktx Source #

Constructors

Ktx
Fields header :: Header kvs :: KeyValueData images :: MipLevels

Instances

Instances details

Show Ktx Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> Ktx -> ShowS # show :: Ktx -> String # showList :: [Ktx] -> ShowS #
Generic Ktx Source #
Instance details Defined in Codec.Ktx Associated Types type Rep Ktx :: Type -> Type # Methods from :: Ktx -> Rep Ktx x # to :: Rep Ktx x -> Ktx #
Binary Ktx Source #
Instance details Defined in Codec.Ktx Methods put :: Ktx -> Put # get :: Get Ktx # putList :: [Ktx] -> Put #
type Rep Ktx Source #
Instance details Defined in Codec.Ktx type Rep Ktx = D1 ('MetaData "Ktx" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'False) (C1 ('MetaCons "Ktx" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Header) :: (S1 ('MetaSel ('Just "kvs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyValueData) :: S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MipLevels))))

Header

data Header Source #

Constructors

Header
Fields identifier :: ByteString endianness :: Word32 glType :: Word32 glTypeSize :: Word32 glFormat :: Word32 glInternalFormat :: Word32 glBaseInternalFormat :: Word32 pixelWidth :: Word32 pixelHeight :: Word32 pixelDepth :: Word32 numberOfArrayElements :: Word32 numberOfFaces :: Word32 numberOfMipmapLevels :: Word32 bytesOfKeyValueData :: Word32

Instances

endiannessLE :: Word32 Source #

canonicalIdentifier :: ByteString Source #

Key-value data

type KeyValueData = Map Key Value Source #

newtype Key Source #

Constructors

Key Text

Instances

Instances details

Eq Key Source #
Instance details Defined in Codec.Ktx Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Instance details Defined in Codec.Ktx Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
Show Key Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
Generic Key Source #
Instance details Defined in Codec.Ktx Associated Types type Rep Key :: Type -> Type # Methods from :: Key -> Rep Key x # to :: Rep Key x -> Key #
type Rep Key Source #
Instance details Defined in Codec.Ktx type Rep Key = D1 ('MetaData "Key" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'True) (C1 ('MetaCons "Key" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype Value Source #

Constructors

Value ByteString

Instances

Instances details

Show Value Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Generic Value Source #
Instance details Defined in Codec.Ktx Associated Types type Rep Value :: Type -> Type # Methods from :: Value -> Rep Value x # to :: Rep Value x -> Value #
type Rep Value Source #
Instance details Defined in Codec.Ktx type Rep Value = D1 ('MetaData "Value" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'True) (C1 ('MetaCons "Value" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

getKeyValueData :: Header -> Get KeyValueData Source #

putKeyValueData :: Map Key Value -> Put Source #

Images

type MipLevels = Vector MipLevel Source #

data MipLevel Source #

Constructors

MipLevel
Fields imageSize :: Word32 arrayElements :: Vector ArrayElement

Instances

Instances details

Show MipLevel Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> MipLevel -> ShowS # show :: MipLevel -> String # showList :: [MipLevel] -> ShowS #
Generic MipLevel Source #
Instance details Defined in Codec.Ktx Associated Types type Rep MipLevel :: Type -> Type # Methods from :: MipLevel -> Rep MipLevel x # to :: Rep MipLevel x -> MipLevel #
type Rep MipLevel Source #
Instance details Defined in Codec.Ktx type Rep MipLevel = D1 ('MetaData "MipLevel" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'False) (C1 ('MetaCons "MipLevel" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "arrayElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector ArrayElement))))

newtype ArrayElement Source #

Constructors

ArrayElement
Fields faces :: Vector Face

Instances

Instances details

Show ArrayElement Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> ArrayElement -> ShowS # show :: ArrayElement -> String # showList :: [ArrayElement] -> ShowS #
Generic ArrayElement Source #
Instance details Defined in Codec.Ktx Associated Types type Rep ArrayElement :: Type -> Type # Methods from :: ArrayElement -> Rep ArrayElement x # to :: Rep ArrayElement x -> ArrayElement #
type Rep ArrayElement Source #
Instance details Defined in Codec.Ktx type Rep ArrayElement = D1 ('MetaData "ArrayElement" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'True) (C1 ('MetaCons "ArrayElement" 'PrefixI 'True) (S1 ('MetaSel ('Just "faces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Face))))

newtype Face Source #

Constructors

Face
Fields zSlices :: Vector ZSlice

Instances

Instances details

Show Face Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> Face -> ShowS # show :: Face -> String # showList :: [Face] -> ShowS #
Generic Face Source #
Instance details Defined in Codec.Ktx Associated Types type Rep Face :: Type -> Type # Methods from :: Face -> Rep Face x # to :: Rep Face x -> Face #
type Rep Face Source #
Instance details Defined in Codec.Ktx type Rep Face = D1 ('MetaData "Face" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'True) (C1 ('MetaCons "Face" 'PrefixI 'True) (S1 ('MetaSel ('Just "zSlices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector ZSlice))))

newtype ZSlice Source #

Constructors

ZSlice
Fields block :: ByteString

Instances

Instances details

Show ZSlice Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> ZSlice -> ShowS # show :: ZSlice -> String # showList :: [ZSlice] -> ShowS #
Generic ZSlice Source #
Instance details Defined in Codec.Ktx Associated Types type Rep ZSlice :: Type -> Type # Methods from :: ZSlice -> Rep ZSlice x # to :: Rep ZSlice x -> ZSlice #
type Rep ZSlice Source #
Instance details Defined in Codec.Ktx type Rep ZSlice = D1 ('MetaData "ZSlice" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'True) (C1 ('MetaCons "ZSlice" 'PrefixI 'True) (S1 ('MetaSel ('Just "block") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

getImages :: Header -> Get MipLevels Source #

putImages :: MipLevels -> Put Source #

Show Header Source #
Instance details Defined in Codec.Ktx Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Generic Header Source #
Instance details Defined in Codec.Ktx Associated Types type Rep Header :: Type -> Type # Methods from :: Header -> Rep Header x # to :: Rep Header x -> Header #
Binary Header Source #
Instance details Defined in Codec.Ktx Methods put :: Header -> Put # get :: Get Header # putList :: [Header] -> Put #
type Rep Header Source #
Instance details Defined in Codec.Ktx type Rep Header = D1 ('MetaData "Header" "Codec.Ktx" "ktx-codec-0.0.1.2-54C7ncJ9B7S9D5Vn9rUrMm" 'False) (C1 ('MetaCons "Header" 'PrefixI 'True) (((S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "endianness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "glType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :: ((S1 ('MetaSel ('Just "glTypeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "glFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :: (S1 ('MetaSel ('Just "glInternalFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "glBaseInternalFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))) :: ((S1 ('MetaSel ('Just "pixelWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: (S1 ('MetaSel ('Just "pixelHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "pixelDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :: ((S1 ('MetaSel ('Just "numberOfArrayElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "numberOfFaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :: (S1 ('MetaSel ('Just "numberOfMipmapLevels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "bytesOfKeyValueData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))))