kinogaki-studio-api

What it is

Depends on

Third-party

None.

Used by

Modules

• animKeys: a parameter's value at a moment of the scene, and how it runs to the next key.47 lines
• cancelCooperative cancellation: CancelToken, which the host raises and long work polls.52 lines
• codecHow data and object bodies save into a project.109 lines
• colorColor management, the host's: one ColorService lent to formats (Reading, Writing), cooks (CookCx::colors), the UI and compiled contexts' runners.144 lines
• componentsComponent selections: which points, edges, faces or vertices of one value are selected, in the data type's own terms.115 lines
• cookThe node cook contract: what a node type computes, and what the environment gives it to compute with.447 lines
• cook::binding (private)Scalar and Vector: the numbers a Handle reads and writes, each bound to a parameter or fixed.225 lines
• cook::context (private)CookCx: everything one cook may read besides its inputs.435 lines
• cook::description (private)Description: what a node type is to the user and to a network: its label and icon, its ports, its parameters and the viewport handles bound to them.421 lines
• cook::handle (private)Handle: a viewport handle a node type binds to its parameters.633 lines
• cook::placement (private)Placement: a placement bound to a node type's Position, Up and Turn, which a Handle's places can be expressed in.226 lines
• cook::sheet (private)SchemaCx: what a node's rows may depend on besides its parameters, and RowsFor where they show; NewCx: what a new node's parameters may; PortsCx: what its ports may.189 lines
• data_typeDataType: everything the environment needs to handle values it can't look inside: identity, a wire color (WireColor), a content stamp, memory, bounds, info rows and how the value saves, plus optional facets for display, picking, the spreadsheet and ...174 lines
• elementSaving into a project: the element tree codecs write and read.370 lines
• element::memory (private)MemoryElement: the element traits over a plain in-memory tree, for package tests (a codec's round trip without Studio).484 lines
• element::values (private)A value as a field, and back: the one encoding of every value kind, in projects, a kind's codec and the user's settings alike.310 lines
• entryA plugin library's entry point: the one function Studio looks up in it.51 lines
• facetsThe optional facets of a DataType: what the environment's surfaces ask of a value beyond identity and storage.41 lines
• facets::canvas (private)Canvas: what the 2D canvas pane paints of a value, a list of pieces in canvas units, back to front: images and text under a placement.259 lines
• facets::display (private)Displayable: how a value is drawn in the viewport.313 lines
• facets::glyph (private)Glyphs: an object kind drawn as lines where its objects are (a light's shape, a camera's frustum), which the viewport places, picks by distance, boxes, frames, ghosts around a context and tints as a template, as it does its own Cameras'.24 lines
• facets::held (private)Held: what the host made of values other values hold.41 lines
• facets::object (private)ObjectPicking and Look: what the viewport asks of an object's result at the object levels beyond its pieces.130 lines
• facets::pick (private)Pickable: turning the viewport's picks into component selections.75 lines
• facets::render (private)Renderable: how a value reaches render engines.157 lines
• facets::snap (private)Snappable: what a gizmo move may land on in a value: its points, edges' middles, faces' centers, crossings, edges and surfaces nearest the pointer.154 lines
• facets::table (private)Tabular: what the spreadsheet shows of a value.187 lines
• formatFileFormat: readers and writers of outside files.480 lines
• format::budget (private)ReadBudget: what one read of a file may spend, and its cancellation.274 lines
• format::conversion (private)Conversion: a file's space in the project's.289 lines
• format::filesThe files a format reads and writes: those a file being read names, found and read by one rule (Named); the image files a written document names (Beside), what a format writing materials (an MTL library, a MaterialX document) writes for the Image ...371 lines
• format::files::named (private)Named: the files a file being read names, found and read by one rule.482 lines
• format::input (private)Input: the file a format reads, on disk or held in memory.224 lines
• format::materialxMaterialX documents' materials as Studio's, and back: what a format reading or writing .mtlx documents, or files holding them, converts at its boundary.91 lines
• format::materialx::read (private)A document's materials as Studio's (the module docs say how).272 lines
• format::materialx::write (private)Materials as a MaterialX document (the module docs say how).229 lines
• format::optionsWhat file formats share about their options: reading one typed value out of a format's FormatOptions (a choice by its key, so a saved setting survives a reordered list), the rows most import dialogs show (a scale, toggles, embed), and the rows a node ...131 lines
• format::unique (private)Unique: names a read or a write gives out once each.130 lines
• heldHeld edits: a node holding an authored delta over its input (Edit Mesh, Edit CAD).88 lines
• iconIcon: the named icons a package adds to Studio's icon set.180 lines
• image_filesImage files as the host reads them: a package asks by source (ImageSource: a file on disk or one embedded in the project, and how its colors read) and never waits.228 lines
• image_files::image_nodeThe rows of core's Image node (IMAGE_NODE), by name, its output, and a node reading a source (reading).49 lines
• kernelKernels: a heavy, shared algorithm library one plugin offers every other, which a consumer reaches through core while it is loaded, knowing only the kernel's documentation.277 lines
• mesherMesher: a kernel's display mesh of a B-rep body.103 lines
• networkNetworks: every object whose kind names a context (ObjectKindSpec::context) holds a network of that context, and Studio's core owns it.42 lines
• network::compile (private)Compiled contexts: a context whose Evaluation is Compile (Comp, shading) isn't cooked node by node.209 lines
• network::context (private)NetworkContext: a context's networks, declared as data.228 lines
• network::edit (private)NetworkEdit: the edits a package makes to a network.656 lines
• network::read (private)NetworkRead: a network as packages read it.101 lines
• network::runA compiled context's runner (the wgpu feature): its package's plans (NetworkCompiler::compile's values) run on the host's device by a Runner its package makes (PlanRunner).72 lines
• objectScene objects a package contributes: ObjectKindSpec describes a kind (Mesh, Camera, Render Output), ObjectBody is one object's own state (a Mesh object's display settings).301 lines
• packagePackage: what one package registers with the environment, and PackageUi, the UI it carries when it has one.441 lines
• paramsParameters: what a node's or a format's settings hold, the value model's Values by name (Parameters) of ValueKinds; how the host presents them (Schema).16 lines
• params::codeWhat a code field knows of its language: a CodeLanguage colors the text by Tokens, offers Completions at the cursor, explains what the pointer rests on and says what is wrong with the text.97 lines
• params::schema (private)Schema: how parameters are presented, as data.165 lines
• refsReferences to what the host's document holds: scene objects and nodes, by the host's ids for them.9 lines
• registryRegistry: what every loaded package registered, by id.265 lines
• registry::check (private)Admission: whether a package may register (Registry::check).539 lines
• renderNeutral render items: how any data type reaches every render engine (RenderItem), made of ShapeSources and instances of other items.106 lines
• render::lightsLights, the SDK's side of them in one place.18 lines
• render::lights::kind (private)DeclaredKind: an engine's own object kind whose objects are prims of the types it declares: its lights (placed, one kind whatever the light is) or its atmosphere (fog, at the root).309 lines
• render::lights::value (private)Lights as a data type: a light shaped as UsdLux shapes one (render-api's standard Light, unplaced: still at the identity).373 lines
• render::lights::view (private)How a DeclaredKind's lights show in the viewport: their line glyphs (an area light's shape with an arrow down its −Z, a dome's globe, a distant light's parallel rays, a spot's cone, another type a ring) and their handles (an area ...230 lines
• render::shader (private)Shading nodes: one node type over each material node an engine declares, which is all a Material's network is made of.117 lines
• scriptScripts: code a node runs over a standard value, on the host's engine.119 lines
• sessionSession slots, package-owned state of an editing session, and the gestures its undo steps are made of.314 lines
• standardThe standard data types: the geometry values every package shares (geometry), as data types.213 lines
• standard::attributes (private)Saving an Attributes table: one child element per attribute (a0, a1…, kind attribute) and per group (g0…, kind group), in the table's order.206 lines
• standard::brep (private)BrepCodec: how Brep values save.552 lines
• standard::brep::carriers (private)A body's carrier tables (surfaces, curves, p-curves) as one pre-order stream of records: each record a tag (carrier_tags), the reals it holds (carrier_reals) and its counts (carrier_counts), each stream read in order.459 lines
• standard::brep::names (private)A value's persistent names as one table: every distinct name once, a name after the names it is made of, and entities and datums naming them by their index in it.156 lines
• standard::camera (private)Cameras as a data type: a lens shaped as UsdGeomCamera shapes one (render-api's Camera, unplaced).231 lines
• standard::color (private)The project's color configuration as a stored project value.59 lines
• standard::embedded (private)EmbeddedFileCodec: how an EmbeddedFile saves.56 lines
• standard::geometry (private)GeometryCodec: how Geometry values save.147 lines
• standard::image (private)ImageCodec: how Image values save.227 lines
• standard::instances (private)Instances: placements of prototypes of any type, the standard value kinogaki.core.instances, and InstancesCodec, how it saves.551 lines
• standard::materials (private)Materials: the materials a file brings and the images its lights name (ImportedMaterial, ImportedImage), and MaterialsCodec, how they save.415 lines
• standard::output (private)How a project's pictures reach a display, as a stored project value.95 lines
• standard::quality (private)The project's display quality as a stored project value.49 lines
• standard::selection (private)Saving a standard Selection: the fields domain, its members as elements and words (as a group saves them), active when one is, on (the 32-byte fingerprint of the value it was made on, or no bytes) and ids (the members' stable ids) when it ...75 lines
• standard::tolerances (private)The project's tolerances as a stored project value.43 lines
• storedStored values: package-owned values the host saves in the project or the user's settings, headless.244 lines
• viewportWhat the viewport draws and picks: a value's display Surface, component levels (ElementKind), sets of packet elements (ElementSet), pick Hits, and pack_linear, the one packing of the linear colors a Look gives.771 lines

Public types and traits

At the crate root

Traits CanvasDataCodecDataTypeDisplayableElementReaderElementWriterFileFormatFormatWriterHeldHeldEditLookMaterialDisplaysMesherNetworkEditNetworkReadNodeTypeObjectBodyObjectCodecObjectKindSpecObjectPickingPassesPickableRenderableRenderedKindSlotSlotDocSnappableStoredTabular

Structs AdoptionCancelTokenComponentsCookCxCookCxBuilderCreateCxDescriptionDisplayRequestDrawnFileItemGestureMarkGestureTokenHitIconImportedInfoRowInputIterationKeyKindCreationListingMeshedNetworkContextNewCxNodeRefOutputsPackagePackageUiPassPicturePiecePortPortsPortsCxProbeProjectReadCxReadingReadsRegistryRenderCxRenderedSchemaSchemaCxSessionSlotSessionSlotsSnapHitSnapQuerySnapTargetsStoredValueStoredValuesSurfaceTableTableColumnTallyValuedWireColorWriting

Enums CanvasPieceCategoryCellKindCellsCombineDrawPurposeFieldFieldRefInsideInterpNodeRolePieceRolePurposeRenderItemResolvedRowsForScopeSnapKind

Type aliases FormatOptionsStamp

Re-exported from other crates

From kinogaki_edit as edit (the crate)

From kinogaki_geometry BoundsDiagnosticErrorErrorKindRateSeverityTextSpanTimeUnitsUpAxisVec3Xform

From kinogaki_geometry as geometry (the crate)

From kinogaki_value datadata::Checkeddata::Datadata::Typedidid::ContextIdid::CreationIdid::DataTypeIdid::FormatIdid::MesherIdid::NodeTypeIdid::ObjectKindIdid::PackageIdid::SlotIdid::StoredIdid::VerbId

From kinogaki_value as value (the crate)

Besides these, 32 public functions at module level.