#include <mixed.h>
Data Fields | |
| const char * | name |
| const char * | description |
| enum mixed_segment_info_flags | flags |
| uint32_t | min_inputs |
| uint32_t | max_inputs |
| uint32_t | outputs |
| struct mixed_segment_field_info | fields [32] |
Detailed Description
Metadata struct for a segment.
This struct contains useful information that describes the behaviour and capabilities of the segment. You may want to look at this if you want to provide a generic interface to segments.
Field Documentation
◆ description
| const char* mixed_segment_info::description |
A human-readable description of the segment's purpose. Must be UTF-8 encoded.
◆ fields
| struct mixed_segment_field_info mixed_segment_info::fields[32] |
A null-terminated array of possible fields that this segment supports. Note that while the struct definition here sets the number of fields to 32, an allocated segment info structure could potentially be larger and carry many more than 32. The only proper way to test for the last field is by testing for a null.
◆ flags
| enum mixed_segment_info_flags mixed_segment_info::flags |
An OR combination of segment info flags.
◆ max_inputs
| uint32_t mixed_segment_info::max_inputs |
The maximal number of outputs that this segment can support.
◆ min_inputs
| uint32_t mixed_segment_info::min_inputs |
The minimal number of inputs that this segment requires.
◆ name
| const char* mixed_segment_info::name |
The name of the segment type as a string. Must be alphanumeric ASCII.
◆ outputs
| uint32_t mixed_segment_info::outputs |
The number of outputs that this segment provides.
The documentation for this struct was generated from the following file:
