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

#include <GHOST_WindowX11.h>

Inheritance diagram for GHOST_WindowX11:
GHOST_Window GHOST_IWindow

Public Member Functions

 GHOST_WindowX11 (GHOST_SystemX11 *system, Display *display, const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, GHOST_WindowX11 *parentWindow, GHOST_TDrawingContextType type=GHOST_kDrawingContextTypeNone, const bool is_dialog=false, const bool stereoVisual=false, const bool exclusive=false, const bool alphaBackground=false, const bool is_debug=false)
 
bool getValid () const
 
void setTitle (const char *title)
 
std::string getTitle () const
 
void getWindowBounds (GHOST_Rect &bounds) const
 
void getClientBounds (GHOST_Rect &bounds) const
 
bool isDialog () 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_TWindowState getState () const
 
GHOST_TSuccess setState (GHOST_TWindowState state)
 
GHOST_TSuccess setOrder (GHOST_TWindowOrder order)
 
GHOST_TSuccess invalidate ()
 
GHOST_TSuccess setProgressBar (float progress)
 
GHOST_TSuccess endProgressBar ()
 
 ~GHOST_WindowX11 ()
 
void validate ()
 
Window getXWindow ()
 
GHOST_TabletDataGetTabletData ()
 
GHOST_TSuccess beginFullScreen () const
 
GHOST_TSuccess endFullScreen () const
 
GHOST_TSuccess setDialogHints (GHOST_WindowX11 *parentWindow)
 
uint16_t getDPIHint ()
 
- 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
 
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 ()
 
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)
 
- Public Member Functions inherited from GHOST_IWindow
virtual ~GHOST_IWindow ()
 

Public Attributes

bool m_post_init
 
GHOST_TWindowState m_post_state
 

Protected Member Functions

GHOST_ContextnewDrawingContext (GHOST_TDrawingContextType type)
 
GHOST_TSuccess setWindowCursorVisibility (bool visible)
 
GHOST_TSuccess setWindowCursorGrab (GHOST_TGrabCursorMode mode)
 
GHOST_TGrabCursorMode getWindowCursorGrab () const
 
GHOST_TSuccess setWindowCursorShape (GHOST_TStandardCursor shape)
 
GHOST_TSuccess hasCursorShape (GHOST_TStandardCursor shape)
 
