[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [39950] trunk/blender/doc/python_api/rst: more minor doc fixes

Campbell Barton ideasman42 at gmail.com
Tue Sep 6 02:41:28 CEST 2011


Revision: 39950
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=39950
Author:   campbellbarton
Date:     2011-09-06 00:41:28 +0000 (Tue, 06 Sep 2011)
Log Message:
-----------
more minor doc fixes

Modified Paths:
--------------
    trunk/blender/doc/python_api/rst/bgl.rst
    trunk/blender/doc/python_api/rst/info_quickstart.rst

Modified: trunk/blender/doc/python_api/rst/bgl.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bgl.rst	2011-09-06 00:31:00 UTC (rev 39949)
+++ trunk/blender/doc/python_api/rst/bgl.rst	2011-09-06 00:41:28 UTC (rev 39950)
@@ -56,9 +56,9 @@
 
    :type n: int
    :arg n: Specifies the number of textures to be queried.
-   :type textures: :class:`Buffer` object I{type GL_INT}
+   :type textures: :class:`bgl.Buffer` object I{type GL_INT}
    :arg textures: Specifies an array containing the names of the textures to be queried
-   :type residences: :class:`Buffer` object I{type GL_INT}(boolean)
+   :type residences: :class:`bgl.Buffer` object I{type GL_INT}(boolean)
    :arg 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.
@@ -101,7 +101,7 @@
    :type xmove, ymove: float
    :arg xmove, ymove: Specify the x and y offsets to be added to the current raster position after
       the bitmap is drawn.
-   :type bitmap: :class:`Buffer` object I{type GL_BYTE}
+   :type bitmap: :class:`bgl.Buffer` object I{type GL_BYTE}
    :arg bitmap: Specifies the address of the bitmap image.
 
 
@@ -139,7 +139,7 @@
    :arg n: Specifies the number of display lists to be executed.
    :type type: Enumerated constant
    :arg type: Specifies the type of values in lists.
-   :type lists: :class:`Buffer` object
+   :type lists: :class:`bgl.Buffer` object
    :arg 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.
@@ -217,7 +217,7 @@
 
    :type plane: Enumerated constant
    :arg plane: Specifies which clipping plane is being positioned.
-   :type equation: :class:`Buffer` object I{type GL_FLOAT}(double)
+   :type equation: :class:`bgl.Buffer` object I{type GL_FLOAT}(double)
    :arg equation: Specifies the address of an array of four double- precision
       floating-point values. These values are interpreted as a plane equation.
 
@@ -340,7 +340,7 @@
 
    :type n: int
    :arg n: Specifies the number of textures to be deleted
-   :type textures: :class:`Buffer` I{GL_INT}
+   :type textures: :class:`bgl.Buffer` I{GL_INT}
    :arg textures: Specifies an array of textures to be deleted
 
 
@@ -413,7 +413,7 @@
    :arg format: Specifies the format of the pixel data.
    :type type: Enumerated constant
    :arg type: Specifies the data type for pixels.
-   :type pixels: :class:`Buffer` object
+   :type pixels: :class:`bgl.Buffer` object
    :arg pixels: Specifies a pointer to the pixel data.
 
 
@@ -512,7 +512,7 @@
    :type type: Enumerated constant
    :arg type: Specifies a symbolic constant that describes the information that
       will be returned for each vertex.
-   :type buffer: :class:`Buffer` object I{GL_FLOAT}
+   :type buffer: :class:`bgl.Buffer` object I{GL_FLOAT}
    :arg buffer: Returns the feedback data.
 
 
@@ -592,7 +592,7 @@
 
    :type n: int
    :arg n: Specifies the number of textures name to be generated.
-   :type textures: :class:`Buffer` object I{type GL_INT}
+   :type textures: :class:`bgl.Buffer` object I{type GL_INT}
    :arg textures: Specifies an array in which the generated textures names are stored.
 
 
@@ -620,7 +620,7 @@
    :arg 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 equation:  :class:`Buffer` object I{type GL_FLOAT}
+   :type equation:  :class:`bgl.Buffer` object I{type GL_FLOAT}
    :arg 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).
 
@@ -646,7 +646,7 @@
       names of the form GL_LIGHTi where 0 < i < GL_MAX_LIGHTS.
    :type pname: Enumerated constant
    :arg pname: Specifies a light source parameter for light.
-   :type params:  :class:`Buffer` object. Depends on function prototype.
+   :type params:  :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the requested data.
 
 
@@ -662,7 +662,7 @@
    :arg target: Specifies the symbolic name of a map.
    :type query: Enumerated constant
    :arg query: Specifies which parameter to return.
-   :type v: :class:`Buffer` object. Depends on function prototype.
+   :type v: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg v: Returns the requested data.
 
 
@@ -679,7 +679,7 @@
       representing the front and back materials, respectively.
    :type pname: Enumerated constant
    :arg pname: Specifies the material parameter to return.
