GHOST_Window Class Reference

#include <GHOST_Window.h>

Inherits GHOST_IWindow.

Inherited by GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.

Public Member Functions
	GHOST_Window (GHOST_TUns32 width, GHOST_TUns32 height, GHOST_TWindowState state, const bool wantStereoVisual=false, const bool exclusive=false)
virtual	~GHOST_Window ()
virtual bool	getValid () const
virtual void *	getOSWindow () const
GHOST_TStandardCursor	getCursorShape () const
bool	isDialog () const
GHOST_TSuccess	setCursorShape (GHOST_TStandardCursor cursorShape)
GHOST_TSuccess	setCustomCursorShape (GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
bool	getCursorVisibility () const
GHOST_TGrabCursorMode	getCursorGrabMode () const
bool	getCursorGrabModeIsWarp () const
GHOST_TAxisFlag	getCursorGrabAxis () const
void	getCursorGrabInitPos (GHOST_TInt32 &x, GHOST_TInt32 &y) const
void	getCursorGrabAccum (GHOST_TInt32 &x, GHOST_TInt32 &y) const
void	setCursorGrabAccum (GHOST_TInt32 x, GHOST_TInt32 y)
GHOST_TSuccess	setCursorVisibility (bool visible)
GHOST_TSuccess	setCursorGrab (GHOST_TGrabCursorMode mode, GHOST_TAxisFlag wrap_axis, GHOST_Rect *bounds, GHOST_TInt32 mouse_ungrab_xy[2])
GHOST_TSuccess	getCursorGrabBounds (GHOST_Rect &bounds)
virtual GHOST_TSuccess	setProgressBar (float)
virtual GHOST_TSuccess	endProgressBar ()
GHOST_TSuccess	setSwapInterval (int interval)
GHOST_TSuccess	getSwapInterval (int &intervalOut)
void	setAcceptDragOperation (bool canAccept)
bool	canAcceptDragOperation () const
virtual GHOST_TSuccess	setModifiedState (bool isUnsavedChanges)
virtual bool	getModifiedState ()
GHOST_TDrawingContextType	getDrawingContextType ()
GHOST_TSuccess	setDrawingContextType (GHOST_TDrawingContextType type)
virtual GHOST_TSuccess	swapBuffers ()
virtual GHOST_TSuccess	activateDrawingContext ()
GHOST_TSuccess	updateDrawingContext ()
virtual unsigned int	getDefaultFramebuffer ()
GHOST_TUserDataPtr	getUserData () const
void	setUserData (const GHOST_TUserDataPtr userData)
float	getNativePixelSize (void)
virtual GHOST_TUns16	getDPIHint ()
Public Member Functions inherited from GHOST_IWindow
virtual	~GHOST_IWindow ()
virtual void	setTitle (const char *title)=0
virtual std::string	getTitle () const =0
virtual void	getWindowBounds (GHOST_Rect &bounds) const =0
virtual void	getClientBounds (GHOST_Rect &bounds) const =0
virtual GHOST_TSuccess	setClientWidth (GHOST_TUns32 width)=0
virtual GHOST_TSuccess	setClientHeight (GHOST_TUns32 height)=0
virtual GHOST_TSuccess	setClientSize (GHOST_TUns32 width, GHOST_TUns32 height)=0
virtual void	screenToClient (GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32 &outX, GHOST_TInt32 &outY) const =0
virtual void	clientToScreen (GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32 &outX, GHOST_TInt32 &outY) const =0
virtual GHOST_TWindowState	getState () const =0
virtual GHOST_TSuccess	setState (GHOST_TWindowState state)=0
virtual GHOST_TSuccess	setOrder (GHOST_TWindowOrder order)=0
virtual GHOST_TSuccess	invalidate ()=0
virtual GHOST_TSuccess	hasCursorShape (GHOST_TStandardCursor cursorShape)=0
virtual GHOST_TSuccess	beginFullScreen () const =0
virtual GHOST_TSuccess	endFullScreen () const =0

Protected Member Functions
virtual GHOST_Context *	newDrawingContext (GHOST_TDrawingContextType type)=0
virtual GHOST_TSuccess	setWindowCursorVisibility (bool visible)=0
virtual GHOST_TSuccess	setWindowCursorGrab (GHOST_TGrabCursorMode)
virtual GHOST_TSuccess	setWindowCursorShape (GHOST_TStandardCursor shape)=0
virtual GHOST_TSuccess	setWindowCustomCursorShape (GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, int szx, int szy, int hotX, int hotY, bool canInvertColor)=0
GHOST_TSuccess	releaseNativeHandles ()

Protected Attributes
GHOST_TDrawingContextType	m_drawingContextType
GHOST_TUserDataPtr	m_userData
bool	m_cursorVisible
GHOST_TGrabCursorMode	m_cursorGrab
GHOST_TAxisFlag	m_cursorGrabAxis
GHOST_TInt32	m_cursorGrabInitPos [2]
GHOST_TInt32	m_cursorGrabAccumPos [2]
GHOST_Rect	m_cursorGrabBounds
GHOST_TStandardCursor	m_cursorShape
bool	m_progressBarVisible
bool	m_canAcceptDragOperation
bool	m_isUnsavedChanges
bool	m_fullScreen
bool	m_wantStereoVisual
GHOST_TUns32	m_fullScreenWidth
GHOST_TUns32	m_fullScreenHeight
float	m_nativePixelSize

Detailed Description

Platform independent implementation of GHOST_IWindow. Dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. Implements part of the GHOST_IWindow interface and adds some methods to be implemented by sub-classes of this class.

Definition at line 38 of file GHOST_Window.h.

Constructor & Destructor Documentation

GHOST_Window()

GHOST_Window::GHOST_Window	(	GHOST_TUns32	width,
		GHOST_TUns32	height,
		GHOST_TWindowState	state,
		const bool	wantStereoVisual = false,
		const bool	exclusive = false
	)

Constructor. Creates a new window and opens it. To check if the window was created properly, use the getValid() method.

Parameters

width	The width the window.
heigh	The height the window.
state	The state the window is initially opened with.
type	The type of drawing context installed in this window.
stereoVisual	Stereo visual for quad buffered stereo.
exclusive	Use to show the window ontop and ignore others (used full-screen).

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 34 of file GHOST_Window.cpp.

References GHOST_kWindowStateFullScreen, height, m_canAcceptDragOperation, m_cursorGrabAccumPos, m_fullScreen, m_fullScreenHeight, m_fullScreenWidth, m_isUnsavedChanges, m_nativePixelSize, m_progressBarVisible, state, and width.

~GHOST_Window()

GHOST_Window::~GHOST_Window ( )

virtual

Inherited from GHOST_ISystem

implementation. virtual bool getValid() const = 0; virtual void setTitle(const char * title) = 0; virtual std::string getTitle() const = 0; virtual void getWindowBounds(GHOST_Rect& bounds) const = 0; virtual void getClientBounds(GHOST_Rect& bounds) const = 0; virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0; virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0; virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0; virtual void screenToClient( GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0; virtual void clientToScreen( GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0; virtual GHOST_TWindowState getState() const = 0; virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0; virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0; virtual GHOST_TSuccess swapBuffers() = 0; virtual GHOST_TSuccess setSwapInterval() = 0; virtual GHOST_TSuccess getSwapInterval(int& intervalOut) = 0; virtual GHOST_TSuccess activateDrawingContext() = 0; virtual GHOST_TSuccess invalidate() = 0; Destructor. Closes the window and disposes resources allocated.

Definition at line 63 of file GHOST_Window.cpp.

Member Function Documentation

activateDrawingContext()

GHOST_TSuccess GHOST_Window::activateDrawingContext ( )

virtual

Activates the drawing context of this window.

Returns

A boolean success indicator.

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowNULL.

Definition at line 117 of file GHOST_Window.cpp.

References GHOST_Context::activateDrawingContext().

Referenced by GHOST_WindowCocoa::GHOST_WindowCocoa().

canAcceptDragOperation()

bool GHOST_Window::canAcceptDragOperation ( ) const

virtual

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

Implements GHOST_IWindow.

Definition at line 217 of file GHOST_Window.cpp.

References m_canAcceptDragOperation.

Referenced by GHOST_DropTargetWin32::DragOver(), and GHOST_DropTargetWin32::Drop().

endProgressBar()

virtual GHOST_TSuccess GHOST_Window::endProgressBar ( )

inlinevirtual

Hides the progress bar in the icon

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowX11, GHOST_WindowWin32, and GHOST_WindowCocoa.

Definition at line 184 of file GHOST_Window.h.

References GHOST_kFailure.

getCursorGrabAccum()

void GHOST_Window::getCursorGrabAccum ( GHOST_TInt32 &  x, GHOST_TInt32 &  y  ) const

inline

Definition at line 441 of file GHOST_Window.h.

References m_cursorGrabAccumPos, x, and y.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), and GHOST_SystemWin32::processCursorEvent().

getCursorGrabAxis()

GHOST_TAxisFlag GHOST_Window::getCursorGrabAxis ( ) const

inline

Definition at line 430 of file GHOST_Window.h.

References m_cursorGrabAxis.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), and GHOST_SystemWin32::processCursorEvent().

getCursorGrabBounds()

GHOST_TSuccess GHOST_Window::getCursorGrabBounds

(

GHOST_Rect &

bounds

)

Gets the cursor grab region, if unset the window is used. reset when grab is disabled.

Definition at line 178 of file GHOST_Window.cpp.

References bounds(), GHOST_kFailure, GHOST_kSuccess, and m_cursorGrabBounds.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), and GHOST_SystemWin32::processCursorEvent().

