FWGL.Graphics.D3

Simplified 3D graphics system.

Elements

data Element

A 3D object with a Texture and a transformation.

cube :: GLES => Texture -> Element

A cube with a specified Texture.

Geometry

data Geometry is

A set of attributes and indices.

Instances

Eq (Geometry is)

Hashable (Geometry is)

type Geometry3 = `[Position3, UV, Normal3]`

A 3D geometry.

geom :: Texture -> Geometry Geometry3 -> Element

An element with a specified Geometry and Texture.

mkGeometry3

Arguments

:: GLES

=> [V3]

List of vertices.

-> [V2]

List of UV coordinates.

-> [V3]

List of normals.

-> [Word16]

Triangles expressed as triples of indices to the three lists above.

-> Geometry Geometry3

Create a 3D Geometry. The first three lists should have the same length.

Textures

module FWGL.Graphics.Color

data Texture

A texture.

Instances

GLES => Eq Texture

textureURL

Arguments

:: String

URL

-> Texture

Creates a Texture from an URL or a local file.

textureFile :: String -> Texture

The same as textureURL.

colorTex :: GLES => Color -> Texture

Generate a 1x1 texture.

mkTexture

Arguments

:: GLES

=> Int

Width.

-> Int

Height.

-> [Color]

List of pixels

-> Texture

Creates a Texture from a list of pixels.

Transformations

data V3

Three-dimensional vector.

Constructors

V3 !Float !Float !Float

Instances

Eq V3

Show V3

Storable V3

Hashable V3

GLES => AttributeCPU V3 V3

GLES => AttributeCPU CV3 Normal3

GLES => AttributeCPU CV3 Position3

GLES => UniformCPU V3 V3

pos :: V3 -> Element -> Element

Translate an Element.

rotX :: Float -> Element -> Element

Rotate an Element around the X axis.

rotY :: Float -> Element -> Element

Rotate an Element around the X axis.

rotZ :: Float -> Element -> Element

Rotate an Element around the X axis.

rotAA :: V3 -> Float -> Element -> Element

Rotate an Element around an axis and an angle.

scale :: Float -> Element -> Element

Scale an Element.

scaleV :: V3 -> Element -> Element

Scale an Element in three dimensions.

transform :: M4 -> Element -> Element

Transform an Element.

Layers

data Layer

An object associated with a program. It can also be a layer included in another.

Element layers

elements :: BackendIO => [Element] -> Layer

Create a standard Layer from a list of Elements.

view :: BackendIO => M4 -> [Element] -> Layer

Create a Layer from a view matrix and a list of Elements.

Object layers

data Program gs is

A vertex shader associated with a compatible fragment shader.

Instances

Eq (Program gs is)

Hashable (Program gs is)

layer :: BackendIO => Object DefaultUniforms3D Geometry3 -> Layer

Create a Layer from a 3D Object, using the default shader.

layerPrg :: (BackendIO, Subset og pg) => Program pg Geometry3 -> Object og Geometry3 -> Layer

Create a Layer from a 3D Object, using a custom shader.

program :: (ValidVertex vgs vis vos, Valid fgs vos [], Equal pgs (Union vgs fgs)) => VertexShader vgs vis vos -> FragmentShader fgs vos -> Program pgs vis

Create a Program from the shaders.

Sublayers

subLayer

Arguments

:: Int

Texture width.

-> Int

Texture height.

-> Layer

Layer to draw on a Texture.

-> (Texture -> [Layer])

Layer to draw on the screen.

-> Layer

Use a Layer as a Texture on another.

depthSubLayer

Arguments

:: Int

Texture width.

-> Int

Texture height.

-> Layer

Layer to draw on a Texture.

-> (Texture -> [Layer])

Layer to draw on the screen.

-> Layer

Use the depth Layer as a Texture on another.

Custom 3D objects

data Object gs is

An object is a set of geometries associated with some uniforms. For example, if you want to draw a rotating cube, its vertices, normals, etc. would be the Geometry, the combination of the geometry and the value of the model matrix would be the Object, and the combination of the object with a Program would be the Layer. In fact, Objects are just descriptions of the actions to perform to draw something. Instead, the Element types in FWGL.Graphics.D2 and FWGL.Graphics.D3 represent managed (high level) objects, and they are ultimately converted to them.

