#include <GHOST_WindowWin32.hh>

Inherits GHOST_Window.

Public Member Functions
	GHOST_WindowWin32 (GHOST_SystemWin32 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, GHOST_WindowWin32 *parent_window, bool dialog, const GHOST_GPUDevice &preferred_device)
	~GHOST_WindowWin32 ()
void	adjustWindowRectForClosestMonitor (LPRECT win_rect, DWORD dwStyle, DWORD dwExStyle)
bool	getValid () const
HWND	getHWND () const
void *	getOSWindow () const
void	setTitle (const char *title)
std::string	getTitle () const
GHOST_TSuccess	applyWindowDecorationStyle () override
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)
GHOST_TWindowState	getState () const
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	setState (GHOST_TWindowState state)
GHOST_TSuccess	setOrder (GHOST_TWindowOrder order)
GHOST_TSuccess	invalidate ()
GHOST_TSuccess	setProgressBar (float progress)
GHOST_TSuccess	endProgressBar ()
void	updateMouseCapture (GHOST_MouseCaptureEventWin32 event)
void	lostMouseCapture ()
bool	isDialog () const
HCURSOR	getStandardCursor (GHOST_TStandardCursor shape) const
void	loadCursor (bool visible, GHOST_TStandardCursor cursor_shape) const
bool	usingTabletAPI (GHOST_TTabletAPI api) const
GHOST_TSuccess	getPointerInfo (std::vector< GHOST_PointerInfoWin32 > &outPointerInfo, WPARAM wParam, LPARAM lParam)
void	resetPointerPenInfo ()
GHOST_Wintab *	getWintab () const
void	loadWintab (bool enable)
void	closeWintab ()
GHOST_TabletData	getTabletData ()
void	updateDPI ()
uint16_t	getDPIHint () override
void	ThemeRefresh ()
void	updateDirectManipulation ()
void	onPointerHitTest (WPARAM wParam)
GHOST_TTrackpadInfo	getTrackpadInfo ()
void	updateHDRInfo ()
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
GHOST_TSuccess	setPath (const char *) override
virtual GHOST_TWindowDecorationStyleFlags	getWindowDecorationStyleFlags () override
virtual void	setWindowDecorationStyleFlags (GHOST_TWindowDecorationStyleFlags style_flags) override
virtual void	setWindowDecorationStyleSettings (GHOST_WindowDecorationStyleSettings decoration_settings) override
GHOST_TStandardCursor	getCursorShape () 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
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	setSwapInterval (int interval) override
GHOST_TSuccess	getSwapInterval (int &interval_out) override
void	setAcceptDragOperation (bool can_accept) override
bool	canAcceptDragOperation () const override
GHOST_TSuccess	setModifiedState (bool is_unsaved_changes) override
bool	getModifiedState () 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 ()
unsigned int	getDefaultFramebuffer () override
GHOST_TUserDataPtr	getUserData () const override
void	setUserData (const GHOST_TUserDataPtr user_data) override
float	getNativePixelSize () override
GHOST_WindowHDRInfo	getHDRInfo () override
Public Member Functions inherited from GHOST_IWindow
virtual	~GHOST_IWindow ()=default

Public Attributes
bool	mouse_present_
bool	in_live_resize_

Additional Inherited Members
Protected Member Functions inherited from GHOST_Window
virtual GHOST_TSuccess	setWindowCustomCursorGenerator (GHOST_CursorGenerator *cursor_generator)
GHOST_TSuccess	releaseNativeHandles ()
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

GHOST window on MS Windows OSs.

Definition at line 54 of file GHOST_WindowWin32.hh.

Constructor & Destructor Documentation

◆ GHOST_WindowWin32()

GHOST_WindowWin32::GHOST_WindowWin32	(	GHOST_SystemWin32 *	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,
		GHOST_WindowWin32 *	parent_window,
		bool	dialog,
		const GHOST_GPUDevice &	preferred_device )

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

Parameters

