MYNT-EYE-S-SDK/include/mynteye/utils.h

63 lines
1.5 KiB
C
Raw Normal View History

2018-05-10 09:46:34 +03:00
// Copyright 2018 Slightech Co., Ltd. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2018-04-20 07:44:23 +03:00
#ifndef MYNTEYE_UTILS_H_ // NOLINT
#define MYNTEYE_UTILS_H_
#pragma once
#include <memory>
#include "mynteye/mynteye.h"
MYNTEYE_BEGIN_NAMESPACE
2018-05-16 05:31:31 +03:00
/**
* @defgroup utils Utiliities
*/
2018-04-20 07:44:23 +03:00
class Device;
namespace device {
2018-05-15 17:01:15 +03:00
/**
2018-05-16 05:31:31 +03:00
* @ingroup utils
*
2018-05-15 17:01:15 +03:00
* Detecting MYNT EYE devices and prompt user to select one.
2018-05-16 05:31:31 +03:00
*
2018-05-15 17:01:15 +03:00
* @return the selected device, or `nullptr` if none.
*/
2018-04-23 18:11:11 +03:00
MYNTEYE_API std::shared_ptr<Device> select();
2018-04-20 07:44:23 +03:00
} // namespace device
2018-05-13 05:34:03 +03:00
namespace utils {
2018-05-15 17:01:15 +03:00
/**
2018-05-16 05:31:31 +03:00
* @ingroup utils
*
2018-05-15 17:01:15 +03:00
* Get real exposure time in ms from virtual value, according to its frame rate.
2018-05-16 05:31:31 +03:00
*
2018-05-15 17:01:15 +03:00
* @param frame_rate the frame rate of the device.
* @param exposure_time the virtual exposure time.
* @return the real exposure time in ms, or the virtual value if frame rate is
* invalid.
2018-05-13 05:34:03 +03:00
*/
MYNTEYE_API float get_real_exposure_time(
std::int32_t frame_rate, std::uint16_t exposure_time);
} // namespace utils
2018-04-20 07:44:23 +03:00
MYNTEYE_END_NAMESPACE
#endif // MYNTEYE_UTILS_H_ NOLINT