summaryrefslogtreecommitdiff
path: root/include/buffer_handler.h
blob: ff5cf1d8167d9b17bb76a85d1df092efdf9a31b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/*
 * Copyright 2013  Samsung Electronics Co., Ltd
 *
 * Licensed under the Flora License, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://floralicense.org/license/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

struct buffer_info;
struct inst_info;
struct buffer;

#include <dynamicbox_buffer.h>

/*!
 * \brief
 * \param[in] type
 * \param[in] w
 * \param[in] h
 * \param[in] pixel_size
 * \return buffer_info
 */
extern struct buffer_info *buffer_handler_create(struct inst_info *inst, enum dynamicbox_fb_type type, int w, int h, int pixel_size);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_destroy(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_load(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_unload(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_is_loaded(const struct buffer_info *info);

/*!
 * \brief Reallocate buffer
 * \param[in] info
 * \param[in] w
 * \param[in] h
 * \return int
 */
extern int buffer_handler_resize(struct buffer_info *info, int w, int h);

/*!
 * \brief Only update the size information
 * \param[in] info
 * \param[in] w
 * \param[in] h
 * \return void
 */
extern void buffer_handler_update_size(struct buffer_info *info, int w, int h);

/*!
 * \brief
 * \param[in] info
 * \return const char *
 */
extern const char *buffer_handler_id(const struct buffer_info *info);

/*!
 * \param[in] info
 * \return dynamicbox_fb_type
 */
extern enum dynamicbox_fb_type buffer_handler_type(const struct buffer_info *info);

/*!
 * \brief This API is not supported for Pixmap.
 * \param[in] info
 * \return void*
 */
extern void *buffer_handler_fb(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \param[out] w
 * \param[out] h
 * \return int
 */
extern int buffer_handler_get_size(struct buffer_info *info, int *w, int *h);

/*!
 * \brief This API only can be used for file type buffer
 * \param[in] info
 * \return void
 */
extern void buffer_handler_flush(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return 0 if fails. Return value should be casted to Pixmap type
 */
extern int buffer_handler_pixmap(const struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return buffer
 */
extern void *buffer_handler_pixmap_acquire_buffer(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_pixmap_release_buffer(void *canvas);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_stride(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_pixels(struct buffer_info *info);

/*!
 * \brief
 * \param[in] info
 * \return int
 */
extern int buffer_handler_auto_align(void);

/*!
 * \brief
 * \return int
 */
extern int buffer_handler_init(void);

/*!
 * \brief
 * \details
 * \remarks
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_fini(void);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] info
 * \return void *
 * \retval NULL
 * \retval address
 * \pre
 * \post
 * \sa
 */
extern void *buffer_handler_pixmap_ref(struct buffer_info *info);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer_ptr
 * \return int
 * \retval 
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_pixmap_unref(void *buffer_ptr);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] pixmap
 * \return void *
 * \retval
 * \pre
 * \post
 * \sa
 */
extern void *buffer_handler_pixmap_find(int pixmap);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] info
 * \return void *
 * \retval
 * \pre
 * \post
 * \sa
 */
extern void *buffer_handler_pixmap_buffer(struct buffer_info *info);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] info
 * \return struct inst_info *
 * \retval
 * \pre
 * \post
 * \sa
 */
extern struct inst_info *buffer_handler_instance(struct buffer_info *info);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] type
 * \param[in] resource
 * \return dynamicbox_fb_t 
 * \retval NULL
 * \retval address
 * \pre
 * \post
 * \sa
 */
extern dynamicbox_fb_t buffer_handler_raw_open(enum dynamicbox_fb_type type, void *resource);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_raw_close(dynamicbox_fb_t buffer);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return void *
 * \retval NULL
 * \pre
 * \post
 * \sa
 */
extern void *buffer_handler_raw_data(dynamicbox_fb_t buffer);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_raw_size(dynamicbox_fb_t buffer);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_lock(struct buffer_info *buffer);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_unlock(struct buffer_info *buffer);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \param[in] data
 * \return int
 * \retval
 * \pre
 * \post
 * \sa
 */
extern int buffer_handler_set_data(struct buffer_info *buffer, void *data);

/*!
 * \brief
 * \details
 * \remarks
 * \param[in] buffer
 * \return void *
 * \retval NULL
 * \retval address
 * \pre
 * \post
 * \sa
 */
extern void *buffer_handler_data(struct buffer_info *buffer);
/* End of a file */