Blender V5.3
GHOST_WindowSDL Class Reference

#include <GHOST_WindowSDL.hh>

Inherits GHOST_Window.

Public Member Functions

 GHOST_WindowSDL (GHOST_SystemSDL *system, const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, GHOST_TDrawingContextType type, const GHOST_ContextParams &context_params, const GHOST_GPUDevice &preferred_device, const bool exclusive=false, const GHOST_IWindow *parent_window=nullptr)
 ~GHOST_WindowSDL ()
SDL_Window * getSDLWindow ()
GHOST_TSuccess invalidate () override
void validate ()
bool getValid () const override
void getWindowBounds (GHOST_Rect &bounds) const override
void getClientBounds (GHOST_Rect &bounds) const override
Public Member Functions inherited from GHOST_Window
 GHOST_Window (uint32_t width, uint32_t height, GHOST_TWindowState state, const GHOST_ContextParams &context_params, const bool exclusive=false)
 ~GHOST_Window () override
void setPath (const char *) override
GHOST_TWindowDecorationStyleFlags getWindowDecorationStyleFlags () override
void setWindowDecorationStyleFlags (GHOST_TWindowDecorationStyleFlags style_flags) override
void setWindowDecorationStyleSettings (GHOST_WindowDecorationStyleSettings decoration_settings) override
GHOST_TSuccess applyWindowDecorationStyle () override
GHOST_TStandardCursor getCursorShape () const override
bool isDialog () const override
GHOST_TSuccess setCursorShape (GHOST_TStandardCursor cursor_shape) override
GHOST_TSuccess setCustomCursorShape (const uint8_t *bitmap, const uint8_t *mask, const int size[2], const int hot_spot[2], bool can_invert_color) override
GHOST_TSuccess setCustomCursorGenerator (GHOST_CursorGenerator *cursor_generator) 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
void getCursorGrabState (GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &wrap_axis, GHOST_Rect &bounds, bool &use_software_cursor) override
GHOST_TSuccess setProgressBar (float) override
GHOST_TSuccess endProgressBar () override
GHOST_TSuccess setSwapInterval (int interval) override
GHOST_TSuccess getSwapInterval (int &interval_out) override
void setAcceptDragOperation (bool can_accept) override
GHOST_TSuccess setModifiedState (bool is_unsaved_changes) override
GHOST_TDrawingContextType getDrawingContextType () override
GHOST_TSuccess setDrawingContextType (GHOST_TDrawingContextType type) override
GHOST_IContext * getDrawingContext () override
GHOST_TSuccess swapBufferAcquire () override
GHOST_TSuccess swapBufferRelease () override
GHOST_TSuccess activateDrawingContext () override
GHOST_TSuccess updateDrawingContext ()
GHOST_Context * getContext ()
bool hasAlpha () const override
unsigned int getDefaultFramebuffer () override
GHOST_TUserDataPtr getUserData () const override
void setUserData (const GHOST_TUserDataPtr user_data) override
float getNativePixelSize () override
GHOST_WindowHDRInfo getHDRInfo () override
virtual void * getOSWindow () const
virtual bool canAcceptDragOperation () const
virtual GHOST_TSuccess getCursorGrabBounds (GHOST_Rect &bounds) const
Public Member Functions inherited from GHOST_IWindow
virtual ~GHOST_IWindow ()=default
virtual GHOST_TWindowTiledFlag getTiledEdges () const

Protected Member Functions

