#include <GHOST_WindowNULL.hh>

Inherits GHOST_Window.

Public Member Functions
GHOST_TSuccess	hasCursorShape (GHOST_TStandardCursor) override
	GHOST_WindowNULL (const char , int32_t, int32_t, uint32_t width, uint32_t height, GHOST_TWindowState state, const GHOST_IWindow , GHOST_TDrawingContextType, const bool stereoVisual)
Public Member Functions inherited from GHOST_Window
	GHOST_Window (uint32_t width, uint32_t height, GHOST_TWindowState state, const bool wantStereoVisual=false, const bool exclusive=false)
	~GHOST_Window () override
void *	getOSWindow () const override
virtual GHOST_TWindowDecorationStyleFlags	getWindowDecorationStyleFlags () override
virtual void	setWindowDecorationStyleFlags (GHOST_TWindowDecorationStyleFlags styleFlags) override
virtual void	setWindowDecorationStyleSettings (GHOST_WindowDecorationStyleSettings decorationSettings) override
virtual GHOST_TSuccess	applyWindowDecorationStyle () override
GHOST_TStandardCursor	getCursorShape () const override
bool	isDialog () const override
GHOST_TSuccess	setCursorShape (GHOST_TStandardCursor cursorShape) override
GHOST_TSuccess	setCustomCursorShape (uint8_t bitmap, uint8_t mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor) override
GHOST_TSuccess	getCursorBitmap (GHOST_CursorBitmapRef *bitmap) override
bool	getCursorVisibility () const override
GHOST_TGrabCursorMode	getCursorGrabMode () const
bool	getCursorGrabModeIsWarp () const
GHOST_TAxisFlag	getCursorGrabAxis () const
void	getCursorGrabInitPos (int32_t &x, int32_t &y) const
void	getCursorGrabAccum (int32_t &x, int32_t &y) const
void	setCursorGrabAccum (int32_t x, int32_t y)
GHOST_TSuccess	setCursorVisibility (bool visible) override
GHOST_TSuccess	setCursorGrab (GHOST_TGrabCursorMode mode, GHOST_TAxisFlag wrap_axis, GHOST_Rect *bounds, int32_t mouse_ungrab_xy[2]) override
GHOST_TSuccess	getCursorGrabBounds (GHOST_Rect &bounds) const override
void	getCursorGrabState (GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &wrap_axis, GHOST_Rect &bounds, bool &use_software_cursor) override
bool	getCursorGrabUseSoftwareDisplay () override
GHOST_TSuccess	setProgressBar (float) override
GHOST_TSuccess	endProgressBar () override
GHOST_TSuccess	setSwapInterval (int interval) override
GHOST_TSuccess	getSwapInterval (int &intervalOut) override
void	setAcceptDragOperation (bool canAccept) override
bool	canAcceptDragOperation () const override
GHOST_TSuccess	setModifiedState (bool isUnsavedChanges) override
bool	getModifiedState () override
GHOST_TDrawingContextType	getDrawingContextType () override
GHOST_TSuccess	setDrawingContextType (GHOST_TDrawingContextType type) override
GHOST_IContext *	getDrawingContext () override
GHOST_TSuccess	updateDrawingContext ()
GHOST_Context *	getContext ()
unsigned int	getDefaultFramebuffer () override
GHOST_TUserDataPtr	getUserData () const override
void	setUserData (const GHOST_TUserDataPtr userData) override
float	getNativePixelSize () override
uint16_t	getDPIHint () override
Public Member Functions inherited from GHOST_IWindow
virtual	~GHOST_IWindow ()=default

