Zivid C++ API 2.13.1+18e79e79-1
Zivid::Presets::PresetBase< SettingsType > Class Template Reference

Presets are pre-defined settings that are tuned for different camera models to perform optimally under different conditions and use cases. More...

#include <Zivid/Presets.h>

Public Member Functions

 PresetBase (std::string name, SettingsType settings) noexcept
 Constructor.
 
const std::string & name () const noexcept
 Get the name of the preset.
 
const SettingsType & settings () const noexcept
 Get the settings of the preset.
 
std::string toString () const
 Get string representation of the preset.
 

Detailed Description

template<typename SettingsType>
class Zivid::Presets::PresetBase< SettingsType >

Presets are pre-defined settings that are tuned for different camera models to perform optimally under different conditions and use cases.

The settings might change between different releases of the SDK. New presets might be added and old ones might be removed. If having the exact same settings is desired, it is recommended to save them to a YML file and load as needed.

Constructor & Destructor Documentation

◆ PresetBase()

template<typename SettingsType >
Zivid::Presets::PresetBase< SettingsType >::PresetBase ( std::string name,
SettingsType settings )
noexcept

Constructor.

Member Function Documentation

◆ name()

template<typename SettingsType >
const std::string & Zivid::Presets::PresetBase< SettingsType >::name ( ) const
noexcept

Get the name of the preset.

◆ settings()

template<typename SettingsType >
const SettingsType & Zivid::Presets::PresetBase< SettingsType >::settings ( ) const
noexcept

Get the settings of the preset.

The settings might change between different releases of the SDK. New presets might be added and old ones might be removed. If having the exact same settings is desired, it is recommended to save them to a YML file and load as needed.

◆ toString()

template<typename SettingsType >
std::string Zivid::Presets::PresetBase< SettingsType >::toString ( ) const

Get string representation of the preset.


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