javax.media.nativewindow

## Interface OffscreenLayerOption

- All Known Implementing Classes:
    GLCanvas, JAWTWindow, NewtCanvasAWT

      public interface OffscreenLayerOption

  Handling requests for using an `OffscreenLayerSurface` within the implementation.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `getShallUseOffscreenLayer()` Returns the property set by `setShallUseOffscreenLayer(boolean)`.
    `boolean` | `isOffscreenLayerSurfaceEnabled()` Returns true if this instance uses an offscreen layer, otherwise false.
    `void` | `setShallUseOffscreenLayer(boolean v)` Request an offscreen layer, if supported.

- - ### Method Detail

    - #### setShallUseOffscreenLayer

          void setShallUseOffscreenLayer(boolean v)

      Request an offscreen layer, if supported.

      Shall be called before the first `NativeSurface.lockSurface()`, and hence before realization.

      See Also:
        `getShallUseOffscreenLayer()`, `isOffscreenLayerSurfaceEnabled()`

    - #### getShallUseOffscreenLayer

          boolean getShallUseOffscreenLayer()

      Returns the property set by `setShallUseOffscreenLayer(boolean)`.

    - #### isOffscreenLayerSurfaceEnabled

          boolean isOffscreenLayerSurfaceEnabled()

      Returns true if this instance uses an offscreen layer, otherwise false.

      This instance is an offscreen layer, if `setShallUseOffscreenLayer(true)` has been called before it's realization and first lock and the underlying implementation supports it.

      The return value is undefined before issuing the first `NativeSurface.lockSurface()`.
      See Also:
        `setShallUseOffscreenLayer(boolean)`

Copyright 2010 JogAmp Community.