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_SPIRV_ENDIAN_H_
16#define SOURCE_SPIRV_ENDIAN_H_
17
18#include "spirv-tools/libspirv.h"
19
20// Converts a word in the specified endianness to the host native endianness.
21uint32_t spvFixWord(const uint32_t word, const spv_endianness_t endianness);
22
23// Converts a pair of words in the specified endianness to the host native
24// endianness.
25uint64_t spvFixDoubleWord(const uint32_t low, const uint32_t high,
26 const spv_endianness_t endianness);
27
28// Gets the endianness of the SPIR-V module given in the binary parameter.
29// Returns SPV_ENDIANNESS_UNKNOWN if the SPIR-V magic number is invalid,
30// otherwise writes the determined endianness into *endian.
31spv_result_t spvBinaryEndianness(const spv_const_binary binary,
32 spv_endianness_t* endian);
33
34// Returns true if the given endianness matches the host's native endianness.
35bool spvIsHostEndian(spv_endianness_t endian);
36
37#endif // SOURCE_SPIRV_ENDIAN_H_
38