libmixed
Loading...
Searching...
No Matches
Data Fields
mixed_segment_field_info Struct Reference

#include <mixed.h>

Data Fields

uint32_t field
 
char * description
 
enum mixed_segment_info_flags flags
 
enum mixed_segment_field_type type
 
uint32_t type_count
 

Detailed Description

Metadata struct for a segment's field.

This struct can be used to figure out what kind of fields are recognised on the segment and what you can do with it.

Field Documentation

◆ description

char* mixed_segment_field_info::description

A human-readable description of the data accessed.

◆ field

uint32_t mixed_segment_field_info::field

The actual field index. Fields should be in order in the fields array of the info struct, but don't have to be.

◆ flags

enum mixed_segment_info_flags mixed_segment_field_info::flags

An OR-combination of flags that describe the field's properties, usually about whether it is valid for inputs, outputs, or the segment itself, and whether it can be set or get.

◆ type

enum mixed_segment_field_type mixed_segment_field_info::type

The base element type of the value contained in the field. Note that while the get and set functions always take a pointer, the dereferenced value is interpreted as being of the type indicated by this field.

◆ type_count

uint32_t mixed_segment_field_info::type_count

In case the field stores an array of values, this defines the number of values that can be dererefenced.


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