This reference describes unreleased code on main; no release documents it yet.

rlmesh::View

classExperimental#include <rlmesh.hpp>[source]

Class in rlmesh.hpp.

struct View

backend

field[source]
ViewBackend backend = ViewBackend::Terminal

port

field[source]
uint16_t port = 8008

fps

field[source]
uint64_t fps = 30

source

field[source]
std::optional<std::string> source{}

format

field[source]
ViewFormat format = ViewFormat::Jpeg

quality

field[source]
uint8_t quality = 75

hold

field[source]
std::variant<bool, Duration> hold = false

step_hz

field[source]
std::optional<double> step_hz{}

parse

static method[source]
static View parse(std::string_view text)

with_backend

method[source]
View& with_backend(ViewBackend value) &

with_backend

method[source]
View with_backend(ViewBackend value) &&

with_port

method[source]
View& with_port(uint16_t value) &

with_port

method[source]
View with_port(uint16_t value) &&

with_fps

method[source]
View& with_fps(uint64_t value) &

with_fps

method[source]
View with_fps(uint64_t value) &&

with_source

method[source]
View& with_source(std::optional<std::string> value) &

with_source

method[source]
View with_source(std::optional<std::string> value) &&

with_format

method[source]
View& with_format(ViewFormat value) &

with_format

method[source]
View with_format(ViewFormat value) &&

with_quality

method[source]
View& with_quality(uint8_t value) &

with_quality

method[source]
View with_quality(uint8_t value) &&

with_hold

method[source]
View& with_hold(std::variant<bool, Duration> value) &

with_hold

method[source]
View with_hold(std::variant<bool, Duration> value) &&

with_step_hz

method[source]
View& with_step_hz(std::optional<double> value) &

with_step_hz

method[source]
View with_step_hz(std::optional<double> value) &&

raw

method[source]
RLMeshView raw() const

validate

method[source]
void validate() const