/
Caman.html
1462 lines (1461 loc) · 38.9 KB
/
Caman.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>CamanJS Documentation</title>
<link rel='stylesheet' href='../assets/codo.css' type='text/css'>
<script src='../assets/codo.js'></script>
<script src='../assets/search_data.js'></script>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../README.md.html' title='CamanJS'>CamanJS</a>
»
<a href='../class_index.html' title='Index'>Index</a>
»
<span class='title'>Caman</span>
<nav>
<ul>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='../class_list.html'>Classes</a>
<a id='file_list_link' href='../file_list.html'>Files</a>
<a id='method_list_link' href='../method_list.html'>Methods</a>
<a id='extra_list_link' href='../extra_list.html'>Extras</a>
</div>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>Ctrl-T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
In frame mode you can toggle the list naviation frame on the left side:
</p>
<ul>
<li>
<span>Ctrl-L</span>
Toggle list view
</li>
</ul>
<p>
You can focus a list in frame mode or toggle a tab in frameless mode:
</p>
<ul>
<li>
<span>Ctrl-C</span>
Class list
</li>
<li>
<span>Ctrl-I</span>
Mixin list
</li>
<li>
<span>Ctrl-F</span>
File list
</li>
<li>
<span>Ctrl-M</span>
Method list
</li>
<li>
<span>Ctrl-E</span>
Extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>Ctrl-S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
<p>
In frameless mode you can close the list tab:
</p>
<ul>
<li>
<span>Esc</span>
Close list tab
</li>
</ul>
</div>
</div>
<div id='content'>
<h1>
Class:
Caman
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/core/caman.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../classes/Module.html'>Module</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Here it begins. Caman is defined.
There are many different initialization for Caman, which are described on the
<a href="http://camanjs.com/guides">Guides</a>.</p><p>Initialization is tricky because we need to make sure everything we need is actually fully
loaded in the DOM before proceeding. When initialized on an image, we need to make sure that the
image is done loading before converting it to a canvas element and writing the pixel data. If we
do this prematurely, the browser will throw a DOM Error, and chaos will ensue. In the event that
we initialize Caman on a canvas element while specifying an image URL, we need to create a new
image element, load the image, then continue with initialization.</p><p>The main goal for Caman was simplicity, so all of this is handled transparently to the end-user. </p>
</div>
<div class='tags'>
</div>
<h2>Property Summary</h2>
<dl class='properties'>
<dt id='DEBUG-property'>
<span class='signature'>
(Boolean) <strong>DEBUG</strong>
</span>
</dt>
<dd class='desc'>
<p>Debug mode enables console logging.</p>
</dd>
</dl>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#toString-class'>
+ (String) <strong>toString</strong>()
</a>
</span>
<span class='desc'>
Custom toString()
</span>
</li>
<li>
<span class='signature'>
<a href='#getAttrId-class'>
+ (String) <strong>getAttrId</strong>(canvas)
</a>
</span>
<span class='desc'>
Get the ID assigned to this canvas by Caman.
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#constructor-instance'>
- (Caman) <strong>constructor</strong>()
</a>
</span>
<span class='constructor note title'>Constructor</span>
<span class='desc'>
The Caman function.
</span>
</li>
<li>
<span class='signature'>
<a href='#domIsLoaded-instance'>
- (void) <strong>domIsLoaded</strong>(cb)
</a>
</span>
<span class='desc'>
Checks to ensure the DOM is loaded.
</span>
</li>
<li>
<span class='signature'>
<a href='#parseArguments-instance'>
- (void) <strong>parseArguments</strong>(args)
</a>
</span>
<span class='desc'>
Parses the arguments given to the Caman function, and sets the appropriate properties on this instance.
</span>
</li>
<li>
<span class='signature'>
<a href='#setInitObject-instance'>
- (void) <strong>setInitObject</strong>(obj)
</a>
</span>
<span class='desc'>
Sets the initialization object for this instance.
</span>
</li>
<li>
<span class='signature'>
<a href='#setup-instance'>
- (void) <strong>setup</strong>()
</a>
</span>
<span class='desc'>
Begins the setup process, which differs depending on whether we're in NodeJS, or if an image or canvas object was provided.
</span>
</li>
<li>
<span class='signature'>
<a href='#initNode-instance'>
- (void) <strong>initNode</strong>()
</a>
</span>
<span class='desc'>
Initialization function for NodeJS.
</span>
</li>
<li>
<span class='signature'>
<a href='#initImage-instance'>
- (void) <strong>initImage</strong>()
</a>
</span>
<span class='desc'>
Initialization function for the browser and image objects.
</span>
</li>
<li>
<span class='signature'>
<a href='#initCanvas-instance'>
- (void) <strong>initCanvas</strong>()
</a>
</span>
<span class='desc'>
Initialization function for the browser and canvas objects.
</span>
</li>
<li>
<span class='signature'>
<a href='#imageAdjustments-instance'>
- (void) <strong>imageAdjustments</strong>()
</a>
</span>
<span class='desc'>
Automatically check for a HiDPI capable screen and swap out the image if possible.
</span>
</li>
<li>
<span class='signature'>
<a href='#waitForImageLoaded-instance'>
- (void) <strong>waitForImageLoaded</strong>()
</a>
</span>
<span class='desc'>
Utility function that fires <a href='../classes/Caman.html#imageLoaded-instance'>Caman#imageLoaded</a> once the image is finished loading.
</span>
</li>
<li>
<span class='signature'>
<a href='#isImageLoaded-instance'>
- (Boolean) <strong>isImageLoaded</strong>()
</a>
</span>
<span class='desc'>
Checks if the given image is finished loading.
</span>
</li>
<li>
<span class='signature'>
<a href='#imageWidth-instance'>
- (Number) <strong>imageWidth</strong>()
</a>
</span>
<span class='desc'>
Internet Explorer has issues figuring out image dimensions when they aren't explicitly defined, apparently.
</span>
</li>
<li>
<span class='signature'>
<a href='#imageHeight-instance'>
- (Number) <strong>imageHeight</strong>()
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#imageLoaded-instance'>
- (void) <strong>imageLoaded</strong>()
</a>
</span>
<span class='desc'>
Function that is called once the initialization image is finished loading.
</span>
</li>
<li>
<span class='signature'>
<a href='#finishInit-instance'>
- (void) <strong>finishInit</strong>()
</a>
</span>
<span class='desc'>
Final step of initialization.
</span>
</li>
<li>
<span class='signature'>
<a href='#reloadCanvasData-instance'>
- (void) <strong>reloadCanvasData</strong>()
</a>
</span>
<span class='desc'>
If you have a separate context reference to this canvas outside of CamanJS and you make a change to the canvas outside of CamanJS, you will have to call this function to update our context reference to include those changes.
</span>
</li>
<li>
<span class='signature'>
<a href='#resetOriginalPixelData-instance'>
- (void) <strong>resetOriginalPixelData</strong>()
</a>
</span>
<span class='desc'>
Reset the canvas pixels to the original state at initialization.
</span>
</li>
<li>
<span class='signature'>
<a href='#hasId-instance'>
- (Boolean) <strong>hasId</strong>()
</a>
</span>
<span class='desc'>
Does this instance have an ID assigned?
</span>
</li>
<li>
<span class='signature'>
<a href='#assignId-instance'>
- (void) <strong>assignId</strong>()
</a>
</span>
<span class='desc'>
Assign a unique ID to this instance.
</span>
</li>
<li>
<span class='signature'>
<a href='#hiDPIDisabled-instance'>
- (Boolean) <strong>hiDPIDisabled</strong>()
</a>
</span>
<span class='desc'>
Is HiDPI support disabled via the HTML data attribute?
</span>
</li>
<li>
<span class='signature'>
<a href='#hiDPIAdjustments-instance'>
- (void) <strong>hiDPIAdjustments</strong>()
</a>
</span>
<span class='desc'>
Perform HiDPI adjustments to the canvas.
</span>
</li>
<li>
<span class='signature'>
<a href='#hiDPIRatio-instance'>
- (Number) <strong>hiDPIRatio</strong>()
</a>
</span>
<span class='desc'>
Calculate the HiDPI ratio of this display based on the backing store and the pixel ratio.
</span>
</li>
<li>
<span class='signature'>
<a href='#hiDPICapable-instance'>
- (Boolean) <strong>hiDPICapable</strong>()
</a>
</span>
<span class='desc'>
Is this display HiDPI capable?
</span>
</li>
<li>
<span class='signature'>
<a href='#needsHiDPISwap-instance'>
- (Boolean) <strong>needsHiDPISwap</strong>()
</a>
</span>
<span class='desc'>
Do we need to perform an image swap with a HiDPI image?
</span>
</li>
<li>
<span class='signature'>
<a href='#hiDPIReplacement-instance'>
- (String) <strong>hiDPIReplacement</strong>()
</a>
</span>
<span class='desc'>
Gets the HiDPI replacement for the initialization image.
</span>
</li>
<li>
<span class='signature'>
<a href='#replaceCanvas-instance'>
- (void) <strong>replaceCanvas</strong>(newCanvas)
</a>
</span>
<span class='desc'>
Replaces the current canvas with a new one, and properly updates all of the applicable references for this instance.
</span>
</li>
<li>
<span class='signature'>
<a href='#render-instance'>
- (void) <strong>render</strong>(callback = function() {})
</a>
</span>
<span class='desc'>
Begins the rendering process.
</span>
</li>
<li>
<span class='signature'>
<a href='#revert-instance'>
- (void) <strong>revert</strong>()
</a>
</span>
<span class='desc'>
Reverts the canvas back to it's original state while maintaining any cropped or resized dimensions.
</span>
</li>
<li>
<span class='signature'>
<a href='#reset-instance'>
- (void) <strong>reset</strong>()
</a>
</span>
<span class='desc'>
Completely resets the canvas back to it's original state.
</span>
</li>
<li>
<span class='signature'>
<a href='#originalVisiblePixels-instance'>
- (Array) <strong>originalVisiblePixels</strong>()
</a>
</span>
<span class='desc'>
Returns the original pixel data while maintaining any cropping or resizing that may have occured.
</span>
</li>
<li>
<span class='signature'>
<a href='#process-instance'>
- (Caman) <strong>process</strong>(name, processFn)
</a>
</span>
<span class='desc'>
Pushes the filter callback that modifies the RGBA object into the render queue.
</span>
</li>
<li>
<span class='signature'>
<a href='#processKernel-instance'>
- (Caman) <strong>processKernel</strong>(name, adjust, divisor = null, bias = 0)
</a>
</span>
<span class='desc'>
Pushes the kernel into the render queue.
</span>
</li>
<li>
<span class='signature'>
<a href='#processPlugin-instance'>
- (Caman) <strong>processPlugin</strong>(plugin, args)
</a>
</span>
<span class='desc'>
Adds a standalone plugin into the render queue.
</span>
</li>
<li>
<span class='signature'>
<a href='#newLayer-instance'>
- (Caman) <strong>newLayer</strong>(callback)
</a>
</span>
<span class='desc'>
Pushes a new layer operation into the render queue and calls the layer callback.
</span>
</li>
<li>
<span class='signature'>
<a href='#executeLayer-instance'>
- (void) <strong>executeLayer</strong>(layer)
</a>
</span>
<span class='desc'>
Pushes the layer context and moves to the next operation.
</span>
</li>
<li>
<span class='signature'>
<a href='#pushContext-instance'>
- (void) <strong>pushContext</strong>(layer)
</a>
</span>
<span class='desc'>
Set all of the relevant data to the new layer.
</span>
</li>
<li>
<span class='signature'>
<a href='#popContext-instance'>
- (void) <strong>popContext</strong>()
</a>
</span>
<span class='desc'>
Restore the previous layer context.
</span>
</li>
<li>
<span class='signature'>
<a href='#applyCurrentLayer-instance'>
- (void) <strong>applyCurrentLayer</strong>()
</a>
</span>
<span class='desc'>
Applies the current layer to its parent layer.
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
</h2>
<h3 class='inherited'>
Methods inherited from
<a href='../classes/Module.html'>Module</a>
</h3>
<p class='inherited'>
<a href='../classes/Module.html#extends-class'>.extends</a>,
<a href='../classes/Module.html#includes-class'>.includes</a>,
<a href='../classes/Module.html#delegate-class'>.delegate</a>,
<a href='../classes/Module.html#aliasFunction-class'>.aliasFunction</a>,
<a href='../classes/Module.html#aliasProperty-class'>.aliasProperty</a>,
<a href='../classes/Module.html#included-class'>.included</a>
</p>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='toString-class'>
+ (String) <strong>toString</strong>()
</p>
<div class='docstring'>
<p>Custom toString()</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt>String</tt>)
—
<span class='desc'>Version and release information.</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getAttrId-class'>
+ (String) <strong>getAttrId</strong>(canvas)
</p>
<div class='docstring'>
<p>Get the ID assigned to this canvas by Caman.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>canvas</span>
<span class='type'>
(<tt>DOMObject</tt>)
</span>
—
<span class='desc'>The canvas to inspect.</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt>String</tt>)
—
<span class='desc'>The Caman ID associated with this canvas.</span>
</li>
</ul>
</div>
</div>
</div>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-instance'>
- (Caman) <strong>Caman</strong>(initializer)
<br>
- (Caman) <strong>Caman</strong>(initializer, callback)
<br>
- (Caman) <strong>Caman</strong>(initializer, url)
<br>
- (Caman) <strong>Caman</strong>(initializer, url, callback)
<br>
- (Caman) <strong>Caman</strong>(file)
<br>
- (Caman) <strong>Caman</strong>(file, callback)
<br>
</p>
<div class='docstring'>
<p>The Caman function. While technically a constructor, it was made to be called without
the <code>new</code> keyword. Caman will figure it out.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>initializer</span>
<span class='type'>
(<tt>DOMObject, String</tt>)
</span>
—
<span class='desc'>The DOM selector or DOM object to initialize.</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt><a href='../classes/Caman.html'>Caman</a></tt>)
—
<span class='desc'>Initialized Caman instance.</span>
</li>
</ul>
<div class='overloads'>
<h3>Overloads:</h3>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(initializer)
</p>
<div class='docstring'>
<p>Initialize Caman without a callback.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(initializer, callback)
</p>
<div class='docstring'>
<p>Initialize Caman with a callback.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>callback</span>
<span class='type'>
(<tt>Function</tt>)
</span>
—
<span class='desc'>Function to call once initialization completes.</span>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(initializer, url)
</p>
<div class='docstring'>
<p>Initialize Caman with a URL to an image and no callback.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>url</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>URl to an image to draw to the canvas.</span>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(initializer, url, callback)
</p>
<div class='docstring'>
<p>Initialize Caman with a canvas, URL to an image, and a callback.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>url</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>URl to an image to draw to the canvas.</span>
</li>
<li>
<span class='name'>callback</span>
<span class='type'>
(<tt>Function</tt>)
</span>
—
<span class='desc'>Function to call once initialization completes.</span>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(file)
</p>
<div class='docstring'>
<p><strong>NodeJS</strong>: Initialize Caman with a path to an image file and no callback.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>file</span>
<span class='type'>
(<tt>String, File</tt>)
</span>
—
<span class='desc'>File object or path to image to read.</span>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
- (Caman) <strong>Caman</strong>(file, callback)
</p>
<div class='docstring'>
<p><strong>NodeJS</strong>: Initialize Caman with a file and a callback.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>file</span>
<span class='type'>
(<tt>String, File</tt>)
</span>
—
<span class='desc'>File object or path to image to read.</span>
</li>
<li>
<span class='name'>callback</span>
<span class='type'>
(<tt>Function</tt>)
</span>
—
<span class='desc'>Function to call once initialization completes.</span>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='domIsLoaded-instance'>
- (void) <strong>domIsLoaded</strong>(cb)
</p>
<div class='docstring'>
<p>Checks to ensure the DOM is loaded. Ensures the callback is always fired, even
if the DOM is already loaded before it's invoked. The callback is also always
called asynchronously.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>cb</span>
<span class='type'>
(<tt>Function</tt>)
</span>
—
<span class='desc'>The callback function to fire when the DOM is ready.</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='parseArguments-instance'>
- (void) <strong>parseArguments</strong>(args)
</p>
<div class='docstring'>
<p>Parses the arguments given to the Caman function, and sets the appropriate
properties on this instance.</p><p>@params [Array] args Array of arguments passed to Caman.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setInitObject-instance'>
- (void) <strong>setInitObject</strong>(obj)
</p>
<div class='docstring'>
<p>Sets the initialization object for this instance.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>obj</span>
<span class='type'>
(<tt>Object, String</tt>)
</span>
—
<span class='desc'>The initialization argument.</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setup-instance'>
- (void) <strong>setup</strong>()
</p>
<div class='docstring'>
<p>Begins the setup process, which differs depending on whether we're in NodeJS,
or if an image or canvas object was provided.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='initNode-instance'>
- (void) <strong>initNode</strong>()
</p>
<div class='docstring'>
<p>Initialization function for NodeJS.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='initImage-instance'>
- (void) <strong>initImage</strong>()
</p>
<div class='docstring'>
<p>Initialization function for the browser and image objects.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='initCanvas-instance'>
- (void) <strong>initCanvas</strong>()
</p>
<div class='docstring'>
<p>Initialization function for the browser and canvas objects.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='imageAdjustments-instance'>
- (void) <strong>imageAdjustments</strong>()
</p>
<div class='docstring'>
<p>Automatically check for a HiDPI capable screen and swap out the image if possible.
Also checks the image URL to see if it's a cross-domain request, and attempt to
proxy the image. If a cross-origin type is configured, the proxy will be ignored.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='waitForImageLoaded-instance'>
- (void) <strong>waitForImageLoaded</strong>()
</p>
<div class='docstring'>
<p>Utility function that fires <a href='../classes/Caman.html#imageLoaded-instance'>Caman#imageLoaded</a> once the image is finished loading.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='isImageLoaded-instance'>
- (Boolean) <strong>isImageLoaded</strong>()
</p>
<div class='docstring'>
<p>Checks if the given image is finished loading.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt>Boolean</tt>)
—
<span class='desc'>Is the image loaded?</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='imageWidth-instance'>
- (Number) <strong>imageWidth</strong>()
</p>
<div class='docstring'>
<p>Internet Explorer has issues figuring out image dimensions when they aren't
explicitly defined, apparently. We check the normal width/height properties first,
but fall back to natural sizes if they are 0.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt>Number</tt>)
—
<span class='desc'>Width of the initialization image.</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='imageHeight-instance'>
- (Number) <strong>imageHeight</strong>()
</p>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(<tt>Number</tt>)
—
<span class='desc'>Height of the initialization image.</span>
</li>
</ul>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='../classes/Caman.html#imageWidth-instance'>Caman#imageWidth</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='imageLoaded-instance'>
- (void) <strong>imageLoaded</strong>()
</p>
<div class='docstring'>
<p>Function that is called once the initialization image is finished loading.
We make sure that the canvas dimensions are properly set here.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='finishInit-instance'>
- (void) <strong>finishInit</strong>()
</p>
<div class='docstring'>
<p>Final step of initialization. We finish setting up our canvas element, and we
draw the image to the canvas (if applicable).</p>
</div>