Platform window interface (SDL implementation on desktop/mobile). Script: win <- eve.Window(); 更多...

#include <Window.h>

类 eve::window::Window 继承关系图:

类
struct	MessageBoxData

struct	WindowSize

Public 成员函数
	Module_REG (Window)

virtual	~Window ()

virtual void	setSize (int width, int height)=0
	Requests a new logical window size.

virtual int	getWidth () const =0

virtual int	getHeight () const =0

virtual bool	setWindowSettings (WindowSettings settings)=0
	Applies a full WindowSettings struct (recreates the window when needed).

virtual WindowSettings	getWindowSettings ()=0

virtual void	close ()=0
	Closes and destroys the underlying window.

virtual bool	setFullscreenDesktop (bool fullscreen)=0
	Switches between desktop fullscreen and windowed mode.

virtual bool	setFullscreenExclusive (bool fullscreen)=0
	Switches between exclusive fullscreen and windowed mode.

virtual bool	isOpen () const =0

virtual void	setWindowTitle (const std::string &title)=0
	Sets the window title shown in the OS title bar.

virtual const std::string &	getWindowTitle () const =0

virtual void	setPosition (int x, int y, int display)=0
	Moves the window to a position in logical units on the given display.

virtual void	getPosition (int &x, int &y, int &display)=0
	Reads the current window position and display index.

virtual void	minimize ()=0
	Minimizes / maximizes / restores the window.

virtual void	maximize ()=0

virtual void	restore ()=0

virtual bool	isMaximized () const =0

virtual bool	isMinimized () const =0

virtual bool	hasFocus () const =0
	True when the window has keyboard focus.

virtual bool	hasMouseFocus () const =0
	True when the window has mouse focus.

virtual bool	isVisible () const =0

virtual void	setVSync (int vsync)=0
	Enables/disables vertical sync (0 = off, 1 = on).

virtual int	getVSync () const =0

virtual int	getPixelWidth () const =0
	Framebuffer (pixel) dimensions of the window.

virtual int	getPixelHeight () const =0

virtual double	getDPIScale () const =0
	Current UI/logical DPI scale (1.0 on non-retina displays).

virtual double	getNativeDPIScale () const =0
	Native DPI scale reported by the OS for this window.

virtual void	windowToPixelCoords (double x, double y) const =0
	Converts window logical coordinates to framebuffer pixel coordinates.

virtual void	pixelToWindowCoords (double x, double y) const =0
	Converts framebuffer pixel coordinates to window logical coordinates.

virtual void	windowToDPICoords (double x, double y) const =0
	Converts window logical coordinates to UI-DPI coordinates.

virtual void	DPIToWindowCoords (double x, double y) const =0
	Converts UI-DPI coordinates to window logical coordinates.

virtual double	toPixels (double x) const =0
	Scales a logical length to UI pixels (and back).

virtual double	fromPixels (double x) const =0

virtual void	toPixelsXY (double wx, double wy, double &px, double &py) const =0
	Vector variants of the coordinate conversions above.

virtual void	fromPixelsXY (double px, double py, double &wx, double &wy) const =0

virtual void *	getHandle () const =0
	Native window handle (SDL_Window* on SDL backend).

virtual int	getDisplayCount () const =0
	Number of displays attached to the system.

virtual std::string	getDisplayName (int display) const =0
	Human-readable display name for a display index.

virtual std::string	getDisplayOrientation (int display) const =0
	Display orientation string (e.g. "landscape").

virtual std::vector< WindowSize >	getFullscreenSizes (int display) const =0
	Fullscreen sizes supported by a display.

virtual void	getDesktopDimensions (int display, int &width, int &height) const =0
	Desktop resolution of a display.

virtual bool	showMessageBox (const std::string &title, const std::string &message, const std::string &type, bool attachToWindow)=0
	Shows a modal message box ("info", "warning", or "error").

virtual int	showMessageBoxData (const MessageBoxData &data)=0
	Shows a configurable message box; returns the pressed button index.

virtual void	requestAttention (bool continuous)=0
	Requests OS attention (flashing taskbar); continuous repeats until focused.

virtual bool	setIconRGBA (const uint8_t *rgba, int width, int height)=0
	Sets the window icon from tightly packed RGBA8 pixels (wh4 bytes).

Public 成员函数继承自 eve::Module
virtual	~Module ()

virtual std::string	getName () const =0

详细描述

Platform window interface (SDL implementation on desktop/mobile). Script: win <- eve.Window();

在文件 Window.h 第 46 行定义.

构造及析构函数说明

◆ ~Window()

virtual eve::window::Window::~Window ( )

inlinevirtual

被 eve::window::sdl::Window 重载.

在文件 Window.h 第 67 行定义.

成员函数说明

◆ close()

virtual void eve::window::Window::close ( )

pure virtual

