Graphics.Rendering.Ombra.Draw

Documentation

module Graphics.Rendering.Ombra.OutBuffer

data Draw o a

An implementation of MonadDraw and MonadDrawBuffers.

Instances

GLES => MonadDrawBuffers Draw

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

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

GLES => MonadRead GVec4 Draw

Methods

readColor :: (Int, Int, Int, Int) -> Draw GVec4 [Color]

readColorFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Vec4]

readDepth :: (Int, Int, Int, Int) -> Draw GVec4 [Word16]

readDepthFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Float]

readStencil :: (Int, Int, Int, Int) -> Draw GVec4 [Word8]

(FragmentShaderOutput o, GLES) => MonadDraw o Draw

Methods

withColorMask :: (Bool, Bool, Bool, Bool) -> Draw o a -> Draw o a

withDepthTest :: Bool -> Draw o a -> Draw o a

withDepthMask :: Bool -> Draw o a -> Draw o a

MonadBase IO (Draw o)

Methods

liftBase :: IO α -> Draw o α

MonadBaseControl IO (Draw o)

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)

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)

Methods

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

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

Applicative (Draw o)

Methods

pure :: a -> Draw o a

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

liftA2 :: (a -> b -> c) -> Draw o a -> Draw o b -> Draw o c

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

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

MonadIO (Draw o)

Methods

liftIO :: IO a -> Draw o a

GLES => MonadTexture (Draw o)

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

GLES => MonadScreen (Draw o)

Methods

currentViewport :: Draw o (Int, Int)

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

GLES => MonadCulling (Draw o)

Methods

withCulling :: Maybe CullFace -> Draw o a -> Draw o a

type StM (Draw o) a

type StM (Draw o) a

data DrawState

The state of the Draw monad.

Running the Draw monad

runDraw

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

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

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

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

Instances

(FragmentShaderOutput o, GLES) => MonadDraw o Draw

Methods

withColorMask :: (Bool, Bool, Bool, Bool) -> Draw o a -> Draw o a

withDepthTest :: Bool -> Draw o a -> Draw o a

withDepthMask :: Bool -> Draw o a -> Draw o a

class MonadDrawBuffers m where

Monads that support drawing to GBuffers and DepthBuffers.

Minimal complete definition

drawBuffers, drawBuffers'

Methods

drawBuffers

Arguments

:: Int

Width of the buffers.

-> Int

Height of the buffers.

-> Either (GBuffer t o) (GBufferInfo o)

The buffer that will contain the output of the fragment shader. Either a previously used buffer, or the info of a new buffer that drawBuffers will create. Do not reuse buffers with a different width or height than the one you specified with the previous argument.

-> Either (DepthBuffer t') DepthBufferInfo

The buffer that contains the depth (and stencil) values.

-> m o a

Image to draw to the buffers.

-> (forall t. GBuffer t o -> DepthBuffer t -> a -> m o' b)

-> m o' b

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)

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

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

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

class MonadDraw o m => MonadRead o m where

Minimal complete definition

readColor, readColorFloat, readDepth, readDepthFloat, readStencil

Methods

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

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

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

readColor variant that read color vectors.

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

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

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

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

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

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

Instances

GLES => MonadRead GVec4 Draw

Methods

readColor :: (Int, Int, Int, Int) -> Draw GVec4 [Color]

readColorFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Vec4]

readDepth :: (Int, Int, Int, Int) -> Draw GVec4 [Word16]

readDepthFloat :: (Int, Int, Int, Int) -> Draw GVec4 [Float]

readStencil :: (Int, Int, Int, Int) -> Draw GVec4 [Word8]

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

Minimal complete definition

currentViewport, resizeViewport

Methods

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

Resize the drawing space.

Instances

GLES => MonadScreen (Draw o)

Methods

currentViewport :: Draw o (Int, Int)

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

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

Clear the color buffer.

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

Clear the depth buffer.

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

Clear the stencil buffer.

Culling

data CullFace

Constructors

CullFront

CullBack

CullFrontBack

Instances

Eq CullFace

Methods

(==) :: CullFace -> CullFace -> Bool

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

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

Minimal complete definition

withCulling

Methods

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

Instances

GLES => MonadCulling (Draw o)

Methods

withCulling :: Maybe CullFace -> Draw o a -> Draw o a

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

Constructors

Loaded r

Unloaded

Error String

Instances

Functor ResStatus

Methods

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

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

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

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

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

Manually allocate a Texture in the GPU.

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

Manually delete a Geometry from the GPU.

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

Manually delete a Texture from the GPU.

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

Check if a Geometry failed to load.

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

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