getCursorGrabInitPos()

void GHOST_Window::getCursorGrabInitPos ( GHOST_TInt32 &  x, GHOST_TInt32 &  y  ) const

inline

Definition at line 435 of file GHOST_Window.h.

References m_cursorGrabInitPos, x, and y.

Referenced by GHOST_SystemCocoa::handleMouseEvent().

getCursorGrabMode()

GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode ( ) const

inline

Definition at line 420 of file GHOST_Window.h.

References m_cursorGrab.

Referenced by GHOST_SystemCocoa::handleMouseEvent().

getCursorGrabModeIsWarp()

bool GHOST_Window::getCursorGrabModeIsWarp ( ) const

inline

Definition at line 425 of file GHOST_Window.h.

References GHOST_kGrabHide, GHOST_kGrabWrap, and m_cursorGrab.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), GHOST_SystemCocoa::handleOpenDocumentRequest(), GHOST_SystemCocoa::handleQuitRequest(), and GHOST_SystemWin32::processCursorEvent().

getCursorShape()

GHOST_TStandardCursor GHOST_Window::getCursorShape ( ) const

inlinevirtual

Returns the current cursor shape.

Returns

The current cursor shape.

Implements GHOST_IWindow.

Definition at line 453 of file GHOST_Window.h.

References m_cursorShape.

