View Javadoc

1   package com.insanityengine.ghia.pixels;
2   
3   /***
4    *
5    * <P>
6    * The read bits of the PixelBufferReadInterface are here to lower
7    * the bar for implementations which only need very basic buffer 
8    * functionality without all the cotton candy.
9    * </P>
10   *
11   * @author BrianHammond
12   *
13   * $Header: /usr/local/cvsroot/ghia/src/java/com/insanityengine/ghia/pixels/PixelBufferReadInterface.java,v 1.3 2005/03/19 17:50:02 brian Exp $
14   *
15   */
16  
17  public interface PixelBufferReadInterface {
18  
19  	/***
20  	 *
21  	 * Determines the width of the buffer. 
22  	 *
23  	 * @return the width of this buffer
24  	 *
25  	 */
26  	public int getWidth();
27  
28  	/***
29  	 *
30  	 * Determines the height of the buffer. 
31  	 *
32  	 * @return the height of this buffer
33  	 *
34  	 */
35  	public int getHeight();
36  
37  	/***
38  	 *
39  	 * Get the pixels
40  	 *
41  	 * @return the pixels
42  	 *
43  	 */
44  	public int[] getPixels();
45  	
46  	/***
47  	 *
48  	 * Get the clear color
49  	 *
50  	 * @return the clear color
51  	 *
52  	 */
53  	public int getClearColor();
54  	
55  };
56  
57  /***
58   *
59   * $Log: PixelBufferReadInterface.java,v $
60   * Revision 1.3  2005/03/19 17:50:02  brian
61   * repackaging
62   *
63   * Revision 1.2  2004/09/02 15:43:46  brian
64   * redefine PixelBufferReadInterface so BufferFx can use it as an interface rather than the RenderInterface
65   *
66   * Revision 1.1  2004/09/02 13:17:16  brian
67   * the big reorg
68   *
69   * Revision 1.4  2004/09/01 01:10:42  brian
70   * fix class level javadoc placement
71   *
72   * Revision 1.3  2004/09/01 00:11:06  brian
73   * author, log and header stuff
74   *
75   *
76   */