aboutsummaryrefslogtreecommitdiff
path: root/src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java')
-rw-r--r--src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java95
1 files changed, 95 insertions, 0 deletions
diff --git a/src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java b/src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java
new file mode 100644
index 000000000..ab799d947
--- /dev/null
+++ b/src/share/classes/sun/java2d/pipe/hw/AccelGraphicsConfig.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2007-2008 Sun Microsystems, Inc. All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package sun.java2d.pipe.hw;
+
+import java.awt.image.VolatileImage;
+
+/**
+ * Implementors of this interface provida a way to create a
+ * {@code VolatileImage} whose destination surface is an
+ * {@link AccelSurface} of specified type.
+ *
+ * @see AccelSurface
+ */
+public interface AccelGraphicsConfig extends BufferedContextProvider {
+ /**
+ * Returns a VolatileImage with specified width, height, transparency
+ * and guaranteed accelerated surface type. If such image can not be created
+ * (out of vram error, specific surface type is not supported) null
+ * is returned.
+ *
+ * Note: if {@link AccelSurface#TEXTURE} type is requested, rendering
+ * to the image will be denied by throwing
+ * {@code UnsupportedOperationException }
+ * from {@link java.awt.image.VolatileImage#getGraphics} and
+ * {@link java.awt.image.VolatileImage#createGraphics}
+ *
+ * @param width the width of the returned {@code VolatileImage}
+ * @param height the height of the returned {@code VolatileImage}
+ * @param transparency the specified transparency mode
+ * @param type requested accelerated surface type as specified by constants
+ * in AccelSurface interface
+ * @return a {@code VolatileImage} backed up by requested accelerated
+ * surface type or null
+ * @throws IllegalArgumentException if the transparency is not a valid value
+ * @see AccelSurface#TEXTURE
+ * @see AccelSurface#RT_PLAIN
+ * @see AccelSurface#RT_TEXTURE
+ */
+ public VolatileImage createCompatibleVolatileImage(int width, int height,
+ int transparency,
+ int type);
+ /**
+ * Returns object representing capabilities of the context associated
+ * with this {@code AccelGraphicsConfig}.
+ *
+ * @return ContextCapabilities object representing caps
+ * @see ContextCapabilities
+ */
+ public ContextCapabilities getContextCapabilities();
+
+ /**
+ * Adds an {@code AccelDeviceEventListener} to listen to accelerated
+ * device's (which is associated with this {@code AccelGraphicsConfig})
+ * events.
+ *
+ * Note: a hard link to the listener may be kept so it must be explicitly
+ * removed via {@link #removeDeviceEventListener()}.
+ *
+ * @param l the listener
+ * @see AccelDeviceEventListener
+ */
+ public void addDeviceEventListener(AccelDeviceEventListener l);
+
+ /**
+ * Removes an {@code AccelDeviceEventListener} from the list of listeners
+ * for this device's events.
+ *
+ * @param l the listener
+ * @see AccelDeviceEventListener
+ */
+ public void removeDeviceEventListener(AccelDeviceEventListener l);
+}