Safe Haskell	None
Language	Haskell2010

Graphics.Rendering.Ombra.Generic

Contents

Objects
Groups
Layers
- Sublayers
Shaders
Geometries
Textures
- Colors

Synopsis

Objects

data Object gs is where Source #

A geometry associated with some uniforms.

Constructors

(:~>) :: Global g -> Object gs is -> Object (g ': gs) is infixr 2

class MemberGlobal g gs where Source #

Minimal complete definition

(~~>)

Methods

(~~>) :: Uniform S g => (Draw (CPU S g) -> Global g) -> Object gs is -> Object gs is infixr 2 Source #

Modify the global of an Object. This doesn't work with mirror globals.

Instances

((~) Bool ((==) * g g1) False, MemberGlobal g gs) => MemberGlobal g ((:) * g1 gs) Source #
Methods (~~>) :: Uniform (S * ) g => (Draw (CPU (S ) g) -> Global g) -> Object (( ': g1) gs) is -> Object ((* ': g1) gs) is Source #
MemberGlobal g ((:) * g gs) Source #
Methods (~~>) :: Uniform (S * ) g => (Draw (CPU (S ) g) -> Global g) -> Object (( ': g) gs) is -> Object ((* ': g) gs) is Source #

class RemoveGlobal g gs gs' where Source #

Minimal complete definition

(*~>)

Methods

(*~>) :: (a -> g) -> Object gs is -> Object gs' is infixr 2 Source #

Remove a global from an Object.

Instances

RemoveGlobal g ((:) * g gs) gs Source #
Methods (~>) :: (a -> g) -> Object (( ': g) gs) is -> Object gs is Source #
((~) Bool ((==) * g g1) False, RemoveGlobal g gs gs') => RemoveGlobal g ((:) * g1 gs) ((:) * g1 gs') Source #
Methods (~>) :: (a -> g) -> Object (( ': g1) gs) is -> Object ((* ': g1) gs') is Source #

nothing :: Object '[] '[] Source #

An empty object.

geom :: Geometry i -> Object '[] i Source #

An object with a specified Geometry.

modifyGeometry :: Empty is ~ False => (Geometry is -> Geometry is') -> Object gs is -> Object gs is' Source #

Modify the geometry of an Object.

Groups

data Group gs is Source #

A group of Objects.

group :: (ShaderVars gs, ShaderVars is) => [Object gs is] -> Group gs is Source #

Create a Group from a list of Objects.

(~~) :: (EqualMerge gs gs' (Text "globals"), EqualMerge is is' (Text "inputs")) => Group gs is -> Group gs' is' -> Group (Union gs gs') (Union is is') Source #

Merge two groups.

groupEmpty :: Group gs is Source #

An empty group.

groupGlobal :: Global g -> Group gs is -> Group (g ': gs) is Source #

Set a global uniform for a Group.

depthTest :: Bool -> Group gs is -> Group gs is Source #

Enable/disable depth testing for a Group.

depthMask :: Bool -> Group gs is -> Group gs is Source #

Enable/disable writing into the depth buffer for a Group.

colorMask :: (Bool, Bool, Bool, Bool) -> Group gs is -> Group gs is Source #

Enable/disable writing into the four channels of the color buffer for a Group.

type ShaderVars = Set ShaderVar Source #

A type-level set of ShaderVars.

type VOShaderVars o = (ShaderVars o, ShaderVars (VertexShaderOutput ': o)) Source #

ShaderVars for the output of VartexShader.

Blending

blend :: Mode -> Group gs is -> Group gs is Source #

Enable blending and set the blending mode for a Group of objects.

noBlend :: Group gs is -> Group gs is Source #

Disable blending for a Group.

transparency :: Mode Source #

Standard transparency (default).

additive :: Mode Source #

Additive blend mode.

Stencil test

stencil :: Mode -> Group gs is -> Group gs is Source #

Enable stencil testing and set the stencil mode for a Group of objects.

noStencil :: Group gs is -> Group gs is Source #

Disable stencil testing on a Group of objects.

Culling

data CullFace Source #

Constructors

CullFront
CullBack
CullFrontBack

Instances

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

cull :: CullFace -> Group gs is -> Group gs is Source #

Enable face culling.

noCull :: Group gs is -> Group gs is Source #

Disable face culling.

Layers

data Buffer Source #

Constructors

ColorBuffer
DepthBuffer
StencilBuffer

data Layer Source #

A Group associated with a program.

layer :: (Subset progAttr grpAttr, Subset progUni grpUni) => Program progUni progAttr -> Group grpUni grpAttr -> Layer Source #

Associate a group with a program.

over :: Layer -> Layer -> Layer infixl 1 Source #

Draw the first Layer over the second one. The first Layer will use the same buffers (color, depth, stencil) of the second one.

clear :: [Buffer] -> Layer -> Layer Source #

Clear some buffers before drawing a Layer.

Sublayers

subLayer :: Int -> Int -> Layer -> (Texture -> Layer) -> Layer Source #

Alias for colorSubLayer.

colorSubLayer Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a `Texture`.
-> (Texture -> Layer)	Layers using the texture.
-> Layer

Use a Layer as a Texture on another.

depthSubLayer Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a depth `Texture`.
-> (Texture -> Layer)	Layers using the texture.
-> Layer

Use a Layer as a depth Texture on another.

colorDepthSubLayer Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on the `Texture`s.
-> (Texture -> Texture -> Layer)	Color, depth.
-> Layer

Combination of colorSubLayer and depthSubLayer.

colorStencilSubLayer Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a `Texture`
-> (Texture -> Layer)	Color.
-> Layer

colorSubLayer with a stencil buffer.

colorSubLayer' Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a `Texture`.
-> Int	First pixel to read X
-> Int	First pixel to read Y
-> Int	Width of the rectangle to read
-> Int	Height of the rectangle to read
-> (Texture -> [Color] -> Layer)	Function using the texture.
-> Layer

Extended version of colorSubLayer that reads and converts the Texture pixels.

depthSubLayer' Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a depth `Texture`.
-> Int	First pixel to read X
-> Int	First pixel to read Y
-> Int	Width of the rectangle to read
-> Int	Height of the rectangle to read
-> (Texture -> [Word8] -> Layer)	Layers using the texture.
-> Layer

Extended version of depthSubLayer. Not supported on WebGL.

colorDepthSubLayer' Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a `Texture`
-> Int	First pixel to read X
-> Int	First pixel to read Y
-> Int	Width of the rectangle to read
-> Int	Height of the rectangle to read
-> (Texture -> Texture -> [Color] -> [Word8] -> Layer)	Layers using the texture.
-> Layer

Extended version of colorDepthSubLayer. Not supported on WebGL.

colorStencilSubLayer' Source #

Arguments

:: Int	Texture width.
-> Int	Texture height.
-> Layer	Layer to draw on a `Texture`.
-> Int	First pixel to read X
-> Int	First pixel to read Y
-> Int	Width of the rectangle to read
-> Int	Height of the rectangle to read
-> (Texture -> [Color] -> Layer)	Function using the texture.
-> Layer

colorSubLayer' with an additional stencil buffer.

buffersSubLayer Source #

Arguments

:: Int	Textures width.
-> Int	Textures height.
-> Int	Number of colors.
-> Layer	Layer to draw.
-> ([Texture] -> Layer)	Function using the textures.
-> Layer

Render a Layer with multiple floating point colors (use Fragment2, Fragment3, etc.) in some Textures and use them to create another Layer.

buffersDepthSubLayer Source #

Arguments

:: Int	Textures width.
-> Int	Textures height.
-> Int	Number of colors.
-> Layer	Layer to draw.
-> ([Texture] -> Texture -> Layer)	Function using the buffers textures and the depth texture.
-> Layer

Combination of buffersSubLayer and depthSubLayer.

buffersStencilSubLayer Source #

Arguments

:: Int	Textures width.
-> Int	Textures height.
-> Int	Number of colors.
-> Layer	Layer to draw.
-> ([Texture] -> Layer)	Function using the texture.
-> Layer

buffersSubLayer with an additional stencil buffer.

Shaders

type Compatible pgs vgs fgs = EqualOrErr pgs (Union vgs fgs) ((((Text "Incompatible shader uniforms" :$$: (Text " Vertex shader uniforms: " :<>: ShowType vgs)) :$$: (Text " Fragment shader uniforms: " :<>: ShowType fgs)) :$$: (Text " United shader uniforms: " :<>: ShowType (Union vgs fgs))) :$$: (Text " Program uniforms: " :<>: ShowType pgs)) Source #

Compatible shaders.

data Program gs is Source #

A vertex shader associated with a compatible fragment shader.

Instances

Eq (Program gs is) Source #
Methods (==) :: Program gs is -> Program gs is -> Bool # (/=) :: Program gs is -> Program gs is -> Bool #
Hashable (Program gs is) Source #
Methods hashWithSalt :: Int -> Program gs is -> Int # hash :: Program gs is -> Int #

program :: (ShaderVars vgs, ShaderVars vis, VOShaderVars os, ShaderVars fgs, Compatible pgs vgs fgs) => VertexShader vgs vis os -> FragmentShader fgs os -> Program pgs vis Source #

Create a Program from the shaders.

data Global g Source #

The value of a GPU uniform.

(-=) :: (ShaderVar g, Uniform S g) => (a -> g) -> CPU S g -> Global g infixr 4 Source #

Create a Global from a pure value. The first argument is ignored, it just provides the type (you can use the constructor of the GPU type). You can use this to set the value of a shader uniform.

globalTexture :: (Uniform S g, CPU S g ~ ActiveTexture, ShaderVar g, GLES) => (a -> g) -> Texture -> Global g Source #

Create a Global of CPU type ActiveTexture using a Texture.

globalTexSize :: (ShaderVar g, Uniform S g, GLES) => (a -> g) -> Texture -> ((Int, Int) -> CPU S g) -> Global g Source #

Create a Global using the size of a Texture.

globalFramebufferSize :: (ShaderVar g, Uniform S g) => (a -> g) -> (Vec2 -> CPU S g) -> Global g Source #

Create a Global using the size of the framebuffer.

type family CPUMirror g Source #

The mirror type of a certain global.

For instance:

     data T = T Vec3 Float -- In the shader module
     data T = T Vec3 Float -- CPU version of the uniform type
     type CPUMirror GPU.T = T

globalMirror :: (ShaderVar g, Uniform M g) => Proxy g -> CPU M g -> Global g Source #

Like -= but for mirror types.

globalMirror' Source #

Arguments

:: (GLES, ShaderVar g, Uniform M g)
=> Proxy g
-> [Texture]	Textures to make active. Remember that the CPU version of `Sampler2D` is `ActiveTexture`, not `Texture`.
-> ([(ActiveTexture, (Int, Int))] -> Vec2 -> CPU M g)	Function that, given a list of active textures (the same passed in the second argument) and their size, and the framebuffer value, build the CPU value of the global.
-> Global g

Extended version of globalMirror.

Geometries

data Geometry is Source #

A set of attributes and indices.

Instances

Eq (Geometry is) Source #
Methods (==) :: Geometry is -> Geometry is -> Bool # (/=) :: Geometry is -> Geometry is -> Bool #
Hashable (Geometry is) Source #
Methods hashWithSalt :: Int -> Geometry is -> Int # hash :: Geometry is -> Int #

data AttrList is where Source #

A heterogeneous list of attributes.

Constructors

AttrListNil :: AttrList '[]
AttrListCons :: (Hashable (CPU S i), Attribute S i) => (a -> i) -> [CPU S i] -> AttrList is -> AttrList (i ': is)

Instances

Hashable (AttrList is) Source #
Methods hashWithSalt :: Int -> AttrList is -> Int # hash :: AttrList is -> Int #

mkGeometry :: AttrList is -> [Word16] -> Geometry is Source #

Create a custom Geometry.

extend Source #

Arguments

:: (Attribute S i, Hashable (CPU S i), ShaderType i, GLES)
=> (a -> i)	Attribute constructor (or any other function with that type).
-> [CPU S i]	List of values
-> Geometry is
-> Geometry (i ': is)

Add an attribute to a geometry.

remove Source #

Arguments

:: (RemoveAttr i is is', GLES)
=> (a -> i)	Attribute constructor (or any other function with that type).
-> Geometry is
-> Geometry is'

Remove an attribute from a geometry.

Textures

data Texture Source #

A texture.

Instances

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

data ActiveTexture Source #

A Texture ready to be passed as an uniform.

mkTexture Source #

Arguments

:: GLES
=> Int	Width.
-> Int	Height.
-> [Color]	List of pixels
-> Texture

Creates a Texture from a list of pixels.

mkTextureFloat Source #

Arguments

:: GLES
=> Int	Width.
-> Int	Height.
-> [Vec4]	List of vectors.
-> Texture

Creates a float Texture from a list of vectors.

data Filter Source #

Constructors

Linear	Average of the four nearest pixels.
Nearest	Nearest pixel.

Instances

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

setFilter :: Filter -> Filter -> Texture -> Texture Source #

Change the Texture minifying and magnifying functions. This doesn't work on sublayer textures.

Colors

data Color Source #

An RGBA 32-bit color.

Constructors

Color !Word8 !Word8 !Word8 !Word8

Instances

Eq Color Source #
Methods (==) :: Color -> Color -> Bool # (/=) :: Color -> Color -> Bool #
Show Color Source #
Methods showsPrec :: Int -> Color -> ShowS # show :: Color -> String # showList :: [Color] -> ShowS #
Storable Color Source #
Methods sizeOf :: Color -> Int # alignment :: Color -> Int # peekElemOff :: Ptr Color -> Int -> IO Color # pokeElemOff :: Ptr Color -> Int -> Color -> IO () # peekByteOff :: Ptr b -> Int -> IO Color # pokeByteOff :: Ptr b -> Int -> Color -> IO () # peek :: Ptr Color -> IO Color # poke :: Ptr Color -> Color -> IO () #
Hashable Color Source #
Methods hashWithSalt :: Int -> Color -> Int # hash :: Color -> Int #

colorTex :: GLES => Color -> Texture Source #

Generate a 1x1 texture.

class (Integral GLEnum, Integral GLUInt, Integral GLInt, Integral GLSize, Bits GLEnum, Num GLEnum, Num GLUInt, Num GLInt, Num GLPtrDiff, Num GLSize, Eq GLEnum, Eq GLUInt, Eq GLInt, Eq GLPtrDiff, Eq GLSize, Eq Texture) => GLES Source #

Backend API.

Minimal complete definition

module Data.Vect.Float

module Graphics.Rendering.Ombra.Color