ktx-codec-0.0.2.1: Khronos texture format

Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.Ktx.KeyValue

Contents

Predefined keys
Writing
Reading
Binary operations

Synopsis

type KeyValueData = Map Text Value
pattern KTXcubemapIncomplete :: Text
pattern KTXanimData :: Text
pattern KTXastcDecodeMode :: Text
pattern KTXwriterScParams :: Text
pattern KTXwriter :: Text
pattern KTXswizzle :: Text
pattern KTXmetalPixelFormat :: Text
pattern KTXdxgiFormat__ :: Text
pattern KTXglFormat :: Text
pattern KTXorientation :: Text
newtype Value = Value ByteString
text :: Text -> Value
bytes :: ByteString -> Value
number :: (Num a, Show a) => a -> Value
class FromValue a where
- fromValue :: Value -> Maybe a
textual :: KeyValueData -> Map Text Text
getDataLe :: Int -> Get KeyValueData
getData :: Get Word32 -> Int -> Get KeyValueData
putDataLe :: KeyValueData -> Put
putData :: (Word32 -> Put) -> KeyValueData -> Put

Documentation

type KeyValueData = Map Text Value Source #

Predefined keys

pattern KTXcubemapIncomplete :: Text Source #

pattern KTXanimData :: Text Source #

pattern KTXastcDecodeMode :: Text Source #

pattern KTXwriterScParams :: Text Source #

pattern KTXwriter :: Text Source #

pattern KTXswizzle :: Text Source #

pattern KTXmetalPixelFormat :: Text Source #

pattern KTXdxgiFormat__ :: Text Source #

pattern KTXglFormat :: Text Source #

pattern KTXorientation :: Text Source #

Writing

newtype Value Source #

A wrapper for raw data.

Use FromValue/ToValue to process.

Constructors

Value ByteString

Instances

Instances details

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

text :: Text -> Value Source #

bytes :: ByteString -> Value Source #

number :: (Num a, Show a) => a -> Value Source #

Reading

class FromValue a where Source #

Methods

fromValue :: Value -> Maybe a Source #

Instances

Instances details

FromValue ByteString Source #
Instance details Defined in Codec.Ktx.KeyValue Methods fromValue :: Value -> Maybe ByteString Source #
FromValue Text Source #
Instance details Defined in Codec.Ktx.KeyValue Methods fromValue :: Value -> Maybe Text Source #

textual :: KeyValueData -> Map Text Text Source #

Extract all valid (null-terminated utf8) values.

Binary operations

getDataLe :: Int -> Get KeyValueData Source #

getData :: Get Word32 -> Int -> Get KeyValueData Source #

putDataLe :: KeyValueData -> Put Source #

putData :: (Word32 -> Put) -> KeyValueData -> Put Source #