Referenced by GHOST_SystemCocoa::handleWindowEvent(), GHOST_SystemWin32::s_wndProc(), GHOST_WindowCocoa::setWindowCursorVisibility(), and GHOST_WindowX11::setWindowCursorVisibility().

getCursorVisibility()

bool GHOST_Window::getCursorVisibility ( ) const

inlinevirtual

Returns the visibility state of the cursor.

Returns

The visibility state of the cursor.

Implements GHOST_IWindow.

Definition at line 415 of file GHOST_Window.h.

References m_cursorVisible.

Referenced by GHOST_SystemCocoa::handleWindowEvent(), GHOST_SystemWin32::s_wndProc(), GHOST_WindowCocoa::setWindowCursorShape(), and GHOST_WindowCocoa::setWindowCustomCursorShape().

getDefaultFramebuffer()

unsigned int GHOST_Window::getDefaultFramebuffer ( )

virtual

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

Returns

The ID of an OpenGL frame-buffer object.

Implements GHOST_IWindow.

Definition at line 112 of file GHOST_Window.cpp.

References GHOST_Context::getDefaultFramebuffer().

getDPIHint()

virtual GHOST_TUns16 GHOST_Window::getDPIHint ( )

inlinevirtual

Returns the recommended DPI for this window.

Returns

