A little spell-checkage.

Some return types changed from PyNone ( a C name ) to None.
This commit is contained in:
Stephen Swaney
2006-07-12 01:36:07 +00:00
parent 0d9002354f
commit fec1ebaca3
14 changed files with 218 additions and 218 deletions

View File

@@ -74,7 +74,7 @@ Example::
#
Draw.Register(show_win, ev, None) # start the main loop
@note: you can use the L{Image} module and L{Image.Image} bpy object to load
@note: you can use the L{Image} module and L{Image.Image} BPy object to load
and set textures. See L{Image.Image.glLoad} and L{Image.Image.glFree},
for example.
@see: U{www.opengl.org}
@@ -130,7 +130,7 @@ def glBegin(mode):
def glBindTexture(target, texture):
"""
Bind a named texture to a textureing target
Bind a named texture to a texturing target
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/bindtexture.html}
@type target: Enumerated constant
@@ -148,7 +148,7 @@ def glBitmap(width, height, xorig, yorig, xmove, ymove, bitmap):
@param width, height: Specify the pixel width and height of the bitmap image.
@type xorig,yorig: float
@param xorig,yorig: Specify the location of the origin in the bitmap image. The origin is measured
from the lower left corner of the bitmap, with right and up beigng the positive axes.
from the lower left corner of the bitmap, with right and up being the positive axes.
@type xmove,ymove: float
@param xmove,ymove: Specify the x and y offsets to be added to the current raster position after
the bitmap is drawn.
@@ -253,7 +253,7 @@ def glClearStencil(s):
def glClipPlane (plane, equation):
"""
Specify a plane against which all geometery is clipped
Specify a plane against which all geometry is clipped
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/clipplane.html}
@type plane: Enumerated constant
@@ -333,7 +333,7 @@ def glDeleteLists(list, range):
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/deletelists.html}
@type list: unsigned int
@param list: Specifiex the integer name of the first display list to delete
@param list: Specifies the integer name of the first display list to delete
@type range: int
@param range: Specifies the number of display lists to delete
"""
@@ -344,7 +344,7 @@ def glDeleteTextures(n, textures):
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/deletetextures.html}
@type n: int
@param n: Specifes the number of textures to be deleted
@param n: Specifies the number of textures to be deleted
@type textures: Buffer I{GL_INT}
@param textures: Specifies an array of textures to be deleted
"""
@@ -420,7 +420,7 @@ def glEdgeFlag (flag):
"""
B{glEdgeFlag, glEdgeFlagv}
Flag edges as either boundary or nonboundary
Flag edges as either boundary or non-boundary
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/edgeflag.html}
@type flag: Depends of function prototype
@@ -685,7 +685,7 @@ def glGetPolygonStipple(mask):
def glGetString(name):
"""
Return a strin describing the current GL connection
Return a string describing the current GL connection
@see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/getstring.html}
@type name: Enumerated constant
@@ -971,12 +971,12 @@ def glMap2 (target, u1, u2, ustride, uorder, v1, v2, vstride, vorder, points):
@param target: Specifies the kind of values that are generated by the evaluator.
@type u1, u2: Depends on function prototype.
@param 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
he variable that is evaluated by the equations specified by this command. Initially
u1 is 0 and u2 is 1.
@type ustride: int
@param 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
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 ustride is 0.
@type uorder: int
@@ -1279,9 +1279,9 @@ def glRasterPos (x,y,z,w):
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.
@note:
If you are drawing to the 3d view with a Scriptlink of a space handeler
If you are drawing to the 3d view with a Scriptlink of a space handler
the zoom level of the panels will scale the glRasterPos by the view matrix.
so a X of 10 will not always offset 10 pixels as youd expect.
so a X of 10 will not always offset 10 pixels as you would expect.
To work around this get the scale value of the view matrix and use it to scale your pixel values.
@@ -1294,7 +1294,7 @@ def glRasterPos (x,y,z,w):
viewMatrix = Buffer(GL_FLOAT, 16)
glGetFloatv(GL_MODELVIEW_MATRIX, viewMatrix)
f = 1/viewMatrix[0]
glRasterPos2f(xval*f, yval*f) # Instead of the useual glRasterPos2i(xval, yval)
glRasterPos2f(xval*f, yval*f) # Instead of the usual glRasterPos2i(xval, yval)
"""
def glReadBuffer(mode):
@@ -1553,7 +1553,7 @@ def glTexImage2D(target, level, internalformat, width, height, border, format, t
some integer n. All implementations support texture images that are at least 64
texels wide.
@type height: int
@param height: Specifies the hieght of the texture image. Must be 2m+2(border) for
@param height: Specifies the height 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 border: int
@@ -1716,7 +1716,7 @@ def gluUnProject(winx, winy, winz, modelMatrix, projMatrix, viewport, objx, objy
class Buffer:
"""
The Buffer object is simply a block of memory that is delineated and initialized by the
user. Many OpenGL funtions return data to a C-style pointer, however, because this
user. Many OpenGL functions return data to a C-style pointer, however, because this
is not possible in python the Buffer object can be used to this end. Wherever pointer
notation is used in the OpenGL functions the Buffer object can be used in it's BGL
wrapper. In some instances the Buffer object will need to be initialized with the template
@@ -1752,8 +1752,8 @@ class Buffer:
be created for the buffer. If a sequence is passed for the dimensions, the buffer
becomes n-Dimensional, where n is equal to the number of parameters passed in the
sequence. Example: [256,2] is a two- dimensional buffer while [256,256,4] creates
a three- dimensional buffer. You can think of each additional dimension as a subitem
of the dimension to the left. i.e. [10,2] is a 10 element array each with 2 subitems.
a three- dimensional buffer. You can think of each additional dimension as a sub-item
of the dimension to the left. i.e. [10,2] is a 10 element array each with 2 sub-items.
[(0,0), (0,1), (1,0), (1,1), (2,0), ...] etc.
@type template: A python sequence object (optional)
@param template: A sequence of matching dimensions which will be used to initialize