License	BSD3
Maintainer	ziocroc@gmail.com
Stability	experimental
Portability	GHC only
Safe Haskell	None
Language	Haskell2010

Graphics.Rendering.Ombra.Draw

Contents

Running the Draw monad
Draw actions
- Culling
- Resources

Description

Synopsis

Documentation

module Graphics.Rendering.Ombra.OutBuffer

data Draw o a Source #

An implementation of MonadDraw and MonadDrawBuffers.

Instances

GLES => MonadDrawBuffers Draw Source #
Methods drawBuffers :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t') DepthBufferInfo -> Draw o a -> (forall t. GBuffer t o -> DepthBuffer t -> a -> Draw o' b) -> Draw o' b Source # drawBuffers' :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t1) DepthBufferInfo -> Draw o a -> Draw o' (a, GBuffer t2 o, DepthBuffer t3) Source #
GLES => MonadRead GVec4 Draw Source #
Methods readColor :: (Int, Int, Int, Int) -> Draw GVec4 [Color] Source # readColorFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Vec4] Source # readDepth :: (Int, Int, Int, Int) -> Draw GVec4 [Word16] Source # readDepthFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Float] Source # readStencil :: (Int, Int, Int, Int) -> Draw GVec4 [Word8] Source #
(FragmentShaderOutput o, GLES) => MonadDraw o Draw Source #
Methods withColorMask :: (Bool, Bool, Bool, Bool) -> Draw o a -> Draw o a Source # withDepthTest :: Bool -> Draw o a -> Draw o a Source # withDepthMask :: Bool -> Draw o a -> Draw o a Source #
MonadBase IO (Draw o) Source #
Methods liftBase :: IO α -> Draw o α #
MonadBaseControl IO (Draw o) Source #
Associated Types type StM (Draw o :: * -> ) a :: # Methods liftBaseWith :: (RunInBase (Draw o) IO -> IO a) -> Draw o a # restoreM :: StM (Draw o) a -> Draw o a #
Monad (Draw o) Source #
Methods (>>=) :: Draw o a -> (a -> Draw o b) -> Draw o b # (>>) :: Draw o a -> Draw o b -> Draw o b # return :: a -> Draw o a # fail :: String -> Draw o a #
Functor (Draw o) Source #
Methods fmap :: (a -> b) -> Draw o a -> Draw o b # (<$) :: a -> Draw o b -> Draw o a #
Applicative (Draw o) Source #
Methods pure :: a -> Draw o a # (<>) :: Draw o (a -> b) -> Draw o a -> Draw o b # (>) :: Draw o a -> Draw o b -> Draw o b # (<*) :: Draw o a -> Draw o b -> Draw o a #
MonadIO (Draw o) Source #
Methods liftIO :: IO a -> Draw o a #
GLES => MonadCulling (Draw o) Source #
Methods withCulling :: Maybe CullFace -> Draw o a -> Draw o a Source #
GLES => MonadScreen (Draw o) Source #
Methods currentViewport :: Draw o (Int, Int) resizeViewport :: Int -> Int -> Draw o () Source #
GLES => MonadTexture (Draw o) Source #
Methods getTexture :: Texture -> Draw o (Either String LoadedTexture) getActiveTexturesCount :: Draw o Int setActiveTexturesCount :: Int -> Draw o () newTexture :: Int -> Int -> TextureParameters -> Int -> (Texture -> GL ()) -> Draw o LoadedTexture unusedTextures :: [LoadedTexture] -> Draw o ()
type StM (Draw o) a Source #
type StM (Draw o) a

data DrawState Source #

The state of the Draw monad.

Running the Draw monad

runDraw Source #

Arguments

:: GLES
=> Int	Viewport width
-> Int	Viewport height
-> Ctx
-> Draw GVec4 a
-> IO a

Draw actions

class (MonadGeometry (m o), MonadProgram (m o), MonadTexture (m o), MonadScreen (m o)) => MonadDraw o m where Source #

Monads that can be used to draw Images.

Minimal complete definition

withColorMask, withDepthTest, withDepthMask

Methods

withColorMask :: (Bool, Bool, Bool, Bool) -> m o a -> m o a Source #

withDepthTest :: Bool -> m o a -> m o a Source #

withDepthMask :: Bool -> m o a -> m o a Source #

Instances

(FragmentShaderOutput o, GLES) => MonadDraw o Draw Source #
Methods withColorMask :: (Bool, Bool, Bool, Bool) -> Draw o a -> Draw o a Source # withDepthTest :: Bool -> Draw o a -> Draw o a Source # withDepthMask :: Bool -> Draw o a -> Draw o a Source #

