OGL-0.0.3: A context aware binding for the OpenGL graphics system

Portabilityportable
Stabilitystable
Maintainersven.panne@aedion.de

Graphics.Rendering.OGL.GL.VertexSpec

Contents

Description

This module corresponds to section 2.7 (Vertex Specification) of the OpenGL 2.1 specs.

Synopsis

Vertex Coordinates

class Vertex a whereSource

Specify the (x, y, z, w) coordinates of a four-dimensional vertex. This must only be done during Graphics.Rendering.OGL.GL.BeginEnd.renderPrimitive, otherwise the behaviour is unspecified. The current values of the auxiliary vertex attributes are associated with the vertex.

Note that there is no such thing as a "current vertex" which could be retrieved.

Methods

vertex :: a -> PrimitiveGL ()Source

vertexv :: Ptr a -> PrimitiveGL ()Source

Instances

class VertexComponent a Source

The class of all types which can be used as a vertex coordinate.

Instances

data Vertex2 a Source

A vertex with z=0 and w=1.

Constructors

Vertex2 !a !a 

Instances

data Vertex3 a Source

A vertex with w=1.

Constructors

Vertex3 !a !a !a 

Instances

data Vertex4 a Source

A fully-fledged four-dimensional vertex.

Constructors

Vertex4 !a !a !a !a 

Instances

Auxiliary Vertex Attributes

Apart from its coordinates in four-dimensional space, every vertex has associated auxiliary attributes: Its texture coordinates, a normal, a fog coordinate, and a color plus a secondary color. For every attribute, the OpenGL state contains its current value, which can be changed at any time.

Every attribute has a "natural" format via which it can be manipulated directly as part of the OpenGL state, e.g. the current texture coordinates are internally handled as TexCoord4 GLfloat. Different formats are converted to this format, e.g. the s, r, and t coordinates of a TexCoord3 GLint are converted to floating point values and a q coordinate of 1.0 is implicitly assumed.

Consequently, the vast majority of classes, functions, and data types in this module are for convenience only and offer no additional functionality.

Texture Coordinates

currentTextureCoords :: StateVar (TexCoord4 GLfloat)Source

The current texture coordinates (s, t, r, q) for the current texture unit (see Graphics.Rendering.OGL.GL.CoordTrans.activeTexture). The initial value is (0,0,0,1) for all texture units.

class TexCoord a whereSource

Change the current texture coordinates of the current or given texture unit.

Methods

texCoord :: MonadGL m => a -> m ()Source

texCoordv :: MonadGL m => Ptr a -> m ()Source

multiTexCoord :: MonadGL m => TextureUnit -> a -> m ()Source

multiTexCoordv :: MonadGL m => TextureUnit -> Ptr a -> m ()Source

Instances

class TexCoordComponent a Source

The class of all types which can be used as a texture coordinate.

Instances

newtype TexCoord1 a Source

Texture coordinates with t=0, r=0, and q=1.

Constructors

TexCoord1 a 

Instances

data TexCoord2 a Source

Texture coordinates with r=0 and q=1.

Constructors

TexCoord2 !a !a 

Instances

data TexCoord3 a Source

Texture coordinates with q=1.

Constructors

TexCoord3 !a !a !a 

Instances

data TexCoord4 a Source

Fully-fledged four-dimensional texture coordinates.

Constructors

TexCoord4 !a !a !a !a 

Instances

Normal

currentNormal :: StateVar (Normal3 GLfloat)Source

The current normal (x, y, z). The initial value is the unit vector (0, 0, 1).

class Normal a whereSource

Change the current normal. Integral arguments are converted to floating-point with a linear mapping that maps the most positive representable integer value to 1.0, and the most negative representable integer value to -1.0.