title	The text shown in the title bar of the window.
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state the window is initially opened with.
type	The type of drawing context installed in this window.
wantStereoVisual	Stereo visual for quad buffered stereo.
preferred_device	Preferred device to use when new device will be created.
parentWindowHwnd	TODO.

Definition at line 54 of file GHOST_WindowWin32.cc.

References adjustWindowRectForClosestMonitor(), alloc_utf16_from_8(), BLI_getenv(), CLSID_TaskbarList, GHOST_DirectManipulationHelper::create(), false, free(), getDPIHint(), GHOST_System::getTabletAPI(), GHOST_kTabletWinPointer, GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, GHOST_kWindowStateNormal, GHOST_TABLET_DATA_NONE, GHOST_Window::GHOST_Window(), GHOST_WindowWin32(), in_live_resize_, left, loadWintab(), long, lostMouseCapture(), mouse_present_, nullptr, GHOST_Window::setDrawingContextType(), state, ThemeRefresh(), top, and updateHDRInfo().

Referenced by GHOST_WindowWin32(), and ~GHOST_WindowWin32().

◆ ~GHOST_WindowWin32()

GHOST_WindowWin32::~GHOST_WindowWin32 ( )

Destructor. Closes the window and disposes resources allocated.

Definition at line 259 of file GHOST_WindowWin32.cc.

References closeWintab(), GHOST_WindowWin32(), GHOST_Window::releaseNativeHandles(), and TBPF_NOPROGRESS.

Member Function Documentation

◆ adjustWindowRectForClosestMonitor()

void GHOST_WindowWin32::adjustWindowRectForClosestMonitor	(	LPRECT	win_rect,
		DWORD	dwStyle,
		DWORD	dwExStyle )

Adjusts a requested window rect to fit and position correctly in monitor.

Parameters

win_rect	pointer to rectangle that will be modified.
dwStyle	The Window Style of the window whose required size is to be calculated.
dwExStyle	The Extended Window Style of the window.

Definition at line 315 of file GHOST_WindowWin32.cc.

References FALSE, max, and min.

Referenced by GHOST_WindowWin32().

◆ applyWindowDecorationStyle()

GHOST_TSuccess GHOST_WindowWin32::applyWindowDecorationStyle ( )

overridevirtual

Apply the window decoration style using the current flags and settings.

Reimplemented from GHOST_Window.

Definition at line 389 of file GHOST_WindowWin32.cc.

References GHOST_kDecorationColoredTitleBar, GHOST_kFailure, GHOST_kSuccess, GHOST_Window::window_decoration_style_flags_, and GHOST_Window::window_decoration_style_settings_.

◆ clientToScreen()

void GHOST_WindowWin32::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

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 525 of file GHOST_WindowWin32.cc.

Referenced by GHOST_SystemWin32::s_wndProc().

◆ closeWintab()

void GHOST_WindowWin32::closeWintab ( )

Closes Wintab for the window.

Definition at line 975 of file GHOST_WindowWin32.cc.

References WINTAB_PRINTF.

Referenced by GHOST_SystemWin32::setTabletAPI(), and ~GHOST_WindowWin32().

◆ endProgressBar()

GHOST_TSuccess GHOST_WindowWin32::endProgressBar ( )

virtual

Hides the progress bar in the icon

Reimplemented from GHOST_Window.

Definition at line 1203 of file GHOST_WindowWin32.cc.

References GHOST_kFailure, GHOST_kSuccess, and TBPF_NOPROGRESS.

◆ getClientBounds()

void GHOST_WindowWin32::getClientBounds ( GHOST_Rect & bounds ) const

virtual

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 416 of file GHOST_WindowWin32.cc.

References bounds().

Referenced by loadWintab(), GHOST_SystemWin32::processCursorEvent(), setClientHeight(), setClientSize(), and setClientWidth().

◆ getDPIHint()

uint16_t GHOST_WindowWin32::getDPIHint ( )

overridevirtual

Returns the recommended DPI for this window.

Returns: The recommended DPI for this window.

Reimplemented from GHOST_Window.

Definition at line 1038 of file GHOST_WindowWin32.cc.

