Safe Haskell	None
Language	Haskell2010

Graphics.GPipe.Internal.Context

Synopsis

class ContextHandler ctx where
- data ContextHandlerParameters ctx
- type ContextWindow ctx
- type WindowParameters ctx
- contextHandlerCreate :: ContextHandlerParameters ctx -> IO ctx
- contextHandlerDelete :: ctx -> IO ()
- createContext :: ctx -> Maybe (WindowBits, WindowParameters ctx) -> IO (ContextWindow ctx)
- contextDoAsync :: ctx -> Maybe (ContextWindow ctx) -> IO () -> IO ()
- contextSwap :: ctx -> ContextWindow ctx -> IO ()
- contextFrameBufferSize :: ctx -> ContextWindow ctx -> IO (Int, Int)
- contextDelete :: ctx -> ContextWindow ctx -> IO ()
data ContextT ctx os m a
newtype GPipeException = GPipeException String
runContextT :: (MonadIO m, MonadAsyncException m, ContextHandler ctx) => ContextHandlerParameters ctx -> (forall os. ContextT ctx os m a) -> m a
newWindow :: (ContextHandler ctx, MonadIO m) => WindowFormat c ds -> WindowParameters ctx -> ContextT ctx os m (Window os c ds)
deleteWindow :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m ()
swapWindowBuffers :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m ()
getFrameBufferSize :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m (V2 Int)
withContextWindow :: MonadIO m => Window os c ds -> (Maybe (ContextWindow ctx) -> IO a) -> ContextT ctx os m a
newtype WindowState = WindowState {
- windowContextData :: ContextData
}
data RenderState = RenderState {
- perWindowRenderState :: PerWindowRenderState
- renderWriteTextures :: IntSet
- renderLastUsedWin :: WinId
}
liftNonWinContextIO :: (ContextHandler ctx, MonadIO m) => IO a -> ContextT ctx os m a
liftNonWinContextAsyncIO :: (ContextHandler ctx, MonadIO m) => IO () -> ContextT ctx os m ()
addContextFinalizer :: (ContextHandler ctx, MonadIO m) => IORef a -> IO () -> ContextT ctx os m ()
newtype Window os c ds = Window {
- getWinName :: WinId
}
addVAOBufferFinalizer :: MonadIO m => IORef GLuint -> ContextT ctx os m ()
addFBOTextureFinalizer :: MonadIO m => Bool -> IORef GLuint -> ContextT ctx os m ()
getVAO :: ContextData -> [VAOKey] -> IO (Maybe (IORef GLuint))
setVAO :: ContextData -> [VAOKey] -> IORef GLuint -> IO ()
getFBO :: ContextData -> FBOKeys -> IO (Maybe (IORef GLuint))
setFBO :: ContextData -> FBOKeys -> IORef GLuint -> IO ()
type ContextData = MVar (VAOCache, FBOCache)
data VAOKey = VAOKey {
- vaoBname :: !GLuint
- vaoCombBufferOffset :: !Int
- vaoComponents :: !GLint
- vaoNorm :: !Bool
- vaoDiv :: !Int
}
data FBOKey = FBOKey {
- fboTname :: !GLuint
- fboTlayerOrNegIfRendBuff :: !Int
- fboTlevel :: !Int
}
data FBOKeys = FBOKeys {
- fboColors :: [FBOKey]
- fboDepth :: Maybe FBOKey
- fboStencil :: Maybe FBOKey
}
newtype Render os a = Render {
- unRender :: ExceptT String (ReaderT RenderEnv (StateT RenderState IO)) a
}
render :: (ContextHandler ctx, MonadIO m, MonadException m) => Render os () -> ContextT ctx os m ()
registerRenderWriteTexture :: Int -> Render os ()
getLastRenderWin :: Render os (WinId, ContextData, ContextDoAsync)
asSync :: (IO () -> IO ()) -> IO x -> IO x

Documentation

class ContextHandler ctx where Source #

Class implementing a window handler that can create openGL contexts, such as GLFW or GLUT

Associated Types

data ContextHandlerParameters ctx Source #

