Blender  V3.3
Public Member Functions | Protected Member Functions | List of all members
GHOST_WindowNULL Class Reference

#include <GHOST_WindowNULL.h>

Inheritance diagram for GHOST_WindowNULL:
GHOST_Window GHOST_IWindow

Public Member Functions

GHOST_TSuccess hasCursorShape (GHOST_TStandardCursor)
 
 GHOST_WindowNULL (GHOST_SystemNULL *system, const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, const GHOST_IWindow *parentWindow, GHOST_TDrawingContextType type, 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)
 
virtual ~GHOST_Window ()
 
virtual voidgetOSWindow () const
 
GHOST_TStandardCursor getCursorShape () const
 
bool isDialog () const
 
GHOST_TSuccess setCursorShape (GHOST_TStandardCursor cursorShape)
 
GHOST_TSuccess setCustomCursorShape (uint8_t *bitmap, uint8_t *mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
 
GHOST_TSuccess getCursorBitmap (GHOST_CursorBitmapRef *bitmap)
 
bool getCursorVisibility () const
 
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)
 
GHOST_TSuccess setCursorGrab (GHOST_TGrabCursorMode mode, GHOST_TAxisFlag wrap_axis, GHOST_Rect *bounds, int32_t mouse_ungrab_xy[2])
 
GHOST_TSuccess getCursorGrabBounds (GHOST_Rect &bounds)
 
void getCursorGrabState (GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &axis_flag, GHOST_Rect &bounds, bool &use_software_cursor)
 
bool getCursorGrabUseSoftwareDisplay ()
 
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)
 
GHOST_TSuccess updateDrawingContext ()
 
virtual unsigned int getDefaultFramebuffer ()
 
GHOST_TUserDataPtr getUserData () const
 
void setUserData (const GHOST_TUserDataPtr userData)
 
float getNativePixelSize (void)
 
virtual uint16_t getDPIHint ()
 
- Public Member Functions inherited from GHOST_IWindow
virtual ~GHOST_IWindow ()
 

Protected Member Functions

GHOST_TSuccess installDrawingContext (GHOST_TDrawingContextType type)
 
GHOST_TSuccess removeDrawingContext ()
 
GHOST_TSuccess setWindowCursorGrab (GHOST_TGrabCursorMode mode)
 
GHOST_TSuccess setWindowCursorShape (GHOST_TStandardCursor shape)
 
