...

...

@@ -5,13 +5,18 @@

5

5

<refname>image2wbmp</refname>

6

6

<refpurpose>&gd.image.output;</refpurpose>

7

7

</refnamediv>

8

+

9

+

<refsynopsisdiv>

10

+

&warn.deprecated.function-7-3-0.removed-8-0-0;

11

+

</refsynopsisdiv>

12

+

8

13

<refsect1 role="description">

9

14

&reftitle.description;

10

15

<methodsynopsis>

11

16

<type>bool</type><methodname>image2wbmp</methodname>

12

17

<methodparam><type>resource</type><parameter>image</parameter></methodparam>

13

18

<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>

14

-

<methodparam choice="opt"><type>int</type><parameter>threshold</parameter></methodparam>

19

+

<methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam>

15

20

</methodsynopsis>

16

21

<para>

17

22

<function>image2wbmp</function> outputs or save a <acronym>WBMP</acronym>

...

...

@@ -22,7 +27,15 @@

22

27

&reftitle.parameters;

23

28

<para>

24

29

<variablelist>

25

-

&gd.image.description;

30

+

<varlistentry>

31

+

<term><parameter>image</parameter></term>

32

+

<listitem>

33

+

<para>

34

+

An image resource, returned by one of the image creation functions,

35

+

such as <function>imagecreatetruecolor</function>.

36

+

</para>

37

+

</listitem>

38

+

</varlistentry>

26

39

<varlistentry>

27

40

<term><parameter>filename</parameter></term>

28

41

<listitem>

...

...

@@ -33,10 +46,12 @@

33

46

</listitem>

34

47

</varlistentry>

35

48

<varlistentry>

36

-

<term><parameter>threshold</parameter></term>

49

+

<term><parameter>foreground</parameter></term>

37

50

<listitem>

38

51

<para>

39

-

Threshold value, between 0 and 255 (inclusive).

52

+

You can set the foreground color with this parameter by setting an

53

+

identifier obtained from <function>imagecolorallocate</function>.

54

+

The default foreground color is black.

40

55

</para>

41

56

</listitem>

42

57

</varlistentry>

...

...

@@ -48,6 +63,7 @@

48

63

<para>

49

64

&return.success;

50

65

</para>

66

+

&gd.return.trueonerror;

51

67

</refsect1>

52

68

<refsect1 role="examples">

53

69

&reftitle.examples;

...

...

@@ -69,22 +85,12 @@ imagedestroy($image);

69

85

</example>

70

86

</para>

71

87

</refsect1>

72

-

<refsect1 role="notes">

73

-

&reftitle.notes;

74

-

<note>

75

-

<para>

76

-

WBMP support is only available if PHP was compiled against GD-1.8 or

77

-

later.

78

-

</para>

79

-

</note>

80

-

</refsect1>

88

+

81

89

<refsect1 role="seealso">

82

90

&reftitle.seealso;

83

-

<para>

84

-

<simplelist>

85

-

<member><function>imagewbmp</function></member>

86

-

</simplelist>

87

-

</para>

91

+

<simplelist>

92

+

<member><function>imagewbmp</function></member>

93

+

</simplelist>

88

94

</refsect1>

89

95

</refentry>

90

96

91

97