The recommended DPI for this window.

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowWin32, GHOST_WindowX11, and GHOST_WindowSDL.

Definition at line 295 of file GHOST_Window.h.

getDrawingContextType()

GHOST_TDrawingContextType GHOST_Window::getDrawingContextType ( )

inlinevirtual

Returns the type of drawing context used in this window.

Returns

The current type of drawing context.

Implements GHOST_IWindow.

Definition at line 410 of file GHOST_Window.h.

References m_drawingContextType.

getModifiedState()

bool GHOST_Window::getModifiedState ( )

virtual

Gets the window "modified" status, indicating unsaved changes

Returns

True if there are unsaved changes

Implements GHOST_IWindow.

Definition at line 229 of file GHOST_Window.cpp.

References m_isUnsavedChanges.

getNativePixelSize()

float GHOST_Window::getNativePixelSize ( void  )

inlinevirtual

Implements GHOST_IWindow.

Definition at line 284 of file GHOST_Window.h.

References m_nativePixelSize.

getOSWindow()

void * GHOST_Window::getOSWindow ( ) const

virtual

Returns the associated OS object/handle

Returns

The associated OS object/handle

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowCocoa.

Definition at line 68 of file GHOST_Window.cpp.

References NULL.

getSwapInterval()

GHOST_TSuccess GHOST_Window::getSwapInterval ( int &  intervalOut )

virtual

Gets the current swap interval for swapBuffers.

Returns

An integer.

Implements GHOST_IWindow.

Definition at line 107 of file GHOST_Window.cpp.

References GHOST_Context::getSwapInterval().

getUserData()

GHOST_TUserDataPtr GHOST_Window::getUserData ( ) const

inlinevirtual

Returns the window user data.

Returns

The window user data.

Implements GHOST_IWindow.

Definition at line 270 of file GHOST_Window.h.

References m_userData.

getValid()

virtual bool GHOST_Window::getValid ( ) const

inlinevirtual

Returns indication as to whether the window is valid.

Returns

The validity of the window.

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.

Definition at line 92 of file GHOST_Window.h.

References NULL.

Referenced by GHOST_SystemWayland::createWindow(), GHOST_WindowCocoa::getValid(), GHOST_WindowSDL::getValid(), GHOST_WindowWin32::getValid(), and GHOST_WindowX11::getValid().

isDialog()

bool GHOST_Window::isDialog ( ) const

inlinevirtual

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, and GHOST_WindowCocoa.

Definition at line 109 of file GHOST_Window.h.

newDrawingContext()

virtual GHOST_Context* GHOST_Window::newDrawingContext ( GHOST_TDrawingContextType  type )

protectedpure 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_WindowX11, GHOST_WindowSDL, and GHOST_WindowCocoa.

Referenced by setDrawingContextType().

releaseNativeHandles()

GHOST_TSuccess GHOST_Window::releaseNativeHandles ( )

protected

Definition at line 127 of file GHOST_Window.cpp.

References GHOST_Context::releaseNativeHandles().

Referenced by GHOST_WindowCocoa::~GHOST_WindowCocoa(), GHOST_WindowSDL::~GHOST_WindowSDL(), GHOST_WindowWayland::~GHOST_WindowWayland(), GHOST_WindowWin32::~GHOST_WindowWin32(), and GHOST_WindowX11::~GHOST_WindowX11().

setAcceptDragOperation()

void GHOST_Window::setAcceptDragOperation ( bool  canAccept )

virtual

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

Implements GHOST_IWindow.

Definition at line 212 of file GHOST_Window.cpp.

References m_canAcceptDragOperation.

Referenced by GHOST_DropTargetWin32::DragEnter().

setCursorGrab()

GHOST_TSuccess GHOST_Window::setCursorGrab ( GHOST_TGrabCursorMode  mode, GHOST_TAxisFlag  wrap_axis, GHOST_Rect *  bounds, GHOST_TInt32  mouse_ungrab_xy[2]  )

