API Reference — `riglogic`

19 entries across 6 modules.

By Task

Load a rig and evaluate instances to drive rig output

API	Module	Summary
RigInstance	RigInstance	Holds the instance-specific input and output buffers for evaluating one instance of a rig, including level-of-detail and control values.
RigInstance	RigLogic	Forward-declared here as the counterpart type that `RigLogic` creates and evaluates instances of; see the `RigInstance` entry in `riglogic/riglogic/RigInstance` for its full interface.
RigLogic	RigInstance	Evaluates a `RigInstance` to produce joint, blend shape, and animated map output values. Pass a `RigInstance` to `RigLogic::calculate` to drive the rig for a given frame.
RigLogic	RigLogic	Loads and optimizes DNA rig data, then calculates rig output values for any number of `RigInstance` objects based on their input control values.

Set options for rig loading and evaluation behavior

API	Module	Summary
CalculationType	Configuration	Selects which CPU algorithm implementation RigLogic uses to evaluate a rig.
Configuration	Configuration	The set of options that determines how RigLogic loads DNA data and evaluates a rig.
Configuration	RigLogic	An alias, inside `RigLogic`, for `rl4::Configuration` — the options struct used to create and inspect a `RigLogic` instance.
FloatingPointType	Configuration	Selects the floating point precision used in RigLogic's vectorized calculations.
RotationType	Configuration	Selects the representation RigLogic uses for rotation output values.
ScaleType	Configuration	Selects the representation RigLogic uses for scale output values.
TranslationType	Configuration	Selects the representation RigLogic uses for translation output values.

Type aliases for array views and memory management

API	Module	Summary
ArrayView	Aliases	An alias for `dna::ArrayView<T>`, a lightweight mutable view over a contiguous array of `T`.
ConstArrayView	Aliases	An alias for `dna::ConstArrayView<T>`, a lightweight read-only view over a contiguous array of `T`.
DefaultInstanceCreator	RigInstance	A `pma` trait specialization that tells the memory management utilities how to construct a `RigInstance` by default.
DefaultInstanceCreator	RigLogic	A `pma` trait specialization that tells the memory management utilities how to construct a `RigLogic` by default.
DefaultInstanceDestroyer	RigInstance	A `pma` trait specialization that tells the memory management utilities how to destroy a `RigInstance` by default.
DefaultInstanceDestroyer	RigLogic	A `pma` trait specialization that tells the memory management utilities how to destroy a `RigLogic` by default.

Query rig statistics and library version

API	Module	Summary
Stats	Stats	A snapshot of counts and configuration describing the size and shape of a loaded rig.
VersionInfo	VersionInfo	Reports the RigLogic library version at runtime, as major/minor/patch numbers and a formatted string.