blender
/
blender
136
406
Fork 589
Code Issues 6.2k Pull Requests 750 Projects 19 Wiki Activity

Cleanup: doxygen comments in ghost 

Use colon after parameters, use hash to reference symbols.
This commit is contained in:
Campbell Barton 2020-11-06 14:18:55 +11:00
parent f11f7ce08e
commit eed6bf22a4
54 changed files with 884 additions and 886 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

398
intern/ghost/GHOST_C-api.h
View File

@ -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

4
intern/ghost/GHOST_IContext.h
View File

@ -44,13 +44,13 @@ class GHOST_IContext {
/**
* Activates the drawing context.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess activateDrawingContext() = 0;
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess releaseDrawingContext() = 0;

4
intern/ghost/GHOST_IEventConsumer.h
View File

@ -46,8 +46,8 @@ class GHOST_IEventConsumer {
/**
* This method is called by the system when it has events to dispatch.
* \see GHOST_ISystem#dispatchEvents
* \param event The event that can be handled or ignored.
* \return Indication as to whether the event was handled.
* \param event: The event that can be handled or ignored.
* \return Indication as to whether the event was handled.
*/
virtual bool processEvent(GHOST_IEvent *event) = 0;

86
intern/ghost/GHOST_ISystem.h
View File

@ -183,10 +183,10 @@ class GHOST_ISystem {
* Installs a timer.
* Note that, on most operating systems, messages need to be processed in order
* for the timer callbacks to be invoked.
* \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 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).
*/
virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
@ -196,7 +196,7 @@ class GHOST_ISystem {
/**
* Removes a timer.
* \param timerTask Timer task to be removed.
* \param timerTask: Timer task to be removed.
* \return Indication of success.
*/
virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
@ -255,38 +255,38 @@ class GHOST_ISystem {
/**
* Dispose a window.
* \param window Pointer to the window to be disposed.
* \return Indication of success.
* \param window: Pointer to the window to be disposed.
* \return Indication of success.
*/
virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;
/**
* Create a new offscreen context.
* Never explicitly delete the context, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
virtual GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings) = 0;
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
virtual GHOST_TSuccess disposeContext(GHOST_IContext *context) = 0;
/**
* Returns whether a window is valid.
* \param window Pointer to the window to be checked.
* \return Indication of validity.
* \param window: Pointer to the window to be checked.
* \return Indication of validity.
*/
virtual bool validWindow(GHOST_IWindow *window) = 0;
/**
* Begins full screen mode.
* \param setting The new setting of the display.
* \param window Window displayed in full screen.
* \param setting: The new setting of the display.
* \param window: Window displayed in full screen.
* This window is invalid after full screen has been ended.
* \return Indication of success.
* \return Indication of success.
*/
virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting &setting,
GHOST_IWindow **window,
@ -295,17 +295,17 @@ class GHOST_ISystem {
/**
* Updates the resolution while in fullscreen mode.
* \param setting The new setting of the display.
* \param window Window displayed in full screen.
* \param setting: The new setting of the display.
* \param window: Window displayed in full screen.
*
* \return Indication of success.
* \return Indication of success.
*/
virtual GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting &setting,
GHOST_IWindow **window) = 0;
/**
* Ends full screen mode.
* \return Indication of success.
* \return Indication of success.
*/
virtual GHOST_TSuccess endFullScreen(void) = 0;
@ -331,7 +331,7 @@ class GHOST_ISystem {
/**
* Retrieves events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
* \param waitForEvent: Flag to wait for an event (or return immediately).
* \return Indication of the presence of events.
*/
virtual bool processEvents(bool waitForEvent) = 0;
@ -343,14 +343,14 @@ class GHOST_ISystem {
/**
* Adds the given event consumer to our list.
* \param consumer The event consumer to add.
* \param consumer: The event consumer to add.
* \return Indication of success.
*/
virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) = 0;
/**
* Removes the given event consumer to our list.
* \param consumer The event consumer to remove.
* \param consumer: The event consumer to remove.
* \return Indication of success.
*/
virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) = 0;
@ -361,18 +361,18 @@ class GHOST_ISystem {
/**
* Returns the current location of the cursor (location in screen coordinates)
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32 &x, GHOST_TInt32 &y) const = 0;
/**
* 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 x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
@ -382,23 +382,23 @@ class GHOST_ISystem {
/**
* Returns the state of a modifier key (outside the message queue).
* \param mask The modifier key state to retrieve.
* \param isDown The state of a modifier key (true == pressed).
* \return Indication of success.
* \param mask: The modifier key state to retrieve.
* \param isDown: The state of a modifier key (true == pressed).
* \return Indication of success.
*/
virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool &isDown) const = 0;
/**
* Returns the state of a mouse button (outside the message queue).
* \param mask The button state to retrieve.
* \param isDown Button state.
* \return Indication of success.
* \param mask: The button state to retrieve.
* \param isDown: Button state.
* \return Indication of success.
*/
virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool &isDown) const = 0;
/**
* Set which tablet API to use. Only affects Windows, other platforms have a single API.
* \param api Enum indicating which API to use.
* \param api: Enum indicating which API to use.
*/
virtual void setTabletAPI(GHOST_TTabletAPI api) = 0;
@ -412,8 +412,8 @@ class GHOST_ISystem {
/**
* Toggles console
* \param action
* - 0: Hides
* \param action:
* - 0: Hides.
* - 1: Shows
* - 2: Toggles
* - 3: Hides if it runs not from command line
@ -445,12 +445,12 @@ class GHOST_ISystem {
/**
* Show a system message box
*
* \param title The title of the message box
* \param message The message to display
* \param help_label Help button label
* \param continue_label Continue button label
* \param link An optional hyperlink
* \param dialog_options Options how to display the message
* \param title: The title of the message box.
* \param message: The message to display.
* \param help_label: Help button label.
* \param continue_label: Continue button label.
* \param link: An optional hyperlink.
* \param dialog_options: Options how to display the message.
*/
virtual GHOST_TSuccess showMessageBox(const char * /*title*/,
const char * /*message*/,

2
intern/ghost/GHOST_ITimerTask.h
View File

@ -55,7 +55,7 @@ class GHOST_ITimerTask {
/**
* Changes the timer callback.
* \param timerProc The timer callback.
* \param timerProc: The timer callback.
*/
virtual void setTimerProc(const GHOST_TimerProcPtr timerProc) = 0;

98
intern/ghost/GHOST_IWindow.h
View File

@ -73,62 +73,62 @@ class GHOST_IWindow {
/**
* Tries to install a rendering context in this window.
* \param type The type of rendering context installed.
* \param type: The type of rendering context installed.
* \return Indication as to whether installation has succeeded.
*/
virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
/**
* Sets the title displayed in the title bar.
* \param title The title to display in the title bar.
* \param title: The title to display in the title bar.
*/
virtual void setTitle(const char *title) = 0;
/**
* Returns the title displayed in the title bar.
* \param title The title displayed in the title bar.
* \param title: The title displayed in the title bar.
*/
virtual std::string getTitle() const = 0;
/**
* Returns the window rectangle dimensions.
* These are screen coordinates.
* \param bounds The bounding rectangle of the window.
* \param bounds: The bounding rectangle of the window.
*/
virtual void getWindowBounds(GHOST_Rect &bounds) const = 0;
/**
* Returns the client rectangle dimensions.
* The left and top members of the rectangle are always zero.
* \param bounds The bounding rectangle of the client area of the window.
* \param bounds: The bounding rectangle of the client area of the window.
*/
virtual void getClientBounds(GHOST_Rect &bounds) const = 0;
/**
* Resizes client rectangle width.
* \param width The new width of the client area of the window.
* \param width: The new width of the client area of the window.
*/
virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
/**
* Resizes client rectangle height.
* \param height The new height of the client area of the window.
* \param height: The new height of the client area of the window.
*/
virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
/**
* Resizes client rectangle.
* \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 width: The new width of the client area of the window.
* \param height: The new height of the client area of the window.
*/
virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
virtual void screenToClient(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -137,10 +137,10 @@ class GHOST_IWindow {
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
virtual void clientToScreen(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -166,14 +166,14 @@ class GHOST_IWindow {
/**
* Sets the state of the window (normal, minimized, maximized).
* \param state The state of the window.
* \param state: The state of the window.
* \return Indication of success.
*/
virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
/**
* Sets the window "modified" status, indicating unsaved changes
* \param isUnsavedChanges Unsaved changes or not
* \param isUnsavedChanges: Unsaved changes or not.
* \return Indication of success.
*/
virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges) = 0;
@ -186,27 +186,27 @@ class GHOST_IWindow {
/**
* Sets the order of the window (bottom, top).
* \param order The order of the window.
* \param order: The order of the window.
* \return Indication of success.
*/
virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess swapBuffers() = 0;
/**
* 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.
*/
virtual GHOST_TSuccess setSwapInterval(int interval) = 0;
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut pointer to location to return swap interval
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: pointer to location to return swap interval.
* (left untouched if there is an error)
* \return A boolean success indicator of if swap interval was successfully read.
*/
@ -214,13 +214,13 @@ class GHOST_IWindow {
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess activateDrawingContext() = 0;
/**
* Gets the OpenGL framebuffer associated with the window's contents.
* \return The name of an OpenGL framebuffer object.
* Gets the OpenGL frame-buffer associated with the window's contents.
* \return The name of an OpenGL frame-buffer object.
*/
virtual unsigned int getDefaultFramebuffer() = 0;
@ -238,7 +238,7 @@ class GHOST_IWindow {
/**
* Changes the window user data.
* \param userData The window user data.
* \param userData: The window user data.
*/
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
@ -250,7 +250,7 @@ class GHOST_IWindow {
/**
* Sets the progress bar value displayed in the window/application icon
* \param progress The progress %
* \param progress: The progress percentage (0.0 to 1.0).
*/
virtual GHOST_TSuccess setProgressBar(float progress) = 0;
@ -265,13 +265,13 @@ class GHOST_IWindow {
/**
* Returns the current cursor shape.
* \return The current cursor shape.
* \return The current cursor shape.
*/
virtual GHOST_TStandardCursor getCursorShape() const = 0;
/**
* Set the shape of the cursor.
* \param cursorShape: The new cursor shape type id.
* \param cursorShape: The new cursor shape type id.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
@ -284,11 +284,11 @@ class GHOST_IWindow {
/**
* Set the shape of the cursor to a custom cursor.
* \param bitmap The bitmap data for the cursor.
* \param mask The mask data for the cursor.
* \param hotX The X coordinate of the cursor hot-spot.
* \param hotY The Y coordinate of the cursor hot-spot.
* \return Indication of success.
* \param bitmap: The bitmap data for the cursor.
* \param mask: The mask data for the cursor.
* \param hotX: The X coordinate of the cursor hot-spot.
* \param hotY: The Y coordinate of the cursor hot-spot.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap,
GHOST_TUns8 *mask,
@ -300,21 +300,21 @@ class GHOST_IWindow {
/**
* Returns the visibility state of the cursor.
* \return The visibility state of the cursor.
* \return The visibility state of the cursor.
*/
virtual bool getCursorVisibility() const = 0;
/**
* Shows or hides the cursor.
* \param visible The new visibility state of the cursor.
* \return Indication of success.
* \param visible: The new visibility state of the cursor.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
/**
* Grabs the cursor for a modal operation.
* \param grab The new grab state of the cursor.
* \return Indication of success.
* \param grab: The new grab state of the cursor.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode /*mode*/,
GHOST_TAxisFlag /*wrap_axis*/,
@ -340,13 +340,13 @@ class GHOST_IWindow {
/**
* Enable IME attached to the given window, i.e. allows user-input
* events to be dispatched to the IME.
* \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 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.
*/
virtual void beginIME(
GHOST_TInt32 x, GHOST_TInt32 y, GHOST_TInt32 w, GHOST_TInt32 h, int completed) = 0;

42
intern/ghost/GHOST_Rect.h
View File

@ -37,10 +37,10 @@ class GHOST_Rect {
public:
/**
* Constructs a rectangle with the given values.
* \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 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.
*/
GHOST_Rect(GHOST_TInt32 l = 0, GHOST_TInt32 t = 0, GHOST_TInt32 r = 0, GHOST_TInt32 b = 0)
: m_l(l), m_t(t), m_r(r), m_b(b)
@ -56,13 +56,13 @@ class GHOST_Rect {
/**
* Access to rectangle width.
* \return width of the rectangle
* \return width of the rectangle.
*/
virtual inline GHOST_TInt32 getWidth() const;
/**
* Access to rectangle height.
* \return height of the rectangle
* \return height of the rectangle.
*/
virtual inline GHOST_TInt32 getHeight() const;
@ -86,7 +86,7 @@ class GHOST_Rect {
* 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.
* \return boolean value (true==valid rectangle)
* \return boolean value (true==valid rectangle)
*/
virtual inline bool isValid() const;
@ -113,8 +113,8 @@ class GHOST_Rect {
/**
* Grows the rectangle to included a point.
* \param x The x-coordinate of the point.
* \param y The y-coordinate of the point.
* \param x: The x-coordinate of the point.
* \param y: The y-coordinate of the point.
*/
virtual inline void wrapPoint(GHOST_TInt32 &x,
GHOST_TInt32 &y,
@ -124,24 +124,24 @@ class GHOST_Rect {
/**
* Returns whether the point is inside this rectangle.
* Point on the boundary is considered inside.
* \param x x-coordinate of point to test.
* \param y y-coordinate of point to test.
* \param x: x-coordinate of point to test.
* \param y: y-coordinate of point to test.
* \return boolean value (true if point is inside).
*/
virtual inline bool isInside(GHOST_TInt32 x, GHOST_TInt32 y) const;
/**
* Returns whether the rectangle is inside this rectangle.
* \param r rectangle to test.
* \return visibility (not, partially or fully visible).
* \param r: rectangle to test.
* \return visibility (not, partially or fully visible).
*/
virtual GHOST_TVisibility getVisibility(GHOST_Rect &r) const;
/**
* Sets rectangle members.
* Sets rectangle members such that it is centered at the given location.
* \param cx requested center x-coordinate of the rectangle
* \param cy requested center y-coordinate of the rectangle
* \param cx: requested center x-coordinate of the rectangle.
* \param cy: requested center y-coordinate of the rectangle.
*/
virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy);
@ -149,10 +149,10 @@ class GHOST_Rect {
* Sets rectangle members.
* Sets rectangle members such that it is centered at the given location,
* with the width requested.
* \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 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.
*/
virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h);
@ -160,8 +160,8 @@ class GHOST_Rect {
* Clips a rectangle.
* Updates the rectangle given such that it will fit within this one.
* This can result in an empty rectangle.
* \param r the rectangle to clip
* \return whether clipping has occurred
* \param r: the rectangle to clip.
* \return whether clipping has occurred
*/
virtual bool clip(GHOST_Rect &r) const;

4
intern/ghost/GHOST_Types.h
View File

@ -585,8 +585,8 @@ typedef int GHOST_TEmbedderWindowID;
/**
* A timer task callback routine.
* \param task The timer task object.
* \param time The current time.
* \param task: The timer task object.
* \param time: The current time.
*/
#ifdef __cplusplus
class GHOST_ITimerTask;

6
intern/ghost/intern/GHOST_Buttons.h
View File

@ -40,15 +40,15 @@ struct GHOST_Buttons {
/**
* Returns the state of a single button.
* \param mask Key button to return.
* \param mask: Key button to return.
* \return The state of the button (pressed == true).
*/
bool get(GHOST_TButtonMask mask) const;
/**
* Updates the state of a single button.
* \param mask Button state to update.
* \param down The new state of the button.
* \param mask: Button state to update.
* \param down: The new state of the button.
*/
void set(GHOST_TButtonMask mask, bool down);

6
intern/ghost/intern/GHOST_CallbackEventConsumer.h
View File

@ -35,8 +35,8 @@ class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer {
public:
/**
* Constructor.
* \param eventCallback The call-back routine invoked.
* \param userData The data passed back through the call-back routine.
* \param eventCallback: The call-back routine invoked.
* \param userData: The data passed back through the call-back routine.
*/
GHOST_CallbackEventConsumer(GHOST_EventCallbackProcPtr eventCallback,
GHOST_TUserDataPtr userData);
@ -50,7 +50,7 @@ class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer {
/**
* This method is called by an event producer when an event is available.
* \param event The event that can be handled or ignored.
* \param event: The event that can be handled or ignored.
* \return Indication as to whether the event was handled.
*/
bool processEvent(GHOST_IEvent *event);

16
intern/ghost/intern/GHOST_Context.h
View File

@ -35,7 +35,7 @@ class GHOST_Context : public GHOST_IContext {
public:
/**
* Constructor.
* \param stereoVisual Stereo visual for quad buffered stereo.
* \param stereoVisual: Stereo visual for quad buffered stereo.
*/
GHOST_Context(bool stereoVisual) : m_stereoVisual(stereoVisual)
{
@ -50,19 +50,19 @@ class GHOST_Context : public GHOST_IContext {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess swapBuffers() = 0;
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess activateDrawingContext() = 0;
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess releaseDrawingContext() = 0;
@ -89,8 +89,8 @@ class GHOST_Context : public GHOST_IContext {
virtual GHOST_TSuccess releaseNativeHandles() = 0;
/**
* 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.
*/
virtual GHOST_TSuccess setSwapInterval(int /*interval*/)
@ -99,8 +99,8 @@ class GHOST_Context : public GHOST_IContext {
}
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
virtual GHOST_TSuccess getSwapInterval(int &)

14
intern/ghost/intern/GHOST_ContextCGL.h
View File

@ -50,19 +50,19 @@ class GHOST_ContextCGL : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -82,15 +82,15 @@ class GHOST_ContextCGL : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &);

14
intern/ghost/intern/GHOST_ContextD3D.h
View File

@ -38,19 +38,19 @@ class GHOST_ContextD3D : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -77,8 +77,8 @@ class GHOST_ContextD3D : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int /*interval*/)
@ -87,8 +87,8 @@ class GHOST_ContextD3D : public GHOST_Context {
}
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &)

14
intern/ghost/intern/GHOST_ContextEGL.h
View File

@ -57,19 +57,19 @@ class GHOST_ContextEGL : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -87,15 +87,15 @@ class GHOST_ContextEGL : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);

14
intern/ghost/intern/GHOST_ContextGLX.h
View File

@ -61,19 +61,19 @@ class GHOST_ContextGLX : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -91,15 +91,15 @@ class GHOST_ContextGLX : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);

18
intern/ghost/intern/GHOST_ContextNone.h
View File

@ -35,50 +35,50 @@ class GHOST_ContextNone : public GHOST_Context {
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds
*/
GHOST_TSuccess swapBuffers();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess releaseDrawingContext();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess updateDrawingContext();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess initializeDrawingContext();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess releaseNativeHandles();
/**
* Dummy function
* \return Always succeeds
* \return Always succeeds.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Dummy function
* \param intervalOut Gets whatever was set by setSwapInterval
* \return Always succeeds
* \param intervalOut: Gets whatever was set by #setSwapInterval.
* \return Always succeeds.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);

14
intern/ghost/intern/GHOST_ContextSDL.h
View File

@ -61,19 +61,19 @@ class GHOST_ContextSDL : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -91,15 +91,15 @@ class GHOST_ContextSDL : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);

14
intern/ghost/intern/GHOST_ContextWGL.h
View File

@ -58,19 +58,19 @@ class GHOST_ContextWGL : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@ -88,15 +88,15 @@ class GHOST_ContextWGL : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* \param intervalOut Variable to store the swap interval if it can be read.
* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);

26
intern/ghost/intern/GHOST_DisplayManager.h
View File

@ -52,15 +52,15 @@ class GHOST_DisplayManager {
/**
* Returns the number of display devices on this system.
* \param numDisplays The number of displays on this system.
* \param numDisplays: The number of displays on this system.
* \return Indication of success.
*/
virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8 &numDisplays) const;
/**
* Returns the number of display settings for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param numSettings The number of settings of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param numSettings: The number of settings of the display device with this index.
* \return Indication of success.
*/
virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display,
@ -68,9 +68,9 @@ class GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param index The setting index to be returned.
* \param setting The setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param index: The setting index to be returned.
* \param setting: The setting of the display device with this index.
* \return Indication of success.
*/
virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display,
@ -79,8 +79,8 @@ class GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display,
@ -90,8 +90,8 @@ class GHOST_DisplayManager {
* Changes the current setting for this display device.
* The setting given to this method is matched against the available display settings.
* The best match is activated (@see findMatch()).
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The setting of the display device to be matched and activated.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The setting of the display device to be matched and activated.
* \return Indication of success.
*/
virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display,
@ -102,9 +102,9 @@ class GHOST_DisplayManager {
/**
* Finds the best display settings match.
* \param display The index of the display device.
* \param setting The setting to match.
* \param match The optimal display setting.
* \param display: The index of the display device.
* \param setting: The setting to match.
* \param match: The optimal display setting.
* \return Indication of success.
*/
GHOST_TSuccess findMatch(GHOST_TUns8 display,

18
intern/ghost/intern/GHOST_DisplayManagerCocoa.h
View File

@ -43,14 +43,14 @@ class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager {
/**
* Returns the number of display devices on this system.
* \param numDisplays The number of displays on this system.
* \param numDisplays: The number of displays on this system.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplays(GHOST_TUns8 &numDisplays) const;
/**
* Returns the number of display settings for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
@ -58,9 +58,9 @@ class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param index The setting index to be returned.
* \param setting The setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param index: The setting index to be returned.
* \param setting: The setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display,
@ -69,8 +69,8 @@ class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display,
@ -78,8 +78,8 @@ class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager {
/**
* Changes the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display,

18
intern/ghost/intern/GHOST_DisplayManagerWin32.h
View File

@ -42,14 +42,14 @@ class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager {
/**
* Returns the number of display devices on this system.
* \param numDisplays The number of displays on this system.
* \param numDisplays: The number of displays on this system.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplays(GHOST_TUns8 &numDisplays) const;
/**
* Returns the number of display settings for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
@ -57,9 +57,9 @@ class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param index The setting index to be returned.
* \param setting The setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param index: The setting index to be returned.
* \param setting: The setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display,
@ -68,8 +68,8 @@ class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display,
@ -77,8 +77,8 @@ class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager {
/**
* Changes the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display,

18
intern/ghost/intern/GHOST_DisplayManagerX11.h
View File

@ -40,14 +40,14 @@ class GHOST_DisplayManagerX11 : public GHOST_DisplayManager {
/**
* Returns the number of display devices on this system.
* \param numDisplays The number of displays on this system.
* \param numDisplays: The number of displays on this system.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplays(GHOST_TUns8 &numDisplays) const;
/**
* Returns the number of display settings for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
@ -55,9 +55,9 @@ class GHOST_DisplayManagerX11 : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param index The setting index to be returned.
* \param setting The setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param index: The setting index to be returned.
* \param setting: The setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display,
@ -66,8 +66,8 @@ class GHOST_DisplayManagerX11 : public GHOST_DisplayManager {
/**
* Returns the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display,
@ -75,8 +75,8 @@ class GHOST_DisplayManagerX11 : public GHOST_DisplayManager {
/**
* Changes the current setting for this display device.
* \param display The index of the display to query with 0 <= display < getNumDisplays().
* \param setting The current setting of the display device with this index.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display,

18
intern/ghost/intern/GHOST_DropTargetWin32.h
View File

@ -73,8 +73,8 @@ class GHOST_DropTargetWin32 : public IDropTarget {
* With the modifier keys, we want to distinguish left and right keys.
* Sometimes this is not possible (Windows ME for instance). Then, we want
* events generated for both keys.
* \param window The window to register as drop target.
* \param system The associated system.
* \param window: The window to register as drop target.
* \param system: The associated system.
*/
GHOST_DropTargetWin32(GHOST_WindowWin32 *window, GHOST_SystemWin32 *system);
@ -89,14 +89,14 @@ class GHOST_DropTargetWin32 : public IDropTarget {
/**
* Base the effect on those allowed by the drop-source.
* \param dwAllowed Drop sources allowed drop effect.
* \param dwAllowed: Drop sources allowed drop effect.
* \return The allowed drop effect.
*/
DWORD allowedDropEffect(DWORD dwAllowed);
/**
* Query DataObject for the data types it supports.
* \param pDataObject Pointer to the DataObject.
* \param pDataObject: Pointer to the DataObject.
* \return GHOST data type.
*/
GHOST_TDragnDropTypes getGhostType(IDataObject *pDataObject);
@ -104,21 +104,21 @@ class GHOST_DropTargetWin32 : public IDropTarget {
/**
* Get data to pass in event.
* It checks the type and calls specific functions for each type.
* \param pDataObject Pointer to the DataObject.
* \param pDataObject: Pointer to the DataObject.
* \return Pointer to data.
*/
void *getGhostData(IDataObject *pDataObject);
/**
* Allocate data as file array to pass in event.
* \param pDataObject Pointer to the DataObject.
* \param pDataObject: Pointer to the DataObject.
* \return Pointer to data.
*/
void *getDropDataAsFilenames(IDataObject *pDataObject);
/**
* Allocate data as string to pass in event.
* \param pDataObject Pointer to the DataObject.
* \param pDataObject: Pointer to the DataObject.
* \return Pointer to data.
*/
void *getDropDataAsString(IDataObject *pDataObject);
@ -127,8 +127,8 @@ class GHOST_DropTargetWin32 : public IDropTarget {
* Convert Unicode to ANSI, replacing uncomfortable chars with '?'.
* The ANSI codepage is the system default codepage,
* and can change from system to system.
* \param in LPCWSTR.
* \param out char *. Is set to NULL on failure.
* \param in: LPCWSTR.
* \param out: char *. Is set to NULL on failure.
* \return 0 on failure. Else the size of the string including '\0'.
*/
int WideCharToANSI(LPCWSTR in, char *&out);

32
intern/ghost/intern/GHOST_DropTargetX11.h
View File

@ -34,8 +34,8 @@ class GHOST_DropTargetX11 {
/**
* Constructor
*
* \param window The window to register as drop target.
* \param system The associated system.
* \param window: The window to register as drop target.
* \param system: The associated system.
*/
GHOST_DropTargetX11(GHOST_WindowX11 *window, GHOST_SystemX11 *system);
@ -52,9 +52,9 @@ class GHOST_DropTargetX11 {
/**
* Get data to pass in event.
* It checks the type and calls specific functions for each type.
* \param dropType - type of dropped entity.
* \param dropBuffer - buffer returned from source application
* \param dropBufferSize - size of returned buffer
* \param dropType: Type of dropped entity.
* \param dropBuffer: Buffer returned from source application.
* \param dropBufferSize: Size of returned buffer.
* \return Pointer to data.
*/
void *getGhostData(Atom dropType, unsigned char *dropBuffer, int dropBufferSize);
@ -73,25 +73,25 @@ class GHOST_DropTargetX11 {
void Uninitialize(void);
/**
* Get data to be passed to event from text/uri-list mime type
* \param dropBuffer - buffer returned from source application
* \param dropBufferSize - size of dropped buffer
* \return pointer to newly created GHOST data
* Get data to be passed to event from text/URI-list mime type
* \param dropBuffer: Buffer returned from source application.
* \param dropBufferSize: Size of dropped buffer.
* \return pointer to newly created GHOST data.
*/
void *getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
/**
* Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
* \param decodedOut - buffer for decoded URL
* \param bufferSize - size of output buffer
* \param encodedIn - input encoded buffer to be decoded
* Decode URL (i.e. converts `file:///a%20b/test` to `file:///a b/test`)
* \param decodedOut: - buffer for decoded URL.
* \param bufferSize: - size of output buffer.
* \param encodedIn: - input encoded buffer to be decoded.
*/
void UrlDecode(char *decodedOut, int bufferSize, const char *encodedIn);
/**
* Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
* \param fileUrl - file path URL to be fully decoded
* \return decoded file path (result should be free-d)
* Fully decode file URL (i.e. converts `file:///a%20b/test` to `/a b/test`)
* \param fileUrl: - file path URL to be fully decoded.
* \return decoded file path (result should be free-d).
*/
char *FileUrlDecode(char *fileUrl);

6
intern/ghost/intern/GHOST_Event.h
View File

@ -33,9 +33,9 @@ class GHOST_Event : public GHOST_IEvent {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of this event.
* \param window The generating window (or NULL if system event).
* \param msec: The time this event was generated.
* \param type: The type of this event.
* \param window: The generating window (or NULL if system event).
*/
GHOST_Event(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window)
: m_type(type), m_time(msec), m_window(window), m_data(NULL)

10
intern/ghost/intern/GHOST_EventButton.h
View File

@ -34,11 +34,11 @@ class GHOST_EventButton : public GHOST_Event {
public:
/**
* Constructor.
* \param time The time this event was generated.
* \param type The type of this event.
* \param window The window of this event.
* \param button The state of the buttons were at the time of the event.
* \param tablet The tablet data associated with this event.
* \param time: The time this event was generated.
* \param type: The type of this event.
* \param window: The window of this event.
* \param button: The state of the buttons were at the time of the event.
* \param tablet: The tablet data associated with this event.
*/
GHOST_EventButton(GHOST_TUns64 time,
GHOST_TEventType type,

10
intern/ghost/intern/GHOST_EventCursor.h
View File

@ -33,11 +33,11 @@ class GHOST_EventCursor : public GHOST_Event {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of this event.
* \param x The x-coordinate of the location the cursor was at the time of the event.
* \param y The y-coordinate of the location the cursor was at the time of the event.
* \param tablet The tablet data associated with this event.
* \param msec: The time this event was generated.
* \param type: The type of this event.
* \param x: The x-coordinate of the location the cursor was at the time of the event.
* \param y: The y-coordinate of the location the cursor was at the time of the event.
* \param tablet: The tablet data associated with this event.
*/
GHOST_EventCursor(GHOST_TUns64 msec,
GHOST_TEventType type,

14
intern/ghost/intern/GHOST_EventDragnDrop.h
View File

@ -64,13 +64,13 @@ class GHOST_EventDragnDrop : public GHOST_Event {
public:
/**
* Constructor.
* \param time The time this event was generated.
* \param type The type of this event.
* \param dataType The type of the drop candidate object
* \param window The window where the event occurred
* \param x The x-coordinate of the location the cursor was at the time of the event.
* \param y The y-coordinate of the location the cursor was at the time of the event.
* \param data The "content" dropped in the window
* \param time: The time this event was generated.
* \param type: The type of this event.
* \param dataType: The type of the drop candidate object.
* \param window: The window where the event occurred.
* \param x: The x-coordinate of the location the cursor was at the time of the event.
* \param y: The y-coordinate of the location the cursor was at the time of the event.
* \param data: The "content" dropped in the window.
*/
GHOST_EventDragnDrop(GHOST_TUns64 time,
GHOST_TEventType type,

14
intern/ghost/intern/GHOST_EventKey.h
View File

@ -35,9 +35,9 @@ class GHOST_EventKey : public GHOST_Event {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of key event.
* \param key The key code of the key.
* \param msec: The time this event was generated.
* \param type: The type of key event.
* \param key: The key code of the key.
*/
GHOST_EventKey(GHOST_TUns64 msec,
GHOST_TEventType type,
@ -55,10 +55,10 @@ class GHOST_EventKey : public GHOST_Event {
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of key event.
* \param key The key code of the key.
* \param ascii The ascii code for the key event.
* \param msec: The time this event was generated.
* \param type: The type of key event.
* \param key: The key code of the key.
* \param ascii: The ascii code for the key event.
*/
GHOST_EventKey(GHOST_TUns64 msec,
GHOST_TEventType type,

18
intern/ghost/intern/GHOST_EventManager.h
View File

@ -57,7 +57,7 @@ class GHOST_EventManager {
/**
* Returns the number of events of a certain type currently on the stack.
* \param type The type of events to be counted.
* \param type: The type of events to be counted.
* \return The number of events on the stack of this type.
*/
GHOST_TUns32 getNumEvents(GHOST_TEventType type);
@ -66,7 +66,7 @@ class GHOST_EventManager {
* Pushes an event on the stack.
* To dispatch it, call dispatchEvent() or dispatchEvents().
* Do not delete the event!
* \param event The event to push on the stack.
* \param event: The event to push on the stack.
*/
GHOST_TSuccess pushEvent(GHOST_IEvent *event);
@ -89,30 +89,30 @@ class GHOST_EventManager {
/**
* Adds a consumer to the list of event consumers.
* \param consumer The consumer added to the list.
* \param consumer: The consumer added to the list.
* \return Indication as to whether addition has succeeded.
*/
GHOST_TSuccess addConsumer(GHOST_IEventConsumer *consumer);
/**
* Removes a consumer from the list of event consumers.
* \param consumer The consumer removed from the list.
* \param consumer: The consumer removed from the list.
* \return Indication as to whether removal has succeeded.
*/
GHOST_TSuccess removeConsumer(GHOST_IEventConsumer *consumer);
/**
* Removes all events for a window from the stack.
* \param window The window to remove events for.
* \param window: The window to remove events for.
*/
void removeWindowEvents(GHOST_IWindow *window);
/**
* Removes all events of a certain type from the stack.
* The window parameter is optional. If non-null, the routine will remove
* events only associated with that window.
* \param type The type of events to be removed.
* \param window The window to remove the events for.
* The window parameter is optional.
* If non-null, the routine will remove events only associated with that window.
* \param type: The type of events to be removed.
* \param window: The window to remove the events for.
*/
void removeTypeEvents(GHOST_TEventType type, GHOST_IWindow *window = NULL);

6
intern/ghost/intern/GHOST_EventPrinter.h
View File

@ -34,7 +34,7 @@ class GHOST_EventPrinter : public GHOST_IEventConsumer {
public:
/**
* Prints all the events received to std out.
* \param event The event that can be handled or not.
* \param event: The event that can be handled or not.
* \return Indication as to whether the event was handled.
*/
bool processEvent(GHOST_IEvent *event);
@ -42,8 +42,8 @@ class GHOST_EventPrinter : public GHOST_IEventConsumer {
protected:
/**
* Converts GHOST key code to a readable string.
* \param key The GHOST key code to convert.
* \param str The GHOST key code converted to a readable string.
* \param key: The GHOST key code to convert.
* \param str: The GHOST key code converted to a readable string.
*/
void getKeyString(GHOST_TKey key, char str[32]) const;
};

8
intern/ghost/intern/GHOST_EventString.h
View File

@ -33,10 +33,10 @@ class GHOST_EventString : public GHOST_Event {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of this event.
* \param window The generating window (or NULL if system event).
* \param data_ptr Pointer to the (unformatted) data associated with the event
* \param msec: The time this event was generated.
* \param type: The type of this event.
* \param window: The generating window (or NULL if system event).
* \param data_ptr: Pointer to the (un-formatted) data associated with the event.
*/
GHOST_EventString(GHOST_TUns64 msec,
GHOST_TEventType type,

8
intern/ghost/intern/GHOST_EventTrackpad.h
View File

@ -33,11 +33,11 @@ class GHOST_EventTrackpad : public GHOST_Event {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param msec: The time this event was generated.
* \param window: The window of this event.
* \param subtype The subtype of the event.
* \param x The x-delta of the pan event.
* \param y The y-delta of the pan event.
* \param subtype: The subtype of the event.
* \param x: The x-delta of the pan event.
* \param y: The y-delta of the pan event.
*/
GHOST_EventTrackpad(GHOST_TUns64 msec,
GHOST_IWindow *window,

4
intern/ghost/intern/GHOST_IXrGraphicsBinding.h
View File

@ -44,8 +44,8 @@ class GHOST_IXrGraphicsBinding {
* Does __not__ require this object is initialized (can be called prior to
* #initFromGhostContext). It's actually meant to be called first.
*
* \param r_requirement_info Return argument to retrieve an informal string on the requirements
* to be met. Useful for error/debug messages.
* \param r_requirement_info: Return argument to retrieve an informal string on the requirements.
* to be met. Useful for error/debug messages.
*/
virtual bool checkVersionRequirements(class GHOST_Context &ghost_ctx,
XrInstance instance,

6
intern/ghost/intern/GHOST_ImeWin32.h
View File

@ -40,9 +40,9 @@ class GHOST_EventIME : public GHOST_Event {
public:
/**
* Constructor.
* \param msec The time this event was generated.
* \param type The type of key event.
* \param key The key code of the key.
* \param msec: The time this event was generated.
* \param type: The type of key event.
* \param key: The key code of the key.
*/
GHOST_EventIME(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window, void *customdata)
: GHOST_Event(msec, type, window)

2
intern/ghost/intern/GHOST_ModifierKeys.h
View File

@ -40,7 +40,7 @@ struct GHOST_ModifierKeys {
/**
* Returns the modifier key's key code from a modifier key mask.
* \param mask The mask of the modifier key.
* \param mask: The mask of the modifier key.
* \return The modifier key's key code.
*/
static GHOST_TKey getModifierKeyCode(GHOST_TModifierKeyMask mask);

90
intern/ghost/intern/GHOST_System.h
View File

@ -79,12 +79,14 @@ class GHOST_System : public GHOST_ISystem {
/**
* Installs a timer.
* Note that, on most operating systems, messages need to be processed in order
*
* \note On most operating systems, messages need to be processed in order
* for the timer callbacks to be invoked.
* \param delay The time to wait for the first call to the timerProc (in milliseconds)
* \param interval The interval between calls to the timerProc
* \param timerProc The callback invoked when the interval expires,
* \param userData Placeholder for user data.
*
* \param delay: The time to wait for the first call to the #timerProc (in milliseconds).
* \param interval: The interval between calls to the #timerProc.
* \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).
*/
GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
@ -94,7 +96,7 @@ class GHOST_System : public GHOST_ISystem {
/**
* Removes a timer.
* \param timerTask Timer task to be removed.
* \param timerTask: Timer task to be removed.
* \return Indication of success.
*/
GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask);
@ -105,32 +107,32 @@ class GHOST_System : public GHOST_ISystem {
/**
* Dispose a window.
* \param window Pointer to the window to be disposed.
* \return Indication of success.
* \param window: Pointer to the window to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess disposeWindow(GHOST_IWindow *window);
/**
* Create a new offscreen context.
* Never explicitly delete the context, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
virtual GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings) = 0;
/**
* Returns whether a window is valid.
* \param window Pointer to the window to be checked.
* \return Indication of validity.
* \param window: Pointer to the window to be checked.
* \return Indication of validity.
*/
bool validWindow(GHOST_IWindow *window);
/**
* Begins full screen mode.
* \param setting The new setting of the display.
* \param window Window displayed in full screen.
* \param stereoVisual Stereo visual for quad buffered stereo.
* \param setting: The new setting of the display.
* \param window: Window displayed in full screen.
* \param stereoVisual: Stereo visual for quad buffered stereo.
* This window is invalid after full screen has been ended.
* \return Indication of success.
* \return Indication of success.
*/
GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting &setting,
GHOST_IWindow **window,
@ -139,16 +141,16 @@ class GHOST_System : public GHOST_ISystem {
/**
* Updates the resolution while in fullscreen mode.
* \param setting The new setting of the display.
* \param window Window displayed in full screen.
* \param setting: The new setting of the display.
* \param window: Window displayed in full screen.
*
* \return Indication of success.
* \return Indication of success.
*/
GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting &setting, GHOST_IWindow **window);
/**
* Ends full screen mode.
* \return Indication of success.
* \return Indication of success.
*/
GHOST_TSuccess endFullScreen(void);
@ -189,14 +191,14 @@ class GHOST_System : public GHOST_ISystem {
/**
* Adds the given event consumer to our list.
* \param consumer The event consumer to add.
* \param consumer: The event consumer to add.
* \return Indication of success.
*/
GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer);
/**
* Remove the given event consumer to our list.
* \param consumer The event consumer to remove.
* \param consumer: The event consumer to remove.
* \return Indication of success.
*/
GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer);
@ -219,23 +221,23 @@ class GHOST_System : public GHOST_ISystem {
/**
* Returns the state of a modifier key (outside the message queue).
* \param mask The modifier key state to retrieve.
* \param isDown The state of a modifier key (true == pressed).
* \return Indication of success.
* \param mask: The modifier key state to retrieve.
* \param isDown: The state of a modifier key (true == pressed).
* \return Indication of success.
*/
GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool &isDown) const;
/**
* Returns the state of a mouse button (outside the message queue).
* \param mask The button state to retrieve.
* \param isDown Button state.
* \return Indication of success.
* \param mask: The button state to retrieve.
* \param isDown: Button state.
* \return Indication of success.
*/
GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool &isDown) const;
/**
* Set which tablet API to use. Only affects Windows, other platforms have a single API.
* \param api Enum indicating which API to use.
* \param api: Enum indicating which API to use.
*/
virtual void setTabletAPI(GHOST_TTabletAPI api);
GHOST_TTabletAPI getTabletAPI(void);
@ -260,7 +262,7 @@ class GHOST_System : public GHOST_ISystem {
* Pushes an event on the stack.
* To dispatch it, call dispatchEvent() or dispatchEvents().
* Do not delete the event!
* \param event The event to push on the stack.
* \param event: The event to push on the stack.
*/
GHOST_TSuccess pushEvent(GHOST_IEvent *event);
@ -288,41 +290,41 @@ class GHOST_System : public GHOST_ISystem {
/**
* Returns the state of all modifier keys.
* \param keys The state of all modifier keys (true == pressed).
* \return Indication of success.
* \param keys: The state of all modifier keys (true == pressed).
* \return Indication of success.
*/
virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const = 0;
/**
* Returns the state of the mouse buttons (outside the message queue).
* \param buttons The state of the buttons.
* \return Indication of success.
* \param buttons: The state of the buttons.
* \return Indication of success.
*/
virtual GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const = 0;
/**
* Returns the selection buffer
* \param selection Only used on X11
* \return Returns the clipboard data
* \param selection: Only used on X11.
* \return Returns the clipboard data
*
*/
virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
/**
* Put data to the Clipboard
* \param buffer The buffer to copy to the clipboard
* \param selection The clipboard to copy too only used on X11
* \param buffer: The buffer to copy to the clipboard.
* \param selection: The clipboard to copy too only used on X11.
*/
virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
/**
* Show a system message box
* \param title The title of the message box
* \param message The message to display
* \param help_label Help button label
* \param continue_label Continue button label
* \param link An optional hyperlink
* \param dialog_options Options how to display the message
* \param title: The title of the message box.
* \param message: The message to display.
* \param help_label: Help button label.
* \param continue_label: Continue button label.
* \param link: An optional hyperlink.
* \param dialog_options: Options how to display the message.
*/
virtual GHOST_TSuccess showMessageBox(const char * /*title*/,
const char * /*message*/,
@ -363,7 +365,7 @@ class GHOST_System : public GHOST_ISystem {
/**
* Creates a fullscreen window.
* \param window The window created.
* \param window: The window created.
* \return Indication of success.
*/
GHOST_TSuccess createFullScreenWindow(GHOST_Window **window,

78
intern/ghost/intern/GHOST_SystemCocoa.h
View File

@ -85,19 +85,19 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Create a new window.
* The new window is added to the list of windows managed.
* Never explicitly delete the window, use disposeWindow() instead.
* \param title The name of the window
* Never explicitly delete the window, use #disposeWindow() instead.
* \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 settings.
* \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
* \param parentWindow Parent (embedder) window
* \return The new window (or 0 if creation failed).
* \param parentWindow: Parent (embedder) window.
* \return The new window (or 0 if creation failed).
*/
GHOST_IWindow *createWindow(const char *title,
GHOST_TInt32 left,
@ -114,14 +114,14 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Create a new offscreen context.
* Never explicitly delete the context, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings);
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess disposeContext(GHOST_IContext *context);
@ -131,7 +131,7 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Gets events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
* \param waitForEvent: Flag to wait for an event (or return immediately).
* \return Indication of the presence of events.
*/
bool processEvents(bool waitForEvent);
@ -150,12 +150,12 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Handles a drag'n'drop destination event. Called by GHOST_WindowCocoa window subclass
* \param eventType The type of drag'n'drop event
* \param draggedObjectType The type object concerned
* (currently array of file names, string, TIFF image)
* \param mouseX x mouse coordinate (in cocoa base window coordinates)
* \param mouseY y mouse coordinate
* \param window The window on which the event occurred
* \param eventType: The type of drag'n'drop event.
* \param draggedObjectType: The type object concerned.
* (currently array of file names, string, TIFF image).
* \param mouseX: x mouse coordinate (in cocoa base window coordinates).
* \param mouseY: y mouse coordinate.
* \param window: The window on which the event occurred.
* \return Indication whether the event was handled.
*/
GHOST_TSuccess handleDraggingEvent(GHOST_TEventType eventType,
@ -171,17 +171,17 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Returns the current location of the cursor (location in screen coordinates)
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess getCursorPosition(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
/**
* Updates the location of the cursor (location in screen coordinates).
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
@ -191,36 +191,36 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Returns the state of all modifier keys.
* \param keys The state of all modifier keys (true == pressed).
* \return Indication of success.
* \param keys: The state of all modifier keys (true == pressed).
* \return Indication of success.
*/
GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const;
/**
* Returns the state of the mouse buttons (outside the message queue).
* \param buttons The state of the buttons.
* \return Indication of success.
* \param buttons: The state of the buttons.
* \return Indication of success.
*/
GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const;
/**
* Returns Clipboard data
* \param selection Indicate which buffer to return
* \return Returns the selected buffer
* \param selection: Indicate which buffer to return.
* \return Returns the selected buffer
*/
GHOST_TUns8 *getClipboard(bool selection) const;
/**
* Puts buffer to system clipboard
* \param buffer The buffer to be copied
* \param selection Indicates which buffer to copy too, only used on X11
* \param buffer: The buffer to be copied.
* \param selection: Indicates which buffer to copy too, only used on X11.
*/
void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
/**
* Handles a window event. Called by GHOST_WindowCocoa window delegate
* \param eventType The type of window event
* \param window The window on which the event occurred
* \param eventType: The type of window event.
* \param window: The window on which the event occurred.
* \return Indication whether the event was handled.
*/
GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa *window);
@ -284,9 +284,9 @@ class GHOST_SystemCocoa : public GHOST_System {
/**
* Performs the actual cursor position update (location in screen coordinates).
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess setMouseCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);

6
intern/ghost/intern/GHOST_SystemCocoa.mm
View File

@ -763,7 +763,7 @@ GHOST_IWindow *GHOST_SystemCocoa::createWindow(const char *title,
/**
* Create a new offscreen context.
* Never explicitly delete the context, use #disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *GHOST_SystemCocoa::createOffscreenContext(GHOST_GLSettings glSettings)
{
@ -778,8 +778,8 @@ GHOST_IContext *GHOST_SystemCocoa::createOffscreenContext(GHOST_GLSettings glSet
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess GHOST_SystemCocoa::disposeContext(GHOST_IContext *context)
{

4
intern/ghost/intern/GHOST_SystemWin32.cpp
View File

@ -422,8 +422,8 @@ finished:
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess GHOST_SystemWin32::disposeContext(GHOST_IContext *context)
{

150
intern/ghost/intern/GHOST_SystemWin32.h
View File

@ -113,19 +113,19 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Create a new window.
* The new window is added to the list of windows managed.
* Never explicitly delete the window, use disposeWindow() instead.
* \param title The name of the window
* Never explicitly delete the window, use #disposeWindow() instead.
* \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 settings.
* \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
* \param parentWindow Parent window
* \return The new window (or 0 if creation failed).
* \param parentWindow: Parent window.
* \return The new window (or 0 if creation failed).
*/
GHOST_IWindow *createWindow(const char *title,
GHOST_TInt32 left,
@ -142,14 +142,14 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Create a new offscreen context.
* Never explicitly delete the window, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings);
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess disposeContext(GHOST_IContext *context);
@ -158,15 +158,15 @@ class GHOST_SystemWin32 : public GHOST_System {
* Never explicitly delete the context, use disposeContext() instead.
* This is for GHOST internal, Win32 specific use, so it can be called statically.
*
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
static GHOST_ContextD3D *createOffscreenContextD3D();
/**
* Dispose of a DirectX context.
* This is for GHOST internal, Win32 specific use, so it can be called statically.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
static GHOST_TSuccess disposeContextD3D(GHOST_ContextD3D *context);
@ -176,7 +176,7 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Gets events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
* \param waitForEvent: Flag to wait for an event (or return immediately).
* \return Indication of the presence of events.
*/
bool processEvents(bool waitForEvent);
@ -187,17 +187,17 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Returns the current location of the cursor (location in screen coordinates)
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess getCursorPosition(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
/**
* Updates the location of the cursor (location in screen coordinates).
* \param x The x-coordinate of the cursor.
* \param y The y-coordinate of the cursor.
* \return Indication of success.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
@ -207,40 +207,40 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Returns the state of all modifier keys.
* \param keys The state of all modifier keys (true == pressed).
* \return Indication of success.
* \param keys: The state of all modifier keys (true == pressed).
* \return Indication of success.
*/
GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const;
/**
* Returns the state of the mouse buttons (outside the message queue).
* \param buttons The state of the buttons.
* \return Indication of success.
* \param buttons: The state of the buttons.
* \return Indication of success.
*/
GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const;
/**
* Returns unsigned char from CUT_BUFFER0
* \param selection Used by X11 only
* \return Returns the Clipboard
* \param selection: Used by X11 only.
* \return Returns the Clipboard.
*/
GHOST_TUns8 *getClipboard(bool selection) const;
/**
* Puts buffer to system clipboard
* \param selection Used by X11 only
* \return No return
* Puts buffer to system clipboard.
* \param selection: Used by X11 only.
* \return No return.
*/
void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
/**
* Show a system message box
* \param title The title of the message box
* \param message The message to display
* \param help_label Help button label
* \param continue_label Continue button label
* \param link An optional hyperlink
* \param dialog_options Options how to display the message
* \param title: The title of the message box.
* \param message: The message to display.
* \param help_label: Help button label.
* \param continue_label: Continue button label.
* \param link: An optional hyperlink.
* \param dialog_options: Options how to display the message.
*/
GHOST_TSuccess showMessageBox(const char *title,
const char *message,
@ -273,7 +273,7 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Set which tablet API to use.
* \param api Enum indicating which API to use.
* \param api: Enum indicating which API to use.
*/
void setTabletAPI(GHOST_TTabletAPI api) override;
@ -293,27 +293,27 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Converts raw WIN32 key codes from the wndproc to GHOST keys.
* \param vKey The virtual key from hardKey
* \param ScanCode The ScanCode of pressed key (similar to PS/2 Set 1)
* \param extend Flag if key is not primly (left or right)
* \param vKey: The virtual key from #hardKey.
* \param ScanCode: The ScanCode of pressed key (similar to PS/2 Set 1).
* \param extend: Flag if key is not primly (left or right).
* \return The GHOST key (GHOST_kKeyUnknown if no match).
*/
GHOST_TKey convertKey(short vKey, short ScanCode, short extend) const;
/**
* Catches raw WIN32 key codes from WM_INPUT in the wndproc.
* \param raw RawInput structure with detailed info about the key event
* \param keyDown Pointer flag that specify if a key is down
* \param vk Pointer to virtual key
* \param raw: RawInput structure with detailed info about the key event.
* \param keyDown: Pointer flag that specify if a key is down.
* \param vk: Pointer to virtual key.
* \return The GHOST key (GHOST_kKeyUnknown if no match).
*/
GHOST_TKey hardKey(RAWINPUT const &raw, bool *r_keyDown, bool *r_is_repeated_modifier);
/**
* Creates mouse button event.
* \param type The type of event to create.
* \param window The window receiving the event (the active window).
* \param mask The button mask of this event.
* \param type: The type of event to create.
* \param window: The window receiving the event (the active window).
* \param mask: The button mask of this event.
* \return The event created.
*/
static GHOST_EventButton *processButtonEvent(GHOST_TEventType type,
@ -322,11 +322,11 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Creates tablet events from Wintab events.
* \param type The type of pointer event.
* \param window The window receiving the event (the active window).
* \param mask The button mask of the calling event.
* \param mousePressed Whether the mouse is currently pressed.
* \return True if the method handled the event.
* \param type: The type of pointer event.
* \param window: The window receiving the event (the active window).
* \param mask: The button mask of the calling event.
* \param mousePressed: Whether the mouse is currently pressed.
* \return True if the method handled the event.
*/
static GHOST_TSuccess processWintabEvent(GHOST_TEventType type,
GHOST_WindowWin32 *window,
@ -335,27 +335,27 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Creates tablet events from pointer events.
* \param type The type of pointer event.
* \param window The window receiving the event (the active window).
* \param wParam The wParam from the wndproc.
* \param lParam The lParam from the wndproc.
* \param eventhandled True if the method handled the event.
* \param type: The type of pointer event.
* \param window: The window receiving the event (the active window).
* \param wParam: The wParam from the wndproc.
* \param lParam: The lParam from the wndproc.
* \param eventhandled: True if the method handled the event.
*/
static void processPointerEvent(
UINT type, GHOST_WindowWin32 *window, WPARAM wParam, LPARAM lParam, bool &eventhandled);
/**
* Creates cursor event.
* \param window The window receiving the event (the active window).
* \param window: The window receiving the event (the active window).
* \return The event created.
*/
static GHOST_EventCursor *processCursorEvent(GHOST_WindowWin32 *window);
/**
* Handles a mouse wheel event.
* \param window The window receiving the event (the active window).
* \param wParam The wParam from the wndproc
* \param lParam The lParam from the wndproc
* \param window: The window receiving the event (the active window).
* \param wParam: The wParam from the wndproc.
* \param lParam: The lParam from the wndproc.
*/
static void processWheelEvent(GHOST_WindowWin32 *window, WPARAM wParam, LPARAM lParam);
@ -363,23 +363,23 @@ class GHOST_SystemWin32 : public GHOST_System {
* Creates a key event and updates the key data stored locally (m_modifierKeys).
* In most cases this is a straightforward conversion of key codes.
* For the modifier keys however, we want to distinguish left and right keys.
* \param window The window receiving the event (the active window).
* \param raw RawInput structure with detailed info about the key event
* \param window: The window receiving the event (the active window).
* \param raw: RawInput structure with detailed info about the key event.
*/
static GHOST_EventKey *processKeyEvent(GHOST_WindowWin32 *window, RAWINPUT const &raw);
/**
* Process special keys (VK_OEM_*), to see if current key layout
* gives us anything special, like ! on french AZERTY.
* \param vKey The virtual key from hardKey
* \param scanCode The ScanCode of pressed key (similar to PS/2 Set 1)
* \param vKey: The virtual key from #hardKey.
* \param scanCode: The ScanCode of pressed key (similar to PS/2 Set 1).
*/
GHOST_TKey processSpecialKey(short vKey, short scanCode) const;
/**
* Creates a window event.
* \param type The type of event to create.
* \param window The window receiving the event (the active window).
* \param type: The type of event to create.
* \param window: The window receiving the event (the active window).
* \return The event created.
*/
static GHOST_Event *processWindowEvent(GHOST_TEventType type, GHOST_WindowWin32 *window);
@ -387,9 +387,9 @@ class GHOST_SystemWin32 : public GHOST_System {
#ifdef WITH_INPUT_IME
/**
* Creates a IME event.
* \param type The type of event to create.
* \param window The window receiving the event (the active window).
* \param data IME data.
* \param type: The type of event to create.
* \param window: The window receiving the event (the active window).
* \param data: IME data.
* \return The event created.
*/
static GHOST_Event *processImeEvent(GHOST_TEventType type,
@ -399,7 +399,7 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Handles minimum window size.
* \param minmax The MINMAXINFO structure.
* \param minmax: The MINMAXINFO structure.
*/
static void processMinMaxInfo(MINMAXINFO *minmax);
@ -408,7 +408,7 @@ class GHOST_SystemWin32 : public GHOST_System {
* Handles Motion and Button events from a SpaceNavigator or related device.
* Instead of returning an event object, this function communicates directly
* with the GHOST_NDOFManager.
* \param raw RawInput structure with detailed info about the NDOF event
* \param raw: RawInput structure with detailed info about the NDOF event.
* \return Whether an event was generated and sent.
*/
bool processNDOF(RAWINPUT const &raw);
@ -416,7 +416,7 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Returns the local state of the modifier keys (from the message queue).
* \param keys The state of the keys.
* \param keys: The state of the keys.
*/
inline void retrieveModifierKeys(GHOST_ModifierKeys &keys) const;
@ -439,7 +439,7 @@ class GHOST_SystemWin32 : public GHOST_System {
/**
* Toggles console
* \param action
* \param action:
* - 0 - Hides
* - 1 - Shows
* - 2 - Toggles

28
intern/ghost/intern/GHOST_SystemX11.cpp
View File

@ -325,19 +325,19 @@ void GHOST_SystemX11::getAllDisplayDimensions(GHOST_TUns32 &width, GHOST_TUns32
/**
* Create a new window.
* The new window is added to the list of windows managed.
* Never explicitly delete the window, use disposeWindow() instead.
* \param title The name of the window
* Never explicitly delete the window, use #disposeWindow() instead.
* \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 settings.
* \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
* \param parentWindow Parent window
* \return The new window (or 0 if creation failed).
* \param exclusive: Use to show the window on top and ignore others (used full-screen).
* \param parentWindow: Parent window.
* \return The new window (or 0 if creation failed).
*/
GHOST_IWindow *GHOST_SystemX11::createWindow(const char *title,
GHOST_TInt32 left,
@ -393,7 +393,7 @@ GHOST_IWindow *GHOST_SystemX11::createWindow(const char *title,
/**
* Create a new offscreen context.
* Never explicitly delete the context, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *GHOST_SystemX11::createOffscreenContext(GHOST_GLSettings glSettings)
{
@ -505,8 +505,8 @@ GHOST_IContext *GHOST_SystemX11::createOffscreenContext(GHOST_GLSettings glSetti
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess GHOST_SystemX11::disposeContext(GHOST_IContext *context)
{

71
intern/ghost/intern/GHOST_SystemX11.h
View File

@ -121,20 +121,19 @@ class GHOST_SystemX11 : public GHOST_System {
/**
* Create a new window.
* The new window is added to the list of windows managed.
* Never explicitly delete the window, use disposeWindow() instead.
* \param title The name of the window
* Never explicitly delete the window, use #disposeWindow() instead.
* \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 stereoVisual Create a stereo visual for quad buffered stereo.
* \param exclusive Use to show the window ontop and ignore others
* (used fullscreen).
* \param parentWindow Parent (embedder) window
* \return The new window (or 0 if creation failed).
* \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 stereoVisual: Create a stereo visual for quad buffered stereo.
* \param exclusive: Use to show the window ontop and ignore others (used full*screen).
* \param parentWindow: Parent (embedder) window.
* \return The new window (or 0 if creation failed).
*/
GHOST_IWindow *createWindow(const char *title,
GHOST_TInt32 left,
@ -151,20 +150,20 @@ class GHOST_SystemX11 : public GHOST_System {
/**
* Create a new offscreen context.
* Never explicitly delete the context, use disposeContext() instead.
* \return The new context (or 0 if creation failed).
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings);
/**
* Dispose of a context.
* \param context Pointer to the context to be disposed.
* \return Indication of success.
* \param context: Pointer to the context to be disposed.
* \return Indication of success.
*/
GHOST_TSuccess disposeContext(GHOST_IContext *context);
/**
* Retrieves events from the system and stores them in the queue.
* \param waitForEvent Flag to wait for an event (or return immediately).
* \param waitForEvent: Flag to wait for an event (or return immediately).
* \return Indication of the presence of events.
*/
bool processEvents(bool waitForEvent);
@ -175,15 +174,15 @@ class GHOST_SystemX11 : public GHOST_System {
/**
* Returns the state of all modifier keys.
* \param keys The state of all modifier keys (true == pressed).
* \return Indication of success.
* \param keys: The state of all modifier keys (true == pressed).
* \return Indication of success.
*/
GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const;
/**
* Returns the state of the mouse buttons (outside the message queue).
* \param buttons The state of the buttons.
* \return Indication of success.
* \param buttons: The state of the buttons.
* \return Indication of success.
*/
GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const;
@ -220,26 +219,26 @@ class GHOST_SystemX11 : public GHOST_System {
/**
* Returns unsigned char from CUT_BUFFER0
* \param selection Get selection, X11 only feature
* \return Returns the Clipboard indicated by Flag
* \param selection: Get selection, X11 only feature.
* \return Returns the Clipboard indicated by Flag.
*/
GHOST_TUns8 *getClipboard(bool selection) const;
/**
* Puts buffer to system clipboard
* \param buffer The buffer to copy to the clipboard
* \param selection Set the selection into the clipboard, X11 only feature
* \param buffer: The buffer to copy to the clipboard.
* \param selection: Set the selection into the clipboard, X11 only feature.
*/
void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
/**
* Show a system message box
* \param title The title of the message box
* \param message The message to display
* \param help_label Help button label
* \param continue_label Continue button label
* \param link An optional hyperlink
* \param dialog_options Options how to display the message
* \param title: The title of the message box.
* \param message: The message to display.
* \param help_label: Help button label.
* \param continue_label: Continue button label.
* \param link: An optional hyperlink.
* \param dialog_options: Options how to display the message.
*/
GHOST_TSuccess showMessageBox(const char *title,
const char *message,
@ -251,12 +250,12 @@ class GHOST_SystemX11 : public GHOST_System {
/**
* Creates a drag'n'drop event and pushes it immediately onto the event queue.
* Called by GHOST_DropTargetX11 class.
* \param eventType The type of drag'n'drop event
* \param draggedObjectType The type object concerned
* \param eventType: The type of drag'n'drop event.
* \param draggedObjectType: The type object concerned.
* (currently array of file names, string, ?bitmap)
* \param mouseX x mouse coordinate (in window coordinates)
* \param mouseY y mouse coordinate
* \param window The window on which the event occurred
* \param mouseX: x mouse coordinate (in window coordinates).
* \param mouseY: y mouse coordinate.
* \param window: The window on which the event occurred.
* \return Indication whether the event was handled.
*/
static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType,

10
intern/ghost/intern/GHOST_TimerManager.h
View File

@ -62,7 +62,7 @@ class GHOST_TimerManager {
/**
* Adds a timer task to the list.
* It is only added when it not already present in the list.
* \param timer The timer task added to the list.
* \param timer: The timer task added to the list.
* \return Indication as to whether addition has succeeded.
*/
GHOST_TSuccess addTimer(GHOST_TimerTask *timer);
@ -70,7 +70,7 @@ class GHOST_TimerManager {
/**
* Removes a timer task from the list.
* It is only removed when it is found in the list.
* \param timer The timer task to be removed from the list.
* \param timer: The timer task to be removed from the list.
* \return Indication as to whether removal has succeeded.
*/
GHOST_TSuccess removeTimer(GHOST_TimerTask *timer);
@ -84,15 +84,15 @@ class GHOST_TimerManager {
/**
* Checks all timer tasks to see if they are expired and fires them if needed.
* \param time The current time.
* \param time: The current time.
* \return True if any timers were fired.
*/
bool fireTimers(GHOST_TUns64 time);
/**
* Checks this timer task to see if they are expired and fires them if needed.
* \param time The current time.
* \param task The timer task to check and optionally fire.
* \param time: The current time.
* \param task: The timer task to check and optionally fire.
* \return True if the timer fired.
*/
bool fireTimer(GHOST_TUns64 time, GHOST_TimerTask *task);

14
intern/ghost/intern/GHOST_TimerTask.h
View File

@ -33,9 +33,9 @@ class GHOST_TimerTask : public GHOST_ITimerTask {
public:
/**
* Constructor.
* \param start The timer start time.
* \param interval The interval between calls to the timerProc
* \param timerProc The callback invoked when the interval expires.
* \param start: The timer start time.
* \param interval: The interval between calls to the #timerProc.
* \param timerProc: The callback invoked when the interval expires.
* \param userData: The timer user data.
*/
GHOST_TimerTask(GHOST_TUns64 start,
@ -62,7 +62,7 @@ class GHOST_TimerTask : public GHOST_ITimerTask {
/**
* Changes the timer start time.
* \param start The timer start time.
* \param start: The timer start time.
*/
void setStart(GHOST_TUns64 start)
{
@ -80,7 +80,7 @@ class GHOST_TimerTask : public GHOST_ITimerTask {
/**
* Changes the timer interval.
* \param interval The timer interval.
* \param interval: The timer interval.
*/
void setInterval(GHOST_TUns64 interval)
{
@ -98,7 +98,7 @@ class GHOST_TimerTask : public GHOST_ITimerTask {
/**
* Changes the time the timerProc will be called.
* \param next The time the timerProc will be called.
* \param next: The time the timerProc will be called.
*/
void setNext(GHOST_TUns64 next)
{
@ -152,7 +152,7 @@ class GHOST_TimerTask : public GHOST_ITimerTask {
/**
* Changes the auxiliary storage room.
* \param auxData The auxiliary storage room.
* \param auxData: The auxiliary storage room.
*/
void setAuxData(GHOST_TUns32 auxData)
{

63
intern/ghost/intern/GHOST_Window.h
View File

@ -41,13 +41,12 @@ class GHOST_Window : public GHOST_IWindow {
* Constructor.
* Creates a new window and opens it.
* To check if the window was created properly, use the getValid() method.
* \param width The width the window.
* \param heigh The height the window.
* \param state The state the window is initially opened with.
* \param type The type of drawing context installed in this window.
* \param stereoVisual Stereo visual for quad buffered stereo.
* \param exclusive Use to show the window ontop and ignore others
* (used fullscreen).
* \param width: The width the window.
* \param heigh: The height the window.
* \param state: The state the window is initially opened with.
* \param type: The type of drawing context installed in this window.
* \param stereoVisual: Stereo visual for quad buffered stereo.
* \param exclusive: Use to show the window ontop and ignore others (used full-screen).
*/
GHOST_Window(GHOST_TUns32 width,
GHOST_TUns32 height,
@ -103,7 +102,7 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Returns the current cursor shape.
* \return The current cursor shape.
* \return The current cursor shape.
*/
inline GHOST_TStandardCursor getCursorShape() const;
@ -114,18 +113,18 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Set the shape of the cursor.
* \param cursorShape: The new cursor shape type id.
* \return Indication of success.
* \param cursorShape: The new cursor shape type id.
* \return Indication of success.
*/
GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
/**
* Set the shape of the cursor to a custom cursor.
* \param bitmap The bitmap data for the cursor.
* \param mask The mask data for the cursor.
* \param hotX The X coordinate of the cursor hot-spot.
* \param hotY The Y coordinate of the cursor hot-spot.
* \return Indication of success.
* \param bitmap: The bitmap data for the cursor.
* \param mask: The mask data for the cursor.
* \param hotX: The X coordinate of the cursor hot-spot.
* \param hotY: The Y coordinate of the cursor hot-spot.
* \return Indication of success.
*/
GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap,
GHOST_TUns8 *mask,
@ -137,7 +136,7 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Returns the visibility state of the cursor.
* \return The visibility state of the cursor.
* \return The visibility state of the cursor.
*/
inline bool getCursorVisibility() const;
inline GHOST_TGrabCursorMode getCursorGrabMode() const;
@ -149,15 +148,15 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Shows or hides the cursor.
* \param visible The new visibility state of the cursor.
* \return Indication of success.
* \param visible: The new visibility state of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess setCursorVisibility(bool visible);
/**
* Sets the cursor grab.
* \param mode The new grab state of the cursor.
* \return Indication of success.
* \param mode: The new grab state of the cursor.
* \return Indication of success.
*/
GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode,
GHOST_TAxisFlag wrap_axis,
@ -172,7 +171,7 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Sets the progress bar value displayed in the window/application icon
* \param progress The progress % (0.0 to 1.0)
* \param progress: The progress percentage (0.0 to 1.0).
*/
virtual GHOST_TSuccess setProgressBar(float /*progress*/)
{
@ -188,14 +187,14 @@ class GHOST_Window : public GHOST_IWindow {
}
/**
* 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.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
* Gets the current swap interval for swapBuffers.
* Gets the current swap interval for #swapBuffers.
* \return An integer.
*/
GHOST_TSuccess getSwapInterval(int &intervalOut);
@ -213,7 +212,7 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Sets the window "modified" status, indicating unsaved changes
* \param isUnsavedChanges Unsaved changes or not
* \param isUnsavedChanges: Unsaved changes or not.
* \return Indication of success.
*/
virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
@ -233,21 +232,21 @@ class GHOST_Window : public GHOST_IWindow {
/**
* Tries to install a rendering context in this window.
* Child classes do not need to overload this method,
* They should overload newDrawingContext instead.
* \param type The type of rendering context installed.
* They should overload #newDrawingContext instead.
* \param type: The type of rendering context installed.
* \return Indication as to whether installation has succeeded.
*/
GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
/**
* Swaps front and back buffers of a window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
* \return A boolean success indicator.
* \return A boolean success indicator.
*/
virtual GHOST_TSuccess activateDrawingContext();
@ -259,8 +258,8 @@ class GHOST_Window : public GHOST_IWindow {
GHOST_TSuccess updateDrawingContext();
/**
* Gets the OpenGL framebuffer associated with the window's contents.
* \return The ID of an OpenGL framebuffer object.
* Gets the OpenGL frame-buffer associated with the window's contents.
* \return The ID of an OpenGL frame-buffer object.
*/
virtual unsigned int getDefaultFramebuffer();
@ -314,7 +313,7 @@ class GHOST_Window : public GHOST_IWindow {
protected:
/**
* Tries to install a rendering context in this window.
* \param type The type of rendering context installed.
* \param type: The type of rendering context installed.
* \return Indication as to whether installation has succeeded.
*/
virtual GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type) = 0;

78
intern/ghost/intern/GHOST_WindowCocoa.h
View File

@ -44,16 +44,16 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Constructor.
* Creates a new window and opens it.
* To check if the window was created properly, use the getValid() method.
* \param systemCocoa The associated system class to forward events to
* \param title The text shown in the title bar of the window.
* \param left The coordinate of the left edge of the window.
* \param bottom The coordinate of the bottom edge of the window.
* \param width The width the window.
* \param height The height the window.
* \param state The state the window is initially opened with.
* \param type The type of drawing context installed in this window.
* \param stereoVisual Stereo visual for quad buffered stereo.
* To check if the window was created properly, use the #getValid() method.
* \param systemCocoa: The associated system class to forward events to.
* \param title: The text shown in the title bar of the window.
* \param left: The coordinate of the left edge of the window.
* \param bottom: The coordinate of the bottom edge of the window.
* \param width: The width the window.
* \param height: The height the window.
* \param state: The state the window is initially opened with.
* \param type: The type of drawing context installed in this window.
* \param stereoVisual: Stereo visual for quad buffered stereo.
*/
GHOST_WindowCocoa(GHOST_SystemCocoa *systemCocoa,
const char *title,
@ -88,12 +88,12 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Sets the title displayed in the title bar.
* \param title The title to display in the title bar.
* \param title: The title to display in the title bar.
*/
void setTitle(const char *title);
/**
* Returns the title displayed in the title bar.
* \param title The title displayed in the title bar.
* \param title: The title displayed in the title bar.
*/
std::string getTitle() const;
@ -101,33 +101,33 @@ class GHOST_WindowCocoa : public GHOST_Window {
* Returns the window rectangle dimensions.
* The dimensions are given in screen coordinates that are
* relative to the upper-left corner of the screen.
* \param bounds The bounding rectangle of the window.
* \param bounds: The bounding rectangle of the window.
*/
void getWindowBounds(GHOST_Rect &bounds) const;
/**
* Returns the client rectangle dimensions.
* The left and top members of the rectangle are always zero.
* \param bounds The bounding rectangle of the client area of the window.
* \param bounds: The bounding rectangle of the client area of the window.
*/
void getClientBounds(GHOST_Rect &bounds) const;
/**
* Resizes client rectangle width.
* \param width The new width of the client area of the window.
* \param width: The new width of the client area of the window.
*/
GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
/**
* Resizes client rectangle height.
* \param height The new height of the client area of the window.
* \param height: The new height of the client area of the window.
*/
GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
/**
* Resizes client rectangle.
* \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 width: The new width of the client area of the window.
* \param height: The new height of the client area of the window.
*/
GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
@ -139,17 +139,17 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Sets the window "modified" status, indicating unsaved changes
* \param isUnsavedChanges Unsaved changes or not
* \param isUnsavedChanges: Unsaved changes or not.
* \return Indication of success.
*/
GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
void screenToClient(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -158,10 +158,10 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
void clientToScreen(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -171,10 +171,10 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Converts a point in screen coordinates to client rectangle coordinates
* but without the y coordinate conversion needed for ghost compatibility.
* \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 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.
*/
void clientToScreenIntern(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -184,10 +184,10 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Converts a point in screen coordinates to client rectangle coordinates,
* but without the y coordinate conversion needed for ghost compatibility.
* \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 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.
*/
void screenToClientIntern(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -202,14 +202,14 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Sets the state of the window (normal, minimized, maximized).
* \param state The state of the window.
* \param state: The state of the window.
* \return Indication of success.
*/
GHOST_TSuccess setState(GHOST_TWindowState state);
/**
* Sets the order of the window (bottom, top).
* \param order The order of the window.
* \param order: The order of the window.
* \return Indication of success.
*/
GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
@ -226,7 +226,7 @@ class GHOST_WindowCocoa : public GHOST_Window {
/**
* Sets the progress bar value displayed in the window/application icon
* \param progress The progress % (0.0 to 1.0)
* \param progress: The progress percentage (0.0 to 1.0).
*/
GHOST_TSuccess setProgressBar(float progress);
@ -265,7 +265,7 @@ class GHOST_WindowCocoa : public GHOST_Window {
protected:
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);

38
intern/ghost/intern/GHOST_WindowManager.h
View File

@ -47,54 +47,54 @@ class GHOST_WindowManager {
/**
* Add a window to our list.
* It is only added if it is not already in the list.
* \param window Pointer to the window to be added.
* \return Indication of success.
* \param window: Pointer to the window to be added.
* \return Indication of success.
*/
GHOST_TSuccess addWindow(GHOST_IWindow *window);
/**
* Remove a window from our list.
* \param window Pointer to the window to be removed.
* \return Indication of success.
* \param window: Pointer to the window to be removed.
* \return Indication of success.
*/
GHOST_TSuccess removeWindow(const GHOST_IWindow *window);
/**
* Returns whether the window is in our list.
* \param window Pointer to the window to query.
* \return A boolean indicator.
* \param window: Pointer to the window to query.
* \return A boolean indicator.
*/
bool getWindowFound(const GHOST_IWindow *window) const;
/**
* Returns whether one of the windows is fullscreen.
* \return A boolean indicator.
* Returns whether one of the windows is full-screen.
* \return A boolean indicator.
*/
bool getFullScreen(void) const;
/**
* Returns pointer to the full-screen window.
* \return The full-screen window (NULL if not in full-screen).
* \return The full-screen window (NULL if not in full-screen).
*/
GHOST_IWindow *getFullScreenWindow(void) const;
/**
* Activates fullscreen mode for a window.
* \param window The window displayed fullscreen.
* \return Indication of success.
* Activates full-screen mode for a window.
* \param window: The window displayed full-screen.
* \return Indication of success.
*/
GHOST_TSuccess beginFullScreen(GHOST_IWindow *window, const bool stereoVisual);
/**
* Closes fullscreen mode down.
* \return Indication of success.
* Closes full-screen mode down.
* \return Indication of success.
*/
GHOST_TSuccess endFullScreen(void);
/**
* Sets new window as active window (the window receiving events).
* There can be only one window active which should be in the current window list.
* \param window The new active window.
* \param window: The new active window.
*/
GHOST_TSuccess setActiveWindow(GHOST_IWindow *window);
@ -107,7 +107,7 @@ class GHOST_WindowManager {
/**
* Set this window to be inactive (not receiving events).
* \param window The window to deactivate.
* \param window: The window to deactivate.
*/
void setWindowInactive(const GHOST_IWindow *window);
@ -119,9 +119,9 @@ class GHOST_WindowManager {
const std::vector<GHOST_IWindow *> &getWindows() const;
/**
* Finds the window associated with an OS window object/handle
* \param osWindow The OS window object/handle
* \return The associated window, null if none corresponds
* Finds the window associated with an OS window object/handle.
* \param osWindow: The OS window object/handle.
* \return The associated window, null if none corresponds.
*/
GHOST_IWindow *getWindowAssociatedWithOSWindow(void *osWindow);

2
intern/ghost/intern/GHOST_WindowNULL.h
View File

@ -168,7 +168,7 @@ class GHOST_WindowNULL : public GHOST_Window {
GHOST_SystemNULL *m_system;
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type)

2
intern/ghost/intern/GHOST_WindowSDL.h
View File

@ -85,7 +85,7 @@ class GHOST_WindowSDL : public GHOST_Window {
protected:
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);

2
intern/ghost/intern/GHOST_WindowWayland.h
View File

@ -118,7 +118,7 @@ class GHOST_WindowWayland : public GHOST_Window {
std::string title;
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type) override;

106
intern/ghost/intern/GHOST_WindowWin32.h
View File

@ -262,16 +262,16 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Constructor.
* Creates a new window and opens it.
* To check if the window was created properly, use the getValid() method.
* \param title The text shown in the title bar of the 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 the window is initially opened with.
* \param type The type of drawing context installed in this window.
* \param wantStereoVisual Stereo visual for quad buffered stereo.
* \param parentWindowHwnd
* To check if the window was created properly, use the #getValid() method.
* \param title: The text shown in the title bar of the 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 the window is initially opened with.
* \param type: The type of drawing context installed in this window.
* \param wantStereoVisual: Stereo visual for quad buffered stereo.
* \param parentWindowHwnd: TODO.
*/
GHOST_WindowWin32(GHOST_SystemWin32 *system,
const char *title,
@ -307,7 +307,7 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Sets the title displayed in the title bar.
* \param title The title to display in the title bar.
* \param title: The title to display in the title bar.
*/
void setTitle(const char *title);
@ -321,33 +321,33 @@ class GHOST_WindowWin32 : public GHOST_Window {
* Returns the window rectangle dimensions.
* The dimensions are given in screen coordinates that are
* relative to the upper-left corner of the screen.
* \param bounds The bounding rectangle of the window.
* \param bounds: The bounding rectangle of the window.
*/
void getWindowBounds(GHOST_Rect &bounds) const;
/**
* Returns the client rectangle dimensions.
* The left and top members of the rectangle are always zero.
* \param bounds The bounding rectangle of the client area of the window.
* \param bounds: The bounding rectangle of the client area of the window.
*/
void getClientBounds(GHOST_Rect &bounds) const;
/**
* Resizes client rectangle width.
* \param width The new width of the client area of the window.
* \param width: The new width of the client area of the window.
*/
GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
/**
* Resizes client rectangle height.
* \param height The new height of the client area of the window.
* \param height: The new height of the client area of the window.
*/
GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
/**
* Resizes client rectangle.
* \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 width: The new width of the client area of the window.
* \param height: The new height of the client area of the window.
*/
GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
@ -359,10 +359,10 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
void screenToClient(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -371,10 +371,10 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Converts a point in screen coordinates to client rectangle coordinates
* \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 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.
*/
void clientToScreen(GHOST_TInt32 inX,
GHOST_TInt32 inY,
@ -383,14 +383,14 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Sets the state of the window (normal, minimized, maximized).
* \param state The state of the window.
* \param state: The state of the window.
* \return Indication of success.
*/
GHOST_TSuccess setState(GHOST_TWindowState state);
/**
* Sets the order of the window (bottom, top).
* \param order The order of the window.
* \param order: The order of the window.
* \return Indication of success.
*/
GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
@ -402,7 +402,7 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Sets the progress bar value displayed in the window/application icon
* \param progress The progress %
* \param progress: The progress percentage (0.0 to 1.0).
*/
GHOST_TSuccess setProgressBar(float progress);
@ -416,8 +416,8 @@ class GHOST_WindowWin32 : public GHOST_Window {
* for any real button press, controls mouse
* capturing).
*
* \param event Whether mouse was pressed and released, or an operator grabbed or ungrabbed the
* mouse
* \param event: Whether mouse was pressed and released,
* or an operator grabbed or ungrabbed the mouse.
*/
void updateMouseCapture(GHOST_MouseCaptureEventWin32 event);
@ -431,31 +431,31 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Loads the windows equivalent of a standard GHOST cursor.
* \param visible Flag for cursor visibility.
* \param cursorShape The cursor shape.
* \param visible: Flag for cursor visibility.
* \param cursorShape: The cursor shape.
*/
HCURSOR getStandardCursor(GHOST_TStandardCursor shape) const;
void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
/**
* Handle setup and switch between Wintab and Pointer APIs.
* \param active Whether the window is or will be in an active state.
* \param visible Whether the window is currently (or will be) visible).
* \param active: Whether the window is or will be in an active state.
* \param visible: Whether the window is currently (or will be) visible).
*/
void updateWintab(bool active, bool visible);
/**
* Query whether given tablet API should be used.
* \param api Tablet API to test.
* \param api: Tablet API to test.
*/
bool useTabletAPI(GHOST_TTabletAPI api) const;
/**
* Translate WM_POINTER events into GHOST_PointerInfoWin32 structs.
* \param outPointerInfo Storage to return resulting GHOST_PointerInfoWin32 structs.
* \param wParam WPARAM of the event.
* \param lParam LPARAM of the event.
* \return True if outPointerInfo was updated.
* \param outPointerInfo: Storage to return resulting GHOST_PointerInfoWin32 structs.
* \param wParam: WPARAM of the event.
* \param lParam: LPARAM of the event.
* \return True if #outPointerInfo was updated.
*/
GHOST_TSuccess getPointerInfo(std::vector<GHOST_PointerInfoWin32> &outPointerInfo,
WPARAM wParam,
@ -468,20 +468,20 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Set tablet details when a cursor enters range.
* \param inRange Whether the Wintab device is in tracking range.
* \param inRange: Whether the Wintab device is in tracking range.
*/
void processWintabProximityEvent(bool inRange);
/**
* Handle Wintab info changes such as change in number of connected tablets.
* \param lParam LPARAM of the event.
* \param lParam: LPARAM of the event.
*/
void processWintabInfoChangeEvent(LPARAM lParam);
/**
* Translate Wintab packets into GHOST_WintabInfoWin32 structs.
* \param outWintabInfo Storage to return resulting GHOST_WintabInfoWin32 structs.
* \return Success if able to read packets, even if there are none.
* \param outWintabInfo: Storage to return resulting GHOST_WintabInfoWin32 structs.
* \return Success if able to read packets, even if there are none.
*/
GHOST_TSuccess getWintabInfo(std::vector<GHOST_WintabInfoWin32> &outWintabInfo);
@ -504,20 +504,20 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Get whether there are currently any mouse buttons pressed.
* \return True if there are any currently pressed mouse buttons.
* \return True if there are any currently pressed mouse buttons.
*/
bool getMousePressed() const;
/**
* Get if there are currently pressed Wintab buttons associated to a Windows mouse button press.
* \return True if there are currently any pressed Wintab buttons associated to a Windows
* mouse button press.
* \return True if there are currently any pressed Wintab buttons associated to a Windows
* mouse button press.
*/
bool wintabSysButPressed() const;
/**
* Register a Wintab button has been associated to a Windows mouse button press.
* \param event Whether the button was pressed or released.
* \param event: Whether the button was pressed or released.
*/
void updateWintabSysBut(GHOST_MouseCaptureEventWin32 event);
@ -540,7 +540,7 @@ class GHOST_WindowWin32 : public GHOST_Window {
private:
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);
@ -554,7 +554,7 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Sets the cursor grab on the window using native window system calls.
* Using registerMouseClickEvent.
* \param mode GHOST_TGrabCursorMode.
* \param mode: GHOST_TGrabCursorMode.
*/
GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
@ -644,10 +644,10 @@ class GHOST_WindowWin32 : public GHOST_Window {
/**
* Convert Wintab system mapped (mouse) buttons into Ghost button mask.
* \param cursor The Wintab cursor associated to the button.
* \param physicalButton The physical button ID to inspect.
* \param buttonMask Return pointer for button found.
* \return Whether an associated button was found.
* \param cursor: The Wintab cursor associated to the button.
* \param physicalButton: The physical button ID to inspect.
* \param buttonMask: Return pointer for button found.
* \return Whether an associated button was found.
*/
GHOST_TSuccess wintabMouseToGhost(UINT cursor,
WORD physicalButton,

22
intern/ghost/intern/GHOST_WindowX11.h
View File

@ -54,16 +54,16 @@ class GHOST_WindowX11 : public GHOST_Window {
* Constructor.
* Creates a new window and opens it.
* To check if the window was created properly, use the getValid() method.
* \param title The text shown in the title bar of the 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 the window is initially opened with.
* \param parentWindow Parent (embedder) window
* \param type The type of drawing context installed in this window.
* \param stereoVisual Stereo visual for quad buffered stereo.
* \param alphaBackground Enable alpha blending of window with display background
* \param title: The text shown in the title bar of the 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 the window is initially opened with.
* \param parentWindow: Parent (embedder) window.
* \param type: The type of drawing context installed in this window.
* \param stereoVisual: Stereo visual for quad buffered stereo.
* \param alphaBackground: Enable alpha blending of window with display background.
*/
GHOST_WindowX11(GHOST_SystemX11 *system,
Display *display,
@ -186,7 +186,7 @@ class GHOST_WindowX11 : public GHOST_Window {
protected:
/**
* \param type The type of rendering context create.
* \param type: The type of rendering context create.
* \return Indication of success.
*/
GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);

2
intern/ghost/intern/GHOST_XrContext.cpp
View File

@ -277,7 +277,7 @@ void GHOST_XrContext::setErrorHandler(GHOST_XrErrorHandlerFn handler_fn, void *c
* \{ */
/**
* \param layer_name May be NULL for extensions not belonging to a specific layer.
* \param layer_name: May be NULL for extensions not belonging to a specific layer.
*/
void GHOST_XrContext::initExtensionsEx(std::vector<XrExtensionProperties> &extensions,
const char *layer_name)