GHOST_C-api.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
#pragma once
 
#include "GHOST_Types.h"
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int (*GHOST_EventCallbackProcPtr)(GHOST_EventHandle event, GHOST_TUserDataPtr userdata);
 
extern GHOST_SystemHandle GHOST_CreateSystem(void);
 
extern void GHOST_SystemInitDebug(GHOST_SystemHandle systemhandle, int is_debug_enabled);
 
extern GHOST_TSuccess GHOST_DisposeSystem(GHOST_SystemHandle systemhandle);
 
extern void GHOST_ShowMessageBox(GHOST_SystemHandle systemhandle,
                                 const char *title,
                                 const char *message,
                                 const char *help_label,
                                 const char *continue_label,
                                 const char *link,
                                 GHOST_DialogOptions dialog_options);
 
extern GHOST_EventConsumerHandle GHOST_CreateEventConsumer(
    GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userdata);
 
extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consumerhandle);
 
extern GHOST_TUns64 GHOST_GetMilliSeconds(GHOST_SystemHandle systemhandle);
 
extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle,
                                                GHOST_TUns64 delay,
                                                GHOST_TUns64 interval,
                                                GHOST_TimerProcPtr timerProc,
                                                GHOST_TUserDataPtr userData);
 
extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle,
                                        GHOST_TimerTaskHandle timertaskhandle);
 
/***************************************************************************************
 * Display/window management functionality
 ***************************************************************************************/
 
extern GHOST_TUns8 GHOST_GetNumDisplays(GHOST_SystemHandle systemhandle);
 
extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle,
                                           GHOST_TUns32 *width,
                                           GHOST_TUns32 *height);
 
extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle,
                                          GHOST_TUns32 *width,
                                          GHOST_TUns32 *height);
 
extern GHOST_WindowHandle GHOST_CreateWindow(GHOST_SystemHandle systemhandle,
                                             GHOST_WindowHandle parent_windowhandle,
                                             const char *title,
                                             GHOST_TInt32 left,
                                             GHOST_TInt32 top,
                                             GHOST_TUns32 width,
                                             GHOST_TUns32 height,
                                             GHOST_TWindowState state,
                                             bool is_dialog,
                                             GHOST_TDrawingContextType type,
                                             GHOST_GLSettings glSettings);
 
extern GHOST_ContextHandle GHOST_CreateOpenGLContext(GHOST_SystemHandle systemhandle,
                                                     GHOST_GLSettings glSettings);
 
extern GHOST_TSuccess GHOST_DisposeOpenGLContext(GHOST_SystemHandle systemhandle,
                                                 GHOST_ContextHandle contexthandle);
 
extern GHOST_TUserDataPtr GHOST_GetWindowUserData(GHOST_WindowHandle windowhandle);
 
extern void GHOST_SetWindowUserData(GHOST_WindowHandle windowhandle, GHOST_TUserDataPtr userdata);
 
extern int GHOST_IsDialogWindow(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_DisposeWindow(GHOST_SystemHandle systemhandle,
                                          GHOST_WindowHandle windowhandle);
 
extern int GHOST_ValidWindow(GHOST_SystemHandle systemhandle, GHOST_WindowHandle windowhandle);
 
extern GHOST_WindowHandle GHOST_BeginFullScreen(GHOST_SystemHandle systemhandle,
                                                GHOST_DisplaySetting *setting,
                                                const int stereoVisual);
 
extern GHOST_TSuccess GHOST_EndFullScreen(GHOST_SystemHandle systemhandle);
 
extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle);
 
/***************************************************************************************
 * Event management functionality
 ***************************************************************************************/
 
extern int GHOST_ProcessEvents(GHOST_SystemHandle systemhandle, int waitForEvent);
 
extern void GHOST_DispatchEvents(GHOST_SystemHandle systemhandle);
 
extern GHOST_TSuccess GHOST_AddEventConsumer(GHOST_SystemHandle systemhandle,
                                             GHOST_EventConsumerHandle consumerhandle);
 
extern GHOST_TSuccess GHOST_RemoveEventConsumer(GHOST_SystemHandle systemhandle,
                                                GHOST_EventConsumerHandle consumerhandle);
 
/***************************************************************************************
 * Progress bar functionality
 ***************************************************************************************/
 
extern GHOST_TSuccess GHOST_SetProgressBar(GHOST_WindowHandle windowhandle, float progress);
 
extern GHOST_TSuccess GHOST_EndProgressBar(GHOST_WindowHandle windowhandle);
 
/***************************************************************************************
 * Cursor management functionality
 ***************************************************************************************/
 
extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle,
                                           GHOST_TStandardCursor cursorshape);
 
