File: ImagickPixel.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (143 lines) | stat: -rw-r--r-- 6,295 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ImagickPixel" namespace="" name="ImagickPixel">
  <method name="clear" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Clears resources associated with this object"/>
      <return type="bool"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="The ImagickPixel constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="color" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="destroy" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Deallocates resources associated with this object"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getColor" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the color"/>
      <return type="array"/>
    </docblock>
    <parameter name="normalized" optional="true" byreference="false" type="int"/>
  </method>
  <method name="getColorAsString" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the color as a string"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getColorCount" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the color count associated with this color">Returns the color count associated with this color.</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getColorQuantum" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getColorValue" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Gets the normalized value of the provided color channel"/>
      <return type="float"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getColorValueQuantum" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="number"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getHSL" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the normalized HSL color of the ImagickPixel object"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getIndex" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="isPixelSimilar" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Check the distance between this color and another"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="object" class="ImagickPixel"/>
    <parameter name="fuzz" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="isPixelSimilarQuantum" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="string"/>
    <parameter name="fuzz" optional="true" byreference="false" type="string"/>
  </method>
  <method name="isSimilar" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Check the distance between this color and another"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="object" class="ImagickPixel"/>
    <parameter name="fuzz" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="setColor" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the color"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setcolorcount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="colorCount" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setColorValue" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the normalized value of one of the channels"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="int"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="setColorValueQuantum" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="bool"/>
    </docblock>
    <parameter name="color" optional="false" byreference="false" type="int"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="number"/>
  </method>
  <method name="setHSL" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the normalized HSL color"/>
      <return type="bool"/>
    </docblock>
    <parameter name="hue" optional="false" byreference="false" type="object" class="float"/>
    <parameter name="saturation" optional="false" byreference="false" type="object" class="float"/>
    <parameter name="luminosity" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="setIndex" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Description"/>
      <return type="bool"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
</class>