Comments
This commit is contained in:
Campbell Barton
@@ -151,7 +151,7 @@ extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle,
|
||||
/**
|
||||
* Returns the dimensions of all displays combine
|
||||
* (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 width A pointer the width 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.
|
||||
* 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
|
||||
* \return intean value (true == valid rectangle)
|
||||
*/
|
||||
@@ -845,7 +845,7 @@ extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
|
||||
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.
|
||||
* \return clipboard data
|
||||
*/
|
||||
|
||||
@@ -48,7 +48,7 @@ class GHOST_IEventConsumer;
|
||||
*
|
||||
* GHOST is yet another acronym. It stands for "Generic Handy Operating System
|
||||
* 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
|
||||
* 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
|
||||
@@ -60,31 +60,29 @@ class GHOST_IEventConsumer;
|
||||
* In short: everything that Blender needed from GLUT to run on all it's supported
|
||||
* operating systems and some extra's.
|
||||
* This includes :
|
||||
* <ul>
|
||||
* <li> Time(r) management.</li>
|
||||
* <li> Display/window management (windows are only created on the main display).
|
||||
* <li> Event management.</li>
|
||||
* <li> Cursor shape management (no custom cursors for now).</li>
|
||||
* <li> Access to the state of the mouse buttons and the keyboard.</li>
|
||||
* <li> Menus for windows with events generated when they are accessed (this is
|
||||
* work in progress).</li>
|
||||
* <li> Video mode switching.</li>
|
||||
* <li> Copy/Paste buffers.</li>
|
||||
* <li> System paths.</li>
|
||||
* </ul>
|
||||
*
|
||||
* - Time(r) management.
|
||||
* - Display/window management (windows are only created on the main display).
|
||||
* - Event management.
|
||||
* - Cursor shape management (no custom cursors for now).
|
||||
* - Access to the state of the mouse buttons and the keyboard.
|
||||
* - Menus for windows with events generated when they are accessed (this is
|
||||
* work in progress).
|
||||
* - Video mode switching.
|
||||
* - Copy/Paste buffers.
|
||||
* - System paths.
|
||||
*
|
||||
* Font management has been moved to a separate library.
|
||||
*
|
||||
* \section platforms Platforms
|
||||
*
|
||||
* GHOST supports the following platforms:
|
||||
* <ul>
|
||||
* <li> OSX Cocoa.</li>
|
||||
* <li> OSX Carbon.</li>
|
||||
* <li> Windows.</li>
|
||||
* <li> X11.</li>
|
||||
* <li> SDL1.3 (experimental).</li>
|
||||
* <li> NULL (headless mode).</li>
|
||||
* </ul>
|
||||
*
|
||||
* - OSX Cocoa.
|
||||
* - Windows.
|
||||
* - X11.
|
||||
* - SDL2 (experimental).
|
||||
* - NULL (headless mode).
|
||||
*
|
||||
* \section Building GHOST
|
||||
*
|
||||
@@ -92,23 +90,23 @@ class GHOST_IEventConsumer;
|
||||
*
|
||||
* \section interface Interface
|
||||
* GHOST has two programming interfaces:
|
||||
* <ul>
|
||||
* <li>The C-API. For programs written in C.</li>
|
||||
* <li>The C++-API. For programs written in C++.</li>
|
||||
* </ul>
|
||||
* GHOST itself is writtem in C++ and the C-API is a wrapper around the C++
|
||||
*
|
||||
* - The C-API. For programs written in C.
|
||||
* - The C++-API. For programs written in C++.
|
||||
*
|
||||
* GHOST itself is written in C++ and the C-API is a wrapper around the C++
|
||||
* API.
|
||||
*
|
||||
* \subsection cplusplus_api The C++ API consists of the following files:
|
||||
* <ul>
|
||||
* <li>GHOST_IEvent.h</li>
|
||||
* <li>GHOST_IEventConsumer.h</li>
|
||||
* <li>GHOST_ISystem.h</li>
|
||||
* <li>GHOST_ITimerTask.h</li>
|
||||
* <li>GHOST_IWindow.h</li>
|
||||
* <li>GHOST_Rect.h</li>
|
||||
* <li>GHOST_Types.h</li>
|
||||
* </ul>
|
||||
*
|
||||
* - GHOST_IEvent.h
|
||||
* - GHOST_IEventConsumer.h
|
||||
* - GHOST_ISystem.h
|
||||
* - GHOST_ITimerTask.h
|
||||
* - GHOST_IWindow.h
|
||||
* - GHOST_Rect.h
|
||||
* - GHOST_Types.h
|
||||
*
|
||||
* For an example of using the C++-API, have a look at the GHOST_C-Test.cpp
|
||||
* program in the ?/ghost/test/gears/ directory.
|
||||
*
|
||||
|
||||
@@ -46,13 +46,12 @@
|
||||
* \see GHOST_ISystem#createWindow
|
||||
*
|
||||
* There are two coordinate systems:
|
||||
* <ul>
|
||||
* <li>The screen coordinate system. The origin of the screen is located in the
|
||||
* upper left corner of the screen.</li>
|
||||
* <li>The client rectangle coordinate system. The client rectangle of a window
|
||||
* is the area that is drawable by the application (excluding title bars etc.).
|
||||
* </li>
|
||||
* </ul>
|
||||
*
|
||||
* - The screen coordinate system. The origin of the screen is located in the
|
||||
* upper left corner of the screen.</li>
|
||||
* - The client rectangle coordinate system. The client rectangle of a window
|
||||
* is the area that is drawable by the application (excluding title bars etc.).
|
||||
*
|
||||
* \author Maarten Gribnau
|
||||
* \date May 31, 2001
|
||||
*/
|
||||
|
||||
@@ -102,7 +102,7 @@ public:
|
||||
|
||||
/**
|
||||
* 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)
|
||||
*/
|
||||
virtual inline bool isValid() const;
|
||||
|
||||
@@ -101,7 +101,7 @@ private:
|
||||
/**
|
||||
* 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 (resutl shold be free-d)
|
||||
* \return decoded file path (resutl should be free-d)
|
||||
*/
|
||||
char *FileUrlDecode(char *fileUrl);
|
||||
|
||||
|
||||
@@ -250,27 +250,23 @@ public:
|
||||
virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event);
|
||||
|
||||
/**
|
||||
* Returns the timer manager.
|
||||
* \return The timer manager.
|
||||
*/
|
||||
inline virtual GHOST_TimerManager *getTimerManager() const;
|
||||
|
||||
/**
|
||||
* Returns a pointer to our event manager.
|
||||
* \return A pointer to our event manager.
|
||||
*/
|
||||
virtual inline GHOST_EventManager *getEventManager() const;
|
||||
|
||||
/**
|
||||
* Returns a pointer to our window manager.
|
||||
* \return A pointer to our window manager.
|
||||
*/
|
||||
virtual inline GHOST_WindowManager *getWindowManager() const;
|
||||
|
||||
#ifdef WITH_INPUT_NDOF
|
||||
/**
|
||||
* Returns a pointer to our n-degree of freedeom manager.
|
||||
* \return A pointer to our n-degree of freedeom manager.
|
||||
* \return A pointer to our n-degree of freedom manager.
|
||||
*/
|
||||
virtual inline GHOST_NDOFManager *getNDOFManager() const;
|
||||
#endif
|
||||
|
||||
@@ -670,7 +670,7 @@ GHOST_SystemX11::processEvent(XEvent *xe)
|
||||
#ifdef WITH_X11_XINPUT
|
||||
/* 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.
|
||||
* 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'
|
||||
* - campbell */
|
||||
if (window->GetTabletData()->Active != GHOST_kTabletModeNone) {
|
||||
|
||||
@@ -87,7 +87,7 @@ public:
|
||||
|
||||
/**
|
||||
* 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;
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ extern "C" {
|
||||
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);
|
||||
|
||||
|
||||
@@ -1709,7 +1709,7 @@ void shade_lamp_loop(ShadeInput *shi, ShadeResult *shr)
|
||||
/* Passes which might need to know 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.
|
||||
*/
|
||||
const int color_passes =
|
||||
|
||||
Reference in New Issue
Block a user