extern GHOST_TSuccess GHOST_HasCursorShape(GHOST_WindowHandle windowhandle,
                                           GHOST_TStandardCursor cursorshape);
 
extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle,
                                                 GHOST_TUns8 *bitmap,
                                                 GHOST_TUns8 *mask,
                                                 int sizex,
                                                 int sizey,
                                                 int hotX,
                                                 int hotY,
                                                 GHOST_TUns8 canInvertColor);
 
extern int GHOST_GetCursorVisibility(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_SetCursorVisibility(GHOST_WindowHandle windowhandle, int visible);
 
extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle,
                                              GHOST_TInt32 *x,
                                              GHOST_TInt32 *y);
 
extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle,
                                              GHOST_TInt32 x,
                                              GHOST_TInt32 y);
 
extern GHOST_TSuccess GHOST_SetCursorGrab(GHOST_WindowHandle windowhandle,
                                          GHOST_TGrabCursorMode mode,
                                          GHOST_TAxisFlag warp_axis,
                                          int bounds[4],
                                          const int mouse_ungrab_xy[2]);
 
/***************************************************************************************
 * Access to mouse button and keyboard states.
 ***************************************************************************************/
 
extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle,
                                                GHOST_TModifierKeyMask mask,
                                                int *isDown);
 
extern GHOST_TSuccess GHOST_GetButtonState(GHOST_SystemHandle systemhandle,
                                           GHOST_TButtonMask mask,
                                           int *isDown);
 
#ifdef WITH_INPUT_NDOF
/***************************************************************************************
 * Access to 3D mouse.
 ***************************************************************************************/
 
extern void GHOST_setNDOFDeadZone(float deadzone);
#endif
 
/***************************************************************************************
 * Drag'n'drop operations
 ***************************************************************************************/
 
extern void GHOST_setAcceptDragOperation(GHOST_WindowHandle windowhandle, GHOST_TInt8 canAccept);
 
extern GHOST_TEventType GHOST_GetEventType(GHOST_EventHandle eventhandle);
 
extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle);
 
extern GHOST_WindowHandle GHOST_GetEventWindow(GHOST_EventHandle eventhandle);
 
extern GHOST_TEventDataPtr GHOST_GetEventData(GHOST_EventHandle eventhandle);
 
extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhandle);
 
extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle,
                               GHOST_TimerProcPtr timerProc);
 
extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle);
 
extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle,
                                       GHOST_TUserDataPtr userdata);
 
extern int GHOST_GetValid(GHOST_WindowHandle windowhandle);
 
extern GHOST_TDrawingContextType GHOST_GetDrawingContextType(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandle,
                                                  GHOST_TDrawingContextType type);
 
extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle, const char *title);
 
extern char *GHOST_GetTitle(GHOST_WindowHandle windowhandle);
 
extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhandle);
 
extern GHOST_RectangleHandle GHOST_GetClientBounds(GHOST_WindowHandle windowhandle);
 
void GHOST_DisposeRectangle(GHOST_RectangleHandle rectanglehandle);
 
extern GHOST_TSuccess GHOST_SetClientWidth(GHOST_WindowHandle windowhandle, GHOST_TUns32 width);
 
extern GHOST_TSuccess GHOST_SetClientHeight(GHOST_WindowHandle windowhandle, GHOST_TUns32 height);
 
extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle,
                                          GHOST_TUns32 width,
                                          GHOST_TUns32 height);
 
extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle,
                                 GHOST_TInt32 inX,
                                 GHOST_TInt32 inY,
                                 GHOST_TInt32 *outX,
                                 GHOST_TInt32 *outY);
 
extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle,
                                 GHOST_TInt32 inX,
                                 GHOST_TInt32 inY,
                                 GHOST_TInt32 *outX,
                                 GHOST_TInt32 *outY);
 
extern GHOST_TWindowState GHOST_GetWindowState(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_SetWindowState(GHOST_WindowHandle windowhandle,
                                           GHOST_TWindowState state);
 
extern GHOST_TSuccess GHOST_SetWindowModifiedState(GHOST_WindowHandle windowhandle,
                                                   GHOST_TUns8 isUnsavedChanges);
 
extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle,
                                           GHOST_TWindowOrder order);
 
