Graphics.Rendering.OpenGL.GL.CoordTrans

This module corresponds to section 2.11 (Coordinate Transformations) of the OpenGL 2.1 specs.

Controlling the Viewport

depthRange :: StateVar (GLclampd, GLclampd)

After clipping and division by w, depth coordinates range from -1 to 1, corresponding to the near and far clipping planes. depthRange specifies a linear mapping of the normalized depth coordinates in this range to window depth coordinates. Regardless of the actual depth buffer implementation, window coordinate depth values are treated as though they range from 0 through 1 (like color components). Thus, the values accepted by depthRange are both clamped to this range before they are accepted.

The initial setting of (0, 1) maps the near plane to 0 and the far plane to 1. With this mapping, the depth buffer range is fully utilized.

It is not necessary that the near value be less than the far value. Reverse mappings such as (1, 0) are acceptable.

data Position

A 2-dimensional position, measured in pixels.

Constructors

Position !GLint !GLint

Instances

Eq Position

Methods

(==) :: Position -> Position -> Bool

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

Ord Position

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Show Position

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

data Size

A 2-dimensional size, measured in pixels.

Constructors

Size !GLsizei !GLsizei

Instances

Eq Size

Methods

(==) :: Size -> Size -> Bool

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

Ord Size

Methods

compare :: Size -> Size -> Ordering

(<) :: Size -> Size -> Bool

(<=) :: Size -> Size -> Bool

(>) :: Size -> Size -> Bool

(>=) :: Size -> Size -> Bool

max :: Size -> Size -> Size

min :: Size -> Size -> Size

Show Size

Methods

showsPrec :: Int -> Size -> ShowS

show :: Size -> String

showList :: [Size] -> ShowS

viewport :: StateVar (Position, Size)

Controls the affine transformation from normalized device coordinates to window coordinates. The viewport state variable consists of the coordinates (x, y) of the lower left corner of the viewport rectangle, (in pixels, initial value (0,0)), and the size (width, height) of the viewport. When a GL context is first attached to a window, width and height are set to the dimensions of that window.

Let (xnd, ynd) be normalized device coordinates. Then the window coordinates (xw, yw) are computed as follows:

xw = (xnd + 1) (width / 2) + x

yw = (ynd + 1) (heigth / 2) + y

Viewport width and height are silently clamped to a range that depends on the implementation, see maxViewportDims.

maxViewportDims :: GettableStateVar Size

The implementation-dependent maximum viewport width and height.

Matrices

data MatrixMode

A matrix stack.

Constructors

Modelview GLsizei

The modelview matrix stack of the specified vertex unit.

Projection

The projection matrix stack.

Texture

The texture matrix stack.

Color

The color matrix stack.

MatrixPalette

The matrix palette stack.

Instances

Eq MatrixMode

Methods

(==) :: MatrixMode -> MatrixMode -> Bool

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

Ord MatrixMode

Methods

compare :: MatrixMode -> MatrixMode -> Ordering

(<) :: MatrixMode -> MatrixMode -> Bool

(<=) :: MatrixMode -> MatrixMode -> Bool

(>) :: MatrixMode -> MatrixMode -> Bool

(>=) :: MatrixMode -> MatrixMode -> Bool

max :: MatrixMode -> MatrixMode -> MatrixMode

min :: MatrixMode -> MatrixMode -> MatrixMode

Show MatrixMode

Methods

showsPrec :: Int -> MatrixMode -> ShowS

show :: MatrixMode -> String

showList :: [MatrixMode] -> ShowS

matrixMode :: StateVar MatrixMode

Controls which matrix stack is the target for subsequent matrix operations. The initial value is (Modelview 0).

data MatrixOrder

Constructors

ColumnMajor

RowMajor

Instances

Eq MatrixOrder

Methods

(==) :: MatrixOrder -> MatrixOrder -> Bool

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

Ord MatrixOrder

Methods

compare :: MatrixOrder -> MatrixOrder -> Ordering

(<) :: MatrixOrder -> MatrixOrder -> Bool

(<=) :: MatrixOrder -> MatrixOrder -> Bool

(>) :: MatrixOrder -> MatrixOrder -> Bool

(>=) :: MatrixOrder -> MatrixOrder -> Bool

max :: MatrixOrder -> MatrixOrder -> MatrixOrder

min :: MatrixOrder -> MatrixOrder -> MatrixOrder

Show MatrixOrder

Methods

showsPrec :: Int -> MatrixOrder -> ShowS

show :: MatrixOrder -> String

showList :: [MatrixOrder] -> ShowS

class Storable c => MatrixComponent c where

Minimal complete definition

getMatrix, loadMatrix, loadTransposeMatrix, multMatrix_, multTransposeMatrix, getUniformv, uniformMatrix4v, rotate, translate, scale

Methods

rotate :: c -> Vector3 c -> IO ()

