This commit is contained in:
Campbell Barton
2014-08-16 10:51:07 +10:00
parent bb39925ec5
commit 88ee650263
10 changed files with 49 additions and 56 deletions

View File

@@ -151,7 +151,7 @@ extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle,
/** /**
* Returns the dimensions of all displays combine * Returns the dimensions of all displays combine
* (the current workspace). * (the current workspace).
* No need to worrky about overlapping monitors. * No need to worry about overlapping monitors.
* \param systemhandle The handle to the system * \param systemhandle The handle to the system
* \param width A pointer the width gets put in * \param width A pointer the width gets put in
* \param height A pointer the height gets put in * \param height A pointer the height gets put in
@@ -751,7 +751,7 @@ extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehand
/** /**
* Returns whether this rectangle is valid. * Returns whether this rectangle is valid.
* Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are 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 intean value (true == valid rectangle) * \return intean value (true == valid rectangle)
*/ */
@@ -845,7 +845,7 @@ extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
GHOST_RectangleHandle anotherrectanglehandle); GHOST_RectangleHandle anotherrectanglehandle);
/** /**
* Return the data from the clipboad * 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 * \return clipboard data
*/ */

View File

@@ -48,7 +48,7 @@ class GHOST_IEventConsumer;
* *
* GHOST is yet another acronym. It stands for "Generic Handy Operating System * GHOST is yet another acronym. It stands for "Generic Handy Operating System
* Toolkit". It has been created to replace the OpenGL utility tool kit * Toolkit". It has been created to replace the OpenGL utility tool kit
* <a href="http://www.opengl.org/developers/documentation/glut.html">GLUT</a>. * <a href="http://www.opengl.org/resources/libraries/glut/">GLUT</a>.
* GLUT was used in <a href="http://www.blender3d.com">Blender</a> until the * GLUT was used in <a href="http://www.blender3d.com">Blender</a> until the
* point that Blender needed to be ported to Apple's Mac OSX. Blender needed a * point that Blender needed to be ported to Apple's Mac OSX. Blender needed a
* number of modifications in GLUT to work but the GLUT sources for OSX were * number of modifications in GLUT to work but the GLUT sources for OSX were
@@ -60,31 +60,29 @@ class GHOST_IEventConsumer;
* 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 it's supported
* operating systems and some extra's. * operating systems and some extra's.
* This includes : * This includes :
* <ul> *
* <li> Time(r) management.</li> * - Time(r) management.
* <li> Display/window management (windows are only created on the main display). * - Display/window management (windows are only created on the main display).
* <li> Event management.</li> * - Event management.
* <li> Cursor shape management (no custom cursors for now).</li> * - Cursor shape management (no custom cursors for now).
* <li> Access to the state of the mouse buttons and the keyboard.</li> * - Access to the state of the mouse buttons and the keyboard.
* <li> Menus for windows with events generated when they are accessed (this is * - Menus for windows with events generated when they are accessed (this is
* work in progress).</li> * work in progress).
* <li> Video mode switching.</li> * - Video mode switching.
* <li> Copy/Paste buffers.</li> * - Copy/Paste buffers.
* <li> System paths.</li> * - System paths.
* </ul> *
* Font management has been moved to a separate library. * Font management has been moved to a separate library.
* *
* \section platforms Platforms * \section platforms Platforms
* *
* GHOST supports the following platforms: * GHOST supports the following platforms:
* <ul> *
* <li> OSX Cocoa.</li> * - OSX Cocoa.
* <li> OSX Carbon.</li> * - Windows.
* <li> Windows.</li> * - X11.
* <li> X11.</li> * - SDL2 (experimental).
* <li> SDL1.3 (experimental).</li> * - NULL (headless mode).
* <li> NULL (headless mode).</li>
* </ul>
* *
* \section Building GHOST * \section Building GHOST
* *
@@ -92,23 +90,23 @@ class GHOST_IEventConsumer;
* *
* \section interface Interface * \section interface Interface
* GHOST has two programming interfaces: * GHOST has two programming interfaces:
* <ul> *
* <li>The C-API. For programs written in C.</li> * - The C-API. For programs written in C.
* <li>The C++-API. For programs written in C++.</li> * - The C++-API. For programs written in C++.
* </ul> *
* GHOST itself is writtem in C++ and the C-API is a wrapper around the C++ * GHOST itself is written in C++ and the C-API is a wrapper around the C++
* API. * API.
* *
* \subsection cplusplus_api The C++ API consists of the following files: * \subsection cplusplus_api The C++ API consists of the following files:
* <ul> *
* <li>GHOST_IEvent.h</li> * - GHOST_IEvent.h
* <li>GHOST_IEventConsumer.h</li> * - GHOST_IEventConsumer.h
* <li>GHOST_ISystem.h</li> * - GHOST_ISystem.h
* <li>GHOST_ITimerTask.h</li> * - GHOST_ITimerTask.h
* <li>GHOST_IWindow.h</li> * - GHOST_IWindow.h
* <li>GHOST_Rect.h</li> * - GHOST_Rect.h
* <li>GHOST_Types.h</li> * - GHOST_Types.h
* </ul> *
* For an example of using the C++-API, have a look at the GHOST_C-Test.cpp * For an example of using the C++-API, have a look at the GHOST_C-Test.cpp
* program in the ?/ghost/test/gears/ directory. * program in the ?/ghost/test/gears/ directory.
* *