GHOST_TSuccess setWindowCustomCursorShape (uint8_t *bitmap, uint8_t *mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
 
bool getValid () const
 
void setTitle (const char *title)
 
std::string getTitle () const
 
void getWindowBounds (GHOST_Rect &bounds) const
 
void getClientBounds (GHOST_Rect &bounds) const
 
GHOST_TSuccess setClientWidth (uint32_t width)
 
GHOST_TSuccess setClientHeight (uint32_t height)
 
GHOST_TSuccess setClientSize (uint32_t width, uint32_t height)
 
void screenToClient (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const
 
void clientToScreen (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const
 
GHOST_TSuccess swapBuffers ()
 
GHOST_TSuccess activateDrawingContext ()
 
 ~GHOST_WindowNULL ()
 
GHOST_TSuccess setWindowCursorVisibility (bool visible)
 
GHOST_TSuccess setState (GHOST_TWindowState state)
 
GHOST_TWindowState getState () const
 
GHOST_TSuccess invalidate ()
 
GHOST_TSuccess setOrder (GHOST_TWindowOrder order)
 
GHOST_TSuccess beginFullScreen () const
 
GHOST_TSuccess endFullScreen () const
 
- 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
 
bool m_wantStereoVisual
 
uint32_t m_fullScreenWidth
 
uint32_t m_fullScreenHeight
 
float m_nativePixelSize
 

Detailed Description

Definition at line 16 of file GHOST_WindowNULL.h.

Constructor & Destructor Documentation

◆ GHOST_WindowNULL()

GHOST_WindowNULL::GHOST_WindowNULL ( GHOST_SystemNULL system,
const char *  title,
int32_t  left,
int32_t  top,
uint32_t  width,
uint32_t  height,
GHOST_TWindowState  state,
const GHOST_IWindow parentWindow,
GHOST_TDrawingContextType  type,
const bool  stereoVisual 
)
inline

Definition at line 23 of file GHOST_WindowNULL.h.

References setTitle().

◆ ~GHOST_WindowNULL()

GHOST_WindowNULL::~GHOST_WindowNULL ( )
inlineprotected

Definition at line 114 of file GHOST_WindowNULL.h.

Member Function Documentation

◆ activateDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::activateDrawingContext ( )
inlineprotectedvirtual

Activates the drawing context of this window.

Returns
A boolean success indicator.

Reimplemented from GHOST_Window.

Definition at line 110 of file GHOST_WindowNULL.h.

References GHOST_kFailure.

◆ beginFullScreen()

GHOST_TSuccess GHOST_WindowNULL::beginFullScreen ( ) const
inlineprotectedvirtual

Implements GHOST_IWindow.

Definition at line 138 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ clientToScreen()

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

Converts a point in client rectangle coordinates to screen coordinates.

Parameters
inXThe x-coordinate in the client rectangle.
inYThe y-coordinate in the client rectangle.
outXThe x-coordinate on the screen.
outYThe y-coordinate on the screen.

Implements GHOST_IWindow.

Definition at line 101 of file GHOST_WindowNULL.h.

◆ endFullScreen()

GHOST_TSuccess GHOST_WindowNULL::endFullScreen ( void  ) const
inlineprotectedvirtual

Implements GHOST_IWindow.

Definition at line 142 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ getClientBounds()

void GHOST_WindowNULL::getClientBounds ( GHOST_Rect bounds) const
inlineprotectedvirtual

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

Parameters
boundsThe bounding rectangle of the client area of the window.

Implements GHOST_IWindow.

Definition at line 81 of file GHOST_WindowNULL.h.

Referenced by getWindowBounds().

◆ getState()

GHOST_TWindowState GHOST_WindowNULL::getState ( ) const
inlineprotectedvirtual

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

Returns
The state of the window.

Implements GHOST_IWindow.

Definition at line 125 of file GHOST_WindowNULL.h.

References GHOST_kWindowStateNormal.

◆ getTitle()

std::string GHOST_WindowNULL::getTitle ( ) const
inlineprotectedvirtual

Returns the title displayed in the title bar.

Parameters
titleThe title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 73 of file GHOST_WindowNULL.h.

◆ getValid()

bool GHOST_WindowNULL::getValid ( ) const
inlineprotectedvirtual

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

◆ getWindowBounds()

void GHOST_WindowNULL::getWindowBounds ( GHOST_Rect bounds) const
inlineprotectedvirtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters
boundsThe bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 77 of file GHOST_WindowNULL.h.

References bounds(), and getClientBounds().

◆ hasCursorShape()

GHOST_TSuccess GHOST_WindowNULL::hasCursorShape ( GHOST_TStandardCursor  cursorShape)
inlinevirtual

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

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 18 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ installDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::installDrawingContext ( GHOST_TDrawingContextType  type)
inlineprotected

Definition at line 39 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ invalidate()

GHOST_TSuccess GHOST_WindowNULL::invalidate ( )
inlineprotectedvirtual

Invalidates the contents of this window.

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 129 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ removeDrawingContext()

GHOST_TSuccess GHOST_WindowNULL::removeDrawingContext ( )
inlineprotected

Definition at line 43 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ screenToClient()

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

Converts a point in screen coordinates to client rectangle coordinates

Parameters
inXThe x-coordinate on the screen.
inYThe y-coordinate on the screen.
outXThe x-coordinate in the client rectangle.
outYThe y-coordinate in the client rectangle.

Implements GHOST_IWindow.

Definition at line 96 of file GHOST_WindowNULL.h.

◆ setClientHeight()

GHOST_TSuccess GHOST_WindowNULL::setClientHeight ( uint32_t  height)
inlineprotectedvirtual

Resizes client rectangle height.

Parameters
heightThe new height of the client area of the window.

Implements GHOST_IWindow.

Definition at line 88 of file GHOST_WindowNULL.h.

References GHOST_kFailure.

◆ setClientSize()

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

Resizes client rectangle.

Parameters
widthThe new width of the client area of the window.
heightThe new height of the client area of the window.

Implements GHOST_IWindow.

Definition at line 92 of file GHOST_WindowNULL.h.

References GHOST_kFailure.

◆ setClientWidth()

GHOST_TSuccess GHOST_WindowNULL::setClientWidth ( uint32_t  width)
inlineprotectedvirtual

Resizes client rectangle width.

Parameters
widthThe new width of the client area of the window.

Implements GHOST_IWindow.

Definition at line 84 of file GHOST_WindowNULL.h.

References GHOST_kFailure.

◆ setOrder()

GHOST_TSuccess GHOST_WindowNULL::setOrder ( GHOST_TWindowOrder  order)
inlineprotectedvirtual

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

Parameters
orderThe order of the window.
Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 133 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ setState()

GHOST_TSuccess GHOST_WindowNULL::setState ( GHOST_TWindowState  state)
inlineprotectedvirtual

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

Parameters
stateThe state of the window.
Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 121 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ setTitle()

void GHOST_WindowNULL::setTitle ( const char *  title)
inlineprotectedvirtual

Sets the title displayed in the title bar.

Parameters
titleThe title to display in the title bar.

Implements GHOST_IWindow.

Definition at line 70 of file GHOST_WindowNULL.h.

Referenced by GHOST_WindowNULL().

◆ setWindowCursorGrab()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorGrab ( GHOST_TGrabCursorMode  )
inlineprotectedvirtual

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

Reimplemented from GHOST_Window.

Definition at line 47 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ setWindowCursorShape()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorShape ( GHOST_TStandardCursor  shape)
inlineprotectedvirtual

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

Implements GHOST_Window.

Definition at line 51 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ setWindowCursorVisibility()

GHOST_TSuccess GHOST_WindowNULL::setWindowCursorVisibility ( bool  visible)
inlineprotectedvirtual

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

Implements GHOST_Window.

Definition at line 117 of file GHOST_WindowNULL.h.

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 
)
inlineprotectedvirtual

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

Implements GHOST_Window.

Definition at line 55 of file GHOST_WindowNULL.h.

References GHOST_kSuccess.

◆ swapBuffers()

GHOST_TSuccess GHOST_WindowNULL::swapBuffers ( )
inlineprotectedvirtual

Swaps front and back buffers of a window.

Returns
A boolean success indicator.

Reimplemented from GHOST_Window.

Definition at line 106 of file GHOST_WindowNULL.h.

References GHOST_kFailure.


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