aicas logoJamaica 6.1 release 1

java.awt
Class BufferCapabilities

java.lang.Object
  extended by java.awt.BufferCapabilities
All Implemented Interfaces:
Cloneable

public class BufferCapabilities
extends Object
implements Cloneable

Capabilities and properties of buffers.

Since:
1.4
See Also:
BufferStrategy.getCapabilities(), GraphicsConfiguration.getBufferCapabilities()

Nested Class Summary
static class BufferCapabilities.FlipContents
          A type-safe enumeration of the possible back buffer contents after page-flipping
 
Constructor Summary
BufferCapabilities(ImageCapabilities frontCaps, ImageCapabilities backCaps, BufferCapabilities.FlipContents flipContents)
          Creates a new object for specifying buffering capabilities
 
Method Summary
 Object clone()
          clone creates a shallow clone of this.
 ImageCapabilities getBackBufferCapabilities()
           
 BufferCapabilities.FlipContents getFlipContents()
           
 ImageCapabilities getFrontBufferCapabilities()
           
 boolean isFullScreenRequired()
           
 boolean isMultiBufferAvailable()
           
 boolean isPageFlipping()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferCapabilities

public BufferCapabilities(ImageCapabilities frontCaps,
                          ImageCapabilities backCaps,
                          BufferCapabilities.FlipContents flipContents)
Creates a new object for specifying buffering capabilities

Parameters:
frontCaps - the capabilities of the front buffer; cannot be null
backCaps - the capabilities of the back and intermediate buffers; cannot be null
flipContents - the contents of the back buffer after page-flipping, null if page flipping is not used (implies blitting)
Throws:
IllegalArgumentException - if frontCaps or backCaps are null
Method Detail

getFrontBufferCapabilities

public ImageCapabilities getFrontBufferCapabilities()
Returns:
the image capabilities of the front (displayed) buffer

getBackBufferCapabilities

public ImageCapabilities getBackBufferCapabilities()
Returns:
the image capabilities of all back buffers (intermediate buffers are considered back buffers)

isPageFlipping

public boolean isPageFlipping()
Returns:
whether or not the buffer strategy uses page flipping; a set of buffers that uses page flipping can swap the contents internally between the front buffer and one or more back buffers by switching the video pointer (or by copying memory internally). A non-flipping set of buffers uses blitting to copy the contents from one buffer to another; when this is the case, getFlipContents returns null

getFlipContents

public BufferCapabilities.FlipContents getFlipContents()
Returns:
the resulting contents of the back buffer after page-flipping. This value is null when the isPageFlipping returns false, implying blitting. It can be one of FlipContents.UNDEFINED (the assumed default), FlipContents.BACKGROUND, FlipContents.PRIOR, or FlipContents.COPIED.
See Also:
isPageFlipping(), BufferCapabilities.FlipContents.UNDEFINED, BufferCapabilities.FlipContents.BACKGROUND, BufferCapabilities.FlipContents.PRIOR, BufferCapabilities.FlipContents.COPIED

isFullScreenRequired

public boolean isFullScreenRequired()
Returns:
whether page flipping is only available in full-screen mode. If this is true, full-screen exclusive mode is required for page-flipping.
See Also:
isPageFlipping(), GraphicsDevice.setFullScreenWindow(java.awt.Window)

isMultiBufferAvailable

public boolean isMultiBufferAvailable()
Returns:
whether or not page flipping can be performed using more than two buffers (one or more intermediate buffers as well as the front and back buffer).
See Also:
isPageFlipping()

clone

public Object clone()
Description copied from class: Object
clone creates a shallow clone of this.

Overrides:
clone in class Object
Returns:
a copy of this BufferCapabilities object.

aicas logoJamaica 6.1 release 1

aicas GmbH, Karlsruhe, Germany —www.aicas.com
Copyright © 2001-2012 aicas GmbH. All Rights Reserved.