PerceptionColorFrameSource.IsCorrelatedWith(String) Method

Reference

Definition

Namespace:: Windows.Devices.Perception

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Checks whether or not the color frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this color frame source to the entity, or vice versa.

public:
 virtual bool IsCorrelatedWith(Platform::String ^ targetId) = IsCorrelatedWith;

bool IsCorrelatedWith(winrt::hstring const& targetId);

/// [Windows.Foundation.Metadata.Deprecated("PerceptionColorFrameSource may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
bool IsCorrelatedWith(winrt::hstring const& targetId);

public bool IsCorrelatedWith(string targetId);

[Windows.Foundation.Metadata.Deprecated("PerceptionColorFrameSource may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public bool IsCorrelatedWith(string targetId);

function isCorrelatedWith(targetId)

Public Function IsCorrelatedWith (targetId As String) As Boolean

Parameters

targetId: String
Platform::String

winrt::hstring

The unique ID of the target entity.

Returns

Boolean

bool

Returns true if a correlation exists, otherwise returns false.

Attributes: DeprecatedAttribute

Applies to