@d3p1/img2pxl 1.15.0 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,16 +16,16 @@ export default class Canvas {
16
16
  * @param {Pane} debugManager
17
17
  * @param {number} resolutionWidth
18
18
  * @param {number} resolutionHeight
19
- * @param {string} displacementImageSrc
20
- * @param {number} displacementSize
21
- * @param {number} displacementTrailingFactor
19
+ * @param {string} pointerImageSrc
20
+ * @param {number} pointerImageSize
21
+ * @param {number} pointerTrailingFactor
22
22
  */
23
- constructor(debugManager: Pane, resolutionWidth: number, resolutionHeight: number, displacementImageSrc: string, displacementSize?: number, displacementTrailingFactor?: number);
23
+ constructor(debugManager: Pane, resolutionWidth: number, resolutionHeight: number, pointerImageSrc: string, pointerImageSize?: number, pointerTrailingFactor?: number);
24
24
  /**
25
25
  * Update
26
26
  *
27
- * @param {number|null} dx
28
- * @param {number|null} dy
27
+ * @param {number | null} dx
28
+ * @param {number | null} dy
29
29
  * @returns {void}
30
30
  */
31
31
  update(dx: number | null, dy: number | null): void;
@@ -8,7 +8,7 @@ import * as THREE from 'three';
8
8
  export default class Pointer {
9
9
  #private;
10
10
  /**
11
- * @type {THREE.Vector2|{x: number|undefined, y: number|undefined}}
11
+ * @type {THREE.Vector2 | {x: number | undefined, y: number | undefined}}
12
12
  */
13
13
  coord: THREE.Vector2 | {
14
14
  x: number | undefined;
package/dist/img2pxl.d.ts CHANGED
@@ -1,25 +1,89 @@
1
+ import { Pane } from 'tweakpane';
2
+ import { default as RendererManager } from './core/lib/renderer-manager.js';
1
3
  export default class Img2Pxl {
2
4
  #private;
5
+ /**
6
+ * @type {RendererManager}
7
+ */
8
+ rendererManager: RendererManager;
9
+ /**
10
+ * @type {Pane}
11
+ */
12
+ debugManager: Pane;
3
13
  /**
4
14
  * Constructor
5
15
  *
6
- * @param {string} imageSrc
7
- * @param {number} width
8
- * @param {number} height
9
- * @param {number} resolutionWidth
10
- * @param {number} resolutionHeight
11
- * @param {number} pointSize
12
- * @param {string|null} element
13
- * @param {string} noiseImageSrc
14
- * @param {number} noiseFrequency
15
- * @param {number} noiseAmplitude
16
- * @param {string} displacementImageSrc
17
- * @param {number} displacementSize
18
- * @param {number} displacementTrailingFactor
19
- * @param {number} displacementFrequency
20
- * @param {number} displacementAmplitude
16
+ * @param {{
17
+ * containerSelector?: string;
18
+ * image: {
19
+ * src: string;
20
+ * width: number;
21
+ * height: number;
22
+ * resolution: {
23
+ * width: number;
24
+ * height: number;
25
+ * };
26
+ * pixel?: {
27
+ * size?: number;
28
+ * motion?: {
29
+ * displacement?: {
30
+ * frequency?: number;
31
+ * amplitude?: number;
32
+ * }
33
+ * }
34
+ * };
35
+ * motion?: {
36
+ * noise?: {
37
+ * src?: string;
38
+ * frequency?: number;
39
+ * amplitude?: number;
40
+ * }
41
+ * }
42
+ * };
43
+ * pointer?: {
44
+ * src?: string;
45
+ * size?: number;
46
+ * trailing?: {
47
+ * factor?: number;
48
+ * }
49
+ * }
50
+ * }} config
21
51
  */
22
- constructor(imageSrc: string, width: number, height: number, resolutionWidth: number, resolutionHeight: number, pointSize?: number, element?: string | null, noiseImageSrc?: string, noiseFrequency?: number, noiseAmplitude?: number, displacementImageSrc?: string, displacementSize?: number, displacementTrailingFactor?: number, displacementFrequency?: number, displacementAmplitude?: number);
52
+ constructor(config: {
53
+ containerSelector?: string;
54
+ image: {
55
+ src: string;
56
+ width: number;
57
+ height: number;
58
+ resolution: {
59
+ width: number;
60
+ height: number;
61
+ };
62
+ pixel?: {
63
+ size?: number;
64
+ motion?: {
65
+ displacement?: {
66
+ frequency?: number;
67
+ amplitude?: number;
68
+ };
69
+ };
70
+ };
71
+ motion?: {
72
+ noise?: {
73
+ src?: string;
74
+ frequency?: number;
75
+ amplitude?: number;
76
+ };
77
+ };
78
+ };
79
+ pointer?: {
80
+ src?: string;
81
+ size?: number;
82
+ trailing?: {
83
+ factor?: number;
84
+ };
85
+ };
86
+ });
23
87
  /**
24
88
  * Render
25
89
  *
@@ -28,12 +92,11 @@ export default class Img2Pxl {
28
92
  */
29
93
  render(t?: number): void;
30
94
  /**
31
- * Enable debug mode
95
+ * Debug
32
96
  *
33
- * @param {KeyboardEvent} e
34
97
  * @returns {void}
35
98
  */
36
- debug(e: KeyboardEvent): void;
99
+ debug(): void;
37
100
  /**
38
101
  * Dispose
39
102
  *