From 3c7a538c9b73ff7ab87ba508c5d44433d6c2877b Mon Sep 17 00:00:00 2001 From: Jacques Lucke Date: Thu, 4 Apr 2019 16:11:14 +0200 Subject: 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 --- doc/python_api/rst/bgl.rst | 608 +-------------------------------------------- 1 file changed, 1 insertion(+), 607 deletions(-) (limited to 'doc/python_api/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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - :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 `__ - - -.. function:: glEndList(): - - Create or replace a display list - - .. seealso:: `OpenGL Docs `__ - - .. 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 `__ - - :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 `__ - - :type range: int - :arg range: Specifies the number of contiguous empty display lists to be generated. - - .. function:: glGenTextures(n, textures): Generate texture names @@ -613,21 +396,6 @@ offers a set of extensive examples, including advanced features. :arg param: Returns the value or values of the specified parameter. -.. function:: glGetClipPlane(plane, equation): - - Return the coefficients of the specified clipping plane - - .. seealso:: `OpenGL Docs `__ - - :type plane: Enumerated constant - :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:`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). - - .. function:: glGetError(): Return error information @@ -700,16 +468,6 @@ offers a set of extensive examples, including advanced features. :arg values: Returns the pixel map contents. -.. function:: glGetPolygonStipple(mask): - - Return the polygon stipple pattern - - .. seealso:: `OpenGL Docs `__ - - :type mask: :class:`bgl.Buffer` object I{type GL_BYTE} - :arg mask: Returns the stipple pattern. The initial value is all 1's. - - .. function:: glGetString(name): Return a string describing the current GL connection @@ -821,38 +579,6 @@ offers a set of extensive examples, including advanced features. :arg mode: Specifies a symbolic constant indicating the desired behavior. -.. function:: glIndex(c): - - B{glIndexd, glIndexf, glIndexi, glIndexs, glIndexdv, glIndexfv, glIndexiv, glIndexsv} - - Set the current color index - - .. seealso:: `OpenGL Docs `__ - - :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. - - -.. function:: glIndexMask(mask): - - Control the writing of individual bits in the color index buffers - - .. seealso:: `OpenGL Docs `__ - - :type mask: int - :arg mask: Specifies a bit mask to enable and disable the writing of individual bits - in the color index buffers. - Initially, the mask is all 1's. - - -.. function:: glInitNames(): - - Initialize the name stack - - .. seealso:: `OpenGL Docs `__ - - .. function:: glIsEnabled(cap): Test whether a capability is enabled @@ -863,16 +589,6 @@ offers a set of extensive examples, including advanced features. :arg cap: Specifies a constant representing a GL capability. -.. function:: glIsList(list): - - Determine if a name corresponds to a display-list - - .. seealso:: `OpenGL Docs `__ - - :type list: unsigned int - :arg list: Specifies a potential display-list name. - - .. function:: glIsTexture(texture): Determine if a name corresponds to a texture @@ -918,23 +634,6 @@ offers a set of extensive examples, including advanced features. specifies a pointer to the value or values that param will be set to. -.. function:: glLineStipple(factor, pattern): - - Specify the line stipple pattern - - .. seealso:: `OpenGL Docs `__ - - :type factor: int - :arg 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 pattern: unsigned short int - :arg 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. - - .. function:: glLineWidth(width): Specify the width of rasterized lines. @@ -945,24 +644,6 @@ offers a set of extensive examples, including advanced features. :arg width: Specifies the width of rasterized lines. The initial value is 1. -.. function:: glListBase(base): - - Set the display-list base for glCallLists - - .. seealso:: `OpenGL Docs `__ - - :type base: unsigned int - :arg base: Specifies an integer offset that will be added to glCallLists - offsets to generate display-list names. The initial value is 0. - - -.. function:: glLoadIdentity(): - - Replace the current matrix with the identity matrix - - .. seealso:: `OpenGL Docs `__ - - .. function:: glLoadMatrix (m): B{glLoadMatrixd, glLoadMatixf} @@ -976,16 +657,6 @@ offers a set of extensive examples, including advanced features. of a 4x4 column-major matrix. -.. function:: glLoadName(name): - - Load a name onto the name stack. - - .. seealso:: `OpenGL Docs `__ - - :type name: unsigned int - :arg name: Specifies a name that will replace the top value on the name stack. - - .. function:: glLogicOp(opcode): Specify a logical pixel operation for color index rendering @@ -1100,16 +771,6 @@ offers a set of extensive examples, including advanced features. pname will be set to. -.. function:: glMatrixMode(mode): - - Specify which matrix is the current matrix. - - .. seealso:: `OpenGL Docs `__ - - :type mode: Enumerated constant - :arg mode: Specifies which matrix stack is the target for subsequent matrix operations. - - .. function:: glMultMatrix (m): B{glMultMatrixd, glMultMatrixf} @@ -1123,18 +784,6 @@ offers a set of extensive examples, including advanced features. major matrix. -.. function:: glNewList(list, mode): - - Create or replace a display list - - .. seealso:: `OpenGL Docs `__ - - :type list: unsigned int - :arg list: Specifies the display list name - :type mode: Enumerated constant - :arg mode: Specifies the compilation mode. - - .. function:: glNormal3 (nx, ny, nz, v): B{Normal3b, Normal3bv, Normal3d, Normal3dv, Normal3f, Normal3fv, Normal3i, Normal3iv, @@ -1152,34 +801,6 @@ offers a set of extensive examples, including advanced features. of the new current normal. -.. function:: glOrtho(left, right, bottom, top, zNear, zFar): - - Multiply the current matrix with an orthographic matrix - - .. seealso:: `OpenGL Docs `__ - - :type left, right: double (float) - :arg left, right: Specify the coordinates for the left and - right vertical clipping planes. - :type bottom, top: double (float) - :arg bottom, top: Specify the coordinates for the bottom and top - horizontal clipping planes. - :type zNear, zFar: double (float) - :arg 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. - - -.. function:: glPassThrough(token): - - Place a marker in the feedback buffer - - .. seealso:: `OpenGL Docs `__ - - :type token: float - :arg token: Specifies a marker value to be placed in the feedback - buffer following a GL_PASS_THROUGH_TOKEN. - - .. function:: glPixelMap (map, mapsize, values): B{glPixelMapfv, glPixelMapuiv, glPixelMapusv} @@ -1226,16 +847,6 @@ offers a set of extensive examples, including advanced features. :arg param: Specifies the value that pname is set to. -.. function:: glPixelZoom(xfactor, yfactor): - - Specify the pixel zoom factors - - .. seealso:: `OpenGL Docs `__ - - :type xfactor, yfactor: float - :arg xfactor, yfactor: Specify the x and y zoom factors for pixel write operations. - - .. function:: glPointSize(size): Specify the diameter of rasterized points @@ -1275,98 +886,6 @@ offers a set of extensive examples, including advanced features. constant depth offset. The initial value is 0. -.. function:: glPolygonStipple(mask): - - Set the polygon stippling pattern - - .. seealso:: `OpenGL Docs `__ - - :type mask: :class:`bgl.Buffer` object I{type GL_BYTE} - :arg mask: Specifies a pointer to a 32x32 stipple pattern that will be unpacked - from memory in the same way that glDrawPixels unpacks pixels. - - -.. function:: glPopAttrib(): - - Pop the server attribute stack - - .. seealso:: `OpenGL Docs `__ - - -.. function:: glPopClientAttrib(): - - Pop the client attribute stack - - .. seealso:: `OpenGL Docs `__ - - -.. function:: glPopMatrix(): - - Pop the current matrix stack - - .. seealso:: `OpenGL Docs `__ - - -.. function:: glPopName(): - - Pop the name stack - - .. seealso:: `OpenGL Docs `__ - - -.. function:: glPrioritizeTextures(n, textures, priorities): - - Set texture residence priority - - .. seealso:: `OpenGL Docs `__ - - :type n: int - :arg n: Specifies the number of textures to be prioritized. - :type textures: :class:`bgl.Buffer` I{type GL_INT} - :arg textures: Specifies an array containing the names of the textures to be prioritized. - :type priorities: :class:`bgl.Buffer` I{type GL_FLOAT} - :arg 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. - - -.. function:: glPushAttrib(mask): - - Push the server attribute stack - - .. seealso:: `OpenGL Docs `__ - - :type mask: Enumerated constant(s) - :arg mask: Specifies a mask that indicates which attributes to save. - - -.. function:: glPushClientAttrib(mask): - - Push the client attribute stack - - .. seealso:: `OpenGL Docs `__ - - :type mask: Enumerated constant(s) - :arg mask: Specifies a mask that indicates which attributes to save. - - -.. function:: glPushMatrix(): - - Push the current matrix stack - - .. seealso:: `OpenGL Docs `__ - - -.. function:: glPushName(name): - - Push the name stack - - .. seealso:: `OpenGL Docs `__ - - :type name: unsigned int - :arg name: Specifies a name that will be pushed onto the name stack. - - .. function:: glRasterPos (x,y,z,w): B{glRasterPos2d, glRasterPos2f, glRasterPos2i, glRasterPos2s, glRasterPos3d, @@ -1453,16 +972,6 @@ offers a set of extensive examples, including advanced features. to the opposite vertex of the rectangle -.. function:: glRenderMode(mode): - - Set rasterization mode - - .. seealso:: `OpenGL Docs `__ - - :type mode: Enumerated constant - :arg mode: Specifies the rasterization mode. - - .. function:: glRotate (angle, x, y, z): B{glRotated, glRotatef} @@ -1503,28 +1012,6 @@ offers a set of extensive examples, including advanced features. dimensions of that window. -.. function:: glSelectBuffer(size, buffer): - - Establish a buffer for selection mode values - - .. seealso:: `OpenGL Docs `__ - - :type size: int - :arg size: Specifies the size of buffer - :type buffer: :class:`bgl.Buffer` I{type GL_INT} - :arg buffer: Returns the selection data - - -.. function:: glShadeModel(mode): - - Select flat or smooth shading - - .. seealso:: `OpenGL Docs `__ - - :type mode: Enumerated constant - :arg mode: Specifies a symbolic value representing a shading technique. - - .. function:: glStencilFunc(func, ref, mask): Set function and reference value for stencil testing @@ -1757,99 +1244,6 @@ offers a set of extensive examples, including advanced features. dimensions of that window. -.. function:: gluPerspective(fovY, aspect, zNear, zFar): - - Set up a perspective projection matrix. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluPerspective.xml - - :type fovY: double - :arg fovY: Specifies the field of view angle, in degrees, in the y direction. - :type aspect: double - :arg aspect: Specifies the aspect ratio that determines the field of view in the x direction. - The aspect ratio is the ratio of x (width) to y (height). - :type zNear: double - :arg zNear: Specifies the distance from the viewer to the near clipping plane (always positive). - :type zFar: double - :arg zFar: Specifies the distance from the viewer to the far clipping plane (always positive). - - -.. function:: gluLookAt(eyex, eyey, eyez, centerx, centery, centerz, upx, upy, upz): - - Define a viewing transformation. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluLookAt.xml - - :type eyex, eyey, eyez: double - :arg eyex, eyey, eyez: Specifies the position of the eye point. - :type centerx, centery, centerz: double - :arg centerx, centery, centerz: Specifies the position of the reference point. - :type upx, upy, upz: double - :arg upx, upy, upz: Specifies the direction of the up vector. - - -.. function:: gluOrtho2D(left, right, bottom, top): - - Define a 2-D orthographic projection matrix. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluOrtho2D.xml - - :type left, right: double - :arg left, right: Specify the coordinates for the left and right vertical clipping planes. - :type bottom, top: double - :arg bottom, top: Specify the coordinates for the bottom and top horizontal clipping planes. - - -.. function:: gluPickMatrix(x, y, width, height, viewport): - - Define a picking region. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluPickMatrix.xml - - :type x, y: double - :arg x, y: Specify the center of a picking region in window coordinates. - :type width, height: double - :arg width, height: Specify the width and height, respectively, of the picking region in window coordinates. - :type viewport: :class:`bgl.Buffer` object. [int] - :arg viewport: Specifies the current viewport. - - -.. function:: gluProject(objx, objy, objz, modelMatrix, projMatrix, viewport, winx, winy, winz): - - Map object coordinates to window coordinates. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluProject.xml - - :type objx, objy, objz: double - :arg objx, objy, objz: Specify the object coordinates. - :type modelMatrix: :class:`bgl.Buffer` object. [double] - :arg modelMatrix: Specifies the current modelview matrix (as from a glGetDoublev call). - :type projMatrix: :class:`bgl.Buffer` object. [double] - :arg projMatrix: Specifies the current projection matrix (as from a glGetDoublev call). - :type viewport: :class:`bgl.Buffer` object. [int] - :arg viewport: Specifies the current viewport (as from a glGetIntegerv call). - :type winx, winy, winz: :class:`bgl.Buffer` object. [double] - :arg winx, winy, winz: Return the computed window coordinates. - - -.. function:: gluUnProject(winx, winy, winz, modelMatrix, projMatrix, viewport, objx, objy, objz): - - Map object coordinates to window coordinates. - - .. seealso:: https://www.opengl.org/sdk/docs/man2/xhtml/gluUnProject.xml - - :type winx, winy, winz: double - :arg winx, winy, winz: Specify the window coordinates to be mapped. - :type modelMatrix: :class:`bgl.Buffer` object. [double] - :arg modelMatrix: Specifies the current modelview matrix (as from a glGetDoublev call). - :type projMatrix: :class:`bgl.Buffer` object. [double] - :arg projMatrix: Specifies the current projection matrix (as from a glGetDoublev call). - :type viewport: :class:`bgl.Buffer` object. [int] - :arg viewport: Specifies the current viewport (as from a glGetIntegerv call). - :type objx, objy, objz: :class:`bgl.Buffer` object. [double] - :arg objx, objy, objz: Return the computed object coordinates. - - .. function:: glUseProgram(program): Installs a program object as part of current rendering state -- cgit v1.2.3