Module BGL

Module BGL

The Blender.BGL submodule (the OpenGL wrapper).

The Blender.BGL submodule

This module wraps OpenGL constants and functions, making them available from within Blender Python.

The complete list can be retrieved from the module itself, by listing its contents: dir(Blender.BGL). A simple search on the net can point to more than enough material to teach OpenGL programming, from books to many collections of tutorials.

The "red book": "OpenGL Programming Guide: The Official Guide to Learning OpenGL" and the online NeHe tutorials are two of the best resources.

Example:

 import Blender
 from Blender.BGL import *
 from Blender import Draw
 R = G = B = 0
 A = 1
 instructions = "Hold mouse buttons to change the background color."
 quitting = " Press ESC or q to quit."
 #
 def show_win():
   glClearColor(R,G,B,A)                # define color used to clear buffers 
   glClear(GL_COLOR_BUFFER_BIT)         # use it to clear the color buffer
   glColor3f(1,1,1)                     # change default color
   glRasterPos2i(50,100)                # move cursor to x = 50, y = 100
   Draw.Text("Testing BGL  + Draw")     # draw this text there
   glRasterPos2i(350,20)                # move cursor again
   Draw.Text(instructions + quitting)   # draw another msg
   glBegin(GL_LINE_LOOP)                # begin a vertex-data list
   glVertex2i(46,92)
   glVertex2i(120,92)
   glVertex2i(120,115)
   glVertex2i(46,115)
   glEnd()                              # close this list
   glColor3f(0.35,0.18,0.92)            # change default color again
   glBegin(GL_POLYGON)                  # another list, for a polygon
   glVertex2i(315, 292)
   glVertex2i(412, 200)
   glVertex2i(264, 256)
   glEnd()
   Draw.Redraw(1)                       # make changes visible.
 #
 def ev(evt, val):                     # this is a callback for Draw.Register()
   global R,G,B,A                       # ... it handles input events
   if evt == Draw.ESCKEY or evt == Draw.QKEY:
     Draw.Exit()                        # this quits the script
   elif evt == Draw.LEFTMOUSE: R = 1 - R
   elif evt == Draw.MIDDLEMOUSE: G = 1 - G
   elif evt == Draw.RIGHTMOUSE: B = 1 - B
   else:
     Draw.Register(show_win, ev, None)
 #
   Draw.Register(show_win, ev, None)     # start the main loop

See Also:: www.opengl.org, nehe.gamedev.net

Classes
`Buffer`	The Buffer object is simply a block of memory that is delineated and initalized by the user.