translate :: Vector3 c -> IO ()

scale :: c -> c -> c -> IO ()

Instances

MatrixComponent GLfloat

Methods

getMatrix :: GetPNameMatrix p => p -> Ptr GLfloat -> IO ()

loadMatrix :: Ptr GLfloat -> IO ()

loadTransposeMatrix :: Ptr GLfloat -> IO ()

multMatrix_ :: Ptr GLfloat -> IO ()

multTransposeMatrix :: Ptr GLfloat -> IO ()

getUniformv :: GLuint -> GLint -> Ptr GLfloat -> IO ()

uniformMatrix4v :: GLint -> GLsizei -> GLboolean -> Ptr GLfloat -> IO ()

rotate :: GLfloat -> Vector3 GLfloat -> IO ()

translate :: Vector3 GLfloat -> IO ()

scale :: GLfloat -> GLfloat -> GLfloat -> IO ()

MatrixComponent GLdouble

Methods

getMatrix :: GetPNameMatrix p => p -> Ptr GLdouble -> IO ()

loadMatrix :: Ptr GLdouble -> IO ()

loadTransposeMatrix :: Ptr GLdouble -> IO ()

multMatrix_ :: Ptr GLdouble -> IO ()

multTransposeMatrix :: Ptr GLdouble -> IO ()

getUniformv :: GLuint -> GLint -> Ptr GLdouble -> IO ()

uniformMatrix4v :: GLint -> GLsizei -> GLboolean -> Ptr GLdouble -> IO ()

rotate :: GLdouble -> Vector3 GLdouble -> IO ()

translate :: Vector3 GLdouble -> IO ()

scale :: GLdouble -> GLdouble -> GLdouble -> IO ()

class Matrix m where

Methods

withNewMatrix :: MatrixComponent c => MatrixOrder -> (Ptr c -> IO ()) -> IO (m c)

Create a new matrix of the given order (containing undefined elements) and call the action to fill it with 4x4 elements.

withMatrix :: MatrixComponent c => m c -> (MatrixOrder -> Ptr c -> IO a) -> IO a

Call the action with the given matrix. Note: The action is not allowed to modify the matrix elements!

newMatrix :: MatrixComponent c => MatrixOrder -> [c] -> IO (m c)

getMatrixComponents :: MatrixComponent c => MatrixOrder -> m c -> IO [c]

Instances

Matrix GLmatrix

Methods

withNewMatrix :: MatrixComponent c => MatrixOrder -> (Ptr c -> IO ()) -> IO (GLmatrix c)

withMatrix :: MatrixComponent c => GLmatrix c -> (MatrixOrder -> Ptr c -> IO a) -> IO a

newMatrix :: MatrixComponent c => MatrixOrder -> [c] -> IO (GLmatrix c)

getMatrixComponents :: MatrixComponent c => MatrixOrder -> GLmatrix c -> IO [c]

matrix :: (Matrix m, MatrixComponent c) => Maybe MatrixMode -> StateVar (m c)

multMatrix :: (Matrix m, MatrixComponent c) => m c -> IO ()

data GLmatrix a

Instances

Matrix GLmatrix

Methods

withNewMatrix :: MatrixComponent c => MatrixOrder -> (Ptr c -> IO ()) -> IO (GLmatrix c)

withMatrix :: MatrixComponent c => GLmatrix c -> (MatrixOrder -> Ptr c -> IO a) -> IO a

newMatrix :: MatrixComponent c => MatrixOrder -> [c] -> IO (GLmatrix c)

getMatrixComponents :: MatrixComponent c => MatrixOrder -> GLmatrix c -> IO [c]

Eq (GLmatrix a)

Methods

(==) :: GLmatrix a -> GLmatrix a -> Bool

(/=) :: GLmatrix a -> GLmatrix a -> Bool

Ord (GLmatrix a)

Methods

compare :: GLmatrix a -> GLmatrix a -> Ordering

(<) :: GLmatrix a -> GLmatrix a -> Bool

(<=) :: GLmatrix a -> GLmatrix a -> Bool

(>) :: GLmatrix a -> GLmatrix a -> Bool

(>=) :: GLmatrix a -> GLmatrix a -> Bool

max :: GLmatrix a -> GLmatrix a -> GLmatrix a

min :: GLmatrix a -> GLmatrix a -> GLmatrix a

Show (GLmatrix a)

Methods

showsPrec :: Int -> GLmatrix a -> ShowS

show :: GLmatrix a -> String

showList :: [GLmatrix a] -> ShowS

MatrixComponent a => Uniform (GLmatrix a)

Note: uniformv expects all matrices to be in ColumnMajor form.

Methods

uniform :: UniformLocation -> StateVar (GLmatrix a)

uniformv :: UniformLocation -> GLsizei -> Ptr (GLmatrix a) -> IO ()

loadIdentity :: IO ()