Closes and destroys the underlying window.

在 eve::window::sdl::Window 内被实现.

◆ DPIToWindowCoords()

virtual void eve::window::Window::DPIToWindowCoords	(	double *	x,
		double *	y
	)		const

pure virtual

Converts UI-DPI coordinates to window logical coordinates.

在 eve::window::sdl::Window 内被实现.

◆ fromPixels()

virtual double eve::window::Window::fromPixels ( double x ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ fromPixelsXY()

virtual void eve::window::Window::fromPixelsXY	(	double	px,
		double	py,
		double &	wx,
		double &	wy
	)		const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getDesktopDimensions()

virtual void eve::window::Window::getDesktopDimensions	(	int	display,
		int &	width,
		int &	height
	)		const

pure virtual

Desktop resolution of a display.

在 eve::window::sdl::Window 内被实现.

◆ getDisplayCount()

virtual int eve::window::Window::getDisplayCount ( ) const

pure virtual

Number of displays attached to the system.

在 eve::window::sdl::Window 内被实现.

◆ getDisplayName()

virtual std::string eve::window::Window::getDisplayName ( int display ) const

pure virtual

Human-readable display name for a display index.

在 eve::window::sdl::Window 内被实现.

◆ getDisplayOrientation()

virtual std::string eve::window::Window::getDisplayOrientation ( int display ) const

pure virtual

Display orientation string (e.g. "landscape").

在 eve::window::sdl::Window 内被实现.

◆ getDPIScale()

virtual double eve::window::Window::getDPIScale ( ) const

pure virtual

Current UI/logical DPI scale (1.0 on non-retina displays).

在 eve::window::sdl::Window 内被实现.

◆ getFullscreenSizes()

virtual std::vector< WindowSize > eve::window::Window::getFullscreenSizes ( int display ) const

pure virtual

Fullscreen sizes supported by a display.

在 eve::window::sdl::Window 内被实现.

◆ getHandle()

virtual void * eve::window::Window::getHandle ( ) const

pure virtual

Native window handle (SDL_Window* on SDL backend).

在 eve::window::sdl::Window 内被实现.

◆ getHeight()

virtual int eve::window::Window::getHeight ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getNativeDPIScale()

virtual double eve::window::Window::getNativeDPIScale ( ) const

pure virtual

Native DPI scale reported by the OS for this window.

在 eve::window::sdl::Window 内被实现.

◆ getPixelHeight()

virtual int eve::window::Window::getPixelHeight ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getPixelWidth()

virtual int eve::window::Window::getPixelWidth ( ) const

pure virtual

Framebuffer (pixel) dimensions of the window.

在 eve::window::sdl::Window 内被实现.

◆ getPosition()

virtual void eve::window::Window::getPosition	(	int &	x,
		int &	y,
		int &	display
	)

pure virtual

Reads the current window position and display index.

在 eve::window::sdl::Window 内被实现.

◆ getVSync()

virtual int eve::window::Window::getVSync ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getWidth()

virtual int eve::window::Window::getWidth ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getWindowSettings()

virtual WindowSettings eve::window::Window::getWindowSettings ( )

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ getWindowTitle()

virtual const std::string & eve::window::Window::getWindowTitle ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ hasFocus()

virtual bool eve::window::Window::hasFocus ( ) const

pure virtual

True when the window has keyboard focus.

在 eve::window::sdl::Window 内被实现.

◆ hasMouseFocus()

virtual bool eve::window::Window::hasMouseFocus ( ) const

pure virtual

True when the window has mouse focus.

在 eve::window::sdl::Window 内被实现.

◆ isMaximized()

virtual bool eve::window::Window::isMaximized ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ isMinimized()

virtual bool eve::window::Window::isMinimized ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ isOpen()

virtual bool eve::window::Window::isOpen ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ isVisible()

virtual bool eve::window::Window::isVisible ( ) const

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ maximize()

virtual void eve::window::Window::maximize ( )

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ minimize()

virtual void eve::window::Window::minimize ( )

pure virtual

Minimizes / maximizes / restores the window.

在 eve::window::sdl::Window 内被实现.

◆ Module_REG()

eve::window::Window::Module_REG ( Window )

◆ pixelToWindowCoords()

virtual void eve::window::Window::pixelToWindowCoords	(	double *	x,
		double *	y
	)		const

pure virtual

Converts framebuffer pixel coordinates to window logical coordinates.

在 eve::window::sdl::Window 内被实现.

◆ requestAttention()

virtual void eve::window::Window::requestAttention ( bool continuous )

pure virtual

Requests OS attention (flashing taskbar); continuous repeats until focused.

在 eve::window::sdl::Window 内被实现.

◆ restore()

virtual void eve::window::Window::restore ( )

pure virtual

在 eve::window::sdl::Window 内被实现.

◆ setFullscreenDesktop()

virtual bool eve::window::Window::setFullscreenDesktop ( bool fullscreen )

pure virtual

Switches between desktop fullscreen and windowed mode.

在 eve::window::sdl::Window 内被实现.

◆ setFullscreenExclusive()

virtual bool eve::window::Window::setFullscreenExclusive ( bool fullscreen )

pure virtual

Switches between exclusive fullscreen and windowed mode.

在 eve::window::sdl::Window 内被实现.

◆ setIconRGBA()

virtual bool eve::window::Window::setIconRGBA	(	const uint8_t *	rgba,
		int	width,
		int	height
	)

pure virtual

Sets the window icon from tightly packed RGBA8 pixels (w*h*4 bytes).

在 eve::window::sdl::Window 内被实现.

◆ setPosition()

virtual void eve::window::Window::setPosition	(	int	x,
		int	y,
		int	display
	)

pure virtual

Moves the window to a position in logical units on the given display.

在 eve::window::sdl::Window 内被实现.

◆ setSize()

virtual void eve::window::Window::setSize	(	int	width,
		int	height
	)

pure virtual

Requests a new logical window size.

在 eve::window::sdl::Window 内被实现.

◆ setVSync()

virtual void eve::window::Window::setVSync ( int vsync )

pure virtual

Enables/disables vertical sync (0 = off, 1 = on).

在 eve::window::sdl::Window 内被实现.

◆ setWindowSettings()

virtual bool eve::window::Window::setWindowSettings ( WindowSettings settings )

pure virtual

Applies a full WindowSettings struct (recreates the window when needed).

在 eve::window::sdl::Window 内被实现.

◆ setWindowTitle()

virtual void eve::window::Window::setWindowTitle ( const std::string & title )

pure virtual

Sets the window title shown in the OS title bar.

在 eve::window::sdl::Window 内被实现.

◆ showMessageBox()

virtual bool eve::window::Window::showMessageBox	(	const std::string &	title,
		const std::string &	message,
		const std::string &	type,
		bool	attachToWindow
	)

pure virtual

Shows a modal message box ("info", "warning", or "error").

在 eve::window::sdl::Window 内被实现.

◆ showMessageBoxData()

virtual int eve::window::Window::showMessageBoxData ( const MessageBoxData & data )

pure virtual

Shows a configurable message box; returns the pressed button index.

在 eve::window::sdl::Window 内被实现.

◆ toPixels()

virtual double eve::window::Window::toPixels ( double x ) const

pure virtual

Scales a logical length to UI pixels (and back).

在 eve::window::sdl::Window 内被实现.

◆ toPixelsXY()

virtual void eve::window::Window::toPixelsXY	(	double	wx,
		double	wy,
		double &	px,
		double &	py
	)		const

pure virtual

Vector variants of the coordinate conversions above.

在 eve::window::sdl::Window 内被实现.

◆ windowToDPICoords()

virtual void eve::window::Window::windowToDPICoords	(	double *	x,
		double *	y
	)		const

pure virtual

Converts window logical coordinates to UI-DPI coordinates.

在 eve::window::sdl::Window 内被实现.

◆ windowToPixelCoords()

virtual void eve::window::Window::windowToPixelCoords	(	double *	x,
		double *	y
	)		const

pure virtual

Converts window logical coordinates to framebuffer pixel coordinates.

在 eve::window::sdl::Window 内被实现.

该类的文档由以下文件生成:

src/modules/window/Window.h

类

Public 成员函数

详细描述

构造及析构函数说明

◆ ~Window()

成员函数说明

◆ close()

◆ DPIToWindowCoords()

◆ fromPixels()

◆ fromPixelsXY()

◆ getDesktopDimensions()

◆ getDisplayCount()

◆ getDisplayName()

◆ getDisplayOrientation()

◆ getDPIScale()

◆ getFullscreenSizes()

◆ getHandle()

◆ getHeight()

◆ getNativeDPIScale()

◆ getPixelHeight()

◆ getPixelWidth()

◆ getPosition()

◆ getVSync()

◆ getWidth()

◆ getWindowSettings()

◆ getWindowTitle()

◆ hasFocus()

◆ hasMouseFocus()

◆ isMaximized()

◆ isMinimized()

◆ isOpen()

◆ isVisible()

◆ maximize()

◆ minimize()

◆ Module_REG()

◆ pixelToWindowCoords()

◆ requestAttention()

◆ restore()

◆ setFullscreenDesktop()

◆ setFullscreenExclusive()

◆ setIconRGBA()

◆ setPosition()

◆ setSize()

◆ setVSync()

◆ setWindowSettings()

◆ setWindowTitle()

◆ showMessageBox()

◆ showMessageBoxData()

◆ toPixels()

◆ toPixelsXY()

◆ windowToDPICoords()

◆ windowToPixelCoords()