Portability | portable |
---|---|
Stability | stable |
Maintainer | sven.panne@aedion.de |
This module corresponds to section 2.6 (Begin/End Paradigm) of the OpenGL 2.1 specs.
- data PrimitiveMode
- = Points
- | Lines
- | LineLoop
- | LineStrip
- | Triangles
- | TriangleStrip
- | TriangleFan
- | Quads
- | QuadStrip
- | Polygon
- renderPrimitive :: PrimitiveMode -> IO a -> IO a
- unsafeRenderPrimitive :: PrimitiveMode -> IO a -> IO a
- primitiveRestart :: IO ()
- data EdgeFlag
- edgeFlag :: StateVar EdgeFlag
Begin and End Objects
data PrimitiveMode Source
Specification of the way the vertices given during renderPrimitive
are
interpreted. In the description of the constructors, n is an integer count
starting at one, and N is the total number of vertices specified.
Points | Treats each vertex as a single point. Vertex n defines point n. N points are drawn. |
Lines | Treats each pair of vertices as an independent line segment. Vertices 2n-1 and 2n define line n. N/2 lines are drawn. |
LineLoop | Draws a connected group of line segments from the first vertex to the last, then back to the first. Vertices n and n+1 define line n. The last line, however, is defined by vertices N and 1. N lines are drawn. |
LineStrip | Draws a connected group of line segments from the first vertex to the last. Vertices n and n+1 define line n. N-1 lines are drawn. |
Triangles | Treats each triplet of vertices as an independent triangle. Vertices 3n-2, 3n-1, and 3n define triangle n. N\3/ triangles are drawn. |
TriangleStrip | Draws a connected group of triangles. One triangle is defined for each vertex presented after the first two vertices. For odd n, vertices n, n+1, and n+2 define triangle n. For even n, vertices n+1, n, and n+2 define triangle n. N-2 triangles are drawn. |
TriangleFan | Draws a connected group of triangles. One triangle is defined for each vertex presented after the first two vertices. Vertices 1, n+1, and n+2 define triangle n. N-2 triangles are drawn. |
Quads | Treats each group of four vertices as an independent quadrilateral. Vertices 4n-3, 4n-2, 4n-1, and 4n define quadrilateral n. N/4 quadrilaterals are drawn. |
QuadStrip | Draws a connected group of quadrilaterals. One quadrilateral is defined for each pair of vertices presented after the first pair. Vertices 2n-1, 2n, 2n+2, and 2n+1 define quadrilateral n. N/2-1 quadrilaterals are drawn. Note that the order in which vertices are used to construct a quadrilateral from strip data is different from that used with independent data. |
Polygon | Draws a single, convex polygon. Vertices 1 through N define this polygon. |
renderPrimitive :: PrimitiveMode -> IO a -> IO aSource
Delimit the vertices that define a primitive or a group of like primitives.
Only a subset of GL commands can be used in the delimited action:
Those for specifying vertex coordinates
(Graphics.Rendering.OpenGL.GL.VertexSpec.vertex
,
Graphics.Rendering.OpenGL.GL.VertexSpec.vertexv
),
vertex colors
(Graphics.Rendering.OpenGL.GL.VertexSpec.color
,
Graphics.Rendering.OpenGL.GL.VertexSpec.colorv
,
Graphics.Rendering.OpenGL.GL.VertexSpec.secondaryColor
,
Graphics.Rendering.OpenGL.GL.VertexSpec.secondaryColorv
,
Graphics.Rendering.OpenGL.GL.VertexSpec.index
,
Graphics.Rendering.OpenGL.GL.VertexSpec.indexv
),
normal
(Graphics.Rendering.OpenGL.GL.VertexSpec.normal
,
Graphics.Rendering.OpenGL.GL.VertexSpec.normalv
),
texture coordinates
(Graphics.Rendering.OpenGL.GL.VertexSpec.texCoord
,
Graphics.Rendering.OpenGL.GL.VertexSpec.texCoordv
,
Graphics.Rendering.OpenGL.GL.VertexSpec.multiTexCoord
,
Graphics.Rendering.OpenGL.GL.VertexSpec.multiTexCoordv
),
and fog coordinates
(Graphics.Rendering.OpenGL.GL.VertexSpec.fogCoord
,
Graphics.Rendering.OpenGL.GL.VertexSpec.fogCoordv
).
Additionally,
Graphics.Rendering.OpenGL.GL.Evaluators.evalPoint1
,
Graphics.Rendering.OpenGL.GL.Evaluators.evalPoint2
,
Graphics.Rendering.OpenGL.GL.Evaluators.evalCoord1
,
Graphics.Rendering.OpenGL.GL.Evaluators.evalCoord1v
,
Graphics.Rendering.OpenGL.GL.Evaluators.evalCoord2
,
Graphics.Rendering.OpenGL.GL.Evaluators.evalCoord2v
,
Graphics.Rendering.OpenGL.GL.Colors.materialAmbient
,
Graphics.Rendering.OpenGL.GL.Colors.materialDiffuse
,
Graphics.Rendering.OpenGL.GL.Colors.materialAmbientAndDiffuse
,
Graphics.Rendering.OpenGL.GL.Colors.materialSpecular
,
Graphics.Rendering.OpenGL.GL.Colors.materialEmission
,
Graphics.Rendering.OpenGL.GL.Colors.materialShininess
,
Graphics.Rendering.OpenGL.GL.DisplayLists.callList
,
Graphics.Rendering.OpenGL.GL.DisplayLists.callLists
,
and setting edgeFlag
are allowed. Writing the respective state variables
is allowed in the delimited action, too.
Regardless of the chosen PrimitiveMode
, there is no limit to the number of
vertices that can be defined during a single renderPrimitive
. Lines,
triangles, quadrilaterals, and polygons that are incompletely specified are
not drawn. Incomplete specification results when either too few vertices are
provided to specify even a single primitive or when an incorrect multiple of
vertices is specified. The incomplete primitive is ignored; the rest are
drawn.
The minimum specification of vertices for each primitive is as follows: 1
for a point, 2 for a line, 3 for a triangle, 4 for a quadrilateral, and 3 for
a polygon. Modes that require a certain multiple of vertices are Lines
(2),
Triangles
(3), Quads
(4), and QuadStrip
(2).
unsafeRenderPrimitive :: PrimitiveMode -> IO a -> IO aSource
A more efficient, but potentially dangerous version of renderPrimitive
:
The given action is not allowed to throw an exception.
Polygon Edges
A vertex can begin an edge which lies in the interior of its polygon or on the polygon's boundary.
edgeFlag :: StateVar EdgeFlagSource
Each vertex of a polygon, separate triangle, or separate quadrilateral
specified during renderPrimitive
is marked as the start of either a boundary
or nonboundary (interior) edge.
The vertices of connected triangles and connected quadrilaterals are always marked as boundary, regardless of the value of the edge flag.
Boundary and nonboundary edge flags on vertices are significant only if
Graphics.Rendering.OpenGL.GL.Polygons.polygonMode
is set to
Graphics.Rendering.OpenGL.GL.Polygons.Point
or
Graphics.Rendering.OpenGL.GL.Polygons.Line
.
Note that the current edge flag can be updated at any time, in particular
during renderPrimitive
.