Normals specified with normal or normalv need not have unit length. If Graphics.Rendering.OGL.GL.CoordTrans.normalize is enabled, then normals of any length specified with normal or normalv are normalized after transformation. If Graphics.Rendering.OGL.GL.CoordTrans.rescaleNormal is enabled, normals are scaled by a scaling factor derived from the modelview matrix. Graphics.Rendering.OGL.GL.CoordTrans.rescaleNormal requires that the originally specified normals were of unit length, and that the modelview matrix contains only uniform scales for proper results. Normalization is initially disabled.

Methods

normal :: MonadGL m => a -> m ()Source

normalv :: MonadGL m => Ptr a -> m ()Source

Instances

class NormalComponent a Source

The class of all types which can be used as a component of a normal.

Instances

data Normal3 a Source

Constructors

Normal3 !a !a !a 

Instances

Fog Coordinate

currentFogCoord :: StateVar (FogCoord1 GLfloat)Source

The current fog coordinate. The initial value is 0.

class FogCoord a whereSource

Change the current fog coordinate.

Methods

fogCoord :: MonadGL m => a -> m ()Source

fogCoordv :: MonadGL m => Ptr a -> m ()Source

Instances

class FogCoordComponent a Source

The class of all types which can be used as the fog coordinate.

Instances

newtype FogCoord1 a Source

A fog coordinate.

Constructors

FogCoord1 a 

Instances

Color and Secondary Color

rgbaMode :: GettableStateVar BoolSource

If rgbaMode contains True, the color buffers store RGBA value. If color indexes are stored, it contains False.

currentColor :: StateVar (Color4 GLfloat)Source

class Color a whereSource

Change the current color.

Methods

color :: MonadGL m => a -> m ()Source

colorv :: MonadGL m => Ptr a -> m ()Source

Instances

currentSecondaryColor :: StateVar (Color3 GLfloat)Source

class SecondaryColor a whereSource

Change the current secondary color.

Methods

secondaryColor :: MonadGL m => a -> m ()Source

secondaryColorv :: MonadGL m => Ptr a -> m ()Source

Instances

class ColorComponent a Source

The class of all types which can be used as a color component.

Instances

data Color3 a Source

Constructors

Color3 !a !a !a 

Instances

data Color4 a Source

A fully-fledged RGBA color.

Constructors

Color4 !a !a !a !a 

Instances

currentIndex :: StateVar (Index1 GLint)Source

class Index a whereSource

Change the current color index.

Methods

index :: MonadGL m => a -> m ()Source

indexv :: MonadGL m => Ptr a -> m ()Source

Instances

class IndexComponent a Source

The class of all types which can be used as a color index.

Instances

newtype Index1 a Source

A color index.

Constructors

Index1 a 

Instances

Generic Vertex Attributes

newtype AttribLocation Source

Constructors

AttribLocation GLuint 

Instances

class VertexAttrib a Source

Instances

class VertexAttribComponent a whereSource

The class of all types which can be used as a generic vertex attribute.

Methods

vertexAttrib1 :: AttribLocation -> a -> PrimitiveGL ()Source

vertexAttrib2 :: AttribLocation -> a -> a -> PrimitiveGL ()Source

vertexAttrib3 :: AttribLocation -> a -> a -> a -> PrimitiveGL ()Source

vertexAttrib4 :: AttribLocation -> a -> a -> a -> a -> PrimitiveGL ()Source

vertexAttrib1v :: AttribLocation -> Ptr a -> PrimitiveGL ()Source

vertexAttrib2v :: AttribLocation -> Ptr a -> PrimitiveGL ()Source

vertexAttrib3v :: AttribLocation -> Ptr a -> PrimitiveGL ()Source

vertexAttrib4v :: AttribLocation -> Ptr a -> PrimitiveGL ()Source

Instances

Texture Units

newtype TextureUnit Source

Identifies a texture unit via its number, which must be in the range of (0 .. maxTextureUnit).

Constructors

TextureUnit GLuint 

Instances

maxTextureUnit :: GettableStateVar TextureUnitSource

An implementation must support at least 2 texture units, but it may support up to 32 ones. This state variable can be used to query the actual implementation limit.