scripts/opengl/src_util.py

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