summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore_fb/ecore_fb.c
diff options
context:
space:
mode:
authorncn <ncn>2004-08-23 22:59:00 +0000
committerncn <ncn@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>2004-08-23 22:59:00 +0000
commit08e7335c1ca0f17037a6b3b1d1c48afe33fde63c (patch)
tree18d69e19ed4680468b56603f5c3cb623667c7b7b /legacy/ecore/src/lib/ecore_fb/ecore_fb.c
parent2b7e81c3dcff53d704e41752dc862ef2dcff6480 (diff)
Just some docs for Ecore_FB functions, some functions still left to doc.
SVN revision: 11329
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore_fb/ecore_fb.c116
1 files changed, 84 insertions, 32 deletions
diff --git a/legacy/ecore/src/lib/ecore_fb/ecore_fb.c b/legacy/ecore/src/lib/ecore_fb/ecore_fb.c
index 01d4878dbb..d518a5ea52 100644
--- a/legacy/ecore/src/lib/ecore_fb/ecore_fb.c
+++ b/legacy/ecore/src/lib/ecore_fb/ecore_fb.c
@@ -375,9 +375,17 @@ static char *_ecore_fb_btn_syms[128] =
375}; 375};
376 376
377/** 377/**
378 * @defgroup Ecore_FB_Library_Group Framebuffer Library Functions
379 *
380 * Functions used to set up and shut down the Ecore_Framebuffer functions.
381 */
382
383/**
378 * Sets up the Ecore_Fb library. 384 * Sets up the Ecore_Fb library.
379 * @param name device target name 385 * @param name device target name
380 * @return @c 0 on failure, greater than @c 0 on success. 386 * @return @c 0 on failure. Otherwise, the number of times the library has
387 * been initialised without being shut down.
388 * @ingroup Ecore_FB_Library_Group
381 */ 389 */
382int 390int
383ecore_fb_init(const char *name) 391ecore_fb_init(const char *name)
@@ -509,8 +517,9 @@ ecore_fb_init(const char *name)
509 517
510/** 518/**
511 * Shuts down the Ecore_Fb library. 519 * Shuts down the Ecore_Fb library.
512 * @return @c 0 if the system was shut * down, or 1 if it still needs to 520 * @return @c The number of times the system has been initialised without
513 * be shut down 521 * being shut down.
522 * @ingroup Ecore_FB_Library_Group
514 */ 523 */
515int 524int
516ecore_fb_shutdown(void) 525ecore_fb_shutdown(void)
@@ -555,13 +564,20 @@ ecore_fb_shutdown(void)
555} 564}
556 565
557/** 566/**
567 * @defgroup Ecore_FB_Click_Group Framebuffer Double Click Functions
568 *
569 * Functions that deal with the double click time of the framebuffer.
570 */
571
572/**
558 * Sets the timeout for a double and triple clicks to be flagged. 573 * Sets the timeout for a double and triple clicks to be flagged.
559 * 574 *
560 * This sets the time between clicks before the double_click flag is 575 * This sets the time between clicks before the double_click flag is
561 * set in a button down event. If 3 clicks occur within double this 576 * set in a button down event. If 3 clicks occur within double this
562 * time, the triple_click flag is also set. 577 * time, the triple_click flag is also set.
563 * 578 *
564 * @param t The time in seconds 579 * @param t The time in seconds
580 * @ingroup Ecore_FB_Click_Group
565 */ 581 */
566void 582void
567ecore_fb_double_click_time_set(double t) 583ecore_fb_double_click_time_set(double t)
@@ -576,6 +592,7 @@ ecore_fb_double_click_time_set(double t)
576 * See @ref ecore_x_double_click_time_set for more information. 592 * See @ref ecore_x_double_click_time_set for more information.
577 * 593 *
578 * @return The timeout for double clicks in seconds. 594 * @return The timeout for double clicks in seconds.
595 * @ingroup Ecore_FB_Click_Group
579 */ 596 */
580double 597double
581ecore_fb_double_click_time_get(void) 598ecore_fb_double_click_time_get(void)
@@ -596,12 +613,19 @@ ecore_fb_size_get(int *w, int *h)
596} 613}
597 614
598/** 615/**
616 * @defgroup Ecore_FB_Calibrate_Group Framebuffer Calibration Functions
617 *
618 * Functions that calibrate the screen.
619 */
620
621/**
599 * Calibrates the touschreen using the given parameters. 622 * Calibrates the touschreen using the given parameters.
600 * @param xscale X scaling, where 256 = 1.0 623 * @param xscale X scaling, where 256 = 1.0
601 * @param xtrans X translation. 624 * @param xtrans X translation.
602 * @param yscale Y scaling. 625 * @param yscale Y scaling.
603 * @param ytrans Y translation. 626 * @param ytrans Y translation.
604 * @param xyswap Swap X & Y flag. 627 * @param xyswap Swap X & Y flag.
628 * @ingroup Ecore_FB_Calibrate_Group
605 */ 629 */
606void 630void
607ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap) 631ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap)
@@ -619,12 +643,13 @@ ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytra
619 643
620/** 644/**
621 * Retrieves the calibration parameters of the touchscreen. 645 * Retrieves the calibration parameters of the touchscreen.
622 * @param xscale Pointer to an integer in which to store the X scaling. 646 * @param xscale Pointer to an integer in which to store the X scaling.
623 * Note that 256 = 1.0. 647 * Note that 256 = 1.0.
624 * @param xtrans Pointer to an integer in which to store the X translation. 648 * @param xtrans Pointer to an integer in which to store the X translation.
625 * @param yscale Pointer to an integer in which to store the Y scaling. 649 * @param yscale Pointer to an integer in which to store the Y scaling.
626 * @param ytrans Pointer to an integer in which to store the Y translation. 650 * @param ytrans Pointer to an integer in which to store the Y translation.
627 * @param xyswap Pointer to an integer in which to store the Swap X & Y flag. 651 * @param xyswap Pointer to an integer in which to store the Swap X & Y flag.
652 * @ingroup Ecore_FB_Calibrate_Group
628 */ 653 */
629void 654void
630ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap) 655ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap)
@@ -641,8 +666,15 @@ ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *
641} 666}
642 667
643/** 668/**
669 * @defgroup Ecore_FB_Backlight_Group Framebuffer Backlight Functions
670 *
671 * Functions that deal with the backlight of a framebuffer's screen.
672 */
673
674/**
644 * Turns on or off the backlight. 675 * Turns on or off the backlight.
645 * @param on @c 1 to turn the backlight on. @c 0 to turn it off. 676 * @param on @c 1 to turn the backlight on. @c 0 to turn it off.
677 * @ingroup Ecore_FB_Backlight_Group
646 */ 678 */
647void 679void
648ecore_fb_backlight_set(int on) 680ecore_fb_backlight_set(int on)
@@ -657,7 +689,8 @@ ecore_fb_backlight_set(int on)
657 689
658/** 690/**
659 * Retrieves the backlight state. 691 * Retrieves the backlight state.
660 * @return Whether the backlight is on. 692 * @return Whether the backlight is on.
693 * @ingroup Ecore_FB_Backlight_Group
661 */ 694 */
662int 695int
663ecore_fb_backlight_get(void) 696ecore_fb_backlight_get(void)
@@ -671,8 +704,9 @@ ecore_fb_backlight_get(void)
671 704
672/** 705/**
673 * Sets the backlight brightness. 706 * Sets the backlight brightness.
674 * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0 707 * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0
675 * is brightest. 708 * is brightest.
709 * @ingroup Ecore_FB_Backlight_Group
676 */ 710 */
677void 711void
678ecore_fb_backlight_brightness_set(double br) 712ecore_fb_backlight_brightness_set(double br)
@@ -690,8 +724,9 @@ ecore_fb_backlight_brightness_set(double br)
690 724
691/** 725/**
692 * Retrieves the backlight brightness. 726 * Retrieves the backlight brightness.
693 * @return The current backlight brigntess, where 0.0 is the darkest and 727 * @return The current backlight brigntess, where 0.0 is the darkest and
694 * 1.0 is the brightest. 728 * 1.0 is the brightest.
729 * @ingroup Ecore_FB_Backlight_Group
695 */ 730 */
696double 731double
697ecore_fb_backlight_brightness_get(void) 732ecore_fb_backlight_brightness_get(void)
@@ -704,9 +739,16 @@ ecore_fb_backlight_brightness_get(void)
704} 739}
705 740
706/** 741/**
707 * To be documented. 742 * @defgroup Ecore_FB_LED_Group Framebuffer LED Functions
708 * 743 *
709 * FIXME: To be fixed. 744 * Functions that deal with the light emitting diode connected to the
745 * current framebuffer.
746 */
747
748/**
749 * Sets whether the current framebuffer's LED to the given state.
750 * @param on @c 1 to indicate the LED should be on, @c 0 if it should be off.
751 * @ingroup Ecore_FB_LED_Group
710 */ 752 */
711void 753void
712ecore_fb_led_set(int on) 754ecore_fb_led_set(int on)
@@ -720,9 +762,10 @@ ecore_fb_led_set(int on)
720} 762}
721 763
722/** 764/**
723 * To be documented. 765 * Makes the LED of the current framebuffer blink.
724 * 766 * @param speed Number to give the speed on the blink.
725 * FIXME: To be fixed. 767 * @ingroup Ecore_FB_LED_Group
768 * @todo Documentation: Work out what speed the units are in.
726 */ 769 */
727void 770void
728ecore_fb_led_blink_set(double speed) 771ecore_fb_led_blink_set(double speed)
@@ -738,9 +781,15 @@ ecore_fb_led_blink_set(double speed)
738} 781}
739 782
740/** 783/**
741 * To be documented. 784 * @defgroup Ecore_FB_Contrast_Group Framebuffer Contrast Functions
742 * 785 *
743 * FIXME: To be fixed. 786 * Values that set and retrieve the contrast of a framebuffer screen.
787 */
788
789/**
790 * Sets the contrast used by the framebuffer screen.
791 * @param cr Value between 0 and 1 that gives the new contrast of the screen.
792 * @ingroup Ecore_FB_Contrast_Group
744 */ 793 */
745void 794void
746ecore_fb_contrast_set(double cr) 795ecore_fb_contrast_set(double cr)
@@ -756,9 +805,10 @@ ecore_fb_contrast_set(double cr)
756} 805}
757 806
758/** 807/**
759 * To be documented. 808 * Retrieves the contrast currently being used by the framebuffer screen.
760 * 809 * @return A value between 0 and 1 that represents the current contrast of the
761 * FIXME: To be fixed. 810 * screen.
811 * @ingroup Ecore_FB_Contrast_Group
762 */ 812 */
763double 813double
764ecore_fb_contrast_get(void) 814ecore_fb_contrast_get(void)
@@ -791,6 +841,7 @@ ecore_fb_light_sensor_get(void)
791 * To be documented. 841 * To be documented.
792 * 842 *
793 * FIXME: To be fixed. 843 * FIXME: To be fixed.
844 * @todo Documentation: Find out what this does.
794 */ 845 */
795void 846void
796ecore_fb_callback_gain_set(void (*func) (void *data), void *data) 847ecore_fb_callback_gain_set(void (*func) (void *data), void *data)
@@ -803,6 +854,7 @@ ecore_fb_callback_gain_set(void (*func) (void *data), void *data)
803 * To be documented. 854 * To be documented.
804 * 855 *
805 * FIXME: To be fixed. 856 * FIXME: To be fixed.
857 * @todo Documentation: Find out what this does.
806 */ 858 */
807void 859void
808ecore_fb_callback_lose_set(void (*func) (void *data), void *data) 860ecore_fb_callback_lose_set(void (*func) (void *data), void *data)