kinogaki-render-api

What it is

Depends on

Third-party

Used by

Modules

• aovOutputs (AOVs) a final frame can carry, known by id.311 lines
• aov::cryptomatteCryptomatte 1.2 (Psyop's specification) for every engine: how a name becomes an ID, and the manifest an Image carries as metadata so a reader names what each ID is.119 lines
• aov::standardThe standard outputs: their ids, and each one's Aov.69 lines
• declaredPrim types an engine declares: lights and atmospheres a host places in its scene, each a parameter schema of Parameters.136 lines
• descriptionWhat an engine is, without a device: EngineDescription.341 lines
• dirtyWhat changed about a prim: a small flag set, a subset of Hydra's HdChangeTracker bits.114 lines
• displayThe display contract between a wgpu host and its render engines.258 lines
• engineThe engine trait and what passes through it: views, frames, one-shot results and the wake callback.290 lines
• idPrim ids: a slot and a generation, so an id that was removed never names the prim that later reuses its slot.148 lines
• materialMaterial networks: MaterialX's nodes (mtlx) and engines' own, wired.691 lines
• material::adopt (private)A network as one engine renders it (adopt), each node it doesn't implement rewritten, exact steps first:435 lines
• material::adopt::work (private)Work: a network being rewritten: nodes by a stable index (a removed one gone), links by name, the shown node.374 lines
• material::def (private)NodeDef: a material node type as data.183 lines
• material::display (private)MaterialDisplay: what the shaded viewport shows of a material, a simple approximation its engine makes of its own material (MaterialRules::display): a color, a primvar and an image, read through its texture's transform ...73 lines
• material::mtlxMaterialX's nodes as NodeDefs: one a signature of the MaterialX library, all made on first use and shared (def).527 lines
• material::previewThe material preview: a shape in the SDK, an image from the engine.291 lines
• material::standardThe standard form: a material as an OpenPBR Surface shown through a Surface Material, what engines, the shaded viewport and file formats meet in.271 lines
• primThe prims a host sends: shapes (meshes and curves), instancers, cameras, materials and textures (the structural prims every scene is made of; a texture is the SDK's one decoded picture, an Image), and prims of the types an engine declares (lights, fog ...139 lines
• prim::camera (private)Camera: a camera after UsdGeomCamera.69 lines
• prim::instancer (private)Instancer: placements of other prims: real instancing.307 lines
• prim::shape (private)Shape: triangles or curves in their own space, with their primvars (Attributes: Hydra's primvars over the SDK's one typed attribute table), their material assignment (Subsets) and their placement.419 lines
• rangesChanged element ranges of a stream (a drag's points), coalesced: spans closer than a small gap join, and past Ranges::MOST spans the change counts as the whole stream.92 lines
• recordingAn engine that renders nothing: it applies updates to a CPU-side store and counts what it was sent, for hosts' tests (a drag must send ranges only, an object move no triangles).216 lines
• settingsSettings: what every view shares (SceneSettings) and the values an engine describes itself (Parameters in Sections, kept by name).99 lines
• sourceWhat a host renders an object from: a shape and the primvars a render reads from it (ShapeSource), whatever made it (a polygon value's display triangulation, its curves, a CAD tessellation, a toolpath preview).147 lines
• standardThe standard prim types: UsdLux's lights and exponential height fog, as schemas (area_light, dome_light, distant_light, spot_light, fog) every engine that renders them declares as they are here, and as typed values (Light, Fog) an engine ...538 lines
• standard::emission (private)Emission: where an emitter's spectrum comes from (Emission), and the color it shows as in an RGB engine (Emission::color): linear ACEScg (RENDER_SPACE) at luminance 1.251 lines
• threadAn engine's render thread, as every engine runs one: EngineThread is the RenderEngine a host holds, a handle that never blocks.473 lines
• updateScene updates: what the host pushes, in batches, and how batches an engine has not applied yet coalesce into one.165 lines

Public types and traits

At the crate root

Traits MaterialRulesRenderEngineShapeSource

Structs AovAovDescAovSpecCameraCapabilitiesCountsDeclaredDeliverDirtyDisplayTextureEngineBuilderEngineDescriptionEnginesFrameIdIdAllocatorInstancerInstancerBuilderLinkMaterialMaterialDisplayMaterialMapsMaterialNetworkMotionNetworkBuilderNodeNodeDefNodeOutputPendingPlainTrianglesPreviewImagePreviewRequestPreviewScenePrimChangePrimIdPrimTypeRangesRecordingEngineRenderStatsSceneSettingsSceneUpdateShapeShapeBuilderSubsetsViewDescViewIdVisibility

Enums AovClassAovFormatNodeInputPreviewLightingPreviewShapePrimPrimKindProjectionRoleTopologyViewCameraViewMode

Type aliases MapNodeIndexWake

Re-exported from other crates

From kinogaki_geometry Detailimage::f32_to_halfimage::half_to_f32

From kinogaki_geometry as geometry (the crate)

From kinogaki_mtlx as materialx (the crate)

From kinogaki_value EngineIdParameterPrimTypeIdSection

From kinogaki_value as value (the crate)

Besides these, 24 public functions at module level.