Protected Member Functions
GHOST_TSuccess	installDrawingContext (GHOST_TDrawingContextType)
GHOST_TSuccess	removeDrawingContext ()
GHOST_TSuccess	setWindowCursorGrab (GHOST_TGrabCursorMode) override
GHOST_TSuccess	setWindowCursorShape (GHOST_TStandardCursor) override
GHOST_TSuccess	setWindowCustomCursorShape (uint8_t , uint8_t , int, int, int, int, bool) override
bool	getValid () const override
void	setTitle (const char *) override
std::string	getTitle () const override
GHOST_TSuccess	setPath (const char *) override
void	getWindowBounds (GHOST_Rect &bounds) const override
void	getClientBounds (GHOST_Rect &) const override
GHOST_TSuccess	setClientWidth (uint32_t) override
GHOST_TSuccess	setClientHeight (uint32_t) override
GHOST_TSuccess	setClientSize (uint32_t, uint32_t) override
void	screenToClient (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override
void	clientToScreen (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override
GHOST_TSuccess	swapBuffers () override
GHOST_TSuccess	activateDrawingContext () override
	~GHOST_WindowNULL () override=default
GHOST_TSuccess	setWindowCursorVisibility (bool) override
GHOST_TSuccess	setState (GHOST_TWindowState) override
GHOST_TWindowState	getState () const override
GHOST_TSuccess	invalidate () override
GHOST_TSuccess	setOrder (GHOST_TWindowOrder) override
Protected Member Functions inherited from GHOST_Window
GHOST_TSuccess	releaseNativeHandles ()

Additional Inherited Members
Protected Attributes inherited from GHOST_Window
GHOST_TDrawingContextType	m_drawingContextType
GHOST_TUserDataPtr	m_userData
bool	m_cursorVisible
GHOST_TGrabCursorMode	m_cursorGrab
GHOST_TAxisFlag	m_cursorGrabAxis
int32_t	m_cursorGrabInitPos [2]
int32_t	m_cursorGrabAccumPos [2]
GHOST_Rect	m_cursorGrabBounds
GHOST_TStandardCursor	m_cursorShape
bool	m_progressBarVisible
bool	m_canAcceptDragOperation
bool	m_isUnsavedChanges
bool	m_fullScreen
GHOST_TWindowDecorationStyleFlags	m_windowDecorationStyleFlags
GHOST_WindowDecorationStyleSettings	m_windowDecorationStyleSettings
bool	m_wantStereoVisual
uint32_t	m_fullScreenWidth
uint32_t	m_fullScreenHeight
float	m_nativePixelSize

Detailed Description

Definition at line 18 of file GHOST_WindowNULL.hh.

Constructor & Destructor Documentation

◆ GHOST_WindowNULL()

GHOST_WindowNULL::GHOST_WindowNULL	(	const char *	,
		int32_t	,
		int32_t	,
		uint32_t	width,
		uint32_t	height,
		GHOST_TWindowState	state,
		const GHOST_IWindow *	,
		GHOST_TDrawingContextType	,
		const bool	stereoVisual )

inline

Definition at line 25 of file GHOST_WindowNULL.hh.

References false, GHOST_Window::GHOST_Window(), and state.

◆ ~GHOST_WindowNULL()

GHOST_WindowNULL::~GHOST_WindowNULL ( )

overrideprotecteddefault

Member Function Documentation

◆ activateDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::activateDrawingContext ( )

inlineoverrideprotectedvirtual

Activates the drawing context of this window.

Returns: A boolean success indicator.

Reimplemented from GHOST_Window.

Definition at line 114 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

◆ clientToScreen()

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

inlineoverrideprotectedvirtual

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.

Implements GHOST_IWindow.

Definition at line 105 of file GHOST_WindowNULL.hh.

◆ getClientBounds()

void GHOST_WindowNULL::getClientBounds ( GHOST_Rect & bounds ) const

inlineoverrideprotectedvirtual

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.

Implements GHOST_IWindow.

Definition at line 85 of file GHOST_WindowNULL.hh.

Referenced by getWindowBounds().

◆ getState()

GHOST_TWindowState GHOST_WindowNULL::getState ( ) const

inlineoverrideprotectedvirtual

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

Returns: The state of the window.

Implements GHOST_IWindow.

Definition at line 128 of file GHOST_WindowNULL.hh.

References GHOST_kWindowStateNormal.

◆ getTitle()

std::string GHOST_WindowNULL::getTitle ( ) const

inlineoverrideprotectedvirtual

Returns the title displayed in the title bar.

Parameters

title The title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 73 of file GHOST_WindowNULL.hh.

◆ getValid()

bool GHOST_WindowNULL::getValid ( ) const

inlineoverrideprotectedvirtual

Returns indication as to whether the window is valid.

Returns: The validity of the window.

Reimplemented from GHOST_Window.

Definition at line 66 of file GHOST_WindowNULL.hh.

◆ getWindowBounds()

void GHOST_WindowNULL::getWindowBounds ( GHOST_Rect & bounds ) const

inlineoverrideprotectedvirtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters

bounds The bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 81 of file GHOST_WindowNULL.hh.

References bounds(), and getClientBounds().

◆ hasCursorShape()

GHOST_TSuccess GHOST_WindowNULL::hasCursorShape ( GHOST_TStandardCursor cursorShape )

inlineoverridevirtual

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

Returns: Indication of success.

Implements GHOST_IWindow.

Definition at line 20 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ installDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::installDrawingContext ( GHOST_TDrawingContextType )

inlineprotected

Definition at line 39 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ invalidate()

GHOST_TSuccess GHOST_WindowNULL::invalidate ( )

inlineoverrideprotectedvirtual

Invalidates the contents of this window.

Returns: Indication of success.

Implements GHOST_IWindow.

Definition at line 132 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ removeDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::removeDrawingContext ( )

inlineprotected

Definition at line 43 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ screenToClient()

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

inlineoverrideprotectedvirtual

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.

Implements GHOST_IWindow.

Definition at line 100 of file GHOST_WindowNULL.hh.

◆ setClientHeight()

GHOST_TSuccess GHOST_WindowNULL::setClientHeight ( uint32_t height )

inlineoverrideprotectedvirtual

Resizes client rectangle height.

Parameters

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

Implements GHOST_IWindow.

Definition at line 92 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

◆ setClientSize()

GHOST_TSuccess GHOST_WindowNULL::setClientSize	(	uint32_t	width,
		uint32_t	height )

inlineoverrideprotectedvirtual

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.

Implements GHOST_IWindow.

Definition at line 96 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

◆ setClientWidth()

GHOST_TSuccess GHOST_WindowNULL::setClientWidth ( uint32_t width )

inlineoverrideprotectedvirtual

Resizes client rectangle width.

Parameters

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

Implements GHOST_IWindow.

Definition at line 88 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

◆ setOrder()

GHOST_TSuccess GHOST_WindowNULL::setOrder ( GHOST_TWindowOrder order )

inlineoverrideprotectedvirtual

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

Parameters

order The order of the window.

Returns: Indication of success.

Implements GHOST_IWindow.

Definition at line 136 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ setPath()

GHOST_TSuccess GHOST_WindowNULL::setPath ( const char * filepath )

inlineoverrideprotectedvirtual

Sets the file name represented by this window.

Parameters

filepath The file directory.

Reimplemented from GHOST_Window.

Definition at line 77 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

◆ setState()

GHOST_TSuccess GHOST_WindowNULL::setState ( GHOST_TWindowState state )

inlineoverrideprotectedvirtual

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

Parameters

state The state of the window.

Returns: Indication of success.

Implements GHOST_IWindow.

Definition at line 124 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ setTitle()

void GHOST_WindowNULL::setTitle ( const char * title )

inlineoverrideprotectedvirtual

Sets the title displayed in the title bar.

Parameters

title The title to display in the title bar.

Implements GHOST_IWindow.

Definition at line 70 of file GHOST_WindowNULL.hh.

◆ setWindowCursorGrab()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorGrab ( GHOST_TGrabCursorMode )

inlineoverrideprotectedvirtual

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

Reimplemented from GHOST_Window.

Definition at line 47 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ setWindowCursorShape()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorShape ( GHOST_TStandardCursor shape )

inlineoverrideprotectedvirtual

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

Implements GHOST_Window.

Definition at line 51 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ setWindowCursorVisibility()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorVisibility ( bool visible )

inlineoverrideprotectedvirtual

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

Implements GHOST_Window.

Definition at line 120 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ setWindowCustomCursorShape()

GHOST_TSuccess GHOST_WindowNULL::setWindowCustomCursorShape	(	uint8_t *	bitmap,
		uint8_t *	mask,
		int	szx,
		int	szy,
		int	hotX,
		int	hotY,
		bool	canInvertColor )

inlineoverrideprotectedvirtual

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

Implements GHOST_Window.

Definition at line 55 of file GHOST_WindowNULL.hh.

References GHOST_kSuccess.

◆ swapBuffers()

GHOST_TSuccess GHOST_WindowNULL::swapBuffers ( )

inlineoverrideprotectedvirtual

Swaps front and back buffers of a window.

Returns: A boolean success indicator.

Reimplemented from GHOST_Window.

Definition at line 110 of file GHOST_WindowNULL.hh.

References GHOST_kFailure.

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

GHOST_WindowNULL.hh

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_WindowNULL()

◆ ~GHOST_WindowNULL()

Member Function Documentation

◆ activateDrawingContext()

◆ clientToScreen()

◆ getClientBounds()

◆ getState()

◆ getTitle()

◆ getValid()

◆ getWindowBounds()

◆ hasCursorShape()

◆ installDrawingContext()

◆ invalidate()

◆ removeDrawingContext()

◆ screenToClient()

◆ setClientHeight()

◆ setClientSize()

◆ setClientWidth()

◆ setOrder()

◆ setPath()

◆ setState()

◆ setTitle()

◆ setWindowCursorGrab()

◆ setWindowCursorShape()

◆ setWindowCursorVisibility()

◆ setWindowCustomCursorShape()

◆ swapBuffers()