Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt

Class BufferCapabilities

Implemented Interfaces:
Cloneable
public class BufferCapabilities
extends Object
implements Cloneable
A double-buffering capability descriptor. This class exposes details about the double-buffering algorithms used by image buffers. BufferCapabilities represents algorithms that involve at least two buffers but it can also specify so-called "multi-buffer" schemes involving more than two buffers. This class describes the capabilities of the front and back buffers as well as the results of "flipping" -- that is, what happens when an image is transferred from the back buffer to the front buffer. Flipping may or may not be supported or may be supported only in fullscreen mode. If it is not supported then "blitting" is implied -- that is, the contents of the back buffer are copied using a fast block transfer operation from the back buffer to the front buffer. The front buffer is the one that is displayed.
Since:
1.4
See Also:
BufferStrategy.getCapabilities(), GraphicsConfiguration.getBufferCapabilities()

Nested Class Summary

static class
BufferCapabilities.FlipContents
A type-safe enumeration of buffer flipping results.

Constructor Summary

BufferCapabilities(ImageCapabilities frontCaps, ImageCapabilities backCaps, BufferCapabilities.FlipContents flip)
Creates a buffer capabilities object.

Method Summary

Object
clone()
Clone this buffering capability descriptor.
ImageCapabilities
getBackBufferCapabilities()
Retrieve the back buffer's image capabilities.
BufferCapabilities.FlipContents
getFlipContents()
Retrieve the result of a flipping operation.
ImageCapabilities
getFrontBufferCapabilities()
Retrieve the front buffer's image capabilities.
boolean
isFullScreenRequired()
Returns true if flipping is only supported in fullscreen mode.
boolean
isMultiBufferAvailable()
Returns true if flipping can involve more than two buffers.
boolean
isPageFlipping()
Return whether or not flipping is supported.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BufferCapabilities

public BufferCapabilities(ImageCapabilities frontCaps,
                          ImageCapabilities backCaps,
                          BufferCapabilities.FlipContents flip)
Creates a buffer capabilities object.
Parameters:
frontCaps - front buffer capabilities descriptor
backCaps - back buffer capabilities descriptor
flip - the results of a flip operation or null if flipping is not supported
Throws:
IllegalArgumentException - if frontCaps or backCaps is null

Method Details

clone

public Object clone()
Clone this buffering capability descriptor.
Overrides:
clone in interface Object
Returns:
a clone of this buffer capability descriptor

getBackBufferCapabilities

public ImageCapabilities getBackBufferCapabilities()
Retrieve the back buffer's image capabilities.
Returns:
the back buffer's image capabilities

getFlipContents

public BufferCapabilities.FlipContents getFlipContents()
Retrieve the result of a flipping operation. If this method returns null then flipping is not supported. This implies that "blitting", a fast block transfer, is used to copy the contents of the back buffer to the front buffer. Other possible return values are:
  • FlipContents.UNDEFINED the contents of the back buffer are undefined after flipping.
  • FlipContents.BACKGROUND the contents of the back buffer are cleared to the background color after flipping.
  • FlipContents.PRIOR the back buffer contains the pre-flipping contents of the front * buffer after flipping.
  • FlipContents.COPIED the back buffer has the same contents as the front buffer after flipping.
Returns:
the result of a flipping operation or null if flipping is not supported

getFrontBufferCapabilities

public ImageCapabilities getFrontBufferCapabilities()
Retrieve the front buffer's image capabilities.
Returns:
the front buffer's image capabilities

isFullScreenRequired

public boolean isFullScreenRequired()
Returns true if flipping is only supported in fullscreen mode.
Returns:
true if flipping is only supported in fullscreen mode, false otherwise

isMultiBufferAvailable

public boolean isMultiBufferAvailable()
Returns true if flipping can involve more than two buffers. One or more intermediate buffers may be available in addition to the front and back buffers.
Returns:
true if there are more than two buffers available for flipping, false otherwise

isPageFlipping

public boolean isPageFlipping()
Return whether or not flipping is supported.
Returns:
true if flipping is supported, false otherwise
BufferCapabilities.java -- double-buffering capabilities descriptor Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. 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 the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 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 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that 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 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 exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About