Aztecs.Asset

Documentation

newtype AssetId

Unique identifier for an asset.

Since: 0.9

Constructors

AssetId

Fields

• unAssetId :: Int

  Unique integer identifier.

  Since: 0.9

Instances

Show AssetId

Defined in Aztecs.Asset.AssetServer

Methods

showsPrec :: Int -> AssetId -> ShowS

show :: AssetId -> String

showList :: [AssetId] -> ShowS

Eq AssetId

Defined in Aztecs.Asset.AssetServer

Methods

(==) :: AssetId -> AssetId -> Bool

(/=) :: AssetId -> AssetId -> Bool

Ord AssetId

Defined in Aztecs.Asset.AssetServer

Methods

compare :: AssetId -> AssetId -> Ordering

(<) :: AssetId -> AssetId -> Bool

(<=) :: AssetId -> AssetId -> Bool

(>) :: AssetId -> AssetId -> Bool

(>=) :: AssetId -> AssetId -> Bool

max :: AssetId -> AssetId -> AssetId

min :: AssetId -> AssetId -> AssetId

data AssetServer a

Asset server.

Since: 0.9

Constructors

AssetServer

Fields

• assetServerAssets :: !(Map AssetId a)

  Loaded assets.

  Since: 0.9

• loadingAssets :: !(Map AssetId (Either (IO (IORef (Maybe a))) (IORef (Maybe a))))

  Assets currently being loaded.

  Since: 0.9

• nextAssetId :: !AssetId

  Next unique asset identifier.

  Since: 0.9

Instances

Typeable a => Component (AssetServer a)

Since: 0.9

Defined in Aztecs.Asset.AssetServer

Associated Types

type StorageT (AssetServer a)

Generic (AssetServer a)

Defined in Aztecs.Asset.AssetServer

Associated Types

type Rep (AssetServer a) :: Type -> Type

Methods

from :: AssetServer a -> Rep (AssetServer a) x

to :: Rep (AssetServer a) x -> AssetServer a

NFData (AssetServer a)

Since: 0.9

Defined in Aztecs.Asset.AssetServer

Methods

rnf :: AssetServer a -> ()

type StorageT (AssetServer a)

Defined in Aztecs.Asset.AssetServer

type StorageT (AssetServer a) = [AssetServer a]

type Rep (AssetServer a)

Defined in Aztecs.Asset.AssetServer

type Rep (AssetServer a) = D1 ('MetaData "AssetServer" "Aztecs.Asset.AssetServer" "aztecs-0.10.0-3EoQmFKNYHMC2yYd4M5ldJ" 'False) (C1 ('MetaCons "AssetServer" 'PrefixI 'True) (S1 ('MetaSel ('Just "assetServerAssets") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map AssetId a)) :*: (S1 ('MetaSel ('Just "loadingAssets") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map AssetId (Either (IO (IORef (Maybe a))) (IORef (Maybe a))))) :*: S1 ('MetaSel ('Just "nextAssetId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AssetId))))

class MonadAssetLoader a m | m -> a where

Monadic interface for loading assets.

Since: 0.9

Methods

asset :: FilePath -> AssetConfig a -> m (Handle a)

Load an asset from a file path with a configuration.

Since: 0.9

Instances

(Monad m, Asset a) => MonadAssetLoader a (AssetLoaderT a m)

Since: 0.9

Defined in Aztecs.Asset.AssetLoader

Methods

asset :: FilePath -> AssetConfig a -> AssetLoaderT a m (Handle a)

class Typeable a => Asset a where

Loadable asset.

Since: 0.9

Associated Types

type AssetConfig a

Configuration for loading an asset.

Since: 0.9

Methods

loadAsset :: FilePath -> AssetConfig a -> IO a

Load an asset from a file path with a configuration.

Since: 0.9

newtype Handle a

Handle to an asset.

Since: 0.9

Constructors

Handle

Fields

• handleId :: AssetId

  Asset ID.

  Since: 0.9

Instances

Show (Handle a)

Defined in Aztecs.Asset.AssetServer

Methods

showsPrec :: Int -> Handle a -> ShowS

show :: Handle a -> String

showList :: [Handle a] -> ShowS

NFData (Handle a)

Since: 0.9

Defined in Aztecs.Asset.AssetServer

Methods

rnf :: Handle a -> ()

Eq (Handle a)

Defined in Aztecs.Asset.AssetServer

Methods

(==) :: Handle a -> Handle a -> Bool

(/=) :: Handle a -> Handle a -> Bool

Ord (Handle a)

Defined in Aztecs.Asset.AssetServer

Methods

compare :: Handle a -> Handle a -> Ordering

(<) :: Handle a -> Handle a -> Bool

(<=) :: Handle a -> Handle a -> Bool

(>) :: Handle a -> Handle a -> Bool

(>=) :: Handle a -> Handle a -> Bool

max :: Handle a -> Handle a -> Handle a

min :: Handle a -> Handle a -> Handle a

lookupAsset :: Handle a -> AssetServer a -> Maybe a

Lookup an asset by its handle.

Since: 0.9

setup :: forall m b a. (Typeable a, MonadAccess b m) => m ()

Setup the asset server.

Since: 0.9

loadAssets :: forall a q s m. (Typeable a, QueryF m q, Applicative q, MonadSystem q s, MonadIO m) => s ()

Load any pending assets.

Since: 0.9

load :: (MonadSystem Query s, Asset a) => AssetLoader a o -> s o

System to load assets.

Since: 0.9