virtual

Sets the cursor grab.

Parameters

mode	The new grab state of the cursor.

Returns

Indication of success.

Reimplemented from GHOST_IWindow.

Definition at line 143 of file GHOST_Window.cpp.

References bounds(), GHOST_IWindow::getClientBounds(), GHOST_kFailure, GHOST_kGrabDisable, GHOST_kSuccess, m_cursorGrab, m_cursorGrabAxis, m_cursorGrabBounds, m_cursorGrabInitPos, GHOST_Rect::m_l, GHOST_Rect::m_r, and setWindowCursorGrab().

setCursorGrabAccum()

void GHOST_Window::setCursorGrabAccum ( GHOST_TInt32  x, GHOST_TInt32  y  )

inline

Definition at line 447 of file GHOST_Window.h.

References m_cursorGrabAccumPos, x, and y.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), GHOST_SystemWin32::processCursorEvent(), GHOST_WindowCocoa::setWindowCursorGrab(), and GHOST_WindowX11::setWindowCursorGrab().

setCursorShape()

GHOST_TSuccess GHOST_Window::setCursorShape ( GHOST_TStandardCursor  cursorShape )

virtual

Set the shape of the cursor.

Parameters

cursorShape

The new cursor shape type id.

Returns

Indication of success.

Implements GHOST_IWindow.

Definition at line 184 of file GHOST_Window.cpp.

References GHOST_kFailure, GHOST_kSuccess, m_cursorShape, and setWindowCursorShape().

setCursorVisibility()

GHOST_TSuccess GHOST_Window::setCursorVisibility ( bool  visible )

virtual

Shows or hides the cursor.

Parameters

visible

The new visibility state of the cursor.

Returns

Indication of success.

Implements GHOST_IWindow.

Definition at line 132 of file GHOST_Window.cpp.

References GHOST_kFailure, GHOST_kSuccess, m_cursorVisible, and setWindowCursorVisibility().

setCustomCursorShape()

GHOST_TSuccess GHOST_Window::setCustomCursorShape ( GHOST_TUns8 *  bitmap, GHOST_TUns8 *  mask, int  sizex, int  sizey, int  hotX, int  hotY, bool  canInvertColor  )

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.

Implements GHOST_IWindow.

Definition at line 195 of file GHOST_Window.cpp.

References GHOST_kFailure, GHOST_kStandardCursorCustom, GHOST_kSuccess, m_cursorShape, mask(), and setWindowCustomCursorShape().

setDrawingContextType()

GHOST_TSuccess GHOST_Window::setDrawingContextType ( GHOST_TDrawingContextType  type )

virtual

Tries to install a rendering context in this window. Child classes do not need to overload this method, They should overload newDrawingContext instead.

Parameters

type	The type of rendering context installed.

Returns

Indication as to whether installation has succeeded.

Implements GHOST_IWindow.

Definition at line 73 of file GHOST_Window.cpp.

References GHOST_kDrawingContextTypeNone, GHOST_kFailure, GHOST_kSuccess, m_drawingContextType, m_wantStereoVisual, newDrawingContext(), NULL, and type.

Referenced by GHOST_WindowCocoa::GHOST_WindowCocoa(), GHOST_WindowSDL::GHOST_WindowSDL(), GHOST_WindowWayland::GHOST_WindowWayland(), GHOST_WindowWin32::GHOST_WindowWin32(), and GHOST_WindowX11::GHOST_WindowX11().

setModifiedState()

GHOST_TSuccess GHOST_Window::setModifiedState ( bool  isUnsavedChanges )

virtual

Sets the window "modified" status, indicating unsaved changes

Parameters

isUnsavedChanges

Unsaved changes or not.

Returns

Indication of success.

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowCocoa.

Definition at line 222 of file GHOST_Window.cpp.

References GHOST_kSuccess, and m_isUnsavedChanges.

Referenced by GHOST_WindowCocoa::setModifiedState().

setProgressBar()

virtual GHOST_TSuccess GHOST_Window::setProgressBar ( float  )

