/**

 * Back 2 Browser Bytecode Translator Copyright (C) 2012 Jaroslav Tulach

 * <jaroslav.tulach@apidesign.org>

 *

 * This program is free software: you can redistribute it and/or modify it under

 * the terms of the GNU General Public License as published by the Free Software

 * Foundation, version 2 of the License.

 *

 * This program 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 for more

 * details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program. Look for COPYING file in the top folder. If not, see

 * http://opensource.org/licenses/GPL-2.0.

 */

package net.java.html.canvas.spi;

import net.java.html.canvas.Dimension;

import net.java.html.canvas.Image;

import net.java.html.canvas.ImageData;

import net.java.html.canvas.Style;

/**

 * Provider API for Canvas. Implement this to add support for your platform.

 *

 * @author antonepple

 */

public interface GraphicsEnvironment {

    public void arc(double centerX,

            double centerY,

            double startAngle,

            double radius,

            double endAngle,

            boolean ccw);

    public void arcTo(double x1,

            double y1,

            double x2,

            double y2,

            double r);

    public boolean isPointInPath(double x, double y);

    public void fill();

    public void stroke();

    public void beginPath();

    public void closePath();

    public void clip();

    public void moveTo(double x, double y);

    public void lineTo(double x, double y);

    public void quadraticCurveTo(double cpx, double cpy, double x, double y);

    public void bezierCurveTo(double cp1x, double cp1y, double cp2x, double cp2y, double x, double y);

    public void fillRect(double x, double y, double width, double height);

    public void strokeRect(double x, double y, double width, double height);

    public void clearRect(double x, double y, double width, double height);

    public void rect(double x, double y, double width, double height);

    public void save();

    public void restore();

    public void rotate(double angle);

    public void transform(double a, double b, double c, double d, double e, double f);

    public void setTransform(double a, double b, double c, double d, double e, double f);

    public void translate(double x, double y);

    public void scale(double x, double y);

    public Object drawImage(Image image,  double x, double y, Object nativeImage);

    public Object drawImage(Image image, double x, double y, double width, double height, Object nativeImage);

    public Object drawImage(Image image, double sx, double sy, double sWidth, double sHeight, double x, double y, double width, double height, Object nativeImage);

    public int getWidth(Image image, Object nativeImage);

    public int getHeight(Image image, Object nativeImage);

    /**

     * When implementing you can return an Object of your choice to enable

     * caching. Returning null means no caching. When caching is enabled, and

     * the cache hasn't been invalidated, the Object you returned will be passed

     * as a parameter.

     *

     * @param style The style object you should use to create your native style

     * @param nativeStyle your native object if cached, null otherwise

     * @return return native Object for caching

     *

     */

    public Object setFillStyle(Style style, Object nativeStyle);

    /**

     * When implementing you can return an Object of your choice to enable

     * caching. Returning null means no caching. When caching is enabled, and

     * the cache hasn't been invalidated, the Object you returned will be passed

     * as a parameter.

     *

     * @param style The style object you should use to create your native style

     * @param nativeStyle your native object if cached, null otherwise

     * @return return native Object for caching

     *

     */

    public Object setStrokeStyle(Style style, Object nativeStyle);

    public void setShadowColor(String color);

    public void setShadowBlur(double blur);

    public void setShadowOffsetX(double x);

    public void setShadowOffsetY(double y);

    public String getShadowColor();

    public double getShadowBlur();

    public double getShadowOffsetX();

    public double getShadowOffsetY();

    public String getLineCap();

    public void setLineCap(String style);

    public String getLineJoin();

    public void setLineJoin(String style);

    public double getLineWidth();

    public void setLineWidth(double width);

    public double getMiterLimit();

    public void setMiterLimit(double limit);

    public String getFont();

    public void setFont(String font);

    public String getTextAlign();

    public void setTextAlign(String textAlign);

    public String getTextBaseline();

    public void setTextBaseline(String textbaseline);

    public void fillText(String text, double x, double y);

    public void fillText(String text, double x, double y, double maxWidth);

    public Dimension measureText(String text);

    public void strokeText(String text, double x, double y);

    public void strokeText(String text, double x, double y, double maxWidth);

    public ImageData createPixelMap(double x, double y);

    public ImageData createPixelMap(ImageData imageData);

    public ImageData getPixelMap(double x, double y, double width, double height);

    public void putPixelMap(ImageData imageData, double x, double y);

    public void putPixelMap(ImageData imageData, double x, double y, double dirtyx, double dirtyy, double dirtywidth, double dirtyheight);

    public void setGlobalAlpha(double alpha);

    public double getGlobalAlpha();

    public void setGlobalCompositeOperation(String operation);

    public String getGlobalCompositeOperation();

    public int getHeight();

    public int getWidth();

    public void setHeight(int height);

    public void setWidth(int width);

    public Object mergeImages(Image a, Image b, Object cachedA, Object cachedB);

}