diff options
| author | Oliver Schinagl <oliver@schinagl.nl> | 2004-12-09 13:08:08 (GMT) |
|---|---|---|
| committer | Oliver Schinagl <oliver@schinagl.nl> | 2004-12-09 13:08:08 (GMT) |
| commit | 1ea117c6702d99249704d5f9acbea00e88df30a7 (patch) | |
| tree | 53239806ee325902f946e0220abab87e0c2d65f0 /Graphic_Equalizer/include | |
| parent | 1fcf36d7f0985a74f44bee6b2e4feec76e79654b (diff) | |
| download | TASS-1ea117c6702d99249704d5f9acbea00e88df30a7.zip TASS-1ea117c6702d99249704d5f9acbea00e88df30a7.tar.gz TASS-1ea117c6702d99249704d5f9acbea00e88df30a7.tar.bz2 | |
Resolved Merge Conflict
Diffstat (limited to 'Graphic_Equalizer/include')
| -rw-r--r-- | Graphic_Equalizer/include/display_shared.hch | 78 |
1 files changed, 46 insertions, 32 deletions
diff --git a/Graphic_Equalizer/include/display_shared.hch b/Graphic_Equalizer/include/display_shared.hch index c9d3725..11d6edc 100644 --- a/Graphic_Equalizer/include/display_shared.hch +++ b/Graphic_Equalizer/include/display_shared.hch @@ -1,9 +1,10 @@ /*! \file display_shared.hch
*
- * \section generic Message build up information and more
+ * \brief Datastructures and defines for usage when interacting with the
+ * display library.
*
* \section project Project information.
- * Project Graphic Equalizer\n
+ * Graphic Equalizer 2\n
* \author
* \date 20041011
* \version 0.1
@@ -21,44 +22,57 @@ -typedef struct {
- unsigned 10 area_spectrum_bottom, area_spectrum_top, area_spectrum_left, area_spectrum_right;
- unsigned 10 area_waveform_bottom, area_waveform_top, area_waveform_left, area_waveform_right;
- unsigned 10 area_volume_bottom, area_volume_top, area_volume_left, area_volume_right;
- unsigned 24 color_area_volume, color_area_waveform, color_area_spectrum_top, color_area_spectrum_bottom, color_equalizer;
-} skindata_t;
+/*! \struct skindata_t
+ * \brief This struct contains all area- dimensions and color information
+ * for the skin.
+ */
+struct skindata_t {
+ /*! \struct skin_info_t
+ * \brief Structure containing the four boundry limits of an area and
+ * maximal two colors per area.
+ */
+ struct skin_info_t {
+ unsigned 10 area_bottom; /*!< lowest point registerd in the area */
+ unsigned 10 area_top; /*!< highest point registerd in the area */
+ unsigned 10 area_left; /*!< leftmost point registerd in the area */
+ unsigned 10 area_right; /*!< rightmost point registerd in the area */
+ unsigned 24 color_primary; /*!< primary color for this area */
+ unsigned 24 color_secondary; /*!< optionally an area can have a second color */
+ };
+ struct skin_info_t waveform; /*!< We store all information about the waveform area here. */
+ struct skin_info_t spectrum; /*!< We store all information about the spectrum analyzer area here. */
+ struct skin_info_t volume; /*!< We store all information about the volume control area here. */
+ struct skin_info_t equalizer; /*!< We store all information about the equalizerbars here. */
+};
-/*
- * Define all area's of the display.
- */
-#define AREA_WAVEFORM 0x01
-#define AREA_VOLUME_YAXIS 0x02
-#define AREA_SPECTRUM_ANALYZER 0x03
+#define AREA_WAVEFORM 0x01 /*!< Waveform area. */
+#define AREA_VOLUME_YAXIS 0x02 /*!< Volume control on the Y plane. */
+#define AREA_SPECTRUM_ANALYZER 0x03 /*!< Spectrum Analyzer area. */
-#define BUTTON_LOG 0x04
-#define BUTTON_DEMO 0x05
-#define BUTTON_RESET 0x06
+#define BUTTON_LOG 0x04 /*!< Logarithmic display button. */
+#define BUTTON_DEMO 0x05 /*!< Demo preset button. */
+#define BUTTON_RESET 0x06 /*!< Reset presets button. */
-#define BUTTON_PRESET_1 0x07
-#define BUTTON_PRESET_2 0x08
-#define BUTTON_PRESET_3 0x09
-#define BUTTON_PRESET_4 0x0a
-#define BUTTON_PRESET_5 0x0b
-#define BUTTON_PRESET_6 0x0c
+#define BUTTON_PRESET_1 0x07 /*!< Button for switching to preset 1 */
+#define BUTTON_PRESET_2 0x08 /*!< Button for switching to preset 2 */
+#define BUTTON_PRESET_3 0x09 /*!< Button for switching to preset 3 */
+#define BUTTON_PRESET_4 0x0a /*!< Button for switching to preset 4 */
+#define BUTTON_PRESET_5 0x0b /*!< Button for switching to preset 5 */
+#define BUTTON_PRESET_6 0x0c /*!< Button for switching to preset 6 */
-#define BUTTON_PRECISE 0x0d /* | */
-#define BUTTON_CONCAVE_HALF 0x0e /* \/ */
-#define BUTTON_CONVEX_HALF 0x0f /* /\ */
-#define BUTTON_CONCAVE_FULL 0x10 /* \ / */
-#define BUTTON_CONVEX_FULL 0x11 /* / \ */
+#define BUTTON_CONVEX_FULL 0x0d /*!< / - \ 'Convex' mode Button*/
+#define BUTTON_CONVEX_HALF 0x0e /*!< /\ 'Convex' mode Button */
+#define BUTTON_PRECISE 0x0f /*!< | 'Precise' selection Button */
+#define BUTTON_CONCAVE_HALF 0x10 /*!< \/ 'Concave' mode Button */
+#define BUTTON_CONCAVE_FULL 0x11 /*!< \ _ / 'Concave' mode Button */
-#define BUTTON_HELP 0x12
-#define BUTTON_MODE 0x13
+#define BUTTON_HELP 0x12 /*!< Button to display help screen. */
+#define BUTTON_MODE 0x13 /*!< Button to change operation mode. */
-#define AREA_EQUALIZER_MIN 0x80
-#define AREA_EQUALIZER_MAX 0xff
+#define AREA_EQUALIZER_MIN 0x80 /*!< First bar of the Equalizer Area. */
+#define AREA_EQUALIZER_MAX 0xff /*!< Last bar of the Equalizer Area. */
#else
#error "ERROR file display_shared.hch multiple times included"
|