<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="jit.scanwrap" module="jit" category="Jitter Special FX">
	<digest>
		Resample by scanline wrapping
	</digest>
	<description>
		The <o>jit.scanwrap</o> object rewraps an input matrix into an output matrix. Matrix output handling is specified by a <at>mode</at> attribute.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Jitter
		</metadata>
		<metadata name="tag">
			Jitter Special FX
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="matrix">
			<digest>
				in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="matrix">
			<digest>
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="matrix">
			<digest>
				out
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="matrix">
			<digest>
				dumpout
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--MOP-->
	<mop matrixinputcount="1" matrixoutputcount="1">
		<matrixoutput name="out" planelink="1" typelink="1" dimlink="1" minplanecount="1" maxplanecount="32" mindimcount="1" maxdimcount="32">
			<types>
				char long float32 float64
			</types>
		</matrixoutput>
	</mop>
	<!--MESSAGES-->
	<methodlist>
		<method name="purge">
			<arglist />
			<digest>
				Sends the output matrix, regardless of its fill state (Note: In fill mode, the output matrix is generally unavailable until it is full).
			</digest>
			<description>
				Sends the output matrix, regardless of its fill state (Note: In fill mode, the output matrix is generally unavailable until it is full). If a matrix is purged, the message <m>purge 1</m> is sent out of the <o>jit.scanwrap</o> object's right outlet. If there is no matrix to purge, the message <m>purge 0</m> is sent. <m>purge</m> does not reset the object like the <m>reset</m> message).
			</description>
		</method>
		<method name="reset">
			<arglist />
			<digest>
				Sets the input/output scan back to the beginning and clears the output matrix
			</digest>
			<description>
				Sets the input/output scan back to the beginning and clears the output matrix. (Note: In fill mode, the <m>reset</m> message will start filling the output matrix from the top, abandoning any partial fill data that had already accumulated.)
			</description>
		</method>
	</methodlist>
	<jittermethodlist>
		<jittermethod name="bang" />
		<jittermethod name="clear" />
		<jittermethod name="exportattrs" />
		<jittermethod name="exportsummary" />
		<jittermethod name="getattributes" />
		<jittermethod name="getstate" />
		<jittermethod name="jit_matrix" />
		<jittermethod name="importattrs" />
		<jittermethod name="outputmatrix" />
		<jittermethod name="summary" />
	</jittermethodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="mode" get="1" set="1" type="int" size="1">
			<digest>
				Output mode
			</digest>
			<description>
				Output mode (default = 0 (fill))
				<br />
				0 = fill: The object will not output a matrix until it has received enough data to fill it. If the input matrix overflows the output, the excess data is truncated.
				<br />
				1 = dump: The object will output one matrix regardless of the amount of data received. If the output matrix is not filled, the remaining cells are set to 0. If the input matrix overflows the output, the excess data is truncated.
				<br />
				2 = spew: The object will output as many matrices as required to void itself of all data. If the output matrix is not filled, it waits until it has received enough data before it is output. If the input matrix overflows the output, the excess data is sent to new matrices, which will be output as soon as they are filled.
				<br />
				3 = wrap: If the input underflows the output matrix, it is 'looped' until it fills it up. Excess data is truncated.
				<br />
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Mode" />
			</attributelist>
		</attribute>
	</attributelist>
	<jitterattributelist>
		<jitterattribute name="outputmode" />
		<jitterattribute name="adapt" />
		<jitterattribute name="out_name" />
		<jitterattribute name="type" />
		<jitterattribute name="planecount" />
		<jitterattribute name="dim" />
	</jitterattributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="jit.scanwrap.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="jit.scanoffset" />
	</seealsolist>
</c74object>
