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                                                 "a3ee0ed08111d44ac3cb863d9e3e81a7c28f9d90",
  42                                                 "bfe070bafe6a0758f23964a078262b45ad163adf7f2dc320f44757908033d107")
  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_KHR_robustness',
  50         'GL_KHR_no_error',
  51         'GL_KHR_parallel_shader_compile',
  52         'GL_EXT_bgra',
  53         'GL_EXT_geometry_point_size',
  54         'GL_EXT_tessellation_shader',
  55         'GL_EXT_geometry_shader',
  56         'GL_EXT_robustness',
  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_debug_marker',
  77         'GL_EXT_polygon_offset_clamp',
  78         'GL_IMG_texture_compression_pvrtc',
  79         'GL_OES_EGL_image',
  80         'GL_OES_EGL_image_external',
  81         'GL_OES_compressed_ETC1_RGB8_texture',
  82         'GL_OES_compressed_paletted_texture',
  83         'GL_OES_required_internalformat',
  84         'GL_OES_packed_depth_stencil',
  85         'GL_OES_texture_3D',
  86         'GL_OES_texture_half_float',
  87         'GL_OES_texture_storage_multisample_2d_array',
  88         'GL_OES_sample_shading',
  89         'GL_OES_standard_derivatives',
  90         'GL_OES_stencil1',
  91         'GL_OES_stencil4',
  92         'GL_OES_surfaceless_context',
  93         'GL_OES_mapbuffer',
  94         'GL_OES_vertex_array_object',
  95         'GL_OES_viewport_array',
  96         'GL_ARB_clip_control',
  97         'GL_ARB_buffer_storage',
  98         'GL_ARB_compute_shader',
  99         'GL_ARB_draw_instanced',
 100         'GL_ARB_draw_elements_base_vertex',
 101         'GL_ARB_direct_state_access',
 102         'GL_ARB_get_program_binary',
 103         'GL_ARB_gl_spirv',
 104         'GL_ARB_indirect_parameters',
 105         'GL_ARB_internalformat_query',
 106         'GL_ARB_instanced_arrays',
 107         'GL_ARB_multi_draw_indirect',
 108         'GL_ARB_parallel_shader_compile',
 109         'GL_ARB_program_interface_query',
 110         'GL_ARB_separate_shader_objects',
 111         'GL_ARB_shader_ballot',
 112         'GL_ARB_shader_image_load_store',
 113         'GL_ARB_shader_viewport_layer_array',
 114         'GL_ARB_sparse_buffer',
 115         'GL_ARB_sparse_texture',
 116         'GL_ARB_spirv_extensions',
 117         'GL_ARB_tessellation_shader',
 118         'GL_ARB_texture_barrier',
 119         'GL_ARB_texture_filter_minmax',
 120         'GL_ARB_texture_gather',
 121         'GL_ARB_texture_storage',
 122         'GL_ARB_texture_storage_multisample',
 123         'GL_ARB_texture_multisample',
 124         'GL_ARB_texture_view',
 125         'GL_ARB_transform_feedback2',
 126         'GL_ARB_transform_feedback3',
 127         'GL_ARB_transform_feedback_instanced',
 128         'GL_ARB_transform_feedback_overflow_query',
 129         'GL_ARB_vertex_array_bgra',
 130         'GL_ARB_vertex_attrib_64bit',
 131         'GL_ARB_vertex_attrib_binding',
 132         'GL_NV_deep_texture3D',
 133         'GL_NV_internalformat_sample_query',
 134         'GL_OES_draw_elements_base_vertex',
 135 ]
 136
 137 def getGLRegistry ():
 138         return khr_util.registry_cache.getRegistry(GL_SOURCE)
 139
 140 def getHybridInterface (stripAliasedExtCommands = True):
 141         # This is a bit awkward, since we have to create a strange hybrid
 142         # interface that includes both GL and ES features and extensions.
 143         registry = getGLRegistry()
 144         glFeatures = registry.getFeatures('gl')
 145         esFeatures = registry.getFeatures('gles2')
 146         spec = khr_util.registry.InterfaceSpec()
 147
 148         for feature in registry.getFeatures('gl'):
 149                 spec.addFeature(feature, 'gl', 'core')
 150
 151         for feature in registry.getFeatures('gles2'):
 152                 spec.addFeature(feature, 'gles2')
 153
 154         for extName in EXTENSIONS:
 155                 extension = registry.extensions[extName]
 156                 # Add all extensions using the ES2 api, but force even non-ES2
 157                 # extensions to be included.
 158                 spec.addExtension(extension, 'gles2', 'core', force=True)
 159
 160         iface = khr_util.registry.createInterface(registry, spec, 'gles2')
 161
 162         if stripAliasedExtCommands:
 163                 # Remove redundant extension commands that are already provided by core.
 164                 strippedCmds = []
 165
 166                 for command in iface.commands:
 167                         if command.alias == None:
 168                                 strippedCmds.append(command)
 169
 170                 iface.commands = strippedCmds
 171
 172         return iface
 173
 174 def getInterface (registry, api, version=None, profile=None, **kwargs):
 175         spec = khr_util.registry.spec(registry, api, version, profile, **kwargs)
 176         if api == 'gl' and profile == 'core' and version < "3.2":
 177                 gl32 = registry.features['GL_VERSION_3_2']
 178                 for eRemove in gl32.xpath('remove'):
 179                         spec.addComponent(eRemove)
 180         return khr_util.registry.createInterface(registry, spec, api)
 181
 182 def getVersionToken (api, version):
 183         prefixes = { 'gles2': "ES", 'gl': "GL" }
 184         return prefixes[api] + version.replace(".", "")
 185
 186 def genCommandList(iface, renderCommand, directory, filename, align=False):
 187         lines = map(renderCommand, iface.commands)
 188         lines = filter(lambda l: l != None, lines)
 189         if align:
 190                 lines = indentLines(lines)
 191         writeInlFile(os.path.join(directory, filename), lines)
 192
 193 def genCommandLists(registry, renderCommand, check, directory, filePattern, align=False):
 194         for eFeature in registry.features:
 195                 api                     = eFeature.get('api')
 196                 version         = eFeature.get('number')
 197                 profile         = check(api, version)
 198                 if profile is True:
 199                         profile = None
 200                 elif profile is False:
 201                         continue
 202                 iface           = getInterface(registry, api, version=version, profile=profile)
 203                 filename        = filePattern % getVersionToken(api, version)
 204                 genCommandList(iface, renderCommand, directory, filename, align)
 205
 206 def getFunctionTypeName (funcName):
 207         return "%sFunc" % funcName
 208
 209 def getFunctionMemberName (funcName):
 210         assert funcName[:2] == "gl"
 211         if funcName[:5] == "glEGL":
 212                 # Otherwise we end up with gl.eGLImage...
 213                 return "egl%s" % funcName[5:]
 214         else:
 215                 return "%c%s" % (funcName[2].lower(), funcName[3:])
 216
 217 INL_HEADER = khr_util.format.genInlHeader("Khronos GL API description (gl.xml)", GL_SOURCE.getRevision())
 218
 219 def writeInlFile (filename, source):
 220         khr_util.format.writeInlFile(filename, INL_HEADER, source)
 221
 222 # Aliases from khr_util.common
 223 indentLines                     = khr_util.format.indentLines
 224 normalizeConstant       = khr_util.format.normalizeConstant
 225 commandParams           = khr_util.format.commandParams
 226 commandArgs                     = khr_util.format.commandArgs