@c %start of fragment
+The functions from this section may be had by loading the module:
+
+@example
+(use-modules (figl glx low-level)
+@end example
+
@copying
This section of the manual was derived from the upstream OpenGL
documentation. Each function's documentation has its own copyright
@end copying
-The functions from this section may be had by loading the module:
+@deftypefun GLXFBConfig-* glXChooseFBConfig dpy screen attrib_list nelements
+Return a list of GLX frame buffer configurations that match the
+specified attributes.
-@example
-(use-modules (figl low-level glx))
-@end example
-
-@defun glXChooseFBConfig
-@heading return a list of GLX frame buffer configurations that match the specified attributes
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXChooseFBConfig} returns GLX frame buffer configurations that
match the attributes specified in @var{attrib_list}, or @code{NULL} if
no matches are found. If @var{attrib_list} is @code{NULL}, then
@end table
-@heading Errors
@code{NULL} is returned if an undefined GLX attribute is encountered in
@var{attrib_list}, if @var{screen} is invalid, or if @var{dpy} does not
support the GLX extension.
-@end defun
+@end deftypefun
+
+@deftypefun XVisualInfo* glXChooseVisual dpy screen attribList
+Return a visual that matches specified attributes.
-@defun glXChooseVisual
-@heading return a visual that matches specified attributes
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXChooseVisual} returns a pointer to an XVisualInfo structure
describing the visual that best meets a minimum specification. The
boolean GLX attributes of the visual that is returned will match the
@end table
-@heading Errors
@code{NULL} is returned if an undefined GLX attribute is encountered in
@var{attribList}.
-@end defun
+@end deftypefun
+
+@deftypefun void glXCopyContext dpy src dst mask
+Copy state from one rendering context to another.
-@defun glXCopyContext
-@heading copy state from one rendering context to another
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCopyContext} copies selected groups of state variables from
@var{src} to @var{dst}. @var{mask} indicates which groups of state
variables are to be copied. @var{mask} contains the bitwise OR of the
An implicit @code{glFlush} is done by @code{glXCopyContext} if @var{src}
is the current context for the calling thread.
-@heading Errors
@code{BadMatch} is generated if rendering contexts @var{src} and
@var{dst} do not share an address space or were not created with respect
to the same screen.
@code{GLXBadContext} is generated if either @var{src} or @var{dst} is
not a valid GLX context.
-@end defun
+@end deftypefun
+
+@deftypefun GLXContext glXCreateContext dpy vis shareList direct
+Create a new GLX rendering context.
-@defun glXCreateContext
-@heading create a new GLX rendering context
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreateContext} creates a GLX rendering context and returns its
handle. This context can be used to render into both windows and GLX
pixmaps. If @code{glXCreateContext} fails to create a rendering context,
If the GL version is 1.1 or greater, then all texture objects except
object 0 are shared by any contexts that share display lists.
-@heading Errors
@code{NULL} is returned if execution fails on the client side.
@code{BadMatch} is generated if the context to be created would not
@code{BadAlloc} is generated if the server does not have enough
resources to allocate the new context.
-@end defun
+@end deftypefun
+
+@deftypefun GLXPixmap glXCreateGLXPixmap dpy vis pixmap
+Create an off-screen GLX rendering area.
-@defun glXCreateGLXPixmap
-@heading create an off-screen GLX rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreateGLXPixmap} creates an off-screen rendering area and
returns its XID. Any GLX rendering context that was created with respect
to @var{vis} can be used to render into this off-screen area. Use
Some implementations may not support GLX pixmaps with direct rendering
contexts.
-@heading Errors
@code{BadMatch} is generated if the depth of @var{pixmap} does not match
the depth value reported by core X11 for @var{vis}, or if @var{pixmap}
was not created with respect to the same screen as @var{vis}.
@code{BadAlloc} is generated if the server cannot allocate the GLX
pixmap.
-@end defun
+@end deftypefun
+
+@deftypefun GLXContext glXCreateNewContext dpy config render_type share_list direct
+Create a new GLX rendering context.
-@defun glXCreateNewContext
-@heading create a new GLX rendering context
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreateNewContext} creates a GLX rendering context and returns
its handle. This context can be used to render into GLX windows,
pixmaps, or pixel buffers. If @code{glXCreateNewContext} fails to create
shared outside a single process, and they may be unable to render to GLX
pixmaps.
-@heading Errors
@code{NULL} is returned if execution fails on the client side.
@code{GLXBadContext} is generated if @var{render_type} is not a GLX
@code{BadValue} is generated if @var{config} is not a valid visual (for
example, if a particular GLX implementation does not support it).
-@end defun
+@end deftypefun
+
+@deftypefun GLXPbuffer glXCreatePbuffer dpy config attrib_list
+Create an off-screen rendering area.
-@defun glXCreatePbuffer
-@heading create an off-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreatePbuffer} creates an off-screen rendering area and returns
its XID. Any GLX rendering context that was created with respect to
@var{config} can be used to render into this window. Use
@var{config}. It is possible to create a pixel buffer with back buffers
and to swap those buffers using @code{glXSwapBuffers}.
-@heading Errors
@code{BadAlloc} is generated if there are insufficient resources to
allocate the requested GLXPbuffer.
to pixel buffers (e.g., @code{GLX_DRAWABLE_TYPE} does not contain
@code{GLX_PBUFFER_BIT}).
-@end defun
+@end deftypefun
+
+@deftypefun GLXPixmap glXCreatePixmap dpy config pixmap attrib_list
+Create an off-screen rendering area.
-@defun glXCreatePixmap
-@heading create an off-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreatePixmap} creates an off-screen rendering area and returns
its XID. Any GLX rendering context that was created with respect to
@var{config} can be used to render into this window. Use
@code{glXMakeCurrent} to associate the rendering area with a GLX
rendering context.
-@heading Errors
@code{BadMatch} is generated if @var{pixmap} was not created with a
visual that corresponds to @var{config}.
-@end defun
+@end deftypefun
+
+@deftypefun GLXWindow glXCreateWindow dpy config win attrib_list
+Create an on-screen rendering area.
-@defun glXCreateWindow
-@heading create an on-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXCreateWindow} creates an on-screen rendering area from an
existing X window that was created with a visual matching @var{config}.
The XID of the GLXWindow is returned. Any GLX rendering context that was
window. Use @code{glXMakeContextCurrent} to associate the rendering area
with a GLX rendering context.
-@heading Errors
@code{BadMatch} is generated if @var{win} was not created with a visual
that corresponds to @var{config}.
-@end defun
+@end deftypefun
+
+@deftypefun void glXDestroyContext dpy ctx
+Destroy a GLX context.
-@defun glXDestroyContext
-@heading destroy a GLX context
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
If the GLX rendering context @var{ctx} is not current to any thread,
@code{glXDestroyContext} destroys it immediately. Otherwise, @var{ctx}
is destroyed when it becomes not current to any thread. In either case,
the resource ID referenced by @var{ctx} is freed immediately.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
context.
-@end defun
+@end deftypefun
+
+@deftypefun void glXDestroyGLXPixmap dpy pix
+Destroy a GLX pixmap.
-@defun glXDestroyGLXPixmap
-@heading destroy a GLX pixmap
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
If the GLX pixmap @var{pix} is not current to any client,
@code{glXDestroyGLXPixmap} destroys it immediately. Otherwise, @var{pix}
is destroyed when it becomes not current to any client. In either case,
the resource ID is freed immediately.
-@heading Errors
@code{GLXBadPixmap} is generated if @var{pix} is not a valid GLX pixmap.
-@end defun
+@end deftypefun
+
+@deftypefun void glXDestroyPbuffer dpy pbuf
+Destroy an off-screen rendering area.
-@defun glXDestroyPbuffer
-@heading destroy an off-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXDestroyPbuffer} destroys a GLXPbuffer created by
@code{glXCreatePbuffer}.
-@heading Errors
@code{GLXBadPbuffer} is generated if @var{pbuf} is not a valid
GLXPbuffer.
-@end defun
+@end deftypefun
+
+@deftypefun void glXDestroyPixmap dpy pixmap
+Destroy an off-screen rendering area.
-@defun glXDestroyPixmap
-@heading destroy an off-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXDestroyPixmap} destroys a GLXPixmap created by
@code{glXCreatePixmap}.
-@heading Errors
@code{GLXBadPixmap} is generated if @var{pixmap} is not a valid
GLXPixmap.
-@end defun
+@end deftypefun
+
+@deftypefun void glXDestroyWindow dpy win
+Destroy an on-screen rendering area.
-@defun glXDestroyWindow
-@heading destroy an on-screen rendering area
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXDestroyWindow} destroys a GLXWindow created by
@code{glXCreateWindow}.
-@heading Errors
@code{GLXBadWindow} is generated if @var{win} is not a valid GLXPixmap.
-@end defun
+@end deftypefun
+
+@deftypefun void glXFreeContextEXT dpy ctx
+Free client-side memory for imported context.
-@defun glXFreeContextEXT
-@heading free client-side memory for imported context
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXFreeContextEXT} frees the client-side part of a GLXContext that
was created with @code{glXImportContextEXT}. @code{glXFreeContextEXT}
does not free the server-side context information or the XID associated
@code{glXQueryExtensionsString}, when called with argument
@code{GLX_EXTENSIONS}, extension @code{EXT_vertex_array} is supported.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
context.
-@end defun
+@end deftypefun
+
+@deftypefun const-char-* glXGetClientString dpy name
+Return a string describing the client.
-@defun glXGetClientString
-@heading return a string describing the client
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXGetClientString} returns a string describing some aspect of the
client library. The possible values for @var{name} are
@code{GLX_VENDOR}, @code{GLX_VERSION}, and @code{GLX_EXTENSIONS}. If
length. The vendor-specific information is optional. However, if it is
present, the format and contents are implementation specific.
-@end defun
+@end deftypefun
+
+@deftypefun int glXGetConfig dpy vis attrib value
+Return information about GLX visuals.
-@defun glXGetConfig
-@heading return information about GLX visuals
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXGetConfig} sets @var{value} to the @var{attrib} value of
windows or GLX pixmaps created with respect to @var{vis}.
@code{glXGetConfig} returns an error code if it fails for any reason.
unnecessary buffers can result in reduced rendering performance as well
as poor resource allocation.
-@heading Errors
@code{GLX_NO_EXTENSION} is returned if @var{dpy} does not support the
GLX extension.
@code{GLX_BAD_VISUAL} is returned if @var{vis} doesn't support GLX and
an attribute other than @code{GLX_USE_GL} is requested.
-@end defun
+@end deftypefun
+
+@deftypefun GLXContextID glXGetContextIDEXT ctx
+Get the XID for a context..
-@defun glXGetContextIDEXT
-@heading get the XID for a context.
-@heading Parameters
@table @asis
@item @var{ctx}
Specifies a GLX rendering context.
@end table
-@heading Description
@code{glXGetContextIDEXT} returns the XID associated with a GLXContext.
No round trip is forced to the server; unlike most X calls that return a
@code{glXQueryExtensionsString}, when called with argument
@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
context.
-@end defun
+@end deftypefun
+
+@deftypefun GLXContext glXGetCurrentContext
+Return the current context.
-@defun glXGetCurrentContext
-@heading return the current context
-@heading Description
@code{glXGetCurrentContext} returns the current context, as specified by
@code{glXMakeCurrent}. If there is no current context, @code{NULL} is
returned.
-@end defun
+@end deftypefun
+
+@deftypefun Display-* glXGetCurrentDisplay
+Get display for current context.
-@defun glXGetCurrentDisplay
-@heading get display for current context
-@heading Description
@code{glXGetCurrentDisplay} returns the display for the current context.
If no context is current, @code{NULL} is returned.
make a round-trip to the server, and therefore does not flush any
pending events.
-@end defun
+@end deftypefun
+
+@deftypefun GLXDrawable glXGetCurrentDrawable
+Return the current drawable.
-@defun glXGetCurrentDrawable
-@heading return the current drawable
-@heading Description
@code{glXGetCurrentDrawable} returns the current drawable, as specified
by @code{glXMakeCurrent}. If there is no current drawable, @code{None}
is returned.
@code{glXGetCurrentDrawable} returns client-side information. It does
not make a round trip to the server.
-@end defun
+@end deftypefun
+
+@deftypefun GLXDrawable glXGetCurrentReadDrawable
+Return the current drawable.
-@defun glXGetCurrentReadDrawable
-@heading return the current drawable
-@heading Description
@code{glXGetCurrentReadDrawable} returns the current read drawable, as
specified by @code{read} parameter of @code{glXMakeContextCurrent}. If
there is no current drawable, @code{None} is returned.
@code{glXGetCurrentReadDrawable} returns client-side information. It
does not make a round-trip to the server.
-@end defun
+@end deftypefun
+
+@deftypefun int glXGetFBConfigAttrib dpy config attribute value
+Return information about a GLX frame buffer configuration.
-@defun glXGetFBConfigAttrib
-@heading return information about a GLX frame buffer configuration
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXGetFBConfigAttrib} sets @var{value} to the @var{attribute}
value of GLX drawables created with respect to @var{config}.
@code{glXGetFBConfigAttrib} returns an error code if it fails for any
pixel buffers with unnecessary buffers can result in reduced rendering
performance as well as poor resource allocation.
-@heading Errors
@code{GLX_NO_EXTENSION} is returned if @var{dpy} does not support the
GLX extension. @code{GLX_BAD_ATTRIBUTE} is returned if @var{attribute}
is not a valid GLX attribute.
-@end defun
+@end deftypefun
+
+@deftypefun GLXFBConfig-* glXGetFBConfigs dpy screen nelements
+List all GLX frame buffer configurations for a given screen.
-@defun glXGetFBConfigs
-@heading list all GLX frame buffer configurations for a given screen
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXGetFBConfigs} returns a list of all GLXFBConfigs available on
the screen specified by @var{screen}. Use @code{glXGetFBConfigAttrib} to
obtain attribute values from a specific GLXFBConfig.
-@end defun
+@end deftypefun
+
+@deftypefun void(*)() glXGetProcAddress procName
+Obtain a pointer to an OpenGL or GLX function.
-@defun glXGetProcAddress
-@heading obtain a pointer to an OpenGL or GLX function
-@heading Parameters
@table @asis
@item @var{procName}
Specifies the name of the OpenGL or GLX function whose address is to be
@end table
-@heading Description
@code{glXGetProcAddress} returns the address of the function specified
in @var{procName}. This is necessary in environments where the OpenGL
link library exports a different set of functions than the runtime
library.
-@end defun
+@end deftypefun
+
+@deftypefun void glXGetSelectedEvent dpy draw event_mask
+Returns GLX events that are selected for a window or a GLX pixel buffer.
-@defun glXGetSelectedEvent
-@heading returns GLX events that are selected for a window or a GLX pixel buffer
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXGetSelectedEvent} returns in @var{event_mask} the events
selected for @var{draw}.
-@heading Errors
@code{GLXBadDrawable} is generated if @var{draw} is not a valid window
or a valid GLX pixel buffer.
-@end defun
+@end deftypefun
+
+@deftypefun XVisualInfo-* glXGetVisualFromFBConfig dpy config
+Return visual that is associated with the frame buffer configuration.
-@defun glXGetVisualFromFBConfig
-@heading return visual that is associated with the frame buffer configuration
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
If @var{config} is a valid GLX frame buffer configuration and it has an
associated X Visual, then information describing that visual is
returned; otherwise @code{NULL} is returned. Use @code{XFree} to free
the data returned.
-@heading Errors
Returns @code{NULL} if @var{config} is not a valid GLXFBConfig.
-@end defun
+@end deftypefun
+
+@deftypefun GLXContext glXImportContextEXT dpy contextID
+Import another process's indirect rendering context..
-@defun glXImportContextEXT
-@heading import another process's indirect rendering context.
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXImportContextEXT} creates a GLXContext given the XID of an
existing GLXContext. It may be used in place of @code{glXCreateContext},
to share another process's indirect rendering context.
@code{glXQueryExtensionsString}, when called with argument
@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
-@heading Errors
@code{GLXBadContext} is generated if @var{contextID} does not refer to a
valid context.
-@end defun
+@end deftypefun
-@defun glXIntro
-@heading Introduction to OpenGL in the X window system
-@end defun
+@deftypefun Bool glXIsDirect dpy ctx
+Indicate whether direct rendering is enabled.
-@defun glXIsDirect
-@heading indicate whether direct rendering is enabled
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXIsDirect} returns @code{True} if @var{ctx} is a direct
rendering context, @code{False} otherwise. Direct rendering contexts
pass rendering commands directly from the calling process's address
space to the rendering system, bypassing the X server. Nondirect
rendering contexts pass all rendering commands to the X server.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
context.
-@end defun
+@end deftypefun
+
+@deftypefun Bool glXMakeContextCurrent display draw read ctx
+Attach a GLX context to a GLX drawable.
-@defun glXMakeContextCurrent
-@heading attach a GLX context to a GLX drawable
-@heading Parameters
@table @asis
@item @var{display}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXMakeContextCurrent} binds @var{ctx} to the current rendering
thread and to the @var{draw} and @var{read} GLX drawables. @var{draw}
and @var{read} may be the same.
@code{False} otherwise. If @code{False} is returned, the previously
current rendering context and drawable (if any) remain unchanged.
-@heading Errors
@code{BadMatch} is generated if @var{draw} and @var{read} are not
compatible.
@var{draw} or @var{read} is a GLXWindow or GLXPbuffer and @var{ctx} was
previously bound to a GLXPixmap.
-@end defun
+@end deftypefun
+
+@deftypefun Bool glXMakeCurrent dpy drawable ctx
+Attach a GLX context to a window or a GLX pixmap.
-@defun glXMakeCurrent
-@heading attach a GLX context to a window or a GLX pixmap
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXMakeCurrent} does two things: It makes @var{ctx} the current
GLX rendering context of the calling thread, replacing the previously
current context if there was one, and it attaches @var{ctx} to a GLX
@code{False} otherwise. If @code{False} is returned, the previously
current rendering context and drawable (if any) remain unchanged.
-@heading Errors
@code{BadMatch} is generated if @var{drawable} was not created with the
same X screen and visual as @var{ctx}. It is also generated if
@var{drawable} is @code{None} and @var{ctx} is not @code{NULL}.
ancillary buffers until @code{glXMakeCurrent} is called, only to find
that it has insufficient resources to complete the allocation.
-@end defun
+@end deftypefun
+
+@deftypefun int glXQueryContextInfoEXT dpy ctx attribute value
+Query context information.
-@defun glXQueryContextInfoEXT
-@heading query context information
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryContextInfoEXT} sets @var{value} to the value of
@var{attribute} with respect to @var{ctx}. @code{glXQueryContextInfoEXT}
returns an error code if it fails for any reason. Otherwise,
@code{glXQueryExtensionsString}, when called with argument
@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
context.
fred @code{GLX_BAD_CONTEXT} is returned if @var{attribute} is not a
valid context.
-@end defun
+@end deftypefun
+
+@deftypefun int glXQueryContext dpy ctx attribute value
+Query context information.
-@defun glXQueryContext
-@heading query context information
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryContext} sets @var{value} to the value of @var{attribute}
with respect to @var{ctx}. @var{attribute} may be one of the following:
This call may cause a round-trip to the server.
-@heading Errors
@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
context.
-@end defun
+@end deftypefun
+
+@deftypefun int glXQueryDrawable dpy draw attribute value
+Returns an attribute assoicated with a GLX drawable.
-@defun glXQueryDrawable
-@heading returns an attribute assoicated with a GLX drawable
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryDrawable} sets @var{value} to the value of @var{attribute}
with respect to the GLXDrawable @var{draw}.
contents of @var{value} are undefined. If @var{attribute} is not one of
the attributes listed above, the contents of @var{value} are unedfined.
-@heading Errors
A @code{GLXBadDrawable} is generated if @var{draw} is not a valid
GLXDrawable.
-@end defun
+@end deftypefun
+
+@deftypefun const-char-* glXQueryExtensionsString dpy screen
+Return list of supported extensions.
-@defun glXQueryExtensionsString
-@heading return list of supported extensions
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryExtensionsString} returns a pointer to a string describing
which GLX extensions are supported on the connection. The string is
null-terminated and contains a space-separated list of extension names.
(The extension names themselves never contain spaces.) If there are no
extensions to GLX, then the empty string is returned.
-@end defun
+@end deftypefun
+
+@deftypefun Bool glXQueryExtension dpy errorBase eventBase
+Indicate whether the GLX extension is supported.
-@defun glXQueryExtension
-@heading indicate whether the GLX extension is supported
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryExtension} returns @code{True} if the X server of
connection @var{dpy} supports the GLX extension, @code{False} otherwise.
If @code{True} is returned, then @var{errorBase} and @var{eventBase}
@var{errorBase} and @var{eventBase} do not return values if they are
specified as @code{NULL}.
-@end defun
+@end deftypefun
+
+@deftypefun const-char-* glXQueryServerString dpy screen name
+Return string describing the server.
-@defun glXQueryServerString
-@heading return string describing the server
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryServerString} returns a pointer to a static,
null-terminated string describing some aspect of the server's GLX
extension. The possible values for @var{name} and the format of the
strings is the same as for @code{glXGetClientString}. If @var{name} is
not set to a recognized value, @code{NULL} is returned.
-@end defun
+@end deftypefun
+
+@deftypefun Bool glXQueryVersion dpy major minor
+Return the version numbers of the GLX extension.
-@defun glXQueryVersion
-@heading return the version numbers of the GLX extension
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXQueryVersion} returns the major and minor version numbers of
the GLX extension implemented by the server associated with connection
@var{dpy}. Implementations with the same major version number are upward
@var{major} and @var{minor} do not return values if they are specified
as @code{NULL}.
-@heading Errors
@code{glXQueryVersion} returns @code{False} if it fails, @code{True}
otherwise.
@var{major} and @var{minor} are not updated when @code{False} is
returned.
-@end defun
+@end deftypefun
+
+@deftypefun void glXSelectEvent dpy draw event_mask
+Select GLX events for a window or a GLX pixel buffer.
-@defun glXSelectEvent
-@heading select GLX events for a window or a GLX pixel buffer
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXSelectEvent} sets the GLX event mask for a GLX pixel buffer or
a window. Calling @code{glXSelectEvent} overrides any previous event
mask that was set by the client for @var{draw}. Note that it does not
indicating which color buffers and ancillary buffers\(emand which
portions of those buffers\(emwere affected.
-@heading Errors
@code{GLXBadDrawable} is generated if @var{draw} is not a valid window
or a valid GLX pixel buffer.
-@end defun
+@end deftypefun
+
+@deftypefun void glXSwapBuffers dpy drawable
+Exchange front and back buffers.
-@defun glXSwapBuffers
-@heading exchange front and back buffers
-@heading Parameters
@table @asis
@item @var{dpy}
Specifies the connection to the X server.
@end table
-@heading Description
@code{glXSwapBuffers} promotes the contents of the back buffer of
@var{drawable} to become the contents of the front buffer of
@var{drawable}. The contents of the back buffer then become undefined.
If @var{drawable} was not created with respect to a double-buffered
visual, @code{glXSwapBuffers} has no effect, and no error is generated.
-@heading Errors
@code{GLXBadDrawable} is generated if @var{drawable} is not a valid GLX
drawable.
context of the calling thread, and @var{drawable} identifies a window
that is no longer valid.
-@end defun
+@end deftypefun
+
+@deftypefun void glXUseXFont font first count listBase
+Create bitmap display lists from an X font.
-@defun glXUseXFont
-@heading create bitmap display lists from an X font
-@heading Parameters
@table @asis
@item @var{font}
Specifies the font from which character glyphs are to be taken.
@end table
-@heading Description
@code{glXUseXFont} generates @var{count} display lists, named
-@var{listBase} through @math{@var{listBase}+@var{count}-1}, each
-containing a single @code{glBitmap} command. The parameters of the
-@code{glBitmap} command of display list @math{@var{listBase}+@var{i}}
-are derived from glyph @math{@var{first}+@var{i}}. Bitmap parameters
-@math{@var{xorig}}, @math{@var{yorig}}, @math{@var{width}}, and
-@math{@var{height}} are computed from font metrics as
-@math{@var{descent}-1}, @math{-@var{lbearing}},
-@math{@var{rbearing}-@var{lbearing}}, and
-@math{@var{ascent}+@var{descent}}, respectively. @math{@var{xmove}} is
-taken from the glyph's @math{@var{width}} metric, and @math{@var{ymove}}
-is set to zero. Finally, the glyph's image is converted to the
-appropriate format for @code{glBitmap}.
+@var{listBase} through @r{@var{listBase}+@var{count}-1}, each containing
+a single @code{glBitmap} command. The parameters of the @code{glBitmap}
+command of display list @r{@var{listBase}+@var{i}} are derived from
+glyph @r{@var{first}+@var{i}}. Bitmap parameters @r{@var{xorig}},
+@r{@var{yorig}}, @r{@var{width}}, and @r{@var{height}} are computed from
+font metrics as @r{@var{descent}-1}, @r{-@var{lbearing}},
+@r{@var{rbearing}-@var{lbearing}}, and @r{@var{ascent}+@var{descent}},
+respectively. @r{@var{xmove}} is taken from the glyph's @r{@var{width}}
+metric, and @r{@var{ymove}} is set to zero. Finally, the glyph's image
+is converted to the appropriate format for @code{glBitmap}.
Using @code{glXUseXFont} may be more efficient than accessing the X font
and generating the display lists explicitly, both because the display
are not defined in @var{font}. @code{glXUseXFont} is ignored if there is
no current GLX context.
-@heading Errors
@code{BadFont} is generated if @var{font} is not a valid font.
@code{GLXBadContextState} is generated if the current GLX context is in
the current context of the calling thread is a window, and that window
is no longer valid.
-@end defun
+@end deftypefun
+
+@deftypefun void glXWaitGL
+Complete GL execution prior to subsequent X calls.
-@defun glXWaitGL
-@heading complete GL execution prior to subsequent X calls
-@heading Description
GL rendering calls made prior to @code{glXWaitGL} are guaranteed to be
executed before X rendering calls made after @code{glXWaitGL}. Although
this same result can be achieved using @code{glFinish}, @code{glXWaitGL}
@code{glXWaitGL} is ignored if there is no current GLX context.
-@heading Errors
@code{GLXBadCurrentWindow} is generated if the drawable associated with
the current context of the calling thread is a window, and that window
is no longer valid.
-@end defun
+@end deftypefun
+
+@deftypefun void glXWaitX
+Complete X execution prior to subsequent GL calls.
-@defun glXWaitX
-@heading complete X execution prior to subsequent GL calls
-@heading Description
X rendering calls made prior to @code{glXWaitX} are guaranteed to be
executed before GL rendering calls made after @code{glXWaitX}. Although
the same result can be achieved using @code{XSync}, @code{glXWaitX} does
@code{glXWaitX} is ignored if there is no current GLX context.
-@heading Errors
@code{GLXBadCurrentWindow} is generated if the drawable associated with
the current context of the calling thread is a window, and that window
is no longer valid.
-@end defun
+@end deftypefun
@c %end of fragment
HCoop / clinton / guile-figl.git / blobdiff