diff options
Diffstat (limited to 'intern/ghost/GHOST_ISystem.h')
| -rw-r--r-- | intern/ghost/GHOST_ISystem.h | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h index 63018a9cee8..81b54cf5a0d 100644 --- a/intern/ghost/GHOST_ISystem.h +++ b/intern/ghost/GHOST_ISystem.h @@ -51,7 +51,7 @@ class GHOST_IEventConsumer; * Blender. * <br><br> * Enough history. What does GHOST have to offer?<br> - * In short: everything that Blender needed from GLUT to run on all it's supported + * In short: everything that Blender needed from GLUT to run on all its supported * operating systems and some extra's. * This includes : * @@ -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*/, |