@newkrok/three-particles 2.10.4 → 2.11.0

package/llms-full.txt

@@ -1,6 +1,6 @@
 # @newkrok/three-particles — Full API Reference
 
-> Three.js-based high-performance particle system library (v2.5.0)
+> Three.js-based high-performance particle system library (v2.10.4)
 > License: MIT | Author: Istvan Krisztian Somoracz
 > Repository: https://github.com/NewKrok/three-particles
 
@@ -62,7 +62,7 @@ function animate() {
 
 | Property/Method | Type | Description |
 |-----------------|------|-------------|
-| `instance` | `THREE.Points \| Gyroscope` | The renderable object — add to scene |
+| `instance` | `THREE.Points \| THREE.Mesh \| Gyroscope` | The renderable object — add to scene (Mesh when using RendererType.INSTANCED) |
 | `pauseEmitter()` | `() => void` | Stop emitting new particles |
 | `resumeEmitter()` | `() => void` | Resume emitting particles |
 | `dispose()` | `() => void` | Destroy system, free resources |
@@ -337,7 +337,15 @@ type Renderer = {
   transparent: boolean;                 // Default: true
   depthTest: boolean;                   // Default: true
   depthWrite: boolean;                  // Default: false
+  rendererType?: RendererType;          // Default: RendererType.POINTS
 };
+
+enum RendererType {
+  POINTS = 'POINTS',       // Classic point sprites (THREE.Points). Default.
+  INSTANCED = 'INSTANCED', // Camera-facing quads via InstancedBufferGeometry.
+                            // Removes gl_PointSize hardware limit, supports large particles.
+                            // Recommended for 10 000+ particles or large on-screen sizes.
+}
 ```
 
 Common blending modes: `THREE.NormalBlending`, `THREE.AdditiveBlending`, `THREE.SubtractiveBlending`
@@ -417,6 +425,9 @@ const system = createParticleSystem({
 ### LifeTimeCurve
 `BEZIER` | `EASING`
 
+### RendererType
+`POINTS` (default — classic point sprites) | `INSTANCED` (GPU instanced quads, no gl_PointSize limit)
+
 ---
 
 ## Callbacks
@@ -425,7 +436,7 @@ const system = createParticleSystem({
 createParticleSystem({
   // Called every frame
   onUpdate: ({ particleSystem, delta, elapsed, lifetime, iterationCount }) => {
-    // particleSystem: THREE.Points instance
+    // particleSystem: THREE.Points or THREE.Mesh instance
     // delta: seconds since last frame
     // elapsed: total seconds
     // lifetime: system duration

package/llms.txt

@@ -69,6 +69,12 @@ function animate() {
 | emission | Emission | rateOverTime: 10 | Emission config |
 | shape | ShapeConfig | — | Emitter shape |
 | map | THREE.Texture | undefined | Particle texture |
+| renderer | Renderer | — | Renderer settings (blending, rendererType, etc.) |
+
+## Renderer Types
+
+- `RendererType.POINTS` (default) — Classic point sprites via `THREE.Points`
+- `RendererType.INSTANCED` — Camera-facing quads via `InstancedBufferGeometry`, removes `gl_PointSize` hardware limit
 
 ## Emitter Shapes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newkrok/three-particles",
-  "version": "2.10.4",
+  "version": "2.11.0",
   "type": "module",
   "description": "Three.js-based high-performance particle system library designed for creating visually stunning particle effects with ease. Perfect for game developers and 3D applications.",
   "main": "./dist/index.js",