git.cworth.org Git - glaze/blob - specs/README

   1 This directory contains .def files listing all of the OpenGL functions
   2 for which Glaze creates ifunc resolvers so that libraries using Glaze
   3 can provide their own implementations.
   4
   5 The .def files are automatically generated from XML descriptions of
   6 the OpenGL API. The XML descriptions are included here as well, and
   7 were obtained by starting from the Khronos "OpenGL Registry" at:
   8
   9         http://www.opengl.org/registry/
  10
  11 From there, browse to the "XML API Registry" to find:
  12
  13         https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/
  14
  15 Where the actual .xml files can be downloaded.
  16
  17 The XML files are made available under the same license as Glaze
  18 itself, so are included in this directory.
  19
  20 The XML files contain much more information than Glaze needs. Glaze
  21 requires only the list of function names. We have written a one-liner
  22 script named xml2def that extracts the function names. That script is
  23 also included here.
  24
  25 The xml2def script depends on the XMLStarlet command-line XML toolkit
  26 which is aailable as a Debian package named "xmlstarlet" or available
  27 for download from:
  28
  29         http://xmlstar.sourceforge.net/
  30
  31 The simple .def files are the true "source" file used by Glaze, so
  32 even though they were generated from an XML document, the generated
  33 files are tracked under revision control here in this directory.
  34
  35 This means that a user of Glaze does not need to have xmlstarlet
  36 installed in order to compile Glaze.
  37