#include <gfx_window_manager_api.h>

Inheritance diagram for Fast::GfxWindowBackend:

Public Member Functions
virtual	~GfxWindowBackend ()=default

virtual void	Init (const char gameName, const char apiName, bool startFullScreen, uint32_t width, uint32_t height, int32_t posX, int32_t posY)=0

virtual void	Close ()=0

virtual void	SetKeyboardCallbacks (bool(mOnKeyDown)(int scancode), bool(mOnKeyUp)(int scancode), void(*mOnAllKeysUp)())=0

virtual void	SetMouseCallbacks (bool(mOnMouseButtonDown)(int btn), bool(mOnMouseButtonUp)(int btn))=0

virtual void	SetFullscreenChangedCallback (void(*mOnFullscreenChanged)(bool is_now_fullscreen))=0

virtual void	SetFullscreen (bool fullscreen)=0

virtual void	GetActiveWindowRefreshRate (uint32_t *refreshRate)=0

virtual void	SetCursorVisibility (bool visability)=0

virtual void	SetMousePos (int32_t posX, int32_t posY)=0

virtual void	GetMousePos (int32_t x, int32_t y)=0

virtual void	GetMouseDelta (int32_t x, int32_t y)=0

virtual void	GetMouseWheel (float x, float y)=0

virtual bool	GetMouseState (uint32_t btn)=0

virtual void	SetMouseCapture (bool capture)=0

virtual bool	IsMouseCaptured ()=0

virtual void	GetDimensions (uint32_t width, uint32_t height, int32_t posX, int32_t posY)=0

virtual void	SetDimensions (uint32_t width, uint32_t height, int32_t posX, int32_t posY)=0

virtual Ship::WindowRect	GetPrimaryMonitorRect ()=0

virtual void	HandleEvents ()=0

virtual bool	IsFrameReady ()=0

virtual void	SwapBuffersBegin ()=0

virtual void	SwapBuffersEnd ()=0

virtual double	GetTime ()=0

virtual int	GetTargetFps ()=0

virtual void	SetTargetFps (int fps)=0

virtual void	SetMaxFrameLatency (int latency)=0

virtual const char *	GetKeyName (int scancode)=0

virtual bool	CanDisableVsync ()=0

virtual bool	IsRunning ()=0

virtual void	Destroy ()=0

virtual bool	IsFullscreen ()=0

Protected Attributes
void(*	mOnFullscreenChanged )(bool isNowFullscreen)

bool(*	mOnKeyDown )(int scancode)

bool(*	mOnKeyUp )(int scancode)

bool(*	mOnMouseButtonDown )(int btn)

bool(*	mOnMouseButtonUp )(int btn)

uint32_t	mTargetFps = 60

bool	mFullScreen

bool	mIsRunning = true

bool	mVsyncEnabled = true

Constructor & Destructor Documentation

◆ ~GfxWindowBackend()

virtual Fast::GfxWindowBackend::~GfxWindowBackend ( )

virtualdefault

Member Function Documentation

◆ CanDisableVsync()

virtual bool Fast::GfxWindowBackend::CanDisableVsync ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ Close()

virtual void Fast::GfxWindowBackend::Close ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ Destroy()

virtual void Fast::GfxWindowBackend::Destroy ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetActiveWindowRefreshRate()

virtual void Fast::GfxWindowBackend::GetActiveWindowRefreshRate ( uint32_t * refreshRate )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetDimensions()

