effect-motion 0.5.0 → 0.6.0

package/README.md

@@ -9,7 +9,7 @@ A scene is an Effect generator program: instantiate entities, then tween or spri
 `effect` is a peer dependency — install it alongside:
 
 ```bash
-pnpm add effect-motion effect
+bun add effect-motion effect
 ```
 
 ## Write a scene

package/dist/Entity.d.ts

@@ -45,12 +45,12 @@ export declare const vec3: (input: {
     readonly x?: number;
     readonly y?: number;
     readonly z?: number;
-}, options?: Schema.MakeOptions) => Schema.Struct.ReadonlySide<{
-    readonly _tag: Schema.tag<"Vec3">;
-    readonly x: Schema.withConstructorDefault<Schema.Number>;
-    readonly y: Schema.withConstructorDefault<Schema.Number>;
-    readonly z: Schema.withConstructorDefault<Schema.Number>;
-}, "Type">;
+}, options?: Schema.MakeOptions) => {
+    readonly _tag: "Vec3";
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+};
 export declare const PathCommand: Schema.TaggedUnion<{
     readonly L: Schema.TaggedStruct<"L", {
         x: Schema.Number;
@@ -362,9 +362,19 @@ export declare const Image: Schema.TaggedStruct<"Image", {
  * that world point and any explicit `rotation` composes on top of the aim.
  * The `Camera` module's helpers are the ergonomic way to drive it.
  *
- * `aperture` and `focusDistance` describe depth of field. They are carried
- * on the frame but currently have NO visual effect — depth-of-field
- * rendering is not implemented, and every frame renders sharp.
+ * `aperture` and `focusDistance` drive depth of field. `focusDistance` is
+ * the view-space distance to the sharp plane (the runner defaults it to the
+ * resting distance, so `z = 0` is in focus). `aperture` is the lens radius in
+ * world units; 0 (the default) is a pinhole and bypasses DoF entirely. A
+ * point at view distance d blurs to a disc of radius
+ * `aperture · |d − focusDistance| / d` world units on the focus plane — at
+ * rest, where one world unit is one pixel on that plane, that is its blur
+ * radius in pixels. Rack focus is a plain tween of `focusDistance`.
+ *
+ * Limits: blur is computed from the depth buffer, so it is correct for
+ * opaque shapes only — a semi-transparent shape blurs at its own depth, not
+ * what shows through it. Perspective cameras only. DoF roughly doubles the
+ * scene's draw cost (the scene renders twice per frame).
  */
 export declare const Camera: Schema.TaggedStruct<"Camera", {
     readonly position: Schema.withConstructorDefault<Schema.TaggedStruct<"Vec3", {

package/dist/Entity.js

@@ -230,9 +230,19 @@ export const Image = Schema.TaggedStruct("Image", {
  * that world point and any explicit `rotation` composes on top of the aim.
  * The `Camera` module's helpers are the ergonomic way to drive it.
  *
- * `aperture` and `focusDistance` describe depth of field. They are carried
- * on the frame but currently have NO visual effect — depth-of-field
- * rendering is not implemented, and every frame renders sharp.
+ * `aperture` and `focusDistance` drive depth of field. `focusDistance` is
+ * the view-space distance to the sharp plane (the runner defaults it to the
+ * resting distance, so `z = 0` is in focus). `aperture` is the lens radius in
+ * world units; 0 (the default) is a pinhole and bypasses DoF entirely. A
+ * point at view distance d blurs to a disc of radius
+ * `aperture · |d − focusDistance| / d` world units on the focus plane — at
+ * rest, where one world unit is one pixel on that plane, that is its blur
+ * radius in pixels. Rack focus is a plain tween of `focusDistance`.
+ *
+ * Limits: blur is computed from the depth buffer, so it is correct for
+ * opaque shapes only — a semi-transparent shape blurs at its own depth, not
+ * what shows through it. Perspective cameras only. DoF roughly doubles the
+ * scene's draw cost (the scene renders twice per frame).
  */
 export const Camera = Schema.TaggedStruct("Camera", {
     ...transformMixin,

package/dist/Projection.d.ts

@@ -35,19 +35,18 @@ export interface CameraView {
     readonly rotZ: number;
     readonly focalLength: number;
     /**
-     * View-space distance to the intended sharp plane. Runner-filled to the
-     * resting camera distance.
-     *
-     * @remarks
-     * Currently inert: depth-of-field rendering is not implemented, so every
-     * frame renders sharp regardless of this value.
+     * View-space distance to the sharp plane, world units. Runner-filled to
+     * the resting camera distance.
      */
     readonly focusDistance: number;
     /**
-     * Intended depth-of-field blur strength; 0 is a pinhole.
+     * Lens radius in world units; 0 is a pinhole and bypasses depth of field.
      *
      * @remarks
-     * Currently inert — see {@link CameraView.focusDistance}.
+     * Thin-lens circle of confusion: a point at view distance d blurs to
+     * radius `aperture · |d − focusDistance| / d` world units on the focus
+     * plane. Opaque shapes only (semi-transparent ones blur at their own
+     * depth); perspective only; roughly doubles the scene's draw cost.
      */
     readonly aperture: number;
 }