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