inlinevirtual

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

Parameters

progress

The progress percentage (0.0 to 1.0).

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowX11, GHOST_WindowWin32, and GHOST_WindowCocoa.

Definition at line 176 of file GHOST_Window.h.

References GHOST_kFailure.

setSwapInterval()

GHOST_TSuccess GHOST_Window::setSwapInterval ( int  interval )

virtual

Sets the swap interval for swapBuffers.

Parameters

interval

The swap interval to use.

Returns

A boolean success indicator.

Implements GHOST_IWindow.

Definition at line 102 of file GHOST_Window.cpp.

References GHOST_Context::setSwapInterval().

setUserData()

void GHOST_Window::setUserData ( const GHOST_TUserDataPtr  userData )

inlinevirtual

Changes the window user data.

Parameters

userData

The window user data.

Implements GHOST_IWindow.

Definition at line 279 of file GHOST_Window.h.

References m_userData.

setWindowCursorGrab()

virtual GHOST_TSuccess GHOST_Window::setWindowCursorGrab ( GHOST_TGrabCursorMode  )

inlineprotectedvirtual

Sets the cursor grab on the window using native window system calls.

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

Definition at line 331 of file GHOST_Window.h.

References GHOST_kSuccess.

Referenced by setCursorGrab().

setWindowCursorShape()

virtual GHOST_TSuccess GHOST_Window::setWindowCursorShape ( GHOST_TStandardCursor  shape )

protectedpure virtual

Sets the cursor shape on the window using native window system calls.

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

Referenced by setCursorShape().

setWindowCursorVisibility()

virtual GHOST_TSuccess GHOST_Window::setWindowCursorVisibility ( bool  visible )

protectedpure virtual

Sets the cursor visibility on the window using native window system calls.

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

Referenced by setCursorVisibility().

setWindowCustomCursorShape()

virtual GHOST_TSuccess GHOST_Window::setWindowCustomCursorShape ( GHOST_TUns8 *  bitmap, GHOST_TUns8 *  mask, int  szx, int  szy, int  hotX, int  hotY, bool  canInvertColor  )

protectedpure virtual

Sets the cursor shape on the window using native window system calls.

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

Referenced by setCustomCursorShape().

swapBuffers()

GHOST_TSuccess GHOST_Window::swapBuffers ( )

virtual

Swaps front and back buffers of a window.

Returns

A boolean success indicator.

Implements GHOST_IWindow.

Reimplemented in GHOST_WindowNULL.

Definition at line 97 of file GHOST_Window.cpp.

References GHOST_Context::swapBuffers().

updateDrawingContext()

GHOST_TSuccess GHOST_Window::updateDrawingContext

(

)

Updates the drawing context of this window. Needed whenever the window is changed.

Returns

Indication of success.

Definition at line 122 of file GHOST_Window.cpp.

References GHOST_Context::updateDrawingContext().

Referenced by GHOST_WindowCocoa::GHOST_WindowCocoa(), and GHOST_SystemCocoa::handleWindowEvent().

Member Data Documentation

m_canAcceptDragOperation

bool GHOST_Window::m_canAcceptDragOperation

protected

The acceptance of the "drop candidate" of the current drag'n'drop operation

Definition at line 387 of file GHOST_Window.h.

Referenced by canAcceptDragOperation(), GHOST_Window(), and setAcceptDragOperation().

m_cursorGrab

GHOST_TGrabCursorMode GHOST_Window::m_cursorGrab

protected

The current grabbed state of the cursor

Definition at line 366 of file GHOST_Window.h.

Referenced by getCursorGrabMode(), getCursorGrabModeIsWarp(), setCursorGrab(), GHOST_WindowCocoa::setWindowCursorGrab(), and GHOST_WindowX11::setWindowCursorGrab().

m_cursorGrabAccumPos

GHOST_TInt32 GHOST_Window::m_cursorGrabAccumPos[2]

protected

Accumulated offset from m_cursorGrabInitPos.

Definition at line 375 of file GHOST_Window.h.

Referenced by getCursorGrabAccum(), GHOST_Window(), and setCursorGrabAccum().