GHOST_Context * newDrawingContext (GHOST_TDrawingContextType type) override
GHOST_TSuccess setWindowCursorGrab (GHOST_TGrabCursorMode mode) override
GHOST_TSuccess setWindowCursorShape (GHOST_TStandardCursor shape) override
GHOST_TSuccess hasCursorShape (GHOST_TStandardCursor shape) override
GHOST_TSuccess setWindowCustomCursorShape (const uint8_t *bitmap, const uint8_t *mask, const int size[2], const int hot_spot[2], bool can_invert_color) override
GHOST_TSuccess setWindowCursorVisibility (bool visible) override
void setTitle (const char *title) override
std::string getTitle () const override
GHOST_TSuccess setClientWidth (uint32_t width) override
GHOST_TSuccess setClientHeight (uint32_t height) override
GHOST_TSuccess setClientSize (uint32_t width, uint32_t height) 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 setState (GHOST_TWindowState state) override
GHOST_TWindowState getState () const override
GHOST_TSuccess setOrder (GHOST_TWindowOrder) override
uint16_t getDPIHint () override
Protected Member Functions inherited from GHOST_Window
virtual GHOST_TSuccess setWindowCustomCursorGenerator (GHOST_CursorGenerator *cursor_generator)
virtual bool getCursorGrabUseSoftwareDisplay ()
virtual bool getModifiedState ()
GHOST_TSuccess releaseNativeHandles ()

Additional Inherited Members

Protected Attributes inherited from GHOST_Window
GHOST_TDrawingContextType drawing_context_type_
GHOST_TUserDataPtr user_data_
bool cursor_visible_
GHOST_TGrabCursorMode cursor_grab_
GHOST_TAxisFlag cursor_grab_axis_
int32_t cursor_grab_init_pos_ [2]
int32_t cursor_grab_accum_pos_ [2]
GHOST_Rect cursor_grab_bounds_
GHOST_TStandardCursor cursor_shape_
bool progress_bar_visible_
bool can_accept_drag_operation_
bool is_unsaved_changes_
bool full_screen_
GHOST_TWindowDecorationStyleFlags window_decoration_style_flags_
GHOST_WindowDecorationStyleSettings window_decoration_style_settings_
GHOST_ContextParams want_context_params_
uint32_t full_screen_width_
uint32_t full_screen_height_
float native_pixel_size_
GHOST_WindowHDRInfo hdr_info_ = GHOST_WINDOW_HDR_INFO_NONE

Detailed Description

Definition at line 21 of file GHOST_WindowSDL.hh.

Constructor & Destructor Documentation

◆ GHOST_WindowSDL()

GHOST_WindowSDL::GHOST_WindowSDL ( GHOST_SystemSDL * system,
const char * title,
int32_t left,
int32_t top,
uint32_t width,
uint32_t height,
GHOST_TWindowState state,
GHOST_TDrawingContextType type,
const GHOST_ContextParams & context_params,
const GHOST_GPUDevice & preferred_device,
const bool exclusive = false,
const GHOST_IWindow * parent_window = nullptr )

◆ ~GHOST_WindowSDL()

GHOST_WindowSDL::~GHOST_WindowSDL ( )

Definition at line 74 of file GHOST_WindowSDL.cc.

References GHOST_Window::releaseNativeHandles().

Member Function Documentation

◆ clientToScreen()

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

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 241 of file GHOST_WindowSDL.cc.

◆ getClientBounds()

void GHOST_WindowSDL::getClientBounds ( GHOST_Rect & bounds) const
overridevirtual

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 198 of file GHOST_WindowSDL.cc.

References GHOST_Rect::b_, GHOST_Rect::l_, GHOST_Rect::r_, GHOST_Rect::t_, w(), x, and y.

Referenced by getWindowBounds().

◆ getDPIHint()

uint16_t GHOST_WindowSDL::getDPIHint ( )
overrideprotectedvirtual

Returns the recommended DPI for this window.

Returns
The recommended DPI for this window.

Reimplemented from GHOST_Window.

Definition at line 679 of file GHOST_WindowSDL.cc.

References scale().

◆ getSDLWindow()

SDL_Window * GHOST_WindowSDL::getSDLWindow ( )
inline

Definition at line 48 of file GHOST_WindowSDL.hh.

◆ getState()

GHOST_TWindowState GHOST_WindowSDL::getState ( ) const
overrideprotectedvirtual

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

Returns
The state of the window.

Implements GHOST_IWindow.

Definition at line 162 of file GHOST_WindowSDL.cc.

References GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, and GHOST_kWindowStateNormal.

◆ getTitle()

std::string GHOST_WindowSDL::getTitle ( ) const
overrideprotectedvirtual

Returns the title displayed in the title bar.

Returns
The title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 188 of file GHOST_WindowSDL.cc.

◆ getValid()

