File: ImagickPixelIterator.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 (95 lines) | stat: -rw-r--r-- 3,913 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ImagickPixelIterator" namespace="" name="ImagickPixelIterator">
  <method name="clear" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Clear resources associated with a PixelIterator"/>
      <return type="bool"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="The ImagickPixelIterator constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="wand" optional="false" byreference="false" type="object" class="Imagick"/>
  </constructor>
  <method name="destroy" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Deallocates resources associated with a PixelIterator"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getCurrentIteratorRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the current row of ImagickPixel objects"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getIteratorRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the current pixel iterator row"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getNextIteratorRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the next row of the pixel iterator"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getPreviousIteratorRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the previous row"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="newPixelIterator" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a new pixel iterator"/>
      <return type="bool"/>
    </docblock>
    <parameter name="wand" optional="false" byreference="false" type="object" class="Imagick"/>
  </method>
  <method name="newPixelRegionIterator" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a new pixel iterator"/>
      <return type="bool"/>
    </docblock>
    <parameter name="wand" optional="false" byreference="false" type="object" class="Imagick"/>
    <parameter name="x" optional="false" byreference="false" type="int"/>
    <parameter name="y" optional="false" byreference="false" type="int"/>
    <parameter name="columns" optional="false" byreference="false" type="int"/>
    <parameter name="rows" optional="false" byreference="false" type="int"/>
  </method>
  <method name="resetIterator" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Resets the pixel iterator"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setIteratorFirstRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the pixel iterator to the first pixel row"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setIteratorLastRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Sets the pixel iterator to the last pixel row"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setIteratorRow" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Set the pixel iterator row"/>
      <return type="bool"/>
    </docblock>
    <parameter name="row" optional="false" byreference="false" type="int"/>
  </method>
  <method name="syncIterator" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Syncs the pixel iterator"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>