ortho :: GLdouble -> GLdouble -> GLdouble -> GLdouble -> GLdouble -> GLdouble -> IO ()

frustum :: GLdouble -> GLdouble -> GLdouble -> GLdouble -> GLdouble -> GLdouble -> IO ()

depthClamp :: StateVar Capability

activeTexture :: StateVar TextureUnit

preservingMatrix :: IO a -> IO a

Push the current matrix stack down by one, duplicating the current matrix, excute the given action, and pop the current matrix stack, replacing the current matrix with the one below it on the stack (i.e. restoring it to its previous state). The returned value is that of the given action. Note that a round-trip to the server is probably required. For a more efficient version, see unsafePreservingMatrix.

unsafePreservingMatrix :: IO a -> IO a

A more efficient, but potentially dangerous version of preservingMatrix: The given action is not allowed to throw an exception or change the current matrix mode permanently.

stackDepth :: Maybe MatrixMode -> GettableStateVar GLsizei

maxStackDepth :: MatrixMode -> GettableStateVar GLsizei

Normal Transformation

rescaleNormal :: StateVar Capability

If rescaleNormal contains Enabled, normal vectors specified with normal are scaled by a scaling factor derived from the modelview matrix. rescaleNormal requires that the originally specified normals were of unit length, and that the modelview matrix contains only uniform scales for proper results. The initial value of rescaleNormal is Disabled.

normalize :: StateVar Capability

If normalize contains Enabled, normal vectors specified with normal are scaled to unit length after transformation. The initial value of normalize is Disabled.

Generating Texture Coordinates

data Plane a

Constructors

Plane !a !a !a !a

Instances

Eq a => Eq (Plane a)

Methods

(==) :: Plane a -> Plane a -> Bool

(/=) :: Plane a -> Plane a -> Bool

Ord a => Ord (Plane a)

Methods

compare :: Plane a -> Plane a -> Ordering

(<) :: Plane a -> Plane a -> Bool

(<=) :: Plane a -> Plane a -> Bool

(>) :: Plane a -> Plane a -> Bool

(>=) :: Plane a -> Plane a -> Bool

max :: Plane a -> Plane a -> Plane a

min :: Plane a -> Plane a -> Plane a

Show a => Show (Plane a)

Methods

showsPrec :: Int -> Plane a -> ShowS

show :: Plane a -> String

showList :: [Plane a] -> ShowS

Storable a => Storable (Plane a)

Methods

sizeOf :: Plane a -> Int

alignment :: Plane a -> Int

peekElemOff :: Ptr (Plane a) -> Int -> IO (Plane a)

pokeElemOff :: Ptr (Plane a) -> Int -> Plane a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Plane a)

pokeByteOff :: Ptr b -> Int -> Plane a -> IO ()

peek :: Ptr (Plane a) -> IO (Plane a)

poke :: Ptr (Plane a) -> Plane a -> IO ()

data TextureCoordName

Constructors

S

T

R

Q

Instances

Eq TextureCoordName

Methods

(==) :: TextureCoordName -> TextureCoordName -> Bool

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

Ord TextureCoordName

Methods

compare :: TextureCoordName -> TextureCoordName -> Ordering

(<) :: TextureCoordName -> TextureCoordName -> Bool

(<=) :: TextureCoordName -> TextureCoordName -> Bool

(>) :: TextureCoordName -> TextureCoordName -> Bool

(>=) :: TextureCoordName -> TextureCoordName -> Bool

max :: TextureCoordName -> TextureCoordName -> TextureCoordName

min :: TextureCoordName -> TextureCoordName -> TextureCoordName

Show TextureCoordName

Methods

showsPrec :: Int -> TextureCoordName -> ShowS

show :: TextureCoordName -> String

showList :: [TextureCoordName] -> ShowS

data TextureGenMode

Constructors

EyeLinear (Plane GLdouble)

ObjectLinear (Plane GLdouble)

SphereMap

NormalMap

ReflectionMap

Instances

Eq TextureGenMode

Methods

(==) :: TextureGenMode -> TextureGenMode -> Bool

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

Ord TextureGenMode

Methods

compare :: TextureGenMode -> TextureGenMode -> Ordering

(<) :: TextureGenMode -> TextureGenMode -> Bool

(<=) :: TextureGenMode -> TextureGenMode -> Bool

(>) :: TextureGenMode -> TextureGenMode -> Bool

(>=) :: TextureGenMode -> TextureGenMode -> Bool

max :: TextureGenMode -> TextureGenMode -> TextureGenMode

min :: TextureGenMode -> TextureGenMode -> TextureGenMode

Show TextureGenMode

Methods

showsPrec :: Int -> TextureGenMode -> ShowS

show :: TextureGenMode -> String

showList :: [TextureGenMode] -> ShowS

textureGenMode :: TextureCoordName -> StateVar (Maybe TextureGenMode)