summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Garrett <mjg@redhat.com>2011-01-18 09:43:21 -0500
committerMatthew Garrett <mjg@redhat.com>2011-01-18 09:43:21 -0500
commitcbc204966677cc2da16ac3aede1b4b8103b6ce8c (patch)
treec0a842cae9bba4ec545b8fb980c2ecc891ec296f
parent902bdbfc6df3a686d5bf392fbb2f44c607ad5ba9 (diff)
Comment the header
-rw-r--r--libbacklight.h18
1 files changed, 16 insertions, 2 deletions
diff --git a/libbacklight.h b/libbacklight.h
index 2a6018d..8ef9983 100644
--- a/libbacklight.h
+++ b/libbacklight.h
@@ -17,12 +17,26 @@ struct backlight {
enum backlight_type type;
};
-void backlight_destroy(struct backlight *backlight);
+/*
+ * Find and set up a backlight for the given PCI device or card/connector
+ * combination. It is valid (and preferred) to provide both sets of information
+ */
struct backlight *backlight_init(struct pci_device *dev, int card,
int connector_type, int connector_type_id);
-long backlight_get_brightness(struct backlight *backlight);
+
+/* Free backlight resources */
+void backlight_destroy(struct backlight *backlight);
+
+/* Provide the maximum backlight value */
long backlight_get_max_brightness(struct backlight *backlight);
+
+/* Provide the cached backlight value */
+long backlight_get_brightness(struct backlight *backlight);
+
+/* Provide the hardware backlight value */
long backlight_get_actual_brightness(struct backlight *backlight);
+
+/* Set the backlight to a value between 0 and max */
long backlight_set_brightness(struct backlight *backlight, long brightness);
#ifdef __cplusplus