4.1.2.2. ManualParser
This modules provides an index of the OpenGL XML manual pages.
-
class PyOpenGLng.GlApi.ManualParser.Manual(name)[source]
Bases: dict
This class represents the root of an OpenGL API manual.
The dictionnary is index by function name.
Public Attributes:
-
classmethod load()[source]
Load the pickled files in the module path and return a dictionnary indexed by manual
name.
-
class PyOpenGLng.GlApi.ManualParser.ManualParser(manual_path)[source]
Bases: object
This class provides a manual indexer that parse the OpenGL XML manual pages.
Public Attributes:
manual
-
_parse_page(page_path)[source]
Parse an XML manual page and build the Page.
-
_parse_pages(manual_path)[source]
Parse the XML manual pages in the given directory.
-
class PyOpenGLng.GlApi.ManualParser.Page(function, page_name, purpose)[source]
Bases: object
This class represents the manual page of an OpenGL command.
Public Attributes:
- function
- function name
- page_name
- manual page name, a page can describe a group of functions.
- purpose
- function purpose
-
PyOpenGLng.GlApi.ManualParser.make_manual(manual_path)[source]
Build a Manual instance.