1# -*- coding: utf-8 -*-
2
3#-------------------------------------------------------------------------
4# drawElements Quality Program utilities
5# --------------------------------------
6#
7# Copyright 2015-2017 The Android Open Source Project
8#
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
12#
13#      http://www.apache.org/licenses/LICENSE-2.0
14#
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.
20#
21#-------------------------------------------------------------------------
22
23import os
24import re
25import sys
26
27sys.path.append(os.path.dirname(os.path.dirname(__file__)))
28
29import khr_util.format
30import khr_util.registry
31import khr_util.registry_cache
32
33SCRIPTS_DIR			= os.path.dirname(__file__)
34OPENGL_DIR			= os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "opengl"))
35EGL_DIR				= os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "egl"))
36OPENGL_INC_DIR		= os.path.join(OPENGL_DIR, "wrapper")
37
38GL_SOURCE			= khr_util.registry_cache.RegistrySource(
39						"https://raw.githubusercontent.com/KhronosGroup/OpenGL-Registry",
40						"xml/gl.xml",
41						"acc85f4b76949b015c0354bd8c20a1076a49b1cf",
42						"443d993e5d905d12b3903e2716d068326af518884988db69af72b6bdb665e6a7")
43
44EXTENSIONS			= [
45	'GL_KHR_texture_compression_astc_ldr',
46	'GL_KHR_blend_equation_advanced',
47	'GL_KHR_blend_equation_advanced_coherent',
48	'GL_KHR_debug',
49	'GL_EXT_robustness',
50	'GL_KHR_robustness',
51	'GL_KHR_no_error',
52	'GL_KHR_parallel_shader_compile',
53	'GL_EXT_bgra',
54	'GL_EXT_geometry_point_size',
55	'GL_EXT_tessellation_shader',
56	'GL_EXT_geometry_shader',
57	'GL_EXT_texture_buffer',
58	'GL_EXT_texture_filter_anisotropic',
59	'GL_EXT_texture_cube_map_array',
60	'GL_EXT_texture_snorm',
61	'GL_EXT_primitive_bounding_box',
62	'GL_EXT_texture_compression_s3tc',
63	'GL_EXT_texture_type_2_10_10_10_REV',
64	'GL_EXT_copy_image',
65	'GL_EXT_depth_bounds_test',
66	'GL_EXT_direct_state_access',
67	'GL_EXT_draw_buffers_indexed',
68	'GL_EXT_draw_elements_base_vertex',
69	'GL_EXT_direct_state_access',
70	'GL_EXT_read_format_bgra',
71	'GL_EXT_texture_storage',
72	'GL_EXT_texture_sRGB_decode',
73	'GL_EXT_texture_border_clamp',
74	'GL_EXT_texture_sRGB_R8',
75	'GL_EXT_texture_sRGB_RG8',
76	'GL_EXT_multisampled_render_to_texture',
77	'GL_EXT_debug_marker',
78	'GL_EXT_polygon_offset_clamp',
79	'GL_IMG_texture_compression_pvrtc',
80	'GL_OES_EGL_image',
81	'GL_OES_EGL_image_external',
82	'GL_OES_compressed_ETC1_RGB8_texture',
83	'GL_OES_compressed_paletted_texture',
84	'GL_OES_required_internalformat',
85	'GL_OES_packed_depth_stencil',
86	'GL_OES_texture_3D',
87	'GL_OES_texture_half_float',
88	'GL_OES_texture_storage_multisample_2d_array',
89	'GL_OES_sample_shading',
90	'GL_OES_standard_derivatives',
91	'GL_OES_stencil1',
92	'GL_OES_stencil4',
93	'GL_OES_surfaceless_context',
94	'GL_OES_mapbuffer',
95	'GL_OES_vertex_array_object',
96	'GL_OES_viewport_array',
97	'GL_ARB_clip_control',
98	'GL_ARB_buffer_storage',
99	'GL_ARB_compute_shader',
100	'GL_ARB_draw_indirect',
101	'GL_ARB_draw_instanced',
102	'GL_ARB_draw_elements_base_vertex',
103	'GL_ARB_direct_state_access',
104	'GL_ARB_get_program_binary',
105	'GL_ARB_gl_spirv',
106	'GL_ARB_indirect_parameters',
107	'GL_ARB_internalformat_query',
108	'GL_ARB_instanced_arrays',
109	'GL_ARB_multi_draw_indirect',
110	'GL_ARB_parallel_shader_compile',
111	'GL_ARB_program_interface_query',
112	'GL_ARB_separate_shader_objects',
113	'GL_ARB_shader_ballot',
114	'GL_ARB_shader_image_load_store',
115	'GL_ARB_shader_viewport_layer_array',
116	'GL_ARB_sparse_buffer',
117	'GL_ARB_sparse_texture',
118	'GL_ARB_spirv_extensions',
119	'GL_ARB_tessellation_shader',
120	'GL_ARB_texture_barrier',
121	'GL_ARB_texture_filter_minmax',
122	'GL_ARB_texture_gather',
123	'GL_ARB_texture_storage',
124	'GL_ARB_texture_storage_multisample',
125	'GL_ARB_texture_multisample',
126	'GL_ARB_texture_view',
127	'GL_ARB_transform_feedback2',
128	'GL_ARB_transform_feedback3',
129	'GL_ARB_transform_feedback_instanced',
130	'GL_ARB_transform_feedback_overflow_query',
131	'GL_ARB_vertex_array_bgra',
132	'GL_ARB_vertex_attrib_64bit',
133	'GL_ARB_vertex_attrib_binding',
134	'GL_NV_deep_texture3D',
135	'GL_NV_gpu_multicast',
136	'GL_NV_internalformat_sample_query',
137	'GL_NVX_cross_process_interop',
138	'GL_OES_draw_elements_base_vertex',
139	'GL_OVR_multiview',
140	'GL_OVR_multiview_multisampled_render_to_texture',
141]
142
143def getGLRegistry ():
144	return khr_util.registry_cache.getRegistry(GL_SOURCE)
145
146def getHybridInterface (stripAliasedExtCommands = True):
147	# This is a bit awkward, since we have to create a strange hybrid
148	# interface that includes both GL and ES features and extensions.
149	registry = getGLRegistry()
150	glFeatures = registry.getFeatures('gl')
151	esFeatures = registry.getFeatures('gles2')
152	spec = khr_util.registry.InterfaceSpec()
153
154	for feature in registry.getFeatures('gl'):
155		spec.addFeature(feature, 'gl', 'core')
156
157	for feature in registry.getFeatures('gles2'):
158		spec.addFeature(feature, 'gles2')
159
160	for extName in EXTENSIONS:
161		extension = registry.extensions[extName]
162		# Add all extensions using the ES2 api, but force even non-ES2
163		# extensions to be included.
164		spec.addExtension(extension, 'gles2', 'core', force=True)
165
166	iface = khr_util.registry.createInterface(registry, spec, 'gles2')
167
168	if stripAliasedExtCommands:
169		# Remove redundant extension commands that are already provided by core.
170		strippedCmds = []
171
172		for command in iface.commands:
173			if command.alias == None:
174				strippedCmds.append(command)
175
176		iface.commands = strippedCmds
177
178	return iface
179
180def getInterface (registry, api, version=None, profile=None, **kwargs):
181	spec = khr_util.registry.spec(registry, api, version, profile, **kwargs)
182	if api == 'gl' and profile == 'core' and version < "3.2":
183		gl32 = registry.features['GL_VERSION_3_2']
184		for eRemove in gl32.xpath('remove'):
185			spec.addComponent(eRemove)
186	return khr_util.registry.createInterface(registry, spec, api)
187
188def getVersionToken (api, version):
189	prefixes = { 'gles2': "ES", 'gl': "GL" }
190	return prefixes[api] + version.replace(".", "")
191
192def genCommandList(iface, renderCommand, directory, filename, align=False):
193	lines = map(renderCommand, iface.commands)
194	lines = filter(lambda l: l != None, lines)
195	if align:
196		lines = indentLines(lines)
197	writeInlFile(os.path.join(directory, filename), lines)
198
199def genCommandLists(registry, renderCommand, check, directory, filePattern, align=False):
200	for eFeature in registry.features:
201		api			= eFeature.get('api')
202		version		= eFeature.get('number')
203		profile		= check(api, version)
204		if profile is True:
205			profile = None
206		elif profile is False:
207			continue
208		iface		= getInterface(registry, api, version=version, profile=profile)
209		filename	= filePattern % getVersionToken(api, version)
210		genCommandList(iface, renderCommand, directory, filename, align)
211
212def getFunctionTypeName (funcName):
213	return "%sFunc" % funcName
214
215def getFunctionMemberName (funcName):
216	assert funcName[:2] == "gl"
217	if funcName[:5] == "glEGL":
218		# Otherwise we end up with gl.eGLImage...
219		return "egl%s" % funcName[5:]
220	else:
221		return "%c%s" % (funcName[2].lower(), funcName[3:])
222
223INL_HEADER = khr_util.format.genInlHeader("Khronos GL API description (gl.xml)", GL_SOURCE.getRevision())
224
225def writeInlFile (filename, source):
226	khr_util.format.writeInlFile(filename, INL_HEADER, source)
227
228# Aliases from khr_util.common
229indentLines			= khr_util.format.indentLines
230normalizeConstant	= khr_util.format.normalizeConstant
231commandParams		= khr_util.format.commandParams
232commandArgs			= khr_util.format.commandArgs
233