op::params::Numeric Struct Reference

An integer parameter with a min, max, step, and optional decimals. More...

#include <params.h>

Public Attributes
std::string_view	name
	Display name shown in the settings UI.
int32_t	min
	Minimum value.
int32_t	max
	Maximum value.
int32_t	default_ = 0
	Initial value.
int32_t	step = 1
	Increment between adjacent values.
uint8_t	decimal_places = 0
	Fixed-point display digits.
uint8_t	is_per_instance = 0
	Set to 1 to give each mode instance its own copy of this value (output modes only; ignored for global modes).
ParentRef	parent = {}
	Optional Section this parameter nests under.
VisibleWhen	visible_when = {}
	Optional gate that hides this parameter based on a sibling's value (see gate).

Detailed Description

An integer parameter with a min, max, step, and optional decimals.

The most common kind, an integer value in [min, max]. Use .decimal_places for fixed-point display (the stored value stays an integer, for example store 12000 with 2 decimals to show 120.00).

Member Data Documentation

decimal_places

uint8_t op::params::Numeric::decimal_places = 0

Fixed-point display digits.

The stored value stays an integer, so storing 12000 with 2 places shows "120.00".

---

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

• include/operator_sdk/params.h