Implementation specific context handler parameters, eg error handling and event processing policies

type ContextWindow ctx Source #

Implementation specific window type

type WindowParameters ctx Source #

Implementation specific window parameters, eg initial size and border decoration

Methods

contextHandlerCreate :: ContextHandlerParameters ctx -> IO ctx Source #

Create a context handler. Called from the main thread

contextHandlerDelete :: ctx -> IO () Source #

Delete the context handler. All contexts created from this handler will be deleted using contextDelete prior to calling this.

createContext :: ctx -> Maybe (WindowBits, WindowParameters ctx) -> IO (ContextWindow ctx) Source #

Create a new context sharing all other contexts created by this ContextHandler. If the parameter is Nothing, a hidden off-screen context is created, otherwise creates a window with the provided window bits and implementation specific parameters. Only ever called from the mainthread (i.e. the thread that called contextHandlerCreate).

contextDoAsync :: ctx -> Maybe (ContextWindow ctx) -> IO () -> IO () Source #

Run an OpenGL IO action in this context, that doesn't return any value to the caller. This may be run after contextDelete or contextHandlerDelete has been called. The thread calling this may not be the same creating the context (for finalizers it is most definetly not). May also be called on previously deleted windows in the case of finalizers.

contextSwap :: ctx -> ContextWindow ctx -> IO () Source #

Swap the front and back buffers in the context's default frame buffer. Only ever called from the mainthread (i.e. the thread that called contextHandlerCreate). Never called on deleted windows.

contextFrameBufferSize :: ctx -> ContextWindow ctx -> IO (Int, Int) Source #

Get the current size of the context's default framebuffer (which may change if the window is resized). Only ever called from the mainthread (i.e. the thread that called contextHandlerCreate)

contextDelete :: ctx -> ContextWindow ctx -> IO () Source #

Delete a context and close any associated window. Only ever called from the mainthread (i.e. the thread that called contextHandlerCreate). Only ever called once per window, and will always be called for each window before the context is deleted with contextHandlerDelete.

data ContextT ctx os m a Source #

The monad transformer that encapsulates a GPipe context (which wraps an OpenGl context).

A value of type ContextT ctx os m a is an action on a context with these parameters:

ctx: The context handler.
os: An abstract type that is used to denote the object space. This is an forall type defined by the runContextT call which will restrict any objects created inside this context to be returned from it or used by another context (the same trick as the ST monad uses).
m: The monad this monad transformer wraps. Need to have IO in the bottom for this ContextT to be runnable.
a: The value returned from this monad action.

Instances

Instances details

