ImageArrayProvider.java

/*******************************************************************************
 * Copyright (c) 2015
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *******************************************************************************/
package jsettlers.graphics.reader;

import java.io.IOException;

/**
 * This class gives us a place to store our image
 * 
 * It is not thread safe.
 * 
 * It internally holds a write pointer, and may be backed by an array or a buffer.
 * 
 * startImage ist always called first, then writeLine for each line.
 * 
 * @author michael
 *
 */
public interface ImageArrayProvider {
	/**
	 * Starts a new image.
	 * 
	 * @param width
	 *            May be 0!
	 * @param height
	 *            May be 0!
	 * @throws IOException
	 */
	public void startImage(int width, int height) throws IOException;

	public void writeLine(short[] data, int length) throws IOException;
}