Detailed Description

Settings related to a region of interest.

Classes
struct	ROI
	Parameters describing a region of interest. More...

Public Member Functions
virtual bool	set (ROI &roi)=0
	Sets a new region of interest to the stream.

virtual ROI	value () const =0
	Gets the current region of interest.

virtual ROI	increment () const =0
	Gets the allowed increments for the region of interest properties.

virtual ROI	minimum () const =0
	Gets the minimum value for the region of interest properties.

virtual ROI	maximum () const =0
	Gets the maximum value for the region of interest properties.

Static Public Attributes
static constexpr auto	property_name = "RegionOfInterest"

Static Public Attributes inherited from VideoStreamSettingsBase
static constexpr auto	property_name = "VideoStreamSettingsBase"

Member Function Documentation

virtual bool set ( ROI & roi )

pure virtual

Sets a new region of interest to the stream.

The implementation should respect the given roi as good as possible but is free to make minor changes regarding increments and clamping to ranges.

Parameters

[in,out] roi The region of interest to set; returns the actually set region of interest

The documentation for this class was generated from the following file: