Skip to content

Commit 2ac7836

Browse files
jonobr1jonobr1
committed
Updated docs
1 parent b3f71f9 commit 2ac7836

10 files changed

Lines changed: 631 additions & 180 deletions

File tree

‎wiki/docs/effects/image-sequence/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,63 @@ Return a JSON compatible plain object that represents the path.
647647

648648

649649

650+
</div>
651+
652+
653+
654+
<div class="instance function ">
655+
656+
## dispose
657+
658+
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.ImageSequence.</span><span class="shortname">dispose</span></a></h2>
659+
660+
661+
662+
663+
<div class="returns">
664+
665+
__Returns__: Two.ImageSequence
666+
667+
668+
669+
</div>
670+
671+
672+
673+
674+
675+
676+
677+
678+
679+
680+
681+
682+
<div class="description">
683+
684+
Release the image sequence's renderer resources and detach all events.
685+
This method stops any running animation, clears animation callbacks, unbinds
686+
textures collection events, and disposes individual textures (calling dispose()
687+
for thorough cleanup) while preserving the renderer type for potential
688+
re-attachment to a new renderer.
689+
690+
</div>
691+
692+
693+
694+
695+
696+
<div class="meta">
697+
698+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L328">
699+
image-sequence.js:328
700+
</a>
701+
702+
</div>
703+
704+
705+
706+
650707
</div>
651708

652709

‎wiki/docs/effects/sprite/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -696,6 +696,63 @@ Return a JSON compatible plain object that represents the path.
696696

697697

698698

699+
</div>
700+
701+
702+
703+
<div class="instance function ">
704+
705+
## dispose
706+
707+
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.Sprite.</span><span class="shortname">dispose</span></a></h2>
708+
709+
710+
711+
712+
<div class="returns">
713+
714+
__Returns__: Two.Sprite
715+
716+
717+
718+
</div>
719+
720+
721+
722+
723+
724+
725+
726+
727+
728+
729+
730+
731+
<div class="description">
732+
733+
Release the sprite's renderer resources and detach all events.
734+
This method stops any running animation, clears animation callbacks, disposes
735+
the texture (calling dispose() for thorough cleanup), and inherits comprehensive
736+
cleanup from the Rectangle/Path hierarchy while preserving the renderer type
737+
for potential re-attachment.
738+
739+
</div>
740+
741+
742+
743+
744+
745+
<div class="meta">
746+
747+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L365">
748+
sprite.js:365
749+
</a>
750+
751+
</div>
752+
753+
754+
755+
699756
</div>
700757

701758

‎wiki/docs/effects/texture/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -637,8 +637,8 @@ Cached method to let renderers know `offset` has been updated on a [Two.Texture]
637637

638638
<div class="meta">
639639

640-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/texture.js#L668">
641-
texture.js:668
640+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/texture.js#L670">
641+
texture.js:670
642642
</a>
643643

