• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!ELEMENT OpenGLAPI (category?, xi:include?, OpenGLAPI?)+>
2<!ELEMENT category (type*, enum*, function*)*>
3<!ELEMENT type EMPTY>
4<!ELEMENT enum (size*)>
5<!ELEMENT size EMPTY>
6<!ELEMENT function (param*, return?, glx?)*>
7<!ELEMENT param EMPTY>
8<!ELEMENT return EMPTY>
9<!ELEMENT glx EMPTY>
10
11<!ELEMENT xi:include (xi:fallback)?>
12<!ATTLIST xi:include
13          xmlns:xi  CDATA #FIXED "http://www.w3.org/2001/XInclude"
14          href       CDATA #REQUIRED
15          parse      (xml|text) "xml"
16          encoding   CDATA #IMPLIED>
17<!ELEMENT xi:fallback ANY>
18<!ATTLIST xi:fallback
19          xmlns:xi   CDATA #FIXED "http://www.w3.org/2001/XInclude">
20
21
22<!ATTLIST category name                NMTOKEN #REQUIRED
23                   number              NMTOKEN #IMPLIED
24		   window_system       NMTOKEN #IMPLIED>
25<!ATTLIST type     name                NMTOKEN #REQUIRED
26                   size                NMTOKEN #REQUIRED
27		   float               (true | false) "false"
28		   unsigned            (true | false) "false"
29		   pointer             (true | false) "false"
30                   glx_name            NMTOKEN #IMPLIED>
31<!ATTLIST enum     name                NMTOKEN #REQUIRED
32                   count               CDATA   #IMPLIED
33                   value               NMTOKEN #REQUIRED>
34<!ATTLIST function name                NMTOKEN #REQUIRED
35                   alias               NMTOKEN #IMPLIED
36                   vectorequiv         NMTOKEN #IMPLIED
37                   es1                 CDATA   "none"
38                   es2                 CDATA   "none"
39                   deprecated          CDATA   "none"
40                   exec                NMTOKEN #IMPLIED
41                   desktop             (true | false) "true">
42<!ATTLIST size     name                NMTOKEN #REQUIRED
43                   count               NMTOKEN #IMPLIED
44                   mode                (get | set) "set">
45<!ATTLIST param    name                NMTOKEN #REQUIRED
46                   type                CDATA   #REQUIRED
47		   client_only	       (true | false) "false"
48                   count               NMTOKEN #IMPLIED
49                   counter             (true | false) "false"
50                   count_scale         NMTOKEN "1"
51                   output              (true | false) "false"
52                   padding             (true | false) "false"
53                   img_width           NMTOKEN #IMPLIED
54                   img_height          NMTOKEN #IMPLIED
55                   img_depth           NMTOKEN #IMPLIED
56                   img_extent          NMTOKEN #IMPLIED
57                   img_xoff            NMTOKEN #IMPLIED
58                   img_yoff            NMTOKEN #IMPLIED
59                   img_zoff            NMTOKEN #IMPLIED
60                   img_woff            NMTOKEN #IMPLIED
61                   img_format          NMTOKEN #IMPLIED
62                   img_type            NMTOKEN #IMPLIED
63                   img_target          NMTOKEN #IMPLIED
64                   img_send_null       (true | false) "false"
65                   img_null_flag       (true | false) "false"
66                   img_pad_dimensions  (true | false) "false"
67                   variable_param      NMTOKENS #IMPLIED>
68<!ATTLIST return   type                CDATA   "void">
69<!ATTLIST glx      rop                 NMTOKEN #IMPLIED
70                   sop                 NMTOKEN #IMPLIED
71                   vendorpriv          NMTOKEN #IMPLIED
72                   large               (true | false) "false"
73                   doubles_in_order    (true | false) "false"
74                   always_array        (true | false) "false"
75                   handcode            (true | false | client | server) "false"
76                   img_reset           NMTOKEN #IMPLIED
77                   dimensions_in_reply (true | false) "false"
78                   ignore              (true | false) "false">
79
80<!--
81The various attributes for param and glx have the meanings listed below.
82When adding new functions, please annote them correctly.  In most cases this
83will just mean adding a '<glx ignore="true"/>' tag.
84
85param:
86     name - name of the parameter
87     type - fully qualified type (e.g., with "const", etc.)
88     client_only - boolean flag set on parameters which are interpreted only
89         by the client and are not present in the protocol encoding (e.g.,
90	 the stride parameters to Map1f, etc.)
91     count - for counted arrays (e.g., the 'lists' parameter to glCallLists),
92         the parameter or literal that represents the count.  For functions
93         like glVertex3fv it will be a litteral, for others it will be one of
94         the parameters.
95     counter - this parameter is a counter that will be referenced by the
96         'count' attribute in another parameter.
97     count_scale - literal value scale factor for the 'count' attribute.
98         See ProgramParameters4dvNV for an example.
99     output - this parameter is used to store the output of the function.
100     variable_param - name of parameter used to determine the number of
101         elements referenced by this parameter.  This should be the name of a
102         single enum parameter.  Most of the gl*Parameter[if]v functions use
103         this.  Additionally, the enums that can be passed should be properly
104         annotated.
105     img_width / img_height / img_depth / img_extent - name of parameters
106         (or hardcoded integer) used for the dimensions of pixel data.
107     img_xoff / img_yoff / img_zoff / img_woff - name of parameters used
108         for x, y, z, and w offsets of pixel data.
109     img_format - name of parameter used as the pixel data format.
110     img_type - name of parameter used as the pixel data type.
111     img_target - name of parameter used as a texture target.  Non-texture
112        pixel data should hardcode 0.
113     img_send_null - boolean flag to determine if blank pixel data should
114        be sent when a NULL pointer is passed.  This is only used by
115        TexImage1D and TexImage2D.
116     img_null_flag - boolean flag to determine if an extra flag is used to
117        determine if a NULL pixel pointer was passed.  This is used by
118        TexSubImage1D, TexSubImage2D, TexImage3D and others.
119     img_pad_dimensions - boolean flag to determine if dimension data and
120        offset data should be padded to the next even number of dimensions.
121        For example, this will insert an empty "height" field after the
122        "width" field in the protocol for TexImage1D.
123
124glx:
125     rop - Opcode value for "render" commands
126     sop - Opcode value for "single" commands
127     vendorpriv - Opcode value for vendor private (or vendor private with
128         reply) commands
129     large - set to "true" of the render command can use RenderLarge protocol.
130     doubles_in_order - older commands always put GLdouble data at the
131         start of the render packet.  Newer commands (e.g.,
132         ProgramEnvParameter4dvARB) put the in the order that they appear
133         in the parameter list.
134     always_array - some single commands take reply data as an array or as
135         return value data (e.g., glGetLightfv).  Other single commands take
136         reply data only as an array (e.g., glGetClipPlane).
137     handcode - some functions are just too complicated to generate
138         (e.g., glSeperableFilter2D) or operate only on client-side data
139         (e.g., glVertexPointer) and must be handcoded.
140     ignore - some functions have an entry in the dispatch table, but aren't
141         suitable for protocol implementation (e.g., glLockArraysEXT).  This
142         also applies to functions that don't have any GLX protocol specified
143         (e.g., glGetFogFuncSGIS).
144-->
145