RegionOfInterest 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 RegionOfInterest : IRegionOfInterest, IRegionOfInterest2
struct winrt::Windows::Media::Devices::RegionOfInterest : IRegionOfInterest, IRegionOfInterest2
public sealed class RegionOfInterest : IRegionOfInterest, IRegionOfInterest2
Public NotInheritable Class RegionOfInterest Implements IRegionOfInterest, IRegionOfInterest2
var regionOfInterest = new 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 RegionOfInterest 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() RegionOfInterest()

Creates a new instance of the RegionOfInterest control.

public : RegionOfInterest()
RegionOfInterest() const;
public RegionOfInterest()
Public Sub New()
var regionOfInterest = new regionOfInterest();

Properties

AutoExposureEnabled AutoExposureEnabled AutoExposureEnabled AutoExposureEnabled AutoExposureEnabled

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

public : Platform::Boolean AutoExposureEnabled { get; set; }
bool AutoExposureEnabled(); void AutoExposureEnabled(bool autoexposureenabled);
public bool AutoExposureEnabled { get; set; }
Public ReadWrite Property AutoExposureEnabled As bool
var bool = regionOfInterest.autoExposureEnabled;
regionOfInterest.autoExposureEnabled = bool;
Value
bool bool bool

true if auto exposure is enabled; otherwise, false.

AutoFocusEnabled AutoFocusEnabled AutoFocusEnabled AutoFocusEnabled AutoFocusEnabled

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

public : Platform::Boolean AutoFocusEnabled { get; set; }
bool AutoFocusEnabled(); void AutoFocusEnabled(bool autofocusenabled);
public bool AutoFocusEnabled { get; set; }
Public ReadWrite Property AutoFocusEnabled As bool
var bool = regionOfInterest.autoFocusEnabled;
regionOfInterest.autoFocusEnabled = bool;
Value
bool bool bool

true if auto focus is enabled; otherwise, false.

AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled AutoWhiteBalanceEnabled

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

public : Platform::Boolean AutoWhiteBalanceEnabled { get; set; }
bool AutoWhiteBalanceEnabled(); void AutoWhiteBalanceEnabled(bool autowhitebalanceenabled);
public bool AutoWhiteBalanceEnabled { get; set; }
Public ReadWrite Property AutoWhiteBalanceEnabled As bool
var bool = regionOfInterest.autoWhiteBalanceEnabled;
regionOfInterest.autoWhiteBalanceEnabled = bool;
Value
bool bool bool

true if auto white balance; otherwise, false.

Bounds Bounds Bounds Bounds Bounds

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

public : Rect Bounds { get; set; }
Rect Bounds(); void Bounds(Rect bounds);
public Rect Bounds { get; set; }
Public ReadWrite Property Bounds As Rect
var rect = regionOfInterest.bounds;
regionOfInterest.bounds = rect;
Value
Rect Rect Rect

The rectangle that defines the region of focus.

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 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 : Platform::Boolean BoundsNormalized { get; set; }
bool BoundsNormalized(); void BoundsNormalized(bool boundsnormalized);
public bool BoundsNormalized { get; set; }
Public ReadWrite Property BoundsNormalized As bool
var bool = regionOfInterest.boundsNormalized;
regionOfInterest.boundsNormalized = bool;
Value
bool bool bool

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

Remarks

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

Type Type Type Type Type

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

public : RegionOfInterestType Type { get; set; }
RegionOfInterestType Type(); void Type(RegionOfInterestType type);
public RegionOfInterestType Type { get; set; }
Public ReadWrite Property Type As RegionOfInterestType
var regionOfInterestType = regionOfInterest.type;
regionOfInterest.type = regionOfInterestType;
Value
RegionOfInterestType RegionOfInterestType RegionOfInterestType

The type of region represented by the RegionOfInterest object.

Weight Weight Weight Weight Weight

Gets or sets the weight of the region of interest.

public : unsigned int Weight { get; set; }
uint32_t Weight(); void Weight(uint32_t weight);
public uint Weight { get; set; }
Public ReadWrite Property Weight As uint
var uint = regionOfInterest.weight;
regionOfInterest.weight = uint;
Value
uint uint uint

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