644644
</div>
@@ -682,8 +682,8 @@ Cached method to let renderers know `scale` has been updated on a [Two.Texture](
682682

683683
<div class="meta">
684684

685-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/texture.js#L677">
686-
texture.js:677
685+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/texture.js#L679">
686+
texture.js:679
687687
</a>
688688

689689
</div>
@@ -1118,7 +1118,7 @@ Return a JSON compatible plain object that represents the texture.
11181118

11191119
## dispose
11201120

1121-
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.Gradient.</span><span class="shortname">dispose</span></a></h2>
1121+
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.Texture.</span><span class="shortname">dispose</span></a></h2>
11221122

11231123

11241124

‎wiki/docs/element/README.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,52 @@ Called internally by Two.js's renderer to reset all flags. Ensures that only pro
364364

365365

366366

367+
</div>
368+
369+
370+
371+
<div class="instance function ">
372+
373+
## dispose
374+
375+
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.Element.</span><span class="shortname">dispose</span></a></h2>
376+
377+
378+
379+
380+
381+
382+
383+
384+
385+
386+
387+
388+
389+
390+
391+
<div class="description">
392+
393+
Release the element's renderer object and detach any events.
394+
This cleans up renderer-specific resources and unbinds all event listeners.
395+
396+
</div>
397+
398+
399+
400+
401+
402+
<div class="meta">
403+
404+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/element.js#L109">
405+
element.js:109
406+
</a>
407+
408+
</div>
409+
410+
411+
412+
367413
</div>
368414

369415

‎wiki/docs/group/README.md‎

Lines changed: 78 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1295,6 +1295,62 @@ Return a JSON compatible plain object that represents the group.
12951295

12961296

12971297

1298+
</div>
1299+
1300+
1301+
1302+
<div class="instance function ">
1303+
1304+
## dispose
1305+
1306+
<h2 class="longname" aria-hidden="true"><a href="#dispose"><span class="prefix">Two.Group.</span><span class="shortname">dispose</span></a></h2>
1307+
1308+
1309+
1310+
1311+
<div class="returns">
1312+
1313+
__Returns__: Two.Group
1314+
1315+
1316+
1317+
</div>
1318+
1319+
1320+
1321+
1322+
1323+
1324+
1325+
1326+
1327+
1328+
1329+
1330+
<div class="description">
1331+
1332+
Release the group's renderer resources and detach all events.
1333+
This method recursively disposes all child objects, unbinds the children
1334+
collection events, and preserves the renderer type for potential re-attachment
1335+
to a new renderer.
1336+
1337+
</div>
1338+
1339+
1340+
1341+
1342+
1343+
<div class="meta">
1344+
1345+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L425">
1346+
group.js:425
1347+
</a>
1348+
1349+
</div>
1350+
1351+
1352+
1353+
12981354
</div>
12991355

13001356

@@ -1331,8 +1387,8 @@ Orient the children of the group to the upper left-hand corner of that group.
13311387

13321388
<div class="meta">
13331389

1334-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L425">
1335-
group.js:425
1390+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L460">
1391+
group.js:460
13361392
</a>
13371393

13381394
</div>
@@ -1376,8 +1432,8 @@ Orient the children of the group to the center of that group.
13761432

13771433
<div class="meta">
13781434

1379-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L447">
1380-
group.js:447
1435+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L482">
1436+
group.js:482
13811437
</a>
13821438

13831439
</div>
@@ -1431,8 +1487,8 @@ Recursively search for id. Returns the first element found.
14311487

14321488
<div class="meta">
14331489

1434-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L473">
1435-
group.js:473
1490+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L508">
1491+
group.js:508
14361492
</a>
14371493

14381494
</div>
@@ -1486,8 +1542,8 @@ Recursively search for classes. Returns an array of matching elements.
14861542

14871543
<div class="meta">
14881544

1489-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L500">
1490-
group.js:500
1545+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L535">
1546+
group.js:535
14911547
</a>
14921548

14931549
</div>
@@ -1541,8 +1597,8 @@ Recursively search for children of a specific type, e.g. [Two.Path](/docs/path/)
15411597

15421598
<div class="meta">
15431599

1544-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L523">
1545-
group.js:523
1600+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L558">
1601+
group.js:558
15461602
</a>
15471603

15481604
</div>
@@ -1593,8 +1649,8 @@ Add objects to the group.
15931649

15941650
<div class="meta">
15951651

1596-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L546">
1597-
group.js:546
1652+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L581">
1653+
group.js:581
15981654
</a>
15991655

16001656
</div>
@@ -1645,8 +1701,8 @@ Remove objects from the group.
16451701

16461702
<div class="meta">
16471703

1648-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L578">
1649-
group.js:578
1704+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L613">
1705+
group.js:613
16501706
</a>
16511707

16521708
</div>
@@ -1707,8 +1763,8 @@ Return an object with top, left, right, bottom, width, and height parameters of
17071763

17081764
<div class="meta">
17091765

1710-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L619">
1711-
group.js:619
1766+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L654">
1767+
group.js:654
17121768
</a>
17131769

17141770
</div>
@@ -1752,8 +1808,8 @@ Apply `noFill` method to all child shapes.
17521808

17531809
<div class="meta">
17541810

1755-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L700">
1756-
group.js:700
1811+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L735">
1812+
group.js:735
17571813
</a>
17581814

17591815
</div>
@@ -1797,8 +1853,8 @@ Apply `noStroke` method to all child shapes.
17971853

17981854
<div class="meta">
17991855

1800-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L712">
1801-
group.js:712
1856+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L747">
1857+
group.js:747
18021858
</a>
18031859

18041860
</div>
@@ -1842,8 +1898,8 @@ Apply `subdivide` method to all child shapes.
18421898

18431899
<div class="meta">
18441900

1845-
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L724">
1846-
group.js:724
1901+
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/group.js#L759">
1902+
group.js:759
18471903
</a>
18481904

18491905
</div>

0 commit comments

Comments
 (0)