<doc>
	<legacy_id>1931</legacy_id>
	<name>ink</name>
	<type>property</type>

	<syntax>
		<example>set the ink of <i>object</i> to <i>inkMode</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Specifies the kind of transparency an <glossary tag="object">object</glossary> is drawn with.</summary>

	<examples>
<example>set the ink of graphic &quot;Floating&quot; to blendClear</example>
<example>set the ink of field &quot;Ghost&quot; to blendPlus</example>
	</examples>

	<history>
		<introduced version="1.0">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		<changed version="5.0">5.0</changed>
<changed version="2.7">2.7</changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<desktop/>
		<server/>
		<web/>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Appearance  Positioning</category>
	</classification>

	<references>
		<property tag="blendLevel">blendLevel Property</property>
		<property tag="innerGlow">innerGlow Property</property>
		<property tag="colorOverlay">colorOverlay Property</property>
		<property tag="innerShadow">innerShadow Property</property>
		<property tag="dropShadow">dropShadow Property</property>
		<property tag="outerGlow">outerGlow Property</property>
		<keyword tag="notSrcCopy">notSrcCopy Keyword</keyword>
	</references>

	<description>
	<overview>Use the <b>ink</b> <glossary tag="property">property</glossary> to specify how the color of each <glossary tag="pixel">pixel</glossary> of an <glossary tag="object">object</glossary> combines with the color of the <glossary tag="pixel">pixel</glossary> underneath it to create the final color shown on the screen.</overview>

		<parameters>
<parameter>
<name>object</name>
<description>the name of the object</description>
</parameter>

<parameter>
<name>inkmode</name>
<description>the name of the ink</description>
</parameter>		</parameters>

	<value>The <b>ink</b> of an <glossary tag="object">object</glossary> is a <keyword tag="string">string</keyword> designating one of 48 <glossary tag="transfer mode">transfer modes</glossary>.<p></p><p>By default, the <b>ink</b> of newly created <glossary tag="object">objects</glossary> is &quot;srcCopy&quot;.</p></value>
	<comments>The <b>srcCopy</b> mode simply puts the <glossary tag="object">object</glossary> on top of the <object tag="group">background</object>; the <object tag="group">background</object> does not show through or affect the final color at all.<p></p><p>You can use other transfer modes with the <b>ink</b> <glossary tag="property">property</glossary> to create special transparent or partially transparent effects, or to invert the colors of an <glossary tag="object">object</glossary> or the colors underneath the <glossary tag="object">object</glossary>, or to combine the <glossary tag="object">object's</glossary> colors with the colors under the <glossary tag="object">object</glossary>.</p><p></p><p>There are 48 transfer modes:</p><p></p><p><b>Structural Blends (Porter Duff operators):</b></p><p>        * <i>blendClear</i></p><p>        * <i>blendSrc</i></p><p>        * <i>blendDst</i></p><p>        * <i>blendSrcOver</i></p><p>        * <i>blendDstOver</i></p><p>        * <i>blendSrcIn</i></p><p>        * <i>blendDstIn</i></p><p>        * <i>blendSrcOut</i></p><p>        * <i>blendDstOut</i></p><p>        * <i>blendSrcAtop</i></p><p>        * <i>blendDstAtop</i></p><p>        * <i>blendXor</i></p><p></p><p><b>Image Processing Blends (SVG/PDF operators):</b></p><p>        * <i>blendPlus</i></p><p>        * <i>blendMultiply</i></p><p>        * <i>blendScreen</i></p><p>        * <i>blendOverlay</i></p><p>        * <i>blendDarken</i></p><p>        * <i>blendLighten</i></p><p>        * <i>blendDodge</i></p><p>        * <i>blendBurn</i></p><p>        * <i>blendHardLight</i></p><p>        * <i>blendSoftLight</i></p><p>        * <i>blendDifference</i></p><p>        * <i>blendExclusion</i></p><p></p><p><b>Bitwise - These inks have been deprecated from version 5.0</b></p><p>        * <i>clear</i></p><p>        * <i>noop</i></p><p>        * <i>notSrcAnd</i></p><p>        * <i>notSrcAndReverse</i></p><p>        * <i>notSrcCopy</i></p><p>        * <i>notSrcOr</i></p><p>        * <i>notSrcOrReverse</i></p><p>        * <i>notSrcXor</i></p><p>        * <i>reverse</i></p><p>        * <i>set</i></p><p>        * <i>srcAnd</i></p><p>        * <i>srcAndReverse</i></p><p>        * <i>srcCopy</i></p><p>        * <i>srcOr</i></p><p>        * <i>srcOrReverse</i></p><p>        * <i>srcXor</i></p><p></p><p><b>Arithmetc: - These inks have been deprecated from version 5.0</b></p><p>        * <i>blend</i></p><p>        * <i>addPin</i></p><p>        * <i>addOver</i></p><p>        * <i>subPin</i></p><p>        * <i>transparent</i></p><p>        * <i>adMin</i></p><p>        * <i>addMax</i></p><p></p><p>The rendered pixels of an object are combined with the corresponding background pixels using the specified ink before the blendLevel is applied.</p><p></p><p></p><note>Most of the structural blends require that an ancestor of the object be a container with an alpha channel. If this is not the case the behaviour of the blend is undefined. Containers (cards and groups) can be forced to have an alpha channel by setting their ink to something other than <i>srcCopy</i>, or by setting their <i>blendLevel</i> to something other than 0.</note><p></p><p></p><note></note><p>The bitwise and arithmetic inks (apart from srcCopy) should be considered as legacy modes and not used in new applications. In general, the behaviour of the structural and image processing blends should be preferred as these naturally work well with alpha-channels.</p></comments>
	</description>
</doc>