This function is part of the UI Interface.
Remarks
Register to receive notifications when the overlay display settings are updated. Newly registered handlers will always be called the next tick with the current state.
must call RemoveNotifyDisplaySettingsUpdated to remove the notification.
Return Value
handle representing the registered callback
Parameters
EOS_UI_AddNotifyDisplaySettingsUpdated
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HUI Handle | |
| const EOS_UI_AddNotifyDisplaySettingsUpdatedOptions* Options | Structure containing information about the request. |
| void* ClientData | Arbitrary data that is passed back to you in the NotificationFn. |
| const EOS_UI_OnDisplaySettingsUpdatedCallback NotificationFn | A callback that is fired when the overlay display settings are updated. |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_UI_OnDisplaySettingsUpdatedCallback to report the results of its operation. See the EOS_UI_OnDisplaySettingsUpdatedCallbackInfo page for more details, or check the [Callback Data] section below.
Callback Remarks
Function prototype definition for callbacks passed to EOS_UI_AddNotifyDisplaySettingsUpdated
Callback Parameters
EOS_UI_OnDisplaySettingsUpdatedCallback
| Parameter Type And Name | Usage Information |
|---|---|
| const EOS_UI_OnDisplaySettingsUpdatedCallbackInfo* Data | A EOS_UI_OnDisplaySettingsUpdatedCallbackInfo containing the current display state. |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_UI_OnDisplaySettingsUpdatedCallbackInfo
| Property | Value |
|---|---|
| void* ClientData | Context that was passed into EOS_UI_AddNotifyDisplaySettingsUpdated |
| EOS_Bool bIsVisible | True when any portion of the overlay is visible. |
| EOS_Bool bIsExclusiveInput | True when the overlay has switched to exclusive input mode. While in exclusive input mode, no keyboard or mouse input will be sent to the game. |
For more information, see the EOS_UI_OnDisplaySettingsUpdatedCallbackInfo page.