update block-properties docs

This commit is contained in:
MihailRis 2024-10-02 22:29:14 +03:00
parent 5ff00df527
commit 597a16e79e
2 changed files with 22 additions and 0 deletions

View File

@ -156,6 +156,16 @@ Block fields are declared in the following format:
}
```
In addition to `type` and `length`, the `convert-strategy` parameter determines the value conversion strategy when narrowing the data type.
The parameter takes one of two values:
- `reset` - a value that does not exists in the new range will be reset to 0
- `clamp` - the value will be reduced to the closest one in the new range
Example: the number 231 when changing the field type from int16 to int8:
- in `reset` mode will turn into 0
- in `clamp` mode will turn into 127
Available data types:
| Type | Size | Description |

View File

@ -159,6 +159,18 @@
}
```
Кроме `type` и `length` доступен параметр `convert-strategy` определяющий
стратегию конвертации значения при сужении типа данных.
Параметр принимает одно из двух значений:
- `reset` - значение, не попадающее в новый диапазон, будет сброшено до 0
- `clamp` - значение будет сведено к ближайшему в новом диапазоне
Пример: число 231 при изменении типа поля с int16 до int8:
- в режиме `reset` превратится в 0
- в режиме `clamp` превратится в 127
Доступные типы данных:
| Тип | Размер | Описание |