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