java.awt
Class BufferCapabilities

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.BufferCapabilities
All Implemented Interfaces:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

public class BufferCapabilities
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

Capabilities and properties of buffers.

Since:
1.4
See Also:
BufferStrategy.getCapabilities() sample code for java.awt.image.BufferStrategy.getCapabilities() definition code for java.awt.image.BufferStrategy.getCapabilities() , GraphicsConfiguration.getBufferCapabilities() sample code for java.awt.GraphicsConfiguration.getBufferCapabilities() definition code for java.awt.GraphicsConfiguration.getBufferCapabilities()

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

Constructor Detail

BufferCapabilities sample code for java.awt.BufferCapabilities(java.awt.ImageCapabilities, java.awt.ImageCapabilities, java.awt.BufferCapabilities.FlipContents) definition code for java.awt.BufferCapabilities(java.awt.ImageCapabilities, java.awt.ImageCapabilities, java.awt.BufferCapabilities.FlipContents)

public BufferCapabilities(ImageCapabilities sample code for java.awt.ImageCapabilities definition code for java.awt.ImageCapabilities  frontCaps,
                          ImageCapabilities sample code for java.awt.ImageCapabilities definition code for java.awt.ImageCapabilities  backCaps,
                          BufferCapabilities.FlipContents sample code for java.awt.BufferCapabilities.FlipContents definition code for java.awt.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if frontCaps or backCaps are null
Method Detail

getFrontBufferCapabilities sample code for java.awt.BufferCapabilities.getFrontBufferCapabilities() definition code for java.awt.BufferCapabilities.getFrontBufferCapabilities()

public ImageCapabilities sample code for java.awt.ImageCapabilities definition code for java.awt.ImageCapabilities  getFrontBufferCapabilities()
Returns:
the image capabilities of the front (displayed) buffer

getBackBufferCapabilities sample code for java.awt.BufferCapabilities.getBackBufferCapabilities() definition code for java.awt.BufferCapabilities.getBackBufferCapabilities()

public ImageCapabilities sample code for java.awt.ImageCapabilities definition code for java.awt.ImageCapabilities  getBackBufferCapabilities()
Returns:
the image capabilities of all back buffers (intermediate buffers are considered back buffers)

isPageFlipping sample code for java.awt.BufferCapabilities.isPageFlipping() definition code for java.awt.BufferCapabilities.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 sample code for java.awt.BufferCapabilities.getFlipContents() definition code for java.awt.BufferCapabilities.getFlipContents()

public BufferCapabilities.FlipContents sample code for java.awt.BufferCapabilities.FlipContents definition code for java.awt.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() sample code for java.awt.BufferCapabilities.isPageFlipping() definition code for java.awt.BufferCapabilities.isPageFlipping() , BufferCapabilities.FlipContents.UNDEFINED sample code for java.awt.BufferCapabilities.FlipContents.UNDEFINED definition code for java.awt.BufferCapabilities.FlipContents.UNDEFINED , BufferCapabilities.FlipContents.BACKGROUND sample code for java.awt.BufferCapabilities.FlipContents.BACKGROUND definition code for java.awt.BufferCapabilities.FlipContents.BACKGROUND , BufferCapabilities.FlipContents.PRIOR sample code for java.awt.BufferCapabilities.FlipContents.PRIOR definition code for java.awt.BufferCapabilities.FlipContents.PRIOR , BufferCapabilities.FlipContents.COPIED sample code for java.awt.BufferCapabilities.FlipContents.COPIED definition code for java.awt.BufferCapabilities.FlipContents.COPIED

isFullScreenRequired sample code for java.awt.BufferCapabilities.isFullScreenRequired() definition code for java.awt.BufferCapabilities.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() sample code for java.awt.BufferCapabilities.isPageFlipping() definition code for java.awt.BufferCapabilities.isPageFlipping() , GraphicsDevice.setFullScreenWindow(java.awt.Window) sample code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window) definition code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window)

isMultiBufferAvailable sample code for java.awt.BufferCapabilities.isMultiBufferAvailable() definition code for java.awt.BufferCapabilities.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() sample code for java.awt.BufferCapabilities.isPageFlipping() definition code for java.awt.BufferCapabilities.isPageFlipping()

clone sample code for java.awt.BufferCapabilities.clone() definition code for java.awt.BufferCapabilities.clone()

public Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Description copied from class: Object sample code for java.lang.Object.clone() definition code for java.lang.Object.clone()
Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
 x.clone() != x
will be true, and that the expression:
 x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
 x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a copy of this BufferCapabilities object.
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable