libiio
Public Attributes | List of all members
iio_data_format Struct Reference

Contains the format of a data sample. More...

#include <iio.h>

Public Attributes

unsigned int length
 Total length of the sample, in bits.
 
unsigned int bits
 Length of valuable data in the sample, in bits.
 
unsigned int shift
 Right-shift to apply when converting sample.
 
bool is_signed
 Contains True if the sample is signed.
 
bool is_fully_defined
 Contains True if the sample is fully defined, sign extended, etc. More...
 
bool is_be
 Contains True if the sample is in big-endian format.
 
bool with_scale
 Contains True if the sample should be scaled when converted.
 
double scale
 Contains the scale to apply if with_scale is set.
 
unsigned int repeat
 Number of times length repeats (added in v0.8)
 

Detailed Description

Contains the format of a data sample.

The different fields inform about the correct way to convert one sample from its raw format (as read from / generated by the hardware) to its real-world value.

Member Data Documentation

◆ is_fully_defined

bool iio_data_format::is_fully_defined

Contains True if the sample is fully defined, sign extended, etc.


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