diff options
Diffstat (limited to 'intern/ghost/intern/GHOST_Window.h')
| -rw-r--r-- | intern/ghost/intern/GHOST_Window.h | 63 |
1 files changed, 31 insertions, 32 deletions
diff --git a/intern/ghost/intern/GHOST_Window.h b/intern/ghost/intern/GHOST_Window.h index c8c21b2b08f..d897fafc003 100644 --- a/intern/ghost/intern/GHOST_Window.h +++ b/intern/ghost/intern/GHOST_Window.h @@ -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; |