BrightnessOverride クラス

リファレンス

定義

名前空間:: Windows.Graphics.Display

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

BrightnessOverride を使用すると、アプリケーションでデバイスに設定されている画面の明るさレベルをオーバーライドできます。この API を使用すると、制御可能な明るさをサポートするデバイスでアプリケーションごとの明るさ制御を行うことができます。

BrightnessOverride を使用すると、ユーザーの明るさレベルの設定を一時的または永続的にオーバーライドできます。

注意

初期化された BrightnessOverride オブジェクトを GetDefaultForSystem または GetForCurrentView から最初に取得する場合、そのオブジェクトの BrightnessLevel プロパティの値は未定義です (たとえば、値は現在のシステムの明るさレベルを表しません)。明るさレベルを設定するには、まず SetBrightnessLevel を呼び出す必要があります。

public ref class BrightnessOverride sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BrightnessOverride final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BrightnessOverride

Public NotInheritable Class BrightnessOverride

継承: Object Platform::Object IInspectable BrightnessOverride

属性: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイスファミリ	Windows 10 Creators Update (10.0.15063.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v4.0 で導入)

プロパティ

BrightnessLevel	この BrightnessOverride インスタンスの画面の明るさレベルを取得します (明るさレベルを設定するために SetBrightnessLevel を以前に呼び出した場合)。注意初期化された BrightnessOverride オブジェクトを GetDefaultForSystem または GetForCurrentView から最初に取得する場合、そのオブジェクトの BrightnessLevel プロパティの値は未定義です (たとえば、値は現在のシステムの明るさレベルを表しません)。明るさレベルを設定するには、まず SetBrightnessLevel を呼び出す必要があります。
IsOverrideActive	明るさのオーバーライドがアクティブかどうかを示す BOOLEAN 値。 TRUE の場合、現在の明るさレベルはオーバーライドの明るさレベルと一致します。 StartOverride() が呼び出されない場合、このプロパティ値は常に FALSE になります。
IsSupported	デバイスに現在、少なくとも 1 つの明るさ制御可能なディスプレイがあるかどうかを示します。 TRUE の場合、デバイスには、明るさのオーバーライドをサポートする少なくとも 1 つの明るさ制御可能なディスプレイがあります。

メソッド

GetDefaultForSystem()	明るさオーバーライドオブジェクトを返します。このメソッドは CoreWindow を必要としないため、バックグラウンドで実行されているアプリで使用できます。
GetForCurrentView()	BrightnessOverride オブジェクトを返します。このメソッドには CoreWindow が必要であるため、ウィンドウで現在実行されているアプリでのみ使用できます。返される明るさオーバーライドオブジェクトは、同じスレッドで BrightnessOverride.GetForCurrentView を複数呼び出す間に同じではない可能性があります。メイン UI スレッドから BrightnessOverride.GetForCurrentView を呼び出す必要があります。
GetLevelForScenario(DisplayBrightnessScenario)	指定したシナリオに関連付けられている明るさレベルを取得します。
SaveForSystemAsync(BrightnessOverride)	これらの値をユーザー設定にコミットして、指定した明るさオーバーライド設定を保存します。オーバーライドの停止後にオーバーライド設定を保持するには、このメソッドを使用します。が値に渡された場合`null`、システムは自動明るさをオンにします。
SetBrightnessLevel(Double, DisplayBrightnessOverrideOptions)	明るさレベルとオーバーライドオプションを設定します。アプリで、オーバーライドする内容で現在の明るさを変更する準備ができたら、 StartOverride を呼び出します。
SetBrightnessScenario(DisplayBrightnessScenario, DisplayBrightnessOverrideOptions)	既知の明るさレベルを持つシナリオと、明るさオーバーライドのオーバーライドオプションを指定して、明るさレベルを設定します。
StartOverride()	画面の明るさレベルのオーバーライドを開始するように要求します。オーバーライドを開始する要求は、画面の明るさレベルが、指定したオーバーライドの明るさレベルに合わせて常に変更されることを意味するものではありません。このオーバーライド要求を受け入れるかどうかを決定するのは、システム次第です。 IsOverrideActive プロパティと IsOverrideActiveChanged プロパティを使用して、システムがオーバーライド要求を受け入れたかどうかを判断します。
StopOverride()	明るさレベルのオーバーライドを停止します。

イベント

BrightnessLevelChanged	画面の明るさレベルが変化したときに発生します。
IsOverrideActiveChanged	画面の明るさレベルが一致し始めるか、オーバーライドの明るさレベルに一致するように停止したときに発生します。このイベントは、 IsOverrideActive プロパティの状態が変更されたときに発生します。
IsSupportedChanged	明るさ制御可能なディスプレイが検出または削除されたときに発生します。このイベントは、 IsSupported プロパティが変更されたときに発生します。

適用対象