-   :type params: :class:`Buffer` object. Depends on function prototype.
+   :type params: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the requested data.
 
 
@@ -693,7 +693,7 @@
 
    :type map:  Enumerated constant
    :arg map: Specifies the name of the pixel map to return.
-   :type values: :class:`Buffer` object. Depends on function prototype.
+   :type values: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg values: Returns the pixel map contents.
 
 
@@ -703,7 +703,7 @@
 
    .. seealso:: `OpenGL Docs <http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/getpolygonstipple.html>`_
 
-   :type mask: :class:`Buffer` object I{type GL_BYTE}
+   :type mask: :class:`bgl.Buffer` object I{type GL_BYTE}
    :arg mask: Returns the stipple pattern. The initial value is all 1's.
 
 
@@ -730,7 +730,7 @@
    :arg target: Specifies a texture environment. Must be GL_TEXTURE_ENV.
    :type pname: Enumerated constant
    :arg pname: Specifies the symbolic name of a texture environment parameter.
-   :type params: :class:`Buffer` object. Depends on function prototype.
+   :type params: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the requested data.
 
 
@@ -746,7 +746,7 @@
    :arg coord: Specifies a texture coordinate.
    :type pname: Enumerated constant
    :arg pname: Specifies the symbolic name of the value(s) to be returned.
-   :type params: :class:`Buffer` object. Depends on function prototype.
+   :type params: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the requested data.
 
 
@@ -765,7 +765,7 @@
    :arg format: Specifies a pixel format for the returned data.
    :type type: Enumerated constant
    :arg type: Specifies a pixel type for the returned data.
-   :type pixels: :class:`Buffer` object.
+   :type pixels: :class:`bgl.Buffer` object.
    :arg pixels: Returns the texture image. Should be a pointer to an array of the
       type specified by type
 
@@ -785,7 +785,7 @@
       Level 0 is the base image level. Level n is the nth mipmap reduction image.
    :type pname: Enumerated constant
    :arg pname: Specifies the symbolic name of a texture parameter.
-   :type params: :class:`Buffer` object. Depends on function prototype.
+   :type params: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the requested data.
 
 
@@ -801,7 +801,7 @@
    :arg target: Specifies the symbolic name of the target texture.
    :type pname: Enumerated constant
    :arg pname: Specifies the symbolic name the target texture.
-   :type params: :class:`Buffer` object. Depends on function prototype.
+   :type params: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg params: Returns the texture parameters.
 
 
@@ -826,7 +826,7 @@
 
    .. seealso:: `OpenGL Docs <http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/index_.html>`_
 
-   :type c: :class:`Buffer` object. Depends on function prototype.
+   :type c: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg c: Specifies a pointer to a one element array that contains the new value for
       the current color index.
 
@@ -956,7 +956,7 @@
 
    .. seealso:: `OpenGL Docs <http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/loadmatrix.html>`_
 
-   :type m: :class:`Buffer` object. Depends on function prototype.
+   :type m: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg m: Specifies a pointer to 16 consecutive values, which are used as the elements
       of a 4x4 column-major matrix.
 
@@ -1002,7 +1002,7 @@
       occupy contiguous memory locations.
    :type order: int
    :arg order: Specifies the number of control points. Must be positive.
-   :type points: :class:`Buffer` object. Depends on function prototype.
+   :type points: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg points: Specifies a pointer to the array of control points.
 
 
@@ -1043,7 +1043,7 @@
    :type vorder: int
    :arg vorder: Specifies the dimension of the control point array in the v axis.
       Must be positive. The initial value is 1.
-   :type points: :class:`Buffer` object. Depends on function prototype.
+   :type points: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg points: Specifies a pointer to the array of control points.
 
 
@@ -1103,7 +1103,7 @@
 
    .. seealso:: `OpenGL Docs <http://www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/multmatrix.html>`_
 
-   :type m: :class:`Buffer` object. Depends on function prototype.
+   :type m: :class:`bgl.Buffer` object. Depends on function prototype.
    :arg m: Points to 16 consecutive values that are used as the elements of a 4x4 column
       major matrix.
 
@@ -1132,7 +1132,7 @@
    :type nx, ny, nz: Depends on function prototype. (non - 'v' prototypes only)
    :arg 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 v: :class:`Buffer` object. Depends on function prototype. ('v' prototypes)
+   :type v: :class:`bgl.Buffer` object. Depends on function prototype. ('v' prototypes)
    :arg v: Specifies a pointer to an array of three elements: the x, y, and z coordinates
       of the new current normal.
 
@@ -1177,7 +1177,7 @@
    :arg map: Specifies a symbolic map name.
    :type mapsize: int

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list