APIdia Launch Partner
Top Description Inners Fields Constructors Methods
sun.java2d.pipe.hw

public Class ExtendedBufferCapabilities

extends BufferCapabilities
Class Inheritance
Known Direct Subclasses
java.awt.Component.ProxyCapabilities
Imports
java.awt.BufferCapabilities, .ImageCapabilities

Provides extended BufferStrategy capabilities, allowing to specify the type of vertical refresh synchronization for a buffer strategy. This BS capability is always page flipping because v-sync is only relevant to flipping buffer strategies. Note that asking for a v-synced BS doesn't necessarily guarantee that it will be v-synced since the vsync capability may be disabled in the driver, or there may be other restriction (like a number of v-synced buffer strategies allowed per vm). Because of this createBufferStrategy doesn't throw AWTException when a v-synced BS could not be created when requested.
See Also
java.awt.Canvas#createBufferStrategy(int, BufferCapabilities), java.awt.Window#createBufferStrategy(int, BufferCapabilities)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ExtendedBufferCapabilities.VSyncType

Type of synchronization on vertical retrace.

Field Summary

Modifier and TypeField and Description
private ExtendedBufferCapabilities.VSyncType

Constructor Summary

AccessConstructor and Description
public
ExtendedBufferCapabilities(BufferCapabilities caps)

Creates an ExtendedBufferCapabilities object with front/back/flip caps from the passed cap, and VSYNC_DEFAULT v-sync mode.

public
ExtendedBufferCapabilities(ImageCapabilities front, ImageCapabilities back, BufferCapabilities.FlipContents flip)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed caps, and VSYNC_DEFAULT v-sync mode.

public
ExtendedBufferCapabilities(ImageCapabilities front, ImageCapabilities back, BufferCapabilities.FlipContents flip, ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed image/flip caps, and the v-sync type.

public
ExtendedBufferCapabilities(BufferCapabilities caps, ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed cap, and the passed v-sync mode.

Method Summary

Modifier and TypeMethod and Description
public ExtendedBufferCapabilities
derive(ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the object, and passed v-sync mode.

public ExtendedBufferCapabilities.VSyncType
getVSync()

Returns the type of v-sync requested by this capabilities instance.

public final boolean
isPageFlipping()

Overrides java.awt.BufferCapabilities.isPageFlipping.

Returns whether or not the buffer strategy uses page flipping.

Inherited from java.awt.BufferCapabilities:
clonegetBackBufferCapabilitiesgetFlipContentsgetFrontBufferCapabilitiesisFullScreenRequiredisMultiBufferAvailable

Field Detail

vsyncback to summary
private ExtendedBufferCapabilities.VSyncType vsync

Constructor Detail

ExtendedBufferCapabilitiesback to summary
public ExtendedBufferCapabilities(BufferCapabilities caps)

Creates an ExtendedBufferCapabilities object with front/back/flip caps from the passed cap, and VSYNC_DEFAULT v-sync mode.

ExtendedBufferCapabilitiesback to summary
public ExtendedBufferCapabilities(ImageCapabilities front, ImageCapabilities back, BufferCapabilities.FlipContents flip)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed caps, and VSYNC_DEFAULT v-sync mode.

ExtendedBufferCapabilitiesback to summary
public ExtendedBufferCapabilities(ImageCapabilities front, ImageCapabilities back, BufferCapabilities.FlipContents flip, ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed image/flip caps, and the v-sync type.

ExtendedBufferCapabilitiesback to summary
public ExtendedBufferCapabilities(BufferCapabilities caps, ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the passed cap, and the passed v-sync mode.

Method Detail

deriveback to summary
public ExtendedBufferCapabilities derive(ExtendedBufferCapabilities.VSyncType t)

Creates an ExtendedBufferCapabilities instance with front/back/flip caps from the object, and passed v-sync mode.

getVSyncback to summary
public ExtendedBufferCapabilities.VSyncType getVSync()

Returns the type of v-sync requested by this capabilities instance.

isPageFlippingback to summary
public final boolean isPageFlipping()

Overrides java.awt.BufferCapabilities.isPageFlipping.

Doc from java.awt.BufferCapabilities.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.

Annotations
@Override
sun.java2d.pipe.hw back to summary

public final Enum ExtendedBufferCapabilities.VSyncType

extends Enum<ExtendedBufferCapabilities.VSyncType>
Class Inheritance

Type of synchronization on vertical retrace.

Field Summary

Modifier and TypeField and Description
private int
public static final ExtendedBufferCapabilities.VSyncType
VSYNC_DEFAULT

Use the default v-sync mode appropriate for given BufferStrategy and situation.

public static final ExtendedBufferCapabilities.VSyncType
VSYNC_OFF

Do not synchronize flip on vertical retrace.

public static final ExtendedBufferCapabilities.VSyncType
VSYNC_ON

Synchronize flip on vertical retrace.

Constructor Summary

AccessConstructor and Description
private
VSyncType(int id)

Method Summary

Modifier and TypeMethod and Description
public int
id()

Used to identify the v-sync type (independent of the constants order as opposed to ordinal()).

public static ExtendedBufferCapabilities.VSyncType
public static ExtendedBufferCapabilities.VSyncType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

idback to summary
private int id
VSYNC_DEFAULTback to summary
public static final ExtendedBufferCapabilities.VSyncType VSYNC_DEFAULT

Use the default v-sync mode appropriate for given BufferStrategy and situation.

VSYNC_OFFback to summary
public static final ExtendedBufferCapabilities.VSyncType VSYNC_OFF

Do not synchronize flip on vertical retrace.

VSYNC_ONback to summary
public static final ExtendedBufferCapabilities.VSyncType VSYNC_ON

Synchronize flip on vertical retrace.

Constructor Detail

VSyncTypeback to summary
private VSyncType(int id)

Method Detail

idback to summary
public int id()

Used to identify the v-sync type (independent of the constants order as opposed to ordinal()).

valueOfback to summary
public static ExtendedBufferCapabilities.VSyncType valueOf(String name)
valuesback to summary
public static ExtendedBufferCapabilities.VSyncType[] values()