Commit d1ca2cfe by Thomas Fitzsimmons Committed by Thomas Fitzsimmons

ImageCapabilities.java: Document.

2005-05-04  Thomas Fitzsimmons  <fitzsim@redhat.com>

	* java/awt/ImageCapabilities.java: Document.

	* java/awt/image/VolatileImage.java: Unindent copyright header.

From-SVN: r99224
parent 1351ec82
2005-05-04 Thomas Fitzsimmons <fitzsim@redhat.com>
* java/awt/ImageCapabilities.java: Document.
* java/awt/image/VolatileImage.java: Unindent copyright header.
2005-05-03 Thomas Fitzsimmons <fitzsim@redhat.com> 2005-05-03 Thomas Fitzsimmons <fitzsim@redhat.com>
* java/awt/image/VolatileImage.java: Document. * java/awt/image/VolatileImage.java: Document.
......
/* ImageCapabilities.java -- /* ImageCapabilities.java -- the capabilities of an image buffer
Copyright (C) 2002 Free Software Foundation, Inc. Copyright (C) 2002, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
...@@ -39,23 +39,60 @@ exception statement from your version. */ ...@@ -39,23 +39,60 @@ exception statement from your version. */
package java.awt; package java.awt;
/** /**
* STUBS ONLY * This class represents the capabilities of an image buffer. An
* image buffer may be backed by accelerated graphics resources.
* Those resources may or may not be volatile. This class is used to
* describe these image buffer characteristics.
*/ */
public class ImageCapabilities implements Cloneable public class ImageCapabilities implements Cloneable
{ {
/**
* Whether or not this the image buffer uses accelerated graphics
* resources.
*/
private final boolean accelerated; private final boolean accelerated;
/**
* Create a new image capability descriptor.
*
* @param accelerated true if the image buffer uses accelerated
* graphics resources
*/
public ImageCapabilities(boolean accelerated) public ImageCapabilities(boolean accelerated)
{ {
this.accelerated = accelerated; this.accelerated = accelerated;
} }
/**
* Returns whether or not the image buffer uses accelerated graphics
* resources.
*
* @return true if the image buffer uses accelerated graphics
* resources; false otherwise
*/
public boolean isAccelerated() public boolean isAccelerated()
{ {
return accelerated; return accelerated;
} }
/**
* Returns whether or not the image buffer's resources are volatile,
* meaning that they can be reclaimed by the graphics system at any
* time.
*
* @return true if the image buffer's resources are volatile; false
* otherwise
*/
public boolean isTrueVolatile() public boolean isTrueVolatile()
{ {
return true; return true;
} }
/**
* Clone this image capability descriptor.
*
* @return a clone of this image capability descriptor
*/
public Object clone() public Object clone()
{ {
try try
...@@ -64,7 +101,7 @@ public class ImageCapabilities implements Cloneable ...@@ -64,7 +101,7 @@ public class ImageCapabilities implements Cloneable
} }
catch (CloneNotSupportedException e) catch (CloneNotSupportedException e)
{ {
throw (Error) new InternalError().initCause(e); // Impossible throw (Error) new InternalError().initCause(e);
} }
} }
} // class ImageCapabilities }
/* VolatileImage.java -- a hardware-accelerated image buffer /* VolatileImage.java -- a hardware-accelerated image buffer
Copyright (C) 2002, 2005 Free Software Foundation, Inc. Copyright (C) 2002, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details. General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA. 02111-1307 USA.
Linking this library statically or dynamically with other modules is Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole conditions of the GNU General Public License cover the whole
combination. combination.
As a special exception, the copyright holders of this library give you As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */ exception statement from your version. */
package java.awt.image; package java.awt.image;
...@@ -152,7 +152,7 @@ public abstract class VolatileImage extends Image ...@@ -152,7 +152,7 @@ public abstract class VolatileImage extends Image
* VolatileImages are typically optimized for writing. * VolatileImages are typically optimized for writing.
* *
* @return an ImageProducer for a static BufferedImage snapshot of * @return an ImageProducer for a static BufferedImage snapshot of
* this image buffer. * this image buffer
*/ */
public ImageProducer getSource() public ImageProducer getSource()
{ {
...@@ -245,7 +245,7 @@ public abstract class VolatileImage extends Image ...@@ -245,7 +245,7 @@ public abstract class VolatileImage extends Image
* Returns the transparency type of this image. * Returns the transparency type of this image.
* *
* @return Transparency.OPAQUE, Transparency.BITMASK or * @return Transparency.OPAQUE, Transparency.BITMASK or
* Transparency.TRANSLUCENT. * Transparency.TRANSLUCENT
*/ */
public int getTransparency() public int getTransparency()
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment