1 /*
2  * Copyright (c) 2021 Huawei Device Co., Ltd.
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 
16 /**
17  * @addtogroup NativeWindow
18  * @{
19  *
20  * @brief Provides the BufferHandle struct for native window.
21  *
22  * @syscap SystemCapability.Graphic.Graphic2D.NativeWindow
23  * @since 8
24  * @version 1.0
25  */
26 
27 /**
28  * @file buffer_handle.h
29  *
30  * @brief Defines the BufferHandle struct for native window.
31  *
32  * @kit ArkGraphics2D
33  * @library libnative_window.so
34  * @syscap SystemCapability.Graphic.Graphic2D.NativeWindow
35  * @since 8
36  * @version 1.0
37  */
38 
39 #ifndef INCLUDE_BUFFER_HANDLE_H
40 #define INCLUDE_BUFFER_HANDLE_H
41 
42 #include <stdint.h>
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 typedef struct {
49     int32_t fd;           /**< buffer fd, -1 if not supported */
50     int32_t width;        /**< the width of memory */
51     int32_t stride;       /**< the stride of memory */
52     int32_t height;       /**< the height of memory */
53     int32_t size;         /* < size of memory */
54     int32_t format;       /**< the format of memory */
55     uint64_t usage;        /**< the usage of memory */
56     void *virAddr;        /**< Virtual address of memory  */
57     uint64_t phyAddr;     /**< Physical address */
58     uint32_t reserveFds;  /**< the number of reserved fd value */
59     uint32_t reserveInts; /**< the number of reserved integer value */
60     int32_t reserve[0];   /**< the data */
61 } BufferHandle;
62 
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 /** @} */
68 #endif // INCLUDE_BUFFER_HANDLE_H
69