Referenced by GHOST_WindowWin32(), and updateDPI().

◆ getHWND()

HWND GHOST_WindowWin32::getHWND ( ) const

Access to the handle of the window.

Returns: The handle of the window.

Definition at line 361 of file GHOST_WindowWin32.cc.

Referenced by GHOST_DropTargetWin32::GHOST_DropTargetWin32(), GHOST_SystemWin32::processButtonEvent(), GHOST_SystemWin32::processWintabEvent(), and GHOST_SystemWin32::s_wndProc().

◆ getOSWindow()

void * GHOST_WindowWin32::getOSWindow ( ) const

virtual

Returns the handle of the window.

Returns: The handle of the window.

Reimplemented from GHOST_Window.

Definition at line 366 of file GHOST_WindowWin32.cc.

◆ getPointerInfo()

GHOST_TSuccess GHOST_WindowWin32::getPointerInfo	(	std::vector< GHOST_PointerInfoWin32 > &	outPointerInfo,
		WPARAM	wParam,
		LPARAM	lParam )

Translate WM_POINTER events into GHOST_PointerInfoWin32 structs.

Parameters

outPointerInfo	Storage to return resulting GHOST_PointerInfoWin32 structs.
wParam	WPARAM of the event.
lParam	LPARAM of the event.

Returns: True if #outPointerInfo was updated.

Definition at line 852 of file GHOST_WindowWin32.cc.

References GET_POINTERID_WPARAM, GHOST_ISystem::getSystem(), GHOST_kButtonMaskButton4, GHOST_kButtonMaskButton5, GHOST_kButtonMaskLeft, GHOST_kButtonMaskMiddle, GHOST_kButtonMaskRight, GHOST_kFailure, GHOST_kSuccess, GHOST_kTabletModeEraser, GHOST_kTabletModeStylus, i, and GHOST_SystemWin32::performanceCounterToMillis().

Referenced by GHOST_SystemWin32::processPointerEvent().

◆ getStandardCursor()

HCURSOR GHOST_WindowWin32::getStandardCursor ( GHOST_TStandardCursor shape ) const

Loads the windows equivalent of a standard GHOST cursor.

Parameters

visible	Flag for cursor visibility.
cursor_shape	The cursor shape.

Definition at line 716 of file GHOST_WindowWin32.cc.

References GHOST_kStandardCursorBottomLeftCorner, GHOST_kStandardCursorBottomRightCorner, GHOST_kStandardCursorCustom, GHOST_kStandardCursorDefault, GHOST_kStandardCursorHelp, GHOST_kStandardCursorMove, GHOST_kStandardCursorText, GHOST_kStandardCursorTopLeftCorner, GHOST_kStandardCursorTopRightCorner, GHOST_kStandardCursorTopSide, and GHOST_kStandardCursorWait.

Referenced by loadCursor().

◆ getState()

GHOST_TWindowState GHOST_WindowWin32::getState ( ) const

virtual

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

Returns: The state of the window.

Implements GHOST_IWindow.

Definition at line 502 of file GHOST_WindowWin32.cc.

References GHOST_kWindowStateFullScreen, GHOST_kWindowStateMaximized, GHOST_kWindowStateMinimized, GHOST_kWindowStateNormal, and result.

Referenced by GHOST_SystemWin32::s_wndProc(), setOrder(), setState(), and GHOST_SystemWin32::setTabletAPI().

◆ getTabletData()

GHOST_TabletData GHOST_WindowWin32::getTabletData ( )

Get the most recent Windows Pointer tablet data.

Returns: Most recent pointer tablet data.

Definition at line 1000 of file GHOST_WindowWin32.cc.

References GHOST_kTabletWintab, GHOST_TABLET_DATA_NONE, and usingTabletAPI().

Referenced by GHOST_SystemWin32::processButtonEvent(), GHOST_SystemWin32::processCursorEvent(), and GHOST_SystemWin32::s_wndProc().

◆ getTitle()

std::string GHOST_WindowWin32::getTitle ( ) const

virtual

