== SCons ==
[blender-staging.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 /***************************************************************************************
270  ** Cursor management functionality
271  ***************************************************************************************/
272
273 /**
274  * Returns the current cursor shape.
275  * @param windowhandle The handle to the window
276  * @return      The current cursor shape.
277  */
278 extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandle);
279
280 /**
281  * Set the shape of the cursor.
282  * @param windowhandle The handle to the window
283  * @param       cursor  The new cursor shape type id.
284  * @return      Indication of success.
285  */
286 extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle,
287                                                                                    GHOST_TStandardCursor cursorshape);
288
289 /**
290  * Set the shape of the cursor to a custom cursor.
291  * @param windowhandle The handle to the window
292  * @param       bitmap  The bitmap data for the cursor.
293  * @param       mask    The mask data for the cursor.
294  * @param       hotX    The X coordinate of the cursor hotspot.
295  * @param       hotY    The Y coordinate of the cursor hotspot.
296  * @return      Indication of success.
297  */
298 extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle,
299                                                                                                  GHOST_TUns8 bitmap[16][2], 
300                                                                                                  GHOST_TUns8 mask[16][2], 
301                                                                                                  int hotX, 
302                                                                                                  int hotY);
303 /**
304  * Set the shape of the cursor to a custom cursor of specified size.
305  * @param windowhandle The handle to the window
306  * @param       bitmap  The bitmap data for the cursor.
307  * @param       mask    The mask data for the cursor.
308  * @parm    sizex, sizey  The size of the cursor
309  * @param       hotX    The X coordinate of the cursor hotspot.
310  * @param       hotY    The Y coordinate of the cursor hotspot.
311  * @param   fg_color, bg_color  Colors of the cursor
312  * @return      Indication of success.
313   */
314 extern GHOST_TSuccess GHOST_SetCustomCursorShapeEx(GHOST_WindowHandle windowhandle,
315                                                                                                  GHOST_TUns8 *bitmap, 
316                                                                                                  GHOST_TUns8 *mask, 
317                                                                                                  int sizex, int sizey, 
318                                                                                                  int hotX,  int hotY,
319                                                                                                  int fg_color, int bg_color );
320
321 /**
322  * Returns the visibility state of the cursor.
323  * @param windowhandle The handle to the window
324  * @return      The visibility state of the cursor.
325  */
326 extern int GHOST_GetCursorVisibility(GHOST_WindowHandle windowhandle);
327
328 /**
329  * Shows or hides the cursor.
330  * @param windowhandle The handle to the window
331  * @param       visible The new visibility state of the cursor.
332  * @return      Indication of success.
333  */
334 extern GHOST_TSuccess GHOST_SetCursorVisibility(GHOST_WindowHandle windowhandle,
335                                                                                                 int visible);
336
337 /**
338  * Returns the current location of the cursor (location in screen coordinates)
339  * @param systemhandle The handle to the system
340  * @param x                     The x-coordinate of the cursor.
341  * @param y                     The y-coordinate of the cursor.
342  * @return                      Indication of success.
343  */
344 extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle,
345                                                                                           GHOST_TInt32* x,
346                                                                                           GHOST_TInt32* y);
347
348 /**
349  * Updates the location of the cursor (location in screen coordinates).
350  * Not all operating systems allow the cursor to be moved (without the input device being moved).
351  * @param systemhandle The handle to the system
352  * @param x                     The x-coordinate of the cursor.
353  * @param y                     The y-coordinate of the cursor.
354  * @return                      Indication of success.
355  */
356 extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle,
357                                                                                           GHOST_TInt32 x,
358                                                                                           GHOST_TInt32 y);
359
360 /***************************************************************************************
361  ** Access to mouse button and keyboard states.
362  ***************************************************************************************/
363
364 /**
365  * Returns the state of a modifier key (ouside the message queue).
366  * @param systemhandle The handle to the system
367  * @param mask          The modifier key state to retrieve.
368  * @param isDown        Pointer to return modifier state in.
369  * @return                      Indication of success.
370  */
371 extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle,
372                                                                                                 GHOST_TModifierKeyMask mask,
373                                                                                                 int* isDown);
374
375 /**
376  * Returns the state of a mouse button (ouside the message queue).
377  * @param systemhandle The handle to the system
378  * @param mask          The button state to retrieve.
379  * @param isDown        Pointer to return button state in.
380  * @return                      Indication of success.
381  */
382 extern GHOST_TSuccess GHOST_GetButtonState(GHOST_SystemHandle systemhandle,
383                                                                                    GHOST_TButtonMask mask,
384                                                                                    int* isDown);
385
386 /**
387  * Returns the event type.
388  * @param eventhandle The handle to the event
389  * @return The event type.
390  */
391 extern GHOST_TEventType GHOST_GetEventType(GHOST_EventHandle eventhandle);
392
393 /**
394  * Returns the time this event was generated.
395  * @param eventhandle The handle to the event
396  * @return The event generation time.
397  */
398 extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle);
399
400 /**
401  * Returns the window this event was generated on, 
402  * or NULL if it is a 'system' event.
403  * @param eventhandle The handle to the event
404  * @return The generating window.
405  */
406 extern GHOST_WindowHandle GHOST_GetEventWindow(GHOST_EventHandle eventhandle);
407
408 /**
409  * Returns the event data.
410  * @param eventhandle The handle to the event
411  * @return The event data.
412  */
413 extern GHOST_TEventDataPtr GHOST_GetEventData(GHOST_EventHandle eventhandle);
414
415 /**
416  * Returns the timer callback.
417  * @param timertaskhandle       The handle to the timertask
418  * @return The timer callback.
419  */
420 extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhandle);
421
422 /**
423  * Changes the timer callback.
424  * @param timertaskhandle The handle to the timertask
425  * @param timerProc The timer callback.
426  */
427 extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle,
428                                                            GHOST_TimerProcPtr timerProc);
429
430 /**
431  * Returns the timer user data.
432  * @param timertaskhandle       The handle to the timertask
433  * @return The timer user data.
434  */
435 extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle);
436         
437 /**
438  * Changes the time user data.
439  * @param timertaskhandle       The handle to the timertask
440  * @param data The timer user data.
441  */
442 extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle,
443                                                                            GHOST_TUserDataPtr userData);
444
445 /**
446  * Returns indication as to whether the window is valid.
447  * @param windowhandle The handle to the window
448  * @return The validity of the window.
449  */
450 extern int GHOST_GetValid(GHOST_WindowHandle windowhandle) ;
451
452 /**
453  * Returns the type of drawing context used in this window.
454  * @param windowhandle The handle to the window
455  * @return The current type of drawing context.
456  */
457 extern GHOST_TDrawingContextType GHOST_GetDrawingContextType(GHOST_WindowHandle windowhandle);
458
459 /**
460  * Tries to install a rendering context in this window.
461  * @param windowhandle The handle to the window
462  * @param type  The type of rendering context installed.
463  * @return Indication as to whether installation has succeeded.
464  */
465 extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandle,
466                                                                                                   GHOST_TDrawingContextType type);
467
468 /**
469  * Sets the title displayed in the title bar.
470  * @param windowhandle The handle to the window
471  * @param title The title to display in the title bar.
472  */
473 extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle,
474                                                    char* title);
475
476 /**
477  * Returns the title displayed in the title bar. The title
478  * should be free'd with free().
479  * 
480  * @param windowhandle The handle to the window
481  * @return The title, free with free().
482  */
483 extern char* GHOST_GetTitle(GHOST_WindowHandle windowhandle);
484
485 /**
486  * Returns the window rectangle dimensions.
487  * These are screen coordinates.
488  * @param windowhandle The handle to the window
489  * @return A handle to the bounding rectangle of the window.
490  */
491 extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhandle);
492
493 /**
494  * Returns the client rectangle dimensions.
495  * The left and top members of the rectangle are always zero.
496  * @param windowhandle The handle to the window
497  * @return A handle to the bounding rectangle of the window.
498  */
499 extern GHOST_RectangleHandle GHOST_GetClientBounds(GHOST_WindowHandle windowhandle);
500
501 /**
502  * Disposes a rectangle object
503  * @param rectanglehandle       Handle to the rectangle.
504  */
505 void GHOST_DisposeRectangle(GHOST_RectangleHandle rectanglehandle);
506
507 /**
508  * Resizes client rectangle width.
509  * @param windowhandle The handle to the window
510  * @param width The new width of the client area of the window.
511  * @return      Indication of success.
512  */
513 extern GHOST_TSuccess GHOST_SetClientWidth(GHOST_WindowHandle windowhandle,
514                                                                                    GHOST_TUns32 width);
515
516 /**
517  * Resizes client rectangle height.
518  * @param windowhandle The handle to the window
519  * @param height The new height of the client area of the window.
520  * @return      Indication of success.
521  */
522 extern GHOST_TSuccess GHOST_SetClientHeight(GHOST_WindowHandle windowhandle,
523                                                                                         GHOST_TUns32 height);
524
525 /**
526  * Resizes client rectangle.
527  * @param windowhandle The handle to the window
528  * @param width         The new width of the client area of the window.
529  * @param height        The new height of the client area of the window.
530  * @return                      Indication of success.
531  */
532 extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle,
533                                                                                   GHOST_TUns32 width,
534                                                                                   GHOST_TUns32 height);
535
536 /**
537  * Converts a point in screen coordinates to client rectangle coordinates
538  * @param windowhandle The handle to the window
539  * @param inX   The x-coordinate on the screen.
540  * @param inY   The y-coordinate on the screen.
541  * @param outX  The x-coordinate in the client rectangle.
542  * @param outY  The y-coordinate in the client rectangle.
543  */
544 extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle,
545                                                                  GHOST_TInt32 inX,
546                                                                  GHOST_TInt32 inY,
547                                                                  GHOST_TInt32* outX,
548                                                                  GHOST_TInt32* outY) ;
549
550 /**
551  * Converts a point in screen coordinates to client rectangle coordinates
552  * @param windowhandle The handle to the window
553  * @param inX   The x-coordinate in the client rectangle.
554  * @param inY   The y-coordinate in the client rectangle.
555  * @param outX  The x-coordinate on the screen.
556  * @param outY  The y-coordinate on the screen.
557  */
558 extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle,
559                                                                  GHOST_TInt32 inX,
560                                                                  GHOST_TInt32 inY,
561                                                                  GHOST_TInt32* outX,
562                                                                  GHOST_TInt32* outY);
563
564 /**
565  * Returns the state of the window (normal, minimized, maximized).
566  * @param windowhandle The handle to the window
567  * @return The state of the window.
568  */
569 extern GHOST_TWindowState GHOST_GetWindowState(GHOST_WindowHandle windowhandle);
570
571 /**
572  * Sets the state of the window (normal, minimized, maximized).
573  * @param windowhandle The handle to the window
574  * @param state The state of the window.
575  * @return Indication of success.
576  */
577 extern GHOST_TSuccess GHOST_SetWindowState(GHOST_WindowHandle windowhandle,
578                                                                                    GHOST_TWindowState state);
579
580 /**
581  * Sets the order of the window (bottom, top).
582  * @param windowhandle The handle to the window
583  * @param order The order of the window.
584  * @return Indication of success.
585  */
586 extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle,
587                                                                                    GHOST_TWindowOrder order);
588
589 /**
590  * Swaps front and back buffers of a window.
591  * @param windowhandle The handle to the window
592  * @return      An intean success indicator.
593  */
594 extern GHOST_TSuccess GHOST_SwapWindowBuffers(GHOST_WindowHandle windowhandle);
595
596 /**
597  * Activates the drawing context of this window.
598  * @param windowhandle The handle to the window
599  * @return      An intean success indicator.
600  */
601 extern GHOST_TSuccess GHOST_ActivateWindowDrawingContext(GHOST_WindowHandle windowhandle);
602
603 /**
604  * Invalidates the contents of this window.
605  * @param windowhandle The handle to the window
606  * @return Indication of success.
607  */
608 extern GHOST_TSuccess GHOST_InvalidateWindow(GHOST_WindowHandle windowhandle);
609
610 /**
611  * Access to rectangle width.
612  * @param rectanglehandle The handle to the rectangle
613  * @return      width of the rectangle
614  */
615 extern GHOST_TInt32 GHOST_GetWidthRectangle(GHOST_RectangleHandle rectanglehandle);
616
617 /**
618  * Access to rectangle height.
619  * @param rectanglehandle The handle to the rectangle
620  * @return      height of the rectangle
621  */
622 extern GHOST_TInt32 GHOST_GetHeightRectangle(GHOST_RectangleHandle rectanglehandle);
623
624 /**
625  * Gets all members of the rectangle.
626  * @param rectanglehandle The handle to the rectangle
627  * @param       l       Pointer to return left coordinate in.
628  * @param       t       Pointer to return top coordinate in.
629  * @param       r       Pointer to return right coordinate in.
630  * @param       b       Pointer to return bottom coordinate in.
631  */
632 extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle,
633                                                            GHOST_TInt32* l,
634                                                            GHOST_TInt32* t,
635                                                            GHOST_TInt32* r,
636                                                            GHOST_TInt32* b);
637
638 /**
639  * Sets all members of the rectangle.
640  * @param rectanglehandle The handle to the rectangle
641  * @param       l       requested left coordinate of the rectangle
642  * @param       t       requested top coordinate of the rectangle
643  * @param       r       requested right coordinate of the rectangle
644  * @param       b       requested bottom coordinate of the rectangle
645  */
646 extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle,
647                                                            GHOST_TInt32 l,
648                                                            GHOST_TInt32 t,
649                                                            GHOST_TInt32 r,
650                                                            GHOST_TInt32 b);
651
652 /**
653  * Returns whether this rectangle is empty.
654  * Empty rectangles are rectangles that have width==0 and/or height==0.
655  * @param rectanglehandle The handle to the rectangle
656  * @return      intean value (true == empty rectangle)
657  */
658 extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehandle);
659
660 /**
661  * Returns whether this rectangle is valid.
662  * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
663  * @param rectanglehandle The handle to the rectangle
664  * @return      intean value (true==valid rectangle)
665  */
666 extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehandle);
667
668 /**
669  * Grows (or shrinks the rectangle).
670  * The method avoids negative insets making the rectangle invalid
671  * @param rectanglehandle The handle to the rectangle
672  * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
673  */
674 extern void GHOST_InsetRectangle(GHOST_RectangleHandle rectanglehandle,
675                                                                  GHOST_TInt32 i);
676
677 /**
678  * Does a union of the rectangle given and this rectangle.
679  * The result is stored in this rectangle.
680  * @param rectanglehandle The handle to the rectangle
681  * @param       r       The rectangle that is input for the union operation.
682  */
683 extern void GHOST_UnionRectangle(GHOST_RectangleHandle rectanglehandle,
684                                                                  GHOST_RectangleHandle anotherrectanglehandle);
685
686 /**
687  * Grows the rectangle to included a point.
688  * @param rectanglehandle The handle to the rectangle
689  * @param       x       The x-coordinate of the point.
690  * @param       y       The y-coordinate of the point.
691  */
692 extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle,
693                                                                           GHOST_TInt32 x,
694                                                                           GHOST_TInt32 y);
695
696 /**
697  * Returns whether the point is inside this rectangle.
698  * Point on the boundary is considered inside.
699  * @param rectanglehandle The handle to the rectangle
700  * @param x     x-coordinate of point to test.
701  * @param y y-coordinate of point to test.
702  * @return intean value (true if point is inside).
703  */
704 extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehandle,
705                                                                                           GHOST_TInt32 x,
706                                                                                           GHOST_TInt32 y);
707
708 /**
709  * Returns whether the rectangle is inside this rectangle.
710  * @param rectanglehandle The handle to the rectangle
711  * @param       r       rectangle to test.
712  * @return      visibility (not, partially or fully visible).
713  */
714 extern GHOST_TVisibility GHOST_GetRectangleVisibility(GHOST_RectangleHandle rectanglehandle,
715                                                                                                           GHOST_RectangleHandle anotherrectanglehandle);
716
717 /**
718  * Sets rectangle members.
719  * Sets rectangle members such that it is centered at the given location.
720  * @param rectanglehandle The handle to the rectangle
721  * @param       cx      requested center x-coordinate of the rectangle
722  * @param       cy      requested center y-coordinate of the rectangle
723  */
724 extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle,
725                                                                          GHOST_TInt32 cx,
726                                                                          GHOST_TInt32 cy);
727
728 /**
729  * Sets rectangle members.
730  * Sets rectangle members such that it is centered at the given location,
731  * with the width requested.
732  * @param rectanglehandle The handle to the rectangle
733  * @param       cx      requested center x-coordinate of the rectangle
734  * @param       cy      requested center y-coordinate of the rectangle
735  * @param       w       requested width of the rectangle
736  * @param       h       requested height of the rectangle
737  */
738 extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle,
739                                                                          GHOST_TInt32 cx,
740                                                                          GHOST_TInt32 cy,
741                                                                          GHOST_TInt32 w,
742                                                                          GHOST_TInt32 h);
743
744 /**
745  * Clips a rectangle.
746  * Updates the rectangle given such that it will fit within this one.
747  * This can result in an empty rectangle.
748  * @param rectanglehandle The handle to the rectangle
749  * @param       r       the rectangle to clip
750  * @return      whether clipping has occurred
751  */
752 extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
753                                                                                   GHOST_RectangleHandle anotherrectanglehandle);
754
755 #ifdef __cplusplus
756 }
757 #endif
758
759 #endif