Graphics.Rendering.Ombra.Draw

Documentation

data Draw a

A state monad on top of GL.

Instances

Monad Draw

Methods

(>>=) :: Draw a -> (a -> Draw b) -> Draw b

(>>) :: Draw a -> Draw b -> Draw b

return :: a -> Draw a

fail :: String -> Draw a

Functor Draw

Methods

fmap :: (a -> b) -> Draw a -> Draw b

(<$) :: a -> Draw b -> Draw a

Applicative Draw

Methods

pure :: a -> Draw a

(<*>) :: Draw (a -> b) -> Draw a -> Draw b

(*>) :: Draw a -> Draw b -> Draw b

(<*) :: Draw a -> Draw b -> Draw a

MonadIO Draw

Methods

liftIO :: IO a -> Draw a

MonadGL Draw

Methods

gl :: GL a -> Draw a

GLES => MonadScreen Draw

Methods

currentViewport :: Draw (Int, Int)

resizeViewport :: Int -> Int -> Draw ()

data DrawState

The state of the Draw monad.

Running the Draw monad

refDrawCtx :: GLES => Ctx -> Draw a -> IORef DrawState -> IO a

Run a Draw action using an IORef and a context.

runDrawCtx

Arguments

:: Ctx

Context (use the appropriate backend functions)

-> Draw a

Draw action

-> DrawState

State (create it with drawState)

-> IO (a, DrawState)

execDrawCtx :: Ctx -> Draw a -> DrawState -> IO DrawState

evalDrawCtx :: Ctx -> Draw a -> DrawState -> IO a

drawState

Arguments

:: GLES

=> Int

Viewport width

-> Int

Viewport height

-> IO DrawState

Create a DrawState.

Draw actions

class MonadIO m => MonadGL m where

Minimal complete definition

gl

Methods

gl :: GL a -> m a

Instances

MonadGL GL

Methods

gl :: GL a -> GL a

MonadGL Draw

Methods

gl :: GL a -> Draw a

class GLES => MonadScreen m where

Minimal complete definition

currentViewport, resizeViewport

Methods

resizeViewport :: Int -> Int -> m ()

Instances

GLES => MonadScreen Draw

Methods

currentViewport :: Draw (Int, Int)

resizeViewport :: Int -> Int -> Draw ()

type MonadObject m = (MonadProgram m, MonadTexture m, MonadScreen m, MonadGeometry m, MonadDrawingMode m)

drawInit :: GLES => Draw ()

Initialize the render engine.

clearBuffers :: (GLES, MonadGL m) => [Buffer] -> m ()

drawLayer :: MonadObject m => Layer' Drawable t a -> m a

Draw a Layer.

Resources

In Ombra, GPU resources are allocated when they're needed, and they're kept alive by their corresponding CPU resources. Specifically, these resources are Geometries, Textures and Programs. This means that, when a CPU resource is garbage collected, the GPU resource is also removed. The functions below let you manage allocation and deallocation manually. Note that if you try to use a resource that was deallocated with the remove* functions it will be allocated again.

data ResStatus r

Constructors

Loaded r

Unloaded

Error String

Instances

Functor ResStatus

Methods

fmap :: (a -> b) -> ResStatus a -> ResStatus b

(<$) :: a -> ResStatus b -> ResStatus a

preloadGeometry :: GLES => Geometry (i ': is) -> Draw (Maybe String)

Manually allocate a Geometry in the GPU. Eventually returns an error string.

preloadTexture :: GLES => Texture -> Draw (Maybe String)

Manually allocate a Texture in the GPU.

preloadProgram :: GLES => Program gs is -> Draw (Maybe String)

Manually allocate a Program in the GPU.

removeGeometry :: GLES => Geometry (i ': is) -> Draw ()

Manually delete a Geometry from the GPU.

removeTexture :: GLES => Texture -> Draw ()

Manually delete a Texture from the GPU.

removeProgram :: GLES => Program gs is -> Draw ()

Manually delete a Program from the GPU.

checkGeometry :: GLES => Geometry (i ': is) -> Draw (ResStatus ())

Check if a Geometry failed to load.

checkTexture :: (GLES, Num a) => Texture -> Draw (ResStatus (a, a))

Check if a Texture failed to load. Eventually returns the texture width and height.

checkProgram :: GLES => Program gs is -> Draw (ResStatus ())

Check if a Program failed to load.

Extensions

hasVertexArrayObjects :: GLES => Ctx -> IO Bool

This extension is fundamental and Ombra won't work without it.

hasFloatTextures :: GLES => Ctx -> IO Bool

Required for the buffers* layer functions. May not be supported on older hardware.

hasDrawBuffers :: GLES => Ctx -> IO Bool

Required for the buffers* layer functions. May not be supported on older hardware.

hasStandardDerivatives :: GLES => Ctx -> IO Bool

Required for the dFdx, dFdy and fwidth shader functions.