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 #ifndef INCLUDE_BUFFER_HANDLE_H
17 #define INCLUDE_BUFFER_HANDLE_H
18 
19 /**
20  * @addtogroup NativeWindow
21  * @{
22  *
23  * @brief Provides the BufferHandle struct for native window.
24  *
25  * @syscap SystemCapability.Graphic.Graphic2D.NativeWindow
26  * @since 8
27  * @version 1.0
28  */
29 
30 /**
31  * @file buffer_handle.h
32  *
33  * @brief Defines the BufferHandle struct for native window.
34  *
35  * @kit ArkGraphics2D
36  * @library libnative_window.so
37  * @syscap SystemCapability.Graphic.Graphic2D.NativeWindow
38  * @since 8
39  * @version 1.0
40  */
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     int32_t key;          /**< Shared memory key */
58     uint64_t phyAddr;     /**< Physical address */
59     uint32_t reserveFds;  /**< the number of reserved fd value */
60     uint32_t reserveInts; /**< the number of reserved integer value */
61     int32_t reserve[0];   /**< the data */
62 } BufferHandle;
63 
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #endif // INCLUDE_BUFFER_HANDLE_H
69