source/ext_inst.h

   1 // Copyright (c) 2015-2016 The Khronos Group Inc.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 #ifndef SOURCE_EXT_INST_H_
  16 #define SOURCE_EXT_INST_H_
  17
  18 #include "source/table.h"
  19 #include "spirv-tools/libspirv.h"
  20
  21 // Gets the type of the extended instruction set with the specified name.
  22 spv_ext_inst_type_t spvExtInstImportTypeGet(const char* name);
  23
  24 // Returns true if the extended instruction set is non-semantic
  25 bool spvExtInstIsNonSemantic(const spv_ext_inst_type_t type);
  26
  27 // Returns true if the extended instruction set is debug info
  28 bool spvExtInstIsDebugInfo(const spv_ext_inst_type_t type);
  29
  30 // Finds the named extended instruction of the given type in the given extended
  31 // instruction table. On success, returns SPV_SUCCESS and writes a handle of
  32 // the instruction entry into *entry.
  33 spv_result_t spvExtInstTableNameLookup(const spv_ext_inst_table table,
  34                                        const spv_ext_inst_type_t type,
  35                                        const char* name,
  36                                        spv_ext_inst_desc* entry);
  37
  38 // Finds the extended instruction of the given type in the given extended
  39 // instruction table by value. On success, returns SPV_SUCCESS and writes a
  40 // handle of the instruction entry into *entry.
  41 spv_result_t spvExtInstTableValueLookup(const spv_ext_inst_table table,
  42                                         const spv_ext_inst_type_t type,
  43                                         const uint32_t value,
  44                                         spv_ext_inst_desc* pEntry);
  45
  46 #endif  // SOURCE_EXT_INST_H_