1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_LIBARTPALETTE_INCLUDE_PALETTE_PALETTE_TYPES_H_
18 #define ART_LIBARTPALETTE_INCLUDE_PALETTE_PALETTE_TYPES_H_
19 
20 #include <stdint.h>
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif  // __cplusplus
25 
26 using palette_status_t = int32_t;
27 
28 // Palette function return value when the function completed successfully.
29 #define PALETTE_STATUS_OK                 ((palette_status_t) 0)
30 
31 // Palette function return value when the function called yielded and error captured by `errno`.
32 #define PALETTE_STATUS_CHECK_ERRNO        ((palette_status_t) 1)
33 
34 // Palette function return value when an argument to the function was invalid.
35 #define PALETTE_STATUS_INVALID_ARGUMENT   ((palette_status_t) 2)
36 
37 // Palette function return value when the function called is not supported. This value allows
38 // palette functions to be retired across Android versions. Palette functions can never be removed
39 // from the palette interface by design.
40 #define PALETTE_STATUS_NOT_SUPPORTED      ((palette_status_t) 3)
41 
42 // Palette function return value when the function failed for unknown reasons.
43 #define PALETTE_STATUS_FAILED_CHECK_LOG   ((palette_status_t) 4)
44 
45 #ifdef __cplusplus
46 }
47 #endif  // __cplusplus
48 
49 #endif  // ART_LIBARTPALETTE_INCLUDE_PALETTE_PALETTE_TYPES_H_
50