#include <GHOST_IWindow.hh>

Inherited by GHOST_Window.

Public Member Functions
virtual	~GHOST_IWindow ()

virtual bool	getValid () const =0

virtual void *	getOSWindow () const =0

virtual GHOST_TDrawingContextType	getDrawingContextType ()=0

virtual GHOST_TSuccess	setDrawingContextType (GHOST_TDrawingContextType type)=0

virtual GHOST_IContext *	getDrawingContext ()=0

virtual void	setTitle (const char *title)=0

virtual std::string	getTitle () const =0

virtual GHOST_TSuccess	setPath (const char *filepath)=0

virtual void	getWindowBounds (GHOST_Rect &bounds) const =0

virtual void	getClientBounds (GHOST_Rect &bounds) const =0

virtual GHOST_TSuccess	setClientWidth (uint32_t width)=0

virtual GHOST_TSuccess	setClientHeight (uint32_t height)=0

virtual GHOST_TSuccess	setClientSize (uint32_t width, uint32_t height)=0

virtual void	screenToClient (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const =0

virtual void	clientToScreen (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const =0

virtual void	setAcceptDragOperation (bool canAccept)=0

virtual bool	canAcceptDragOperation () const =0

virtual GHOST_TWindowState	getState () const =0

virtual GHOST_TSuccess	setState (GHOST_TWindowState state)=0

virtual GHOST_TSuccess	setModifiedState (bool isUnsavedChanges)=0

virtual bool	getModifiedState ()=0

virtual GHOST_TSuccess	setOrder (GHOST_TWindowOrder order)=0

virtual GHOST_TSuccess	swapBuffers ()=0

virtual GHOST_TSuccess	setSwapInterval (int interval)=0

virtual GHOST_TSuccess	getSwapInterval (int &intervalOut)=0

virtual GHOST_TSuccess	activateDrawingContext ()=0

virtual unsigned int	getDefaultFramebuffer ()=0

virtual GHOST_TSuccess	invalidate ()=0

virtual GHOST_TUserDataPtr	getUserData () const =0

virtual void	setUserData (const GHOST_TUserDataPtr userData)=0

virtual bool	isDialog () const =0

virtual GHOST_TSuccess	setProgressBar (float progress)=0

virtual GHOST_TSuccess	endProgressBar ()=0

virtual GHOST_TStandardCursor	getCursorShape () const =0

virtual GHOST_TSuccess	setCursorShape (GHOST_TStandardCursor cursorShape)=0

virtual GHOST_TSuccess	getCursorGrabBounds (GHOST_Rect &bounds) const =0

virtual void	getCursorGrabState (GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &axis_flag, GHOST_Rect &bounds, bool &use_software_cursor)=0

virtual bool	getCursorGrabUseSoftwareDisplay ()=0

virtual GHOST_TSuccess	hasCursorShape (GHOST_TStandardCursor cursorShape)=0

virtual GHOST_TSuccess	setCustomCursorShape (uint8_t bitmap, uint8_t mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)=0

virtual GHOST_TSuccess	getCursorBitmap (GHOST_CursorBitmapRef *bitmap)=0

virtual bool	getCursorVisibility () const =0

virtual GHOST_TSuccess	setCursorVisibility (bool visible)=0

virtual GHOST_TSuccess	setCursorGrab (GHOST_TGrabCursorMode, GHOST_TAxisFlag, GHOST_Rect *, int32_t[2])

virtual GHOST_TSuccess	beginFullScreen () const =0

virtual GHOST_TSuccess	endFullScreen () const =0

virtual float	getNativePixelSize ()=0

virtual uint16_t	getDPIHint ()=0

Detailed Description

Interface for GHOST windows.

You can create a window with the system's GHOST_ISystem::createWindow method.

See also: GHOST_ISystem::createWindow

There are two coordinate systems:

The screen coordinate system. The origin of the screen is located in the upper left corner of the screen.
The client rectangle coordinate system. The client rectangle of a window is the area that is drawable by the application (excluding title bars etc.).

Definition at line 34 of file GHOST_IWindow.hh.

Constructor & Destructor Documentation

◆ ~GHOST_IWindow()

virtual GHOST_IWindow::~GHOST_IWindow ( )

inlinevirtual

Destructor.

Definition at line 39 of file GHOST_IWindow.hh.

Member Function Documentation

◆ activateDrawingContext()

virtual GHOST_TSuccess GHOST_IWindow::activateDrawingContext ( )

pure virtual

Activates the drawing context of this window.

Returns: A boolean success indicator.

Implemented in GHOST_Window, and GHOST_WindowNULL.

Referenced by GHOST_ActivateWindowDrawingContext(), and View().

◆ beginFullScreen()

virtual GHOST_TSuccess GHOST_IWindow::beginFullScreen ( ) const

pure virtual

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_WindowManager::beginFullScreen().

◆ canAcceptDragOperation()

virtual bool GHOST_IWindow::canAcceptDragOperation ( ) const

pure virtual

Returns acceptance of the dropped object Usually called by the "object dropped" event handling function

Implemented in GHOST_Window.

◆ clientToScreen()

virtual void GHOST_IWindow::clientToScreen	(	int32_t	inX,
		int32_t	inY,
		int32_t &	outX,
		int32_t &	outY ) const

pure virtual

Converts a point in client rectangle coordinates to screen coordinates.

Parameters

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.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_ClientToScreen(), and GHOST_System::setCursorPositionClientRelative().

◆ endFullScreen()

virtual GHOST_TSuccess GHOST_IWindow::endFullScreen ( ) const

pure virtual

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_WindowManager::endFullScreen().

◆ endProgressBar()

virtual GHOST_TSuccess GHOST_IWindow::endProgressBar ( )

pure virtual

Hides the progress bar in the icon

Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_EndProgressBar().

◆ getClientBounds()

virtual void GHOST_IWindow::getClientBounds ( GHOST_Rect & bounds ) const

pure virtual

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

Parameters

bounds The bounding rectangle of the client area of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_System::getWindowUnderCursor(), GHOST_GetClientBounds(), GHOST_Window::setCursorGrab(), and View().

◆ getCursorBitmap()

virtual GHOST_TSuccess GHOST_IWindow::getCursorBitmap ( GHOST_CursorBitmapRef * bitmap )

pure virtual

Implemented in GHOST_Window, and GHOST_WindowWayland.

Referenced by GHOST_GetCursorBitmap().

◆ getCursorGrabBounds()

virtual GHOST_TSuccess GHOST_IWindow::getCursorGrabBounds ( GHOST_Rect & bounds ) const

pure virtual

Implemented in GHOST_Window.

◆ getCursorGrabState()

virtual void GHOST_IWindow::getCursorGrabState	(	GHOST_TGrabCursorMode &	mode,
		GHOST_TAxisFlag &	axis_flag,
		GHOST_Rect &	bounds,
		bool &	use_software_cursor )

pure virtual

Implemented in GHOST_Window.

Referenced by GHOST_GetCursorGrabState().

◆ getCursorGrabUseSoftwareDisplay()

virtual bool GHOST_IWindow::getCursorGrabUseSoftwareDisplay ( )

pure virtual

Implemented in GHOST_Window, and GHOST_WindowWayland.

◆ getCursorShape()

virtual GHOST_TStandardCursor GHOST_IWindow::getCursorShape ( ) const

pure virtual

Returns the current cursor shape.

Returns: The current cursor shape.

Implemented in GHOST_Window.

Referenced by GHOST_GetCursorShape().

◆ getCursorVisibility()

virtual bool GHOST_IWindow::getCursorVisibility ( ) const

pure virtual

Returns the visibility state of the cursor.

Returns: The visibility state of the cursor.

Implemented in GHOST_Window.

Referenced by GHOST_GetCursorVisibility(), and Application::processEvent().

◆ getDefaultFramebuffer()

virtual unsigned int GHOST_IWindow::getDefaultFramebuffer ( )

pure virtual

Gets the OpenGL frame-buffer associated with the window's contents.

Returns: The name of an OpenGL frame-buffer object.

Implemented in GHOST_Window.

Referenced by GHOST_GetDefaultGPUFramebuffer().

◆ getDPIHint()

virtual uint16_t GHOST_IWindow::getDPIHint ( )

pure virtual

Returns the recommended DPI for this window.

Returns: The recommended DPI for this window.

Implemented in GHOST_Window, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_GetDPIHint().

◆ getDrawingContext()

virtual GHOST_IContext * GHOST_IWindow::getDrawingContext ( )

pure virtual

Returns the drawing context used in this window.

Returns: The current drawing context.

Implemented in GHOST_Window.

Referenced by GHOST_GetDrawingContext().

◆ getDrawingContextType()

virtual GHOST_TDrawingContextType GHOST_IWindow::getDrawingContextType ( )

pure virtual

Returns the type of drawing context used in this window.

Returns: The current type of drawing context.

Implemented in GHOST_Window.

Referenced by GHOST_GetDrawingContextType().

◆ getModifiedState()

virtual bool GHOST_IWindow::getModifiedState ( )

pure virtual

Gets the window "modified" status, indicating unsaved changes

Returns: True if there are unsaved changes

Implemented in GHOST_Window.

◆ getNativePixelSize()

virtual float GHOST_IWindow::getNativePixelSize ( )

pure virtual

Implemented in GHOST_Window.

Referenced by GHOST_GetNativePixelSize().

◆ getOSWindow()

virtual void * GHOST_IWindow::getOSWindow ( ) const

pure virtual

Returns the associated OS object/handle

Returns: The associated OS object/handle

Implemented in GHOST_Window, GHOST_WindowCocoa, and GHOST_WindowWin32.

◆ getState()

virtual GHOST_TWindowState GHOST_IWindow::getState ( ) const

pure virtual

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

Returns: The state of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_System::getWindowUnderCursor(), and GHOST_GetWindowState().

◆ getSwapInterval()

virtual GHOST_TSuccess GHOST_IWindow::getSwapInterval ( int & intervalOut )

pure virtual

Gets the current swap interval for swapBuffers.

Parameters

intervalOut 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.

Implemented in GHOST_Window.

Referenced by GHOST_GetSwapInterval().

◆ getTitle()

virtual std::string GHOST_IWindow::getTitle ( ) const

pure virtual

Returns the title displayed in the title bar.

Parameters

title The title displayed in the title bar.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_GetTitle(), and Application::processEvent().

◆ getUserData()

virtual GHOST_TUserDataPtr GHOST_IWindow::getUserData ( ) const

pure virtual

Returns the window user data.

Returns: The window user data.

Implemented in GHOST_Window.

Referenced by GHOST_GetWindowUserData().

◆ getValid()

virtual bool GHOST_IWindow::getValid ( ) const

pure virtual

Returns indication as to whether the window is valid.

Returns: The validity of the window.

Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_WindowManager::beginFullScreen(), GHOST_SystemCocoa::createWindow(), and GHOST_GetValid().

◆ getWindowBounds()

virtual void GHOST_IWindow::getWindowBounds ( GHOST_Rect & bounds ) const

pure virtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters

bounds The bounding rectangle of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_GetWindowBounds().

◆ hasCursorShape()

virtual GHOST_TSuccess GHOST_IWindow::hasCursorShape ( GHOST_TStandardCursor cursorShape )

pure virtual

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

Returns: Indication of success.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, and GHOST_WindowX11.

Referenced by GHOST_HasCursorShape().

◆ invalidate()

virtual GHOST_TSuccess GHOST_IWindow::invalidate ( )

pure virtual

Invalidates the contents of this window.

Returns: Indication of success.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by gearsTimerProc(), and GHOST_InvalidateWindow().

◆ isDialog()

virtual bool GHOST_IWindow::isDialog ( ) const

pure virtual

Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_IsDialogWindow().

◆ screenToClient()

virtual void GHOST_IWindow::screenToClient	(	int32_t	inX,
		int32_t	inY,
		int32_t &	outX,
		int32_t &	outY ) const

pure virtual

Converts a point in screen coordinates to client rectangle coordinates

Parameters

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.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_System::getCursorPositionClientRelative(), and GHOST_ScreenToClient().

◆ setAcceptDragOperation()

virtual void GHOST_IWindow::setAcceptDragOperation ( bool canAccept )

pure virtual

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

Implemented in GHOST_Window.

Referenced by GHOST_setAcceptDragOperation().

◆ setClientHeight()

virtual GHOST_TSuccess GHOST_IWindow::setClientHeight ( uint32_t height )

pure virtual

Resizes client rectangle height.

Parameters

height The new height of the client area of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetClientHeight().

◆ setClientSize()

virtual GHOST_TSuccess GHOST_IWindow::setClientSize	(	uint32_t	width,
		uint32_t	height )

pure virtual

Resizes client rectangle.

Parameters

width	The new width of the client area of the window.
height	The new height of the client area of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetClientSize().

◆ setClientWidth()

virtual GHOST_TSuccess GHOST_IWindow::setClientWidth ( uint32_t width )

pure virtual

Resizes client rectangle width.

Parameters

width The new width of the client area of the window.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetClientWidth().

◆ setCursorGrab()

virtual GHOST_TSuccess GHOST_IWindow::setCursorGrab	(	GHOST_TGrabCursorMode	,
		GHOST_TAxisFlag	,
		GHOST_Rect *	,
		int32_t	[2] )

inlinevirtual

Grabs the cursor for a modal operation.

Parameters

grab	The new grab state of the cursor.

Returns: Indication of success.

Reimplemented in GHOST_Window.

Definition at line 326 of file GHOST_IWindow.hh.

References GHOST_kSuccess.

Referenced by GHOST_SetCursorGrab().

◆ setCursorShape()

virtual GHOST_TSuccess GHOST_IWindow::setCursorShape ( GHOST_TStandardCursor cursorShape )

pure virtual

Set the shape of the cursor.

Parameters

cursorShape The new cursor shape type id.

Returns: Indication of success.

Implemented in GHOST_Window.

Referenced by GHOST_SetCursorShape(), and Application::processEvent().

◆ setCursorVisibility()

virtual GHOST_TSuccess GHOST_IWindow::setCursorVisibility ( bool visible )

pure virtual

Shows or hides the cursor.

Parameters

visible The new visibility state of the cursor.

Returns: Indication of success.

Implemented in GHOST_Window.

Referenced by GHOST_SetCursorVisibility(), and Application::processEvent().

◆ setCustomCursorShape()

virtual GHOST_TSuccess GHOST_IWindow::setCustomCursorShape	(	uint8_t *	bitmap,
		uint8_t *	mask,
		int	sizex,
		int	sizey,
		int	hotX,
		int	hotY,
		bool	canInvertColor )

pure virtual

Set the shape of the cursor to a custom cursor.

Parameters

bitmap	The bitmap data for the cursor.
mask	The mask data for the cursor.
hotX	The X coordinate of the cursor hot-spot.
hotY	The Y coordinate of the cursor hot-spot.

Returns: Indication of success.

Implemented in GHOST_Window.

Referenced by GHOST_SetCustomCursorShape().

◆ setDrawingContextType()

virtual GHOST_TSuccess GHOST_IWindow::setDrawingContextType ( GHOST_TDrawingContextType type )

pure virtual

Tries to install a rendering context in this window.

Parameters

type	The type of rendering context installed.

Returns: Indication as to whether installation has succeeded.

Implemented in GHOST_Window.

Referenced by GHOST_SetDrawingContextType().

◆ setModifiedState()

virtual GHOST_TSuccess GHOST_IWindow::setModifiedState ( bool isUnsavedChanges )

pure virtual

Sets the window "modified" status, indicating unsaved changes

Parameters

isUnsavedChanges Unsaved changes or not.

Returns: Indication of success.

Implemented in GHOST_Window, and GHOST_WindowCocoa.

Referenced by GHOST_SetWindowModifiedState().

◆ setOrder()

virtual GHOST_TSuccess GHOST_IWindow::setOrder ( GHOST_TWindowOrder order )

pure virtual

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

Parameters

order The order of the window.

Returns: Indication of success.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetWindowOrder().

◆ setPath()

virtual GHOST_TSuccess GHOST_IWindow::setPath ( const char * filepath )

pure virtual

Sets the file name represented by this window.

Parameters

filepath The file directory.

Implemented in GHOST_Window, GHOST_WindowCocoa, and GHOST_WindowNULL.

Referenced by GHOST_SetPath().

◆ setProgressBar()

virtual GHOST_TSuccess GHOST_IWindow::setProgressBar ( float progress )

pure virtual

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

Parameters

progress The progress percentage (0.0 to 1.0).

Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetProgressBar().

◆ setState()

virtual GHOST_TSuccess GHOST_IWindow::setState ( GHOST_TWindowState state )

pure virtual

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

Parameters

state The state of the window.

Returns: Indication of success.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetWindowState().

◆ setSwapInterval()

virtual GHOST_TSuccess GHOST_IWindow::setSwapInterval ( int interval )

pure virtual

Sets the swap interval for swapBuffers.

Parameters

interval The swap interval to use.

Returns: A boolean success indicator.

Implemented in GHOST_Window.

Referenced by GHOST_SetSwapInterval().

◆ setTitle()

virtual void GHOST_IWindow::setTitle ( const char * title )

pure virtual

Sets the title displayed in the title bar.

Parameters

title The title to display in the title bar.

Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Referenced by GHOST_SetTitle(), and Application::processEvent().

◆ setUserData()

virtual void GHOST_IWindow::setUserData ( const GHOST_TUserDataPtr userData )

pure virtual

Changes the window user data.

Parameters

userData The window user data.

Implemented in GHOST_Window.

Referenced by GHOST_SetWindowUserData().

◆ swapBuffers()

virtual GHOST_TSuccess GHOST_IWindow::swapBuffers ( )

pure virtual

Swaps front and back buffers of a window.

Returns: A boolean success indicator.

Implemented in GHOST_Window, GHOST_WindowNULL, and GHOST_WindowWayland.

Referenced by GHOST_SwapWindowBuffers(), and Application::processEvent().

The documentation for this class was generated from the following file:

GHOST_IWindow.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~GHOST_IWindow()

Member Function Documentation

◆ activateDrawingContext()

◆ beginFullScreen()

◆ canAcceptDragOperation()

◆ clientToScreen()

◆ endFullScreen()

◆ endProgressBar()

◆ getClientBounds()

◆ getCursorBitmap()

◆ getCursorGrabBounds()

◆ getCursorGrabState()

◆ getCursorGrabUseSoftwareDisplay()

◆ getCursorShape()

◆ getCursorVisibility()

◆ getDefaultFramebuffer()

◆ getDPIHint()

◆ getDrawingContext()

◆ getDrawingContextType()

◆ getModifiedState()

◆ getNativePixelSize()

◆ getOSWindow()

◆ getState()

◆ getSwapInterval()

◆ getTitle()

◆ getUserData()

◆ getValid()

◆ getWindowBounds()

◆ hasCursorShape()

◆ invalidate()

◆ isDialog()

◆ screenToClient()

◆ setAcceptDragOperation()

◆ setClientHeight()

◆ setClientSize()

◆ setClientWidth()

◆ setCursorGrab()

◆ setCursorShape()

◆ setCursorVisibility()

◆ setCustomCursorShape()

◆ setDrawingContextType()

◆ setModifiedState()

◆ setOrder()

◆ setPath()

◆ setProgressBar()

◆ setState()

◆ setSwapInterval()

◆ setTitle()

◆ setUserData()

◆ swapBuffers()