/*
 * java-gnome, a UI library for writing GTK and GNOME programs from Java!
 *
 * Copyright © 2007-2010 Operational Dynamics Consulting, Pty Ltd
 *
 * The code in this file, and the program it is a part of, is made available
 * to you by its authors as open source software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License version
 * 2 ("GPL") as published by the Free Software Foundation.
 *
 * 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 GPL for more details.
 *
 * You should have received a copy of the GPL along with this program. If not,
 * see http://www.gnu.org/licenses/. The authors of this program may be
 * contacted through http://java-gnome.sourceforge.net/.
 *
 * Linking this library statically or dynamically with other modules is making
 * a combined work based on this library. Thus, the terms and conditions of
 * the GPL cover the whole combination. As a special exception (the
 * "Claspath Exception"), the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent modules,
 * and to copy and distribute the resulting executable under terms of your
 * choice, provided that you also meet, for each linked independent module,
 * the terms and conditions of the license of that module. An independent
 * module is a module which is not derived from or based on this library. If
 * you modify this library, you may extend the Classpath Exception to your
 * version of the library, but you are not obligated to do so. If you do not
 * wish to do so, delete this exception statement from your version.
 */
package org.freedesktop.cairo;

import org.freedesktop.bindings.Constant;

/**
 * Constants specifying what the bit depth of the pixels in an ImageSurface.
 * 
 * @author Andrew Cowie
 * @since 4.0.7
 */
/*
 * TODO do we need to ramble on about bit orders, pre multiplication of alpha
 * in ARGB, etc?
 */
public class Format extends Constant
{
    private Format(int ordinal, String nickname) {
        super(ordinal, nickname);
    }

    /**
     * 32 bits per pixel, being 8 bits for each of red, green, blue,
     * <i>and</i> and 8 bit alpha (transparency) channel. This is the standard
     * choice for most work.
     */
    public static final Format ARGB32 = new Format(CairoFormat.ARGB32, "ARGB32");

    /**
     * 24 bits per pixel, being 8 bits in each of red, green, and blue. No
     * alpha channel.
     */
    public static final Format RGB24 = new Format(CairoFormat.RGB24, "RGB24");

    /**
     * 8 bits per pixel, holding an alpha value (only).
     */
    public static final Format A8 = new Format(CairoFormat.A8, "A8");

    /**
     * A traditional bitmask with a 1 bit alpha value (on or off).
     */
    public static final Format A1 = new Format(CairoFormat.A1, "A1");
}