libnx  v4.2.2
lbl.h
Go to the documentation of this file.
1 /**
2  * @file lbl.h
3  * @brief LBL service IPC wrapper.
4  * @author SciresM, exelix
5  * @copyright libnx Authors
6  */
7 #pragma once
8 #include "../types.h"
9 #include "../sf/service.h"
10 
11 typedef enum {
12  LblBacklightSwitchStatus_Disabled = 0,
13  LblBacklightSwitchStatus_Enabled = 1,
14  LblBacklightSwitchStatus_Enabling = 2,
15  LblBacklightSwitchStatus_Disabling = 3,
16 } LblBacklightSwitchStatus;
17 
18 /// Initialize lbl.
19 Result lblInitialize(void);
20 
21 /// Exit lbl.
22 void lblExit(void);
23 
24 /// Gets the Service object for the actual lbl service session.
26 
27 Result lblSaveCurrentSetting(void);
28 Result lblLoadCurrentSetting(void);
29 
30 /**
31  * @note The brightness goes from 0 to 1.0.
32  */
33 Result lblSetCurrentBrightnessSetting(float brightness);
34 Result lblGetCurrentBrightnessSetting(float *out_value);
35 
36 Result lblApplyCurrentBrightnessSettingToBacklight(void);
37 Result lblGetBrightnessSettingAppliedToBacklight(float *out_value);
38 
39 Result lblSwitchBacklightOn(u64 fade_time);
40 Result lblSwitchBacklightOff(u64 fade_time);
41 Result lblGetBacklightSwitchStatus(LblBacklightSwitchStatus *out_value);
42 
43 Result lblEnableDimming(void);
44 Result lblDisableDimming(void);
45 Result lblIsDimmingEnabled(bool *out_value);
46 
47 Result lblEnableAutoBrightnessControl(void);
48 Result lblDisableAutoBrightnessControl(void);
49 Result lblIsAutoBrightnessControlEnabled(bool *out_value);
50 
51 Result lblSetAmbientLightSensorValue(float value);
52 
53 /**
54  * @note Used internally by \ref appletGetAmbientLightSensorValue and \ref appletGetCurrentIlluminanceEx.
55  */
56 Result lblGetAmbientLightSensorValue(bool *over_limit, float *lux);
57 
58 /**
59  * @note Only available on [3.0.0+].
60  * @note Used internally by \ref appletIsIlluminanceAvailable.
61  */
63 
64 /**
65  * @note Only available on [3.0.0+].
66  */
68 
69 /**
70  * @note Only available on [3.0.0+].
71  */
73 
74 /**
75  * @note Only available on [3.0.0+].
76  * @note Used internally by \ref appletSetVrModeEnabled.
77  */
79 
80 /**
81  * @note Only available on [3.0.0+].
82  * @note Used internally by \ref appletSetVrModeEnabled.
83  */
85 
86 /**
87  * @note Only available on [3.0.0+].
88  * @note Used internally by \ref appletIsVrModeEnabled.
89  */
90 Result lblIsVrModeEnabled(bool *out_value);
lblSetCurrentBrightnessSetting
Result lblSetCurrentBrightnessSetting(float brightness)
lblSetCurrentBrightnessSettingForVrMode
Result lblSetCurrentBrightnessSettingForVrMode(float brightness)
lblIsVrModeEnabled
Result lblIsVrModeEnabled(bool *out_value)
lblEnableVrMode
Result lblEnableVrMode(void)
lblGetCurrentBrightnessSettingForVrMode
Result lblGetCurrentBrightnessSettingForVrMode(float *out_value)
u64
uint64_t u64
64-bit unsigned integer.
Definition: types.h:22
lblExit
void lblExit(void)
Exit lbl.
lblGetServiceSession
Service * lblGetServiceSession(void)
Gets the Service object for the actual lbl service session.
Result
u32 Result
Function error code result type.
Definition: types.h:44
lblIsAmbientLightSensorAvailable
Result lblIsAmbientLightSensorAvailable(bool *out_value)
lblInitialize
Result lblInitialize(void)
Initialize lbl.
lblGetAmbientLightSensorValue
Result lblGetAmbientLightSensorValue(bool *over_limit, float *lux)
lblDisableVrMode
Result lblDisableVrMode(void)
Service
Service object structure.
Definition: service.h:13