GHOST C-API function and type declarations. More...

#include "GHOST_Types.h"

Typedefs
using	GHOST_EventCallbackProcPtr = bool (*)(GHOST_EventHandle event, GHOST_TUserDataPtr user_data)

Functions
GHOST_SystemHandle	GHOST_CreateSystem (void)
GHOST_SystemHandle	GHOST_CreateSystemBackground (void)
void	GHOST_SystemInitDebug (GHOST_SystemHandle systemhandle, GHOST_Debug debug)
const char *	GHOST_SystemBackend (void)
GHOST_TSuccess	GHOST_DisposeSystem (GHOST_SystemHandle systemhandle)
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)
GHOST_EventConsumerHandle	GHOST_CreateEventConsumer (GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr user_data)
GHOST_TSuccess	GHOST_DisposeEventConsumer (GHOST_EventConsumerHandle consumerhandle)
uint64_t	GHOST_GetMilliSeconds (GHOST_SystemHandle systemhandle)
GHOST_TimerTaskHandle	GHOST_InstallTimer (GHOST_SystemHandle systemhandle, uint64_t delay, uint64_t interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr user_data)
GHOST_TSuccess	GHOST_RemoveTimer (GHOST_SystemHandle systemhandle, GHOST_TimerTaskHandle timertaskhandle)
uint8_t	GHOST_GetNumDisplays (GHOST_SystemHandle systemhandle)
GHOST_TSuccess	GHOST_GetMainDisplayDimensions (GHOST_SystemHandle systemhandle, uint32_t r_width, uint32_t r_height)
GHOST_TSuccess	GHOST_GetAllDisplayDimensions (GHOST_SystemHandle systemhandle, uint32_t r_width, uint32_t r_height)
GHOST_WindowHandle	GHOST_CreateWindow (GHOST_SystemHandle systemhandle, GHOST_WindowHandle parent_windowhandle, const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, bool is_dialog, GHOST_GPUSettings gpuSettings)
GHOST_ContextHandle	GHOST_CreateGPUContext (GHOST_SystemHandle systemhandle, GHOST_GPUSettings gpuSettings)
GHOST_TSuccess	GHOST_DisposeGPUContext (GHOST_SystemHandle systemhandle, GHOST_ContextHandle contexthandle)
GHOST_TUserDataPtr	GHOST_GetWindowUserData (GHOST_WindowHandle windowhandle)
void	GHOST_SetWindowUserData (GHOST_WindowHandle windowhandle, GHOST_TUserDataPtr user_data)
bool	GHOST_IsDialogWindow (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_DisposeWindow (GHOST_SystemHandle systemhandle, GHOST_WindowHandle windowhandle)
bool	GHOST_ValidWindow (GHOST_SystemHandle systemhandle, GHOST_WindowHandle windowhandle)
GHOST_WindowHandle	GHOST_GetWindowUnderCursor (GHOST_SystemHandle systemhandle, int32_t x, int32_t y)
bool	GHOST_ProcessEvents (GHOST_SystemHandle systemhandle, bool waitForEvent)
void	GHOST_DispatchEvents (GHOST_SystemHandle systemhandle)
GHOST_TSuccess	GHOST_AddEventConsumer (GHOST_SystemHandle systemhandle, GHOST_EventConsumerHandle consumerhandle)
GHOST_TSuccess	GHOST_RemoveEventConsumer (GHOST_SystemHandle systemhandle, GHOST_EventConsumerHandle consumerhandle)
GHOST_TSuccess	GHOST_SetProgressBar (GHOST_WindowHandle windowhandle, float progress)
GHOST_TSuccess	GHOST_EndProgressBar (GHOST_WindowHandle windowhandle)
GHOST_TStandardCursor	GHOST_GetCursorShape (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetCursorShape (GHOST_WindowHandle windowhandle, GHOST_TStandardCursor cursorshape)
GHOST_TSuccess	GHOST_HasCursorShape (GHOST_WindowHandle windowhandle, GHOST_TStandardCursor cursorshape)
GHOST_TSuccess	GHOST_SetCustomCursorShape (GHOST_WindowHandle windowhandle, uint8_t bitmap, uint8_t mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
GHOST_TSuccess	GHOST_GetCursorBitmap (GHOST_WindowHandle windowhandle, GHOST_CursorBitmapRef *bitmap)
uint32_t	GHOST_GetCursorPreferredLogicalSize (const GHOST_SystemHandle systemhandle)
bool	GHOST_GetCursorVisibility (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetCursorVisibility (GHOST_WindowHandle windowhandle, bool visible)
GHOST_TSuccess	GHOST_GetCursorPosition (const GHOST_SystemHandle systemhandle, const GHOST_WindowHandle windowhandle, int32_t x, int32_t y)
GHOST_TSuccess	GHOST_SetCursorPosition (GHOST_SystemHandle systemhandle, GHOST_WindowHandle windowhandle, int32_t x, int32_t y)
void	GHOST_GetCursorGrabState (GHOST_WindowHandle windowhandle, GHOST_TGrabCursorMode r_mode, GHOST_TAxisFlag r_axis_flag, int r_bounds[4], bool *r_use_software_cursor)
GHOST_TSuccess	GHOST_SetCursorGrab (GHOST_WindowHandle windowhandle, GHOST_TGrabCursorMode mode, GHOST_TAxisFlag wrap_axis, const int bounds[4], const int mouse_ungrab_xy[2])
GHOST_TSuccess	GHOST_GetModifierKeyState (GHOST_SystemHandle systemhandle, GHOST_TModifierKey mask, bool *r_is_down)
GHOST_TSuccess	GHOST_GetButtonState (GHOST_SystemHandle systemhandle, GHOST_TButton mask, bool *r_is_down)
void	GHOST_setAcceptDragOperation (GHOST_WindowHandle windowhandle, bool can_accept)
GHOST_TEventType	GHOST_GetEventType (GHOST_EventHandle eventhandle)
uint64_t	GHOST_GetEventTime (GHOST_EventHandle eventhandle)
GHOST_WindowHandle	GHOST_GetEventWindow (GHOST_EventHandle eventhandle)
GHOST_TEventDataPtr	GHOST_GetEventData (GHOST_EventHandle eventhandle)
GHOST_TimerProcPtr	GHOST_GetTimerProc (GHOST_TimerTaskHandle timertaskhandle)
void	GHOST_SetTimerProc (GHOST_TimerTaskHandle timertaskhandle, GHOST_TimerProcPtr timerProc)
GHOST_TUserDataPtr	GHOST_GetTimerTaskUserData (GHOST_TimerTaskHandle timertaskhandle)
void	GHOST_SetTimerTaskUserData (GHOST_TimerTaskHandle timertaskhandle, GHOST_TUserDataPtr user_data)
bool	GHOST_GetValid (GHOST_WindowHandle windowhandle)
GHOST_TDrawingContextType	GHOST_GetDrawingContextType (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetDrawingContextType (GHOST_WindowHandle windowhandle, GHOST_TDrawingContextType type)
GHOST_ContextHandle	GHOST_GetDrawingContext (GHOST_WindowHandle windowhandle)
void	GHOST_SetTitle (GHOST_WindowHandle windowhandle, const char *title)
char *	GHOST_GetTitle (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetPath (GHOST_WindowHandle windowhandle, const char *filepath)
GHOST_TWindowDecorationStyleFlags	GHOST_GetWindowDecorationStyleFlags (GHOST_WindowHandle windowhandle)
void	GHOST_SetWindowDecorationStyleFlags (GHOST_WindowHandle windowhandle, GHOST_TWindowDecorationStyleFlags styleFlags)
void	GHOST_SetWindowDecorationStyleSettings (GHOST_WindowHandle windowhandle, GHOST_WindowDecorationStyleSettings decorationSettings)
GHOST_TSuccess	GHOST_ApplyWindowDecorationStyle (GHOST_WindowHandle windowhandle)
GHOST_RectangleHandle	GHOST_GetWindowBounds (GHOST_WindowHandle windowhandle)
GHOST_RectangleHandle	GHOST_GetClientBounds (GHOST_WindowHandle windowhandle)
void	GHOST_DisposeRectangle (GHOST_RectangleHandle rectanglehandle)
GHOST_TSuccess	GHOST_SetClientWidth (GHOST_WindowHandle windowhandle, uint32_t width)
GHOST_TSuccess	GHOST_SetClientHeight (GHOST_WindowHandle windowhandle, uint32_t height)
GHOST_TSuccess	GHOST_SetClientSize (GHOST_WindowHandle windowhandle, uint32_t width, uint32_t height)
void	GHOST_ScreenToClient (GHOST_WindowHandle windowhandle, int32_t inX, int32_t inY, int32_t outX, int32_t outY)
void	GHOST_ClientToScreen (GHOST_WindowHandle windowhandle, int32_t inX, int32_t inY, int32_t outX, int32_t outY)
GHOST_TWindowState	GHOST_GetWindowState (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetWindowState (GHOST_WindowHandle windowhandle, GHOST_TWindowState state)
GHOST_TSuccess	GHOST_SetWindowModifiedState (GHOST_WindowHandle windowhandle, bool isUnsavedChanges)
GHOST_TSuccess	GHOST_SetWindowOrder (GHOST_WindowHandle windowhandle, GHOST_TWindowOrder order)
GHOST_TSuccess	GHOST_SwapWindowBuffers (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_SetSwapInterval (GHOST_WindowHandle windowhandle, int interval)
GHOST_TSuccess	GHOST_GetSwapInterval (GHOST_WindowHandle windowhandle, int *r_interval)
GHOST_TSuccess	GHOST_ActivateWindowDrawingContext (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_InvalidateWindow (GHOST_WindowHandle windowhandle)
GHOST_TSuccess	GHOST_ActivateGPUContext (GHOST_ContextHandle contexthandle)
GHOST_TSuccess	GHOST_ReleaseGPUContext (GHOST_ContextHandle contexthandle)
GHOST_ContextHandle	GHOST_GetActiveGPUContext ()
unsigned int	GHOST_GetContextDefaultGPUFramebuffer (GHOST_ContextHandle contexthandle)
unsigned int	GHOST_GetDefaultGPUFramebuffer (GHOST_WindowHandle windowhandle)
void	GHOST_SetMultitouchGestures (GHOST_SystemHandle systemhandle, const bool use)
void	GHOST_SetTabletAPI (GHOST_SystemHandle systemhandle, GHOST_TTabletAPI api)
GHOST_TSuccess	GHOST_GetPixelAtCursor (float r_color[3])
int32_t	GHOST_GetWidthRectangle (GHOST_RectangleHandle rectanglehandle)
int32_t	GHOST_GetHeightRectangle (GHOST_RectangleHandle rectanglehandle)
void	GHOST_GetRectangle (GHOST_RectangleHandle rectanglehandle, int32_t l, int32_t t, int32_t r, int32_t b)
void	GHOST_SetRectangle (GHOST_RectangleHandle rectanglehandle, int32_t l, int32_t t, int32_t r, int32_t b)
GHOST_TSuccess	GHOST_IsEmptyRectangle (GHOST_RectangleHandle rectanglehandle)
GHOST_TSuccess	GHOST_IsValidRectangle (GHOST_RectangleHandle rectanglehandle)
void	GHOST_InsetRectangle (GHOST_RectangleHandle rectanglehandle, int32_t i)
void	GHOST_UnionRectangle (GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle)
void	GHOST_UnionPointRectangle (GHOST_RectangleHandle rectanglehandle, int32_t x, int32_t y)
GHOST_TSuccess	GHOST_IsInsideRectangle (GHOST_RectangleHandle rectanglehandle, int32_t x, int32_t y)
GHOST_TVisibility	GHOST_GetRectangleVisibility (GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle)
void	GHOST_SetCenterRectangle (GHOST_RectangleHandle rectanglehandle, int32_t cx, int32_t cy)
void	GHOST_SetRectangleCenter (GHOST_RectangleHandle rectanglehandle, int32_t cx, int32_t cy, int32_t w, int32_t h)
GHOST_TSuccess	GHOST_ClipRectangle (GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle)
char *	GHOST_getClipboard (bool selection)
void	GHOST_putClipboard (const char *buffer, bool selection)
GHOST_TSuccess	GHOST_hasClipboardImage (void)
uint *	GHOST_getClipboardImage (int r_width, int r_height)
GHOST_TSuccess	GHOST_putClipboardImage (uint *rgba, int width, int height)
bool	GHOST_setConsoleWindowState (GHOST_TConsoleWindowState action)
bool	GHOST_UseNativePixels (void)
GHOST_TCapabilityFlag	GHOST_GetCapabilities (void)
void	GHOST_SetBacktraceHandler (GHOST_TBacktraceFn backtrace_fn)
void	GHOST_UseWindowFocus (bool use_focus)
void	GHOST_SetAutoFocus (bool auto_focus)
float	GHOST_GetNativePixelSize (GHOST_WindowHandle windowhandle)
uint16_t	GHOST_GetDPIHint (GHOST_WindowHandle windowhandle)
void	GHOST_BeginIME (GHOST_WindowHandle windowhandle, int32_t x, int32_t y, int32_t w, int32_t h, bool complete)
void	GHOST_EndIME (GHOST_WindowHandle windowhandle)

Detailed Description

GHOST C-API function and type declarations.

Definition in file GHOST_C-api.h.

Typedef Documentation

◆ GHOST_EventCallbackProcPtr

using GHOST_EventCallbackProcPtr = bool (*)(GHOST_EventHandle event, GHOST_TUserDataPtr user_data)

Definition of a callback routine that receives events.

Parameters

event	The event received.
user_data	The callback's user data, supplied to GHOST_CreateSystem.

Definition at line 22 of file GHOST_C-api.h.

Function Documentation

◆ GHOST_ActivateGPUContext()

GHOST_TSuccess GHOST_ActivateGPUContext ( GHOST_ContextHandle contexthandle )

extern

Activates the drawing context of this context.

Parameters

contexthandle The handle to the context.

Returns: A success indicator.

Definition at line 731 of file GHOST_C-api.cc.

References GHOST_ActivateGPUContext(), GHOST_kFailure, and GHOST_PRINTF.

Referenced by blender::gpu::GPUSecondaryContext::activate(), GHOST_ActivateGPUContext(), blender::gpu::GPUSecondaryContext::GPUSecondaryContext(), blender::gpu::GPUTest::SetUpTestSuite(), and WM_system_gpu_context_activate().

◆ GHOST_ActivateWindowDrawingContext()

GHOST_TSuccess GHOST_ActivateWindowDrawingContext ( GHOST_WindowHandle windowhandle )

extern

Activates the drawing context of this window.

Parameters

windowhandle The handle to the window.

Returns: A success indicator.

Definition at line 724 of file GHOST_C-api.cc.

References GHOST_IWindow::activateDrawingContext(), and GHOST_ActivateWindowDrawingContext().

Referenced by extrawindow_do_draw(), extrawindow_do_reshape(), GHOST_ActivateWindowDrawingContext(), ghost_event_proc(), loggerwindow_do_draw(), loggerwindow_do_reshape(), mainwindow_do_draw(), mainwindow_do_reshape(), playanim_toscreen_ex(), setViewPortGL(), wm_ghostwindow_destroy(), WM_window_pixels_read_from_frontbuffer(), WM_window_pixels_read_sample_from_frontbuffer(), and wm_window_set_drawable().

◆ GHOST_AddEventConsumer()

GHOST_TSuccess GHOST_AddEventConsumer	(	GHOST_SystemHandle	systemhandle,
		GHOST_EventConsumerHandle	consumerhandle )

extern

Adds the given event consumer to our list.

Parameters

systemhandle	The handle to the system.
consumerhandle	The event consumer to add.

Returns: Indication of success.

Definition at line 244 of file GHOST_C-api.cc.

References GHOST_ISystem::addEventConsumer(), and GHOST_AddEventConsumer().

Referenced by GHOST_AddEventConsumer(), main(), multitestapp_new(), wm_ghost_init(), and wm_main_playanim_intern().

◆ GHOST_ApplyWindowDecorationStyle()

GHOST_TSuccess GHOST_ApplyWindowDecorationStyle ( GHOST_WindowHandle windowhandle )

extern

Apply the window decoration style using the current flags and settings.

Definition at line 603 of file GHOST_C-api.cc.

References GHOST_IWindow::applyWindowDecorationStyle(), and GHOST_ApplyWindowDecorationStyle().

Referenced by GHOST_ApplyWindowDecorationStyle(), and WM_window_decoration_style_apply().

◆ GHOST_BeginIME()

void GHOST_BeginIME	(	GHOST_WindowHandle	windowhandle,
		int32_t	x,
		int32_t	y,
		int32_t	w,
		int32_t	h,
		bool	complete )

extern

Enable IME attached to the given window, i.e. allows user-input events to be dispatched to the IME.

Parameters

windowhandle	Window handle of the caller.
x	Requested x-coordinate of the rectangle.
y	Requested y-coordinate of the rectangle.
w	Requested width of the rectangle.
h	Requested height of the rectangle.
complete	Whether or not to complete the ongoing composition. true: Start a new composition. false: Move the IME windows to the given position without finishing it.

References GHOST_BeginIME(), w(), x, and y.

Referenced by GHOST_BeginIME().

◆ GHOST_ClientToScreen()

void GHOST_ClientToScreen	(	GHOST_WindowHandle	windowhandle,
		int32_t	inX,
		int32_t	inY,
		int32_t *	outX,
		int32_t *	outY )

extern

Converts a point in client rectangle coordinates to screen coordinates.

Parameters

windowhandle	The handle to the window.
inX	The x-coordinate in the client rectangle.
inY	The y-coordinate in the client rectangle.
outX	The x-coordinate on the screen.
outY	The y-coordinate on the screen.

Definition at line 667 of file GHOST_C-api.cc.

References GHOST_IWindow::clientToScreen(), and GHOST_ClientToScreen().

Referenced by GHOST_ClientToScreen(), and wm_cursor_position_to_ghost_screen_coords().

◆ GHOST_ClipRectangle()

GHOST_TSuccess GHOST_ClipRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		GHOST_RectangleHandle	anotherrectanglehandle )

extern

Clips a rectangle. Updates the rectangle given such that it will fit within this one. This can result in an empty rectangle.

Parameters

rectanglehandle	The handle to the rectangle.
anotherrectanglehandle	The rectangle to clip.

Returns: Whether clipping has occurred

Definition at line 886 of file GHOST_C-api.cc.

References GHOST_ClipRectangle(), GHOST_kFailure, GHOST_kSuccess, and result.

Referenced by GHOST_ClipRectangle().

◆ GHOST_CreateEventConsumer()

GHOST_EventConsumerHandle GHOST_CreateEventConsumer	(	GHOST_EventCallbackProcPtr	eventCallback,
		GHOST_TUserDataPtr	user_data )

extern

Creates an event consumer object

Parameters

eventCallback	The event callback routine.
user_data	Pointer to user data returned to the callback routine.

Definition at line 73 of file GHOST_C-api.cc.

References GHOST_CallbackEventConsumer::GHOST_CallbackEventConsumer(), and GHOST_CreateEventConsumer().

Referenced by GHOST_CreateEventConsumer(), main(), multitestapp_new(), wm_ghost_init(), and wm_main_playanim_intern().

◆ GHOST_CreateGPUContext()

GHOST_ContextHandle GHOST_CreateGPUContext	(	GHOST_SystemHandle	systemhandle,
		GHOST_GPUSettings	gpuSettings )

extern

Create a new off-screen context. Never explicitly delete the context, use #disposeContext() instead.

Parameters

systemhandle	The handle to the system.
gpuSettings	Misc GPU options.

Returns: A handle to the new context ( == nullptr if creation failed).

Definition at line 141 of file GHOST_C-api.cc.

References GHOST_ISystem::createOffscreenContext(), and GHOST_CreateGPUContext().

Referenced by GHOST_CreateGPUContext(), blender::gpu::GPUSecondaryContext::GPUSecondaryContext(), blender::gpu::GPUTest::SetUpTestSuite(), and WM_system_gpu_context_create().

◆ GHOST_CreateSystem()

GHOST_SystemHandle GHOST_CreateSystem ( void )

extern

Creates the one and only system.

Returns: a handle to the system.

Definition at line 26 of file GHOST_C-api.cc.

References GHOST_ISystem::createSystem(), GHOST_ISystem::getSystem(), and GHOST_CreateSystem().

Referenced by GHOST_CreateSystem(), main(), multitestapp_new(), wm_ghost_init(), and wm_main_playanim_intern().

◆ GHOST_CreateSystemBackground()

GHOST_SystemHandle GHOST_CreateSystemBackground ( void )

extern

Definition at line 34 of file GHOST_C-api.cc.

References GHOST_ISystem::createSystemBackground(), GHOST_ISystem::getSystem(), and GHOST_CreateSystemBackground().

Referenced by GHOST_CreateSystemBackground(), blender::gpu::GPUTest::SetUpTestSuite(), and wm_ghost_init_background().

◆ GHOST_CreateWindow()

GHOST_WindowHandle GHOST_CreateWindow	(	GHOST_SystemHandle	systemhandle,
		GHOST_WindowHandle	parent_windowhandle,
		const char *	title,
		int32_t	left,
		int32_t	top,
		uint32_t	width,
		uint32_t	height,
		GHOST_TWindowState	state,
		bool	is_dialog,
		GHOST_GPUSettings	gpuSettings )

extern

Create a new window. The new window is added to the list of windows managed. Never explicitly delete the window, use disposeWindow() instead.

Parameters

systemhandle	The handle to the system.
parent_windowhandle	Handle of parent (or owner) window, or nullptr
title	The name of the window. (displayed in the title bar of the window if the OS supports it).
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state of the window when opened.
is_dialog	Stay on top of parent window, no icon in taskbar, can't be minimized.
gpuSettings	Misc GPU options.

Returns: A handle to the new window ( == nullptr if creation failed).

Definition at line 158 of file GHOST_C-api.cc.

References GHOST_ISystem::createWindow(), GHOST_CreateWindow(), and state.

Referenced by extrawindow_new(), GHOST_CreateWindow(), loggerwindow_new(), main(), mainwindow_new(), playanim_window_open(), and wm_window_ghostwindow_add().

◆ GHOST_DispatchEvents()

void GHOST_DispatchEvents ( GHOST_SystemHandle systemhandle )

extern

Retrieves events from the queue and send them to the event consumers.

Parameters

systemhandle The handle to the system.

Definition at line 237 of file GHOST_C-api.cc.

References GHOST_ISystem::dispatchEvents(), and GHOST_DispatchEvents().

Referenced by build_pict_list_from_image_sequence(), GHOST_DispatchEvents(), main(), multitestapp_run(), wm_main_playanim_intern(), and wm_window_events_process().

◆ GHOST_DisposeEventConsumer()

GHOST_TSuccess GHOST_DisposeEventConsumer ( GHOST_EventConsumerHandle consumerhandle )

extern

Disposes an event consumer object

Parameters

consumerhandle Handle to the event consumer.

Returns: An indication of success.

Definition at line 79 of file GHOST_C-api.cc.

References GHOST_DisposeEventConsumer(), and GHOST_kSuccess.

Referenced by GHOST_DisposeEventConsumer(), and wm_main_playanim_intern().

◆ GHOST_DisposeGPUContext()

GHOST_TSuccess GHOST_DisposeGPUContext	(	GHOST_SystemHandle	systemhandle,
		GHOST_ContextHandle	contexthandle )

extern

Dispose of a context.

Parameters

systemhandle	The handle to the system.
contexthandle	Handle to the context to be disposed.

Returns: Indication of success.

Definition at line 149 of file GHOST_C-api.cc.

References GHOST_ISystem::disposeContext(), and GHOST_DisposeGPUContext().

Referenced by GHOST_DisposeGPUContext(), blender::gpu::GPUTest::TearDownTestSuite(), WM_system_gpu_context_dispose(), and blender::gpu::GPUSecondaryContext::~GPUSecondaryContext().

◆ GHOST_DisposeRectangle()

void GHOST_DisposeRectangle ( GHOST_RectangleHandle rectanglehandle )

Disposes a rectangle object.

Parameters

rectanglehandle Handle to the rectangle.

Definition at line 631 of file GHOST_C-api.cc.

References GHOST_DisposeRectangle().

Referenced by blender::gpu::GLContext::activate(), GHOST_DisposeRectangle(), blender::gpu::GLContext::GLContext(), playanim_window_size_get(), setViewPortGL(), and wm_window_update_size_position().

◆ GHOST_DisposeSystem()

GHOST_TSuccess GHOST_DisposeSystem ( GHOST_SystemHandle systemhandle )

extern

Disposes the one and only system.

Parameters

systemhandle The handle to the system.

Returns: An indication of success.

Definition at line 49 of file GHOST_C-api.cc.

References GHOST_ISystem::disposeSystem(), and GHOST_DisposeSystem().

Referenced by GHOST_DisposeSystem(), main(), multitestapp_free(), blender::gpu::GPUTest::TearDownTestSuite(), wm_ghost_exit(), and wm_main_playanim_intern().

◆ GHOST_DisposeWindow()

GHOST_TSuccess GHOST_DisposeWindow	(	GHOST_SystemHandle	systemhandle,
		GHOST_WindowHandle	windowhandle )

extern

Dispose a window.

Parameters

systemhandle	The handle to the system.
windowhandle	Handle to the window to be disposed.

Returns: Indication of success.

Definition at line 203 of file GHOST_C-api.cc.

References GHOST_ISystem::disposeWindow(), and GHOST_DisposeWindow().

Referenced by extrawindow_free(), GHOST_DisposeWindow(), loggerwindow_free(), main(), mainwindow_free(), processEvent(), wm_ghostwindow_destroy(), and wm_main_playanim_intern().

◆ GHOST_EndIME()

void GHOST_EndIME ( GHOST_WindowHandle windowhandle )

extern

Disable the IME attached to the given window, i.e. prohibits any user-input events from being dispatched to the IME.

Parameters

windowhandle The window handle of the caller.

References GHOST_EndIME(), GHOST_XrContextCreate(), GHOST_XrContextDestroy(), GHOST_XrErrorHandler(), and GHOST_XrEventsHandle().

Referenced by GHOST_EndIME().

◆ GHOST_EndProgressBar()

GHOST_TSuccess GHOST_EndProgressBar ( GHOST_WindowHandle windowhandle )

extern

Hides the progress bar in the icon

Parameters

windowhandle The handle to the window.

Definition at line 267 of file GHOST_C-api.cc.

References GHOST_IWindow::endProgressBar(), and GHOST_EndProgressBar().

Referenced by GHOST_EndProgressBar(), and WM_progress_clear().

◆ GHOST_GetActiveGPUContext()

GHOST_ContextHandle GHOST_GetActiveGPUContext ( )

extern

Return the thread's currently active drawing context.

Definition at line 748 of file GHOST_C-api.cc.

References GHOST_IContext::getActiveDrawingContext(), and GHOST_GetActiveGPUContext().

Referenced by GHOST_GetActiveGPUContext(), and blender::gpu::GPUSecondaryContext::GPUSecondaryContext().

◆ GHOST_GetAllDisplayDimensions()

GHOST_TSuccess GHOST_GetAllDisplayDimensions	(	GHOST_SystemHandle	systemhandle,
		uint32_t *	r_width,
		uint32_t *	r_height )

extern

Returns the dimensions of all displays combine (the current workspace). No need to worry about overlapping monitors.

Parameters

systemhandle	The handle to the system.
r_width	A pointer the width gets put in.
r_height	A pointer the height gets put in.

Returns: success.

Definition at line 130 of file GHOST_C-api.cc.

References GHOST_ISystem::getAllDisplayDimensions(), GHOST_GetAllDisplayDimensions(), GHOST_kFailure, and GHOST_kSuccess.

Referenced by GHOST_GetAllDisplayDimensions(), and wm_get_desktopsize().

◆ GHOST_GetButtonState()

GHOST_TSuccess GHOST_GetButtonState	(	GHOST_SystemHandle	systemhandle,
		GHOST_TButton	mask,
		bool *	r_is_down )

extern

Returns the state of a mouse button (outside the message queue).

Parameters

systemhandle	The handle to the system.
mask	The button state to retrieve.
isDown	Pointer to return button state in.

Returns: Indication of success.

Definition at line 437 of file GHOST_C-api.cc.

References GHOST_ISystem::getButtonState(), GHOST_GetButtonState(), mask(), and result.

Referenced by GHOST_GetButtonState().

◆ GHOST_GetCapabilities()

GHOST_TCapabilityFlag GHOST_GetCapabilities ( void )

extern

Return features which are supported by the GHOST back-end.

Definition at line 939 of file GHOST_C-api.cc.

References GHOST_ISystem::getCapabilities(), GHOST_ISystem::getSystem(), and GHOST_GetCapabilities().

Referenced by GHOST_GetCapabilities(), playanim_window_open(), and WM_capabilities_flag().

◆ GHOST_GetClientBounds()

GHOST_RectangleHandle GHOST_GetClientBounds ( GHOST_WindowHandle windowhandle )

extern

Returns the client rectangle dimensions. The left and top members of the rectangle are always zero.

Parameters

windowhandle The handle to the window.

Returns: A handle to the bounding rectangle of the window.

Definition at line 620 of file GHOST_C-api.cc.

References GHOST_IWindow::getClientBounds(), GHOST_GetClientBounds(), and GHOST_Rect::GHOST_Rect().

Referenced by blender::gpu::GLContext::activate(), extrawindow_do_reshape(), GHOST_GetClientBounds(), blender::gpu::GLContext::GLContext(), loggerwindow_do_reshape(), mainwindow_do_reshape(), playanim_window_size_get(), setViewPortGL(), and wm_window_update_size_position().

◆ GHOST_getClipboard()

char * GHOST_getClipboard ( bool selection )

extern

Return the data from the clipboard

Parameters

selection Boolean to return the selection instead, X11 only feature.

Returns: clipboard data

Definition at line 897 of file GHOST_C-api.cc.

References GHOST_ISystem::getClipboard(), GHOST_ISystem::getSystem(), and GHOST_getClipboard().

Referenced by GHOST_getClipboard(), and wm_clipboard_text_get_impl().

◆ GHOST_getClipboardImage()

uint * GHOST_getClipboardImage	(	int *	r_width,
		int *	r_height )

extern

Get image data from the Clipboard

Parameters

r_width	the returned image width in pixels.
r_height	the returned image height in pixels.

Returns: pointer uint array in RGBA byte order. Caller must free.

Definition at line 915 of file GHOST_C-api.cc.

References GHOST_ISystem::getClipboardImage(), GHOST_ISystem::getSystem(), and GHOST_getClipboardImage().

Referenced by GHOST_getClipboardImage(), and WM_clipboard_image_get().

◆ GHOST_GetContextDefaultGPUFramebuffer()

unsigned int GHOST_GetContextDefaultGPUFramebuffer ( GHOST_ContextHandle contexthandle )

extern

Get the GPU frame-buffer handle that serves as a default frame-buffer.

Definition at line 753 of file GHOST_C-api.cc.

References GHOST_GetContextDefaultGPUFramebuffer().

Referenced by GHOST_GetContextDefaultGPUFramebuffer().

◆ GHOST_GetCursorBitmap()

GHOST_TSuccess GHOST_GetCursorBitmap	(	GHOST_WindowHandle	windowhandle,
		GHOST_CursorBitmapRef *	bitmap )

extern

Definition at line 311 of file GHOST_C-api.cc.

References GHOST_IWindow::getCursorBitmap(), and GHOST_GetCursorBitmap().

Referenced by GHOST_GetCursorBitmap(), and wm_software_cursor_draw().

◆ GHOST_GetCursorGrabState()

void GHOST_GetCursorGrabState	(	GHOST_WindowHandle	windowhandle,
		GHOST_TGrabCursorMode *	r_mode,
		GHOST_TAxisFlag *	r_axis_flag,
		int	r_bounds[4],
		bool *	r_use_software_cursor )

Definition at line 406 of file GHOST_C-api.cc.

References GHOST_IWindow::getCursorGrabState(), GHOST_GetCursorGrabState(), GHOST_Rect::m_b, GHOST_Rect::m_l, GHOST_Rect::m_r, and GHOST_Rect::m_t.

Referenced by GHOST_GetCursorGrabState(), wm_software_cursor_needed_for_window(), and wm_window_grab_warp_region_is_set().

◆ GHOST_GetCursorPosition()

GHOST_TSuccess GHOST_GetCursorPosition	(	const GHOST_SystemHandle	systemhandle,
		const GHOST_WindowHandle	windowhandle,
		int32_t *	x,
		int32_t *	y )

Returns the current location of the cursor (location in client relative coordinates)

Parameters

systemhandle	The handle to the system.
x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Definition at line 362 of file GHOST_C-api.cc.

References GHOST_ISystem::getCursorPositionClientRelative(), GHOST_GetCursorPosition(), x, and y.

Referenced by ghost_event_proc(), GHOST_GetCursorPosition(), and wm_cursor_position_get().

◆ GHOST_GetCursorPreferredLogicalSize()

uint32_t GHOST_GetCursorPreferredLogicalSize ( const GHOST_SystemHandle systemhandle )

extern

Returns: the size of the cursor in logical pixels (before Hi-DPI scaling is applied).

Definition at line 319 of file GHOST_C-api.cc.

References GHOST_ISystem::getCursorPreferredLogicalSize(), and GHOST_GetCursorPreferredLogicalSize().

Referenced by GHOST_GetCursorPreferredLogicalSize(), and WM_cursor_preferred_logical_size().

◆ GHOST_GetCursorShape()

GHOST_TStandardCursor GHOST_GetCursorShape ( GHOST_WindowHandle windowhandle )

extern

Returns the current cursor shape.

Parameters

windowhandle The handle to the window.

Returns: The current cursor shape.

Definition at line 274 of file GHOST_C-api.cc.

References GHOST_IWindow::getCursorShape(), and GHOST_GetCursorShape().

Referenced by GHOST_GetCursorShape().

◆ GHOST_GetCursorVisibility()

bool GHOST_GetCursorVisibility ( GHOST_WindowHandle windowhandle )

extern

Returns the visibility state of the cursor.

Parameters

windowhandle The handle to the window.

Returns: The visibility state of the cursor.

Definition at line 326 of file GHOST_C-api.cc.

References GHOST_IWindow::getCursorVisibility(), and GHOST_GetCursorVisibility().

Referenced by GHOST_GetCursorVisibility(), processEvent(), and wm_software_cursor_needed_for_window().

◆ GHOST_GetDefaultGPUFramebuffer()

unsigned int GHOST_GetDefaultGPUFramebuffer ( GHOST_WindowHandle windowhandle )

extern

Get the GPU frame-buffer handle that serves as a default frame-buffer.

Definition at line 760 of file GHOST_C-api.cc.

References GHOST_IWindow::getDefaultFramebuffer(), and GHOST_GetDefaultGPUFramebuffer().

Referenced by GHOST_GetDefaultGPUFramebuffer(), and blender::gpu::GLContext::GLContext().

◆ GHOST_GetDPIHint()

uint16_t GHOST_GetDPIHint ( GHOST_WindowHandle windowhandle )

extern

Returns the suggested DPI for this window.

Definition at line 971 of file GHOST_C-api.cc.

References GHOST_IWindow::getDPIHint(), and GHOST_GetDPIHint().

Referenced by GHOST_GetDPIHint(), playanim_window_font_scale_from_dpi(), and WM_window_set_dpi().

◆ GHOST_GetDrawingContext()

GHOST_ContextHandle GHOST_GetDrawingContext ( GHOST_WindowHandle windowhandle )

extern

Returns the drawing context used in the this window.

Parameters

windowhandle The handle to the window.

Returns: The window drawing context.

Definition at line 545 of file GHOST_C-api.cc.

References GHOST_IWindow::getDrawingContext(), and GHOST_GetDrawingContext().

Referenced by blender::gpu::VKBackend::context_alloc(), and GHOST_GetDrawingContext().

◆ GHOST_GetDrawingContextType()

GHOST_TDrawingContextType GHOST_GetDrawingContextType ( GHOST_WindowHandle windowhandle )

extern

Returns the type of drawing context used in this window.

Parameters

windowhandle The handle to the window.

Returns: The current type of drawing context.

Definition at line 530 of file GHOST_C-api.cc.

References GHOST_IWindow::getDrawingContextType(), and GHOST_GetDrawingContextType().

Referenced by GHOST_GetDrawingContextType().

◆ GHOST_GetEventData()

GHOST_TEventDataPtr GHOST_GetEventData ( GHOST_EventHandle eventhandle )

extern

Returns the event data.

Parameters

eventhandle The handle to the event.

Returns: The event data.

Definition at line 487 of file GHOST_C-api.cc.

References GHOST_IEvent::getData(), and GHOST_GetEventData().

Referenced by event_to_buf(), extrawindow_handle(), ghost_event_proc(), ghost_event_proc(), GHOST_GetEventData(), loggerwindow_handle(), mainwindow_handle(), and processEvent().

◆ GHOST_GetEventTime()

uint64_t GHOST_GetEventTime ( GHOST_EventHandle eventhandle )

extern

Returns the time this event was generated.

Parameters

eventhandle The handle to the event.

Returns: The event generation time.

Definition at line 473 of file GHOST_C-api.cc.

References GHOST_IEvent::getTime(), and GHOST_GetEventTime().

Referenced by event_to_buf(), extrawindow_handle(), ghost_event_proc(), ghost_event_proc_timestamp_warning(), and GHOST_GetEventTime().

◆ GHOST_GetEventType()

GHOST_TEventType GHOST_GetEventType ( GHOST_EventHandle eventhandle )

extern

Returns the event type.

Parameters

eventhandle The handle to the event.

Returns: The event type.

Definition at line 466 of file GHOST_C-api.cc.

References GHOST_IEvent::getType(), and GHOST_GetEventType().

Referenced by event_to_buf(), extrawindow_handle(), ghost_event_proc(), ghost_event_proc(), ghost_event_proc_timestamp_warning(), GHOST_GetEventType(), loggerwindow_handle(), mainwindow_handle(), multitest_event_handler(), and processEvent().

◆ GHOST_GetEventWindow()

GHOST_WindowHandle GHOST_GetEventWindow ( GHOST_EventHandle eventhandle )

extern

Returns the window this event was generated on, or nullptr if it is a 'system' event.

Parameters

eventhandle The handle to the event.

Returns: The generating window.

Definition at line 480 of file GHOST_C-api.cc.

References GHOST_IEvent::getWindow(), and GHOST_GetEventWindow().

Referenced by event_to_buf(), ghost_event_proc(), GHOST_GetEventWindow(), multitest_event_handler(), and processEvent().

◆ GHOST_GetHeightRectangle()

int32_t GHOST_GetHeightRectangle ( GHOST_RectangleHandle rectanglehandle )

extern

Access to rectangle height.

Parameters

rectanglehandle The handle to the rectangle.

Returns: height of the rectangle

Definition at line 797 of file GHOST_C-api.cc.

References GHOST_GetHeightRectangle().

Referenced by blender::gpu::GLContext::activate(), extrawindow_do_reshape(), GHOST_GetHeightRectangle(), blender::gpu::GLContext::GLContext(), loggerwindow_do_reshape(), mainwindow_do_reshape(), playanim_window_size_get(), and setViewPortGL().

◆ GHOST_GetMainDisplayDimensions()

GHOST_TSuccess GHOST_GetMainDisplayDimensions	(	GHOST_SystemHandle	systemhandle,
		uint32_t *	r_width,
		uint32_t *	r_height )

extern

Returns the dimensions of the main display on this system.

Parameters

systemhandle	The handle to the system.
r_width	A pointer the width gets put in.
r_height	A pointer the height gets put in.

Returns: success.

Definition at line 119 of file GHOST_C-api.cc.

References GHOST_ISystem::getMainDisplayDimensions(), GHOST_GetMainDisplayDimensions(), GHOST_kFailure, and GHOST_kSuccess.

Referenced by GHOST_GetMainDisplayDimensions(), loggerwindow_new(), playanim_window_open(), and wm_get_screensize().

◆ GHOST_GetMilliSeconds()

uint64_t GHOST_GetMilliSeconds ( GHOST_SystemHandle systemhandle )

extern

Returns the system time. Returns the number of milliseconds since the start of the system.

Parameters

systemhandle The handle to the system.

Returns: The number of milliseconds.

Definition at line 85 of file GHOST_C-api.cc.

References GHOST_ISystem::getMilliSeconds(), and GHOST_GetMilliSeconds().

Referenced by ghost_event_proc_timestamp_warning(), and GHOST_GetMilliSeconds().

◆ GHOST_GetModifierKeyState()

GHOST_TSuccess GHOST_GetModifierKeyState	(	GHOST_SystemHandle	systemhandle,
		GHOST_TModifierKey	mask,
		bool *	r_is_down )

extern

Returns the state of a modifier key (outside the message queue).

Parameters

systemhandle	The handle to the system.
mask	The modifier key state to retrieve.
isDown	Pointer to return modifier state in.

Returns: Indication of success.

Definition at line 423 of file GHOST_C-api.cc.

References GHOST_ISystem::getModifierKeyState(), GHOST_GetModifierKeyState(), mask(), and result.

Referenced by GHOST_GetModifierKeyState(), playanim_event_qual_update(), and wm_ghost_modifier_query().

◆ GHOST_GetNativePixelSize()

float GHOST_GetNativePixelSize ( GHOST_WindowHandle windowhandle )

extern

If window was opened using native pixel size, it returns scaling factor.

Definition at line 962 of file GHOST_C-api.cc.

References GHOST_IWindow::getNativePixelSize(), and GHOST_GetNativePixelSize().

Referenced by GHOST_GetNativePixelSize(), playanim_window_font_scale_from_dpi(), playanim_window_size_get(), wm_cursor_arrow_move(), wm_cursor_position_from_ghost_client_coords(), wm_cursor_position_to_ghost_client_coords(), WM_window_native_pixel_coords(), WM_window_native_pixel_size(), WM_window_native_pixel_x(), WM_window_native_pixel_y(), WM_window_open(), and WM_window_set_dpi().

◆ GHOST_GetNumDisplays()

uint8_t GHOST_GetNumDisplays ( GHOST_SystemHandle systemhandle )

extern

Returns the number of displays on this system.

Parameters

systemhandle The handle to the system.

Returns: The number of displays.

Definition at line 112 of file GHOST_C-api.cc.

References GHOST_ISystem::getNumDisplays(), and GHOST_GetNumDisplays().

Referenced by GHOST_GetNumDisplays().

◆ GHOST_GetPixelAtCursor()

GHOST_TSuccess GHOST_GetPixelAtCursor ( float r_color[3] )

extern

Get the color of the pixel at the current mouse cursor location

Parameters

r_color returned sRGB float colors

Returns: Success value (true == successful and supported by platform)

Definition at line 786 of file GHOST_C-api.cc.

References GHOST_ISystem::getPixelAtCursor(), GHOST_ISystem::getSystem(), and GHOST_GetPixelAtCursor().

Referenced by GHOST_GetPixelAtCursor(), and WM_desktop_cursor_sample_read().

◆ GHOST_GetRectangle()

void GHOST_GetRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t *	l,
		int32_t *	t,
		int32_t *	r,
		int32_t *	b )

extern

Gets all members of the rectangle.

Parameters

rectanglehandle	The handle to the rectangle.
l	Pointer to return left coordinate in.
t	Pointer to return top coordinate in.
r	Pointer to return right coordinate in.
b	Pointer to return bottom coordinate in.

Definition at line 802 of file GHOST_C-api.cc.

References b, GHOST_GetRectangle(), l, GHOST_Rect::m_b, GHOST_Rect::m_l, GHOST_Rect::m_r, and GHOST_Rect::m_t.

Referenced by GHOST_GetRectangle(), and wm_window_update_size_position().

◆ GHOST_GetRectangleVisibility()

GHOST_TVisibility GHOST_GetRectangleVisibility	(	GHOST_RectangleHandle	rectanglehandle,
		GHOST_RectangleHandle	anotherrectanglehandle )

extern

Returns whether the rectangle is inside this rectangle.

Parameters

rectanglehandle	The handle to the rectangle.
anotherrectanglehandle	The rectangle to test.

Returns: visibility (not, partially or fully visible).

Definition at line 865 of file GHOST_C-api.cc.

References GHOST_GetRectangleVisibility(), and GHOST_kNotVisible.

Referenced by GHOST_GetRectangleVisibility().

◆ GHOST_GetSwapInterval()

GHOST_TSuccess GHOST_GetSwapInterval	(	GHOST_WindowHandle	windowhandle,
		int *	r_interval )

extern

Gets the current swap interval for #swapBuffers.

Parameters

windowhandle	The handle to the window
r_interval	pointer to location to return swap interval (left untouched if there is an error)

Returns: A boolean success indicator of if swap interval was successfully read.

Definition at line 717 of file GHOST_C-api.cc.

References GHOST_IWindow::getSwapInterval(), and GHOST_GetSwapInterval().

Referenced by GHOST_GetSwapInterval(), and wm_window_get_swap_interval().

◆ GHOST_GetTimerProc()

GHOST_TimerProcPtr GHOST_GetTimerProc ( GHOST_TimerTaskHandle timertaskhandle )

extern

Returns the timer callback.

Parameters

timertaskhandle The handle to the timer-task.

Returns: The timer callback.

Definition at line 494 of file GHOST_C-api.cc.

References GHOST_ITimerTask::getTimerProc(), and GHOST_GetTimerProc().

Referenced by GHOST_GetTimerProc().

◆ GHOST_GetTimerTaskUserData()

GHOST_TUserDataPtr GHOST_GetTimerTaskUserData ( GHOST_TimerTaskHandle timertaskhandle )

extern

Returns the timer user data.

Parameters

timertaskhandle The handle to the timer-task.

Returns: The timer user data.

Definition at line 508 of file GHOST_C-api.cc.

References GHOST_ITimerTask::getUserData(), and GHOST_GetTimerTaskUserData().

Referenced by gearsTimerProc(), GHOST_GetTimerTaskUserData(), and mainwindow_timer_proc().

◆ GHOST_GetTitle()

char * GHOST_GetTitle ( GHOST_WindowHandle windowhandle )

extern

Returns the title displayed in the title bar. The title must be freed with free().

Parameters

windowhandle The handle to the window.

Returns: The title, free with free().

Definition at line 558 of file GHOST_C-api.cc.

References GHOST_IWindow::getTitle(), and GHOST_GetTitle().

Referenced by event_to_buf(), GHOST_GetTitle(), and processEvent().

◆ GHOST_GetValid()

bool GHOST_GetValid ( GHOST_WindowHandle windowhandle )

extern

Returns indication as to whether the window is valid.

Parameters

windowhandle The handle to the window.

Returns: The validity of the window.

Definition at line 523 of file GHOST_C-api.cc.

References GHOST_IWindow::getValid(), and GHOST_GetValid().

Referenced by GHOST_GetValid().

◆ GHOST_GetWidthRectangle()

int32_t GHOST_GetWidthRectangle ( GHOST_RectangleHandle rectanglehandle )

extern

Access to rectangle width.

Parameters

rectanglehandle The handle to the rectangle.

Returns: width of the rectangle

Definition at line 792 of file GHOST_C-api.cc.

References GHOST_GetWidthRectangle().

Referenced by blender::gpu::GLContext::activate(), extrawindow_do_reshape(), GHOST_GetWidthRectangle(), blender::gpu::GLContext::GLContext(), loggerwindow_do_reshape(), mainwindow_do_reshape(), playanim_window_size_get(), and setViewPortGL().

◆ GHOST_GetWindowBounds()

GHOST_RectangleHandle GHOST_GetWindowBounds ( GHOST_WindowHandle windowhandle )

extern

Returns the window rectangle dimensions. These are screen coordinates.

Parameters

windowhandle The handle to the window.

Returns: A handle to the bounding rectangle of the window.

Definition at line 609 of file GHOST_C-api.cc.

References GHOST_IWindow::getWindowBounds(), GHOST_GetWindowBounds(), and GHOST_Rect::GHOST_Rect().

Referenced by GHOST_GetWindowBounds().

◆ GHOST_GetWindowDecorationStyleFlags()

GHOST_TWindowDecorationStyleFlags GHOST_GetWindowDecorationStyleFlags ( GHOST_WindowHandle windowhandle )

extern

Return the current window decoration style flags.

Definition at line 582 of file GHOST_C-api.cc.

References GHOST_IWindow::getWindowDecorationStyleFlags(), and GHOST_GetWindowDecorationStyleFlags().

Referenced by GHOST_GetWindowDecorationStyleFlags(), and WM_window_decoration_style_flags_get().

◆ GHOST_GetWindowState()

GHOST_TWindowState GHOST_GetWindowState ( GHOST_WindowHandle windowhandle )

extern

Returns the state of the window (normal, minimized, maximized).

Parameters

windowhandle The handle to the window.

Returns: The state of the window.

Definition at line 675 of file GHOST_C-api.cc.

References GHOST_IWindow::getState(), and GHOST_GetWindowState().

Referenced by ghost_event_proc(), GHOST_GetWindowState(), wm_draw_update(), WM_stereo3d_enabled(), wm_window_fullscreen_toggle_exec(), wm_window_ghostwindow_add(), and wm_window_raise().

◆ GHOST_GetWindowUnderCursor()

GHOST_WindowHandle GHOST_GetWindowUnderCursor	(	GHOST_SystemHandle	systemhandle,
		int32_t	x,
		int32_t	y )

extern

Get the Window under the cursor. Although coordinates of the mouse are supplied, platform- specific implementations are free to ignore these and query the mouse location themselves, due to them possibly being incorrect under certain conditions, for example when using multiple monitors that vary in scale and/or DPI.

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: The window under the cursor or nullptr in none.

Definition at line 220 of file GHOST_C-api.cc.

References GHOST_ISystem::getWindowUnderCursor(), GHOST_GetWindowUnderCursor(), x, and y.

Referenced by GHOST_GetWindowUnderCursor(), and WM_window_find_under_cursor().

◆ GHOST_GetWindowUserData()

GHOST_TUserDataPtr GHOST_GetWindowUserData ( GHOST_WindowHandle windowhandle )

extern

Returns the window user data.

Parameters

windowhandle The handle to the window.

Returns: The window user data.

Definition at line 183 of file GHOST_C-api.cc.

References GHOST_IWindow::getUserData(), and GHOST_GetWindowUserData().

Referenced by extrawindow_free(), ghost_event_proc(), GHOST_GetWindowUserData(), loggerwindow_free(), mainwindow_free(), multitest_event_handler(), and WM_window_find_under_cursor().

◆ GHOST_hasClipboardImage()

GHOST_TSuccess GHOST_hasClipboardImage ( void )

extern

Returns GHOST_kSuccess if the clipboard contains an image.

Definition at line 909 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_hasClipboardImage(), and GHOST_ISystem::hasClipboardImage().

Referenced by GHOST_hasClipboardImage(), and WM_clipboard_image_available().

◆ GHOST_HasCursorShape()

GHOST_TSuccess GHOST_HasCursorShape	(	GHOST_WindowHandle	windowhandle,
		GHOST_TStandardCursor	cursorshape )

extern

Test if the standard cursor shape is supported by current platform.

Returns: Indication of success.

Definition at line 289 of file GHOST_C-api.cc.

References GHOST_HasCursorShape(), and GHOST_IWindow::hasCursorShape().

Referenced by GHOST_HasCursorShape(), and WM_cursor_set().

◆ GHOST_InsetRectangle()

void GHOST_InsetRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	i )

extern

Grows (or shrinks the rectangle). The method avoids negative insets making the rectangle invalid

Parameters

rectanglehandle	The handle to the rectangle.
i	The amount of offset given to each extreme (negative values shrink the rectangle).

Definition at line 839 of file GHOST_C-api.cc.

References GHOST_InsetRectangle(), and i.

Referenced by GHOST_InsetRectangle().

◆ GHOST_InstallTimer()

GHOST_TimerTaskHandle GHOST_InstallTimer	(	GHOST_SystemHandle	systemhandle,
		uint64_t	delay,
		uint64_t	interval,
		GHOST_TimerProcPtr	timerProc,
		GHOST_TUserDataPtr	user_data )

extern

Installs a timer. Note that, on most operating systems, messages need to be processed in order for the timer callbacks to be invoked.

Parameters

systemhandle	The handle to the system.
delay	The time to wait for the first call to the timerProc (in milliseconds).
interval	The interval between calls to the timerProc (in milliseconds).
timerProc	The callback invoked when the interval expires.
userData	Placeholder for user data.

Returns: A timer task (0 if timer task installation failed).

Definition at line 92 of file GHOST_C-api.cc.

References GHOST_InstallTimer(), and GHOST_ISystem::installTimer().

Referenced by GHOST_InstallTimer(), main(), mainwindow_new(), and processEvent().

◆ GHOST_InvalidateWindow()

GHOST_TSuccess GHOST_InvalidateWindow ( GHOST_WindowHandle windowhandle )

extern

Invalidates the contents of this window.

Parameters

windowhandle The handle to the window.

Returns: Indication of success.

Definition at line 767 of file GHOST_C-api.cc.

References GHOST_InvalidateWindow(), and GHOST_IWindow::invalidate().

Referenced by gearsTimerProc(), GHOST_InvalidateWindow(), loggerwindow_do_button(), loggerwindow_do_move(), loggerwindow_log(), mainwindow_do_button(), mainwindow_do_key(), and mainwindow_do_move().

◆ GHOST_IsDialogWindow()

bool GHOST_IsDialogWindow ( GHOST_WindowHandle windowhandle )

extern

Definition at line 196 of file GHOST_C-api.cc.

References GHOST_IsDialogWindow(), and GHOST_IWindow::isDialog().

Referenced by GHOST_IsDialogWindow(), and wm_window_copy().

◆ GHOST_IsEmptyRectangle()

GHOST_TSuccess GHOST_IsEmptyRectangle ( GHOST_RectangleHandle rectanglehandle )

extern

Returns whether this rectangle is empty. Empty rectangles are rectangles that have width==0 and/or height==0.

Parameters

rectanglehandle The handle to the rectangle.

Returns: Success value (true == empty rectangle)

Definition at line 819 of file GHOST_C-api.cc.

References GHOST_IsEmptyRectangle(), GHOST_kFailure, GHOST_kSuccess, and result.

Referenced by GHOST_IsEmptyRectangle().

◆ GHOST_IsInsideRectangle()

GHOST_TSuccess GHOST_IsInsideRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	x,
		int32_t	y )

extern

Returns whether the point is inside this rectangle. Point on the boundary is considered inside.

Parameters

rectanglehandle	The handle to the rectangle.
x	x-coordinate of point to test.
y	y-coordinate of point to test.

Returns: Success value (true if point is inside).

Definition at line 855 of file GHOST_C-api.cc.

References GHOST_IsInsideRectangle(), GHOST_kFailure, GHOST_kSuccess, isInside(), result, x, and y.

Referenced by GHOST_IsInsideRectangle().

◆ GHOST_IsValidRectangle()

GHOST_TSuccess GHOST_IsValidRectangle ( GHOST_RectangleHandle rectanglehandle )

extern

Returns whether this rectangle is valid. Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, empty rectangles are valid.

Parameters

rectanglehandle The handle to the rectangle.

Returns: Success value (true == valid rectangle)

Definition at line 829 of file GHOST_C-api.cc.

References GHOST_IsValidRectangle(), GHOST_kFailure, GHOST_kSuccess, and result.

Referenced by GHOST_IsValidRectangle().

◆ GHOST_ProcessEvents()

bool GHOST_ProcessEvents	(	GHOST_SystemHandle	systemhandle,
		bool	waitForEvent )

extern

Retrieves events from the system and stores them in the queue.

Parameters

systemhandle	The handle to the system.
waitForEvent	Boolean to indicate that #ProcessEvents should. wait (block) until the next event before returning.

Returns: Indication of the presence of events.

Definition at line 230 of file GHOST_C-api.cc.

References GHOST_ProcessEvents(), and GHOST_ISystem::processEvents().

Referenced by build_pict_list_from_image_sequence(), GHOST_ProcessEvents(), main(), multitestapp_run(), wm_main_playanim_intern(), and wm_window_events_process().

◆ GHOST_putClipboard()

void GHOST_putClipboard	(	const char *	buffer,
		bool	selection )

extern

Put data to the Clipboard

Parameters

buffer	the string buffer to set.
selection	Set the selection instead, X11 only feature.

Definition at line 903 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_putClipboard(), and GHOST_ISystem::putClipboard().

Referenced by GHOST_putClipboard(), and wm_clipboard_text_set_impl().

◆ GHOST_putClipboardImage()

GHOST_TSuccess GHOST_putClipboardImage	(	uint *	rgba,
		int	width,
		int	height )

extern

Put image data to the Clipboard

Parameters

rgba	uint array in RGBA byte order.
width	the image width in pixels.
height	the image height in pixels.

Definition at line 921 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_putClipboardImage(), and GHOST_ISystem::putClipboardImage().

Referenced by GHOST_putClipboardImage(), and WM_clipboard_image_set_byte_buffer().

◆ GHOST_ReleaseGPUContext()

GHOST_TSuccess GHOST_ReleaseGPUContext ( GHOST_ContextHandle contexthandle )

extern

Release the drawing context bound to this thread.

Parameters

contexthandle The handle to the context.

Returns: A success indicator.

Definition at line 741 of file GHOST_C-api.cc.

References GHOST_ReleaseGPUContext().

Referenced by GHOST_ReleaseGPUContext(), blender::gpu::GPUSecondaryContext::GPUSecondaryContext(), WM_system_gpu_context_release(), and blender::gpu::GPUSecondaryContext::~GPUSecondaryContext().

◆ GHOST_RemoveEventConsumer()

GHOST_TSuccess GHOST_RemoveEventConsumer	(	GHOST_SystemHandle	systemhandle,
		GHOST_EventConsumerHandle	consumerhandle )

extern

Remove the given event consumer to our list.

Parameters

systemhandle	The handle to the system.
consumerhandle	The event consumer to remove.

Returns: Indication of success.

Definition at line 252 of file GHOST_C-api.cc.

References GHOST_RemoveEventConsumer(), and GHOST_ISystem::removeEventConsumer().

Referenced by GHOST_RemoveEventConsumer(), and wm_main_playanim_intern().

◆ GHOST_RemoveTimer()

GHOST_TSuccess GHOST_RemoveTimer	(	GHOST_SystemHandle	systemhandle,
		GHOST_TimerTaskHandle	timertaskhandle )

extern

Removes a timer.

Parameters

systemhandle	The handle to the system.
timertaskhandle	Timer task to be removed.

Returns: Indication of success.

Definition at line 103 of file GHOST_C-api.cc.

References GHOST_RemoveTimer(), and GHOST_ISystem::removeTimer().

Referenced by GHOST_RemoveTimer(), and processEvent().

◆ GHOST_ScreenToClient()

void GHOST_ScreenToClient	(	GHOST_WindowHandle	windowhandle,
		int32_t	inX,
		int32_t	inY,
		int32_t *	outX,
		int32_t *	outY )

extern

Converts a point in screen coordinates to client rectangle coordinates

Parameters

windowhandle	The handle to the window.
inX	The x-coordinate on the screen.
inY	The y-coordinate on the screen.
outX	The x-coordinate in the client rectangle.
outY	The y-coordinate in the client rectangle.

Definition at line 659 of file GHOST_C-api.cc.

References GHOST_ScreenToClient(), and GHOST_IWindow::screenToClient().

Referenced by ghost_event_proc(), GHOST_ScreenToClient(), loggerwindow_handle(), mainwindow_handle(), and wm_cursor_position_from_ghost_screen_coords().

◆ GHOST_setAcceptDragOperation()

void GHOST_setAcceptDragOperation	(	GHOST_WindowHandle	windowhandle,
		bool	can_accept )

extern

Tells if the ongoing drag & drop object can be accepted upon mouse drop.

Definition at line 459 of file GHOST_C-api.cc.

References GHOST_setAcceptDragOperation(), and GHOST_IWindow::setAcceptDragOperation().

Referenced by GHOST_setAcceptDragOperation().

◆ GHOST_SetAutoFocus()

void GHOST_SetAutoFocus ( bool auto_focus )

extern

Focus and raise windows on mouse hover.

Definition at line 956 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_SetAutoFocus(), and GHOST_ISystem::setAutoFocus().

Referenced by GHOST_SetAutoFocus(), ui_textedit_begin(), and ui_textedit_end().

◆ GHOST_SetBacktraceHandler()

void GHOST_SetBacktraceHandler ( GHOST_TBacktraceFn backtrace_fn )

extern

Assign the callback which generates a back-trace (may be nullptr).

Definition at line 945 of file GHOST_C-api.cc.

References GHOST_SetBacktraceHandler(), and GHOST_ISystem::setBacktraceFn().

Referenced by GHOST_SetBacktraceHandler(), wm_ghost_init(), wm_ghost_init_background(), and wm_main_playanim_intern().

◆ GHOST_SetCenterRectangle()

void GHOST_SetCenterRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	cx,
		int32_t	cy )

extern

Sets rectangle members. Sets rectangle members such that it is centered at the given location.

Parameters

rectanglehandle	The handle to the rectangle.
cx	Requested center x-coordinate of the rectangle.
cy	Requested center y-coordinate of the rectangle.

Definition at line 875 of file GHOST_C-api.cc.

References GHOST_SetCenterRectangle().

Referenced by GHOST_SetCenterRectangle().

◆ GHOST_SetClientHeight()

GHOST_TSuccess GHOST_SetClientHeight	(	GHOST_WindowHandle	windowhandle,
		uint32_t	height )

extern

Resizes client rectangle height.

Parameters

windowhandle	The handle to the window.
height	The new height of the client area of the window.

Returns: Indication of success.

Definition at line 643 of file GHOST_C-api.cc.

References GHOST_SetClientHeight(), and GHOST_IWindow::setClientHeight().

Referenced by GHOST_SetClientHeight().

◆ GHOST_SetClientSize()

GHOST_TSuccess GHOST_SetClientSize	(	GHOST_WindowHandle	windowhandle,
		uint32_t	width,
		uint32_t	height )

extern

Resizes client rectangle.

Parameters

windowhandle	The handle to the window.
width	The new width of the client area of the window.
height	The new height of the client area of the window.

Returns: Indication of success.

Definition at line 650 of file GHOST_C-api.cc.

References GHOST_SetClientSize(), and GHOST_IWindow::setClientSize().

Referenced by GHOST_SetClientSize(), playanim_window_zoom(), and wm_window_set_size().

◆ GHOST_SetClientWidth()

GHOST_TSuccess GHOST_SetClientWidth	(	GHOST_WindowHandle	windowhandle,
		uint32_t	width )

extern

Resizes client rectangle width.

Parameters

windowhandle	The handle to the window.
width	The new width of the client area of the window.

Returns: Indication of success.

Definition at line 636 of file GHOST_C-api.cc.

References GHOST_SetClientWidth(), and GHOST_IWindow::setClientWidth().

Referenced by GHOST_SetClientWidth().

◆ GHOST_setConsoleWindowState()

bool GHOST_setConsoleWindowState ( GHOST_TConsoleWindowState action )

extern

Set the Console State

Parameters

action console state

Returns: current status (1 -visible, 0 - hidden)

Definition at line 927 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_setConsoleWindowState(), and GHOST_ISystem::setConsoleWindowState().

Referenced by GHOST_setConsoleWindowState(), and WM_init().

◆ GHOST_SetCursorGrab()

GHOST_TSuccess GHOST_SetCursorGrab	(	GHOST_WindowHandle	windowhandle,
		GHOST_TGrabCursorMode	mode,
		GHOST_TAxisFlag	wrap_axis,
		const int	bounds[4],
		const int	mouse_ungrab_xy[2] )

extern

Grabs the cursor for a modal operation, to keep receiving events when the mouse is outside the window. X11 only, others do this automatically.

Parameters

windowhandle	The handle to the window.
mode	The new grab state of the cursor.
bounds	The grab region (optional) - left,top,right,bottom.
mouse_ungrab_xy	XY for new mouse location (optional).

Returns: Indication of success.

Definition at line 384 of file GHOST_C-api.cc.

References bounds(), GHOST_Rect::GHOST_Rect(), GHOST_SetCursorGrab(), and GHOST_IWindow::setCursorGrab().

Referenced by GHOST_SetCursorGrab(), WM_cursor_grab_disable(), and WM_cursor_grab_enable().

◆ GHOST_SetCursorPosition()

GHOST_TSuccess GHOST_SetCursorPosition	(	GHOST_SystemHandle	systemhandle,
		GHOST_WindowHandle	windowhandle,
		int32_t	x,
		int32_t	y )

Updates the location of the cursor (location in client relative coordinates). Not all operating systems allow the cursor to be moved (without the input device being moved).

Parameters

systemhandle	The handle to the system.
x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Definition at line 373 of file GHOST_C-api.cc.

References GHOST_SetCursorPosition(), GHOST_ISystem::setCursorPositionClientRelative(), x, and y.

Referenced by GHOST_SetCursorPosition(), and WM_cursor_warp().

◆ GHOST_SetCursorShape()

GHOST_TSuccess GHOST_SetCursorShape	(	GHOST_WindowHandle	windowhandle,
		GHOST_TStandardCursor	cursorshape )

extern

Set the shape of the cursor. If the shape is not supported by the platform, it will use the default cursor instead.

Parameters

windowhandle	The handle to the window.
cursorshape	The new cursor shape type id.

Returns: Indication of success.

Definition at line 281 of file GHOST_C-api.cc.

References GHOST_SetCursorShape(), and GHOST_IWindow::setCursorShape().

Referenced by GHOST_SetCursorShape(), loggerwindow_do_button(), mainwindow_do_key(), processEvent(), and WM_cursor_set().

◆ GHOST_SetCursorVisibility()

GHOST_TSuccess GHOST_SetCursorVisibility	(	GHOST_WindowHandle	windowhandle,
		bool	visible )

extern

Shows or hides the cursor.

Parameters

windowhandle	The handle to the window.
visible	The new visibility state of the cursor.

Returns: Indication of success.

Definition at line 333 of file GHOST_C-api.cc.

References GHOST_SetCursorVisibility(), and GHOST_IWindow::setCursorVisibility().

Referenced by GHOST_SetCursorVisibility(), mainwindow_do_key(), processEvent(), and WM_cursor_set().

◆ GHOST_SetCustomCursorShape()

GHOST_TSuccess GHOST_SetCustomCursorShape	(	GHOST_WindowHandle	windowhandle,
		uint8_t *	bitmap,
		uint8_t *	mask,
		int	sizex,
		int	sizey,
		int	hotX,
		int	hotY,
		bool	canInvertColor )

extern

Set the shape of the cursor to a custom cursor of specified size.

Parameters

windowhandle	The handle to the window.
bitmap	The bitmap data for the cursor.
mask	The mask data for the cursor.
sizex	The width of the cursor.
sizey	The height of the cursor.
hotX	The X coordinate of the cursor hot-spot.
hotY	The Y coordinate of the cursor hot-spot.
canInvertColor	Let macOS invert cursor color to match platform convention.

Returns: Indication of success.

Definition at line 297 of file GHOST_C-api.cc.

References GHOST_SetCustomCursorShape(), mask(), and GHOST_IWindow::setCustomCursorShape().

Referenced by extrawindow_spin_cursor(), GHOST_SetCustomCursorShape(), window_set_custom_cursor(), wm_cursor_time_large(), and wm_cursor_time_small().

◆ GHOST_SetDrawingContextType()

GHOST_TSuccess GHOST_SetDrawingContextType	(	GHOST_WindowHandle	windowhandle,
		GHOST_TDrawingContextType	type )

extern

Tries to install a rendering context in this window.

Parameters

windowhandle	The handle to the window.
type	The type of rendering context installed.

Returns: Indication as to whether installation has succeeded.

Definition at line 537 of file GHOST_C-api.cc.

References GHOST_SetDrawingContextType(), and GHOST_IWindow::setDrawingContextType().

Referenced by GHOST_SetDrawingContextType().

◆ GHOST_SetMultitouchGestures()

void GHOST_SetMultitouchGestures	(	GHOST_SystemHandle	systemhandle,
		const bool	use )

extern

Use multi-touch gestures if supported.

Parameters

systemhandle	The handle to the system.
use	Enable or disable.

Definition at line 774 of file GHOST_C-api.cc.

References GHOST_SetMultitouchGestures(), and GHOST_ISystem::setMultitouchGestures().

Referenced by GHOST_SetMultitouchGestures(), and WM_init_input_devices().

◆ GHOST_SetPath()

GHOST_TSuccess GHOST_SetPath	(	GHOST_WindowHandle	windowhandle,
		const char *	filepath )

extern

Sets the file name represented by this window.

Parameters

filepath The file directory.

Returns: Indication if the backend implements file associated with window.

Definition at line 575 of file GHOST_C-api.cc.

References GHOST_SetPath(), and GHOST_IWindow::setPath().

Referenced by GHOST_SetPath(), and WM_window_title().

◆ GHOST_SetProgressBar()

GHOST_TSuccess GHOST_SetProgressBar	(	GHOST_WindowHandle	windowhandle,
		float	progress )

extern

Sets the progress bar value displayed in the window/application icon

Parameters

windowhandle	The handle to the window.
progress	The progress percentage (0.0 to 1.0).

Definition at line 260 of file GHOST_C-api.cc.

References GHOST_SetProgressBar(), progress, and GHOST_IWindow::setProgressBar().

Referenced by GHOST_SetProgressBar(), and WM_progress_set().

◆ GHOST_SetRectangle()

void GHOST_SetRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	l,
		int32_t	t,
		int32_t	r,
		int32_t	b )

extern

Sets all members of the rectangle.

Parameters

rectanglehandle	The handle to the rectangle.
l	requested left coordinate of the rectangle.
t	requested top coordinate of the rectangle.
r	requested right coordinate of the rectangle.
b	requested bottom coordinate of the rectangle.

Definition at line 813 of file GHOST_C-api.cc.

References b, GHOST_SetRectangle(), and l.

Referenced by GHOST_SetRectangle().

◆ GHOST_SetRectangleCenter()

void GHOST_SetRectangleCenter	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	cx,
		int32_t	cy,
		int32_t	w,
		int32_t	h )

extern

Sets rectangle members. Sets rectangle members such that it is centered at the given location, with the width requested.

Parameters

rectanglehandle	The handle to the rectangle.
cx	requested center x-coordinate of the rectangle.
cy	requested center y-coordinate of the rectangle.
w	requested width of the rectangle.
h	requested height of the rectangle.

Definition at line 880 of file GHOST_C-api.cc.

References GHOST_SetRectangleCenter(), and w().

Referenced by GHOST_SetRectangleCenter().

◆ GHOST_SetSwapInterval()

GHOST_TSuccess GHOST_SetSwapInterval	(	GHOST_WindowHandle	windowhandle,
		int	interval )

extern

Sets the swap interval for #swapBuffers.

Parameters

interval The swap interval to use.

Returns: A boolean success indicator.

Definition at line 710 of file GHOST_C-api.cc.

References GHOST_SetSwapInterval(), and GHOST_IWindow::setSwapInterval().

Referenced by GHOST_SetSwapInterval(), and wm_window_set_swap_interval().

◆ GHOST_SetTabletAPI()

void GHOST_SetTabletAPI	(	GHOST_SystemHandle	systemhandle,
		GHOST_TTabletAPI	api )

extern

Set which tablet API to use. Only affects Windows, other platforms have a single API.

Parameters

systemhandle	The handle to the system.
api	Enum indicating which API to use.

Definition at line 780 of file GHOST_C-api.cc.

References GHOST_SetTabletAPI(), and GHOST_ISystem::setTabletAPI().

Referenced by GHOST_SetTabletAPI(), and WM_init_input_devices().

◆ GHOST_SetTimerProc()

void GHOST_SetTimerProc	(	GHOST_TimerTaskHandle	timertaskhandle,
		GHOST_TimerProcPtr	timerProc )

extern

Changes the timer callback.

Parameters

timertaskhandle	The handle to the timer-task.
timerProc	The timer callback.

Definition at line 501 of file GHOST_C-api.cc.

References GHOST_SetTimerProc(), and GHOST_ITimerTask::setTimerProc().

Referenced by GHOST_SetTimerProc().

◆ GHOST_SetTimerTaskUserData()

void GHOST_SetTimerTaskUserData	(	GHOST_TimerTaskHandle	timertaskhandle,
		GHOST_TUserDataPtr	user_data )

extern

Changes the time user data.

Parameters

timertaskhandle	The handle to the timer-task.
user_data	The timer user data.

Definition at line 515 of file GHOST_C-api.cc.

References GHOST_SetTimerTaskUserData(), and GHOST_ITimerTask::setUserData().

Referenced by GHOST_SetTimerTaskUserData().

◆ GHOST_SetTitle()

void GHOST_SetTitle	(	GHOST_WindowHandle	windowhandle,
		const char *	title )

extern

Sets the title displayed in the title bar.

Parameters

windowhandle	The handle to the window.
title	The title to display in the title bar.

Definition at line 551 of file GHOST_C-api.cc.

References GHOST_SetTitle(), and GHOST_IWindow::setTitle().

Referenced by GHOST_SetTitle(), processEvent(), and WM_window_title().

◆ GHOST_SetWindowDecorationStyleFlags()

void GHOST_SetWindowDecorationStyleFlags	(	GHOST_WindowHandle	windowhandle,
		GHOST_TWindowDecorationStyleFlags	styleFlags )

extern

Set the window decoration style flags.

Parameters

styleFlags Window decoration style flags.

Definition at line 589 of file GHOST_C-api.cc.

References GHOST_SetWindowDecorationStyleFlags(), and GHOST_IWindow::setWindowDecorationStyleFlags().

Referenced by GHOST_SetWindowDecorationStyleFlags(), and WM_window_decoration_style_flags_set().

◆ GHOST_SetWindowDecorationStyleSettings()

void GHOST_SetWindowDecorationStyleSettings	(	GHOST_WindowHandle	windowhandle,
		GHOST_WindowDecorationStyleSettings	decorationSettings )

extern

Set the window decoration style settings.

Parameters

decorationSettings Window decoration style settings.

Definition at line 596 of file GHOST_C-api.cc.

References GHOST_SetWindowDecorationStyleSettings(), and GHOST_IWindow::setWindowDecorationStyleSettings().

Referenced by GHOST_SetWindowDecorationStyleSettings(), and wm_window_decoration_style_set_from_theme().

◆ GHOST_SetWindowModifiedState()

GHOST_TSuccess GHOST_SetWindowModifiedState	(	GHOST_WindowHandle	windowhandle,
		bool	isUnsavedChanges )

extern

Sets the window "modified" status, indicating unsaved changes.

Parameters

windowhandle	The handle to the window.
isUnsavedChanges	Unsaved changes or not.

Returns: Indication of success.

Definition at line 689 of file GHOST_C-api.cc.

References GHOST_SetWindowModifiedState(), and GHOST_IWindow::setModifiedState().

Referenced by GHOST_SetWindowModifiedState(), and WM_window_title().

◆ GHOST_SetWindowOrder()

GHOST_TSuccess GHOST_SetWindowOrder	(	GHOST_WindowHandle	windowhandle,
		GHOST_TWindowOrder	order )

extern

Sets the order of the window (bottom, top).

Parameters

windowhandle	The handle to the window.
order	The order of the window.

Returns: Indication of success.

Definition at line 696 of file GHOST_C-api.cc.

References GHOST_SetWindowOrder(), and GHOST_IWindow::setOrder().

Referenced by GHOST_SetWindowOrder(), mainwindow_do_key(), wm_window_lower(), and wm_window_raise().

◆ GHOST_SetWindowState()

GHOST_TSuccess GHOST_SetWindowState	(	GHOST_WindowHandle	windowhandle,
		GHOST_TWindowState	state )

extern

Sets the state of the window (normal, minimized, maximized).

Parameters

windowhandle	The handle to the window.
state	The state of the window.

Returns: Indication of success.

Definition at line 682 of file GHOST_C-api.cc.

References GHOST_SetWindowState(), GHOST_IWindow::setState(), and state.

Referenced by GHOST_SetWindowState(), wm_window_fullscreen_toggle_exec(), wm_window_ghostwindow_add(), and wm_window_raise().

◆ GHOST_SetWindowUserData()

void GHOST_SetWindowUserData	(	GHOST_WindowHandle	windowhandle,
		GHOST_TUserDataPtr	user_data )

extern

Changes the window user data.

Parameters

windowhandle	The handle to the window.
user_data	The window user data.

Definition at line 189 of file GHOST_C-api.cc.

References GHOST_SetWindowUserData(), and GHOST_IWindow::setUserData().

Referenced by extrawindow_new(), GHOST_SetWindowUserData(), loggerwindow_new(), mainwindow_new(), wm_file_read_setup_wm_substitute_old_window(), and wm_window_ghostwindow_add().

◆ GHOST_ShowMessageBox()

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

Show a system message box to the user

Parameters

systemhandle	The handle to the system.
title	Title of the message box.
message	Message of the message box.
help_label	Text to show on the help button that opens a link.
continue_label	Text to show on the ok button that continues.
link	Optional (hyper)link to a web-page to show when pressing help.
dialog_options	Options to configure the message box.

Definition at line 61 of file GHOST_C-api.cc.

References GHOST_ShowMessageBox(), and GHOST_ISystem::showMessageBox().

Referenced by GHOST_ShowMessageBox(), and WM_ghost_show_message_box().

◆ GHOST_SwapWindowBuffers()

GHOST_TSuccess GHOST_SwapWindowBuffers ( GHOST_WindowHandle windowhandle )

extern

Swaps front and back buffers of a window.

Parameters

windowhandle The handle to the window.

Returns: A success indicator.

Definition at line 703 of file GHOST_C-api.cc.

References GHOST_SwapWindowBuffers(), and GHOST_IWindow::swapBuffers().

Referenced by extrawindow_do_draw(), GHOST_SwapWindowBuffers(), loggerwindow_do_draw(), mainwindow_do_draw(), playanim_toscreen_ex(), processEvent(), wm_main_playanim_intern(), and wm_window_swap_buffers().

◆ GHOST_SystemBackend()

const char * GHOST_SystemBackend ( void )

extern

Definition at line 55 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystemBackend(), and GHOST_SystemBackend().

Referenced by GHOST_SystemBackend(), and wm_ghost_init().

◆ GHOST_SystemInitDebug()

void GHOST_SystemInitDebug	(	GHOST_SystemHandle	systemhandle,
		GHOST_Debug	debug )

extern

Specifies whether debug messages are to be enabled for the specific system handle.

Parameters

systemhandle	The handle to the system.
debug	Flag for systems to debug.

Definition at line 42 of file GHOST_C-api.cc.

References GHOST_SystemInitDebug(), and GHOST_ISystem::initDebug().

Referenced by GHOST_SystemInitDebug(), wm_ghost_init(), and wm_ghost_init_background().

◆ GHOST_UnionPointRectangle()

void GHOST_UnionPointRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		int32_t	x,
		int32_t	y )

extern

Grows the rectangle to included a point.

Parameters

rectanglehandle	The handle to the rectangle.
x	The x-coordinate of the point.
y	The y-coordinate of the point.

Definition at line 850 of file GHOST_C-api.cc.

References GHOST_UnionPointRectangle(), x, and y.

Referenced by GHOST_UnionPointRectangle().

◆ GHOST_UnionRectangle()

void GHOST_UnionRectangle	(	GHOST_RectangleHandle	rectanglehandle,
		GHOST_RectangleHandle	anotherrectanglehandle )

extern

Does a union of the rectangle given and this rectangle. The result is stored in this rectangle.

Parameters

rectanglehandle	The handle to the rectangle.
anotherrectanglehandle	The rectangle that is input for the union operation.

Definition at line 844 of file GHOST_C-api.cc.

References GHOST_UnionRectangle().

Referenced by GHOST_UnionRectangle().

◆ GHOST_UseNativePixels()

bool GHOST_UseNativePixels ( void )

extern

Use native pixel size (MacBook pro 'retina'), if supported.

Definition at line 933 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_UseNativePixels(), and GHOST_ISystem::useNativePixel().

Referenced by GHOST_UseNativePixels(), wm_ghost_init(), and wm_main_playanim_intern().

◆ GHOST_UseWindowFocus()

void GHOST_UseWindowFocus ( bool use_focus )

extern

Focus window after opening, or put them in the background.

Definition at line 950 of file GHOST_C-api.cc.

References GHOST_ISystem::getSystem(), GHOST_UseWindowFocus(), and GHOST_ISystem::useWindowFocus().

Referenced by GHOST_UseWindowFocus(), and wm_ghost_init().

◆ GHOST_ValidWindow()

bool GHOST_ValidWindow	(	GHOST_SystemHandle	systemhandle,
		GHOST_WindowHandle	windowhandle )

extern

Returns whether a window is valid.

Parameters

systemhandle	The handle to the system.
windowhandle	Handle to the window to be checked.

Returns: Indication of validity.

Definition at line 212 of file GHOST_C-api.cc.

References GHOST_ValidWindow(), and GHOST_ISystem::validWindow().

Referenced by gearsTimerProc(), ghost_event_proc(), GHOST_ValidWindow(), main(), multitest_event_handler(), and processEvent().

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ GHOST_EventCallbackProcPtr

Function Documentation

◆ GHOST_ActivateGPUContext()

◆ GHOST_ActivateWindowDrawingContext()

◆ GHOST_AddEventConsumer()

◆ GHOST_ApplyWindowDecorationStyle()

◆ GHOST_BeginIME()

◆ GHOST_ClientToScreen()

◆ GHOST_ClipRectangle()

◆ GHOST_CreateEventConsumer()

◆ GHOST_CreateGPUContext()

◆ GHOST_CreateSystem()

◆ GHOST_CreateSystemBackground()

◆ GHOST_CreateWindow()

◆ GHOST_DispatchEvents()

◆ GHOST_DisposeEventConsumer()

◆ GHOST_DisposeGPUContext()

◆ GHOST_DisposeRectangle()

◆ GHOST_DisposeSystem()

◆ GHOST_DisposeWindow()

◆ GHOST_EndIME()

◆ GHOST_EndProgressBar()

◆ GHOST_GetActiveGPUContext()

◆ GHOST_GetAllDisplayDimensions()

◆ GHOST_GetButtonState()

◆ GHOST_GetCapabilities()

◆ GHOST_GetClientBounds()

◆ GHOST_getClipboard()

◆ GHOST_getClipboardImage()

◆ GHOST_GetContextDefaultGPUFramebuffer()

◆ GHOST_GetCursorBitmap()

◆ GHOST_GetCursorGrabState()

◆ GHOST_GetCursorPosition()

◆ GHOST_GetCursorPreferredLogicalSize()

◆ GHOST_GetCursorShape()

◆ GHOST_GetCursorVisibility()

◆ GHOST_GetDefaultGPUFramebuffer()

◆ GHOST_GetDPIHint()

◆ GHOST_GetDrawingContext()

◆ GHOST_GetDrawingContextType()

◆ GHOST_GetEventData()

◆ GHOST_GetEventTime()

◆ GHOST_GetEventType()

◆ GHOST_GetEventWindow()

◆ GHOST_GetHeightRectangle()

◆ GHOST_GetMainDisplayDimensions()

◆ GHOST_GetMilliSeconds()

◆ GHOST_GetModifierKeyState()

◆ GHOST_GetNativePixelSize()

◆ GHOST_GetNumDisplays()

◆ GHOST_GetPixelAtCursor()

◆ GHOST_GetRectangle()

◆ GHOST_GetRectangleVisibility()

◆ GHOST_GetSwapInterval()

◆ GHOST_GetTimerProc()

◆ GHOST_GetTimerTaskUserData()

◆ GHOST_GetTitle()

◆ GHOST_GetValid()

◆ GHOST_GetWidthRectangle()

◆ GHOST_GetWindowBounds()

◆ GHOST_GetWindowDecorationStyleFlags()

◆ GHOST_GetWindowState()

◆ GHOST_GetWindowUnderCursor()

◆ GHOST_GetWindowUserData()

◆ GHOST_hasClipboardImage()

◆ GHOST_HasCursorShape()

◆ GHOST_InsetRectangle()

◆ GHOST_InstallTimer()

◆ GHOST_InvalidateWindow()

◆ GHOST_IsDialogWindow()

◆ GHOST_IsEmptyRectangle()

◆ GHOST_IsInsideRectangle()

◆ GHOST_IsValidRectangle()

◆ GHOST_ProcessEvents()

◆ GHOST_putClipboard()

◆ GHOST_putClipboardImage()