Cleanup: doxygen comments
This commit is contained in:
parent
1779452eb4
commit
d9046ccbd4
|
@ -40,7 +40,7 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/**
|
||||
* Creates a "handle" for a C++ GHOST object.
|
||||
* Creates a "handle" for a C++ GHOST object.
|
||||
* A handle is just an opaque pointer to an empty struct.
|
||||
* In the API the pointer is casted to the actual C++ class.
|
||||
* \param name Name of the handle to create.
|
||||
|
@ -174,19 +174,19 @@ extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle,
|
|||
* \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 Stereo visual for quad buffered stereo.
|
||||
* \param numOfAASamples Number of samples used for AA (zero if no AA)
|
||||
* \param glSettings: Misc OpenGL options.
|
||||
* \return A handle to the new window ( == NULL if creation failed).
|
||||
*/
|
||||
extern GHOST_WindowHandle GHOST_CreateWindow(GHOST_SystemHandle systemhandle,
|
||||
const char *title,
|
||||
GHOST_TInt32 left,
|
||||
GHOST_TInt32 top,
|
||||
GHOST_TUns32 width,
|
||||
GHOST_TUns32 height,
|
||||
GHOST_TWindowState state,
|
||||
GHOST_TDrawingContextType type,
|
||||
GHOST_GLSettings glSettings);
|
||||
extern GHOST_WindowHandle GHOST_CreateWindow(
|
||||
GHOST_SystemHandle systemhandle,
|
||||
const char *title,
|
||||
GHOST_TInt32 left,
|
||||
GHOST_TInt32 top,
|
||||
GHOST_TUns32 width,
|
||||
GHOST_TUns32 height,
|
||||
GHOST_TWindowState state,
|
||||
GHOST_TDrawingContextType type,
|
||||
GHOST_GLSettings glSettings);
|
||||
|
||||
/**
|
||||
* Returns the window user data.
|
||||
|
|
|
@ -241,8 +241,8 @@ public:
|
|||
* \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 numOfAASamples Number of samples used for AA (zero if no AA)
|
||||
* \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).
|
||||
*/
|
||||
|
|
|
@ -80,7 +80,7 @@ public:
|
|||
|
||||
/**
|
||||
* Changes the time user data.
|
||||
* \param data The timer user data.
|
||||
* \param userData: The timer user data.
|
||||
*/
|
||||
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
|
||||
|
||||
|
|
|
@ -212,7 +212,6 @@ public:
|
|||
|
||||
/**
|
||||
* 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)
|
||||
* \return A boolean success indicator of if swap interval was successfully read.
|
||||
*/
|
||||
|
@ -244,7 +243,7 @@ public:
|
|||
|
||||
/**
|
||||
* Changes the window user data.
|
||||
* \param data The window user data.
|
||||
* \param userData The window user data.
|
||||
*/
|
||||
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
|
||||
|
||||
|
@ -281,8 +280,8 @@ public:
|
|||
|
||||
/**
|
||||
* Set the shape of the cursor.
|
||||
* \param cursor The new cursor shape type id.
|
||||
* \return Indication of success.
|
||||
* \param cursorShape: The new cursor shape type id.
|
||||
* \return Indication of success.
|
||||
*/
|
||||
virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
|
||||
|
||||
|
|
|
@ -63,7 +63,7 @@ public:
|
|||
/**
|
||||
* Returns the number of display settings for this display device.
|
||||
* \param display The index of the display to query with 0 <= display < getNumDisplays().
|
||||
* \param setting The number of settings of the display device with this index.
|
||||
* \param numSetting: The number of settings of the display device with this index.
|
||||
* \return Indication of success.
|
||||
*/
|
||||
GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
|
||||
|
|
|
@ -63,7 +63,7 @@ public:
|
|||
/**
|
||||
* Returns the number of display settings for this display device.
|
||||
* \param display The index of the display to query with 0 <= display < getNumDisplays().
|
||||
* \param setting The number of settings of the display device with this index.
|
||||
* \param numSetting: The number of settings of the display device with this index.
|
||||
* \return Indication of success.
|
||||
*/
|
||||
GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
|
||||
|
|
|
@ -66,7 +66,7 @@ public:
|
|||
/**
|
||||
* Returns the number of display settings for this display device.
|
||||
* \param display The index of the display to query with 0 <= display < getNumDisplays().
|
||||
* \param setting The number of settings of the display device with this index.
|
||||
* \param numSetting: The number of settings of the display device with this index.
|
||||
* \return Indication of success.
|
||||
*/
|
||||
GHOST_TSuccess
|
||||
|
|
|
@ -47,9 +47,8 @@ public:
|
|||
* Constructor.
|
||||
* \param time 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 at the time of the event.
|
||||
* \param y The y-coordinate of the location the cursor was at at the time of the event.
|
||||
* \param buttons The state of the buttons was at at the time of the event.
|
||||
* \param window: The window of this event.
|
||||
* \param button: The state of the buttons were at at the time of the event.
|
||||
*/
|
||||
GHOST_EventButton(GHOST_TUns64 time, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask button)
|
||||
: GHOST_Event(time, type, window)
|
||||
|
|
|
@ -45,7 +45,7 @@ public:
|
|||
/**
|
||||
* Constructor.
|
||||
* \param msec The time this event was generated.
|
||||
* \param type The type of this event.
|
||||
* \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.
|
||||
|
|
|
@ -47,9 +47,9 @@ class GHOST_EventWheel : public GHOST_Event
|
|||
public:
|
||||
/**
|
||||
* Constructor.
|
||||
* \param msec The time this event was generated.
|
||||
* \param type The type of this event.
|
||||
* \param z The displacement of the mouse wheel.
|
||||
* \param msec: The time this event was generated.
|
||||
* \param window: The window of this event.
|
||||
* \param z: The displacement of the mouse wheel.
|
||||
*/
|
||||
GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow *window, GHOST_TInt32 z)
|
||||
: GHOST_Event(msec, GHOST_kEventWheel, window)
|
||||
|
|
|
@ -59,15 +59,15 @@ struct GHOST_ModifierKeys {
|
|||
|
||||
/**
|
||||
* Returns the state of a single modifier key.
|
||||
* \param mask. Key state to return.
|
||||
* \param mask: Key state to return.
|
||||
* \return The state of the key (pressed == true).
|
||||
*/
|
||||
bool get(GHOST_TModifierKeyMask mask) const;
|
||||
|
||||
/**
|
||||
* Updates the state of a single modifier key.
|
||||
* \param mask. Key state to update.
|
||||
* \param down. The new state of the key.
|
||||
* \param mask: Key state to update.
|
||||
* \param down: The new state of the key.
|
||||
*/
|
||||
void set(GHOST_TModifierKeyMask mask, bool down);
|
||||
|
||||
|
@ -78,7 +78,7 @@ struct GHOST_ModifierKeys {
|
|||
|
||||
/**
|
||||
* Determines whether to modifier key states are equal.
|
||||
* \param keys. The modifier key state to compare to.
|
||||
* \param keys: The modifier key state to compare to.
|
||||
* \return Indication of equality.
|
||||
*/
|
||||
bool equals(const GHOST_ModifierKeys& keys) const;
|
||||
|
|
|
@ -105,8 +105,8 @@ public:
|
|||
* \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 Stereo visual for quad buffered stereo.
|
||||
* \param numOfAASamples Number of samples used for AA (zero if no AA)
|
||||
* \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).
|
||||
*/
|
||||
|
|
|
@ -118,8 +118,8 @@ public:
|
|||
* \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 Stereo visual for quad buffered stereo.
|
||||
* \param numOfAASamples Number of samples used for AA (zero if no AA)
|
||||
* \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).
|
||||
*/
|
||||
|
@ -283,7 +283,7 @@ protected:
|
|||
* 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 (simular to PS/2 Set 1)
|
||||
* \param scanCode The ScanCode of pressed key (simular to PS/2 Set 1)
|
||||
*/
|
||||
GHOST_TKey processSpecialKey(short vKey, short scanCode) const;
|
||||
|
||||
|
|
|
@ -280,10 +280,8 @@ getAllDisplayDimensions(
|
|||
* \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 Stereo visual for quad buffered stereo.
|
||||
* \param exclusive Use to show the window ontop and ignore others
|
||||
* (used fullscreen).
|
||||
* \param numOfAASamples Number of samples used for AA (zero if no AA)
|
||||
* \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).
|
||||
*/
|
||||
|
|
|
@ -49,7 +49,7 @@ public:
|
|||
* \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 data The timer user data.
|
||||
* \param userData: The timer user data.
|
||||
*/
|
||||
GHOST_TimerTask(GHOST_TUns64 start,
|
||||
GHOST_TUns64 interval,
|
||||
|
@ -129,7 +129,7 @@ public:
|
|||
|
||||
/**
|
||||
* Changes the timer callback.
|
||||
* \param The timer callback.
|
||||
* \param timerProc: The timer callback.
|
||||
*/
|
||||
inline void setTimerProc(const GHOST_TimerProcPtr timerProc)
|
||||
{
|
||||
|
@ -147,7 +147,7 @@ public:
|
|||
|
||||
/**
|
||||
* Changes the time user data.
|
||||
* \param data The timer user data.
|
||||
* \param userData: The timer user data.
|
||||
*/
|
||||
void setUserData(const GHOST_TUserDataPtr userData)
|
||||
{
|
||||
|
|
|
@ -123,7 +123,7 @@ public:
|
|||
|
||||
/**
|
||||
* Set the shape of the cursor.
|
||||
* \param cursor The new cursor shape type id.
|
||||
* \param cursorShape: The new cursor shape type id.
|
||||
* \return Indication of success.
|
||||
*/
|
||||
GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
|
||||
|
@ -281,7 +281,7 @@ public:
|
|||
|
||||
/**
|
||||
* Changes the window user data.
|
||||
* \param data The window user data.
|
||||
* \param userData: The window user data.
|
||||
*/
|
||||
void setUserData(const GHOST_TUserDataPtr userData)
|
||||
{
|
||||
|
|
|
@ -247,7 +247,6 @@ protected:
|
|||
/**
|
||||
* Sets the cursor grab on the window using
|
||||
* native window system calls.
|
||||
* \param warp Only used when grab is enabled, hides the mouse and allows dragging outside the screen.
|
||||
*/
|
||||
GHOST_TSuccess
|
||||
setWindowCursorGrab(
|
||||
|
|
Loading…
Reference in New Issue