Game.GoreAndAsh.LambdaCube.API

Documentation

class (MonadIO m, MonadThrow m) => MonadLambdaCube m where

Low level monadic API for module.

Minimal complete definition

lambdacubeUpdateSize, lambdacubeAddPipeline, lambdacubeDeletePipeline, lambdacubeCreateStorage, lambdacubeDeleteStorage, lambdacubeGetStorage, lambdacubeRenderStorageLast, lambdacubeRenderStorageFirst, lambdacubeStopRendering

Methods

lambdacubeUpdateSize :: Word -> Word -> m ()

Update viewport size for rendering engine Should be called when window size is changed (or every frame)

lambdacubeAddPipeline :: [FilePath] -> String -> PipelineId -> Writer PipelineSchema a -> m ()

Compile and register new pipeline.

Throws: PipeLineCompileFailed or PipeLineAlreadyRegistered when failed.

lambdacubeDeletePipeline :: PipelineId -> m ()

Removes pipeline from engine, deallocates all storages for rendering storages

Note: if pipeline with the name doesn't exists, do nothing.

lambdacubeCreateStorage :: PipelineId -> m (StorageId, GLStorage)

Creates new storage (corresponding to one game object)

Note: if pipeline not found, throws PipeLineNotFound

lambdacubeDeleteStorage :: StorageId -> m ()

Removes storage for pipeline, deallocates it

Note: if storage with the id doesn't exists, do nothing

lambdacubeGetStorage :: StorageId -> m GLStorage

Getting storage by ID

Throws StorageNotFound if no storage found

lambdacubeRenderStorageLast :: StorageId -> m ()

Adds storage to rendering queue

lambdacubeRenderStorageFirst :: StorageId -> m ()

Adds storage to rendering queue

lambdacubeStopRendering :: StorageId -> m ()

Removes storage from rendering queue

Instances

(MonadIO (mt m), MonadThrow (mt m), MonadLambdaCube m, MonadTrans mt) => MonadLambdaCube (mt m)

Methods

lambdacubeUpdateSize :: Word -> Word -> mt m ()

lambdacubeAddPipeline :: [FilePath] -> String -> PipelineId -> Writer PipelineSchema a -> mt m ()

lambdacubeDeletePipeline :: PipelineId -> mt m ()

lambdacubeCreateStorage :: PipelineId -> mt m (StorageId, GLStorage)

lambdacubeDeleteStorage :: StorageId -> mt m ()

lambdacubeGetStorage :: StorageId -> mt m GLStorage

lambdacubeRenderStorageLast :: StorageId -> mt m ()

lambdacubeRenderStorageFirst :: StorageId -> mt m ()

lambdacubeStopRendering :: StorageId -> mt m ()

(MonadIO m, MonadThrow m) => MonadLambdaCube (LambdaCubeT s m)

Methods

lambdacubeUpdateSize :: Word -> Word -> LambdaCubeT s m ()

lambdacubeAddPipeline :: [FilePath] -> String -> PipelineId -> Writer PipelineSchema a -> LambdaCubeT s m ()

lambdacubeDeletePipeline :: PipelineId -> LambdaCubeT s m ()

lambdacubeCreateStorage :: PipelineId -> LambdaCubeT s m (StorageId, GLStorage)

lambdacubeDeleteStorage :: StorageId -> LambdaCubeT s m ()

lambdacubeGetStorage :: StorageId -> LambdaCubeT s m GLStorage

lambdacubeRenderStorageLast :: StorageId -> LambdaCubeT s m ()

lambdacubeRenderStorageFirst :: StorageId -> LambdaCubeT s m ()

lambdacubeStopRendering :: StorageId -> LambdaCubeT s m ()

data LambdaCubeException

Exception type that could be thrown by the module

Constructors

PipeLineCompileFailed String PipelineId String

Thrown when a pipeline compilation failed, first is pipeline main module, last is error message

PipeLineAlreadyRegistered PipelineId

Thrown when tries to register the same pipeline twice

PipeLineNotFound PipelineId

Trhown when tries to create storage for unregistered pipeline

StorageNotFound StorageId

Thrown when tries to get unregistered storage

PipeLineIncompatible StorageId String

Thrown when failed to bind pipeline to context, contains pipeline name and error message

Instances

Show LambdaCubeException

Methods

showsPrec :: Int -> LambdaCubeException -> ShowS

show :: LambdaCubeException -> String

showList :: [LambdaCubeException] -> ShowS

Generic LambdaCubeException

Associated Types

type Rep LambdaCubeException :: * -> *

Methods

from :: LambdaCubeException -> Rep LambdaCubeException x

to :: Rep LambdaCubeException x -> LambdaCubeException

Exception LambdaCubeException

Methods

toException :: LambdaCubeException -> SomeException

fromException :: SomeException -> Maybe LambdaCubeException

displayException :: LambdaCubeException -> String

type Rep LambdaCubeException

type Rep LambdaCubeException = D1 (MetaData "LambdaCubeException" "Game.GoreAndAsh.LambdaCube.State" "gore-and-ash-lambdacube-0.2.0.0-5EhXRpUDsTL23dfGCQjBPt" False) ((:+:) ((:+:) (C1 (MetaCons "PipeLineCompileFailed" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PipelineId)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) (C1 (MetaCons "PipeLineAlreadyRegistered" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PipelineId)))) ((:+:) (C1 (MetaCons "PipeLineNotFound" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PipelineId))) ((:+:) (C1 (MetaCons "StorageNotFound" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StorageId))) (C1 (MetaCons "PipeLineIncompatible" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StorageId)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))))