SDK · crate

kinogaki-value

SDK

Kinogaki Studio's value model: the one way the SDK says what a value is and holds.

Repository: SDK (kinogaki/studio-sdk)
Folder: sdk/crates/value
Source: 12 files, 2,808 lines
Tests: 0 files, 0 lines

depends onused by tests alonedependencies for tests alone are listed below, not drawn

What it is

Kinogaki Studio's value model: the one way the SDK says what a value is and holds.

Module	What
`id`	declared ids (`<vendor>.<package>.<name>`), one type per kind of thing
`data`	`Data`: a type-erased value of a registered data type, and a kernel's `Typed` handle (`Checked` for values checked as they are wrapped)
`value`	`Value`: what a parameter, a render setting, a declared prim's value or a material port holds; `Parameters`, values by name
`reads`	`ParametersExt`: a value of `Parameters` read by name as its variant, or an error naming it
`kind`	`ValueKind`: what a value holds, its limits and the options its kind takes (`Number`, `Unit`, `Choice`)
`look`	`NumberLook`: how a row of numbers shows and moves, carried beside a kind by what has a row
`parameter`	`Parameter`: one value a person sets, described (a node's parameter, a format's option, an engine's setting, a declared prim's value, a material input), and the `Section`s parameters sit in
`condition`	`Condition`: when something applies, as values holding values
`ramp`, `tone_curve`	the structured values: `Ramp` and `ToneCurve`
`reference`	`RefFilter`: what a reference may name; `ObjectRef`: an object, by the host's id

Integers are exact (i64), numbers f64 wherever they are held; a choice is held and saved by its key; a unit's suffix is owned text; an image is authored as its path and reaches an engine as its texture. How a value is presented (segments or a menu, a remembered tool setting, a read-only row) is the UI layer's; a number's look travels beside its kind, never in it.

Depends on

Crate	Repository	As	What it is
`kinogaki-geometry`	SDK	normal	Kinogaki Studio's standard geometry values.

Third-party

None.

Used by

Crate	Repository	As	What it is
`kinogaki-render-api`	SDK	normal	Kinogaki's render interface: what a host (Studio) sends a render engine and what comes back, with no GPU or OS API.
`kinogaki-studio-api`	SDK	normal	Kinogaki Studio's headless plugin API.

Modules

conditionCondition: when something applies, as values holding values: a port that is required, a handle that shows, a row that is enabled or shown.67 lines
dataValues on wires and in object results: Data, a type-erased shared value tagged with its data type, and Typed, a kernel's typed handle for wrapping and reading its own values (Checked for a type whose values are checked as they are wrapped).318 lines
idDeclared ids: what packages name everything they contribute by.340 lines
kindValueKind: what a value holds, its limits and what a host offers for it (a choice's entries, an attribute row's names).546 lines
lookNumberLook: how a row of numbers shows and moves.71 lines
parameterParameter: one value a person sets, described as data, and the Sections parameters sit in.320 lines
rampRamps: a value along 0–1 through keys, a number (a float ramp: a profile, a falloff) or a color (a color ramp: a gradient), as Houdini's ramp parameters have them.522 lines
readsParametersExt: a value of Parameters read by name as its variant, or an error naming it.123 lines
referenceRefFilter: what a reference parameter may name.71 lines
tone_curveTone curves: what a ValueKind::ToneCurves value holds (Value::ToneCurves), one ToneCurve a channel.159 lines
valueValue: what a parameter, a render setting, a declared prim's value or a material port holds.234 lines

Public types and traits

At the crate root

Traits ParametersExt

Structs CheckedChoiceConditionCurveChannelDataNumberNumberLookObjectRefPackageIdParameterRampRefFilterSectionToneCurveTyped

Enums FitsNumberStyleUnitValueValueKind

Type aliases Parameters

By module: 25 public types and traits in 11 modules

condition Condition

data CheckedDataTyped

id PackageId

kind ChoiceCurveChannelNumberUnitValueKind

look NumberLookNumberStyle

parameter ParameterSection

ramp InterpolationKeyRamp

reads ParametersExt

reference FitsObjectRefRefFilter

tone_curve InterpolationToneCurve

value ParametersValue

Besides these, 1 public function at module level.