1 /*
   2  * Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package sun.java2d.pipe.hw;
  27 
  28 import java.awt.Rectangle;
  29 import sun.java2d.Surface;
  30 
  31 import java.lang.annotation.Native;
  32 
  33 /**
  34  * Abstraction for a hardware accelerated surface.
  35  */
  36 public interface AccelSurface extends BufferedContextProvider, Surface {
  37     /**
  38      * Undefined
  39      */
  40     @Native public static final int UNDEFINED       = 0;
  41     /**
  42      * Window (or window substitute) surface
  43      */
  44     @Native public static final int WINDOW          = 1;
  45     /**
  46      * Render-To Plain surface (Render Target surface for Direct3D)

  47      */
  48     @Native public static final int RT_PLAIN        = 2;
  49     /**
  50      * Texture surface
  51      */
  52     @Native public static final int TEXTURE         = 3;
  53     /**
  54      * A back-buffer surface (SwapChain surface for Direct3D, backbuffer for
  55      * OpenGL)
  56      */
  57     @Native public static final int FLIP_BACKBUFFER = 4;
  58     /**
  59      * Render-To Texture surface (fbobject for OpenGL, texture with render-to
  60      * attribute for Direct3D)
  61      */
  62     @Native public static final int RT_TEXTURE      = 5;
  63 
  64     /**
  65      * Returns {@code int} representing surface's type as defined by constants
  66      * in this interface.
  67      *
  68      * @return an integer representing this surface's type
  69      * @see AccelSurface#UNDEFINED
  70      * @see AccelSurface#WINDOW
  71      * @see AccelSurface#RT_PLAIN
  72      * @see AccelSurface#TEXTURE
  73      * @see AccelSurface#FLIP_BACKBUFFER
  74      * @see AccelSurface#RT_TEXTURE
  75      */
  76     public int getType();
  77 
  78     /**
  79      * Returns a pointer to the native surface data associated with this
  80      * surface.
  81      * Note: this pointer is only valid on the rendering thread.
  82      *
  83      * @return pointer to the native surface's data
  84      */
  85     public long getNativeOps();
  86 
  87     /**
  88      * Returns a pointer to the real native resource
  89      * of the specified type associated with this AccelSurface.
  90      * Note: this pointer is only valid on the rendering thread.
  91      *
  92      * @param resType the type of the requested resource
  93      * @return a long containing a pointer to the native resource of the
  94      * specified type or 0L if such resource doesn't exist for this surface
  95      */
  96     public long getNativeResource(int resType);
  97 
  98     /**
  99      * Marks this surface dirty.
 100      */
 101     public void markDirty();
 102 
 103     /**
 104      * Returns whether the pipeline considers this surface valid. A surface
 105      * may become invalid if it is disposed of, or resized.
 106      *
 107      * @return true if valid, false otherwise
 108      */
 109     public boolean isValid();
 110 
 111     /**
 112      * Returns whether this surface is lost. The return value is only valid
 113      * on the render thread, meaning that even if this method returns
 114      * {@code true} it could be lost in the next moment unless it is called
 115      * on the rendering thread.
 116      *
 117      * @return true if the surface is known to be lost, false otherwise
 118      */
 119     public boolean isSurfaceLost();
 120 
 121     /**
 122      * Returns the requested bounds of the destination surface. The real bounds
 123      * of the native accelerated surface may differ. Use
 124      * {@link #getNativeBounds} to get the bounds of the native surface.
 125      *
 126      * @return Rectangle representing java surface's bounds
 127      */
 128     public Rectangle getBounds();
 129 
 130     /**
 131      * Returns real bounds of the native surface, which may differ from those
 132      * returned by {@link #getBounds}.
 133      *
 134      * @return Rectangle representing native surface's bounds
 135      */
 136     public Rectangle getNativeBounds();
 137 }
--- EOF ---