DisplayState DisplayState DisplayState DisplayState DisplayState Class

Definition

Represents a slice in time of display pipeline state for a subset of the system's display targets. If IsReadOnly is false, then this object can be modified by connecting targets that are owned by the caller's DisplayManager, or by modifying path properties. Modifying a DisplayState object, or its child objects, does not directly modify the system's display state until you call TryApply.

public : sealed class DisplayState
struct winrt::Windows::Devices::Display::Core::DisplayState
public sealed class DisplayState
Public NotInheritable Class DisplayState
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Properties

IsReadOnly IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether this DisplayState and its child views and paths can be modified.

IsStale IsStale IsStale IsStale IsStale

Gets a value indicating whether the system display state has changed since this DisplayState was created.

Properties Properties Properties Properties Properties

Reserved for future use.

Targets Targets Targets Targets Targets

Returns the set of DisplayTarget objects used to create this DisplayState object.

Views Views Views Views Views

Methods

CanConnectTargetToView(DisplayTarget, DisplayView) CanConnectTargetToView(DisplayTarget, DisplayView) CanConnectTargetToView(DisplayTarget, DisplayView) CanConnectTargetToView(DisplayTarget, DisplayView) CanConnectTargetToView(DisplayTarget, DisplayView)
Clone() Clone() Clone() Clone() Clone()

Creates a copy of this DisplayState object, including copies of all views and paths.

ConnectTarget(DisplayTarget) ConnectTarget(DisplayTarget) ConnectTarget(DisplayTarget) ConnectTarget(DisplayTarget) ConnectTarget(DisplayTarget)
ConnectTarget(DisplayTarget, DisplayView) ConnectTarget(DisplayTarget, DisplayView) ConnectTarget(DisplayTarget, DisplayView) ConnectTarget(DisplayTarget, DisplayView) ConnectTarget(DisplayTarget, DisplayView)

Connects the specified target to an existing logical clone group and returns the resulting path.

DisconnectTarget(DisplayTarget) DisconnectTarget(DisplayTarget) DisconnectTarget(DisplayTarget) DisconnectTarget(DisplayTarget) DisconnectTarget(DisplayTarget)
GetPathForTarget(DisplayTarget) GetPathForTarget(DisplayTarget) GetPathForTarget(DisplayTarget) GetPathForTarget(DisplayTarget) GetPathForTarget(DisplayTarget)
GetViewForTarget(DisplayTarget) GetViewForTarget(DisplayTarget) GetViewForTarget(DisplayTarget) GetViewForTarget(DisplayTarget) GetViewForTarget(DisplayTarget)
TryApply(DisplayStateApplyOptions) TryApply(DisplayStateApplyOptions) TryApply(DisplayStateApplyOptions) TryApply(DisplayStateApplyOptions) TryApply(DisplayStateApplyOptions)

Attempts to atomically apply this DisplayState to the relevant hardware. Implicitly, this involves "functionalizing" all paths to determine the best modes matching all DisplayPath and DisplayView properties.

TryFunctionalize(DisplayStateFunctionalizeOptions) TryFunctionalize(DisplayStateFunctionalizeOptions) TryFunctionalize(DisplayStateFunctionalizeOptions) TryFunctionalize(DisplayStateFunctionalizeOptions) TryFunctionalize(DisplayStateFunctionalizeOptions)

Attempts to "functionalize" this DisplayState by trying to evaluate the best modes on all paths given all specified DisplayPath properties as constraints. This method then (optionally, see Remarks) updates all DisplayPath and DisplayView properties with the results of the functionalization. In particular, all DisplayPath and DisplayView properties set to null will have their values computed and set.