← Back to Package Catalog

vivid-3d

experimental Gpu

3D rendering operators for Vivid

Version 0.1.0 Vivid Core >=0.1.0 <2.0.0 Author seethroughlab
vivid-3d preview ./build/vivid install https://github.com/seethroughlab/vivid-3d.git

Overview

vivid-3d

vivid-3d is a package library for building lit 3D scenes inside Vivid. It focuses on geometry sources, scene composition, materials, lighting, instancing, and 3D post-processing.

Preview

vivid-3d preview

Package docs model

  • this README.md is the package overview used by the central Vivid docs site
  • operator reference pages are generated from source doc block comments in operators/
  • graphs under graphs/ are the active demo surface for smoke coverage and package examples

Highlights

  • procedural primitives: Grid, Box, Sphere, Shape3D, MeshBuilder, Sweep, SDF3D
  • scene utilities: Transform3D, SceneMerge, Instancer3D, MeshDraw, MeshImport
  • look development: Material3D, Light3D, Environment3D, Boolean3D
  • rendering and post: Render3D, SSAO3D, DepthOfField3D, DepthMask3D
  • motion systems: Particles3D, Deformer

Install

./build/vivid install https://github.com/seethroughlab/vivid-3d.git

Local development

From vivid-core:

./build/vivid link ../vivid-3d
./build/vivid rebuild vivid-3d

Example graphs

  • graphs/3d_hello_world_demo.json — first lit scene
  • graphs/3d_shapes_demo.json — procedural primitive overview
  • graphs/3d_materials_demo.json — material and lighting comparison
  • graphs/3d_particles_demo.json — particle workflow
  • graphs/3d_particles_compute_beginner_demo.json — simplified compute path for learning
  • graphs/3d_shadow_focus_demo.json — focused shadow-map setup
  • graphs/3d_fog_fake_post_demo.json — stylized post-process fog
  • graphs/3d_fog_true_demo.json — depth-aware fog in Render3D

Validation

Before pushing changes:

  1. Configure and build the package operators.
  2. Run package tests if present.
  3. Validate the link/rebuild cycle from vivid-core.
  4. Run test_demo_graphs against this package's graphs/ directory.
  5. Treat GPU-heavy graph smoke as load and registry coverage first; skipped no-GPU runs are acceptable in headless CI.

License

MIT (see LICENSE).

Operators

Source-derived documentation for OrbitCamera.

control/orbit_camera · Minimal page

Grid

GPU

Generates a reusable 3D grid mesh.

gpu/grid · Source docs

Generates a sphere mesh with configurable tessellation.

gpu/sphere · Source docs

Box

GPU

Generates a box mesh with independent dimensions.

gpu/box · Source docs

Renders incoming 3D points as a shaded point cloud.

gpu/point_cloud · Source docs

Renders many copies of a mesh using per-instance transforms.

gpu/mesh_draw · Source docs

Renders a composed 3D scene into a texture with camera, lighting, and post controls.

gpu/render_3d · Source docs

Generates a procedural 3D primitive with material and transform controls.

gpu/shape3d · Source docs

Applies translation, rotation, and scale to incoming 3D geometry.

gpu/transform3d · Source docs

Merges multiple 3D scene inputs into a single scene stream.

gpu/scene_merge · Source docs

Defines a configurable 3D light source for the scene pipeline.

gpu/light3d · Source docs

Loads an external mesh file into the 3D scene pipeline.

gpu/mesh_import · Source docs

Deforms incoming 3D geometry with procedural or audio-driven motion.

gpu/deformer · Source docs

Attach an InstanceArray3D bundle to a scene fragment for instanced draws.

gpu/instancer3d · Source docs

Generate N per-instance transforms in a geometric layout.

gpu/instance_grid · Source docs

Add time-varying noise to per-instance position, rotation, and scale.

gpu/instance_noise · Source docs

Migration bridge from per-attribute lane arrays to an InstanceArray3D bundle.

gpu/instances_from_lanes · Source docs

Simulates and renders a configurable 3D particle system.

gpu/particles3d · Source docs

Raymarches signed-distance 3D shapes into a rendered scene texture.

gpu/sdf3d · Source docs

Applies surface shading parameters to incoming 3D geometry.

gpu/material3d · Source docs

Adds screen-space ambient occlusion to a rendered 3D scene.

gpu/ssao3d · Source docs

Applies depth-of-field blur to a rendered 3D scene.

gpu/dof3d · Source docs

Adds environment lighting and rotation controls to a 3D scene.

gpu/environment3d · Source docs

Combines two 3D meshes with boolean-style scene operations.

gpu/boolean3d · Source docs

Builds a mask from scene depth for compositing and selective post-processing.

gpu/depth_mask3d · Source docs

Builds common procedural meshes with integrated material settings.

gpu/mesh_builder · Source docs

Sweeps a profile shape along a path to generate procedural 3D geometry.

gpu/sweep · Source docs