1 # -*- coding: utf-8 -*-
3 #-------------------------------------------------------------------------
4 # drawElements Quality Program utilities
5 # --------------------------------------
7 # Copyright 2015-2017 The Android Open Source Project
9 # Licensed under the Apache License, Version 2.0 (the "License");
10 # you may not use this file except in compliance with the License.
11 # You may obtain a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
21 #-------------------------------------------------------------------------
27 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
29 import khr_util.format
30 import khr_util.registry
31 import khr_util.registry_cache
33 SCRIPTS_DIR = os.path.dirname(__file__)
34 OPENGL_DIR = os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "opengl"))
35 EGL_DIR = os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "egl"))
36 OPENGL_INC_DIR = os.path.join(OPENGL_DIR, "wrapper")
38 GL_SOURCE = khr_util.registry_cache.RegistrySource(
39 "https://raw.githubusercontent.com/KhronosGroup/OpenGL-Registry",
41 "967f96c92bae15baa1a4326a55222984befdc9ed",
42 "f281f2dc6b2206a8852670d161e15fa43723dac5042a991ff4e1702e29d7403d")
45 'GL_KHR_texture_compression_astc_ldr',
46 'GL_KHR_blend_equation_advanced',
47 'GL_KHR_blend_equation_advanced_coherent',
52 'GL_EXT_geometry_point_size',
53 'GL_EXT_tessellation_shader',
54 'GL_EXT_geometry_shader',
56 'GL_EXT_texture_buffer',
57 'GL_EXT_texture_filter_anisotropic',
58 'GL_EXT_texture_cube_map_array',
59 'GL_EXT_texture_snorm',
60 'GL_EXT_primitive_bounding_box',
61 'GL_EXT_texture_compression_s3tc',
62 'GL_EXT_texture_type_2_10_10_10_REV',
64 'GL_EXT_depth_bounds_test',
65 'GL_EXT_direct_state_access',
66 'GL_EXT_draw_buffers_indexed',
67 'GL_EXT_draw_elements_base_vertex',
68 'GL_EXT_direct_state_access',
69 'GL_EXT_read_format_bgra',
70 'GL_EXT_texture_storage',
71 'GL_EXT_texture_sRGB_decode',
72 'GL_EXT_texture_border_clamp',
73 'GL_EXT_texture_sRGB_R8',
74 'GL_EXT_texture_sRGB_RG8',
75 'GL_EXT_debug_marker',
76 'GL_IMG_texture_compression_pvrtc',
78 'GL_OES_EGL_image_external',
79 'GL_OES_compressed_ETC1_RGB8_texture',
80 'GL_OES_compressed_paletted_texture',
81 'GL_OES_required_internalformat',
82 'GL_OES_packed_depth_stencil',
84 'GL_OES_texture_half_float',
85 'GL_OES_texture_storage_multisample_2d_array',
86 'GL_OES_sample_shading',
87 'GL_OES_standard_derivatives',
90 'GL_OES_surfaceless_context',
92 'GL_OES_vertex_array_object',
93 'GL_OES_viewport_array',
94 'GL_ARB_clip_control',
95 'GL_ARB_buffer_storage',
96 'GL_ARB_compute_shader',
97 'GL_ARB_draw_instanced',
98 'GL_ARB_draw_elements_base_vertex',
99 'GL_ARB_direct_state_access',
100 'GL_ARB_get_program_binary',
101 'GL_ARB_indirect_parameters',
102 'GL_ARB_internalformat_query',
103 'GL_ARB_instanced_arrays',
104 'GL_ARB_multi_draw_indirect',
105 'GL_ARB_parallel_shader_compile',
106 'GL_ARB_program_interface_query',
107 'GL_ARB_separate_shader_objects',
108 'GL_ARB_shader_ballot',
109 'GL_ARB_shader_image_load_store',
110 'GL_ARB_shader_viewport_layer_array',
111 'GL_ARB_sparse_buffer',
112 'GL_ARB_sparse_texture',
113 'GL_ARB_tessellation_shader',
114 'GL_ARB_texture_barrier',
115 'GL_ARB_texture_filter_minmax',
116 'GL_ARB_texture_gather',
117 'GL_ARB_texture_storage',
118 'GL_ARB_texture_storage_multisample',
119 'GL_ARB_texture_multisample',
120 'GL_ARB_texture_view',
121 'GL_ARB_transform_feedback2',
122 'GL_ARB_transform_feedback3',
123 'GL_ARB_transform_feedback_instanced',
124 'GL_ARB_transform_feedback_overflow_query',
125 'GL_ARB_vertex_array_bgra',
126 'GL_ARB_vertex_attrib_64bit',
127 'GL_ARB_vertex_attrib_binding',
128 'GL_NV_deep_texture3D',
129 'GL_NV_internalformat_sample_query',
132 def getGLRegistry ():
133 return khr_util.registry_cache.getRegistry(GL_SOURCE)
135 def getHybridInterface (stripAliasedExtCommands = True):
136 # This is a bit awkward, since we have to create a strange hybrid
137 # interface that includes both GL and ES features and extensions.
138 registry = getGLRegistry()
139 glFeatures = registry.getFeatures('gl')
140 esFeatures = registry.getFeatures('gles2')
141 spec = khr_util.registry.InterfaceSpec()
143 for feature in registry.getFeatures('gl'):
144 spec.addFeature(feature, 'gl', 'core')
146 for feature in registry.getFeatures('gles2'):
147 spec.addFeature(feature, 'gles2')
149 for extName in EXTENSIONS:
150 extension = registry.extensions[extName]
151 # Add all extensions using the ES2 api, but force even non-ES2
152 # extensions to be included.
153 spec.addExtension(extension, 'gles2', 'core', force=True)
155 iface = khr_util.registry.createInterface(registry, spec, 'gles2')
157 if stripAliasedExtCommands:
158 # Remove redundant extension commands that are already provided by core.
161 for command in iface.commands:
162 if command.alias == None:
163 strippedCmds.append(command)
165 iface.commands = strippedCmds
169 def getInterface (registry, api, version=None, profile=None, **kwargs):
170 spec = khr_util.registry.spec(registry, api, version, profile, **kwargs)
171 if api == 'gl' and profile == 'core' and version < "3.2":
172 gl32 = registry.features['GL_VERSION_3_2']
173 for eRemove in gl32.xpath('remove'):
174 spec.addComponent(eRemove)
175 return khr_util.registry.createInterface(registry, spec, api)
177 def getVersionToken (api, version):
178 prefixes = { 'gles2': "ES", 'gl': "GL" }
179 return prefixes[api] + version.replace(".", "")
181 def genCommandList(iface, renderCommand, directory, filename, align=False):
182 lines = map(renderCommand, iface.commands)
183 lines = filter(lambda l: l != None, lines)
185 lines = indentLines(lines)
186 writeInlFile(os.path.join(directory, filename), lines)
188 def genCommandLists(registry, renderCommand, check, directory, filePattern, align=False):
189 for eFeature in registry.features:
190 api = eFeature.get('api')
191 version = eFeature.get('number')
192 profile = check(api, version)
195 elif profile is False:
197 iface = getInterface(registry, api, version=version, profile=profile)
198 filename = filePattern % getVersionToken(api, version)
199 genCommandList(iface, renderCommand, directory, filename, align)
201 def getFunctionTypeName (funcName):
202 return "%sFunc" % funcName
204 def getFunctionMemberName (funcName):
205 assert funcName[:2] == "gl"
206 if funcName[:5] == "glEGL":
207 # Otherwise we end up with gl.eGLImage...
208 return "egl%s" % funcName[5:]
210 return "%c%s" % (funcName[2].lower(), funcName[3:])
212 INL_HEADER = khr_util.format.genInlHeader("Khronos GL API description (gl.xml)", GL_SOURCE.getRevision())
214 def writeInlFile (filename, source):
215 khr_util.format.writeInlFile(filename, INL_HEADER, source)
217 # Aliases from khr_util.common
218 indentLines = khr_util.format.indentLines
219 normalizeConstant = khr_util.format.normalizeConstant
220 commandParams = khr_util.format.commandParams
221 commandArgs = khr_util.format.commandArgs