libtinylor
Single-file header library for controlling Light-O-Rama hardware
Loading...
Searching...
No Matches
lor_req Struct Reference

Represents a request to apply an effect to a set of channels on a specific unit. The effect may require additional arguments, which are stored in the args field. Fields may be set directly, or better yet, by using the provided helper functions which handle potential data validation/conversion that you may not want to do. More...

#include <tinylor.h>

Collaboration diagram for lor_req:

Data Fields

lor_effect effect
 The effect type to apply.
 
lor_effect_args_u args
 The effect data, if required by the effect type, otherwise zero.
 
lor_channel_set cset
 The channel set to apply the effect to, may be a single channel.
 
lor_unit unit
 The unit to apply the effect to.
 

Detailed Description

Represents a request to apply an effect to a set of channels on a specific unit. The effect may require additional arguments, which are stored in the args field. Fields may be set directly, or better yet, by using the provided helper functions which handle potential data validation/conversion that you may not want to do.

Field Documentation

◆ args

lor_effect_args_u lor_req::args

The effect data, if required by the effect type, otherwise zero.

◆ cset

lor_channel_set lor_req::cset

The channel set to apply the effect to, may be a single channel.

◆ effect

lor_effect lor_req::effect

The effect type to apply.

◆ unit

lor_unit lor_req::unit

The unit to apply the effect to.


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