/*
 * Copyright (c) 2007, 2008, Oracle and/or its affiliates. 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.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 VolatileImage whose destination surface is an AccelSurface of specified type. 
See Also:
AccelSurface/**
 * 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 AccelSurface.TEXTURE type is requested, rendering to the image will be denied by throwing UnsupportedOperationException  from VolatileImage.getGraphics and VolatileImage.createGraphics 
Params:
width – the width of the returned VolatileImage
height – the height of the returned VolatileImage
transparency – the specified transparency mode
type – requested accelerated surface type as specified by constants
in AccelSurface interface
Throws:
IllegalArgumentException – if the transparency is not a valid value
See Also:
AccelSurface.TEXTURE
AccelSurface.RT_PLAIN
AccelSurface.RT_TEXTURE
Returns:
a VolatileImage backed up by requested accelerated surface type or null/**
     * 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 AccelGraphicsConfig. 
See Also:
ContextCapabilities
Returns:
ContextCapabilities object representing caps/**
     * Returns object representing capabilities of the context associated
     * with this {@code AccelGraphicsConfig}.
     *
     * @return ContextCapabilities object representing caps
     * @see ContextCapabilities
     */
    public ContextCapabilities getContextCapabilities();

    
Adds an AccelDeviceEventListener to listen to accelerated device's (which is associated with this AccelGraphicsConfig) events. Note: a hard link to the listener may be kept so it must be explicitly removed via removeDeviceEventListener(). 
Params:
l – the listener
See Also:
AccelDeviceEventListener/**
     * 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 AccelDeviceEventListener from the list of listeners for this device's events. 
Params:
l – the listener
See Also:
AccelDeviceEventListener/**
     * 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);
}