Safe Haskell	None
Language	Haskell2010

Codec.Ktx2.Font

Contents

KTX font bundles
Shaping context
- Associated data utilities
Format internals

Synopsis

data Bundle = Bundle {
- fontData :: FontData
- atlas :: Compact
}
loadBundle :: ReadChunk a => Context a -> IO Bundle
loadBundleBytes :: ByteString -> IO Bundle
loadBundleFile :: FilePath -> IO Bundle
freeBundle :: Bundle -> IO ()
bundleFont :: FilePath -> FilePath -> FilePath -> FilePath -> IO ()
data StackContext a = StackContext {
- shapeContext :: MVar Context
- bundled :: IntMap a
- atlases :: IntMap Compact
}
createStackContext :: Foldable t => t Bundle -> IO (StackContext ())
pushBundleFont :: Context -> Bundle -> IO Int
destroyStackContext :: StackContext a -> IO ()
lookupAtlas :: Font -> StackContext a -> Maybe Compact
lookupBundled :: Font -> StackContext a -> Maybe a
mapWithBundle :: Foldable t => t (Bundle, a -> b) -> StackContext a -> StackContext b
mapBundled :: (a -> b) -> StackContext a -> StackContext b
pattern KTX_KEY_atlas :: Text
pattern KTX_KEY_kbts :: Text
pattern KTX_KEY_kbts_version :: Text
kbtsVersion :: Text

KTX font bundles

data Bundle Source #

Constructors

Bundle
Fields fontData :: FontData The bundle holds the font memory too. atlas :: Compact Glyph atlas data for the texture.

Instances

Instances details

Eq Bundle Source #
Instance details Defined in Codec.Ktx2.Font Methods (==) :: Bundle -> Bundle -> Bool # (/=) :: Bundle -> Bundle -> Bool #

loadBundle :: ReadChunk a => Context a -> IO Bundle Source #

Load bundle data from already opened KTX2 reader context

loadBundleBytes :: ByteString -> IO Bundle Source #

loadBundleFile :: FilePath -> IO Bundle Source #

freeBundle :: Bundle -> IO () Source #

bundleFont Source #

Arguments

:: FilePath	Source font (ttf etc)
-> FilePath	Atlas JSON
-> FilePath	KTX2 texture
-> FilePath	Output
-> IO ()

Shaping context

data StackContext a Source #

Constructors

StackContext
Fields shapeContext :: MVar Context bundled :: IntMap a atlases :: IntMap Compact

Instances

Instances details

Functor StackContext Source #

Instance details

Defined in Codec.Ktx2.Font

Methods

fmap :: (a -> b) -> StackContext a -> StackContext b #

(<$) :: a -> StackContext b -> StackContext a #

Foldable StackContext Source #

Instance details

Defined in Codec.Ktx2.Font

Methods

fold :: Monoid m => StackContext m -> m #

foldMap :: Monoid m => (a -> m) -> StackContext a -> m #

foldMap' :: Monoid m => (a -> m) -> StackContext a -> m #

foldr :: (a -> b -> b) -> b -> StackContext a -> b #

foldr' :: (a -> b -> b) -> b -> StackContext a -> b #

foldl :: (b -> a -> b) -> b -> StackContext a -> b #

foldl' :: (b -> a -> b) -> b -> StackContext a -> b #

foldr1 :: (a -> a -> a) -> StackContext a -> a #

foldl1 :: (a -> a -> a) -> StackContext a -> a #

toList :: StackContext a -> [a] #

null :: StackContext a -> Bool #

length :: StackContext a -> Int #

elem :: Eq a => a -> StackContext a -> Bool #

maximum :: Ord a => StackContext a -> a #

minimum :: Ord a => StackContext a -> a #

sum :: Num a => StackContext a -> a #

product :: Num a => StackContext a -> a #

Traversable StackContext Source #

Instance details

Defined in Codec.Ktx2.Font

Methods

traverse :: Applicative f => (a -> f b) -> StackContext a -> f (StackContext b) #

sequenceA :: Applicative f => StackContext (f a) -> f (StackContext a) #

mapM :: Monad m => (a -> m b) -> StackContext a -> m (StackContext b) #

sequence :: Monad m => StackContext (m a) -> m (StackContext a) #

Generic1 StackContext Source #

Instance details

Defined in Codec.Ktx2.Font

Associated Types

type Rep1 StackContext

Instance details

Defined in Codec.Ktx2.Font

type Rep1 StackContext = D1 ('MetaData "StackContext" "Codec.Ktx2.Font" "ktx-font-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StackContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Context)) :*: (S1 ('MetaSel ('Just "bundled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec1 IntMap) :*: S1 ('MetaSel ('Just "atlases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap Compact)))))

Methods

from1 :: StackContext a -> Rep1 StackContext a #

to1 :: Rep1 StackContext a -> StackContext a #

Generic (StackContext a) Source #

Instance details

Defined in Codec.Ktx2.Font

Associated Types

type Rep (StackContext a)

Instance details

Defined in Codec.Ktx2.Font

type Rep (StackContext a) = D1 ('MetaData "StackContext" "Codec.Ktx2.Font" "ktx-font-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StackContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Context)) :*: (S1 ('MetaSel ('Just "bundled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap a)) :*: S1 ('MetaSel ('Just "atlases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap Compact)))))

Methods

from :: StackContext a -> Rep (StackContext a) x #

to :: Rep (StackContext a) x -> StackContext a #

type Rep1 StackContext Source #

Instance details

Defined in Codec.Ktx2.Font

type Rep1 StackContext = D1 ('MetaData "StackContext" "Codec.Ktx2.Font" "ktx-font-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StackContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Context)) :*: (S1 ('MetaSel ('Just "bundled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec1 IntMap) :*: S1 ('MetaSel ('Just "atlases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap Compact)))))

type Rep (StackContext a) Source #

Instance details

Defined in Codec.Ktx2.Font

type Rep (StackContext a) = D1 ('MetaData "StackContext" "Codec.Ktx2.Font" "ktx-font-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StackContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Context)) :*: (S1 ('MetaSel ('Just "bundled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap a)) :*: S1 ('MetaSel ('Just "atlases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IntMap Compact)))))

createStackContext :: Foldable t => t Bundle -> IO (StackContext ()) Source #

Create shaping context and push fonts from all the bundles.

pushBundleFont :: Context -> Bundle -> IO Int Source #

Put already-loaded font to context.

The context will NOT keep a fontData reference.

destroyStackContext :: StackContext a -> IO () Source #

Destroy shaping context.

NB: Does NOT free the fonts as they may be shared with other stacks. Use freeBundle for that.

Associated data utilities

lookupAtlas :: Font -> StackContext a -> Maybe Compact Source #

lookupBundled :: Font -> StackContext a -> Maybe a Source #

mapWithBundle :: Foldable t => t (Bundle, a -> b) -> StackContext a -> StackContext b Source #

Update font annotations with the bundle collection annotated with update functions.

This may be used to attach more information, e.g. after all fonts were assigned texture slots.

The update collection should be a superset of what was initially bundled. Otherwise you may see missing things downstream.

mapBundled :: (a -> b) -> StackContext a -> StackContext b Source #

Format internals

pattern KTX_KEY_atlas :: Text Source #

pattern KTX_KEY_kbts :: Text Source #

pattern KTX_KEY_kbts_version :: Text Source #

kbtsVersion :: Text Source #