[Bf-blender-cvs] [3c7a538c9b7] master: Fix T60891: bgl docs still include deprecated opengl functions
Jacques Lucke
noreply at git.blender.org
Thu Apr 4 16:15:15 CEST 2019
Commit: 3c7a538c9b73ff7ab87ba508c5d44433d6c2877b
Author: Jacques Lucke
Date: Thu Apr 4 16:11:14 2019 +0200
Branches: master
https://developer.blender.org/rB3c7a538c9b73ff7ab87ba508c5d44433d6c2877b
Fix T60891: bgl docs still include deprecated opengl functions
In a separate step, all new functions should be added.
However, the best way to do this, is not clear yet.
A list of functions, that have to be added is available
in D4280.
Differential Revision: https://developer.blender.org/D4280
===================================================================
M doc/python_api/rst/bgl.rst
===================================================================
diff --git a/doc/python_api/rst/bgl.rst b/doc/python_api/rst/bgl.rst
index 90a1442edeb..3410677f109 100644
--- a/doc/python_api/rst/bgl.rst
+++ b/doc/python_api/rst/bgl.rst
@@ -26,58 +26,6 @@ offers a set of extensive examples, including advanced features.
for example.
-.. function:: glAccum(op, value):
-
- Operate on the accumulation buffer.
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glAccum.xml>`__
-
- :type op: Enumerated constant
- :arg op: The accumulation buffer operation.
- :type value: float
- :arg value: a value used in the accumulation buffer operation.
-
-
-.. function:: glAlphaFunc(func, ref):
-
- Specify the alpha test function.
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glAlphaFunc.xml>`__
-
- :type func: Enumerated constant
- :arg func: Specifies the alpha comparison function.
- :type ref: float
- :arg ref: The reference value that incoming alpha values are compared to.
- Clamped between 0 and 1.
-
-
-.. function:: glAreTexturesResident(n, textures, residences):
-
- Determine if textures are loaded in texture memory
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glAreTexturesResident.xml>`__
-
- :type n: int
- :arg n: Specifies the number of textures to be queried.
- :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:`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.
-
-
-.. function:: glBegin(mode):
-
- Delimit the vertices of a primitive or a group of like primitives
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glBegin.xml>`__
-
- :type mode: Enumerated constant
- :arg mode: Specifies the primitive that will be create from vertices between
- glBegin and glEnd.
-
-
.. function:: glBindTexture(target, texture):
Bind a named texture to a texturing target
@@ -90,24 +38,6 @@ offers a set of extensive examples, including advanced features.
:arg texture: Specifies the name of a texture.
-.. function:: glBitmap(width, height, xorig, yorig, xmove, ymove, bitmap):
-
- Draw a bitmap
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glBitmap.xml>`__
-
- :type width, height: int
- :arg width, height: Specify the pixel width and height of the bitmap image.
- :type xorig, yorig: float
- :arg 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 being the positive axes.
- :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:`bgl.Buffer` object I{type GL_BYTE}
- :arg bitmap: Specifies the address of the bitmap image.
-
-
.. function:: glBlendFunc(sfactor, dfactor):
Specify pixel arithmetic
@@ -122,32 +52,6 @@ offers a set of extensive examples, including advanced features.
blending factors are computed.
-.. function:: glCallList(list):
-
- Execute a display list
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glCallList.xml>`__
-
- :type list: unsigned int
- :arg list: Specifies the integer name of the display list to be executed.
-
-
-.. function:: glCallLists(n, type, lists):
-
- Execute a list of display lists
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glCallLists.xml>`__
-
- :type n: int
- :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:`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.
-
-
.. function:: glClear(mask):
Clear buffers to preset values
@@ -158,17 +62,6 @@ offers a set of extensive examples, including advanced features.
:arg mask: Bitwise OR of masks that indicate the buffers to be cleared.
-.. function:: glClearAccum(red, green, blue, alpha):
-
- Specify clear values for the accumulation buffer
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glClearAccum.xml>`__
-
- :type red, green, blue, alpha: float
- :arg 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.
-
-
.. function:: glClearColor(red, green, blue, alpha):
Specify clear values for the color buffers
@@ -191,17 +84,6 @@ offers a set of extensive examples, including advanced features.
The initial value is 1.
-.. function:: glClearIndex(c):
-
- Specify the clear value for the color index buffers
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glClearIndex.xml>`__
-
- :type c: float
- :arg c: Specifies the index used when the color index buffers are cleared.
- The initial value is 0.
-
-
.. function:: glClearStencil(s):
Specify the clear value for the stencil buffer
@@ -255,36 +137,7 @@ offers a set of extensive examples, including advanced features.
color components can be written.
-.. function:: glColorMaterial(face, mode):
-
- Cause a material color to track the current color
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glColorMaterial.xml>`__
-
- :type face: Enumerated constant
- :arg face: Specifies whether front, back, or both front and back material parameters should
- track the current color.
- :type mode: Enumerated constant
- :arg mode: Specifies which of several material parameters track the current color.
-
-
-.. function:: glCopyPixels(x, y, width, height, type):
-
- Copy pixels in the frame buffer
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glCopyPixels.xml>`__
-
- :type x, y: int
- :arg x, y: Specify the window coordinates of the lower left corner of the rectangular
- region of pixels to be copied.
- :type width, height: int
- :arg width,height: Specify the dimensions of the rectangular region of pixels to be copied.
- Both must be non-negative.
- :type type: Enumerated constant
- :arg type: Specifies whether color values, depth values, or stencil values are to be copied.
-
-
- def glCopyTexImage2D(target, level, internalformat, x, y, width, height, border):
+.. function:: glCopyTexImage2D(target, level, internalformat, x, y, width, height, border):
Copy pixels into a 2D texture image
@@ -323,18 +176,6 @@ offers a set of extensive examples, including advanced features.
:arg mode: Specifies whether front- or back-facing facets are candidates for culling.
-.. function:: glDeleteLists(list, range):
-
- Delete a contiguous group of display lists
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glDeleteLists.xml>`__
-
- :type list: unsigned int
- :arg list: Specifies the integer name of the first display list to delete
- :type range: int
- :arg range: Specifies the number of display lists to delete
-
-
.. function:: glDeleteTextures(n, textures):
Delete named textures
@@ -403,23 +244,6 @@ offers a set of extensive examples, including advanced features.
:arg mode: Specifies up to four color buffers to be drawn into.
-.. function:: glDrawPixels(width, height, format, type, pixels):
-
- Write a block of pixels to the frame buffer
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glDrawPixels.xml>`__
-
- :type width, height: int
- :arg width, height: Specify the dimensions of the pixel rectangle to be
- written into the frame buffer.
- :type format: Enumerated constant
- :arg format: Specifies the format of the pixel data.
- :type type: Enumerated constant
- :arg type: Specifies the data type for pixels.
- :type pixels: :class:`bgl.Buffer` object
- :arg pixels: Specifies a pointer to the pixel data.
-
-
.. function:: glEdgeFlag (flag):
B{glEdgeFlag, glEdgeFlagv}
@@ -442,20 +266,6 @@ offers a set of extensive examples, including advanced features.
:arg cap: Specifies a symbolic constant indicating a GL capability.
-.. function:: glEnd():
-
- Delimit the vertices of a primitive or group of like primitives
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glBegin.xml>`__
-
-
-.. function:: glEndList():
-
- Create or replace a display list
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glNewList.xml>`__
-
-
.. function:: glEvalCoord (u,v):
B{glEvalCoord1d, glEvalCoord1f, glEvalCoord2d, glEvalCoord2f, glEvalCoord1dv, glEvalCoord1fv,
@@ -560,33 +370,6 @@ offers a set of extensive examples, including advanced features.
:arg mode: Specifies the orientation of front-facing polygons.
-.. function:: glFrustum(left, right, bottom, top, zNear, zFar):
-
- Multiply the current matrix by a perspective matrix
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glFrustum.xml>`__
-
- :type left, right: double (float)
- :arg left, right: Specify the coordinates for the left and right vertical
- clipping planes.
- :type top, bottom: double (float)
- :arg top, bottom: Specify the coordinates for the bottom and top horizontal
- clipping planes.
- :type zNear, zFar: double (float)
- :arg zNear, zFar: Specify the distances to the near and far depth clipping planes.
- Both distances must be positive.
-
-
-.. function:: glGenLists(range):
-
- Generate a contiguous set of empty display lists
-
- .. seealso:: `OpenGL Docs <https://www.opengl.org/sdk/docs/man2/xhtml/glGenLists.xml>`__
-
- :type range: int
- :arg range: Specifie
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list