ProviderSettingsEditor
This is a custom Editor base for Provider Settings. It displays provider general settings and you can use it to extend provider settings editors to display custom provider settings.
Read time 7 minutesLast updated 11 days ago
Definition
- Type: Class
- Namespace: UnityEditor.AdaptivePerformance.Editor
- Assembly: UnityEditor.AdaptivePerformanceModule
- Inherits from: Editor
public class ProviderSettingsEditor : Editor
Fields
Value | Description |
|---|---|
| m_ShowDevelopmentSettings | Whether the development settings are collapsed or not. |
| m_ShowIndexerSettings | Whether the indexer settings are collapsed or not. |
| m_ShowRuntimeSettings | Whether the runtime settings are collapsed or not. |
| m_ShowScalerSettings | Whether the scaler settings are collapsed or not. |
Properties
Property | Description |
|---|---|
| CurrentTargetGroup | Specify which platform the provider should be supported on. |
| IsAutoGameModeAvailable | Controls whether or not the 'AutomaticGameModeEnabled' option is available. Default value is |
| IsAutoPerformanceModeAvailable | Controls whether or not the 'AutomaticPerformanceModeEnabled' option is available. Default value is |
| IsBoostAvailable | Controls whether or not the 'EnableBoostOnStartup' option is available. Default value is |
| IsThermalActionDelayAvailable | Controls whether or not the 'Indexer/Thermal Action Delay' option is available. Default value is |
| ShowTargetGroupSelection | Whether to show targetGroupSelection tab when using the default base setting. User should use this property to conditionally define their UI if they choose to custom the provider setting UI for each platform and uses the targetGroupSelection tab. |
| UnsupportedInfo | String to show when the provider is not available on this platform. |
Methods
Method | Description |
|---|---|
| DisplayBaseDeveloperSettings | Displays the base developer settings. Requires DisplayBaseSettingsBegin() to be called before and DisplayBaseSettingsEnd() after as serialization is not taken care of. |
| DisplayBaseIndexerSettings | Displays the base indexer settings. Requires the serializedObject to be updated before and applied after as serialization is not taken care of. |
| DisplayBaseRuntimeSettings | Displays the base runtime settings. Requires DisplayBaseSettingsBegin() to be called before and DisplayBaseSettingsEnd() after as serialization is not taken care of. |
| DisplayBaseSettingsBegin | Starts the display block of the base settings. Needs to be called if DisplayBaseRuntimeSettings() or DisplayBaseDeveloperSettings() gets called. Needs to be concluded by a call to DisplayBaseSettingsEnd(). Pass isLegacyAPI = false to hide the legacy warning banner and comply with new APIs. Default is true (for compatibility). |
| DisplayBaseSettingsEnd | Ends the display block of the base settings. Needs to be called if DisplayBaseSettingsBegin() is called. Pass isLegacyAPI = false to comply with new APIs in this class. Default is true (for compatibility). |
| DisplayProviderSettings | Default UI for showing provider settings on both project settings and build profile. |
| DisplayScalerSettings | Displays the base scaler settings. Requires the serializedObject to be updated before and applied after as serialization is not taken care of. |
| DisplayTargetProviderSettings | Display default common base settings for provider on specific target, which user could choose to override if they are using DisplayProviderSettings. |
| OnEnable | Enables Settings Editor and generates the reorderable list to store all profiles in. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |