threejs

Build high-performance 3D web applications using Three.js. Contains 556 searchable examples across 13 categories, 60 API classes, and 20 use-case templates.

When to Use

• Building 3D scenes, games, or visualizations
• Loading 3D models (GLTF, FBX, OBJ)
• Implementing animations, physics, or VR/XR
• Creating particle effects or custom shaders
• Optimizing rendering performance

Search Examples & API

Use the search CLI to find relevant examples and API references:

python3 .gemini/skills/threejs/scripts/search.py "<query>" [--domain <domain>] [-n <max_results>]

Search Domains

| Domain | Use For | Example Query | |--------|---------|---------------| | examples | Find code examples | "particle effects gpu" | | api | Class/method reference | "PerspectiveCamera" | | use-cases | Project recommendations | "product configurator" | | categories | Browse categories | "webgpu" |

Quick Examples

# Find particle/compute examples
python3 .gemini/skills/threejs/scripts/search.py "particle compute webgpu"

# Search API for camera classes
python3 .gemini/skills/threejs/scripts/search.py "camera" --domain api

# Get examples for a use case
python3 .gemini/skills/threejs/scripts/search.py "product configurator" --use-case

# Filter by category
python3 .gemini/skills/threejs/scripts/search.py --category webgpu -n 10

# Filter by complexity
python3 .gemini/skills/threejs/scripts/search.py --complexity high -n 5

Example Categories

| Category | Count | Description | |----------|-------|-------------| | webgl | 216 | Standard WebGL rendering | | webgpu (wip) | 190 | Modern WebGPU + compute shaders | | webgl / advanced | 48 | Low-level GPU, custom shaders | | webgl / postprocessing | 27 | Bloom, SSAO, SSR, DOF | | webxr | 26 | VR/AR experiences | | physics | 13 | Physics simulation |

Common Use Cases

| Use Case | Recommended | Complexity | |----------|-------------|------------| | Product Configurator | GLTF, PBR, EnvMaps | Medium | | Game Development | Animation, Physics, Controls | High | | Data Visualization | BufferGeometry, Points | Medium | | 360 Panorama | Equirectangular, WebXR | Low | | Architectural Viz | GLTF, HDR, CSM Shadows | High |

Quick Start

// 1. Scene, Camera, Renderer
const scene = new THREE.Scene();
const camera = new THREE.PerspectiveCamera(75, window.innerWidth/window.innerHeight, 0.1, 1000);
const renderer = new THREE.WebGLRenderer({ antialias: true });
renderer.setSize(window.innerWidth, window.innerHeight);
renderer.setPixelRatio(window.devicePixelRatio);
document.body.appendChild(renderer.domElement);

// 2. Lighting
scene.add(new THREE.AmbientLight(0x404040));
const dirLight = new THREE.DirectionalLight(0xffffff, 1);
dirLight.position.set(5, 5, 5);
scene.add(dirLight);

// 3. Load GLTF Model
import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js';
const loader = new GLTFLoader();
loader.load('model.glb', (gltf) => scene.add(gltf.scene));

// 4. Animation Loop
function animate() {
  requestAnimationFrame(animate);
  renderer.render(scene, camera);
}
animate();

Progressive Reference Files

Level 1: Fundamentals

• references/00-fundamentals.md - Core concepts, scene graph
• references/01-getting-started.md - Setup, basic rendering

Level 2: Common Tasks

• references/02-loaders.md - GLTF, FBX, OBJ loaders
• references/03-textures.md - Texture types, mapping
• references/04-cameras.md - Camera types, controls
• references/05-lights.md - Light types, shadows
• references/06-animations.md - AnimationMixer, clips
• references/11-materials.md - PBR, standard materials
• references/18-geometry.md - BufferGeometry, primitives

Level 3: Interactive

• references/08-interaction.md - Raycasting, picking
• references/09-postprocessing.md - Bloom, SSAO, SSR
• references/10-controls.md - OrbitControls, etc.

Level 4: Advanced

• references/12-performance.md - Instancing, LOD, batching
• references/13-node-materials.md - TSL shader graphs
• references/17-shader.md - Custom GLSL shaders

Level 5: Specialized

• references/14-physics-vr.md - Physics, WebXR
• references/16-webgpu.md - WebGPU, compute shaders

External Resources

• Docs: https://threejs.org/docs/
• Examples: https://threejs.org/examples/
• Editor: https://threejs.org/editor/
• Discord: https://discord.gg/56GBJwAnUS