spirv_target_env.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. // Copyright (c) 2016 Google 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. #ifndef SOURCE_SPIRV_TARGET_ENV_H_
  15. #define SOURCE_SPIRV_TARGET_ENV_H_
  16. #include <string>
  17. #include "spirv-tools/libspirv.h"
  18. // Returns true if |env| is a VULKAN environment, false otherwise.
  19. bool spvIsVulkanEnv(spv_target_env env);
  20. // Returns true if |env| is an OPENCL environment, false otherwise.
  21. bool spvIsOpenCLEnv(spv_target_env env);
  22. // Returns true if |env| is an OPENGL environment, false otherwise.
  23. bool spvIsOpenGLEnv(spv_target_env env);
  24. // Returns true if |env| is an implemented/valid environment, false otherwise.
  25. bool spvIsValidEnv(spv_target_env env);
  26. // Returns the version number for the given SPIR-V target environment.
  27. uint32_t spvVersionForTargetEnv(spv_target_env env);
  28. // Returns a string to use in logging messages that indicates the class of
  29. // environment, i.e. "Vulkan", "OpenCL", etc.
  30. std::string spvLogStringForEnv(spv_target_env env);
  31. // Returns a formatted list of all SPIR-V target environment names that
  32. // can be parsed by spvParseTargetEnv.
  33. // |pad| is the number of space characters that the beginning of each line
  34. // except the first one will be padded with.
  35. // |wrap| is the max length of lines the user desires. Word-wrapping will
  36. // occur to satisfy this limit.
  37. std::string spvTargetEnvList(const int pad, const int wrap);
  38. #endif // SOURCE_SPIRV_TARGET_ENV_H_