d5fc87c16f6e8490cfe66611f2ca568fa17f69f2
[blender.git] / intern / ghost / GHOST_C-api.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31 /**
32  * @file        GHOST_C-api.h
33  * GHOST C-API function and type declarations.
34  * The C-API wraps the C++ objects with the 
35  */
36
37 #ifndef GHOST_C_API_H
38 #define GHOST_C_API_H
39
40 #include "GHOST_Types.h"
41
42 #ifdef __cplusplus
43 extern "C" { 
44 #endif
45
46 /**
47  * Creates a "handle" for a C++ GHOST object.
48  * A handle is just an opaque pointer to an empty struct.
49  * In the API the pointer is casted to the actual C++ class.
50  * @param       name    Name of the handle to create.
51  */
52 #define GHOST_DECLARE_HANDLE(name) typedef struct name##__ { int unused; } *name
53
54 GHOST_DECLARE_HANDLE(GHOST_SystemHandle);
55 GHOST_DECLARE_HANDLE(GHOST_TimerTaskHandle);
56 GHOST_DECLARE_HANDLE(GHOST_WindowHandle);
57 GHOST_DECLARE_HANDLE(GHOST_EventHandle);
58 GHOST_DECLARE_HANDLE(GHOST_RectangleHandle);
59 GHOST_DECLARE_HANDLE(GHOST_EventConsumerHandle);
60
61
62 /**
63  * Definition of a callback routine that receives events.
64  * @param event The event received.
65  * @param userdata The callback's user data, supplied to GHOST_CreateSystem.
66  */
67 typedef int (*GHOST_EventCallbackProcPtr)(GHOST_EventHandle event, GHOST_TUserDataPtr userdata);
68
69
70 /**
71  * Creates the one and only system.
72  * @return a handle to the system.
73  */
74 extern GHOST_SystemHandle GHOST_CreateSystem(void);
75
76 /**
77  * Disposes the one and only system.
78  * @param systemhandle The handle to the system
79  * @return An indication of success.
80  */
81 extern GHOST_TSuccess GHOST_DisposeSystem(GHOST_SystemHandle systemhandle);
82
83
84 /**
85  * Creates an event consumer object
86  * @param eventCallback The event callback routine.
87  * @param userdata              Pointer to user data returned to the callback routine.
88  */
89 extern GHOST_EventConsumerHandle GHOST_CreateEventConsumer(GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userdata);
90
91 /**
92  * Disposes an event consumer object
93  * @param consumerhandle        Handle to the event consumer.
94  * @return An indication of success.
95  */
96 extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consumerhandle);
97
98
99 /**
100  * Returns the system time.
101  * Returns the number of milliseconds since the start of the system process.
102  * Based on ANSI clock() routine.
103  * @param systemhandle The handle to the system
104  * @return The number of milliseconds.
105  */
106 extern GHOST_TUns64 GHOST_GetMilliSeconds(GHOST_SystemHandle systemhandle);
107
108 /**
109  * Installs a timer.
110  * Note that, on most operating systems, messages need to be processed in order 
111  * for the timer callbacks to be invoked.
112  * @param systemhandle The handle to the system
113  * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
114  * @param interval      The interval between calls to the timerProc (in milliseconds)
115  * @param timerProc     The callback invoked when the interval expires,
116  * @param userData      Placeholder for user data.
117  * @return A timer task (0 if timer task installation failed).
118  */
119 extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle,
120                                                                                                 GHOST_TUns64 delay,
121                                                                                                 GHOST_TUns64 interval,
122                                                                                                 GHOST_TimerProcPtr timerProc,
123                                                                                                 GHOST_TUserDataPtr userData);
124
125 /**
126  * Removes a timer.
127  * @param systemhandle The handle to the system
128  * @param timerTask Timer task to be removed.
129  * @return Indication of success.
130  */
131 extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle,
132                                                                                 GHOST_TimerTaskHandle timertaskhandle);
133
134 /***************************************************************************************
135  ** Display/window management functionality
136  ***************************************************************************************/
137
138 /**
139  * Returns the number of displays on this system.
140  * @param systemhandle The handle to the system
141  * @return The number of displays.
142  */
143 extern GHOST_TUns8 GHOST_GetNumDisplays(GHOST_SystemHandle systemhandle);
144
145 /**
146  * Returns the dimensions of the main display on this system.
147  * @param systemhandle The handle to the system
148  * @param width         A pointer the width gets put in
149  * @param height        A pointer the height gets put in
150  * @return void.
151  */
152 extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle,
153                                                                                    GHOST_TUns32* width,
154                                                                                    GHOST_TUns32* height);
155
156 /**
157  * Create a new window.
158  * The new window is added to the list of windows managed. 
159  * Never explicitly delete the window, use disposeWindow() instead.
160  * @param systemhandle The handle to the system
161  * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
162  * @param       left    The coordinate of the left edge of the window.
163  * @param       top             The coordinate of the top edge of the window.
164  * @param       width   The width the window.
165  * @param       height  The height the window.
166  * @param       state   The state of the window when opened.
167  * @param       type    The type of drawing context installed in this window.
168  * @return      A handle to the new window ( == NULL if creation failed).
169  */
170 extern GHOST_WindowHandle GHOST_CreateWindow(GHOST_SystemHandle systemhandle,
171         char* title,
172         GHOST_TInt32 left,
173         GHOST_TInt32 top,
174         GHOST_TUns32 width,
175         GHOST_TUns32 height,
176         GHOST_TWindowState state,
177         GHOST_TDrawingContextType type,
178         const int stereoVisual);
179
180 /**
181  * Returns the window user data.
182  * @param windowhandle  The handle to the window
183  * @return The window user data.
184  */
185 extern GHOST_TUserDataPtr GHOST_GetWindowUserData(GHOST_WindowHandle windowhandle);
186         
187 /**
188  * Changes the window user data.
189  * @param windowhandle  The handle to the window
190  * @param data The window user data.
191  */
192 extern void GHOST_SetWindowUserData(GHOST_WindowHandle windowhandle, 
193         GHOST_TUserDataPtr userdata);
194
195 /**
196  * Dispose a window.
197  * @param systemhandle The handle to the system
198  * @param       window Handle to the window to be disposed.
199  * @return      Indication of success.
200  */
201 extern GHOST_TSuccess GHOST_DisposeWindow(GHOST_SystemHandle systemhandle,
202                                                                                   GHOST_WindowHandle windowhandle);
203
204 /**
205  * Returns whether a window is valid.
206  * @param systemhandle The handle to the system
207  * @param       window Handle to the window to be checked.
208  * @return      Indication of validity.
209  */
210 extern int GHOST_ValidWindow(GHOST_SystemHandle systemhandle,
211                                                                                 GHOST_WindowHandle windowhandle);
212
213 /**
214  * Begins full screen mode.
215  * @param systemhandle The handle to the system
216  * @param setting       The new setting of the display.
217  * @return                      A handle to the window displayed in full screen.
218  *                                      This window is invalid after full screen has been ended.
219  */
220 extern GHOST_WindowHandle GHOST_BeginFullScreen(GHOST_SystemHandle systemhandle,
221         GHOST_DisplaySetting* setting,
222         const int stereoVisual);
223
224 /**
225  * Ends full screen mode.
226  * @param systemhandle The handle to the system
227  * @return      Indication of success.
228  */
229 extern GHOST_TSuccess GHOST_EndFullScreen(GHOST_SystemHandle systemhandle);
230
231 /**
232  * Returns current full screen mode status.
233  * @param systemhandle The handle to the system
234  * @return The current status.
235  */
236 extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle);
237
238 /***************************************************************************************
239  ** Event management functionality
240  ***************************************************************************************/
241
242 /**
243  * Retrieves events from the system and stores them in the queue.
244  * @param systemhandle The handle to the system
245  * @param waitForEvent Boolean to indicate that ProcessEvents should
246  * wait (block) until the next event before returning.
247  * @return Indication of the presence of events.
248  */
249 extern int GHOST_ProcessEvents(GHOST_SystemHandle systemhandle, int waitForEvent);
250
251 /**
252  * Retrieves events from the queue and send them to the event consumers.
253  * @param systemhandle The handle to the system
254  * @return Indication of the presence of events.
255  */
256 extern int GHOST_DispatchEvents(GHOST_SystemHandle systemhandle);
257
258 /**
259  * Adds the given event consumer to our list.
260  * @param systemhandle The handle to the system
261  * @param consumerhandle The event consumer to add.
262  * @return Indication of success.
263  */
264 extern GHOST_TSuccess GHOST_AddEventConsumer(GHOST_SystemHandle systemhandle,
265                                                                                           GHOST_EventConsumerHandle consumerhandle);
266         
267
268 /***************************************************************************************
269  ** N-degree of freedom device management functionality
270  ***************************************************************************************/
271  
272 /**
273 * Open N-degree of freedom devices
274  */
275 extern void GHOST_OpenNDOF(GHOST_SystemHandle systemhandle, 
276                            GHOST_WindowHandle windowhandle,
277                           GHOST_NDOFLibraryInit_fp setNdofLibraryInit, 
278                           GHOST_NDOFLibraryShutdown_fp setNdofLibraryShutdown,
279                           GHOST_NDOFDeviceOpen_fp setNdofDeviceOpen,
280                           GHOST_NDOFEventHandler_fp setNdofEventHandler);
281
282 /***************************************************************************************
283  ** Cursor management functionality
284  ***************************************************************************************/
285
286 /**
287  * Returns the current cursor shape.
288  * @param windowhandle The handle to the window
289  * @return      The current cursor shape.
290  */
291 extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandle);
292
293 /**
294  * Set the shape of the cursor.
295  * @param windowhandle The handle to the window
296  * @param       cursor  The new cursor shape type id.
297  * @return      Indication of success.
298  */
299 extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle,
300                                                                                    GHOST_TStandardCursor cursorshape);
301
302 /**
303  * Set the shape of the cursor to a custom cursor.
304  * @param windowhandle The handle to the window
305  * @param       bitmap  The bitmap data for the cursor.
306  * @param       mask    The mask data for the cursor.
307  * @param       hotX    The X coordinate of the cursor hotspot.
308  * @param       hotY    The Y coordinate of the cursor hotspot.
309  * @return      Indication of success.
310  */
311 extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle,
312                                                                                                  GHOST_TUns8 bitmap[16][2], 
313                                                                                                  GHOST_TUns8 mask[16][2], 
314                                                                                                  int hotX, 
315                                                                                                  int hotY);
316 /**
317  * Set the shape of the cursor to a custom cursor of specified size.
318  * @param windowhandle The handle to the window
319  * @param       bitmap  The bitmap data for the cursor.
320  * @param       mask    The mask data for the cursor.
321  * @parm    sizex, sizey  The size of the cursor
322  * @param       hotX    The X coordinate of the cursor hotspot.
323  * @param       hotY    The Y coordinate of the cursor hotspot.
324  * @param   fg_color, bg_color  Colors of the cursor
325  * @return      Indication of success.
326   */
327 extern GHOST_TSuccess GHOST_SetCustomCursorShapeEx(GHOST_WindowHandle windowhandle,
328                                                                                                  GHOST_TUns8 *bitmap, 
329                                                                                                  GHOST_TUns8 *mask, 
330                                                                                                  int sizex, int sizey, 
331                                                                                                  int hotX,  int hotY,
332                                                                                                  int fg_color, int bg_color );
333
334 /**
335  * Returns the visibility state of the cursor.
336  * @param windowhandle The handle to the window
337  * @return      The visibility state of the cursor.
338  */
339 extern int GHOST_GetCursorVisibility(GHOST_WindowHandle windowhandle);
340
341 /**
342  * Shows or hides the cursor.
343  * @param windowhandle The handle to the window
344  * @param       visible The new visibility state of the cursor.
345  * @return      Indication of success.
346  */
347 extern GHOST_TSuccess GHOST_SetCursorVisibility(GHOST_WindowHandle windowhandle,
348                                                                                                 int visible);
349
350 /**
351  * Returns the current location of the cursor (location in screen coordinates)
352  * @param systemhandle The handle to the system
353  * @param x                     The x-coordinate of the cursor.
354  * @param y                     The y-coordinate of the cursor.
355  * @return                      Indication of success.
356  */
357 extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle,
358                                                                                           GHOST_TInt32* x,
359                                                                                           GHOST_TInt32* y);
360
361 /**
362  * Updates the location of the cursor (location in screen coordinates).
363  * Not all operating systems allow the cursor to be moved (without the input device being moved).
364  * @param systemhandle The handle to the system
365  * @param x                     The x-coordinate of the cursor.
366  * @param y                     The y-coordinate of the cursor.
367  * @return                      Indication of success.
368  */
369 extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle,
370                                                                                           GHOST_TInt32 x,
371                                                                                           GHOST_TInt32 y);
372
373 /***************************************************************************************
374  ** Access to mouse button and keyboard states.
375  ***************************************************************************************/
376
377 /**
378  * Returns the state of a modifier key (ouside the message queue).
379  * @param systemhandle The handle to the system
380  * @param mask          The modifier key state to retrieve.
381  * @param isDown        Pointer to return modifier state in.
382  * @return                      Indication of success.
383  */
384 extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle,
385                                                                                                 GHOST_TModifierKeyMask mask,
386                                                                                                 int* isDown);
387
388 /**
389  * Returns the state of a mouse button (ouside the message queue).
390  * @param systemhandle The handle to the system
391  * @param mask          The button state to retrieve.
392  * @param isDown        Pointer to return button state in.
393  * @return                      Indication of success.
394  */
395 extern GHOST_TSuccess GHOST_GetButtonState(GHOST_SystemHandle systemhandle,
396                                                                                    GHOST_TButtonMask mask,
397                                                                                    int* isDown);
398
399 /**
400  * Returns the event type.
401  * @param eventhandle The handle to the event
402  * @return The event type.
403  */
404 extern GHOST_TEventType GHOST_GetEventType(GHOST_EventHandle eventhandle);
405
406 /**
407  * Returns the time this event was generated.
408  * @param eventhandle The handle to the event
409  * @return The event generation time.
410  */
411 extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle);
412
413 /**
414  * Returns the window this event was generated on, 
415  * or NULL if it is a 'system' event.
416  * @param eventhandle The handle to the event
417  * @return The generating window.
418  */
419 extern GHOST_WindowHandle GHOST_GetEventWindow(GHOST_EventHandle eventhandle);
420
421 /**
422  * Returns the event data.
423  * @param eventhandle The handle to the event
424  * @return The event data.
425  */
426 extern GHOST_TEventDataPtr GHOST_GetEventData(GHOST_EventHandle eventhandle);
427
428 /**
429  * Returns the timer callback.
430  * @param timertaskhandle       The handle to the timertask
431  * @return The timer callback.
432  */
433 extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhandle);
434
435 /**
436  * Changes the timer callback.
437  * @param timertaskhandle The handle to the timertask
438  * @param timerProc The timer callback.
439  */
440 extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle,
441                                                            GHOST_TimerProcPtr timerProc);
442
443 /**
444  * Returns the timer user data.
445  * @param timertaskhandle       The handle to the timertask
446  * @return The timer user data.
447  */
448 extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle);
449         
450 /**
451  * Changes the time user data.
452  * @param timertaskhandle       The handle to the timertask
453  * @param data The timer user data.
454  */
455 extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle,
456                                                                            GHOST_TUserDataPtr userData);
457
458 /**
459  * Returns indication as to whether the window is valid.
460  * @param windowhandle The handle to the window
461  * @return The validity of the window.
462  */
463 extern int GHOST_GetValid(GHOST_WindowHandle windowhandle) ;
464
465 /**
466  * Returns the type of drawing context used in this window.
467  * @param windowhandle The handle to the window
468  * @return The current type of drawing context.
469  */
470 extern GHOST_TDrawingContextType GHOST_GetDrawingContextType(GHOST_WindowHandle windowhandle);
471
472 /**
473  * Tries to install a rendering context in this window.
474  * @param windowhandle The handle to the window
475  * @param type  The type of rendering context installed.
476  * @return Indication as to whether installation has succeeded.
477  */
478 extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandle,
479                                                                                                   GHOST_TDrawingContextType type);
480
481 /**
482  * Sets the title displayed in the title bar.
483  * @param windowhandle The handle to the window
484  * @param title The title to display in the title bar.
485  */
486 extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle,
487                                                    char* title);
488
489 /**
490  * Returns the title displayed in the title bar. The title
491  * should be free'd with free().
492  * 
493  * @param windowhandle The handle to the window
494  * @return The title, free with free().
495  */
496 extern char* GHOST_GetTitle(GHOST_WindowHandle windowhandle);
497
498 /**
499  * Returns the window rectangle dimensions.
500  * These are screen coordinates.
501  * @param windowhandle The handle to the window
502  * @return A handle to the bounding rectangle of the window.
503  */
504 extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhandle);
505
506 /**
507  * Returns the client rectangle dimensions.
508  * The left and top members of the rectangle are always zero.
509  * @param windowhandle The handle to the window
510  * @return A handle to the bounding rectangle of the window.
511  */
512 extern GHOST_RectangleHandle GHOST_GetClientBounds(GHOST_WindowHandle windowhandle);
513
514 /**
515  * Disposes a rectangle object
516  * @param rectanglehandle       Handle to the rectangle.
517  */
518 void GHOST_DisposeRectangle(GHOST_RectangleHandle rectanglehandle);
519
520 /**
521  * Resizes client rectangle width.
522  * @param windowhandle The handle to the window
523  * @param width The new width of the client area of the window.
524  * @return      Indication of success.
525  */
526 extern GHOST_TSuccess GHOST_SetClientWidth(GHOST_WindowHandle windowhandle,
527                                                                                    GHOST_TUns32 width);
528
529 /**
530  * Resizes client rectangle height.
531  * @param windowhandle The handle to the window
532  * @param height The new height of the client area of the window.
533  * @return      Indication of success.
534  */
535 extern GHOST_TSuccess GHOST_SetClientHeight(GHOST_WindowHandle windowhandle,
536                                                                                         GHOST_TUns32 height);
537
538 /**
539  * Resizes client rectangle.
540  * @param windowhandle The handle to the window
541  * @param width         The new width of the client area of the window.
542  * @param height        The new height of the client area of the window.
543  * @return                      Indication of success.
544  */
545 extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle,
546                                                                                   GHOST_TUns32 width,
547                                                                                   GHOST_TUns32 height);
548
549 /**
550  * Converts a point in screen coordinates to client rectangle coordinates
551  * @param windowhandle The handle to the window
552  * @param inX   The x-coordinate on the screen.
553  * @param inY   The y-coordinate on the screen.
554  * @param outX  The x-coordinate in the client rectangle.
555  * @param outY  The y-coordinate in the client rectangle.
556  */
557 extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle,
558                                                                  GHOST_TInt32 inX,
559                                                                  GHOST_TInt32 inY,
560                                                                  GHOST_TInt32* outX,
561                                                                  GHOST_TInt32* outY) ;
562
563 /**
564  * Converts a point in screen coordinates to client rectangle coordinates
565  * @param windowhandle The handle to the window
566  * @param inX   The x-coordinate in the client rectangle.
567  * @param inY   The y-coordinate in the client rectangle.
568  * @param outX  The x-coordinate on the screen.
569  * @param outY  The y-coordinate on the screen.
570  */
571 extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle,
572                                                                  GHOST_TInt32 inX,
573                                                                  GHOST_TInt32 inY,
574                                                                  GHOST_TInt32* outX,
575                                                                  GHOST_TInt32* outY);
576
577 /**
578  * Returns the state of the window (normal, minimized, maximized).
579  * @param windowhandle The handle to the window
580  * @return The state of the window.
581  */
582 extern GHOST_TWindowState GHOST_GetWindowState(GHOST_WindowHandle windowhandle);
583
584 /**
585  * Sets the state of the window (normal, minimized, maximized).
586  * @param windowhandle The handle to the window
587  * @param state The state of the window.
588  * @return Indication of success.
589  */
590 extern GHOST_TSuccess GHOST_SetWindowState(GHOST_WindowHandle windowhandle,
591                                                                                    GHOST_TWindowState state);
592
593 /**
594  * Sets the order of the window (bottom, top).
595  * @param windowhandle The handle to the window
596  * @param order The order of the window.
597  * @return Indication of success.
598  */
599 extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle,
600                                                                                    GHOST_TWindowOrder order);
601
602 /**
603  * Swaps front and back buffers of a window.
604  * @param windowhandle The handle to the window
605  * @return      An intean success indicator.
606  */
607 extern GHOST_TSuccess GHOST_SwapWindowBuffers(GHOST_WindowHandle windowhandle);
608
609 /**
610  * Activates the drawing context of this window.
611  * @param windowhandle The handle to the window
612  * @return      An intean success indicator.
613  */
614 extern GHOST_TSuccess GHOST_ActivateWindowDrawingContext(GHOST_WindowHandle windowhandle);
615
616 /**
617  * Invalidates the contents of this window.
618  * @param windowhandle The handle to the window
619  * @return Indication of success.
620  */
621 extern GHOST_TSuccess GHOST_InvalidateWindow(GHOST_WindowHandle windowhandle);
622
623 /**
624  * Returns the status of the tablet
625  * @param windowhandle The handle to the window
626  * @return Status of tablet
627  */
628 extern const GHOST_TabletData *GHOST_GetTabletData(GHOST_WindowHandle windowhandle);
629
630 /**
631  * Access to rectangle width.
632  * @param rectanglehandle The handle to the rectangle
633  * @return      width of the rectangle
634  */
635 extern GHOST_TInt32 GHOST_GetWidthRectangle(GHOST_RectangleHandle rectanglehandle);
636
637 /**
638  * Access to rectangle height.
639  * @param rectanglehandle The handle to the rectangle
640  * @return      height of the rectangle
641  */
642 extern GHOST_TInt32 GHOST_GetHeightRectangle(GHOST_RectangleHandle rectanglehandle);
643
644 /**
645  * Gets all members of the rectangle.
646  * @param rectanglehandle The handle to the rectangle
647  * @param       l       Pointer to return left coordinate in.
648  * @param       t       Pointer to return top coordinate in.
649  * @param       r       Pointer to return right coordinate in.
650  * @param       b       Pointer to return bottom coordinate in.
651  */
652 extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle,
653                                                            GHOST_TInt32* l,
654                                                            GHOST_TInt32* t,
655                                                            GHOST_TInt32* r,
656                                                            GHOST_TInt32* b);
657
658 /**
659  * Sets all members of the rectangle.
660  * @param rectanglehandle The handle to the rectangle
661  * @param       l       requested left coordinate of the rectangle
662  * @param       t       requested top coordinate of the rectangle
663  * @param       r       requested right coordinate of the rectangle
664  * @param       b       requested bottom coordinate of the rectangle
665  */
666 extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle,
667                                                            GHOST_TInt32 l,
668                                                            GHOST_TInt32 t,
669                                                            GHOST_TInt32 r,
670                                                            GHOST_TInt32 b);
671
672 /**
673  * Returns whether this rectangle is empty.
674  * Empty rectangles are rectangles that have width==0 and/or height==0.
675  * @param rectanglehandle The handle to the rectangle
676  * @return      intean value (true == empty rectangle)
677  */
678 extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehandle);
679
680 /**
681  * Returns whether this rectangle is valid.
682  * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
683  * @param rectanglehandle The handle to the rectangle
684  * @return      intean value (true==valid rectangle)
685  */
686 extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehandle);
687
688 /**
689  * Grows (or shrinks the rectangle).
690  * The method avoids negative insets making the rectangle invalid
691  * @param rectanglehandle The handle to the rectangle
692  * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
693  */
694 extern void GHOST_InsetRectangle(GHOST_RectangleHandle rectanglehandle,
695                                                                  GHOST_TInt32 i);
696
697 /**
698  * Does a union of the rectangle given and this rectangle.
699  * The result is stored in this rectangle.
700  * @param rectanglehandle The handle to the rectangle
701  * @param       r       The rectangle that is input for the union operation.
702  */
703 extern void GHOST_UnionRectangle(GHOST_RectangleHandle rectanglehandle,
704                                                                  GHOST_RectangleHandle anotherrectanglehandle);
705
706 /**
707  * Grows the rectangle to included a point.
708  * @param rectanglehandle The handle to the rectangle
709  * @param       x       The x-coordinate of the point.
710  * @param       y       The y-coordinate of the point.
711  */
712 extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle,
713                                                                           GHOST_TInt32 x,
714                                                                           GHOST_TInt32 y);
715
716 /**
717  * Returns whether the point is inside this rectangle.
718  * Point on the boundary is considered inside.
719  * @param rectanglehandle The handle to the rectangle
720  * @param x     x-coordinate of point to test.
721  * @param y y-coordinate of point to test.
722  * @return intean value (true if point is inside).
723  */
724 extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehandle,
725                                                                                           GHOST_TInt32 x,
726                                                                                           GHOST_TInt32 y);
727
728 /**
729  * Returns whether the rectangle is inside this rectangle.
730  * @param rectanglehandle The handle to the rectangle
731  * @param       r       rectangle to test.
732  * @return      visibility (not, partially or fully visible).
733  */
734 extern GHOST_TVisibility GHOST_GetRectangleVisibility(GHOST_RectangleHandle rectanglehandle,
735                                                                                                           GHOST_RectangleHandle anotherrectanglehandle);
736
737 /**
738  * Sets rectangle members.
739  * Sets rectangle members such that it is centered at the given location.
740  * @param rectanglehandle The handle to the rectangle
741  * @param       cx      requested center x-coordinate of the rectangle
742  * @param       cy      requested center y-coordinate of the rectangle
743  */
744 extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle,
745                                                                          GHOST_TInt32 cx,
746                                                                          GHOST_TInt32 cy);
747
748 /**
749  * Sets rectangle members.
750  * Sets rectangle members such that it is centered at the given location,
751  * with the width requested.
752  * @param rectanglehandle The handle to the rectangle
753  * @param       cx      requested center x-coordinate of the rectangle
754  * @param       cy      requested center y-coordinate of the rectangle
755  * @param       w       requested width of the rectangle
756  * @param       h       requested height of the rectangle
757  */
758 extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle,
759                                                                          GHOST_TInt32 cx,
760                                                                          GHOST_TInt32 cy,
761                                                                          GHOST_TInt32 w,
762                                                                          GHOST_TInt32 h);
763
764 /**
765  * Clips a rectangle.
766  * Updates the rectangle given such that it will fit within this one.
767  * This can result in an empty rectangle.
768  * @param rectanglehandle The handle to the rectangle
769  * @param       r       the rectangle to clip
770  * @return      whether clipping has occurred
771  */
772 extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
773                                                                                   GHOST_RectangleHandle anotherrectanglehandle);
774 #ifdef __cplusplus
775 }
776 #endif
777
778 #endif