Function Summary
	`glAccum(op, value)` Operate on the accumulation buffer
	`glAlphaFunc(func, ref)` Specify the alpha test function
	`glAreTexturesResident(n, textures, residences)` Determine if textures are loaded in texture memory
	`glBegin(mode)` Delimit the vertices of a primitive or a group of like primatives
	`glBindTexture(target, texture)` Bind a named texture to a textureing target
	`glBitmap(width, height, xorig, yorig, xmove, ymove, bitmap)` Draw a bitmap
	`glBlendFunc(sfactor, dfactor)` Specify pixel arithmetic
	`glCallList(list)` Execute a display list
	`glCallLists(n, type, lists)` Execute a list of display lists
	`glClear(mask)` Clear buffers to preset values
	`glClearAccum(red, green, blue, alpha)` Specify clear values for the accumulation buffer
	`glClearColor(red, green, blue, alpha)` Specify clear values for the color buffers
	`glClearDepth(depth)` Specify the clear value for the depth buffer
	`glClearIndex(c)` Specify the clear value for the color index buffers
	`glClearStencil(s)` Specify the clear value for the stencil buffer
	`glClipPlane(plane, equation)` Specify a plane against which all geometery is clipped
	`glColor(red, green, blue, alpha)` glColor3b, glColor3d, glColor3f, glColor3i, glColor3s, glColor3ub, glColor3ui, glColor3us, glColor4b, glColor4d, glColor4f, glColor4i, glColor4s, glColor4ub, glColor4ui, glColor4us, glColor3bv, glColor3dv, glColor3fv, glColor3iv, glColor3sv, glColor3ubv, glColor3uiv, glColor3usv, glColor4bv, glColor4dv, glColor4fv, glColor4iv, glColor4sv, glColor4ubv, glColor4uiv, glColor4usv
	`glColorMask(red, green, blue, alpha)` Enable and disable writing of frame buffer color components
	`glColorMaterial(face, mode)` Cause a material color to track the current color
	`glCopyPixels(x, y, width, height, type)` Copy pixels in the frame buffer
	`glCullFace(mode)` Specify whether front- or back-facing facets can be culled
	`glDeleteLists(list, range)` Delete a contiguous group of display lists
	`glDeleteTextures(n, textures)` Delete named textures
	`glDepthFunc(func)` Specify the value used for depth buffer comparisons
	`glDepthMask(flag)` Enable or disable writing into the depth buffer
	`glDepthRange(zNear, zFar)` Specify mapping of depth values from normalized device coordinates to window coordinates
	`glDisable(cap)` Disable server-side GL capabilities
	`glDrawBuffer(mode)` Specify which color buffers are to be drawn into
	`glDrawPixels(width, height, format, type, pixels)` Write a block of pixels to the frame buffer
	`glEdgeFlag(flag)` glEdgeFlag, glEdgeFlagv
	`glEnable(cap)` Enable server-side GL capabilities
	`glEnd()` Delimit the vertices of a primitive or group of like primitives
	`glEndList()` Create or replace a display list
	`glEvalCoord(u, v)` glEvalCoord1d, glEvalCoord1f, glEvalCoord2d, glEvalCoord2f, glEvalCoord1dv, glEvalCoord1fv, glEvalCoord2dv, glEvalCoord2fv
	`glEvalMesh(mode, i1, i2)` glEvalMesh1 or glEvalMesh2
	`glEvalPoint(i, j)` glEvalPoint1 and glEvalPoint2
	`glFeedbackBuffer(size, type, buffer)` Controls feedback mode
	`glFinish()` Block until all GL execution is complete
	`glFlush()` Force Execution of GL commands in finite time
	`glFog(pname, param)` glFogf, glFogi, glFogfv, glFogiv
	`glFrontFace(mode)` Define front- and back-facing polygons
	`glFrustum(left, right, bottom, top, zNear, zFar)` Multiply the current matrix by a perspective matrix
	`glGenLists(range)` Generate a contiguous set of empty display lists
	`glGenTextures(n, textures)` Generate texture names
	`glGet(pname, param)` glGetBooleanv, glGetfloatv, glGetFloatv, glGetIntegerv
	`glGetClipPlane(plane, equation)` Return the coefficients of the specified clipping plane
	`glGetError()` Return error information
	`glGetLight(light, pname, params)` glGetLightfv and glGetLightiv
	`glGetMap(target, query, v)` glGetMapdv, glGetMapfv, glGetMapiv
	`glGetMaterial(face, pname, params)` glGetMaterialfv, glGetMaterialiv
	`glGetPixelMap(map, values)` glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv
	`glGetPolygonStipple(mask)` Return the polygon stipple pattern
	`glGetString(name)` Return a strin describing the current GL connection
	`glGetTexEnv(target, pname, params)` glGetTexEnvfv, glGetTexEnviv
	`glGetTexGen(coord, pname, params)` glGetTexGendv, glGetTexGenfv, glGetTexGeniv
	`glGetTexImage(target, level, format, type, pixels)` Return a texture image
	`glGetTexLevelParameter(target, level, pname, params)` glGetTexLevelParameterfv, glGetTexLevelParameteriv
	`glGetTexParameter(target, pname, params)` glGetTexParameterfv, glGetTexParameteriv
	`glHint(target, mode)` Specify implementation-specific hints
	`glIndex(c)` glIndexd, glIndexf, glIndexi, glIndexs, glIndexdv, glIndexfv, glIndexiv, glIndexsv
	`glInitNames()` Initialize the name stack
	`glIsEnabled(cap)` Test whether a capability is enabled
	`glIsList(list)` Determine if a name corresponds to a display-list
	`glIsTexture(texture)` Determine if a name corresponds to a texture
	`glLight(light, pname, param)` glLightf,glLighti, glLightfv, glLightiv
	`glLightModel(pname, param)` glLightModelf, glLightModeli, glLightModelfv, glLightModeliv
	`glLineStipple(factor, pattern)` Specify the line stipple pattern
	`glLineWidth(width)` Specify the width of rasterized lines.
	`glListBase(base)` Set the display-list base for glCallLists
	`glLoadIdentity()` Replace the current matrix with the identity matrix
	`glLoadMatrix(m)` glLoadMatrixd, glLoadMatixf
	`glLoadName(name)` Load a name onto the name stack.
	`glLogicOp(opcode)` Specify a logical pixel operation for color index rendering
	`glMap1(target, u1, u2, stride, order, points)` glMap1d, glMap1f
	`glMap2(target, u1, u2, ustride, uorder, v1, v2, vstride, vorder, points)` glMap2d, glMap2f
	`glMapGrid(un, u1, u2, vn, v1, v2)` glMapGrid1d, glMapGrid1f, glMapGrid2d, glMapGrid2f
	`glMaterial(face, pname, params)` Specify material parameters for the lighting model.
	`glMatrixMode(mode)` Specify which matrix is the current matrix.
	`glMultMatrix(m)` glMultMatrixd, glMultMatrixf
	`glNewList(list, mode)` Create or replace a display list
	`glNormal3(nx, ny, nz, v)` Normal3b, Normal3bv, Normal3d, Normal3dv, Normal3f, Normal3fv, Normal3i, Normal3iv, Normal3s, Normal3sv
	`glOrtho(left, right, bottom, top, zNear, zFar)` Multiply the current matrix with an orthographic matrix
	`glPassThrough(token)` Place a marker in the feedback buffer
	`glPixelMap(map, mapsize, values)` glPixelMapfv, glPixelMapuiv, glPixelMapusv
	`glPixelStore(pname, param)` glPixelStoref, glPixelStorei
	`glPixelTransfer(pname, param)` glPixelTransferf, glPixelTransferi
	`glPixelZoom(xfactor, yfactor)` Specify the pixel zoom factors
	`glPointSize(size)` Specify the diameter of rasterized points
	`glPolygonMode(face, mode)` Select a polygon rasterization mode
	`glPolygonOffset(factor, units)` Set the scale and units used to calculate depth values
	`glPolygonStipple(mask)` Set the polygon stippling pattern
	`glPopAttrib()` Pop the server attribute stack
	`glPopMatrix()` Pop the current matrix stack
	`glPopName()` Pop the name stack
	`glPrioritizeTextures(n, textures, priorities)` Set texture residence priority
	`glPushAttrib(mask)` Push the server attribute stack
	`glPushMatrix()` Push the current matrix stack
	`glPushName(name)` Push the name stack
	`glRasterPos(x, y, z, w)` glRasterPos2d, glRasterPos2f, glRasterPos2i, glRasterPos2s, glRasterPos3d, glRasterPos3f, glRasterPos3i, glRasterPos3s, glRasterPos4d, glRasterPos4f, glRasterPos4i, glRasterPos4s, glRasterPos2dv, glRasterPos2fv, glRasterPos2iv, glRasterPos2sv, glRasterPos3dv, glRasterPos3fv, glRasterPos3iv, glRasterPos3sv, glRasterPos4dv, glRasterPos4fv, glRasterPos4iv, glRasterPos4sv
	`glReadBuffer(mode)` Select a color buffer source for pixels.
	`glReadPixels(x, y, width, height, format, type, pixels)` Read a block of pixels from the frame buffer
	`glRect(x1, y1, x2, y2, v1, v2)` glRectd, glRectf, glRecti, glRects, glRectdv, glRectfv, glRectiv, glRectsv
	`glRenderMode(mode)` Set rasterization mode
	`glRotate(angle, x, y, z)` glRotated, glRotatef
	`glScale(x, y, z)` glScaled, glScalef
	`glScissor(x, y, width, height)` Define the scissor box
	`glSelectBuffer(size, buffer)` Establish a buffer for selection mode values
	`glShadeModel(mode)` Select flat or smooth shading
	`glStencilFuc(func, ref, mask)` Set function and reference value for stencil testing
	`glStencilMask(mask)` Control the writing of individual bits in the stencil planes
	`glStencilOp(fail, zfail, zpass)` Set stencil test actions
	`glTexCoord(s, t, r, q, v)` glTexCoord1d, glTexCoord1f, glTexCoord1i, glTexCoord1s, glTexCoord2d, glTexCoord2f, glTexCoord2i, glTexCoord2s, glTexCoord3d, glTexCoord3f, glTexCoord3i, glTexCoord3s, glTexCoord4d, glTexCoord4f, glTexCoord4i, glTexCoord4s, glTexCoord1dv, glTexCoord1fv, glTexCoord1iv, glTexCoord1sv, glTexCoord2dv, glTexCoord2fv, glTexCoord2iv, glTexCoord2sv, glTexCoord3dv, glTexCoord3fv, glTexCoord3iv, glTexCoord3sv, glTexCoord4dv, glTexCoord4fv, glTexCoord4iv, glTexCoord4sv
	`glTexEnv(target, pname, param)` glTextEnvf, glTextEnvi, glTextEnvfv, glTextEnviv
	`glTexGen(coord, pname, param)` glTexGend, glTexGenf, glTexGeni, glTexGendv, glTexGenfv, glTexGeniv
	`glTexImage1D(target, level, internalformat, width, border, format, type, pixels)` Specify a one-dimensional texture image
	`glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels)` Specify a two-dimensional texture image
	`glTexParameter(target, pname, param)` glTexParameterf, glTexParameteri, glTexParameterfv, glTexParameteriv
	`glTranslate(x, y, z)` glTranslatef, glTranslated
	`glVertex(x, y, z, w, v)` glVertex2d, glVertex2f, glVertex2i, glVertex2s, glVertex3d, glVertex3f, glVertex3i, glVertex3s, glVertex4d, glVertex4f, glVertex4i, glVertex4s, glVertex2dv, glVertex2fv, glVertex2iv, glVertex2sv, glVertex3dv, glVertex3fv, glVertex3iv, glVertex3sv, glVertex4dv, glVertex4fv, glVertex4iv, glVertex4sv
	`glViewport(x, y, width, height)` Set the viewport