m_cursorGrabAxis

GHOST_TAxisFlag GHOST_Window::m_cursorGrabAxis

protected

Grab cursor axis.

Definition at line 369 of file GHOST_Window.h.

Referenced by getCursorGrabAxis(), and setCursorGrab().

m_cursorGrabBounds

GHOST_Rect GHOST_Window::m_cursorGrabBounds

protected

Wrap the cursor within this region.

Definition at line 378 of file GHOST_Window.h.

Referenced by getCursorGrabBounds(), setCursorGrab(), GHOST_WindowCocoa::setWindowCursorGrab(), and GHOST_WindowX11::setWindowCursorGrab().

m_cursorGrabInitPos

GHOST_TInt32 GHOST_Window::m_cursorGrabInitPos[2]

protected

Initial grab location.

Definition at line 372 of file GHOST_Window.h.

Referenced by getCursorGrabInitPos(), setCursorGrab(), GHOST_WindowCocoa::setWindowCursorGrab(), and GHOST_WindowX11::setWindowCursorGrab().

m_cursorShape

GHOST_TStandardCursor GHOST_Window::m_cursorShape

protected

The current shape of the cursor

Definition at line 381 of file GHOST_Window.h.

Referenced by getCursorShape(), setCursorShape(), setCustomCursorShape(), and GHOST_WindowWayland::setWindowCursorShape().

m_cursorVisible

bool GHOST_Window::m_cursorVisible

protected

The current visibility of the cursor

Definition at line 363 of file GHOST_Window.h.

Referenced by getCursorVisibility(), and setCursorVisibility().

m_drawingContextType

GHOST_TDrawingContextType GHOST_Window::m_drawingContextType

protected

The drawing context installed in this window.

Definition at line 357 of file GHOST_Window.h.

Referenced by getDrawingContextType(), and setDrawingContextType().

m_fullScreen

bool GHOST_Window::m_fullScreen

protected

Stores whether this is a full screen window.

Definition at line 393 of file GHOST_Window.h.

Referenced by GHOST_Window(), and GHOST_WindowCocoa::GHOST_WindowCocoa().

m_fullScreenHeight

GHOST_TUns32 GHOST_Window::m_fullScreenHeight

protected

Full-screen height

Definition at line 401 of file GHOST_Window.h.

Referenced by GHOST_Window().

m_fullScreenWidth

GHOST_TUns32 GHOST_Window::m_fullScreenWidth

protected

Full-screen width

Definition at line 399 of file GHOST_Window.h.

Referenced by GHOST_Window().

m_isUnsavedChanges

bool GHOST_Window::m_isUnsavedChanges

protected

Modified state : are there unsaved changes

Definition at line 390 of file GHOST_Window.h.

Referenced by getModifiedState(), GHOST_Window(), and setModifiedState().

m_nativePixelSize

float GHOST_Window::m_nativePixelSize

protected

Definition at line 404 of file GHOST_Window.h.

Referenced by getNativePixelSize(), GHOST_Window(), and GHOST_WindowCocoa::setNativePixelSize().

m_progressBarVisible

bool GHOST_Window::m_progressBarVisible

protected

The presence of progress indicator with the application icon

Definition at line 384 of file GHOST_Window.h.

Referenced by GHOST_WindowCocoa::endProgressBar(), GHOST_Window(), and GHOST_WindowCocoa::setProgressBar().

m_userData

GHOST_TUserDataPtr GHOST_Window::m_userData

protected

The window user data

Definition at line 360 of file GHOST_Window.h.

Referenced by getUserData(), and setUserData().

m_wantStereoVisual

bool GHOST_Window::m_wantStereoVisual

protected

Whether to attempt to initialize a context with a stereo frame-buffer.

Definition at line 396 of file GHOST_Window.h.

Referenced by GHOST_WindowCocoa::newDrawingContext(), GHOST_WindowSDL::newDrawingContext(), GHOST_WindowX11::newDrawingContext(), and setDrawingContextType().

---

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

• GHOST_Window.h
• GHOST_Window.cpp