bool GHOST_WindowSDL::getValid ( ) const
overridevirtual

Returns indication as to whether the window is valid.

Returns
The validity of the window.

Reimplemented from GHOST_Window.

Definition at line 178 of file GHOST_WindowSDL.cc.

References GHOST_Window::getValid().

◆ getWindowBounds()

void GHOST_WindowSDL::getWindowBounds ( GHOST_Rect & bounds) const
overridevirtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters
boundsThe bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 193 of file GHOST_WindowSDL.cc.

References getClientBounds().

◆ hasCursorShape()

GHOST_TSuccess GHOST_WindowSDL::hasCursorShape ( GHOST_TStandardCursor cursor_shape)
overrideprotectedvirtual

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

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 646 of file GHOST_WindowSDL.cc.

References getStandardCursorShape(), GHOST_kFailure, and GHOST_kSuccess.

◆ invalidate()

GHOST_TSuccess GHOST_WindowSDL::invalidate ( )
overridevirtual

Invalidates the contents of this window.

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 128 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ newDrawingContext()

GHOST_Context * GHOST_WindowSDL::newDrawingContext ( GHOST_TDrawingContextType type)
overrideprotectedvirtual

◆ screenToClient()

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

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 232 of file GHOST_WindowSDL.cc.

◆ setClientHeight()

GHOST_TSuccess GHOST_WindowSDL::setClientHeight ( uint32_t height)
overrideprotectedvirtual

Resizes client rectangle height.

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

Implements GHOST_IWindow.

Definition at line 218 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ setClientSize()

GHOST_TSuccess GHOST_WindowSDL::setClientSize ( uint32_t width,
uint32_t height )
overrideprotectedvirtual

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 226 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ setClientWidth()

GHOST_TSuccess GHOST_WindowSDL::setClientWidth ( uint32_t width)
overrideprotectedvirtual

Resizes client rectangle width.

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

Implements GHOST_IWindow.

Definition at line 210 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ setOrder()

GHOST_TSuccess GHOST_WindowSDL::setOrder ( GHOST_TWindowOrder order)
inlineoverrideprotectedvirtual

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

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

Implements GHOST_IWindow.

Definition at line 108 of file GHOST_WindowSDL.hh.

References GHOST_kSuccess.

◆ setState()

GHOST_TSuccess GHOST_WindowSDL::setState ( GHOST_TWindowState state)
overrideprotectedvirtual

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 138 of file GHOST_WindowSDL.cc.

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

◆ setTitle()

void GHOST_WindowSDL::setTitle ( const char * title)
overrideprotectedvirtual

Sets the title displayed in the title bar.

Parameters
titleThe title to display in the title bar.

Implements GHOST_IWindow.

Definition at line 183 of file GHOST_WindowSDL.cc.

Referenced by GHOST_WindowSDL().

◆ setWindowCursorGrab()

GHOST_TSuccess GHOST_WindowSDL::setWindowCursorGrab ( GHOST_TGrabCursorMode mode)
overrideprotectedvirtual

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

Reimplemented from GHOST_Window.

Definition at line 630 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ setWindowCursorShape()

GHOST_TSuccess GHOST_WindowSDL::setWindowCursorShape ( GHOST_TStandardCursor shape)
overrideprotectedvirtual

◆ setWindowCursorVisibility()

GHOST_TSuccess GHOST_WindowSDL::setWindowCursorVisibility ( bool visible)
overrideprotectedvirtual

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

Implements GHOST_Window.

Definition at line 668 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess.

◆ setWindowCustomCursorShape()

GHOST_TSuccess GHOST_WindowSDL::setWindowCustomCursorShape ( const uint8_t * bitmap,
const uint8_t * mask,
const int size[2],
const int hot_size[2],
bool can_invert_color )
overrideprotectedvirtual

Implements GHOST_Window.

Definition at line 651 of file GHOST_WindowSDL.cc.

References GHOST_kSuccess, mask(), and sdl_ghost_CreateCursor().

◆ validate()

void GHOST_WindowSDL::validate ( )
inline

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

Definition at line 60 of file GHOST_WindowSDL.hh.


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