Function Details

glAccum(op, value)

Operate on the accumulation buffer

Parameters:: op - The accumulation buffer operation.
(type=Enumerated constant); value - a value used in the accumulation buffer operation.
(type=float)

glAlphaFunc(func, ref)

Specify the alpha test function

Parameters:: func - Specifies the alpha comparison function.
(type=Enumerated constant); ref - The reference value that incoming alpha values are compared to. Clamped between 0 and 1.
(type=float)

glAreTexturesResident(n, textures, residences)

Determine if textures are loaded in texture memory

Parameters:: n - Specifies the number of textures to be queried.
(type=int); textures - Specifies an array containing the names of the textures to be queried
(type=Buffer object type GL_INT); residences - An array in which the texture residence status in returned.The residence status of a texture named by an element of textures is returned in the corresponding element of residences.
(type=Buffer object type GL_INT(boolean))

glBegin(mode)

Delimit the vertices of a primitive or a group of like primatives

Parameters:: mode - Specifies the primitive that will be create from vertices between glBegin and glEnd.
(type=Enumerated constant)

glBindTexture(target, texture)

Bind a named texture to a textureing target

Parameters:: target - Specifies the target to which the texture is bound.
(type=Enumerated constant); texture - Specifies the name of a texture.
(type=unsigned int)

glBitmap(width, height, xorig, yorig, xmove, ymove, bitmap)

Draw a bitmap

Parameters:: width, height - Specify the pixel width and height of the bitmap image.
(type of width=int)
(type of height=int); xorig, yorig - Specify the location of the origin in the bitmap image. The origin is measured from the lower left cornere of the bitmap, with right and up beigng the positive axes.
(type of xorig=float)
(type of yorig=float); xmove, ymove - Specify the x and y offsets to be added to the current raster position after the bitmap is drawn.
(type of xmove=float)
(type of ymove=float); bitmap - Specifies the address of the bitmap image.
(type=Buffer object type GL_BYTE)

glBlendFunc(sfactor, dfactor)

Specify pixel arithmetic

Parameters:: sfactor - Specifies how the red, green, blue, and alpha source blending factors are computed.
(type=Enumerated constant); dfactor - Specifies how the red, green, blue, and alpha destination blending factors are computed.
(type=Enumerated constant)

glCallList(list)

Execute a display list

Parameters:: list - Specifies the integer name of the display list to be executed.
(type=unsigned int)

glCallLists(n, type, lists)

Execute a list of display lists

Parameters:: n - Specifies the number of display lists to be executed.
(type=int); type - Specifies the type of values in lists.
(type=Enumerated constant); lists - Specifies the address of an array of name offsets in the display list. The pointer type is void because the offsets can be bytes, shorts, ints, or floats, depending on the value of type.
(type=Buffer object)

glClear(mask)

Clear buffers to preset values

Parameters:: mask - Bitwise OR of masks that indicate the buffers to be cleared.
(type=Enumerated constant(s))

glClearAccum(red, green, blue, alpha)

Specify clear values for the accumulation buffer

Parameters:: red, green, blue, alpha - Specify the red, green, blue, and alpha values used when the accumulation buffer is cleared. The initial values are all 0.
           (type of red=float)
           (type of green=float)
           (type of blue=float)
           (type of alpha=float)

glClearColor(red, green, blue, alpha)

Specify clear values for the color buffers

Parameters:: red, green, blue, alpha - Specify the red, green, blue, and alpha values used when the color buffers are cleared. The initial values are all 0.
           (type of red=float)
           (type of green=float)
           (type of blue=float)
           (type of alpha=float)

glClearDepth(depth)

Specify the clear value for the depth buffer

Parameters:: depth - Specifies the depth value used when the depth buffer is cleared. The initial value is 1.
(type=int)

glClearIndex(c)

Specify the clear value for the color index buffers

Parameters:: c - Specifies the index used when the color index buffers are cleared. The initial value is 0.
(type=float)

glClearStencil(s)

Specify the clear value for the stencil buffer

Parameters:: s - Specifies the index used when the stencil buffer is cleared. The initial value is 0.
(type=int)

glClipPlane(plane, equation)

Specify a plane against which all geometery is clipped

Parameters:: plane - Specifies which clipping plane is being positioned.
(type=Enumerated constant); equation - Specifies the address of an array of four double- precision floating-point values. These values are interpreted as a plane equation.
(type=Buffer object type GL_FLOAT(double))

glColor(red, green, blue, alpha)

glColor3b, glColor3d, glColor3f, glColor3i, glColor3s, glColor3ub, glColor3ui, glColor3us, glColor4b, glColor4d, glColor4f, glColor4i, glColor4s, glColor4ub, glColor4ui, glColor4us, glColor3bv, glColor3dv, glColor3fv, glColor3iv, glColor3sv, glColor3ubv, glColor3uiv, glColor3usv, glColor4bv, glColor4dv, glColor4fv, glColor4iv, glColor4sv, glColor4ubv, glColor4uiv, glColor4usv

Set a new color.

Parameters:: red, green, blue - Specify new red, green, and blue values for the current color.
           (type of red=Depends on function prototype.)
           (type of green=Depends on function prototype.)
           (type of blue=Depends on function prototype.); alpha - Specifies a new alpha value for the current color. Included only in the four-argument glColor4 commands. (With '4' colors only)
(type=Depends on function prototype.)

glColorMask(red, green, blue, alpha)

Enable and disable writing of frame buffer color components

Parameters:: red, green, blue, alpha - Specify whether red, green, blue, and alpha can or cannot be written into the frame buffer. The initial values are all GL_TRUE, indicating that the color components can be written.
           (type of red=int (boolean))
           (type of green=int (boolean))
           (type of blue=int (boolean))
           (type of alpha=int (boolean))

glColorMaterial(face, mode)

Cause a material color to track the current color

Parameters:: face - Specifies whether front, back, or both front and back material parameters should track the current color.
(type=Enumerated constant); mode - Specifies which of several material parameters track the current color.
(type=Enumerated constant)

glCopyPixels(x, y, width, height, type)

Copy pixels in the frame buffer

Parameters:: x, y - Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied.
(type of x=int)
(type of y=int); width, height - Specify the dimensions of the rectangular region of pixels to be copied. Both must be non-negative.
(type of width=int)
(type of height=int); type - Specifies whether color values, depth values, or stencil values are to be copied.
(type=Enumerated constant)

glCullFace(mode)

Specify whether front- or back-facing facets can be culled

Parameters:: mode - Specifies whether front- or back-facing facets are candidates for culling.
(type=Enumerated constant)

glDeleteLists(list, range)

Delete a contiguous group of display lists

Parameters:: list - Specifiex the integer name of the first display list to delete
(type=unsigned int); range - Specifies the number of display lists to delete
(type=int)

glDeleteTextures(n, textures)

Delete named textures

