/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = gdk-Images.html
 * outPack = gdk
 * outFile = ImageGdk
 * strct   = GdkImage
 * realStrct=
 * ctorStrct=
 * clss    = ImageGdk
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gdk_image_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- gdk.Visual
 * 	- gdk.Drawable
 * 	- gdk.Colormap
 * structWrap:
 * 	- GdkColormap* -> Colormap
 * 	- GdkDrawable* -> Drawable
 * 	- GdkImage* -> ImageGdk
 * 	- GdkVisual* -> Visual
 * module aliases:
 * local aliases:
 * overrides:
 */

module gdk.ImageGdk;

public  import gtkc.gdktypes;

private import gtkc.gdk;
private import glib.ConstructionException;
private import gobject.ObjectG;


private import gdk.Visual;
private import gdk.Drawable;
private import gdk.Colormap;




/**
 * Description
 * The GdkImage type represents an area for drawing graphics.
 * It has now been superceded to a large extent by the much more flexible
 * GdkRGB functions.
 * To create an empty GdkImage use gdk_image_new().
 * To create a GdkImage from bitmap data use gdk_image_new_bitmap().
 * To create an image from part of a GdkWindow use gdk_drawable_get_image().
 * The image can be manipulated with gdk_image_get_pixel() and
 * gdk_image_put_pixel(), or alternatively by changing the actual pixel data.
 * Though manipulating the pixel data requires complicated code to cope with
 * the different formats that may be used.
 * To draw a GdkImage in a GdkWindow or GdkPixmap use gdk_draw_image().
 * To destroy a GdkImage use gdk_image_destroy().
 */
public class ImageGdk
{
	