MonadTrans (ContextT ctx os) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods lift :: Monad m => m a -> ContextT ctx os m a #
Monad m => Monad (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (>>=) :: ContextT ctx os m a -> (a -> ContextT ctx os m b) -> ContextT ctx os m b # (>>) :: ContextT ctx os m a -> ContextT ctx os m b -> ContextT ctx os m b # return :: a -> ContextT ctx os m a #
Functor m => Functor (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods fmap :: (a -> b) -> ContextT ctx os m a -> ContextT ctx os m b # (<$) :: a -> ContextT ctx os m b -> ContextT ctx os m a #
MonadIO m => MonadFail (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods fail :: String -> ContextT ctx os m a #
Monad m => Applicative (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods pure :: a -> ContextT ctx os m a # (<>) :: ContextT ctx os m (a -> b) -> ContextT ctx os m a -> ContextT ctx os m b # liftA2 :: (a -> b -> c) -> ContextT ctx os m a -> ContextT ctx os m b -> ContextT ctx os m c # (>) :: ContextT ctx os m a -> ContextT ctx os m b -> ContextT ctx os m b # (<*) :: ContextT ctx os m a -> ContextT ctx os m b -> ContextT ctx os m a #
MonadIO m => MonadIO (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods liftIO :: IO a -> ContextT ctx os m a #
MonadException m => MonadException (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods throw :: Exception e => e -> ContextT ctx os m a # catch :: Exception e => ContextT ctx os m a -> (e -> ContextT ctx os m a) -> ContextT ctx os m a # finally :: ContextT ctx os m a -> ContextT ctx os m b -> ContextT ctx os m a #
MonadAsyncException m => MonadAsyncException (ContextT ctx os m) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods mask :: ((forall a. ContextT ctx os m a -> ContextT ctx os m a) -> ContextT ctx os m b) -> ContextT ctx os m b #

newtype GPipeException Source #

This kind of exception may be thrown from GPipe when a GPU hardware limit is reached (for instance, too many textures are drawn to from the same FragmentStream)

Constructors

GPipeException String

Instances

Instances details

Show GPipeException Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods showsPrec :: Int -> GPipeException -> ShowS # show :: GPipeException -> String # showList :: [GPipeException] -> ShowS #
Exception GPipeException Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods toException :: GPipeException -> SomeException # fromException :: SomeException -> Maybe GPipeException # displayException :: GPipeException -> String #

runContextT :: (MonadIO m, MonadAsyncException m, ContextHandler ctx) => ContextHandlerParameters ctx -> (forall os. ContextT ctx os m a) -> m a Source #

Run a ContextT monad transformer that encapsulates an object space. You need an implementation of a ContextHandler, which is provided by an auxillary package, such as GPipe-GLFW.

newWindow :: (ContextHandler ctx, MonadIO m) => WindowFormat c ds -> WindowParameters ctx -> ContextT ctx os m (Window os c ds) Source #

Creates a window

deleteWindow :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m () Source #

Deletes a window. Any rendering to this window will become a noop.

swapWindowBuffers :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m () Source #

Run this action after a render call to swap out the context windows back buffer with the front buffer, effectively showing the result. This call may block if vsync is enabled in the system and/or too many frames are outstanding. After this call, the context window content is undefined and should be cleared at earliest convenience using clearContextColor and friends.

getFrameBufferSize :: (ContextHandler ctx, MonadIO m) => Window os c ds -> ContextT ctx os m (V2 Int) Source #

Return the current size of the context frame buffer. This is needed to set viewport size and to get the aspect ratio to calculate projection matrices.

withContextWindow :: MonadIO m => Window os c ds -> (Maybe (ContextWindow ctx) -> IO a) -> ContextT ctx os m a Source #

Use the context window handle, which type is specific to the window system used. This handle shouldn't be returned from this function

newtype WindowState Source #

Constructors

WindowState
Fields windowContextData :: ContextData

data RenderState Source #

Constructors

RenderState
Fields perWindowRenderState :: PerWindowRenderState renderWriteTextures :: IntSet renderLastUsedWin :: WinId

liftNonWinContextIO :: (ContextHandler ctx, MonadIO m) => IO a -> ContextT ctx os m a Source #

liftNonWinContextAsyncIO :: (ContextHandler ctx, MonadIO m) => IO () -> ContextT ctx os m () Source #

addContextFinalizer :: (ContextHandler ctx, MonadIO m) => IORef a -> IO () -> ContextT ctx os m () Source #

newtype Window os c ds Source #

Constructors

Window
Fields getWinName :: WinId

Instances

Instances details

Eq (Window os c ds) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (==) :: Window os c ds -> Window os c ds -> Bool # (/=) :: Window os c ds -> Window os c ds -> Bool #

addVAOBufferFinalizer :: MonadIO m => IORef GLuint -> ContextT ctx os m () Source #

Removes a VAO entry from all SharedContextDatas when one of the buffers are deleted. This will in turn make the VAO finalizer to be run.

addFBOTextureFinalizer :: MonadIO m => Bool -> IORef GLuint -> ContextT ctx os m () Source #

Removes a FBO entry from all SharedContextDatas when one of the textures are deleted. This will in turn make the FBO finalizer to be run.

getVAO :: ContextData -> [VAOKey] -> IO (Maybe (IORef GLuint)) Source #

setVAO :: ContextData -> [VAOKey] -> IORef GLuint -> IO () Source #

getFBO :: ContextData -> FBOKeys -> IO (Maybe (IORef GLuint)) Source #

setFBO :: ContextData -> FBOKeys -> IORef GLuint -> IO () Source #

type ContextData = MVar (VAOCache, FBOCache) Source #

data VAOKey Source #

Constructors

VAOKey
Fields vaoBname :: !GLuint vaoCombBufferOffset :: !Int vaoComponents :: !GLint vaoNorm :: !Bool vaoDiv :: !Int

Instances

Instances details

Eq VAOKey Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (==) :: VAOKey -> VAOKey -> Bool # (/=) :: VAOKey -> VAOKey -> Bool #
Ord VAOKey Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods compare :: VAOKey -> VAOKey -> Ordering # (<) :: VAOKey -> VAOKey -> Bool # (<=) :: VAOKey -> VAOKey -> Bool # (>) :: VAOKey -> VAOKey -> Bool # (>=) :: VAOKey -> VAOKey -> Bool # max :: VAOKey -> VAOKey -> VAOKey # min :: VAOKey -> VAOKey -> VAOKey #

data FBOKey Source #

Constructors

FBOKey
Fields fboTname :: !GLuint fboTlayerOrNegIfRendBuff :: !Int fboTlevel :: !Int

Instances

Instances details

Eq FBOKey Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (==) :: FBOKey -> FBOKey -> Bool # (/=) :: FBOKey -> FBOKey -> Bool #
Ord FBOKey Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods compare :: FBOKey -> FBOKey -> Ordering # (<) :: FBOKey -> FBOKey -> Bool # (<=) :: FBOKey -> FBOKey -> Bool # (>) :: FBOKey -> FBOKey -> Bool # (>=) :: FBOKey -> FBOKey -> Bool # max :: FBOKey -> FBOKey -> FBOKey # min :: FBOKey -> FBOKey -> FBOKey #

data FBOKeys Source #

Constructors

FBOKeys
Fields fboColors :: [FBOKey] fboDepth :: Maybe FBOKey fboStencil :: Maybe FBOKey

Instances

Instances details

Eq FBOKeys Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (==) :: FBOKeys -> FBOKeys -> Bool # (/=) :: FBOKeys -> FBOKeys -> Bool #
Ord FBOKeys Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods compare :: FBOKeys -> FBOKeys -> Ordering # (<) :: FBOKeys -> FBOKeys -> Bool # (<=) :: FBOKeys -> FBOKeys -> Bool # (>) :: FBOKeys -> FBOKeys -> Bool # (>=) :: FBOKeys -> FBOKeys -> Bool # max :: FBOKeys -> FBOKeys -> FBOKeys # min :: FBOKeys -> FBOKeys -> FBOKeys #

newtype Render os a Source #

A monad in which shaders are run.

Constructors

Render
Fields unRender :: ExceptT String (ReaderT RenderEnv (StateT RenderState IO)) a

Instances

Instances details

Monad (Render os) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods (>>=) :: Render os a -> (a -> Render os b) -> Render os b # (>>) :: Render os a -> Render os b -> Render os b # return :: a -> Render os a #
Functor (Render os) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods fmap :: (a -> b) -> Render os a -> Render os b # (<$) :: a -> Render os b -> Render os a #
Applicative (Render os) Source #
Instance details Defined in Graphics.GPipe.Internal.Context Methods pure :: a -> Render os a # (<>) :: Render os (a -> b) -> Render os a -> Render os b # liftA2 :: (a -> b -> c) -> Render os a -> Render os b -> Render os c # (>) :: Render os a -> Render os b -> Render os b # (<*) :: Render os a -> Render os b -> Render os a #

render :: (ContextHandler ctx, MonadIO m, MonadException m) => Render os () -> ContextT ctx os m () Source #

Run a Render monad, that may have the effect of windows or textures being drawn to.

May throw a GPipeException if a combination of draw images (FBO) used by this render call is unsupported by the graphics driver

registerRenderWriteTexture :: Int -> Render os () Source #

getLastRenderWin :: Render os (WinId, ContextData, ContextDoAsync) Source #

asSync :: (IO () -> IO ()) -> IO x -> IO x Source #