Lightgraph
C++17 light-graph engine API reference
Loading...
Searching...
No Matches
lightgraph::EmitCommand Struct Reference

One emit request. More...

#include <types.hpp>

Public Attributes

int8_t model = 0
 Topology model index.
 
float speed = 1.0f
 Light speed scalar.
 
std::optional< uint16_tlength
 Optional explicit list length.
 
uint16_t trail = 0
 Trail length.
 
std::optional< uint32_tcolor
 Optional packed RGB color (0xRRGGBB); omitted means random color.
 
uint16_t note_id = 0
 Optional note identifier for list reuse.
 
uint8_t min_brightness = 0
 Minimum brightness bound.
 
uint8_t max_brightness = 255
 Maximum brightness bound.
 
uint16_t behaviour_flags = 0
 Legacy behavior-flag bitmask.
 
uint8_t emit_groups = 0
 Optional emit-group mask override.
 
uint8_t emit_offset = 0
 Initial emit position offset.
 
uint32_t duration_ms = 0
 Optional list duration in milliseconds (0 means library default behavior).
 
int8_t from = -1
 Optional source index override (-1 means automatic).
 
bool linked = true
 Whether new lights should be linked.
 

Detailed Description

One emit request.

Definition at line 49 of file types.hpp.

Member Data Documentation

◆ behaviour_flags

uint16_t lightgraph::EmitCommand::behaviour_flags = 0

Legacy behavior-flag bitmask.

Definition at line 67 of file types.hpp.

◆ color

std::optional<uint32_t> lightgraph::EmitCommand::color

Optional packed RGB color (0xRRGGBB); omitted means random color.

Definition at line 59 of file types.hpp.

◆ duration_ms

uint32_t lightgraph::EmitCommand::duration_ms = 0

Optional list duration in milliseconds (0 means library default behavior).

Definition at line 73 of file types.hpp.

◆ emit_groups

uint8_t lightgraph::EmitCommand::emit_groups = 0

Optional emit-group mask override.

Definition at line 69 of file types.hpp.

◆ emit_offset

uint8_t lightgraph::EmitCommand::emit_offset = 0

Initial emit position offset.

Definition at line 71 of file types.hpp.

◆ from

int8_t lightgraph::EmitCommand::from = -1

Optional source index override (-1 means automatic).

Definition at line 75 of file types.hpp.

◆ length

std::optional<uint16_t> lightgraph::EmitCommand::length

Optional explicit list length.

Definition at line 55 of file types.hpp.

◆ linked

bool lightgraph::EmitCommand::linked = true

Whether new lights should be linked.

Definition at line 77 of file types.hpp.

◆ max_brightness

uint8_t lightgraph::EmitCommand::max_brightness = 255

Maximum brightness bound.

Definition at line 65 of file types.hpp.

◆ min_brightness

uint8_t lightgraph::EmitCommand::min_brightness = 0

Minimum brightness bound.

Definition at line 63 of file types.hpp.

◆ model

int8_t lightgraph::EmitCommand::model = 0

Topology model index.

Definition at line 51 of file types.hpp.

◆ note_id

uint16_t lightgraph::EmitCommand::note_id = 0

Optional note identifier for list reuse.

Definition at line 61 of file types.hpp.

◆ speed

float lightgraph::EmitCommand::speed = 1.0f

Light speed scalar.

Definition at line 53 of file types.hpp.

◆ trail

uint16_t lightgraph::EmitCommand::trail = 0

Trail length.

Definition at line 57 of file types.hpp.


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