cvs: phpdoc /en/reference/imagick constants.xml

mkoppanen Thu Jul 31 15:20:51 2008 UTC Modified files: /phpdoc/en/reference/imagick constants.xml Log: Added new composite constants and descriptions for the composite constants

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/constants.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/imagick/constants.xml diff -u phpdoc/en/reference/imagick/constants.xml:1.14 phpdoc/en/reference/imagick/constants.xml:1.15 --- phpdoc/en/reference/imagick/constants.xml:1.14 Sun Dec 23 20:12:42 2007 +++ phpdoc/en/reference/imagick/constants.xml Thu Jul 31 15:20:50 2008 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <appendix xmlns="http://docbook.org/ns/docbook" xml:id="imagick.constants"> &reftitle.constants; &extension.constants; @@ -188,159 +188,595 @@ <title>Composite Operator Constants</title> <varlistentry> <term> - <constant>imagick::COMPOSITE_OVER</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_DEFAULT</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Overlay one image over the next + The default composite operator </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_IN</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_UNDEFINED</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Replaces the inside of one layer with another + Undefined composite operator </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_OUT</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_NO</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Replaces the outside of one layer with another + No composite operator defined + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_ADD</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The result of image + image </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>imagick::COMPOSITE_ATOP</constant> - (<type>integer</type>) + (<type>integer</type>) </term> <listitem> <simpara> - Composites the inside of one layer with the other + The result is the same shape as image, with composite image obscuring image where the image shapes overlap </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_XOR</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_BLEND</constant> + (<type>integer</type>) </term> <listitem> <simpara> - The part of the source that lies outside of the destination is - combined with the part of the destination that lies outside the - source. + Blends the image </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_PLUS</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_BUMPMAP</constant> + (<type>integer</type>) </term> <listitem> <simpara> - The source is added to the destination and replaces the destination. + The same as COMPOSITE_MULTIPLY, except the source is converted to greyscale first. </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_MINUS</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_CLEAR</constant> + (<type>integer</type>) </term> <listitem> <simpara> - The source is subtracted to the destination and replaces the - destination. + Makes the target image transparent </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_ADD</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_COLORBURN</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Deprecated + Darkens the destination image to reflect the source image </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_SUBTRACT</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_COLORDODGE</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Deprecated + Brightens the destination image to reflect the source image </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_DIFFERENCE</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_COLORIZE</constant> + (<type>integer</type>) </term> <listitem> <simpara> - The difference in color values. Good for comparing images. + Colorizes the target image using the composite image </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_BUMPMAP</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_COPYBLACK</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies black from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYBLUE</constant> + (<type>integer</type>) </term> <listitem> <simpara> - The same as COMPOSITE_MULTIPLY, except the source is converted to - greyscale first. + Copies blue from the source to target </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>imagick::COMPOSITE_COPY</constant> - (<type>integer</type>) + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies the source image on the target image + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYCYAN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies cyan from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYGREEN</constant> + (<type>integer</type>) </term> <listitem> <simpara> - Simply place the source on top of the destination. + Copies green from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYMAGENTA</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies magenta from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYOPACITY</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies opacity from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYRED</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies red from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_COPYYELLOW</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Copies yellow from the source to target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DARKEN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Darkens the target image + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DSTATOP</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The part of the destination lying inside of the source is composited over the source and replaces the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DST</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The target is left untouched + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DSTIN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The parts inside the source replace the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DSTOUT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The parts outside the source replace the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DSTOVER</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Target replaces the source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_DIFFERENCE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Subtracts the darker of the two constituent colors from the lighter </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>imagick::COMPOSITE_DISPLACE</constant> - (<type>integer</type>) + (<type>integer</type>) </term> <listitem> <simpara> - + Shifts target image pixels as defined by the source </simpara> </listitem> </varlistentry> <varlistentry> <term> - <constant>imagick::COMPOSITE_DEFAULT</constant> - (<type>integer</type>) + <constant>imagick::COMPOSITE_DISSOLVE</constant> + (<type>integer</type>) </term> <listitem> <simpara> - + Dissolves the source in to the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_EXCLUSION</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Produces an effect similar to that of imagick::COMPOSITE_DIFFERENCE, but appears as lower contrast + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_HARDLIGHT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Multiplies or screens the colors, dependent on the source color value + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_HUE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Modifies the hue of the target as defined by source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_IN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Composites source into the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_LIGHTEN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Lightens the target as defined by source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_LUMINIZE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Luminizes the target as defined by source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_MINUS</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Substracts the source from the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_MODULATE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Modulates the target brightness, saturation and hue as defined by source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_MULTIPLY</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Multiplies the target to the source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_OUT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Composites outer parts of the source on the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_OVER</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Composites source over the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_OVERLAY</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Overlays the source on the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_PLUS</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Adds the source to the target + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_REPLACE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Replaces the target with the source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SATURATE</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Saturates the target as defined by the source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SCREEN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The source and destination are complemented and then multiplied and then replace the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SOFTLIGHT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Darkens or lightens the colors, dependent on the source + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SRCATOP</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The part of the source lying inside of the destination is composited onto the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SRC</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The source is copied to the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SRCIN</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The part of the source lying inside of the destination replaces the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SRCOUT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The part of the source lying outside of the destination replaces the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SRCOVER</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The source replaces the destination + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_SUBTRACT</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Subtract the colors in the source image from the destination image + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_THRESHOLD</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The source is composited on the target as defined by source threshold + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>imagick::COMPOSITE_XOR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + The part of the source that lies outside of the destination is combined with the part of the destination that lies outside of the source </simpara> </listitem> </varlistentry>