1wxImage(3)                 Erlang Module Definition                 wxImage(3)
2
3
4

NAME

6       wxImage - See external documentation: wxImage.
7

DESCRIPTION

9       See external documentation: wxImage.
10
11       All (default) image handlers are initialized.
12

DATA TYPES

14         wxImage():
15
16
17           An  object  reference,  The  representation  is internal and can be
18           changed without notice. It can't be used for comparsion  stored  on
19           disc or distributed for use on other nodes.
20

EXPORTS

22       new() -> wxImage()
23
24              See external documentation.
25
26       new(Name) -> wxImage()
27
28              Types:
29
30                 Name = unicode:chardata()
31
32              Equivalent to new(Name, []).
33
34       new(Width, Height) -> wxImage()
35       new(Name, Height::[Option]) -> wxImage()
36
37              Types:
38
39                 Width = integer()
40                 Height = integer()
41                 Name = unicode:chardata()
42                 Option = {type, integer()} | {index, integer()}
43
44              See external documentation.
45              Also:
46              new(Name, [Option]) -> wxImage() when
47              Name::unicode:chardata(),
48              Option :: {'type', integer()}
49              | {'index', integer()}.
50
51
52       new(Width, Height, Data) -> wxImage()
53       new(Width, Height, Data::[Option]) -> wxImage()
54       new(Name, Mimetype, Data::[Option]) -> wxImage()
55
56              Types:
57
58                 Width = integer()
59                 Height = integer()
60                 Data = binary()
61                 Width = integer()
62                 Height = integer()
63                 Option = {clear, boolean()}
64                 Name = unicode:chardata()
65                 Mimetype = unicode:chardata()
66                 Option = {index, integer()}
67
68              See external documentation.
69              Also:
70              new(Width, Height, [Option]) -> wxImage() when
71              Width::integer(), Height::integer(),
72              Option :: {'clear', boolean()};
73              (Name, Mimetype, [Option]) -> wxImage() when
74              Name::unicode:chardata(), Mimetype::unicode:chardata(),
75              Option :: {'index', integer()}.
76
77
78       new(Width, Height, Data, Alpha) -> wxImage()
79       new(Width, Height, Data, Alpha::[Option]) -> wxImage()
80
81              Types:
82
83                 Width = integer()
84                 Height = integer()
85                 Data = binary()
86                 Alpha = binary()
87                 Width = integer()
88                 Height = integer()
89                 Data = binary()
90                 Option = {static_data, boolean()}
91
92              See external documentation.
93              Also:
94              new(Width, Height, Data, [Option]) -> wxImage() when
95              Width::integer(), Height::integer(), Data::binary(),
96              Option :: {'static_data', boolean()}.
97
98
99       new(Width, Height, Data, Alpha, Options::[Option]) -> wxImage()
100
101              Types:
102
103                 Width = integer()
104                 Height = integer()
105                 Data = binary()
106                 Alpha = binary()
107                 Option = {static_data, boolean()}
108
109              See external documentation.
110
111       blur(This, Radius) -> wxImage()
112
113              Types:
114
115                 This = wxImage()
116                 Radius = integer()
117
118              See external documentation.
119
120       blurHorizontal(This, Radius) -> wxImage()
121
122              Types:
123
124                 This = wxImage()
125                 Radius = integer()
126
127              See external documentation.
128
129       blurVertical(This, Radius) -> wxImage()
130
131              Types:
132
133                 This = wxImage()
134                 Radius = integer()
135
136              See external documentation.
137
138       convertAlphaToMask(This) -> boolean()
139
140              Types:
141
142                 This = wxImage()
143
144              Equivalent to convertAlphaToMask(This, []).
145
146       convertAlphaToMask(This, Options::[Option]) -> boolean()
147
148              Types:
149
150                 This = wxImage()
151                 Option = {threshold, integer()}
152
153              See external documentation.
154
155       convertToGreyscale(This) -> wxImage()
156
157              Types:
158
159                 This = wxImage()
160
161              Equivalent to convertToGreyscale(This, []).
162
163       convertToGreyscale(This, Options::[Option]) -> wxImage()
164
165              Types:
166
167                 This = wxImage()
168                 Option = {lr, number()} | {lg, number()} | {lb, number()}
169
170              See external documentation.
171
172       convertToMono(This, R, G, B) -> wxImage()
173
174              Types:
175
176                 This = wxImage()
177                 R = integer()
178                 G = integer()
179                 B = integer()
180
181              See external documentation.
182
183       copy(This) -> wxImage()
184
185              Types:
186
187                 This = wxImage()
188
189              See external documentation.
190
191       create(This, Width, Height) -> boolean()
192
193              Types:
194
195                 This = wxImage()
196                 Width = integer()
197                 Height = integer()
198
199              Equivalent to create(This, Width, Height, []).
200
201       create(This, Width, Height, Data) -> boolean()
202       create(This, Width, Height, Data::[Option]) -> boolean()
203
204              Types:
205
206                 This = wxImage()
207                 Width = integer()
208                 Height = integer()
209                 Data = binary()
210                 This = wxImage()
211                 Width = integer()
212                 Height = integer()
213                 Option = {clear, boolean()}
214
215              See external documentation.
216              Also:
217              create(This, Width, Height, [Option]) -> boolean() when
218              This::wxImage(), Width::integer(), Height::integer(),
219              Option :: {'clear', boolean()}.
220
221
222       create(This, Width, Height, Data, Alpha) -> boolean()
223       create(This, Width, Height, Data, Alpha::[Option]) -> boolean()
224
225              Types:
226
227                 This = wxImage()
228                 Width = integer()
229                 Height = integer()
230                 Data = binary()
231                 Alpha = binary()
232                 This = wxImage()
233                 Width = integer()
234                 Height = integer()
235                 Data = binary()
236                 Option = {static_data, boolean()}
237
238              See external documentation.
239              Also:
240              create(This, Width, Height, Data, [Option]) -> boolean() when
241              This::wxImage(),       Width::integer(),      Height::integer(),
242              Data::binary(),
243              Option :: {'static_data', boolean()}.
244
245
246       create(This, Width, Height, Data, Alpha,  Options::[Option])  ->  bool‐
247       ean()
248
249              Types:
250
251                 This = wxImage()
252                 Width = integer()
253                 Height = integer()
254                 Data = binary()
255                 Alpha = binary()
256                 Option = {static_data, boolean()}
257
258              See external documentation.
259
260       Destroy(This) -> ok
261
262              Types:
263
264                 This = wxImage()
265
266              See external documentation.
267
268       findFirstUnusedColour(This) -> Result
269
270              Types:
271
272                 Result   =   {Res::boolean(),   R::integer(),   G::integer(),
273                 B::integer()}
274                 This = wxImage()
275
276              Equivalent to findFirstUnusedColour(This, []).
277
278       findFirstUnusedColour(This, Options::[Option]) -> Result
279
280              Types:
281
282                 Result   =   {Res::boolean(),   R::integer(),   G::integer(),
283                 B::integer()}
284                 This = wxImage()
285                 Option = {startR, integer()} | {startG, integer()} | {startB,
286                 integer()}
287
288              See external documentation.
289
290       getImageExtWildcard() -> unicode:charlist()
291
292              See external documentation.
293
294       getAlpha(This) -> binary()
295
296              Types:
297
298                 This = wxImage()
299
300              See external documentation.
301
302       getAlpha(This, X, Y) -> integer()
303
304              Types:
305
306                 This = wxImage()
307                 X = integer()
308                 Y = integer()
309
310              See external documentation.
311
312       getBlue(This, X, Y) -> integer()
313
314              Types:
315
316                 This = wxImage()
317                 X = integer()
318                 Y = integer()
319
320              See external documentation.
321
322       getData(This) -> binary()
323
324              Types:
325
326                 This = wxImage()
327
328              See external documentation.
329
330       getGreen(This, X, Y) -> integer()
331
332              Types:
333
334                 This = wxImage()
335                 X = integer()
336                 Y = integer()
337
338              See external documentation.
339
340       getImageCount(Name) -> integer()
341
342              Types:
343
344                 Name = unicode:chardata()
345
346              Equivalent to getImageCount(Name, []).
347
348       getImageCount(Name, Options::[Option]) -> integer()
349
350              Types:
351
352                 Name = unicode:chardata()
353                 Option = {type, wx:wx_enum()}
354
355              See external documentation.
356              Type   =   ?wxBITMAP_TYPE_INVALID   |    ?wxBITMAP_TYPE_BMP    |
357              ?wxBITMAP_TYPE_BMP_RESOURCE    |    ?wxBITMAP_TYPE_RESOURCE    |
358              ?wxBITMAP_TYPE_ICO     |      ?wxBITMAP_TYPE_ICO_RESOURCE      |
359              ?wxBITMAP_TYPE_CUR      |      ?wxBITMAP_TYPE_CUR_RESOURCE     |
360              ?wxBITMAP_TYPE_XBM       |       ?wxBITMAP_TYPE_XBM_DATA       |
361              ?wxBITMAP_TYPE_XPM       |       ?wxBITMAP_TYPE_XPM_DATA       |
362              ?wxBITMAP_TYPE_TIF     |      ?wxBITMAP_TYPE_TIF_RESOURCE      |
363              ?wxBITMAP_TYPE_GIF      |      ?wxBITMAP_TYPE_GIF_RESOURCE     |
364              ?wxBITMAP_TYPE_PNG     |      ?wxBITMAP_TYPE_PNG_RESOURCE      |
365              ?wxBITMAP_TYPE_JPEG     |     ?wxBITMAP_TYPE_JPEG_RESOURCE     |
366              ?wxBITMAP_TYPE_PNM     |      ?wxBITMAP_TYPE_PNM_RESOURCE      |
367              ?wxBITMAP_TYPE_PCX      |      ?wxBITMAP_TYPE_PCX_RESOURCE     |
368              ?wxBITMAP_TYPE_PICT     |     ?wxBITMAP_TYPE_PICT_RESOURCE     |
369              ?wxBITMAP_TYPE_ICON     |     ?wxBITMAP_TYPE_ICON_RESOURCE     |
370              ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF |  ?wxBITMAP_TYPE_TGA  |
371              ?wxBITMAP_TYPE_MACCURSOR  |  ?wxBITMAP_TYPE_MACCURSOR_RESOURCE |
372              ?wxBITMAP_TYPE_ANY
373
374       getHeight(This) -> integer()
375
376              Types:
377
378                 This = wxImage()
379
380              See external documentation.
381
382       getMaskBlue(This) -> integer()
383
384              Types:
385
386                 This = wxImage()
387
388              See external documentation.
389
390       getMaskGreen(This) -> integer()
391
392              Types:
393
394                 This = wxImage()
395
396              See external documentation.
397
398       getMaskRed(This) -> integer()
399
400              Types:
401
402                 This = wxImage()
403
404              See external documentation.
405
406       getOrFindMaskColour(This) -> Result
407
408              Types:
409
410                 Result   =   {Res::boolean(),   R::integer(),   G::integer(),
411                 B::integer()}
412                 This = wxImage()
413
414              See external documentation.
415
416       getPalette(This) -> wxPalette:wxPalette()
417
418              Types:
419
420                 This = wxImage()
421
422              See external documentation.
423
424       getRed(This, X, Y) -> integer()
425
426              Types:
427
428                 This = wxImage()
429                 X = integer()
430                 Y = integer()
431
432              See external documentation.
433
434       getSubImage(This, Rect) -> wxImage()
435
436              Types:
437
438                 This = wxImage()
439                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
440                 ger()}
441
442              See external documentation.
443
444       getWidth(This) -> integer()
445
446              Types:
447
448                 This = wxImage()
449
450              See external documentation.
451
452       hasAlpha(This) -> boolean()
453
454              Types:
455
456                 This = wxImage()
457
458              See external documentation.
459
460       hasMask(This) -> boolean()
461
462              Types:
463
464                 This = wxImage()
465
466              See external documentation.
467
468       getOption(This, Name) -> unicode:charlist()
469
470              Types:
471
472                 This = wxImage()
473                 Name = unicode:chardata()
474
475              See external documentation.
476
477       getOptionInt(This, Name) -> integer()
478
479              Types:
480
481                 This = wxImage()
482                 Name = unicode:chardata()
483
484              See external documentation.
485
486       hasOption(This, Name) -> boolean()
487
488              Types:
489
490                 This = wxImage()
491                 Name = unicode:chardata()
492
493              See external documentation.
494
495       initAlpha(This) -> ok
496
497              Types:
498
499                 This = wxImage()
500
501              See external documentation.
502
503       initStandardHandlers() -> ok
504
505              See external documentation.
506
507       isTransparent(This, X, Y) -> boolean()
508
509              Types:
510
511                 This = wxImage()
512                 X = integer()
513                 Y = integer()
514
515              Equivalent to isTransparent(This, X, Y, []).
516
517       isTransparent(This, X, Y, Options::[Option]) -> boolean()
518
519              Types:
520
521                 This = wxImage()
522                 X = integer()
523                 Y = integer()
524                 Option = {threshold, integer()}
525
526              See external documentation.
527
528       loadFile(This, Name) -> boolean()
529
530              Types:
531
532                 This = wxImage()
533                 Name = unicode:chardata()
534
535              Equivalent to loadFile(This, Name, []).
536
537       loadFile(This, Name, Options::[Option]) -> boolean()
538
539              Types:
540
541                 This = wxImage()
542                 Name = unicode:chardata()
543                 Option = {type, integer()} | {index, integer()}
544
545              See external documentation.
546
547       loadFile(This, Name, Mimetype, Options::[Option]) -> boolean()
548
549              Types:
550
551                 This = wxImage()
552                 Name = unicode:chardata()
553                 Mimetype = unicode:chardata()
554                 Option = {index, integer()}
555
556              See external documentation.
557
558       ok(This) -> boolean()
559
560              Types:
561
562                 This = wxImage()
563
564              See external documentation.
565
566       removeHandler(Name) -> boolean()
567
568              Types:
569
570                 Name = unicode:chardata()
571
572              See external documentation.
573
574       mirror(This) -> wxImage()
575
576              Types:
577
578                 This = wxImage()
579
580              Equivalent to mirror(This, []).
581
582       mirror(This, Options::[Option]) -> wxImage()
583
584              Types:
585
586                 This = wxImage()
587                 Option = {horizontally, boolean()}
588
589              See external documentation.
590
591       replace(This, R1, G1, B1, R2, G2, B2) -> ok
592
593              Types:
594
595                 This = wxImage()
596                 R1 = integer()
597                 G1 = integer()
598                 B1 = integer()
599                 R2 = integer()
600                 G2 = integer()
601                 B2 = integer()
602
603              See external documentation.
604
605       rescale(This, Width, Height) -> wxImage()
606
607              Types:
608
609                 This = wxImage()
610                 Width = integer()
611                 Height = integer()
612
613              Equivalent to rescale(This, Width, Height, []).
614
615       rescale(This, Width, Height, Options::[Option]) -> wxImage()
616
617              Types:
618
619                 This = wxImage()
620                 Width = integer()
621                 Height = integer()
622                 Option = {quality, wx:wx_enum()}
623
624              See external documentation.
625              Quality = integer
626
627       resize(This, Size, Pos) -> wxImage()
628
629              Types:
630
631                 This = wxImage()
632                 Size = {W::integer(), H::integer()}
633                 Pos = {X::integer(), Y::integer()}
634
635              Equivalent to resize(This, Size, Pos, []).
636
637       resize(This, Size, Pos, Options::[Option]) -> wxImage()
638
639              Types:
640
641                 This = wxImage()
642                 Size = {W::integer(), H::integer()}
643                 Pos = {X::integer(), Y::integer()}
644                 Option = {r, integer()} | {g, integer()} | {b, integer()}
645
646              See external documentation.
647
648       rotate(This, Angle, Centre_of_rotation) -> wxImage()
649
650              Types:
651
652                 This = wxImage()
653                 Angle = number()
654                 Centre_of_rotation = {X::integer(), Y::integer()}
655
656              Equivalent to rotate(This, Angle, Centre_of_rotation, []).
657
658       rotate(This, Angle, Centre_of_rotation, Options::[Option]) -> wxImage()
659
660              Types:
661
662                 This = wxImage()
663                 Angle = number()
664                 Centre_of_rotation = {X::integer(), Y::integer()}
665                 Option = {interpolating, boolean()} | {offset_after_rotation,
666                 {X::integer(), Y::integer()}}
667
668              See external documentation.
669
670       rotateHue(This, Angle) -> ok
671
672              Types:
673
674                 This = wxImage()
675                 Angle = number()
676
677              See external documentation.
678
679       rotate90(This) -> wxImage()
680
681              Types:
682
683                 This = wxImage()
684
685              Equivalent to rotate90(This, []).
686
687       rotate90(This, Options::[Option]) -> wxImage()
688
689              Types:
690
691                 This = wxImage()
692                 Option = {clockwise, boolean()}
693
694              See external documentation.
695
696       saveFile(This, Name) -> boolean()
697
698              Types:
699
700                 This = wxImage()
701                 Name = unicode:chardata()
702
703              See external documentation.
704
705       saveFile(This, Name, Type) -> boolean()
706       saveFile(This, Name, Mimetype) -> boolean()
707
708              Types:
709
710                 This = wxImage()
711                 Name = unicode:chardata()
712                 Type = integer()
713                 This = wxImage()
714                 Name = unicode:chardata()
715                 Mimetype = unicode:chardata()
716
717              See external documentation.
718              Also:
719              saveFile(This, Name, Mimetype) -> boolean() when
720              This::wxImage(),     Name::unicode:chardata(),    Mimetype::uni‐
721              code:chardata().
722
723
724       scale(This, Width, Height) -> wxImage()
725
726              Types:
727
728                 This = wxImage()
729                 Width = integer()
730                 Height = integer()
731
732              Equivalent to scale(This, Width, Height, []).
733
734       scale(This, Width, Height, Options::[Option]) -> wxImage()
735
736              Types:
737
738                 This = wxImage()
739                 Width = integer()
740                 Height = integer()
741                 Option = {quality, wx:wx_enum()}
742
743              See external documentation.
744              Quality = integer
745
746       size(This, Size, Pos) -> wxImage()
747
748              Types:
749
750                 This = wxImage()
751                 Size = {W::integer(), H::integer()}
752                 Pos = {X::integer(), Y::integer()}
753
754              Equivalent to size(This, Size, Pos, []).
755
756       size(This, Size, Pos, Options::[Option]) -> wxImage()
757
758              Types:
759
760                 This = wxImage()
761                 Size = {W::integer(), H::integer()}
762                 Pos = {X::integer(), Y::integer()}
763                 Option = {r, integer()} | {g, integer()} | {b, integer()}
764
765              See external documentation.
766
767       setAlpha(This, Alpha) -> ok
768
769              Types:
770
771                 This = wxImage()
772                 Alpha = binary()
773
774              Equivalent to setAlpha(This, Alpha, []).
775
776       setAlpha(This, Alpha, Options::[Option]) -> ok
777
778              Types:
779
780                 This = wxImage()
781                 Alpha = binary()
782                 Option = {static_data, boolean()}
783
784              See external documentation.
785
786       setAlpha(This, X, Y, Alpha) -> ok
787
788              Types:
789
790                 This = wxImage()
791                 X = integer()
792                 Y = integer()
793                 Alpha = integer()
794
795              See external documentation.
796
797       setData(This, Data) -> ok
798
799              Types:
800
801                 This = wxImage()
802                 Data = binary()
803
804              Equivalent to setData(This, Data, []).
805
806       setData(This, Data, Options::[Option]) -> ok
807
808              Types:
809
810                 This = wxImage()
811                 Data = binary()
812                 Option = {static_data, boolean()}
813
814              See external documentation.
815
816       setData(This, Data, New_width, New_height) -> ok
817
818              Types:
819
820                 This = wxImage()
821                 Data = binary()
822                 New_width = integer()
823                 New_height = integer()
824
825              Equivalent to setData(This, Data, New_width, New_height, []).
826
827       setData(This, Data, New_width, New_height, Options::[Option]) -> ok
828
829              Types:
830
831                 This = wxImage()
832                 Data = binary()
833                 New_width = integer()
834                 New_height = integer()
835                 Option = {static_data, boolean()}
836
837              See external documentation.
838
839       setMask(This) -> ok
840
841              Types:
842
843                 This = wxImage()
844
845              Equivalent to setMask(This, []).
846
847       setMask(This, Options::[Option]) -> ok
848
849              Types:
850
851                 This = wxImage()
852                 Option = {mask, boolean()}
853
854              See external documentation.
855
856       setMaskColour(This, R, G, B) -> ok
857
858              Types:
859
860                 This = wxImage()
861                 R = integer()
862                 G = integer()
863                 B = integer()
864
865              See external documentation.
866
867       setMaskFromImage(This, Mask, Mr, Mg, Mb) -> boolean()
868
869              Types:
870
871                 This = wxImage()
872                 Mask = wxImage()
873                 Mr = integer()
874                 Mg = integer()
875                 Mb = integer()
876
877              See external documentation.
878
879       setOption(This, Name, Value) -> ok
880       setOption(This, Name, Value) -> ok
881
882              Types:
883
884                 This = wxImage()
885                 Name = unicode:chardata()
886                 Value = integer()
887                 This = wxImage()
888                 Name = unicode:chardata()
889                 Value = unicode:chardata()
890
891              See external documentation.
892              Also:
893              setOption(This, Name, Value) -> 'ok' when
894              This::wxImage(), Name::unicode:chardata(),  Value::unicode:char‐
895              data().
896
897
898       setPalette(This, Palette) -> ok
899
900              Types:
901
902                 This = wxImage()
903                 Palette = wxPalette:wxPalette()
904
905              See external documentation.
906
907       setRGB(This, Rect, R, G, B) -> ok
908
909              Types:
910
911                 This = wxImage()
912                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
913                 ger()}
914                 R = integer()
915                 G = integer()
916                 B = integer()
917
918              See external documentation.
919
920       setRGB(This, X, Y, R, G, B) -> ok
921
922              Types:
923
924                 This = wxImage()
925                 X = integer()
926                 Y = integer()
927                 R = integer()
928                 G = integer()
929                 B = integer()
930
931              See external documentation.
932
933       destroy(This::wxImage()) -> ok
934
935              Destroys this object, do not use object again
936

AUTHORS

938       <>
939
940
941
942                                   wx 1.9.3                         wxImage(3)