gml_Drawable.h

Go to the documentation of this file.
00001 /**
00002  * @file gml_Drawable.h
00003  *
00004  *    Wrapper of platform dependent "Drawable" structures (i.e. onscreen or
00005  *    offscreen bitmaps).
00006  *
00007  *  Copyright (c) 2003 CLIPS-IMAG
00008  *
00009  *  See the file "gml_LicenseTerms.txt" for information on usage and redistribution
00010  *  of this file, and for a DISCLAIMER OF ALL WARRANTIES.
00011  *
00012  *  Created on April 4, 2003 (FB).
00013  */
00014 #ifndef __GMLDRAWABLE__
00015 #define __GMLDRAWABLE__
00016 
00017 #include "gml/base/gml_Types.h"
00018 
00019 /**
00020  * gml_TDrawable --
00021  *
00022  *  A pointer to a native drawing port structure.
00023  *  On Mac OS X, this is a "CGrafPtr".
00024  *  On X11, this is a "Drawable".
00025  */
00026 typedef void* gml_TDrawable;
00027 
00028 /**
00029  * gml_TDisplay --
00030  *
00031  *  A pointer to a native display structure.
00032  *  (non-NULL only under X-Windows)
00033  */
00034 typedef void* gml_TDisplay;
00035 
00036 /**
00037  * gml_TVisual --
00038  *
00039  *  A pointer to a native visual structure.
00040  *  (non-NULL only under X-Windows)
00041  */
00042 typedef void* gml_TVisual;
00043 
00044 
00045 /**
00046  * gml_DrawableSize --
00047  *
00048  *  Returns the width and height of a drawable.
00049  *  Does not count the size of the window decoration (window title, borders)
00050  *  if the drawable is a window.
00051  */
00052 GML_EXTERN_C
00053 void gml_DrawableSize (gml_TDisplay display, gml_TDrawable drawable, int* width, int* height);
00054 
00055 
00056 #endif