Parameters:: n - Specifes the number of textures to be deleted
(type=int); textures - Specifies an array of textures to be deleted
(type=Buffer GL_INT)

glDepthFunc(func)

Specify the value used for depth buffer comparisons

Parameters:: func - Specifies the depth comparison function.
(type=Enumerated constant)

glDepthMask(flag)

Enable or disable writing into the depth buffer

Parameters:: flag - Specifies whether the depth buffer is enabled for writing. If flag is GL_FALSE, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled.
(type=int (boolean))

glDepthRange(zNear, zFar)

Specify mapping of depth values from normalized device coordinates to window coordinates

Parameters:: zNear - Specifies the mapping of the near clipping plane to window coordinates. The initial value is 0.
(type=int); zFar - Specifies the mapping of the far clipping plane to window coordinates. The initial value is 1.
(type=int)

glDisable(cap)

Disable server-side GL capabilities

Parameters:: cap - Specifies a symbolic constant indicating a GL capability.
(type=Enumerated constant)

glDrawBuffer(mode)

Specify which color buffers are to be drawn into

Parameters:: mode - Specifies up to four color buffers to be drawn into.
(type=Enumerated constant)

glDrawPixels(width, height, format, type, pixels)

Write a block of pixels to the frame buffer

Parameters:: width, height - Specify the dimensions of the pixel rectangle to be written into the frame buffer.
(type of width=int)
(type of height=int); format - Specifies the format of the pixel data.
(type=Enumerated constant); type - Specifies the data type for pixels.
(type=Enumerated constant); pixels - Specifies a pointer to the pixel data.
(type=Buffer object)

glEdgeFlag(flag)

glEdgeFlag, glEdgeFlagv

Flag edges as either boundary or nonboundary

Parameters:: flag - Specifies the current edge flag value.The initial value is GL_TRUE.
(type=Depends of function prototype)

glEnable(cap)

Enable server-side GL capabilities

Parameters:: cap - Specifies a symbolic constant indicating a GL capability.
(type=Enumerated constant)

glEnd()

Delimit the vertices of a primitive or group of like primitives

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/begin.html

glEndList()

Create or replace a display list

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/newlist.html

glEvalCoord(u, v)

glEvalCoord1d, glEvalCoord1f, glEvalCoord2d, glEvalCoord2f, glEvalCoord1dv, glEvalCoord1fv, glEvalCoord2dv, glEvalCoord2fv

Evaluate enabled one- and two-dimensional maps

Parameters:: u - Specifies a value that is the domain coordinate u to the basis function defined in a previous glMap1 or glMap2 command. If the function prototype ends in 'v' then u specifies a pointer to an array containing either one or two domain coordinates. The first coordinate is u. The second coordinate is v, which is present only in glEvalCoord2 versions.
(type=Depends on function prototype.); v - Specifies a value that is the domain coordinate v to the basis function defined in a previous glMap2 command. This argument is not present in a glEvalCoord1 command.
(type=Depends on function prototype. (only with '2' prototypes))

glEvalMesh(mode, i1, i2)

glEvalMesh1 or glEvalMesh2

Compute a one- or two-dimensional grid of points or lines

Parameters:: mode - In glEvalMesh1, specifies whether to compute a one-dimensional mesh of points or lines.
(type=Enumerated constant); i1, i2 - Specify the first and last integer values for the grid domain variable i.
(type of i1=int)
(type of i2=int)

glEvalPoint(i, j)

glEvalPoint1 and glEvalPoint2

Generate and evaluate a single point in a mesh

Parameters:: i - Specifies the integer value for grid domain variable i.
(type=int); j - Specifies the integer value for grid domain variable j (glEvalPoint2 only).
(type=int (only with '2' prototypes))

glFeedbackBuffer(size, type, buffer)

Controls feedback mode

Parameters:: size
(type=int @param size:Specifies the maximum number of values that can be written into buffer.); type
(type=Enumerated constant @param type:Specifies a symbolic constant that describes the information that will be returned for each vertex.); buffer - Returns the feedback data.
(type=Buffer object GL_FLOAT)

glFinish()

Block until all GL execution is complete

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/finish.html

glFlush()

Force Execution of GL commands in finite time

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/flush.html

glFog(pname, param)

glFogf, glFogi, glFogfv, glFogiv

Specify fog parameters

Parameters:: pname - Specifies a single-valued fog parameter. If the function prototype ends in 'v' specifies a fog parameter.
(type=Enumerated constant); param - Specifies the value or values to be assigned to pname. GL_FOG_COLOR requires an array of four values. All other parameters accept an array containing only a single value.
(type=Depends on function prototype.)

glFrontFace(mode)

Define front- and back-facing polygons

Parameters:: mode - Specifies the orientation of front-facing polygons.
(type=Enumerated constant)

glFrustum(left, right, bottom, top, zNear, zFar)

Multiply the current matrix by a perspective matrix

Parameters:: left, right - Specify the coordinates for the left and right vertical clipping planes.
(type of left=double (float))
(type of right=double (float)); bottom, top - Specify the coordinates for the bottom and top horizontal clipping planes.
(type of bottom=double (float))
(type of top=double (float)); zNear, zFar - Specify the distances to the near and far depth clipping planes. Both distances must be positive.
(type of zNear=double (float))
(type of zFar=double (float))

glGenLists(range)

Generate a contiguous set of empty display lists

Parameters:: range - Specifies the number of contiguous empty display lists to be generated.
(type=int)

glGenTextures(n, textures)

Generate texture names

Parameters:: n - Specifies the number of textures name to be generated.
(type=int); textures - Specifies an array in which the generated textures names are stored.
(type=Buffer object type GL_INT)

glGet(pname, param)

glGetBooleanv, glGetfloatv, glGetFloatv, glGetIntegerv

Return the value or values of a selected parameter

Parameters:: pname - Specifies the parameter value to be returned.
(type=Enumerated constant); param - Returns the value or values of the specified parameter.
(type=Depends on function prototype.)

glGetClipPlane(plane, equation)

Return the coefficients of the specified clipping plane

Parameters:: plane - Specifies a clipping plane. The number of clipping planes depends on the implementation, but at least six clipping planes are supported. They are identified by symbolic names of the form GL_CLIP_PLANEi where 0 < i < GL_MAX_CLIP_PLANES.
(type=Enumerated constant); equation - Returns four float (double)-precision values that are the coefficients of the plane equation of plane in eye coordinates. The initial value is (0, 0, 0, 0).
(type=Buffer object type GL_FLOAT)

glGetError()

Return error information

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/geterror.html

glGetLight(light, pname, params)

glGetLightfv and glGetLightiv

Return light source parameter values

Parameters:: light - Specifies a light source. The number of possible lights depends on the implementation, but at least eight lights are supported. They are identified by symbolic names of the form GL_LIGHTi where 0 < i < GL_MAX_LIGHTS.
(type=Enumerated constant); pname - Specifies a light source parameter for light.
(type=Enumerated constant); params - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetMap(target, query, v)

glGetMapdv, glGetMapfv, glGetMapiv

Return evaluator parameters

Parameters:: target - Specifies the symbolic name of a map.
(type=Enumerated constant); query - Specifies which parameter to return.
(type=Enumerated constant); v - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetMaterial(face, pname, params)

