README

A growing collection of useful helpers and fully functional, ready-made abstractions for @react-three/fiber.

If you make a component that is generic enough to be useful to others, think about CONTRIBUTING!

bash
npm install @react-three/drei


 [!IMPORTANT]
 this package is using the stand-alone three-stdlib instead of three/examples/jsm.

 Basic usage

jsx
import { PerspectiveCamera, PositionalAudio, ... } from '@react-three/drei'


 React-native

jsx
import { PerspectiveCamera, PositionalAudio, ... } from '@react-three/drei/native'


The native route of the library does not export Html or Loader. The default export of the library is web which does export Html and Loader.

 Documentation

https://pmndrs.github.io/drei


  Old doc

 [!WARNING]
 Below is an archive of the anchors links with their new respective locations to the documentation website.
 Do not update the links below, they are for reference only.


  
    
      
        Cameras
        
          PerspectiveCamera
          OrthographicCamera
          CubeCamera
        
        Controls
        
          CameraControls
          FlyControls
          MapControls
          DeviceOrientationControls
          TrackballControls
          ArcballControls
          PointerLockControls
          FirstPersonControls
          ScrollControls
          PresentationControls
          KeyboardControls
          FaceControls
          MotionPathControls
        
        Gizmos
        
          GizmoHelper
          PivotControls
          DragControls
          TransformControls
          Grid
          Helper / useHelper
          Helper
        
        Abstractions
        
          Image
          Text
          Text3D
          PositionalAudio
          Billboard
          ScreenSpace
          ScreenSizer
          Effects
          GradientTexture
          Edges
          Outlines
          Trail
          Sampler
          ComputedAttribute
          Clone
          useAnimations
          MarchingCubes
          Decal
          Svg
          Gltf
          AsciiRenderer
          Splat
        
        Shaders
        
          MeshReflectorMaterial
          MeshWobbleMaterial
          MeshDistortMaterial
          MeshRefractionMaterial
          MeshTransmissionMaterial
          MeshDiscardMaterial
          PointMaterial
          SoftShadows
          shaderMaterial
        
      
    
    
      
        Misc
        
          Example
          Html
          CycleRaycast
          Select
          Sprite Animator
          Stats
          StatsGl
          Wireframe
          useDepthBuffer
          useContextBridge
          Fbo / useFBO
          useCamera
          CubeCamera / useCubeCamera
          DetectGPU / useDetectGPU
          useAspect
          useCursor
          useIntersect
          useBoxProjectedEnv
          Trail / useTrail
          useSurfaceSampler
          FaceLandmarker
        
        Loaders
        
          Loader
          Progres