	/** the main Gtk struct */
	protected GdkImage* gdkImage;
	
	
	public GdkImage* getImageGdkStruct()
	{
		return gdkImage;
	}
	
	
	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)gdkImage;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GdkImage* gdkImage)
	{
		this.gdkImage = gdkImage;
	}
	
	/**
	 */
	
	/**
	 * Warning
	 * gdk_image_new is deprecated and should not be used in newly-written code.
	 * Creates a new GdkImage.
	 * Params:
	 * type = the type of the GdkImage, one of GDK_IMAGE_NORMAL, GDK_IMAGE_SHARED
	 * and GDK_IMAGE_FASTEST. GDK_IMAGE_FASTEST is probably the best choice, since
	 * it will try creating a GDK_IMAGE_SHARED image first and if that fails it will
	 * then use GDK_IMAGE_NORMAL.
	 * visual = the GdkVisual to use for the image.
	 * width = the width of the image in pixels.
	 * height = the height of the image in pixels.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this (GdkImageType type, Visual visual, int width, int height)
	{
		// GdkImage * gdk_image_new (GdkImageType type,  GdkVisual *visual,  gint width,  gint height);
		auto p = gdk_image_new(type, (visual is null) ? null : visual.getVisualStruct(), width, height);
		if(p is null)
		{
			throw new ConstructionException("null returned by gdk_image_new(type, (visual is null) ? null : visual.getVisualStruct(), width, height)");
		}
		this(cast(GdkImage*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_new_bitmap is deprecated and should not be used in newly-written code.
	 * Creates a new GdkImage with a depth of 1 from the given data.
	 * Warning
	 * THIS FUNCTION IS INCREDIBLY BROKEN. The passed-in data must
	 * be allocated by malloc() (NOT g_malloc()) and will be freed when the
	 * image is freed.
	 * Params:
	 * visual = the GdkVisual to use for the image.
	 * data = the pixel data.
	 * width = the width of the image in pixels.
	 * height = the height of the image in pixels.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this (Visual visual, void* data, int width, int height)
	{
		// GdkImage * gdk_image_new_bitmap (GdkVisual *visual,  gpointer data,  gint width,  gint height);
		auto p = gdk_image_new_bitmap((visual is null) ? null : visual.getVisualStruct(), data, width, height);
		if(p is null)
		{
			throw new ConstructionException("null returned by gdk_image_new_bitmap((visual is null) ? null : visual.getVisualStruct(), data, width, height)");
		}
		this(cast(GdkImage*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_get is deprecated and should not be used in newly-written code.
	 * This is a deprecated wrapper for gdk_drawable_get_image();
	 * gdk_drawable_get_image() should be used instead. Or even better: in
	 * most cases gdk_pixbuf_get_from_drawable() is the most convenient
	 * choice.
	 * Params:
	 * drawable = a GdkDrawable
	 * x = x coordinate in window
	 * y = y coordinate in window
	 * width = width of area in window
	 * height = height of area in window
	 * Returns: a new GdkImage or NULL
	 */
	public static ImageGdk get(Drawable drawable, int x, int y, int width, int height)
	{
		// GdkImage * gdk_image_get (GdkDrawable *drawable,  gint x,  gint y,  gint width,  gint height);
		auto p = gdk_image_get((drawable is null) ? null : drawable.getDrawableStruct(), x, y, width, height);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ImageGdk)(cast(GdkImage*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_ref has been deprecated since version 2.0 and should not be used in newly-written code. Use g_object_ref() instead.
	 * Deprecated function; use g_object_ref() instead.
	 * Returns: the image
	 */
	public ImageGdk doref()
	{
		// GdkImage * gdk_image_ref (GdkImage *image);
		auto p = gdk_image_ref(gdkImage);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ImageGdk)(cast(GdkImage*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_unref has been deprecated since version 2.0 and should not be used in newly-written code. Use g_object_unref() instead.
	 * Deprecated function; use g_object_unref() instead.
	 */
	public void unref()
	{
		// void gdk_image_unref (GdkImage *image);
		gdk_image_unref(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_colormap has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Retrieves the colormap for a given image, if it exists. An image
	 * will have a colormap if the drawable from which it was created has
	 * a colormap, or if a colormap was set explicitely with
	 * gdk_image_set_colormap().
	 * Returns: colormap for the image
	 */
	public Colormap getColormap()
	{
		// GdkColormap * gdk_image_get_colormap (GdkImage *image);
		auto p = gdk_image_get_colormap(gdkImage);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Colormap)(cast(GdkColormap*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_set_colormap has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Sets the colormap for the image to the given colormap. Normally
	 * there's no need to use this function, images are created with the
	 * correct colormap if you get the image from a drawable. If you
	 * create the image from scratch, use the colormap of the drawable you
	 * intend to render the image to.
	 * Params:
	 * colormap = a GdkColormap
	 */
	public void setColormap(Colormap colormap)
	{
		// void gdk_image_set_colormap (GdkImage *image,  GdkColormap *colormap);
		gdk_image_set_colormap(gdkImage, (colormap is null) ? null : colormap.getColormapStruct());
	}
	
	/**
	 * Warning
	 * gdk_image_get_bits_per_pixel has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the number of bits per pixel of the image.
	 * Since 2.22
	 * Returns: the bits per pixel
	 */
	public ushort getBitsPerPixel()
	{
		// guint16 gdk_image_get_bits_per_pixel (GdkImage *image);
		return gdk_image_get_bits_per_pixel(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_bytes_per_pixel has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the number of bytes per pixel of the image.
	 * Since 2.22
	 * Returns: the bytes per pixel
	 */
	public ushort getBytesPerPixel()
	{
		// guint16 gdk_image_get_bytes_per_pixel (GdkImage *image);
		return gdk_image_get_bytes_per_pixel(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_bytes_per_line has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the number of bytes per line of the image.
	 * Since 2.22
	 * Returns: the bytes per line
	 */
	public ushort getBytesPerLine()
	{
		// guint16 gdk_image_get_bytes_per_line (GdkImage *image);
		return gdk_image_get_bytes_per_line(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_byte_order has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the byte order of the image.
	 * Since 2.22
	 * Returns: a GdkVisual
	 */
	public GdkByteOrder getByteOrder()
	{
		// GdkByteOrder gdk_image_get_byte_order (GdkImage *image);
		return gdk_image_get_byte_order(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_depth has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the depth of the image.
	 * Since 2.22
	 * Returns: the depth
	 */
	public ushort getDepth()
	{
		// guint16 gdk_image_get_depth (GdkImage *image);
		return gdk_image_get_depth(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_height has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the height of the image.
	 * Since 2.22
	 * Returns: the height
	 */
	public int getHeight()
	{
		// gint gdk_image_get_height (GdkImage *image);
		return gdk_image_get_height(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_image_type has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the type of a given image.
	 * Since 2.22
	 * Returns: the GdkImageType of the image
	 */
	public GdkImageType getImageType()
	{
		// GdkImageType gdk_image_get_image_type (GdkImage *image);
		return gdk_image_get_image_type(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_visual has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the visual that was used to create the image.
	 * Since 2.22
	 * Returns: a GdkVisual
	 */
	public Visual getVisual()
	{
		// GdkVisual * gdk_image_get_visual (GdkImage *image);
		auto p = gdk_image_get_visual(gdkImage);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Visual)(cast(GdkVisual*) p);
	}
	
	/**
	 * Warning
	 * gdk_image_get_width has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Determines the width of the image.
	 * Since 2.22
	 * Returns: the width
	 */
	public int getWidth()
	{
		// gint gdk_image_get_width (GdkImage *image);
		return gdk_image_get_width(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_get_pixels has been deprecated since version 2.22 and should not be used in newly-written code. GdkImage should not be used anymore.
	 * Returns a pointer to the pixel data of the image.
	 * Since 2.22
	 * Returns: the pixel data of the image
	 */
	public void* getPixels()
	{
		// gpointer gdk_image_get_pixels (GdkImage *image);
		return gdk_image_get_pixels(gdkImage);
	}
	
	/**
	 * Warning
	 * gdk_image_put_pixel is deprecated and should not be used in newly-written code.
	 * Sets a pixel in a GdkImage to a given pixel value.
	 * Params:
	 * x = the x coordinate of the pixel to set.
	 * y = the y coordinate of the pixel to set.
	 * pixel = the pixel value to set.
	 */
	public void putPixel(int x, int y, uint pixel)
	{
		// void gdk_image_put_pixel (GdkImage *image,  gint x,  gint y,  guint32 pixel);
		gdk_image_put_pixel(gdkImage, x, y, pixel);
	}
	
	/**
	 * Warning
	 * gdk_image_get_pixel is deprecated and should not be used in newly-written code.
	 * Gets a pixel value at a specified position in a GdkImage.
	 * Params:
	 * x = the x coordinate of the pixel to get.
	 * y = the y coordinate of the pixel to get.
	 * Returns: the pixel value at the given position.
	 */
	public uint getPixel(int x, int y)
	{
		// guint32 gdk_image_get_pixel (GdkImage *image,  gint x,  gint y);
		return gdk_image_get_pixel(gdkImage, x, y);
	}
}