This function is part of the UI Interface.
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
UI.UIInterface.AddNotifyDisplaySettingsUpdated
|
Parameter Type And Name
|
Usage Information
|
|
AddNotifyDisplaySettingsUpdatedOptions options
|
Structure containing information about the request.
|
|
object clientData
|
Arbitrary data that is passed back to you in the NotificationFn.
|
|
OnDisplaySettingsUpdatedCallback notificationFn
|
A callback that is fired when the overlay display settings are updated.
|
This function enables your callback (the NotificationFn parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.
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.
Function prototype definition for callbacks passed to EOS_UI_AddNotifyDisplaySettingsUpdated
Callback Parameters
UI.OnDisplaySettingsUpdatedCallback
|
Parameter Type And Name
|
Usage Information
|
|
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:
UI.OnDisplaySettingsUpdatedCallbackInfo
|
Property
|
Value
|
|
object ClientData
|
Context that was passed into EOS_UI_AddNotifyDisplaySettingsUpdated
|
|
bool IsVisible
|
True when any portion of the overlay is visible.
|
|
bool IsExclusiveInput
|
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.