aboutsummaryrefslogtreecommitdiff
path: root/man/luxget.3
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2022-10-13 00:05:17 +0200
committerThomas Voss <mail@thomasvoss.com> 2022-10-13 00:05:17 +0200
commit240b41ed21ea41ba28272d44a4566e2955b5f00b (patch)
treeed1889f7595a6e8e4e2bf3ea5b26fc3648ed374a /man/luxget.3
parent9c6917a866bd7736001b88e10f20e0e35ec7e977 (diff)
Document the change from struct luxdisp to lux_t
Diffstat (limited to 'man/luxget.3')
-rw-r--r--man/luxget.314
1 files changed, 7 insertions, 7 deletions
diff --git a/man/luxget.3 b/man/luxget.3
index cb4b00f..1f72e1f 100644
--- a/man/luxget.3
+++ b/man/luxget.3
@@ -15,7 +15,7 @@
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: October 1 2022 $
+.Dd $Mdocdate: October 12 2022 $
.Dt LUXGET 3
.Os
.Sh NAME
@@ -28,16 +28,16 @@
.Sh SYNOPSIS
.In lux.h
.Ft int
-.Fn luxget "struct luxdisp *disp"
+.Fn luxget "lux_t *disp"
.Ft int
-.Fn luxmax "struct luxdisp *disp"
+.Fn luxmax "lux_t *disp"
.Ft double
-.Fn luxgetp "struct luxdisp *disp"
+.Fn luxgetp "lux_t *disp"
.Sh DESCRIPTION
The
.Fn luxget
function takes a pointer to a
-.Vt "struct luxdisp"
+.Vt lux_t
structure and returns the raw brightness value of the associated display.
If the function returns \-1 it means that an error has occurred, however this is
only possible if
@@ -64,7 +64,7 @@ functions.
The
.Fn luxgetp
function takes a pointer to a
-.Vt "struct luxdisp"
+.Vt lux_t
structure and returns the brightness of the associated display as a percentage.
A return value of 100.0 means the display is at 100% brightness.
If the function returns \-1 it means that an error has occurred.
@@ -106,7 +106,7 @@ main(void)
{
int cur, max;
double curp;
- struct luxdisp disp;
+ lux_t disp;
luxinit(&disp);