GHOST_TSuccess setWindowCustomCursorShape (uint8_t *bitmap, uint8_t *mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
 
- 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

X11 implementation of GHOST_IWindow. Dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.

Definition at line 35 of file GHOST_WindowX11.h.

Constructor & Destructor Documentation

◆ GHOST_WindowX11()

GHOST_WindowX11::GHOST_WindowX11 ( GHOST_SystemX11 system,
Display *  display,
const char *  title,
int32_t  left,
int32_t  top,
uint32_t  width,
uint32_t  height,
GHOST_TWindowState  state,
GHOST_WindowX11 parentWindow,
GHOST_TDrawingContextType  type = GHOST_kDrawingContextTypeNone,
const bool  is_dialog = false,
const bool  stereoVisual = false,
const bool  exclusive = false,
const bool  alphaBackground = false,
const bool  is_debug = false 
)

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

Parameters
titleThe text shown in the title bar of the window.
leftThe coordinate of the left edge of the window.
topThe coordinate of the top edge of the window.
widthThe width the window.
heightThe height the window.
stateThe state the window is initially opened with.
parentWindowParent (embedder) window.
typeThe type of drawing context installed in this window.
stereoVisualStereo visual for quad buffered stereo.
alphaBackgroundEnable alpha blending of window with display background.

Definition at line 198 of file GHOST_WindowX11.cpp.

References GHOST_SystemX11::_NET_WM_STATE, GHOST_SystemX11::_NET_WM_STATE_FULLSCREEN, GHOST_SystemX11::_NET_WM_STATE_MAXIMIZED_HORZ, GHOST_SystemX11::_NET_WM_STATE_MAXIMIZED_VERT, ARRAY_SIZE, BLENDER_ICONS_WM_X11, count, ELEM, free(), GHOST_kDrawingContextTypeOpenGL, GHOST_kSuccess, GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, GHOST_kWindowStateNormal, GHOST_PRINT, GHOST_WindowX11(), height, HOST_NAME_MAX, left, len, GHOST_SystemX11::m_atom, m_post_init, m_post_state, GHOST_System::m_windowFocus, None, setDialogHints(), GHOST_Window::setDrawingContextType(), setTitle(), state, top, type, void, width, GHOST_SystemX11::WM_DELETE_WINDOW, GHOST_SystemX11::WM_PROTOCOLS, GHOST_SystemX11::WM_TAKE_FOCUS, and x11_visualinfo_from_glx().

Referenced by GHOST_WindowX11().

◆ ~GHOST_WindowX11()

GHOST_WindowX11::~GHOST_WindowX11 ( )

Destructor. Closes the window and disposes resources allocated.

Definition at line 1235 of file GHOST_WindowX11.cpp.

References None, and GHOST_Window::releaseNativeHandles().

Member Function Documentation

◆ beginFullScreen()

GHOST_TSuccess GHOST_WindowX11::beginFullScreen ( ) const
virtual

Implements GHOST_IWindow.

Definition at line 1643 of file GHOST_WindowX11.cpp.

References err, GHOST_kSuccess, None, and GHOST_SystemX11::setCursorPosition().

◆ clientToScreen()

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

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 672 of file GHOST_WindowX11.cpp.

Referenced by getClientBounds().

◆ endFullScreen()

GHOST_TSuccess GHOST_WindowX11::endFullScreen ( void  ) const
virtual

Implements GHOST_IWindow.

Definition at line 1687 of file GHOST_WindowX11.cpp.

References GHOST_kSuccess.

◆ endProgressBar()

GHOST_TSuccess GHOST_WindowX11::endProgressBar ( )
virtual

Hides the progress bar in the icon

Reimplemented from GHOST_Window.

Definition at line 1746 of file GHOST_WindowX11.cpp.

References GHOST_kFailure, GHOST_kSuccess, GHOST_TaskBarX11::is_valid(), and GHOST_TaskBarX11::set_progress_enabled().

◆ getClientBounds()

void GHOST_WindowX11::getClientBounds ( GHOST_Rect bounds) const
virtual

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 605 of file GHOST_WindowX11.cpp.

References bounds(), and clientToScreen().

Referenced by getWindowBounds().

◆ getDPIHint()

uint16_t GHOST_WindowX11::getDPIHint ( )
virtual

Returns the recommended DPI for this window.

Returns
The recommended DPI for this window.

Reimplemented from GHOST_Window.

Definition at line 1695 of file GHOST_WindowX11.cpp.

References sqrt(), and type.

◆ getState()

GHOST_TWindowState GHOST_WindowX11::getState ( ) const
virtual

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

Returns
The state of the window.

Implements GHOST_IWindow.

Definition at line 977 of file GHOST_WindowX11.cpp.

References ELEM, GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, GHOST_kWindowStateNormal, and state.

Referenced by setState().

◆ GetTabletData()

GHOST_TabletData& GHOST_WindowX11::GetTabletData ( )
inline

Definition at line 124 of file GHOST_WindowX11.h.

◆ getTitle()

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

Returns the title displayed in the title bar.

Parameters
titleThe title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 588 of file GHOST_WindowX11.cpp.

◆ getValid()

bool GHOST_WindowX11::getValid ( ) const
virtual

Returns indication as to whether the window is valid.

Returns
The validity of the window.

Reimplemented from GHOST_Window.

Definition at line 563 of file GHOST_WindowX11.cpp.

References GHOST_Window::getValid().

Referenced by GHOST_SystemX11::createWindow().

◆ getWindowBounds()

void GHOST_WindowX11::getWindowBounds ( GHOST_Rect bounds) const
virtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters
boundsThe bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 598 of file GHOST_WindowX11.cpp.

References bounds(), and getClientBounds().

◆ getWindowCursorGrab()

GHOST_TGrabCursorMode GHOST_WindowX11::getWindowCursorGrab ( ) const
protected

◆ getXWindow()

Window GHOST_WindowX11::getXWindow ( )

◆ hasCursorShape()

GHOST_TSuccess GHOST_WindowX11::hasCursorShape ( GHOST_TStandardCursor  cursorShape)
protectedvirtual

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

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 1596 of file GHOST_WindowX11.cpp.

◆ invalidate()

GHOST_TSuccess GHOST_WindowX11::invalidate ( )
virtual

Invalidates the contents of this window.

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 1197 of file GHOST_WindowX11.cpp.

References GHOST_SystemX11::addDirtyWindow(), and GHOST_kSuccess.

◆ isDialog()

bool GHOST_WindowX11::isDialog ( ) const
virtual

Reimplemented from GHOST_Window.

Definition at line 1159 of file GHOST_WindowX11.cpp.

References ret, and usdtokens::st().

◆ newDrawingContext()

GHOST_Context * GHOST_WindowX11::newDrawingContext ( GHOST_TDrawingContextType  type)
protectedvirtual

◆ screenToClient()

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

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 659 of file GHOST_WindowX11.cpp.

◆ setClientHeight()

GHOST_TSuccess GHOST_WindowX11::setClientHeight ( uint32_t  height)
virtual

Resizes client rectangle height.

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

Implements GHOST_IWindow.

Definition at line 640 of file GHOST_WindowX11.cpp.

References GHOST_kSuccess, and height.

◆ setClientSize()

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

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 649 of file GHOST_WindowX11.cpp.

References GHOST_kSuccess, height, and width.

◆ setClientWidth()

GHOST_TSuccess GHOST_WindowX11::setClientWidth ( uint32_t  width)
virtual

Resizes client rectangle width.

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

Implements GHOST_IWindow.

Definition at line 630 of file GHOST_WindowX11.cpp.

References GHOST_kSuccess, and width.

◆ setDialogHints()

GHOST_TSuccess GHOST_WindowX11::setDialogHints ( GHOST_WindowX11 parentWindow)

◆ setOrder()

GHOST_TSuccess GHOST_WindowX11::setOrder ( GHOST_TWindowOrder  order)
virtual

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

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

Implements GHOST_IWindow.

Definition at line 1102 of file GHOST_WindowX11.cpp.

References GHOST_kFailure, GHOST_kSuccess, GHOST_kWindowOrderBottom, GHOST_kWindowOrderTop, None, order, and Window::window.

◆ setProgressBar()

GHOST_TSuccess GHOST_WindowX11::setProgressBar ( float  )
virtual

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

Parameters
progressThe progress percentage (0.0 to 1.0).

Reimplemented from GHOST_Window.

Definition at line 1735 of file GHOST_WindowX11.cpp.

References GHOST_kFailure, GHOST_kSuccess, GHOST_TaskBarX11::is_valid(), GHOST_TaskBarX11::set_progress(), and GHOST_TaskBarX11::set_progress_enabled().

◆ setState()

GHOST_TSuccess GHOST_WindowX11::setState ( GHOST_TWindowState  state)
virtual

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 1003 of file GHOST_WindowX11.cpp.

References getState(), GHOST_kFailure, GHOST_kSuccess, GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, GHOST_kWindowStateNormal, and state.

◆ setTitle()

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

Sets the title displayed in the title bar.

Parameters
titleThe title to display in the title bar.

Implements GHOST_IWindow.

Definition at line 568 of file GHOST_WindowX11.cpp.

Referenced by GHOST_WindowX11().

◆ setWindowCursorGrab()

GHOST_TSuccess GHOST_WindowX11::setWindowCursorGrab ( GHOST_TGrabCursorMode  mode)
protectedvirtual

◆ setWindowCursorShape()

GHOST_TSuccess GHOST_WindowX11::setWindowCursorShape ( GHOST_TStandardCursor  shape)
protectedvirtual

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

Implements GHOST_Window.

Definition at line 1581 of file GHOST_WindowX11.cpp.

References GHOST_kFailure, GHOST_kStandardCursorDefault, and GHOST_kSuccess.

◆ setWindowCursorVisibility()

GHOST_TSuccess GHOST_WindowX11::setWindowCursorVisibility ( bool  visible)
protectedvirtual

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

Implements GHOST_Window.

Definition at line 1492 of file GHOST_WindowX11.cpp.

References GHOST_Window::getCursorShape(), GHOST_kFailure, and GHOST_kSuccess.

Referenced by setWindowCursorGrab().

◆ setWindowCustomCursorShape()

GHOST_TSuccess GHOST_WindowX11::setWindowCustomCursorShape ( uint8_t bitmap,
uint8_t mask,
int  sizex,
int  sizey,
int  hotX,
int  hotY,
bool  canInvertColor 
)
protectedvirtual

Sets the cursor shape on the window using native window system calls (Arbitrary size/color).

Implements GHOST_Window.

Definition at line 1602 of file GHOST_WindowX11.cpp.

References GHOST_kFailure, GHOST_kSuccess, L, and mask().

◆ validate()

void GHOST_WindowX11::validate ( )

X11 system specific calls

The reverse of invalidate! Tells this window that all events for it have been pushed into the GHOST event queue.

called by the X11 system implementation when expose events for the window have been pushed onto the GHOST queue

Definition at line 1225 of file GHOST_WindowX11.cpp.

Member Data Documentation

◆ m_post_init

bool GHOST_WindowX11::m_post_init

Definition at line 154 of file GHOST_WindowX11.h.

Referenced by GHOST_WindowX11().

◆ m_post_state

GHOST_TWindowState GHOST_WindowX11::m_post_state

Definition at line 155 of file GHOST_WindowX11.h.

Referenced by GHOST_WindowX11().


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