DisplaySourceStatus Enum

Definition

Namespace:

Windows.Devices.Display.Core

Defines constants that specify a state that a display source (a DisplaySource object) can be in.

The state affects the display source's usage, and how it affects other API calls. For example, if a display source is powered off, then you can expect that a call to (for example) DisplayTaskPool.TryExecuteTask won't be successful.

public enum class DisplaySourceStatus

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 851968)]
enum class DisplaySourceStatus

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 851968)]
public enum DisplaySourceStatus

var value = Windows.Devices.Display.Core.DisplaySourceStatus.active

Public Enum DisplaySourceStatus

Inheritance

Enum

DisplaySourceStatus

Attributes

ContractVersionAttribute

Windows requirements

Device family	Windows 11 (introduced in 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v14.0)

Fields

Name	Value	Description
Active	0	Specifies that the display source is connected to a DisplayTarget, and is valid and owned by the given **DisplayDevice**. Also, it means that the underlying display's power status is powered on from the kernel's perspective. This is the most common status when a DisplaySource is set up correctly and is in use by a DirectDisplay client for presentation.
PoweredOff	1	Specifies that the display source is connected to a DisplayTarget, and is valid and owned by the given DisplayDevice. But the underlying display's power status is powered off from the kernel's perspective.
Invalid	2	Specifies that the display source is not valid, and the DirectDisplay client needs to recreate the DisplaySource object. A DisplaySource can become invalid for various reasons; for example, display mode changes, or hot plug detect (HPD) of the connected monitor.
OwnedByAnotherDevice	3	Specifies that the display source isn't currently owned by the current DisplayDevice, and is owned by either a different DisplayDevice (let's call that display device A), or by some other Direct3D device. If display device A has ownership, then the current DisplayDevice can try to recreate the display source (if the **DisplayManager** that created display device A used **DisplayManagerOptions.None**. If some other Direct3D device has ownership, then you can still try to recreate the DisplaySource if you believe that you're the right owner.
Unowned	4	Specifies that the display source isn't currently owned by the current DisplayDevice, and is in an unowned state. In this case you can try to recreate the DisplaySource; doing so will give you ownership implicitly.