virtual void Fast::GfxWindowBackend::GetDimensions	(	uint32_t *	width,
		uint32_t *	height,
		int32_t *	posX,
		int32_t *	posY
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetKeyName()

virtual const char * Fast::GfxWindowBackend::GetKeyName ( int scancode )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetMouseDelta()

virtual void Fast::GfxWindowBackend::GetMouseDelta	(	int32_t *	x,
		int32_t *	y
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetMousePos()

virtual void Fast::GfxWindowBackend::GetMousePos	(	int32_t *	x,
		int32_t *	y
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetMouseState()

virtual bool Fast::GfxWindowBackend::GetMouseState ( uint32_t btn )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetMouseWheel()

virtual void Fast::GfxWindowBackend::GetMouseWheel	(	float *	x,
		float *	y
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetPrimaryMonitorRect()

virtual Ship::WindowRect Fast::GfxWindowBackend::GetPrimaryMonitorRect ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetTargetFps()

virtual int Fast::GfxWindowBackend::GetTargetFps ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ GetTime()

virtual double Fast::GfxWindowBackend::GetTime ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ HandleEvents()

virtual void Fast::GfxWindowBackend::HandleEvents ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ Init()

virtual void Fast::GfxWindowBackend::Init	(	const char *	gameName,
		const char *	apiName,
		bool	startFullScreen,
		uint32_t	width,
		uint32_t	height,
		int32_t	posX,
		int32_t	posY
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ IsFrameReady()

virtual bool Fast::GfxWindowBackend::IsFrameReady ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ IsFullscreen()

virtual bool Fast::GfxWindowBackend::IsFullscreen ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ IsMouseCaptured()

virtual bool Fast::GfxWindowBackend::IsMouseCaptured ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ IsRunning()

virtual bool Fast::GfxWindowBackend::IsRunning ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetCursorVisibility()

virtual void Fast::GfxWindowBackend::SetCursorVisibility ( bool visability )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetDimensions()

virtual void Fast::GfxWindowBackend::SetDimensions	(	uint32_t	width,
		uint32_t	height,
		int32_t	posX,
		int32_t	posY
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetFullscreen()

virtual void Fast::GfxWindowBackend::SetFullscreen ( bool fullscreen )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetFullscreenChangedCallback()

virtual void Fast::GfxWindowBackend::SetFullscreenChangedCallback ( void(*)(bool is_now_fullscreen) mOnFullscreenChanged )

pure virtual

Implemented in Fast::GfxWindowBackendSDL2, and Fast::GfxWindowBackendDXGI.

◆ SetKeyboardCallbacks()

virtual void Fast::GfxWindowBackend::SetKeyboardCallbacks	(	bool(*)(int scancode)	mOnKeyDown,
		bool(*)(int scancode)	mOnKeyUp,
		void(*)()	mOnAllKeysUp
	)

pure virtual

Implemented in Fast::GfxWindowBackendSDL2, and Fast::GfxWindowBackendDXGI.

◆ SetMaxFrameLatency()

virtual void Fast::GfxWindowBackend::SetMaxFrameLatency ( int latency )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetMouseCallbacks()

virtual void Fast::GfxWindowBackend::SetMouseCallbacks	(	bool(*)(int btn)	mOnMouseButtonDown,
		bool(*)(int btn)	mOnMouseButtonUp
	)

pure virtual

Implemented in Fast::GfxWindowBackendSDL2, and Fast::GfxWindowBackendDXGI.

◆ SetMouseCapture()

virtual void Fast::GfxWindowBackend::SetMouseCapture ( bool capture )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetMousePos()

virtual void Fast::GfxWindowBackend::SetMousePos	(	int32_t	posX,
		int32_t	posY
	)

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SetTargetFps()

virtual void Fast::GfxWindowBackend::SetTargetFps ( int fps )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SwapBuffersBegin()

virtual void Fast::GfxWindowBackend::SwapBuffersBegin ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

◆ SwapBuffersEnd()

virtual void Fast::GfxWindowBackend::SwapBuffersEnd ( )

pure virtual

Implemented in Fast::GfxWindowBackendDXGI, and Fast::GfxWindowBackendSDL2.

Member Data Documentation

◆ mFullScreen

bool Fast::GfxWindowBackend::mFullScreen

protected

◆ mIsRunning

bool Fast::GfxWindowBackend::mIsRunning = true

protected

◆ mOnFullscreenChanged

void(* Fast::GfxWindowBackend::mOnFullscreenChanged) (bool isNowFullscreen)

protected

◆ mOnKeyDown

bool(* Fast::GfxWindowBackend::mOnKeyDown) (int scancode)

protected

◆ mOnKeyUp

bool(* Fast::GfxWindowBackend::mOnKeyUp) (int scancode)

protected

◆ mOnMouseButtonDown

bool(* Fast::GfxWindowBackend::mOnMouseButtonDown) (int btn)

protected

◆ mOnMouseButtonUp

bool(* Fast::GfxWindowBackend::mOnMouseButtonUp) (int btn)

protected

◆ mTargetFps

uint32_t Fast::GfxWindowBackend::mTargetFps = 60

protected

◆ mVsyncEnabled

bool Fast::GfxWindowBackend::mVsyncEnabled = true

protected

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

include/fast/backends/gfx_window_manager_api.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ ~GfxWindowBackend()

Member Function Documentation

◆ CanDisableVsync()

◆ Close()

◆ Destroy()

◆ GetActiveWindowRefreshRate()

◆ GetDimensions()

◆ GetKeyName()

◆ GetMouseDelta()

◆ GetMousePos()

◆ GetMouseState()

◆ GetMouseWheel()

◆ GetPrimaryMonitorRect()

◆ GetTargetFps()

◆ GetTime()

◆ HandleEvents()

◆ Init()

◆ IsFrameReady()

◆ IsFullscreen()

◆ IsMouseCaptured()

◆ IsRunning()

◆ SetCursorVisibility()

◆ SetDimensions()

◆ SetFullscreen()

◆ SetFullscreenChangedCallback()

◆ SetKeyboardCallbacks()

◆ SetMaxFrameLatency()

◆ SetMouseCallbacks()

◆ SetMouseCapture()

◆ SetMousePos()

◆ SetTargetFps()

◆ SwapBuffersBegin()

◆ SwapBuffersEnd()

Member Data Documentation

◆ mFullScreen

◆ mIsRunning

◆ mOnFullscreenChanged

◆ mOnKeyDown

◆ mOnKeyUp

◆ mOnMouseButtonDown

◆ mOnMouseButtonUp

◆ mTargetFps

◆ mVsyncEnabled