1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
7 * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8 * JinYoung Jeon <jy0.jeon@samsung.com>,
9 * Taeheon Kim <th908.kim@samsung.com>,
10 * YoungJun Cho <yj44.cho@samsung.com>,
11 * SooChan Lim <sc1.lim@samsung.com>,
12 * Boram Park <boram1288.park@samsung.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sub license, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 **************************************************************************/
40 #include <sys/types.h>
41 #include <tbm_surface.h>
42 #include <tbm_surface_queue.h>
43 #include <tbm_surface_internal.h>
45 #include "tdm_types.h"
46 #include "tdm_deprecated.h"
54 * @brief The header file for a frontend user.
57 * #include <tdm.h> //for a frontend user
62 * @brief Initialize a display object
63 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
64 * @return A display object
65 * @see tdm_display_deinit
68 tdm_display_init(tdm_error *error);
71 * @brief Deinitialize a display object
72 * @param[in] dpy A display object
73 * @see tdm_display_init
76 tdm_display_deinit(tdm_display *dpy);
79 * @brief Get the file descriptor
80 * @details TDM handles the events of fd with #tdm_display_handle_events.
81 * @param[in] dpy A display object
82 * @param[out] fd The file descriptor
83 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
84 * @see tdm_display_handle_events
87 tdm_display_get_fd(tdm_display *dpy, int *fd);
90 * @brief Handle the events
91 * @param[in] dpy A display object
92 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
93 * @see tdm_display_get_fd
96 tdm_display_handle_events(tdm_display *dpy);
99 * @brief Flush the all events to clients
100 * @param[in] dpy A display object
103 tdm_display_flush(tdm_display *dpy);
106 * @brief Get the capabilities of a display object.
107 * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
108 * @param[in] dpy A display object
109 * @param[out] capabilities The capabilities of a display object
110 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
113 tdm_display_get_capabilities(tdm_display *dpy,
114 tdm_display_capability *capabilities);
117 * @brief Get the pp capabilities of a display object.
118 * @param[in] dpy A display object
119 * @param[out] capabilities The pp capabilities
120 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
123 tdm_display_get_pp_capabilities(tdm_display *dpy,
124 tdm_pp_capability *capabilities);
127 * @brief Get the pp available format array of a display object.
128 * @param[in] dpy A display object
129 * @param[out] formats The pp available format array
130 * @param[out] count The count of formats
131 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
134 tdm_display_get_pp_available_formats(tdm_display *dpy,
135 const tbm_format **formats, int *count);
138 * @brief Get the pp available size of a display object.
139 * @details -1 means that a TDM backend module doesn't define the value.
140 * @param[in] dpy A display object
141 * @param[out] min_w The minimum width which TDM can handle
142 * @param[out] min_h The minimum height which TDM can handle
143 * @param[out] max_w The maximum width which TDM can handle
144 * @param[out] max_h The maximum height which TDM can handle
145 * @param[out] preferred_align The preferred align width which TDM can handle
146 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
149 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
150 int *max_w, int *max_h, int *preferred_align);
153 * @brief Get the capture capabilities of a display object.
154 * @param[in] dpy A display object
155 * @param[out] capabilities The capture capabilities
156 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
159 tdm_display_get_capture_capabilities(tdm_display *dpy,
160 tdm_capture_capability *capabilities);
163 * @brief Get the capture available format array of a display object.
164 * @param[in] dpy A display object
165 * @param[out] formats The capture available format array
166 * @param[out] count The count of formats
167 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
170 tdm_display_get_capture_available_formats(tdm_display *dpy,
171 const tbm_format **formats, int *count);
174 * @brief Get the capture available size of a display object.
175 * @details -1 means that a TDM backend module doesn't define the value.
176 * @param[in] dpy A display object
177 * @param[out] min_w The minimum width which TDM can handle
178 * @param[out] min_h The minimum height which TDM can handle
179 * @param[out] max_w The maximum width which TDM can handle
180 * @param[out] max_h The maximum height which TDM can handle
181 * @param[out] preferred_align The preferred align width which TDM can handle
182 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
185 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
186 int *max_w, int *max_h, int *preferred_align);
189 * @brief Get the output counts which a display object has.
190 * @param[in] dpy A display object
191 * @param[out] count The count of outputs
192 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
193 * @see tdm_display_get_output
196 tdm_display_get_output_count(tdm_display *dpy, int *count);
199 * @brief Get a output object which has the given index.
200 * @param[in] dpy A display object
201 * @param[in] index The index of a output object
202 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
203 * @return A output object if success. Otherwise, NULL.
204 * @see tdm_display_get_output_count
207 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
210 * @brief Find a output object which has the given name.
211 * @param[in] dpy A display object
212 * @param[in] name The name of a output object
213 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
214 * @return A output object if success. Otherwise, NULL.
217 tdm_display_find_output(tdm_display *dpy, const char *name, tdm_error *error);
220 * @brief Create a pp object.
221 * @param[in] dpy A display object
222 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
223 * @return A pp object if success. Otherwise, NULL.
224 * @see tdm_pp_destroy
227 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
230 * @brief Get the information of the TDM backend module.
231 * @param[in] module A backend module object
232 * @param[out] name The name of the TDM backend module
233 * @param[out] vendor The vendor of the TDM backend module
234 * @param[out] version The version of the TDM backend module
235 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
238 tdm_module_get_info(tdm_module *module, const char **name,
239 const char **vendor, int *major, int *minor);
242 * @brief Get a backend module object of the given output.
243 * @param[in] output A output object
244 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
245 * @return A backend object if success. Otherwise, NULL.
248 tdm_output_get_backend_module(tdm_output *output, tdm_error *error);
251 * @brief Get the capabilities of a output object.
252 * @param[in] output A output object
253 * @param[out] capabilities The capabilities of a output object
254 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
257 tdm_output_get_capabilities(tdm_output *output,
258 tdm_output_capability *capabilities);
261 * @brief Get the model information of a output object.
262 * @param[in] output A output object
263 * @param[out] maker The output maker.
264 * @param[out] model The output model.
265 * @param[out] name The output name.
266 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
269 tdm_output_get_model_info(tdm_output *output, const char **maker,
270 const char **model, const char **name);
273 * @brief Get the connection status of a output object.
274 * @param[in] output A output object
275 * @param[out] status The connection status.
276 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
279 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
282 * @brief Add a output change handler
283 * @details The handler will be called when the status of a
284 * output object is changed. connection, DPMS, etc.
285 * @param[in] output A output object
286 * @param[in] func A output change handler
287 * @param[in] user_data The user data
288 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
291 tdm_output_add_change_handler(tdm_output *output,
292 tdm_output_change_handler func,
296 * @brief Remove a output change handler
297 * @param[in] output A output object
298 * @param[in] func A output change handler
299 * @param[in] user_data The user data
300 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
303 tdm_output_remove_change_handler(tdm_output *output,
304 tdm_output_change_handler func,
308 * @brief Get the connection type of a output object.
309 * @param[in] output A output object
310 * @param[out] type The connection type.
311 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
317 * @brief Get the layer counts which a output object has.
318 * @param[in] output A output object
319 * @param[out] count The count of layers
320 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
321 * @see tdm_output_get_layer
324 tdm_output_get_layer_count(tdm_output *output, int *count);
327 * @brief Get a layer object which has the given index.
328 * @param[in] output A output object
329 * @param[in] index The index of a layer object
330 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
331 * @return A layer object if success. Otherwise, NULL.
332 * @see tdm_output_get_layer_count
335 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
338 * @brief Get the available property array of a output object.
339 * @param[in] output A output object
340 * @param[out] props The available property array
341 * @param[out] count The count of properties
342 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
345 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
349 * @brief Get the available mode array of a output object.
350 * @param[in] output A output object
351 * @param[out] modes The available mode array
352 * @param[out] count The count of modes
353 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
356 tdm_output_get_available_modes(tdm_output *output,
357 const tdm_output_mode **modes, int *count);
360 * @brief Get the available size of a output object.
361 * @details -1 means that a TDM backend module doesn't define the value.
362 * @param[in] output A output object
363 * @param[out] min_w The minimum width which TDM can handle
364 * @param[out] min_h The minimum height which TDM can handle
365 * @param[out] max_w The maximum width which TDM can handle
366 * @param[out] max_h The maximum height which TDM can handle
367 * @param[out] preferred_align The preferred align width which TDM can handle
368 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
371 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
372 int *max_w, int *max_h, int *preferred_align);
375 * @brief Get the available cursor size of a output object.
376 * @details -1 means that a TDM backend module doesn't define the value.
377 * @param[in] output A output object
378 * @param[out] min_w The minimum width which TDM can handle
379 * @param[out] min_h The minimum height which TDM can handle
380 * @param[out] max_w The maximum width which TDM can handle
381 * @param[out] max_h The maximum height which TDM can handle
382 * @param[out] preferred_align The preferred align width which TDM can handle
383 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
386 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
387 int *max_w, int *max_h, int *preferred_align);
390 * @brief Get the physical size of a output object.
391 * @param[in] output A output object
392 * @param[out] mmWidth The milimeter width
393 * @param[out] mmHeight The milimeter height
394 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
397 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
398 unsigned int *mmHeight);
401 * @brief Get the subpixel of a output object.
402 * @param[in] output A output object
403 * @param[out] subpixel The subpixel
404 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
407 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
410 * @brief Get the pipe of a output object.
411 * @param[in] output A output object
412 * @param[out] pipe The pipe
413 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
416 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
419 * @brief Get the index of a primary layer.
420 * @param[in] output A output object
421 * @param[out] index The primary layer index
422 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
425 tdm_output_get_primary_index(tdm_output *output, int *index);
428 * @brief Set the property which has a given id.
429 * @param[in] output A output object
430 * @param[in] id The property id
431 * @param[in] value The value
432 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
435 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
438 * @brief Get the property which has a given id
439 * @param[in] output A output object
440 * @param[in] id The property id
441 * @param[out] value The value
442 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
445 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
448 * @brief Wait for VBLANK
449 * @details After interval vblanks, a user vblank handler will be called.
450 * @param[in] output A output object
451 * @param[in] interval vblank interval
452 * @param[in] sync 0: asynchronous, 1:synchronous
453 * @param[in] func A user vblank handler
454 * @param[in] user_data The user data
455 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
456 * @see #tdm_output_vblank_handler
459 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
460 tdm_output_vblank_handler func, void *user_data);
463 * @brief Commit changes for a output object
464 * @details After all change of a output object are applied, a user commit handler
466 * @param[in] output A output object
467 * @param[in] sync 0: asynchronous, 1:synchronous
468 * @param[in] func A user commit handler
469 * @param[in] user_data The user data
470 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
471 * @see #tdm_layer_commit
474 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
478 * @brief Remove the user vblank handler
479 * @param[in] output A output object
480 * @param[in] func A user vblank handler
481 * @param[in] user_data The user data
482 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
488 * @brief Remove the user commit handler
489 * @param[in] output A output object
490 * @param[in] func A user commit handler
491 * @param[in] user_data The user data
492 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
495 tdm_output_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data);
498 * @brief Set one of available modes of a output object
499 * @param[in] output A output object
500 * @param[in] mode A output mode
501 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
504 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
507 * @brief Get the mode of a output object
508 * @param[in] output A output object
509 * @param[out] mode A output mode
510 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
513 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
516 * @brief Set DPMS of a output object synchronously
517 * @param[in] output A output object
518 * @param[in] dpms_value DPMS value
519 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
520 * @see tdm_output_set_dpms_async
523 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
526 * @brief Set DPMS of a output object asynchronously
527 * @details This function can be used when a output supports the asynchronous DPMS
528 * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which
529 * #tdm_output_get_capabilities returns. If an output change handler is added with
530 * #tdm_output_add_change_handler, the output change handler will be called when
531 * the DPMS status is changed indeed.
532 * @param[in] output A output object
533 * @param[in] dpms_value DPMS value
534 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
535 * @see tdm_output_add_change_handler, tdm_output_set_dpms,
536 * tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS.
539 tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value);
542 * @brief Get DPMS of a output object
543 * @param[in] output A output object
544 * @param[out] dpms_value DPMS value
545 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
548 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
551 * @brief Check if a output object has the capture capability
552 * @param[in] output A output object
553 * @param[out] has_capability 1: has the capability, 0: not has the capability
554 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
557 tdm_output_has_capture_capability(tdm_output *output, unsigned int *has_capability);
560 * @brief Create a capture object of a output object
561 * @param[in] output A output object
562 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
563 * @return A capture object
564 * @see tdm_capture_destroy
567 tdm_output_create_capture(tdm_output *output, tdm_error *error);
570 * @brief Get a hwc associated with a output object.
571 * @param[in] output A output object
572 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
573 * @return A hwc object
577 tdm_output_get_hwc(tdm_output *output, tdm_error *error);
580 * @brief Get a output object of a layer object
581 * @param[in] layer A layer object
582 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
583 * @return A TDM output object if success. Otherwise, NULL.
586 tdm_layer_get_output(tdm_layer *layer, tdm_error *error);
589 * @brief Get the index of a layer object.
590 * @param[in] layer A layer object
591 * @param[out] index The index of a layer object
592 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
595 tdm_layer_get_index(tdm_layer *layer, int *index);
598 * @brief Get the capabilities of a layer object.
599 * @param[in] layer A layer object
600 * @param[out] capabilities The capabilities of a layer object
601 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
604 tdm_layer_get_capabilities(tdm_layer *layer,
605 tdm_layer_capability *capabilities);
608 * @brief Get the available format array of a layer object.
609 * @param[in] layer A layer object
610 * @param[out] formats The available format array
611 * @param[out] count The count of formats
612 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
615 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
619 * @brief Get the available property array of a layer object.
620 * @param[in] layer A layer object
621 * @param[out] props The available property array
622 * @param[out] count The count of properties
623 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
626 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
630 * @brief Get the zpos of a layer object.
632 * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
633 * - But the zpos of VIDEO layers will be decided by a backend module side.
634 * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
635 * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
636 * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
637 * -------------------------------- graphic layer 3 <-- top most layer
638 * -------------------------------- graphic layer 2
639 * -------------------------------- graphic layer 1
640 * -------------------------------- graphic layer 0
641 * -------------------------------- video layer -1
642 * -------------------------------- video layer -2 <-- lowest layer
643 * @param[in] layer A layer object
644 * @param[out] zpos The zpos
645 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
646 * @see tdm_layer_set_video_pos, tdm_layer_capability
649 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
652 * @brief Set the property which has a given id.
653 * @param[in] layer A layer object
654 * @param[in] id The property id
655 * @param[in] value The value
656 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
659 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
662 * @brief Get the property which has a given id.
663 * @param[in] layer A layer object
664 * @param[in] id The property id
665 * @param[out] value The value
666 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
669 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
672 * @brief Set the geometry information to a layer object
673 * @details The geometry information will be applied when the output object
674 * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
675 * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
677 * @param[in] layer A layer object
678 * @param[in] info The geometry information
679 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
680 * @see tdm_layer_commit
683 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
686 * @brief Get the geometry information to a layer object
687 * @param[in] layer A layer object
688 * @param[out] info The geometry information
689 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
692 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
695 * @brief Set a TDM buffer to a layer object
696 * @details A TDM buffer will be applied when the output object
697 * of a layer object is committed.
698 * @param[in] layer A layer object
699 * @param[in] buffer A TDM buffer
700 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
701 * @see tdm_layer_commit
704 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
707 * @brief Unset a TDM buffer from a layer object
708 * @details When this function is called, a current showing buffer will be
709 * disappeared from screen. Then nothing is showing on a layer object.
710 * @param[in] layer A layer object
711 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
714 tdm_layer_unset_buffer(tdm_layer *layer);
717 * @brief Commit changes for a layer object
718 * @details After all change of a layer object are applied, a user commit handler
720 * @param[in] layer A layer object
721 * @param[in] func A user commit handler
722 * @param[in] user_data The user data
723 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
726 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
729 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
732 * @brief Remove the user commit handler
733 * @param[in] layer A layer object
734 * @param[in] func A user commit handler
735 * @param[in] user_data The user data
736 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
739 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
742 * @brief Get a displaying TDM buffer from a layer object
743 * @details A displaying TDM buffer is a current showing buffer on screen
744 * that is set to layer object and applied output object of a layer object.
745 * @param[in] layer A layer object
746 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
747 * @return A TDM buffer if success. Otherwise, NULL.
750 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
753 * @brief Set a TBM surface_queue to a layer object
754 * @details A TBM surface_queue will be applied when the output object
755 * of a layer object is committed. and TDM layer will be automatically updated
756 * @param[in] layer A layer object
757 * @param[in] buffer_queue A TBM surface_queue
758 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
759 * @see tdm_layer_commit
762 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
765 * @brief Unset a TBM surface_queue from a layer object
766 * @details When this function is called, a current surface_queue will be
767 * disappeared from screen. Then nothing is showing on a layer object.
768 * @param[in] layer A layer object
769 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
772 tdm_layer_unset_buffer_queue(tdm_layer *layer);
775 * @brief Check wheter a layer object is available for a frontend user to use.
776 * @details A layer object is not usable if a TDM buffer is showing on screen
777 * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
778 * will become usable.
779 * @param[in] layer A layer object
780 * @param[out] usable 1 if usable, 0 if not usable
781 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
784 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
787 * @brief Set the relative zpos to a VIDEO layer object
788 * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
789 * it is more than the maximum zpos of GRAPHIC layers.
790 * @param[in] layer A VIDEO layer object
791 * @param[in] zpos The zpos
792 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
793 * @see tdm_layer_get_zpos, tdm_layer_capability
796 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
799 * @brief Create a capture object of a layer object
800 * @param[in] layer A layer object
801 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
802 * @return A capture object
803 * @see tdm_capture_destroy
806 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
809 * @brief Get buffer flags from a layer object
810 * @param[in] layer A layer object
811 * @param[out] flags a buffer flags value
812 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
815 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
818 * @brief Creates a new window on the given hwc.
819 * @param[in] hwc A hwc object
820 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
821 * @return A created window object
825 tdm_hwc_create_window(tdm_hwc *hwc, tdm_error *error);
828 * @brief Get the video supported format array for hwc windows of a output object.
829 * @param[in] hwc A hwc object
830 * @param[out] formats The available format array
831 * @param[out] count The count of formats
832 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
835 tdm_hwc_get_video_supported_formats(tdm_hwc *hwc, const tbm_format **formats,
839 * @brief Get the hwc video capability
840 * @param[in] hwc A hwc object
841 * @param[out] video_capability A hwc video capability
842 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
845 tdm_hwc_get_video_capability(tdm_hwc *hwc, tdm_hwc_video_capability *video_capability);
848 * @brief Get the available property array of a hwc object.
849 * @param[in] hwc A hwc
850 * @param[out] props The available property array
851 * @param[out] count The count of properties
852 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
855 tdm_hwc_get_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *count);
858 * @brief Get a target buffer queue
859 * @details Buffers from target buffer queue will receive the output of
860 * client composition. Window marked as TDM_COMPOSITION_CLIENT or
861 * TDM_COMPOSITION_DEVICE_CANDIDATE will be composited into this buffers
862 * prior to the call to tdm_output_commit().
863 * @param[in] output A output object
864 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
865 * @return A buffer queue
869 tdm_hwc_get_client_target_buffer_queue(tdm_hwc *hwc, tdm_error *error);
872 * @brief Set the client(relative to the TDM) target buffer
873 * @details Sets the buffer which will receive the output of client composition.
874 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
875 * will be composited into this buffer prior to the call to tdm_output_commit(),
876 * and windows not marked as TDM_COMPOSITION_CLIENT and
877 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
880 * The buffer handle provided may be null if no windows are being composited by
881 * the client. This must not result in an error (unless an invalid display
882 * handle is also provided).
884 * The damage parameter describes a buffer damage region as defined in the
885 * description of tdm_hwc_window_set_buffer_damage().
887 * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
888 * should be passed along with #target_buffer to allow tdm to make the smooth transition
889 * from a DEVICE type to a CLIENT type.
891 * Should be called before tdm_output_commit() if any of the layers are marked as
892 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
893 * so marked, then it is not necessary to call this function. It is not necessary
894 * to call tdm_hwc_validate() after changing the target through this function.
895 * @param[in] hwc A output hwc
896 * @param[in] target_buffer The new target buffer
897 * @param[in] damage The buffer damage region
898 * @param[in] composited_wnds The array of composited hwc_wnds
899 * @param[in] num_wnds The size of #composited_wnds array
900 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
904 tdm_hwc_set_client_target_buffer(tdm_hwc *hwc, tbm_surface_h target_buffer, tdm_region damage);
907 * @brief Validate the output
908 * @details Instructs the device to inspect all of the layer state and
909 * determine if there are any composition type changes necessary before
910 * presenting the output. Permitted changes are described in the definition
911 * of tdm_hwc_window_composition_t above.
912 * @param[in] output A output object
913 * @param[out] num_types The number of composition type changes required by
914 * the device; if greater than 0, the client must either set and validate new
915 * types, or call tdm_hwc_accept_changes() to accept the changes returned by
916 * tdm_hwc_get_changed_composition_types(); must be the same as the number of
917 * changes returned by tdm_hwc_get_changed_composition_types (see the
918 * declaration of that function for more information); pointer will be non-NULL
919 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
923 tdm_hwc_validate(tdm_hwc *hwc, tdm_hwc_window **composited_wnds, uint32_t num_wnds,
924 uint32_t *num_types);
927 * @brief Get changed composition types
928 * @details Retrieves the windows for which the device requires a different
929 * composition type than had been set prior to the last call to tdm_hwc_validate().
930 * The client will either update its state with these types and call
931 * tdm_hwc_accept_changes, or will set new types and attempt to validate the
933 * windows and types may be NULL to retrieve the number of elements which
934 * will be returned. The number of elements returned must be the same as the
935 * value returned in num_types from the last call to tdm_hwc_validate().
936 * @param[in] output A output object
937 * @param[out] num_elements If windows or types were NULL, the number of layers
938 * and types which would have been returned; if both were non-NULL, the
939 * number of elements returned in layers and types, which must not exceed
940 * the value stored in num_elements prior to the call; pointer will be
942 * @param[in] output A output object
943 * @param[out] windows An array of windows
944 * @param[out] composition_types An array of composition types, each corresponding
945 * to an element of windows
946 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
950 tdm_hwc_get_changed_composition_types(tdm_hwc *hwc, uint32_t *num_elements,
951 tdm_hwc_window **hwc_window,
952 tdm_hwc_window_composition *composition_types);
955 * @brief Accepts the changes required by the device
956 * @details Accepts the changes required by the device from the previous
957 * tdm_hwc_validate() call (which may be queried using
958 * tdm_hwc_get_chaged_composition_types()) and revalidates the display. This
959 * function is equivalent to requesting the changed types from
960 * tdm_hwc_get_chaged_composition_types(), setting those types on the
961 * corresponding windows, and then calling tdm_hwc_validate again.
962 * After this call it must be valid to present this display. Calling this after
963 * tdm_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
964 * should have no other effect.
965 * @param[in] output A output object
966 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
970 tdm_hwc_accept_changes(tdm_hwc *hwc);
973 * @brief Commit changes for a hwc
974 * @details After all change of a window object are applied, a user commit handler
976 * @param[in] hwc A hwc object
977 * @param[in] sync 0: asynchronous, 1:synchronous
978 * @param[in] func A user commit handler
979 * @param[in] user_data The user data
980 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
983 tdm_hwc_commit(tdm_hwc *hwc, int sync, tdm_hwc_commit_handler func, void *user_data);
986 * @brief Destroys the given window.
987 * @param[in] output A output object
988 * @param[in] window the pointer of the window to destroy
992 tdm_hwc_window_destroy(tdm_hwc_window *hwc_window);
995 * @brief Get a buffer queue for the window object
996 * @details These buffers are used to composite by hardware a client content in
998 * @param[in] hwc_window A window object
999 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1000 * @return A tbm buffer queue
1004 tdm_hwc_window_get_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error);
1007 * @brief Sets the desired composition type of the given window.
1008 * @details During tdm_hwc_validate(), the device may request changes to
1009 * the composition types of any of the layers as described in the definition
1010 * of tdm_hwc_window_composition_t above.
1011 * @param[in] hwc_window A window object
1012 * @param[in] composition_type The new composition type
1013 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1017 tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window,
1018 tdm_hwc_window_composition composition_type);
1021 * @brief Set the buffer damage
1022 * @details Provides the region of the source buffer which has been modified
1023 * since the last frame. This region does not need to be validated before
1024 * calling tdm_output_commit().
1025 * Once set through this function, the damage region remains the same until a
1026 * subsequent call to this function.
1027 * If damage.num_rects > 0, then it may be assumed that any portion of the source
1028 * buffer not covered by one of the rects has not been modified this frame. If
1029 * damage.num_rects == 0, then the whole source buffer must be treated as if it
1030 * has been modified.
1031 * If the layer's contents are not modified relative to the prior frame, damage
1032 * will contain exactly one empty rect([0, 0, 0, 0]).
1033 * The damage rects are relative to the pre-transformed buffer, and their origin
1034 * is the top-left corner. They will not exceed the dimensions of the latched
1036 * @param[in] hwc_window A window object
1037 * @param[in] damage The new buffer damage region
1038 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1042 tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_region damage);
1045 * @brief Set the information to a window object
1046 * @details The information will be applied when the output object of a window
1047 * object is committed.
1048 * @param[in] hwc_window A window object
1049 * @param[in] info The information
1050 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1054 tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info);
1057 * @brief Set a TBM buffer to a window object
1058 * @details A TBM buffer will be applied when the output object of a layer
1059 * object is committed.
1060 * @param[in] hwc_window A window object
1061 * @param[in] buffer A TDM buffer
1062 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1063 * @return #TDM_ERROR_BUSY if #hwc_window can't be updated right now, this
1064 * can happen if #hwc_window is involved in the smooth transition from
1065 * DEVICE to CLIENT, this shouldn't be interpreted like some critical error.
1069 tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer);
1072 * @brief Get the property which has a given id.
1073 * @param[in] hwc window A hwc window object
1074 * @param[in] id The property id
1075 * @param[out] value The value
1076 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1079 tdm_hwc_window_get_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value *value);
1082 * @brief Set the property which has a given id.
1083 * @param[in] hwc window A hwc window object
1084 * @param[in] id The property id
1085 * @param[in] value The value
1086 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1089 tdm_hwc_window_set_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value value);
1092 * @brief Destroy a pp object
1093 * @param[in] pp A pp object
1094 * @see tdm_display_create_pp
1097 tdm_pp_destroy(tdm_pp *pp);
1100 * @brief Set the geometry information to a pp object
1101 * @param[in] pp A pp object
1102 * @param[in] info The geometry information
1103 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1104 * @see tdm_pp_commit
1107 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
1110 * @brief Set the PP done handler to a pp object
1112 * The user PP done handler will be called after converting a source buffer's image
1113 * to a destination buffer.
1114 * @param[in] pp A pp object
1115 * @param[in] func A user PP done handler
1116 * @param[in] user_data The user data
1117 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1120 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
1123 * @brief Attach a source buffer and a destination buffer to a pp object
1124 * @param[in] pp A pp object
1125 * @param[in] src A source buffer
1126 * @param[in] dst A destination buffer
1127 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1128 * @see tdm_pp_commit, tdm_pp_set_done_handler
1131 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1134 * @brief Commit changes for a pp object
1135 * @param[in] pp A pp object
1136 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1139 tdm_pp_commit(tdm_pp *pp);
1142 * @brief Destroy a capture object
1143 * @param[in] capture A capture object
1144 * @see tdm_output_create_capture, tdm_layer_create_capture
1147 tdm_capture_destroy(tdm_capture *capture);
1150 * @brief Set the geometry information to a capture object
1151 * @param[in] capture A capture object
1152 * @param[in] info The geometry information
1153 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1154 * @see tdm_capture_commit
1157 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
1160 * @brief Set the capture done handler to a capture object
1162 * The user capture done handler will be called after capturing a screen into a
1164 * @param[in] capture A capture object
1165 * @param[in] func A user capture done handler
1166 * @param[in] user_data The user data
1167 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1170 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
1173 * @brief Attach a TDM buffer to a capture object
1174 * @param[in] capture A capture object
1175 * @param[in] buffer A TDM buffer
1176 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1177 * @see tdm_capture_commit, tdm_capture_set_done_handler
1180 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
1183 * @brief Commit changes for a capture object
1184 * @param[in] capture A capture object
1185 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1188 tdm_capture_commit(tdm_capture *capture);
1191 * @brief The release handler of a TDM buffer
1192 * @param[in] buffer A TDM buffer
1193 * @param[in] user_data user data
1194 * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
1196 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
1200 * @brief Add a release handler to a TDM buffer
1202 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1203 * becomes available for a next job. A TDM buffer can be used for TDM to show
1204 * it on screen or to capture an output and a layer. After all operations,
1205 * TDM will release it immediately when TDM doesn't need it any more.
1206 * @param[in] buffer A TDM buffer
1207 * @param[in] func A release handler
1208 * @param[in] user_data user data
1209 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1210 * @see tdm_buffer_remove_release_handler
1213 tdm_buffer_add_release_handler(tbm_surface_h buffer,
1214 tdm_buffer_release_handler func, void *user_data);
1217 * @brief Remove a release handler from a TDM buffer
1218 * @param[in] buffer A TDM buffer
1219 * @param[in] func A release handler
1220 * @param[in] user_data user data
1221 * @see tdm_buffer_add_release_handler
1224 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
1225 tdm_buffer_release_handler func, void *user_data);
1228 * @brief The handler of a vblank object
1229 * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
1231 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
1232 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
1235 * @brief Set the vblank fps for the given PID and name.
1236 * @param[in] pid The process ID
1237 * @param[in] name The client vblank name
1238 * @param[in] fps The client vblank fps
1239 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1242 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
1245 * @brief Set the ignore global fps for the given PID and name.
1246 * @param[in] pid The process ID
1247 * @param[in] name The client vblank name
1248 * @param[in] ignore 1: ignore 0:not ignore(default)
1249 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1252 tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore);
1255 * @brief Set the vblank global fps for the entire system.
1256 * @param[in] enable 1:enable, 0:disable
1257 * @param[in] fps The vblank global fps
1259 * This global fps will be applied to all client's vblanks for all outputs.
1260 * If the client's vblank fps is less than this, the global fps will be ignored
1261 * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1262 * the global fps, it will be ignored also.
1263 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1266 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps);
1269 * @brief Add the vblank create handler.
1270 * @param[in] dpy A display object
1271 * @param[in] func The user vblank create handler
1272 * @param[in] user_data The user data
1274 * The user vblank create handler will be called when new vblank object created.
1275 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1278 tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data);
1281 * @brief Remove the vblank create handler.
1282 * @param[in] dpy A display object
1283 * @param[in] func The user vblank create handler
1284 * @param[in] user_data The user data
1285 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1288 tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data);
1291 * @brief Create a vblank object
1292 * @param[in] dpy A display object
1293 * @param[in] output A output object
1294 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1295 * @return A vblank object
1296 * @see #tdm_vblank_destroy
1299 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
1302 * @brief Destroy a vblank object
1303 * @param[in] vblank A vblank object
1304 * @see #tdm_vblank_create
1307 tdm_vblank_destroy(tdm_vblank *vblank);
1310 * @brief Get a output object of a vblank object
1311 * @param[in] vblank A vblank object
1312 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1313 * @return A TDM output object if success. Otherwise, NULL.
1314 * @see #tdm_vblank_create
1317 tdm_vblank_get_output(tdm_vblank *vblank, tdm_error *error);
1320 * @brief Get the client PID for a vblank object
1321 * @param[in] vblank A vblank object
1322 * @param[out] pid PID of vblank's client
1323 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1326 tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid);
1329 * @brief Set the name to a vblank object
1330 * @details The default name is "unknown"
1331 * @param[in] vblank A vblank object
1332 * @param[in] name vblank name
1333 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1336 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
1339 * @brief Get the name for a vblank object
1340 * @details The default name is "unknown"
1341 * @param[in] vblank A vblank object
1342 * @param[out] name vblank name
1343 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1346 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
1349 * @brief Set the fps to a vblank object
1350 * @details Default is the @b vertical @b refresh @b rate of the given output.
1351 * It could be ignored when the fixed fps is set by #tdm_vblank_set_fixed_fps
1352 * @param[in] vblank A vblank object
1353 * @param[in] fps over 0
1354 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1357 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
1360 * @brief Get the fps for a vblank object
1361 * @param[in] vblank A vblank object
1362 * @param[out] fps over 0
1363 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1366 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
1369 * @brief Set the fixed fps to a vblank object
1371 * It could be ignored when the global fps is set by #tdm_vblank_enable_global_fps
1372 * @param[in] vblank A vblank object
1373 * @param[in] fps over 0
1374 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1377 tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps);
1380 * @brief Ignore the vblank global fps
1382 * The global fps will be applied to all client's vblanks for all outputs.
1383 * If the client's vblank fps is less than this, the global fps will be ignored
1384 * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1385 * the global fps, it will be ignored also.
1386 * @param[in] vblank A vblank object
1387 * @param[in] ignore 1: ignore 0:not ignore(default)
1388 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1391 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore);
1394 * @brief Set the offset(milli-second) to a vblank object
1395 * @details Default is @b 0.
1396 * @param[in] vblank A vblank object
1397 * @param[in] offset the offset(milli-second)
1398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1401 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
1404 * @brief Get the offset(milli-second) for a vblank object
1405 * @param[in] vblank A vblank object
1406 * @param[out] offset the offset(milli-second)
1407 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1410 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1413 * @brief Enable/Disable the fake vblank to a vblank object
1415 * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1416 * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1418 * @param[in] vblank A vblank object
1419 * @param[in] enable_fake 1:enable, 0:disable
1420 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1423 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1426 * @brief Get the fake vblank
1427 * @param[in] vblank A vblank object
1428 * @param[out] enable_fake 1:enable, 0:disable
1429 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1432 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1435 * @brief Wait for a vblank
1437 * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1438 * SHOULD be called after the given interval. \n
1439 * The sequence value of tdm_vblank_handler is the relative value of fps.
1440 * If fps = 10, this sequence value should be increased by 10 during 1 second.
1441 * @param[in] vblank A vblank object
1442 * @param[in] req_sec The vblank request time(second)
1443 * @param[in] req_usec The vblank request time(micro-second)
1444 * @param[in] interval The vblank interval
1445 * @param[in] func The user vblank handler
1446 * @param[in] user_data The user data
1447 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1450 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1451 unsigned int interval, tdm_vblank_handler func, void *user_data);
1454 * @brief Wait for a vblank with the target sequence number
1455 * @param[in] vblank A vblank object
1456 * @param[in] req_sec The vblank request time(second)
1457 * @param[in] req_usec The vblank request time(micro-second)
1458 * @param[in] sequence The target sequence number
1459 * @param[in] func The user client vblank handler
1460 * @param[in] user_data The user data
1461 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1464 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1465 unsigned int sequence, tdm_vblank_handler func, void *user_data);
1471 #endif /* _TDM_H_ */