Returns the title displayed in the title bar.

Returns: The title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 378 of file GHOST_WindowWin32.cc.

References conv_utf_16_to_8(), count_utf_8_from_16(), and L.

◆ getTrackpadInfo()

GHOST_TTrackpadInfo GHOST_WindowWin32::getTrackpadInfo ( )

Definition at line 250 of file GHOST_WindowWin32.cc.

Referenced by GHOST_SystemWin32::processTrackpad().

◆ getValid()

bool GHOST_WindowWin32::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 356 of file GHOST_WindowWin32.cc.

References GHOST_Window::getValid().

Referenced by GHOST_SystemWin32::createWindow().

◆ getWindowBounds()

void GHOST_WindowWin32::getWindowBounds ( GHOST_Rect & bounds ) const

virtual

Returns the window rectangle dimensions. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.

Parameters

bounds The bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 406 of file GHOST_WindowWin32.cc.

References bounds().

Referenced by setClientHeight(), setClientSize(), and setClientWidth().

◆ getWintab()

GHOST_Wintab * GHOST_WindowWin32::getWintab ( ) const

Retrieves pointer to Wintab if Wintab is the set Tablet API.

Returns: Pointer to Wintab member.

Definition at line 946 of file GHOST_WindowWin32.cc.

Referenced by GHOST_SystemWin32::processWintabEvent(), and GHOST_SystemWin32::s_wndProc().

◆ invalidate()

GHOST_TSuccess GHOST_WindowWin32::invalidate ( )

virtual

Invalidates the contents of this window.

Implements GHOST_IWindow.

Definition at line 607 of file GHOST_WindowWin32.cc.

References FALSE, GHOST_kFailure, and GHOST_kSuccess.

◆ isDialog()

bool GHOST_WindowWin32::isDialog ( ) const

virtual

Reimplemented from GHOST_Window.

Definition at line 682 of file GHOST_WindowWin32.cc.

◆ loadCursor()

void GHOST_WindowWin32::loadCursor	(	bool	visible,
		GHOST_TStandardCursor	cursor_shape ) const

Definition at line 772 of file GHOST_WindowWin32.cc.

References FALSE, getStandardCursor(), and GHOST_kStandardCursorDefault.

Referenced by GHOST_SystemWin32::s_wndProc().

◆ loadWintab()

void GHOST_WindowWin32::loadWintab ( bool enable )

Loads Wintab context for the window.

Parameters

enable True if Wintab should be enabled after loading. Wintab should not be enabled if the window is minimized.

Definition at line 951 of file GHOST_WindowWin32.cc.

References getClientBounds(), GHOST_Rect::isInside(), GHOST_Wintab::loadWintab(), WINTAB_PRINTF, x, and y.

Referenced by GHOST_WindowWin32(), and GHOST_SystemWin32::setTabletAPI().

◆ lostMouseCapture()

void GHOST_WindowWin32::lostMouseCapture ( )

Inform the window that it has lost mouse capture, called in response to native window system messages (WA_INACTIVE, WM_CAPTURECHANGED) or if ReleaseCapture() is explicitly called (for new window creation).

Definition at line 673 of file GHOST_WindowWin32.cc.

Referenced by GHOST_WindowWin32(), and GHOST_SystemWin32::s_wndProc().

◆ onPointerHitTest()

void GHOST_WindowWin32::onPointerHitTest ( WPARAM wParam )

Definition at line 235 of file GHOST_WindowWin32.cc.

References GET_POINTERID_WPARAM.

Referenced by GHOST_SystemWin32::s_wndProc().

◆ resetPointerPenInfo()

void GHOST_WindowWin32::resetPointerPenInfo ( )

Resets pointer pen tablet state.

Definition at line 941 of file GHOST_WindowWin32.cc.

References GHOST_TABLET_DATA_NONE.

Referenced by GHOST_SystemWin32::s_wndProc(), and GHOST_SystemWin32::setTabletAPI().

◆ screenToClient()

void GHOST_WindowWin32::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

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 514 of file GHOST_WindowWin32.cc.