RegionOfInterest RegionOfInterest RegionOfInterest RegionOfInterest Class

Definition

Represents a region of interest which is a rectangular region on the image which is used for functions such as focus and exposure.

public sealed class RegionOfInterestpublic sealed class RegionOfInterestPublic NotInheritable Class RegionOfInterestpublic sealed class RegionOfInterest
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Get an instance of this class by accessing the @Windows.Media.Devices.RegionOfInterest.#ctor property.

The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus.

Constructors

RegionOfInterest() RegionOfInterest() RegionOfInterest() RegionOfInterest()

Creates a new instance of the RegionOfInterest control.

public RegionOfInterest()public New()Public Sub New()public RegionOfInterest()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

AutoExposureEnabled AutoExposureEnabled AutoExposureEnabled AutoExposureEnabled

Gets or sets a value that specifies if auto exposure is enabled.

public bool AutoExposureEnabled { get; set; }public bool AutoExposureEnabled { get; set; }Public ReadWrite Property AutoExposureEnabled As boolpublic bool AutoExposureEnabled { get; set; }
Value
bool bool bool bool

true if auto exposure is enabled; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

AutoFocusEnabled AutoFocusEnabled AutoFocusEnabled AutoFocusEnabled

Gets or sets a value that specifies if auto focus is enabled.

public bool AutoFocusEnabled { get; set; }public bool AutoFocusEnabled { get; set; }Public ReadWrite Property AutoFocusEnabled As boolpublic bool AutoFocusEnabled { get; set; }
Value
bool bool bool bool

true if auto focus is enabled; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled

Gets or sets a value that specifies if auto white balance is enabled.

public bool AutoWhiteBalanceEnabled { get; set; }public bool AutoWhiteBalanceEnabled { get; set; }Public ReadWrite Property AutoWhiteBalanceEnabled As boolpublic bool AutoWhiteBalanceEnabled { get; set; }
Value
bool bool bool bool

true if auto white balance; otherwise, false.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Bounds Bounds Bounds Bounds

Gets or sets the rectangle that defines the region of focus.

public Rect Bounds { get; set; }public Rect Bounds { get; set; }Public ReadWrite Property Bounds As Rectpublic Rect Bounds { get; set; }
Value
Rect Rect Rect Rect

The rectangle that defines the region of focus.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

To specify a point with non-normalized coordinates, meaning the BoundsNormalized property is not set or set to FALSE, you should specify a rectangle with width of 1 and height of 1.

To specify a point with normalized coordinates, meaning BoundsNormalized is set to TRUE, you should specify a rectangle with width of FLT_EPSILON and height of FLT_EPSILON.

If the region of interest specified by the developer is smaller than what is supported by the hardware, the driver will default to the smallest supported rectangle possible that fully contains the specified region.

BoundsNormalized BoundsNormalized BoundsNormalized BoundsNormalized

Gets or sets a value indicating whether the Bounds Rect is in pixels or is mapped to a range of 0 to 1.0.

public bool BoundsNormalized { get; set; }public bool BoundsNormalized { get; set; }Public ReadWrite Property BoundsNormalized As boolpublic bool BoundsNormalized { get; set; }
Value
bool bool bool bool

A value indicating whether the Bounds Rect is in pixels or is mapped to a range of 0 to 1.0.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

For information on how this property affects the bounds of the region of interest, see the Bounds property.

Type Type Type Type

Gets or sets the type of region represented by the RegionOfInterest object.

public RegionOfInterestType Type { get; set; }public RegionOfInterestType Type { get; set; }Public ReadWrite Property Type As RegionOfInterestTypepublic RegionOfInterestType Type { get; set; }
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Weight Weight Weight Weight

Gets or sets the weight of the region of interest.

public uint Weight { get; set; }public uint Weight { get; set; }Public ReadWrite Property Weight As uintpublic uint Weight { get; set; }
Value
uint uint uint uint

Gets or sets the weight of the region of interest which is a value from 0-100.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)