diff options
Diffstat (limited to 'intern/ghost/GHOST_C-api.h')
| -rw-r--r-- | intern/ghost/GHOST_C-api.h | 398 |
1 files changed, 198 insertions, 200 deletions
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 2046b55c97f..64740b68c0c 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -31,8 +31,8 @@ extern "C" { /** * Definition of a callback routine that receives events. - * \param event The event received. - * \param userdata The callback's user data, supplied to GHOST_CreateSystem. + * \param event: The event received. + * \param userdata: The callback's user data, supplied to #GHOST_CreateSystem. */ typedef int (*GHOST_EventCallbackProcPtr)(GHOST_EventHandle event, GHOST_TUserDataPtr userdata); @@ -49,21 +49,20 @@ extern void GHOST_SystemInitDebug(GHOST_SystemHandle systemhandle, int is_debug_ /** * Disposes the one and only system. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. * \return An indication of success. */ extern GHOST_TSuccess GHOST_DisposeSystem(GHOST_SystemHandle systemhandle); /** * Show a system message box to the user - * \param systemhandle The handle to the system - * \param title Title of the message box - * \param message Message of the message box - * \param help_label Text to show on the help button that opens a link - * \param continue_label Text to show on the ok button that continues - * \param link Optional (hyper)link to a webpage to show when pressing help - * \param dialog_options Options to configure the message box. - * \return void. + * \param systemhandle: The handle to the system. + * \param title: Title of the message box. + * \param message: Message of the message box. + * \param help_label: Text to show on the help button that opens a link. + * \param continue_label: Text to show on the ok button that continues. + * \param link: Optional (hyper)link to a webpage to show when pressing help. + * \param dialog_options: Options to configure the message box. */ extern void GHOST_ShowMessageBox(GHOST_SystemHandle systemhandle, const char *title, @@ -75,15 +74,15 @@ extern void GHOST_ShowMessageBox(GHOST_SystemHandle systemhandle, /** * Creates an event consumer object - * \param eventCallback The event callback routine. - * \param userdata Pointer to user data returned to the callback routine. + * \param eventCallback: The event callback routine. + * \param userdata: Pointer to user data returned to the callback routine. */ extern GHOST_EventConsumerHandle GHOST_CreateEventConsumer( GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userdata); /** * Disposes an event consumer object - * \param consumerhandle Handle to the event consumer. + * \param consumerhandle: Handle to the event consumer. * \return An indication of success. */ extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consumerhandle); @@ -92,7 +91,7 @@ extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consu * Returns the system time. * Returns the number of milliseconds since the start of the system process. * Based on ANSI clock() routine. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. * \return The number of milliseconds. */ extern GHOST_TUns64 GHOST_GetMilliSeconds(GHOST_SystemHandle systemhandle); @@ -101,11 +100,11 @@ extern GHOST_TUns64 GHOST_GetMilliSeconds(GHOST_SystemHandle systemhandle); * Installs a timer. * Note that, on most operating systems, messages need to be processed in order * for the timer callbacks to be invoked. - * \param systemhandle The handle to the system - * \param delay The time to wait for the first call to the timerProc (in milliseconds) - * \param interval The interval between calls to the timerProc (in milliseconds) - * \param timerProc The callback invoked when the interval expires, - * \param userData Placeholder for user data. + * \param systemhandle: The handle to the system. + * \param delay: The time to wait for the first call to the timerProc (in milliseconds). + * \param interval: The interval between calls to the timerProc (in milliseconds). + * \param timerProc: The callback invoked when the interval expires. + * \param userData: Placeholder for user data. * \return A timer task (0 if timer task installation failed). */ extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle, @@ -116,8 +115,8 @@ extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle, /** * Removes a timer. - * \param systemhandle The handle to the system - * \param timertaskhandle Timer task to be removed. + * \param systemhandle: The handle to the system. + * \param timertaskhandle: Timer task to be removed. * \return Indication of success. */ extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle, @@ -129,17 +128,16 @@ extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle, /** * Returns the number of displays on this system. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. * \return The number of displays. */ extern GHOST_TUns8 GHOST_GetNumDisplays(GHOST_SystemHandle systemhandle); /** * Returns the dimensions of the main display on this system. - * \param systemhandle The handle to the system - * \param width A pointer the width gets put in - * \param height A pointer the height gets put in - * \return void. + * \param systemhandle: The handle to the system. + * \param width: A pointer the width gets put in. + * \param height: A pointer the height gets put in. */ extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle, GHOST_TUns32 *width, @@ -149,10 +147,9 @@ extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle, * Returns the dimensions of all displays combine * (the current workspace). * No need to worry about overlapping monitors. - * \param systemhandle The handle to the system - * \param width A pointer the width gets put in - * \param height A pointer the height gets put in - * \return void. + * \param systemhandle: The handle to the system. + * \param width: A pointer the width gets put in. + * \param height: A pointer the height gets put in. */ extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle, GHOST_TUns32 *width, @@ -162,15 +159,15 @@ extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle, * Create a new window. * The new window is added to the list of windows managed. * Never explicitly delete the window, use disposeWindow() instead. - * \param systemhandle The handle to the system - * \param title The name of the window + * \param systemhandle: The handle to the system. + * \param title: The name of the window. * (displayed in the title bar of the window if the OS supports it). - * \param left The coordinate of the left edge of the window. - * \param top The coordinate of the top edge of the window. - * \param width The width the window. - * \param height The height the window. - * \param state The state of the window when opened. - * \param type The type of drawing context installed in this window. + * \param left: The coordinate of the left edge of the window. + * \param top: The coordinate of the top edge of the window. + * \param width: The width the window. + * \param height: The height the window. + * \param state: The state of the window when opened. + * \param type: The type of drawing context installed in this window. * \param glSettings: Misc OpenGL options. * \return A handle to the new window ( == NULL if creation failed). */ @@ -198,8 +195,8 @@ extern GHOST_WindowHandle GHOST_CreateDialogWindow(GHOST_SystemHandle systemhand /** * Create a new offscreen context. * Never explicitly delete the context, use disposeContext() instead. - * \param systemhandle The handle to the system - * \param platform_support_callback An optional callback to check platform support + * \param systemhandle: The handle to the system. + * \param platform_support_callback: An optional callback to check platform support. * \return A handle to the new context ( == NULL if creation failed). */ extern GHOST_ContextHandle GHOST_CreateOpenGLContext(GHOST_SystemHandle systemhandle, @@ -207,8 +204,8 @@ extern GHOST_ContextHandle GHOST_CreateOpenGLContext(GHOST_SystemHandle systemha /** * Dispose of a context. - * \param systemhandle The handle to the system - * \param contexthandle Handle to the context to be disposed. + * \param systemhandle: The handle to the system. + * \param contexthandle: Handle to the context to be disposed. * \return Indication of success. */ extern GHOST_TSuccess GHOST_DisposeOpenGLContext(GHOST_SystemHandle systemhandle, @@ -216,15 +213,15 @@ extern GHOST_TSuccess GHOST_DisposeOpenGLContext(GHOST_SystemHandle systemhandle /** * Returns the window user data. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The window user data. */ extern GHOST_TUserDataPtr GHOST_GetWindowUserData(GHOST_WindowHandle windowhandle); /** * Changes the window user data. - * \param windowhandle The handle to the window - * \param userdata The window user data. + * \param windowhandle: The handle to the window. + * \param userdata: The window user data. */ extern void GHOST_SetWindowUserData(GHOST_WindowHandle windowhandle, GHOST_TUserDataPtr userdata); @@ -232,8 +229,8 @@ extern int GHOST_IsDialogWindow(GHOST_WindowHandle windowhandle); /** * Dispose a window. - * \param systemhandle The handle to the system - * \param windowhandle Handle to the window to be disposed. + * \param systemhandle: The handle to the system. + * \param windowhandle: Handle to the window to be disposed. * \return Indication of success. */ extern GHOST_TSuccess GHOST_DisposeWindow(GHOST_SystemHandle systemhandle, @@ -241,17 +238,17 @@ extern GHOST_TSuccess GHOST_DisposeWindow(GHOST_SystemHandle systemhandle, /** * Returns whether a window is valid. - * \param systemhandle The handle to the system - * \param windowhandle Handle to the window to be checked. + * \param systemhandle: The handle to the system. + * \param windowhandle: Handle to the window to be checked. * \return Indication of validity. */ extern int GHOST_ValidWindow(GHOST_SystemHandle systemhandle, GHOST_WindowHandle windowhandle); /** * Begins full screen mode. - * \param systemhandle The handle to the system - * \param setting The new setting of the display. - * \param stereoVisual Option for stereo display. + * \param systemhandle: The handle to the system. + * \param setting: The new setting of the display. + * \param stereoVisual: Option for stereo display. * \return A handle to the window displayed in full screen. * This window is invalid after full screen has been ended. */ @@ -261,14 +258,14 @@ extern GHOST_WindowHandle GHOST_BeginFullScreen(GHOST_SystemHandle systemhandle, /** * Ends full screen mode. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. * \return Indication of success. */ extern GHOST_TSuccess GHOST_EndFullScreen(GHOST_SystemHandle systemhandle); /** * Returns current full screen mode status. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. * \return The current status. */ extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle); @@ -279,8 +276,8 @@ extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle); /** * Retrieves events from the system and stores them in the queue. - * \param systemhandle The handle to the system - * \param waitForEvent Boolean to indicate that ProcessEvents should + * \param systemhandle: The handle to the system. + * \param waitForEvent: Boolean to indicate that #ProcessEvents should. * wait (block) until the next event before returning. * \return Indication of the presence of events. */ @@ -288,14 +285,14 @@ extern int GHOST_ProcessEvents(GHOST_SystemHandle systemhandle, int waitForEvent /** * Retrieves events from the queue and send them to the event consumers. - * \param systemhandle The handle to the system + * \param systemhandle: The handle to the system. */ extern void GHOST_DispatchEvents(GHOST_SystemHandle systemhandle); /** * Adds the given event consumer to our list. - * \param systemhandle The handle to the system - * \param consumerhandle The event consumer to add. + * \param systemhandle: The handle to the system. + * \param consumerhandle: The event consumer to add. * \return Indication of success. */ extern GHOST_TSuccess GHOST_AddEventConsumer(GHOST_SystemHandle systemhandle, @@ -303,8 +300,8 @@ extern GHOST_TSuccess GHOST_AddEventConsumer(GHOST_SystemHandle systemhandle, /** * Remove the given event consumer to our list. - * \param systemhandle The handle to the system - * \param consumerhandle The event consumer to remove. + * \param systemhandle: The handle to the system. + * \param consumerhandle: The event consumer to remove. * \return Indication of success. */ extern GHOST_TSuccess GHOST_RemoveEventConsumer(GHOST_SystemHandle systemhandle, @@ -316,14 +313,14 @@ extern GHOST_TSuccess GHOST_RemoveEventConsumer(GHOST_SystemHandle systemhandle, /** * Sets the progress bar value displayed in the window/application icon - * \param windowhandle The handle to the window - * \param progress The progress % (0.0 to 1.0) + * \param windowhandle: The handle to the window. + * \param progress: The progress percentage (0.0 to 1.0). */ extern GHOST_TSuccess GHOST_SetProgressBar(GHOST_WindowHandle windowhandle, float progress); /** * Hides the progress bar in the icon - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. */ extern GHOST_TSuccess GHOST_EndProgressBar(GHOST_WindowHandle windowhandle); @@ -333,7 +330,7 @@ extern GHOST_TSuccess GHOST_EndProgressBar(GHOST_WindowHandle windowhandle); /** * Returns the current cursor shape. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The current cursor shape. */ extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandle); @@ -341,8 +338,8 @@ extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandl /** * Set the shape of the cursor. If the shape is not supported by the platform, * it will use the default cursor instead. - * \param windowhandle The handle to the window - * \param cursorshape The new cursor shape type id. + * \param windowhandle: The handle to the window. + * \param cursorshape: The new cursor shape type id. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle, @@ -357,14 +354,14 @@ extern GHOST_TSuccess GHOST_HasCursorShape(GHOST_WindowHandle windowhandle, /** * Set the shape of the cursor to a custom cursor of specified size. - * \param windowhandle The handle to the window - * \param bitmap The bitmap data for the cursor. - * \param mask The mask data for the cursor. - * \param sizex The width of the cursor - * \param sizey The height of the cursor - * \param hotX The X coordinate of the cursor hot-spot. - * \param hotY The Y coordinate of the cursor hot-spot. - * \param canInvertColor Let macOS invert cursor color to match platform convention. + * \param windowhandle: The handle to the window. + * \param bitmap: The bitmap data for the cursor. + * \param mask: The mask data for the cursor. + * \param sizex: The width of the cursor. + * \param sizey: The height of the cursor. + * \param hotX: The X coordinate of the cursor hot-spot. + * \param hotY: The Y coordinate of the cursor hot-spot. + * \param canInvertColor: Let macOS invert cursor color to match platform convention. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle, @@ -378,24 +375,24 @@ extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle /** * Returns the visibility state of the cursor. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The visibility state of the cursor. */ extern int GHOST_GetCursorVisibility(GHOST_WindowHandle windowhandle); /** * Shows or hides the cursor. - * \param windowhandle The handle to the window - * \param visible The new visibility state of the cursor. + * \param windowhandle: The handle to the window. + * \param visible: The new visibility state of the cursor. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetCursorVisibility(GHOST_WindowHandle windowhandle, int visible); /** * Returns the current location of the cursor (location in screen coordinates) - * \param systemhandle The handle to the system - * \param x The x-coordinate of the cursor. - * \param y The y-coordinate of the cursor. + * \param systemhandle: The handle to the system. + * \param x: The x-coordinate of the cursor. + * \param y: The y-coordinate of the cursor. * \return Indication of success. */ extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle, @@ -405,9 +402,9 @@ extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle, /** * Updates the location of the cursor (location in screen coordinates). * Not all operating systems allow the cursor to be moved (without the input device being moved). - * \param systemhandle The handle to the system - * \param x The x-coordinate of the cursor. - * \param y The y-coordinate of the cursor. + * \param systemhandle: The handle to the system. + * \param x: The x-coordinate of the cursor. + * \param y: The y-coordinate of the cursor. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle, @@ -418,10 +415,10 @@ extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle, * Grabs the cursor for a modal operation, to keep receiving * events when the mouse is outside the window. X11 only, others * do this automatically. - * \param windowhandle The handle to the window - * \param mode The new grab state of the cursor. - * \param bounds The grab region (optional) - left,top,right,bottom - * \param mouse_ungrab_xy XY for new mouse location (optional) - x,y + * \param windowhandle: The handle to the window. + * \param mode: The new grab state of the cursor. + * \param bounds: The grab region (optional) - left,top,right,bottom. + * \param mouse_ungrab_xy: XY for new mouse location (optional). * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetCursorGrab(GHOST_WindowHandle windowhandle, @@ -436,9 +433,9 @@ extern GHOST_TSuccess GHOST_SetCursorGrab(GHOST_WindowHandle windowhandle, /** * Returns the state of a modifier key (outside the message queue). - * \param systemhandle The handle to the system - * \param mask The modifier key state to retrieve. - * \param isDown Pointer to return modifier state in. + * \param systemhandle: The handle to the system. + * \param mask: The modifier key state to retrieve. + * \param isDown: Pointer to return modifier state in. * \return Indication of success. */ extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle, @@ -447,9 +444,9 @@ extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle, /** * Returns the state of a mouse button (outside the message queue). - * \param systemhandle The handle to the system - * \param mask The button state to retrieve. - * \param isDown Pointer to return button state in. + * \param systemhandle: The handle to the system. + * \param mask: The button state to retrieve. + * \param isDown: Pointer to return button state in. * \return Indication of success. */ extern GHOST_TSuccess GHOST_GetButtonState(GHOST_SystemHandle systemhandle, @@ -479,14 +476,14 @@ extern void GHOST_setAcceptDragOperation(GHOST_WindowHandle windowhandle, GHOST_ /** * Returns the event type. - * \param eventhandle The handle to the event + * \param eventhandle: The handle to the event. * \return The event type. */ extern GHOST_TEventType GHOST_GetEventType(GHOST_EventHandle eventhandle); /** * Returns the time this event was generated. - * \param eventhandle The handle to the event + * \param eventhandle: The handle to the event. * \return The event generation time. */ extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle); @@ -494,66 +491,66 @@ extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle); /** * Returns the window this event was generated on, * or NULL if it is a 'system' event. - * \param eventhandle The handle to the event + * \param eventhandle: The handle to the event. * \return The generating window. */ extern GHOST_WindowHandle GHOST_GetEventWindow(GHOST_EventHandle eventhandle); /** * Returns the event data. - * \param eventhandle The handle to the event + * \param eventhandle: The handle to the event. * \return The event data. */ extern GHOST_TEventDataPtr GHOST_GetEventData(GHOST_EventHandle eventhandle); /** * Returns the timer callback. - * \param timertaskhandle The handle to the timer-task. + * \param timertaskhandle: The handle to the timer-task. * \return The timer callback. */ extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhandle); /** * Changes the timer callback. - * \param timertaskhandle The handle to the timertask - * \param timerProc The timer callback. + * \param timertaskhandle: The handle to the timertask. + * \param timerProc: The timer callback. */ extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle, GHOST_TimerProcPtr timerProc); /** * Returns the timer user data. - * \param timertaskhandle The handle to the timertask + * \param timertaskhandle: The handle to the timertask. * \return The timer user data. */ extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle); /** * Changes the time user data. - * \param timertaskhandle The handle to the timertask - * \param userdata The timer user data. + * \param timertaskhandle: The handle to the timertask. + * \param userdata: The timer user data. */ extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle, GHOST_TUserDataPtr userdata); /** * Returns indication as to whether the window is valid. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The validity of the window. */ extern int GHOST_GetValid(GHOST_WindowHandle windowhandle); /** * Returns the type of drawing context used in this window. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The current type of drawing context. */ extern GHOST_TDrawingContextType GHOST_GetDrawingContextType(GHOST_WindowHandle windowhandle); /** * Tries to install a rendering context in this window. - * \param windowhandle The handle to the window - * \param type The type of rendering context installed. + * \param windowhandle: The handle to the window. + * \param type: The type of rendering context installed. * \return Indication as to whether installation has succeeded. */ extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandle, @@ -561,8 +558,8 @@ extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandl /** * Sets the title displayed in the title bar. - * \param windowhandle The handle to the window - * \param title The title to display in the title bar. + * \param windowhandle: The handle to the window. + * \param title: The title to display in the title bar. */ extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle, const char *title); @@ -570,7 +567,7 @@ extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle, const char *title); * Returns the title displayed in the title bar. The title * should be free'd with free(). * - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The title, free with free(). */ extern char *GHOST_GetTitle(GHOST_WindowHandle windowhandle); @@ -578,7 +575,7 @@ extern char *GHOST_GetTitle(GHOST_WindowHandle windowhandle); /** * Returns the window rectangle dimensions. * These are screen coordinates. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return A handle to the bounding rectangle of the window. */ extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhandle); @@ -586,38 +583,38 @@ extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhand /** * Returns the client rectangle dimensions. * The left and top members of the rectangle are always zero. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return A handle to the bounding rectangle of the window. */ extern GHOST_RectangleHandle GHOST_GetClientBounds(GHOST_WindowHandle windowhandle); /** - * Disposes a rectangle object - * \param rectanglehandle Handle to the rectangle. + * Disposes a rectangle object. + * \param rectanglehandle: Handle to the rectangle. */ void GHOST_DisposeRectangle(GHOST_RectangleHandle rectanglehandle); /** * Resizes client rectangle width. - * \param windowhandle The handle to the window - * \param width The new width of the client area of the window. + * \param windowhandle: The handle to the window. + * \param width: The new width of the client area of the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetClientWidth(GHOST_WindowHandle windowhandle, GHOST_TUns32 width); /** * Resizes client rectangle height. - * \param windowhandle The handle to the window - * \param height The new height of the client area of the window. + * \param windowhandle: The handle to the window. + * \param height: The new height of the client area of the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetClientHeight(GHOST_WindowHandle windowhandle, GHOST_TUns32 height); /** * Resizes client rectangle. - * \param windowhandle The handle to the window - * \param width The new width of the client area of the window. - * \param height The new height of the client area of the window. + * \param windowhandle: The handle to the window. + * \param width: The new width of the client area of the window. + * \param height: The new height of the client area of the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle, @@ -626,11 +623,11 @@ extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle, /** * Converts a point in screen coordinates to client rectangle coordinates - * \param windowhandle The handle to the window - * \param inX The x-coordinate on the screen. - * \param inY The y-coordinate on the screen. - * \param outX The x-coordinate in the client rectangle. - * \param outY The y-coordinate in the client rectangle. + * \param windowhandle: The handle to the window. + * \param inX: The x-coordinate on the screen. + * \param inY: The y-coordinate on the screen. + * \param outX: The x-coordinate in the client rectangle. + * \param outY: The y-coordinate in the client rectangle. */ extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle, GHOST_TInt32 inX, @@ -640,11 +637,11 @@ extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle, /** * Converts a point in screen coordinates to client rectangle coordinates - * \param windowhandle The handle to the window - * \param inX The x-coordinate in the client rectangle. - * \param inY The y-coordinate in the client rectangle. - * \param outX The x-coordinate on the screen. - * \param outY The y-coordinate on the screen. + * \param windowhandle: The handle to the window. + * \param inX: The x-coordinate in the client rectangle. + * \param inY: The y-coordinate in the client rectangle. + * \param outX: The x-coordinate on the screen. + * \param outY: The y-coordinate on the screen. */ extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle, GHOST_TInt32 inX, @@ -654,24 +651,24 @@ extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle, /** * Returns the state of the window (normal, minimized, maximized). - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return The state of the window. */ extern GHOST_TWindowState GHOST_GetWindowState(GHOST_WindowHandle windowhandle); /** * Sets the state of the window (normal, minimized, maximized). - * \param windowhandle The handle to the window - * \param state The state of the window. + * \param windowhandle: The handle to the window. + * \param state: The state of the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetWindowState(GHOST_WindowHandle windowhandle, GHOST_TWindowState state); /** - * Sets the window "modified" status, indicating unsaved changes - * \param windowhandle The handle to the window - * \param isUnsavedChanges Unsaved changes or not + * Sets the window "modified" status, indicating unsaved changes. + * \param windowhandle: The handle to the window. + * \param isUnsavedChanges: Unsaved changes or not. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetWindowModifiedState(GHOST_WindowHandle windowhandle, @@ -679,8 +676,8 @@ extern GHOST_TSuccess GHOST_SetWindowModifiedState(GHOST_WindowHandle windowhand /** * Sets the order of the window (bottom, top). - * \param windowhandle The handle to the window - * \param order The order of the window. + * \param windowhandle: The handle to the window. + * \param order: The order of the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle, @@ -688,20 +685,20 @@ extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle, /** * Swaps front and back buffers of a window. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return A success indicator. */ extern GHOST_TSuccess GHOST_SwapWindowBuffers(GHOST_WindowHandle windowhandle); /** - * Sets the swap interval for swapBuffers. - * \param interval The swap interval to use. + * Sets the swap interval for #swapBuffers. + * \param interval: The swap interval to use. * \return A boolean success indicator. */ extern GHOST_TSuccess GHOST_SetSwapInterval(GHOST_WindowHandle windowhandle, int interval); /** - * Gets the current swap interval for swapBuffers. + * Gets the current swap interval for #swapBuffers. * \param windowhandle: The handle to the window * \param intervalOut: pointer to location to return swap interval * (left untouched if there is an error) @@ -711,28 +708,28 @@ extern GHOST_TSuccess GHOST_GetSwapInterval(GHOST_WindowHandle windowhandle, int /** * Activates the drawing context of this window. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return A success indicator. */ extern GHOST_TSuccess GHOST_ActivateWindowDrawingContext(GHOST_WindowHandle windowhandle); /** * Invalidates the contents of this window. - * \param windowhandle The handle to the window + * \param windowhandle: The handle to the window. * \return Indication of success. */ extern GHOST_TSuccess GHOST_InvalidateWindow(GHOST_WindowHandle windowhandle); /** * Activates the drawing context of this context. - * \param contexthandle The handle to the context + * \param contexthandle: The handle to the context. * \return A success indicator. */ extern GHOST_TSuccess GHOST_ActivateOpenGLContext(GHOST_ContextHandle contexthandle); /** * Release the drawing context bound to this thread. - * \param contexthandle The handle to the context + * \param contexthandle: The handle to the context. * \return A success indicator. */ extern GHOST_TSuccess GHOST_ReleaseOpenGLContext(GHOST_ContextHandle contexthandle); @@ -756,32 +753,32 @@ extern unsigned int GHOST_GetDefaultOpenGLFramebuffer(GHOST_WindowHandle windwHa /** * Set which tablet API to use. Only affects Windows, other platforms have a single API. - * \param systemhandle The handle to the system - * \param api Enum indicating which API to use. + * \param systemhandle: The handle to the system. + * \param api: Enum indicating which API to use. */ extern void GHOST_SetTabletAPI(GHOST_SystemHandle systemhandle, GHOST_TTabletAPI api); /** * Access to rectangle width. - * \param rectanglehandle The handle to the rectangle + * \param rectanglehandle: The handle to the rectangle. * \return width of the rectangle */ extern GHOST_TInt32 GHOST_GetWidthRectangle(GHOST_RectangleHandle rectanglehandle); /** * Access to rectangle height. - * \param rectanglehandle The handle to the rectangle + * \param rectanglehandle: The handle to the rectangle. * \return height of the rectangle */ extern GHOST_TInt32 GHOST_GetHeightRectangle(GHOST_RectangleHandle rectanglehandle); /** * Gets all members of the rectangle. - * \param rectanglehandle The handle to the rectangle - * \param l Pointer to return left coordinate in. - * \param t Pointer to return top coordinate in. - * \param r Pointer to return right coordinate in. - * \param b Pointer to return bottom coordinate in. + * \param rectanglehandle: The handle to the rectangle. + * \param l: Pointer to return left coordinate in. + * \param t: Pointer to return top coordinate in. + * \param r: Pointer to return right coordinate in. + * \param b: Pointer to return bottom coordinate in. */ extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 *l, @@ -791,11 +788,11 @@ extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle, /** * Sets all members of the rectangle. - * \param rectanglehandle The handle to the rectangle - * \param l requested left coordinate of the rectangle - * \param t requested top coordinate of the rectangle - * \param r requested right coordinate of the rectangle - * \param b requested bottom coordinate of the rectangle + * \param rectanglehandle: The handle to the rectangle. + * \param l: requested left coordinate of the rectangle. + * \param t: requested top coordinate of the rectangle. + * \param r: requested right coordinate of the rectangle. + * \param b: requested bottom coordinate of the rectangle. */ extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 l, @@ -806,7 +803,7 @@ extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle, /** * Returns whether this rectangle is empty. * Empty rectangles are rectangles that have width==0 and/or height==0. - * \param rectanglehandle The handle to the rectangle + * \param rectanglehandle: The handle to the rectangle. * \return Success value (true == empty rectangle) */ extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehandle); @@ -815,7 +812,7 @@ extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehand * Returns whether this rectangle is valid. * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. * Thus, empty rectangles are valid. - * \param rectanglehandle The handle to the rectangle + * \param rectanglehandle: The handle to the rectangle. * \return Success value (true == valid rectangle) */ extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehandle); @@ -823,25 +820,25 @@ extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehand /** * Grows (or shrinks the rectangle). * The method avoids negative insets making the rectangle invalid - * \param rectanglehandle The handle to the rectangle - * \param i The amount of offset given to each extreme (negative values shrink the rectangle). + * \param rectanglehandle: The handle to the rectangle. + * \param i: The amount of offset given to each extreme (negative values shrink the rectangle). */ extern void GHOST_InsetRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 i); /** * Does a union of the rectangle given and this rectangle. * The result is stored in this rectangle. - * \param rectanglehandle The handle to the rectangle - * \param anotherrectanglehandle The rectangle that is input for the union operation. + * \param rectanglehandle: The handle to the rectangle. + * \param anotherrectanglehandle: The rectangle that is input for the union operation. */ extern void GHOST_UnionRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle); /** * Grows the rectangle to included a point. - * \param rectanglehandle The handle to the rectangle - * \param x The x-coordinate of the point. - * \param y The y-coordinate of the point. + * \param rectanglehandle: The handle to the rectangle. + * \param x: The x-coordinate of the point. + * \param y: The y-coordinate of the point. */ extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 x, @@ -850,9 +847,9 @@ extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle, /** * Returns whether the point is inside this rectangle. * Point on the boundary is considered inside. - * \param rectanglehandle The handle to the rectangle - * \param x x-coordinate of point to test. - * \param y y-coordinate of point to test. + * \param rectanglehandle: The handle to the rectangle. + * \param x: x-coordinate of point to test. + * \param y: y-coordinate of point to test. * \return Success value (true if point is inside). */ extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehandle, @@ -861,8 +858,8 @@ extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehan /** * Returns whether the rectangle is inside this rectangle. - * \param rectanglehandle The handle to the rectangle - * \param anotherrectanglehandle The rectangle to test. + * \param rectanglehandle: The handle to the rectangle. + * \param anotherrectanglehandle: The rectangle to test. * \return visibility (not, partially or fully visible). */ extern GHOST_TVisibility GHOST_GetRectangleVisibility( @@ -871,9 +868,9 @@ extern GHOST_TVisibility GHOST_GetRectangleVisibility( /** * Sets rectangle members. * Sets rectangle members such that it is centered at the given location. - * \param rectanglehandle The handle to the rectangle - * \param cx Requested center x-coordinate of the rectangle - * \param cy Requested center y-coordinate of the rectangle + * \param rectanglehandle: The handle to the rectangle. + * \param cx: Requested center x-coordinate of the rectangle. + * \param cy: Requested center y-coordinate of the rectangle. */ extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 cx, @@ -883,11 +880,11 @@ extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle, * Sets rectangle members. * Sets rectangle members such that it is centered at the given location, * with the width requested. - * \param rectanglehandle The handle to the rectangle - * \param cx requested center x-coordinate of the rectangle - * \param cy requested center y-coordinate of the rectangle - * \param w requested width of the rectangle - * \param h requested height of the rectangle + * \param rectanglehandle: The handle to the rectangle. + * \param cx: requested center x-coordinate of the rectangle. + * \param cy: requested center y-coordinate of the rectangle. + * \param w: requested width of the rectangle. + * \param h: requested height of the rectangle. */ extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 cx, @@ -899,8 +896,8 @@ extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle, * Clips a rectangle. * Updates the rectangle given such that it will fit within this one. * This can result in an empty rectangle. - * \param rectanglehandle The handle to the rectangle - * \param anotherrectanglehandle The rectangle to clip + * \param rectanglehandle: The handle to the rectangle. + * \param anotherrectanglehandle: The rectangle to clip. * \return Whether clipping has occurred */ extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle, @@ -908,21 +905,21 @@ extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle, /** * Return the data from the clipboard - * \param selection Boolean to return the selection instead, X11 only feature. + * \param selection: Boolean to return the selection instead, X11 only feature. * \return clipboard data */ extern GHOST_TUns8 *GHOST_getClipboard(int selection); /** * Put data to the Clipboard - * \param buffer the string buffer to set. - * \param selection Set the selection instead, X11 only feature. + * \param buffer: the string buffer to set. + * \param selection: Set the selection instead, X11 only feature. */ extern void GHOST_putClipboard(GHOST_TInt8 *buffer, int selection); /** * Toggles console - * \param action + * \param action: * - 0: Hides * - 1: Shows * - 2: Toggles @@ -955,14 +952,14 @@ extern GHOST_TUns16 GHOST_GetDPIHint(GHOST_WindowHandle windowhandle); /** * Enable IME attached to the given window, i.e. allows user-input * events to be dispatched to the IME. - * \param windowhandle Window handle of the caller - * \param x Requested x-coordinate of the rectangle - * \param y Requested y-coordinate of the rectangle - * \param w Requested width of the rectangle - * \param h Requested height of the rectangle - * \param complete Whether or not to complete the ongoing composition - * true: Start a new composition - * false: Move the IME windows to the given position without finishing it. + * \param windowhandle: Window handle of the caller. + * \param x: Requested x-coordinate of the rectangle. + * \param y: Requested y-coordinate of the rectangle. + * \param w: Requested width of the rectangle. + * \param h: Requested height of the rectangle. + * \param complete: Whether or not to complete the ongoing composition. + * - true: Start a new composition. + * - false: Move the IME windows to the given position without finishing it. */ extern void GHOST_BeginIME(GHOST_WindowHandle windowhandle, GHOST_TInt32 x, @@ -973,7 +970,7 @@ extern void GHOST_BeginIME(GHOST_WindowHandle windowhandle, /** * Disable the IME attached to the given window, i.e. prohibits any user-input * events from being dispatched to the IME. - * \param windowhandle The window handle of the caller + * \param windowhandle: The window handle of the caller. */ extern void GHOST_EndIME(GHOST_WindowHandle windowhandle); @@ -1071,4 +1068,5 @@ GHOST_TSuccess GHOST_XrEventsHandle(GHOST_XrContextHandle xr_context); #ifdef __cplusplus } + #endif |