glGetMaterialfv, glGetMaterialiv

Return material parameters

Parameters:: face - Specifies which of the two materials is being queried. representing the front and back materials, respectively.
(type=Enumerated constant); pname - Specifies the material parameter to return.
(type=Enumerated constant); params - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetPixelMap(map, values)

glGetPixelMapfv, glGetPixelMapuiv, glGetPixelMapusv

Return the specified pixel map

Parameters:: map - Specifies the name of the pixel map to return.
(type=Enumerated constant); values - Returns the pixel map contents.
(type=Buffer object. Depends on function prototype.)

glGetPolygonStipple(mask)

Return the polygon stipple pattern

Parameters:: mask - Returns the stipple pattern. The initial value is all 1's.
(type=Buffer object type GL_BYTE)

glGetString(name)

Return a strin describing the current GL connection

Parameters:: name - Specifies a symbolic constant.
(type=Enumerated constant)

glGetTexEnv(target, pname, params)

glGetTexEnvfv, glGetTexEnviv

Return texture environment parameters

Parameters:: target - Specifies a texture environment. Must be GL_TEXTURE_ENV.
(type=Enumerated constant); pname - Specifies the symbolic name of a texture environment parameter.
(type=Enumerated constant); params - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetTexGen(coord, pname, params)

glGetTexGendv, glGetTexGenfv, glGetTexGeniv

Return texture coordinate generation parameters

Parameters:: coord - Specifies a texture coordinate.
(type=Enumerated constant); pname - Specifies the symbolic name of the value(s) to be returned.
(type=Enumerated constant); params - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetTexImage(target, level, format, type, pixels)

Return a texture image

Parameters:: target - Specifies which texture is to be obtained.
(type=Enumerated constant); level - Specifies the level-of-detail number of the desired image. Level 0 is the base image level. Level n is the nth mipmap reduction image.
(type=int); format - Specifies a pixel format for the returned data.
(type=Enumerated constant); type - Specifies a pixel type for the returned data.
(type=Enumerated constant); pixels - Returns the texture image. Should be a pointer to an array of the type specified by type
(type=Buffer object.)

glGetTexLevelParameter(target, level, pname, params)

glGetTexLevelParameterfv, glGetTexLevelParameteriv

return texture parameter values for a specific level of detail

Parameters:: target - Specifies the symbolic name of the target texture.
(type=Enumerated constant); level - Specifies the level-of-detail number of the desired image. Level 0 is the base image level. Level n is the nth mipmap reduction image.
(type=int); pname - Specifies the symbolic name of a texture parameter.
(type=Enumerated constant); params - Returns the requested data.
(type=Buffer object. Depends on function prototype.)

glGetTexParameter(target, pname, params)

glGetTexParameterfv, glGetTexParameteriv

Return texture parameter values

Parameters:: target - Specifies the symbolic name of the target texture.
(type=Enumerated constant); pname - Specifies the symbolic name the target texture.
(type=Enumerated constant); params - Returns the texture parameters.
(type=Buffer object. Depends on function prototype.)

glHint(target, mode)

Specify implementation-specific hints

Parameters:: target - Specifies a symbolic constant indicating the behavior to be controlled.
(type=Enumerated constant); mode - Specifies a symbolic constant indicating the desired behavior.
(type=Enumerated constant)

glIndex(c)

glIndexd, glIndexf, glIndexi, glIndexs, glIndexdv, glIndexfv, glIndexiv, glIndexsv

Set the current color index

Parameters:: c - Specifies a pointer to a one element array that contains the new value for the current color index.
(type=Buffer object. Depends on function prototype.)

glInitNames()

Initialize the name stack

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/initnames.html

glIsEnabled(cap)

Test whether a capability is enabled

Parameters:: cap - Specifies a constant representing a GL capability.
(type=Enumerated constant)

glIsList(list)

Determine if a name corresponds to a display-list

Parameters:: list - Specifies a potential display-list name.
(type=unsigned int)

glIsTexture(texture)

Determine if a name corresponds to a texture

Parameters:: texture - Specifies a value that may be the name of a texture.
(type=unsigned int)

glLight(light, pname, param)

glLightf,glLighti, glLightfv, glLightiv

Set the light source parameters

Parameters:: light - Specifies a light. The number of lights depends on the implementation, but at least eight lights are supported. They are identified by symbolic names of the form GL_LIGHTi where 0 < i < GL_MAX_LIGHTS.
(type=Enumerated constant); pname - Specifies a single-valued light source parameter for light.
(type=Enumerated constant); param - Specifies the value that parameter pname of light source light will be set to. If function prototype ends in 'v' specifies a pointer to the value or values that parameter pname of light source light will be set to.
(type=Depends on function prototype.)

glLightModel(pname, param)

glLightModelf, glLightModeli, glLightModelfv, glLightModeliv

Set the lighting model parameters

Parameters:: pname - Specifies a single-value light model parameter.
(type=Enumerated constant); param - Specifies the value that param will be set to. If function prototype ends in 'v' specifies a pointer to the value or values that param will be set to.
(type=Depends on function prototype.)

glLineStipple(factor, pattern)

Specify the line stipple pattern

Parameters:: factor - Specifies a multiplier for each bit in the line stipple pattern. If factor is 3, for example, each bit in the pattern is used three times before the next bit in the pattern is used. factor is clamped to the range [1, 256] and defaults to 1.
(type=int); pattern - Specifies a 16-bit integer whose bit pattern determines which fragments of a line will be drawn when the line is rasterized. Bit zero is used first; the default pattern is all 1's.
(type=unsigned short int)

glLineWidth(width)

Specify the width of rasterized lines.

Parameters:: width - Specifies the width of rasterized lines. The initial value is 1.
(type=float)

glListBase(base)

Set the display-list base for glCallLists

Parameters:: base - Specifies an integer offset that will be added to glCallLists offsets to generate display-list names. The initial value is 0.
(type=unsigned int)

glLoadIdentity()

Replace the current matrix with the identity matrix

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/loadidentity.html

glLoadMatrix(m)

glLoadMatrixd, glLoadMatixf

Replace the current matrix with the specified matrix

Parameters:: m - Specifies a pointer to 16 consecutive values, which are used as the elements of a 4x4 column-major matrix.
(type=Buffer object. Depends on function prototype.)

glLoadName(name)

Load a name onto the name stack.

Parameters:: name - Specifies a name that will replace the top value on the name stack.
(type=unsigned int)

glLogicOp(opcode)

Specify a logical pixel operation for color index rendering

Parameters:: opcode - Specifies a symbolic constant that selects a logical operation.
(type=Enumerated constant)

glMap1(target, u1, u2, stride, order, points)

glMap1d, glMap1f

Define a one-dimensional evaluator

