EOS API reference page for EOS_UI_AddNotifyDisplaySettingsUpdated

3 분 소요

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



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_AddNotifyDisplaySettingsUpdatedOptions* OptionsStructure containing information about the request.
void* ClientDataArbitrary data that is passed back to you in the NotificationFn.
const EOS_UI_OnDisplaySettingsUpdatedCallback NotificationFnA 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


Parameter Type And NameUsage Information
const EOS_UI_OnDisplaySettingsUpdatedCallbackInfo* DataA EOS_UI_OnDisplaySettingsUpdatedCallbackInfo containing the current display state.

Callback Data

The EOS SDK passes the following data structure to the callback function:


void* ClientDataContext that was passed into EOS_UI_AddNotifyDisplaySettingsUpdated
EOS_Bool bIsVisibleTrue when any portion of the overlay is visible.
EOS_Bool bIsExclusiveInputTrue 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.