Game.GoreAndAsh.LambdaCube.State

Documentation

data LambdaCubeState s

Internal state of core module

s

- state of next module, they are chained until bottom, that is usually an empty data type.

Constructors

LambdaCubeState

Fields

• lambdacubePipelines :: !(HashMap PipelineId PipelineInfo)

  Module storage for LambdaCube pipelines

• lambdacubeStorages :: !(HashMap StorageId GLStorage)

  Module storage for LambdaCube storages

• lambdacubeRenderOrder :: !(Seq StorageId)

  Defines in which order to render each object at next frame

• lambdacubeNextStorageId :: !Int

  Next storage id to use

• lambdacubeNextState :: !s

  Next module state in chain of modules

Instances

Generic (LambdaCubeState s)

Associated Types

type Rep (LambdaCubeState s) :: * -> *

Methods

from :: LambdaCubeState s -> Rep (LambdaCubeState s) x

to :: Rep (LambdaCubeState s) x -> LambdaCubeState s

NFData s => NFData (LambdaCubeState s)

Methods

rnf :: LambdaCubeState s -> ()

Monad m => MonadState (LambdaCubeState s) (LambdaCubeT s m)

Methods

get :: LambdaCubeT s m (LambdaCubeState s)

put :: LambdaCubeState s -> LambdaCubeT s m ()

state :: (LambdaCubeState s -> (a, LambdaCubeState s)) -> LambdaCubeT s m a

type Rep (LambdaCubeState s)

type Rep (LambdaCubeState s)

type PipelineId = Text

ID to uniquely identify LambdaCube rednering pipeline

data StorageId

ID to uniquely identify LambdaCube storage

Constructors

StorageId

Fields

• storageId :: !Int
• storageScheme :: !PipelineId

Instances

Eq StorageId

Methods

(==) :: StorageId -> StorageId -> Bool

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

Show StorageId

Methods

showsPrec :: Int -> StorageId -> ShowS

show :: StorageId -> String

showList :: [StorageId] -> ShowS

Generic StorageId

Associated Types

type Rep StorageId :: * -> *

Methods

from :: StorageId -> Rep StorageId x

to :: Rep StorageId x -> StorageId

NFData StorageId

Methods

rnf :: StorageId -> ()

Hashable StorageId

Methods

hashWithSalt :: Int -> StorageId -> Int

hash :: StorageId -> Int

type Rep StorageId

type Rep StorageId = D1 (MetaData "StorageId" "Game.GoreAndAsh.LambdaCube.State" "gore-and-ash-lambdacube-0.2.0.0-5EhXRpUDsTL23dfGCQjBPt" False) (C1 (MetaCons "StorageId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "storageId") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "storageScheme") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PipelineId))))

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)))))))

emptyLambdaCubeState :: s -> LambdaCubeState s

Create inital state of the core module

s

- state of next module

freeLambdaCubeState :: LambdaCubeState s -> IO ()

Release module state resources

Internal API

updateStateViewportSize :: Word -> Word -> LambdaCubeState s -> IO ()

Update viewport size of all storages

isPipelineRegisteredInternal :: PipelineId -> LambdaCubeState s -> Bool

Returns True if given pipeline is already exists

registerPipelineInternal :: PipelineId -> Pipeline -> PipelineSchema -> GLRenderer -> LambdaCubeState s -> LambdaCubeState s

Register new pipeline with renderer in module

unregisterPipelineInternal :: PipelineId -> LambdaCubeState s -> IO (LambdaCubeState s)

Removes pipeline from state and deletes it, also destroys all storages of the pipeline

getPipelineSchemeInternal :: PipelineId -> LambdaCubeState s -> Maybe PipelineSchema

Getter of pipeline scheme

registerStorageInternal :: PipelineId -> GLStorage -> LambdaCubeState s -> (StorageId, LambdaCubeState s)

Registering gl storage for given pipeline

unregisterStorageInternal :: StorageId -> LambdaCubeState s -> IO (LambdaCubeState s)

Remove and deallocate storage

getStorageInternal :: StorageId -> LambdaCubeState s -> Maybe GLStorage

Find storage in state

getRendererInternal :: PipelineId -> LambdaCubeState s -> Maybe GLRenderer

renderStorageLastInternal :: StorageId -> LambdaCubeState s -> LambdaCubeState s

Puts storage at end of rendering queue

renderStorageFirstInternal :: StorageId -> LambdaCubeState s -> LambdaCubeState s

Puts storage at begining of rendering queue

stopRenderingInternal :: StorageId -> LambdaCubeState s -> LambdaCubeState s

Removes storage from rendering queue

Orphan instances

NFData Pipeline

Methods

rnf :: Pipeline -> ()

NFData PipelineSchema

Methods

rnf :: PipelineSchema -> ()

NFData GLStorage

Methods

rnf :: GLStorage -> ()

NFData GLRenderer

Methods

rnf :: GLRenderer -> ()