ImageRect Class Reference

Image rectangle operations on a device. More...

#include <cvb/driver/image_rect.hpp>

Public Member Functions
DevicePtr	Parent () const noexcept
	Gets the parent device of this interface.
Size2D< int >	SensorSize () const
	Gets the sensor size.
Size2D< int >	Size () const
	Gets the current rectangle size.
void	ApplySize (Size2D< int > size, DeviceUpdateMode mode)
	Sets the size.
Point2D< int >	Offset () const
	Gets the offset of the image rectangle.
void	SetOffset (Point2D< int > point)
	Sets the offset of the image rectangle.
void	Update (DeviceUpdateMode mode)
	Updates the CVB buffer according to the current device settings.

Detailed Description

Image rectangle operations on a device.

Member Function Documentation

ApplySize()

void ApplySize ( Size2D< int > size, DeviceUpdateMode mode )

inline

Sets the size.

Parameters

[in]	size	The new size.
[in]	mode	How to handle the device image.

Exceptions

Any	exception derived from std::exception including CvbException.

Offset()

Point2D< int > Offset ( ) const

inline

Gets the offset of the image rectangle.

Returns

The current offset.

Exceptions

Any	exception derived from std::exception including CvbException.

Parent()

DevicePtr Parent ( ) const

inlinenoexcept

Gets the parent device of this interface.

Returns

The parent device pointer, or a null pointer if disconnected.

Exceptions

Does	not throw any exception.

SensorSize()

Size2D< int > SensorSize ( ) const

inline

Gets the sensor size.

Returns

The sensor size in pixels.

Exceptions

Any	exception derived from std::exception including CvbException.

SetOffset()

void SetOffset ( Point2D< int > point )

inline

Sets the offset of the image rectangle.

Parameters

[in]

point

The new offset.

Exceptions

Any	exception derived from std::exception including CvbException.

Size()

Size2D< int > Size ( ) const

inline

Gets the current rectangle size.

Returns

The current size.

Exceptions

Any	exception derived from std::exception including CvbException.

Update()

void Update ( DeviceUpdateMode mode )

inline

Updates the CVB buffer according to the current device settings.

Parameters

[in]

mode

How to handle the device image.

Exceptions

Any	exception derived from std::exception including CvbException.