object :: BackendIO => M4 -> [Element] -> Object DefaultUniforms3D Geometry3

Create a graphical Object from a list of Elements and a view matrix.

object1 :: BackendIO => Element -> Object `[Transform3, Texture2]` Geometry3

Create a graphical Object from a single Element. This lets you set your own globals individually. If the shader uses the view matrix View3 (e.g. the default 3D shader), you have to set it with viewObject.

object1Trans :: BackendIO => Element -> Object `[Transform3]` Geometry3

Like object1, but it will only set the transformation matrix.

object1Tex :: BackendIO => Element -> Object `[Texture2]` Geometry3

Like 'object1, but it will only set the texture.

(~~) :: (Equal gs gs', Equal is is') => Object gs is -> Object gs' is' -> Object (Union gs gs') (Union is is')

Join two objects.

Globals

global :: (Typeable g, UniformCPU c g) => g -> c -> Object gs is -> Object (g : gs) is

Sets a global variable (uniform) of an object.

globalTexture :: (BackendIO, Typeable g, UniformCPU ActiveTexture g) => g -> Texture -> Object gs is -> Object (g : gs) is

Sets a global (uniform) of an object using a Texture.

globalTexSize :: (BackendIO, Typeable g, UniformCPU c g) => g -> Texture -> ((Int, Int) -> c) -> Object gs is -> Object (g : gs) is

Sets a global (uniform) of an object using the dimensions of a Texture.

viewObject :: BackendIO => M4 -> Object gs Geometry3 -> Object (View3 : gs) Geometry3

Set the value of the view matrix of a 3D Object.

type DefaultUniforms3D = Uniforms

The uniforms used in the default 3D program.

data Texture2

Instances

ShaderType Texture2

Typeable * Texture2

GLES => UniformCPU CSampler2D Texture2

data Transform3

Instances

ShaderType Transform3

Typeable * Transform3

GLES => UniformCPU CM4 Transform3

data View3

Instances

ShaderType View3

Typeable * View3

GLES => UniformCPU CM4 View3

3D matrices

data V4

Four-dimensional vector.

Constructors

V4 !Float !Float !Float !Float

Instances

Eq V4

Show V4

Storable V4

Hashable V4

GLES => AttributeCPU V4 V4

GLES => UniformCPU V4 V4

data M4

4x4 matrix.

Constructors

M4 !V4 !V4 !V4 !V4

Instances

Eq M4

Show M4

GLES => UniformCPU M4 M4

GLES => UniformCPU CM4 View3

GLES => UniformCPU CM4 Transform3

mat4 :: (Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float, Float) -> M4

Create a 4x4 matrix.

mul4 :: M4 -> M4 -> M4

4x4 matrix multiplication.

View matrices

perspectiveMat4

Arguments

:: Float

Far

-> Float

Near

-> Float

FOV

-> Float

Aspect ratio

-> M4

4x4 perspective projection matrix.

orthoMat4

Arguments

:: Float

Far

-> Float

Near

-> Float

Left

-> Float

Right

-> Float

Bottom

-> Float

Top

-> M4

4x4 orthographic projection matrix.

cameraMat4

Arguments

:: V3

Eye

-> Float

Pitch

-> Float

Yaw

-> M4

4x4 FPS camera matrix.

lookAtMat4 :: V3 -> V3 -> V3 -> M4

4x4 "look at" camera matrix.

Transformation matrices

idMat4 :: M4

4x4 identity matrix.

transMat4 :: V3 -> M4

4x4 translation matrix.

rotXMat4 :: Float -> M4

4x4 rotation matrix (X axis).

rotYMat4 :: Float -> M4

4x4 rotation matrix (Y axis).

rotZMat4 :: Float -> M4

4x4 rotation matrix (Z axis).

rotAAMat4

Arguments

:: V3

Axis.

-> Float

Angle

-> M4

4x4 rotation matrix.

scaleMat4 :: V3 -> M4

4x4 scale matrix.