Parameters:: target - Specifies the kind of values that are generated by the evaluator.
(type=Enumerated constant); u1, u2 - Specify a linear mapping of u, as presented to glEvalCoord1, to ^, t he variable that is evaluated by the equations specified by this command.
(type of u1=Depends on function prototype.)
(type of u2=Depends on function prototype.); stride - Specifies the number of floats or float (double)s between the beginning of one control point and the beginning of the next one in the data structure referenced in points. This allows control points to be embedded in arbitrary data structures. The only constraint is that the values for a particular control point must occupy contiguous memory locations.
(type=int); order - Specifies the number of control points. Must be positive.
(type=int); points - Specifies a pointer to the array of control points.
(type=Buffer object. Depends on function prototype.)

glMap2(target, u1, u2, ustride, uorder, v1, v2, vstride, vorder, points)

glMap2d, glMap2f

Define a two-dimensional evaluator

Parameters:: target - Specifies the kind of values that are generated by the evaluator.
(type=Enumerated constant); u1, u2 - Specify a linear mapping of u, as presented to glEvalCoord2, to ^, t he variable that is evaluated by the equations specified by this command. Initally u1 is 0 and u2 is 1.
(type of u1=Depends on function prototype.)
(type of u2=Depends on function prototype.); ustride - Specifies the number of floats or float (double)s between the beginning of control point R and the beginning of control point R ij, where i and j are the u and v control pointiindices, respectively. This allows control points to be embedded in arbitrary data structures. The only constraint is that the values for a particular control point must occupy contiguous memory locations. The initial value of ustride is 0.
(type=int); uorder - Specifies the dimension of the control point array in the u axis. Must be positive. The initial value is 1.
(type=int); v1, v2 - Specify a linear mapping of v, as presented to glEvalCoord2, to ^, one of the two variables that are evaluated by the equations specified by this command. Initially, v1 is 0 and v2 is 1.
(type of v1=Depends on function prototype.)
(type of v2=Depends on function prototype.); vstride - Specifies the number of floats or float (double)s between the beginning of control point R and the beginning of control point R ij, where i and j are the u and v control point(indices, respectively. This allows control points to be embedded in arbitrary data structures. The only constraint is that the values for a particular control point must occupy contiguous memory locations. The initial value of vstride is 0.
(type=int); vorder - Specifies the dimension of the control point array in the v axis. Must be positive. The initial value is 1.
(type=int); points - Specifies a pointer to the array of control points.
(type=Buffer object. Depends on function prototype.)

glMapGrid(un, u1, u2, vn, v1, v2)

glMapGrid1d, glMapGrid1f, glMapGrid2d, glMapGrid2f

Define a one- or two-dimensional mesh

Parameters:: un - Specifies the number of partitions in the grid range interval [u1, u2]. Must be positive.
(type=int); u1, u2 - Specify the mappings for integer grid domain values i=0 and i=un.
(type of u1=Depends on function prototype.)
(type of u2=Depends on function prototype.); vn - Specifies the number of partitions in the grid range interval [v1, v2] (glMapGrid2 only).
(type=int); v1, v2 - Specify the mappings for integer grid domain values j=0 and j=vn (glMapGrid2 only).
(type of v1=Depends on function prototype.)
(type of v2=Depends on function prototype.)

glMaterial(face, pname, params)

Specify material parameters for the lighting model.

Parameters:: face - Specifies which face or faces are being updated. Must be one of:
(type=Enumerated constant); pname - Specifies the single-valued material parameter of the face or faces that is being updated. Must be GL_SHININESS.
(type=Enumerated constant); params - Specifies the value that parameter GL_SHININESS will be set to. If function prototype ends in 'v' specifies a pointer to the value or values that pname will be set to.
(type=int)

glMatrixMode(mode)

Specify which matrix is the current matrix.

Parameters:: mode - Specifies which matrix stack is the target for subsequent matrix operations.
(type=Enumerated constant)

glMultMatrix(m)

glMultMatrixd, glMultMatrixf

Multiply the current matrix with the specified matrix

Parameters:: m - Points to 16 consecutive values that are used as the elements of a 4x4 column major matrix.
(type=Buffer object. Depends on function prototype.)

glNewList(list, mode)

Create or replace a display list

Parameters:: list - Specifies the display list name
(type=unsigned int); mode - Specifies the compilation mode.
(type=Enumerated constant)

glNormal3(nx, ny, nz, v)

Normal3b, Normal3bv, Normal3d, Normal3dv, Normal3f, Normal3fv, Normal3i, Normal3iv, Normal3s, Normal3sv

Set the current normal vector

Parameters:: nx, ny, nz - Specify the x, y, and z coordinates of the new current normal. The initial value of the current normal is the unit vector, (0, 0, 1).
           (type of nx=Depends on function prototype. (non - 'v' prototypes only))
           (type of ny=Depends on function prototype. (non - 'v' prototypes only))
           (type of nz=Depends on function prototype. (non - 'v' prototypes only)); v - Specifies a pointer to an array of three elements: the x,y, and z coordinates of the new current normal.
(type=Buffer object. Depends on function prototype. ('v' prototypes))

glOrtho(left, right, bottom, top, zNear, zFar)

Multiply the current matrix with an orthographic matrix

Parameters:: left, right - Specify the coordinates for the left and right vertical clipping planes.
(type of left=double (float))
(type of right=double (float)); bottom, top - Specify the coordinates for the bottom and top horizontal clipping planes.
(type of bottom=double (float))
(type of top=double (float)); zNear, zFar - Specify the distances to the nearer and farther depth clipping planes. These values are negative if the plane is to be behind the viewer.
(type of zNear=double (float))
(type of zFar=double (float))

glPassThrough(token)

Place a marker in the feedback buffer

Parameters:: token - Specifies a marker value to be placed in the feedback buffer following a GL_PASS_THROUGH_TOKEN.
(type=float)

glPixelMap(map, mapsize, values)

glPixelMapfv, glPixelMapuiv, glPixelMapusv

Set up pixel transfer maps

Parameters:: map - Specifies a symbolic map name.
(type=Enumerated constant); mapsize - Specifies the size of the map being defined.
(type=int); values - Specifies an array of mapsize values.
(type=Buffer object. Depends on function prototype.)

glPixelStore(pname, param)

glPixelStoref, glPixelStorei

Set pixel storage modes

Parameters:: pname - Specifies the symbolic name of the parameter to be set. Six values affect the packing of pixel data into memory. Six more affect the unpacking of pixel data from memory.
(type=Enumerated constant); param - Specifies the value that pname is set to.
(type=Depends on function prototype.)

glPixelTransfer(pname, param)

glPixelTransferf, glPixelTransferi

Set pixel transfer modes

Parameters:: pname - Specifies the symbolic name of the pixel transfer parameter to be set.
(type=Enumerated constant); param - Specifies the value that pname is set to.
(type=Depends on function prototype.)

glPixelZoom(xfactor, yfactor)

Specify the pixel zoom factors

Parameters:: xfactor, yfactor - Specify the x and y zoom factors for pixel write operations.
(type of xfactor=float)
(type of yfactor=float)

glPointSize(size)

Specify the diameter of rasterized points

Parameters:: size - Specifies the diameter of rasterized points. The initial value is 1.
(type=float)

glPolygonMode(face, mode)

Select a polygon rasterization mode

Parameters:: face - Specifies the polygons that mode applies to. Must be GL_FRONT for front-facing polygons, GL_BACK for back- facing polygons, or GL_FRONT_AND_BACK for front- and back-facing polygons.
(type=Enumerated constant); mode - Specifies how polygons will be rasterized. The initial value is GL_FILL for both front- and back- facing polygons.
(type=Enumerated constant)

glPolygonOffset(factor, units)

Set the scale and units used to calculate depth values

Parameters:: factor - Specifies a scale factor that is used to create a variable depth offset for each polygon. The initial value is 0.
(type=float); units - Is multiplied by an implementation-specific value to create a constant depth offset. The initial value is 0.
(type=float)

glPolygonStipple(mask)

Set the polygon stippling pattern

Parameters:: mask - Specifies a pointer to a 32x32 stipple pattern that will be unpacked from memory in the same way that glDrawPixels unpacks pixels.
(type=Buffer object type GL_BYTE)

glPopAttrib()

Pop the server attribute stack

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/pushattrib.html

glPopMatrix()

Pop the current matrix stack

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/pushmatrix.html

glPopName()

Pop the name stack

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/pushname.html

glPrioritizeTextures(n, textures, priorities)

Set texture residence priority

Parameters:: n
(type=int @param n:Specifies the number of textures to be prioritized.); textures - Specifies an array containing the names of the textures to be prioritized.
(type=Buffer type GL_INT); priorities - Specifies an array containing the texture priorities. A priority given in an element of priorities applies to the texture named by the corresponding element of textures.
(type=Buffer type GL_FLOAT)

glPushAttrib(mask)

Push the server attribute stack

Parameters:: mask - Specifies a mask that indicates which attributes to save.
(type=Enumerated constant(s))

glPushMatrix()

Push the current matrix stack

: See Also: http://www.opengl.org/developers/documentation/man_pages/hardcopy/GL/html/gl/pushmatrix.html

glPushName(name)

Push the name stack

Parameters:: name - Specifies a name that will be pushed onto the name stack.
(type=unsigned int)

glRasterPos(x, y, z, w)

glRasterPos2d, glRasterPos2f, glRasterPos2i, glRasterPos2s, glRasterPos3d, glRasterPos3f, glRasterPos3i, glRasterPos3s, glRasterPos4d, glRasterPos4f, glRasterPos4i, glRasterPos4s, glRasterPos2dv, glRasterPos2fv, glRasterPos2iv, glRasterPos2sv, glRasterPos3dv, glRasterPos3fv, glRasterPos3iv, glRasterPos3sv, glRasterPos4dv, glRasterPos4fv, glRasterPos4iv, glRasterPos4sv

Specify the raster position for pixel operations

Parameters:: x, y, z, w - Specify the x,y,z, and w object coordinates (if present) for the raster position. If function prototype ends in 'v' specifies a pointer to an array of two, three, or four elements, specifying x, y, z, and w coordinates, respectively.
           (type of x=Depends on function prototype. (z and w for '3' and '4' prototypes only))
           (type of y=Depends on function prototype. (z and w for '3' and '4' prototypes only))
           (type of z=Depends on function prototype. (z and w for '3' and '4' prototypes only))
           (type of w=Depends on function prototype. (z and w for '3' and '4' prototypes only))

glReadBuffer(mode)

Select a color buffer source for pixels.

Parameters:: mode - Specifies a color buffer.
(type=Enumerated constant)

glReadPixels(x, y, width, height, format, type, pixels)

Read a block of pixels from the frame buffer

Parameters:: x
(type=int @param x,y:Specify the window coordinates of the first pixel that is read from the frame buffer. This location is the lower left corner of a rectangular block of pixels.); y
(type=int @param x,y:Specify the window coordinates of the first pixel that is read from the frame buffer. This location is the lower left corner of a rectangular block of pixels.); width, height - Specify the dimensions of the pixel rectangle. width and height of one correspond to a single pixel.
(type of width=int)
(type of height=int); format - Specifies the format of the pixel data.
(type=Enumerated constant); type - Specifies the data type of the pixel data.
(type=Enumerated constant); pixels - Returns the pixel data.
(type=Buffer object)

glRect(x1, y1, x2, y2, v1, v2)

glRectd, glRectf, glRecti, glRects, glRectdv, glRectfv, glRectiv, glRectsv

Draw a rectangle

Parameters:: x1, y1 - Specify one vertex of a rectangle
(type of x1=Depends on function prototype. (for non 'v' prototypes only))
(type of y1=Depends on function prototype. (for non 'v' prototypes only)); x2, y2 - Specify the opposite vertex of the rectangle
(type of x2=Depends on function prototype. (for non 'v' prototypes only))
(type of y2=Depends on function prototype. (for non 'v' prototypes only)); v1, v2 - Specifies a pointer to one vertex of a rectangle and the pointer to the opposite vertex of the rectangle
(type of v1=Depends on function prototype. (for 'v' prototypes only))
(type of v2=Depends on function prototype. (for 'v' prototypes only))

glRenderMode(mode)

Set rasterization mode

Parameters:: mode - Specifies the rasterization mode.
(type=Enumerated constant)

glRotate(angle, x, y, z)

glRotated, glRotatef

Multiply the current matrix by a rotation matrix

Parameters:: angle - Specifies the angle of rotation in degrees.
(type=Depends on function prototype.); x, y, z - Specify the x,y, and z coordinates of a vector respectively.
           (type of x=Depends on function prototype.)
           (type of y=Depends on function prototype.)
           (type of z=Depends on function prototype.)

glScale(x, y, z)

glScaled, glScalef

Multiply the current matrix by a general scaling matrix

Parameters:: x, y, z - Specify scale factors along the x,y, and z axes, respectively.
           (type of x=Depends on function prototype.)
           (type of y=Depends on function prototype.)
           (type of z=Depends on function prototype.)

glScissor(x, y, width, height)

Define the scissor box

Parameters:: x, y - Specify the lower left corner of the scissor box. Initially (0, 0).
(type of x=int)
(type of y=int); width, height - Specify the width and height of the scissor box. When a GL context is first attached to a window, width and height are set to the dimensions of that window.
(type of width=int)
(type of height=int)

glSelectBuffer(size, buffer)

Establish a buffer for selection mode values

Parameters:: size - Specifies the size of buffer
(type=int); buffer - Returns the selection data
(type=Buffer type GL_INT)

glShadeModel(mode)

Select flat or smooth shading

Parameters:: mode - Specifies a symbolic value representing a shading technique.
(type=Enumerated constant)

glStencilFuc(func, ref, mask)

Set function and reference value for stencil testing

Parameters:: func
(type=Enumerated constant @param func:Specifies the test function.); ref
(type=int @param ref:Specifies the reference value for the stencil test. ref is clamped to the range [0,2n-1], where n is the number of bitplanes in the stencil buffer. The initial value is 0.); mask
(type=unsigned int @param mask:Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is all 1's.)

glStencilMask(mask)

Control the writing of individual bits in the stencil planes

Parameters:: mask - Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is all 1's.
(type=unsigned int)

glStencilOp(fail, zfail, zpass)

Set stencil test actions

Parameters:: fail - Specifies the action to take when the stencil test fails. The initial value is GL_KEEP.
(type=Enumerated constant); zfail - Specifies the stencil action when the stencil test passes, but the depth test fails. zfail accepts the same symbolic constants as fail. The initial value is GL_KEEP.
(type=Enumerated constant); zpass - Specifies the stencil action when both the stencil test and the depth test pass, or when the stencil test passes and either there is no depth buffer or depth testing is not enabled. zpass accepts the same symbolic constants as fail. The initial value is GL_KEEP.
(type=Enumerated constant)

glTexCoord(s, t, r, q, v)

glTexCoord1d, glTexCoord1f, glTexCoord1i, glTexCoord1s, glTexCoord2d, glTexCoord2f, glTexCoord2i, glTexCoord2s, glTexCoord3d, glTexCoord3f, glTexCoord3i, glTexCoord3s, glTexCoord4d, glTexCoord4f, glTexCoord4i, glTexCoord4s, glTexCoord1dv, glTexCoord1fv, glTexCoord1iv, glTexCoord1sv, glTexCoord2dv, glTexCoord2fv, glTexCoord2iv, glTexCoord2sv, glTexCoord3dv, glTexCoord3fv, glTexCoord3iv, glTexCoord3sv, glTexCoord4dv, glTexCoord4fv, glTexCoord4iv, glTexCoord4sv

Set the current texture coordinates

Parameters:: s, t, r, q - Specify s, t, r, and q texture coordinates. Not all parameters are present in all forms of the command.
           (type of s=Depends on function prototype. (r and q for '3' and '4' prototypes only))
           (type of t=Depends on function prototype. (r and q for '3' and '4' prototypes only))
           (type of r=Depends on function prototype. (r and q for '3' and '4' prototypes only))
           (type of q=Depends on function prototype. (r and q for '3' and '4' prototypes only)); v - Specifies a pointer to an array of one, two, three, or four elements, which in turn specify the s, t, r, and q texture coordinates.
(type=Buffer object. Depends on function prototype. (for 'v' prototypes only))

glTexEnv(target, pname, param)

glTextEnvf, glTextEnvi, glTextEnvfv, glTextEnviv

Set texture environment parameters

Parameters:: target - Specifies a texture environment. Must be GL_TEXTURE_ENV.
(type=Enumerated constant); pname - Specifies the symbolic name of a single-valued texture environment parameter. Must be GL_TEXTURE_ENV_MODE.
(type=Enumerated constant); param - Specifies a single symbolic constant. If function prototype ends in 'v' specifies a pointer to a parameter array that contains either a single symbolic constant or an RGBA color
(type=Depends on function prototype.)

glTexGen(coord, pname, param)

glTexGend, glTexGenf, glTexGeni, glTexGendv, glTexGenfv, glTexGeniv

Control the generation of texture coordinates

Parameters:: coord - Specifies a texture coordinate.
(type=Enumerated constant); pname - Specifies the symbolic name of the texture- coordinate generation function.
(type=Enumerated constant); param - Specifies a single-valued texture generation parameter. If function prototype ends in 'v' specifies a pointer to an array of texture generation parameters. If pname is GL_TEXTURE_GEN_MODE, then the array must contain a single symbolic constant. Otherwise, params holds the coefficients for the texture-coordinate generation function specified by pname.
(type=Depends on function prototype.)

glTexImage1D(target, level, internalformat, width, border, format, type, pixels)

Specify a one-dimensional texture image

Parameters:: target - Specifies the target texture.
(type=Enumerated constant); level - Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.
(type=int); internalformat - Specifies the number of color components in the texture.
(type=int); width - Specifies the width of the texture image. Must be 2n+2(border) for some integer n. All implementations support texture images that are at least 64 texels wide. The height of the 1D texture image is 1.
(type=int); border - Specifies the width of the border. Must be either 0 or 1.
(type=int); format - Specifies the format of the pixel data.
(type=Enumerated constant); type - Specifies the data type of the pixel data.
(type=Enumerated constant); pixels - Specifies a pointer to the image data in memory.
(type=Buffer object.)

glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels)

Specify a two-dimensional texture image

Parameters:: target - Specifies the target texture.
(type=Enumerated constant); level - Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.
(type=int); internalformat - Specifies the number of color components in the texture.
(type=int); width - Specifies the width of the texture image. Must be 2n+2(border) for some integer n. All implementations support texture images that are at least 64 texels wide.
(type=int); height - Specifies the hieght of the texture image. Must be 2m+2(border) for some integer m. All implementations support texture images that are at least 64 texels high.
(type=int); border - Specifies the width of the border. Must be either 0 or 1.
(type=int); format - Specifies the format of the pixel data.
(type=Enumerated constant); type - Specifies the data type of the pixel data.
(type=Enumerated constant); pixels - Specifies a pointer to the image data in memory.
(type=Buffer object.)

glTexParameter(target, pname, param)

glTexParameterf, glTexParameteri, glTexParameterfv, glTexParameteriv

Set texture parameters

Parameters:: target - Specifies the target texture.
(type=Enumerated constant); pname - Specifies the symbolic name of a single-valued texture parameter.
(type=Enumerated constant); param - Specifies the value of pname. If function prototype ends in 'v' specifies a pointer to an array where the value or values of pname are stored.
(type=Depends on function prototype.)

glTranslate(x, y, z)

glTranslatef, glTranslated

Multiply the current matrix by a translation matrix

Parameters:: x, y, z - Specify the x, y, and z coordinates of a translation vector.
           (type of x=Depends on function prototype.)
           (type of y=Depends on function prototype.)
           (type of z=Depends on function prototype.)

glVertex(x, y, z, w, v)

glVertex2d, glVertex2f, glVertex2i, glVertex2s, glVertex3d, glVertex3f, glVertex3i, glVertex3s, glVertex4d, glVertex4f, glVertex4i, glVertex4s, glVertex2dv, glVertex2fv, glVertex2iv, glVertex2sv, glVertex3dv, glVertex3fv, glVertex3iv, glVertex3sv, glVertex4dv, glVertex4fv, glVertex4iv, glVertex4sv

Specify a vertex

Parameters:: x, y, z, w - Specify x, y, z, and w coordinates of a vertex. Not all parameters are present in all forms of the command.
           (type of x=Depends on function prototype (z and w for '3' and '4' prototypes only))
           (type of y=Depends on function prototype (z and w for '3' and '4' prototypes only))
           (type of z=Depends on function prototype (z and w for '3' and '4' prototypes only))
           (type of w=Depends on function prototype (z and w for '3' and '4' prototypes only)); v - Specifies a pointer to an array of two, three, or four elements. The elements of a two-element array are x and y; of a three-element array, x, y, and z; and of a four-element array, x, y, z, and w.
(type=Buffer object. Depends of function prototype (for 'v' prototypes only))

glViewport(x, y, width, height)

Set the viewport

Parameters:: x, y - Specify the lower left corner of the viewport rectangle, in pixels. The initial value is (0,0).
(type of x=int)
(type of y=int); width, height - Specify the width and 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.
(type of width=int)
(type of height=int)

Generated by Epydoc 2.0 on Tue Nov 11 20:06:11 2003

http://epydoc.sf.net