View File

@@ -46,13 +46,12 @@
* \see GHOST_ISystem#createWindow * \see GHOST_ISystem#createWindow
* *
* There are two coordinate systems: * There are two coordinate systems:
* <ul> *
* <li>The screen coordinate system. The origin of the screen is located in the * - The screen coordinate system. The origin of the screen is located in the
* upper left corner of the screen.</li> * upper left corner of the screen.</li>
* <li>The client rectangle coordinate system. The client rectangle of a window * - The client rectangle coordinate system. The client rectangle of a window
* is the area that is drawable by the application (excluding title bars etc.). * is the area that is drawable by the application (excluding title bars etc.).
* </li> *
* </ul>
* \author Maarten Gribnau * \author Maarten Gribnau
* \date May 31, 2001 * \date May 31, 2001
*/ */

View File

@@ -102,7 +102,7 @@ public:
/** /**
* Returns whether this rectangle is valid. * Returns whether this rectangle is valid.
* Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are 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; virtual inline bool isValid() const;

View File

@@ -101,7 +101,7 @@ private:
/** /**
* Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test") * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
* \param fileUrl - file path URL to be fully decoded * \param fileUrl - file path URL to be fully decoded
* \return decoded file path (resutl shold be free-d) * \return decoded file path (resutl should be free-d)
*/ */
char *FileUrlDecode(char *fileUrl); char *FileUrlDecode(char *fileUrl);

View File

@@ -250,27 +250,23 @@ public:
virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event); virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event);
/** /**
* Returns the timer manager.
* \return The timer manager. * \return The timer manager.
*/ */
inline virtual GHOST_TimerManager *getTimerManager() const; inline virtual GHOST_TimerManager *getTimerManager() const;
/** /**
* Returns a pointer to our event manager.
* \return A pointer to our event manager. * \return A pointer to our event manager.
*/ */
virtual inline GHOST_EventManager *getEventManager() const; virtual inline GHOST_EventManager *getEventManager() const;
/** /**
* Returns a pointer to our window manager.
* \return A pointer to our window manager. * \return A pointer to our window manager.
*/ */
virtual inline GHOST_WindowManager *getWindowManager() const; virtual inline GHOST_WindowManager *getWindowManager() const;
#ifdef WITH_INPUT_NDOF #ifdef WITH_INPUT_NDOF
/** /**
* Returns a pointer to our n-degree of freedeom manager. * \return A pointer to our n-degree of freedom manager.
* \return A pointer to our n-degree of freedeom manager.
*/ */
virtual inline GHOST_NDOFManager *getNDOFManager() const; virtual inline GHOST_NDOFManager *getNDOFManager() const;
#endif #endif

View File

@@ -670,7 +670,7 @@ GHOST_SystemX11::processEvent(XEvent *xe)
#ifdef WITH_X11_XINPUT #ifdef WITH_X11_XINPUT
/* Proximity-Out Events are not reliable, if the tablet is active - check on each event /* Proximity-Out Events are not reliable, if the tablet is active - check on each event
* this adds a little overhead but only while the tablet is in use. * this adds a little overhead but only while the tablet is in use.
* in the futire we could have a ghost call window->CheckTabletProximity() * in the future we could have a ghost call window->CheckTabletProximity()
* but for now enough parts of the code are checking 'Active' * but for now enough parts of the code are checking 'Active'
* - campbell */ * - campbell */
if (window->GetTabletData()->Active != GHOST_kTabletModeNone) { if (window->GetTabletData()->Active != GHOST_kTabletModeNone) {

View File

@@ -87,7 +87,7 @@ public:
/** /**
* Returns pointer to the full-screen window. * Returns pointer to the full-screen window.
* \return The fll-screen window (0 if not in full-screen). * \return The full-screen window (NULL if not in full-screen).
*/ */
virtual GHOST_IWindow *getFullScreenWindow(void) const; virtual GHOST_IWindow *getFullScreenWindow(void) const;

View File

@@ -76,7 +76,7 @@ extern "C" {
extern size_t (*MEM_allocN_len)(const void *vmemh) ATTR_WARN_UNUSED_RESULT; extern size_t (*MEM_allocN_len)(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
/** /**
* Release memory previously allocatred by this module. * Release memory previously allocated by this module.
*/ */
extern void (*MEM_freeN)(void *vmemh); extern void (*MEM_freeN)(void *vmemh);

View File

@@ -1709,7 +1709,7 @@ void shade_lamp_loop(ShadeInput *shi, ShadeResult *shr)
/* Passes which might need to know material color. /* Passes which might need to know material color.
* *
* It seems to be faster to just calculate material color * It seems to be faster to just calculate material color
* even if the pass doesn't really need it than tryign to * even if the pass doesn't really need it than trying to
* figure out whether color is really needed or not. * figure out whether color is really needed or not.
*/ */
const int color_passes = const int color_passes =