class MonadDrawBuffers m where Source #

Monads that support drawing to GBuffers and DepthBuffers.

Minimal complete definition

drawBuffers, drawBuffers'

Methods

drawBuffers :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t') DepthBufferInfo -> m o a -> (forall t. GBuffer t o -> DepthBuffer t -> a -> m o' b) -> m o' b Source #

Draw an image to some buffers.

drawBuffers' :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t1) DepthBufferInfo -> m o a -> m o' (a, GBuffer t2 o, DepthBuffer t3) Source #

Use this instead of drawBuffers if you need to reuse the newly created buffers layer. They will be deleted from the GPU when the 'GBuffer'/'DepthBuffer' is garbage collected.

Instances

GLES => MonadDrawBuffers Draw Source #
Methods drawBuffers :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t') DepthBufferInfo -> Draw o a -> (forall t. GBuffer t o -> DepthBuffer t -> a -> Draw o' b) -> Draw o' b Source # drawBuffers' :: Int -> Int -> Either (GBuffer t o) (GBufferInfo o) -> Either (DepthBuffer t1) DepthBufferInfo -> Draw o a -> Draw o' (a, GBuffer t2 o, DepthBuffer t3) Source #

class MonadDraw o m => MonadRead o m where Source #

Minimal complete definition

readColor, readColorFloat, readDepth, readDepthFloat, readStencil

Methods

readColor :: (Int, Int, Int, Int) -> m o [Color] Source #

Read a rectangle of pixel colors from the screen (or texture).

readColorFloat :: (Int, Int, Int, Int) -> m o [Vec4] Source #

readColor variant that read color vectors.

readDepth :: (Int, Int, Int, Int) -> m o [Word16] Source #

Read a rectangle of pixel depths from the screen (or texture). Not supported on WebGL!

readDepthFloat :: (Int, Int, Int, Int) -> m o [Float] Source #

readDepth variants that read floats. Not supported on WebGL as well.

readStencil :: (Int, Int, Int, Int) -> m o [Word8] Source #

Read a rectangle of stencil values from the screen (or texture). Not supported on WebGL!

Instances

GLES => MonadRead GVec4 Draw Source #
Methods readColor :: (Int, Int, Int, Int) -> Draw GVec4 [Color] Source # readColorFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Vec4] Source # readDepth :: (Int, Int, Int, Int) -> Draw GVec4 [Word16] Source # readDepthFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Float] Source # readStencil :: (Int, Int, Int, Int) -> Draw GVec4 [Word8] Source #

class (GLES, Monad m) => MonadScreen m where Source #

Minimal complete definition

currentViewport, resizeViewport

Methods

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

Resize the drawing space.

Instances

GLES => MonadScreen (Draw o) Source #
Methods currentViewport :: Draw o (Int, Int) resizeViewport :: Int -> Int -> Draw o () Source #

clearColor :: (GLES, MonadGL m) => m () Source #

Clear the color buffer.

clearDepth :: (GLES, MonadGL m) => m () Source #

Clear the depth buffer.

clearStencil :: (GLES, MonadGL m) => m () Source #

Clear the stencil buffer.

Culling

data CullFace Source #

Constructors

CullFront
CullBack
CullFrontBack

Instances

Eq CullFace Source #
Methods (==) :: CullFace -> CullFace -> Bool # (/=) :: CullFace -> CullFace -> Bool #

class (GLES, MonadGL m) => MonadCulling m where Source #

Minimal complete definition

withCulling

Methods

withCulling :: Maybe CullFace -> m a -> m a Source #

Instances

GLES => MonadCulling (Draw o) Source #
Methods withCulling :: Maybe CullFace -> Draw o a -> Draw o a Source #

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 Shaders. 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 Source #

Constructors

Loaded r
Unloaded
Error String

Instances

Functor ResStatus Source #
Methods fmap :: (a -> b) -> ResStatus a -> ResStatus b # (<$) :: a -> ResStatus b -> ResStatus a #

preloadGeometry :: (GLES, GeometryVertex g) => Geometry g -> Draw o (Maybe String) Source #

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

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

Manually allocate a Texture in the GPU.

removeGeometry :: (GLES, GeometryVertex g) => Geometry g -> Draw o () Source #

Manually delete a Geometry from the GPU.

removeTexture :: GLES => Texture -> Draw o () Source #

Manually delete a Texture from the GPU.

checkGeometry :: (GLES, GeometryVertex g) => Geometry g -> Draw o (ResStatus ()) Source #

Check if a Geometry failed to load.

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

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