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

AUTHORS

903       <>
904
905
906
907                                   wx 1.8.3                         wxImage(3)