extern GHOST_TSuccess GHOST_SwapWindowBuffers(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_SetSwapInterval(GHOST_WindowHandle windowhandle, int interval);
 
extern GHOST_TSuccess GHOST_GetSwapInterval(GHOST_WindowHandle windowhandle, int *intervalOut);
 
extern GHOST_TSuccess GHOST_ActivateWindowDrawingContext(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_InvalidateWindow(GHOST_WindowHandle windowhandle);
 
extern GHOST_TSuccess GHOST_ActivateOpenGLContext(GHOST_ContextHandle contexthandle);
 
extern GHOST_TSuccess GHOST_ReleaseOpenGLContext(GHOST_ContextHandle contexthandle);
 
extern unsigned int GHOST_GetContextDefaultOpenGLFramebuffer(GHOST_ContextHandle contexthandle);
 
extern int GHOST_isUpsideDownContext(GHOST_ContextHandle contexthandle);
 
extern unsigned int GHOST_GetDefaultOpenGLFramebuffer(GHOST_WindowHandle windwHandle);
 
extern void GHOST_SetTabletAPI(GHOST_SystemHandle systemhandle, GHOST_TTabletAPI api);
 
extern GHOST_TInt32 GHOST_GetWidthRectangle(GHOST_RectangleHandle rectanglehandle);
 
extern GHOST_TInt32 GHOST_GetHeightRectangle(GHOST_RectangleHandle rectanglehandle);
 
extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle,
                               GHOST_TInt32 *l,
                               GHOST_TInt32 *t,
                               GHOST_TInt32 *r,
                               GHOST_TInt32 *b);
 
extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle,
                               GHOST_TInt32 l,
                               GHOST_TInt32 t,
                               GHOST_TInt32 r,
                               GHOST_TInt32 b);
 
extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehandle);
 
extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehandle);
 
extern void GHOST_InsetRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_TInt32 i);
 
extern void GHOST_UnionRectangle(GHOST_RectangleHandle rectanglehandle,
                                 GHOST_RectangleHandle anotherrectanglehandle);
 
extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle,
                                      GHOST_TInt32 x,
                                      GHOST_TInt32 y);
 
extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehandle,
                                              GHOST_TInt32 x,
                                              GHOST_TInt32 y);
 
extern GHOST_TVisibility GHOST_GetRectangleVisibility(
    GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle);
 
extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle,
                                     GHOST_TInt32 cx,
                                     GHOST_TInt32 cy);
 
extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle,
                                     GHOST_TInt32 cx,
                                     GHOST_TInt32 cy,
                                     GHOST_TInt32 w,
                                     GHOST_TInt32 h);
 
extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
                                          GHOST_RectangleHandle anotherrectanglehandle);
 
extern GHOST_TUns8 *GHOST_getClipboard(int selection);
 
extern void GHOST_putClipboard(GHOST_TInt8 *buffer, int selection);
 
extern int GHOST_toggleConsole(int action);
 
extern int GHOST_UseNativePixels(void);
 
extern void GHOST_UseWindowFocus(int use_focus);
 
extern float GHOST_GetNativePixelSize(GHOST_WindowHandle windowhandle);
 
extern GHOST_TUns16 GHOST_GetDPIHint(GHOST_WindowHandle windowhandle);
 
extern void GHOST_BeginIME(GHOST_WindowHandle windowhandle,
                           GHOST_TInt32 x,
                           GHOST_TInt32 y,
                           GHOST_TInt32 w,
                           GHOST_TInt32 h,
                           int complete);
extern void GHOST_EndIME(GHOST_WindowHandle windowhandle);
 
#ifdef WITH_XR_OPENXR
 
/* XR-context */
 
void GHOST_XrErrorHandler(GHOST_XrErrorHandlerFn handler_fn, void *customdata);
 
GHOST_XrContextHandle GHOST_XrContextCreate(const GHOST_XrContextCreateInfo *create_info);
void GHOST_XrContextDestroy(GHOST_XrContextHandle xr_context);
 
void GHOST_XrGraphicsContextBindFuncs(GHOST_XrContextHandle xr_context,
                                      GHOST_XrGraphicsContextBindFn bind_fn,
                                      GHOST_XrGraphicsContextUnbindFn unbind_fn);
 
void GHOST_XrDrawViewFunc(GHOST_XrContextHandle xr_context, GHOST_XrDrawViewFn draw_view_fn);
 
/* sessions */
void GHOST_XrSessionStart(GHOST_XrContextHandle xr_context,
                          const GHOST_XrSessionBeginInfo *begin_info);
void GHOST_XrSessionEnd(GHOST_XrContextHandle xr_context);
void GHOST_XrSessionDrawViews(GHOST_XrContextHandle xr_context, void *customdata);
int GHOST_XrSessionIsRunning(const GHOST_XrContextHandle xr_context);
 
int GHOST_XrSessionNeedsUpsideDownDrawing(const GHOST_XrContextHandle xr_context);
 
/* events */
GHOST_TSuccess GHOST_XrEventsHandle(GHOST_XrContextHandle xr_context);
#endif
 
#ifdef __cplusplus
}
 
#endif