AppGLFW.cpp File Reference

App::run implementation from App.h for the GLFW platform. More...

#include <App.h>
#include <SLGLState.h>
#include <SLEnums.h>
#include <SLInterface.h>
#include <AppCommon.h>
#include <SLAssetManager.h>
#include <SLScene.h>
#include <SLSceneView.h>
#include <CVCapture.h>
#include <Profiler.h>
#include <SLAssetLoader.h>
#include <GLFW/glfw3.h>

Include dependency graph for AppGLFW.cpp:

Go to the source code of this file.

Macros
#define	GLFW_INCLUDE_NONE

Functions
static SLbool	onPaint ()
	Static paint function that gets called once every frame. More...
static void	onGLFWError (int error, const char *description)
static void	onResize (GLFWwindow *myWindow, int width, int height)
static void	onMouseButton (GLFWwindow *myWindow, int button, int action, int mods)
static void	onMouseMove (GLFWwindow *myWindow, double x, double y)
static void	onMouseWheel (GLFWwindow *myWindow, double xscroll, double yscroll)
static void	onKey (GLFWwindow *myWindow, int GLFWKey, int scancode, int action, int mods)
static void	onCharInput (GLFWwindow *, SLuint c)
	Event handler for GLFW character input. More...
static void	onClose (GLFWwindow *myWindow)
static SLKey	mapKeyToSLKey (int key)
	Maps the GLFW key codes to the SLKey codes. More...

Variables
static GLFWwindow *	window
	The global glfw window handle. More...
static SLint	svIndex
	Scene view index. More...
static SLint	scrWidth
	Window width at start up. More...
static SLint	scrHeight
	Window height at start up. More...
static SLfloat	contentScaleX
	Content scale in X direction. More...
static SLfloat	contentScaleY
	Content scale in Y direction. More...
static SLint	dpi = 142
	Dot per inch resolution of screen. More...
static SLbool	fixAspectRatio = false
	Flag if wnd aspect ratio should be fixed. More...
static SLint	startX
	start position x in pixels More...
static SLint	startY
	start position y in pixels More...
static SLint	mouseX
	Last mouse position x in pixels. More...
static SLint	mouseY
	Last mouse position y in pixels. More...
static SLint	lastWidth
	Last window width in pixels. More...
static SLint	lastHeight
	Last window height in pixels. More...
static SLfloat	lastMouseDownTime = 0.0f
	Last mouse press time. More...
static SLKey	modifiers = K_none
	last modifier keys More...
static SLbool	fullscreen = false
	flag if window is in fullscreen mode More...
static SLVec2i	windowPosBeforeFullscreen
	Window position before entering fullscreen mode. More...

Detailed Description

App::run implementation from App.h for the GLFW platform.

The functions implement mostly the callbacks for the platform independent OpenGL window framework for desktop OS. For more info on how to create a new app with SLProject see: https://github.com/cpvrlab/SLProject4/wiki/Creating-a-New-App For more info about App framework see: https://cpvrlab.github.io/SLProject4/app-framework.html

Date

June 2024

Authors

Marino von Wattenwyl

Copyright

http://opensource.org/licenses/GPL-3.0

Remarks

Please use clangformat to format the code. See more code style on https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style

Definition in file AppGLFW.cpp.

Macro Definition Documentation

GLFW_INCLUDE_NONE

#define GLFW_INCLUDE_NONE

Definition at line 29 of file AppGLFW.cpp.

Function Documentation

mapKeyToSLKey()

static SLKey mapKeyToSLKey ( int  key )

static

Maps the GLFW key codes to the SLKey codes.

Definition at line 504 of file AppGLFW.cpp.

{
    switch (key)
    {
        case GLFW_KEY_SPACE: return K_space;
        case GLFW_KEY_ESCAPE: return K_esc;
        case GLFW_KEY_F1: return K_F1;
        case GLFW_KEY_F2: return K_F2;
        case GLFW_KEY_F3: return K_F3;
        case GLFW_KEY_F4: return K_F4;
        case GLFW_KEY_F5: return K_F5;
        case GLFW_KEY_F6: return K_F6;
        case GLFW_KEY_F7: return K_F7;
        case GLFW_KEY_F8: return K_F8;
        case GLFW_KEY_F9: return K_F9;
        case GLFW_KEY_F10: return K_F10;
        case GLFW_KEY_F11: return K_F11;
        case GLFW_KEY_F12: return K_F12;
        case GLFW_KEY_UP: return K_up;
        case GLFW_KEY_DOWN: return K_down;
        case GLFW_KEY_LEFT: return K_left;
        case GLFW_KEY_RIGHT: return K_right;
        case GLFW_KEY_LEFT_SHIFT:
        case GLFW_KEY_RIGHT_SHIFT: return K_shift;
        case GLFW_KEY_LEFT_CONTROL:
        case GLFW_KEY_RIGHT_CONTROL: return K_ctrl;
        case GLFW_KEY_LEFT_ALT:
        case GLFW_KEY_RIGHT_ALT: return K_alt;
        case GLFW_KEY_LEFT_SUPER:
        case GLFW_KEY_RIGHT_SUPER: return K_super; // Apple command key
        case GLFW_KEY_TAB: return K_tab;
        case GLFW_KEY_ENTER: return K_enter;
        case GLFW_KEY_BACKSPACE: return K_backspace;
        case GLFW_KEY_INSERT: return K_insert;
        case GLFW_KEY_DELETE: return K_delete;
        case GLFW_KEY_PAGE_UP: return K_pageUp;
        case GLFW_KEY_PAGE_DOWN: return K_pageDown;
        case GLFW_KEY_HOME: return K_home;
        case GLFW_KEY_END: return K_end;
        case GLFW_KEY_KP_0: return K_NP0;
        case GLFW_KEY_KP_1: return K_NP1;
        case GLFW_KEY_KP_2: return K_NP2;
        case GLFW_KEY_KP_3: return K_NP3;
        case GLFW_KEY_KP_4: return K_NP4;
        case GLFW_KEY_KP_5: return K_NP5;
        case GLFW_KEY_KP_6: return K_NP6;
        case GLFW_KEY_KP_7: return K_NP7;
        case GLFW_KEY_KP_8: return K_NP8;
        case GLFW_KEY_KP_9: return K_NP9;
        case GLFW_KEY_KP_DIVIDE: return K_NPDivide;
        case GLFW_KEY_KP_MULTIPLY: return K_NPMultiply;
        case GLFW_KEY_KP_SUBTRACT: return K_NPSubtract;
        case GLFW_KEY_KP_ADD: return K_NPAdd;
        case GLFW_KEY_KP_DECIMAL: return K_NPDecimal;
        case GLFW_KEY_UNKNOWN: return K_none;
        default: break;
    }
    return (SLKey)key;
}

onCharInput()

void onCharInput ( GLFWwindow *  , SLuint  c  )

static

Event handler for GLFW character input.

Definition at line 489 of file AppGLFW.cpp.

{
    slCharInput(svIndex, c);
}

onClose()

void onClose ( GLFWwindow *  myWindow )

static

onClose event handler for deallocation of the scene & sceneview. onClose is called glfwPollEvents, glfwWaitEvents or glfwSwapBuffers.

Definition at line 498 of file AppGLFW.cpp.

{
    slShouldClose(true);
}

onGLFWError()

static void onGLFWError ( int  error, const char *  description  )

static

Error callback handler for GLFW.

Definition at line 256 of file AppGLFW.cpp.

{
    fputs(description, stderr);
}

onKey()

static void onKey ( GLFWwindow *  myWindow, int  GLFWKey, int  scancode, int  action, int  mods  )

static

Key event handler sets the modifier key state & forwards the event to the slKeyPress/slKeyRelease functions.

Definition at line 420 of file AppGLFW.cpp.

{
    SLKey key = mapKeyToSLKey(GLFWKey);
 
    // Do not handle key events if scene is being loaded.
    if (!AppCommon::scene) return;
 
    if (action == GLFW_PRESS)
    {
        switch (key)
        {
            case K_ctrl: modifiers = (SLKey)(modifiers | K_ctrl); return;
            case K_alt: modifiers = (SLKey)(modifiers | K_alt); return;
            case K_shift: modifiers = (SLKey)(modifiers | K_shift); return;
            default: break;
        }
    }
    else if (action == GLFW_RELEASE)
    {
        switch (key)
        {
            case K_ctrl: modifiers = (SLKey)(modifiers ^ K_ctrl); return;
            case K_alt: modifiers = (SLKey)(modifiers ^ K_alt); return;
            case K_shift: modifiers = (SLKey)(modifiers ^ K_shift); return;
            default: break;
        }
    }
 
    // Special treatment for ESC key
    if (key == K_esc && action == GLFW_RELEASE && fullscreen)
    {
        fullscreen = false;
        glfwSetWindowSize(myWindow, scrWidth, scrHeight);
        glfwSetWindowPos(myWindow, windowPosBeforeFullscreen.x, windowPosBeforeFullscreen.y);
    }
 
    // Toggle fullscreen mode
    if (key == K_F9 && action == GLFW_PRESS)
    {
        fullscreen = !fullscreen;
 
        if (fullscreen)
        {
            GLFWmonitor*       primary = glfwGetPrimaryMonitor();
            const GLFWvidmode* mode    = glfwGetVideoMode(primary);
            glfwSetWindowSize(myWindow, mode->width, mode->height);
            glfwGetWindowPos(myWindow, &windowPosBeforeFullscreen.x, &windowPosBeforeFullscreen.y);
            glfwSetWindowPos(myWindow, 0, 0);
        }
        else
        {
            glfwSetWindowSize(myWindow, scrWidth, scrHeight);
            glfwSetWindowPos(myWindow, windowPosBeforeFullscreen.x, windowPosBeforeFullscreen.y);
        }
 
        return;
    }
 
    if (action == GLFW_PRESS)
        slKeyPress(svIndex, key, modifiers);
    else if (action == GLFW_RELEASE)
        slKeyRelease(svIndex, key, modifiers);
}

onMouseButton()

static void onMouseButton ( GLFWwindow *  myWindow, int  button, int  action, int  mods  )

static

Mouse button event handler forwards the events to the slMouseDown or slMouseUp. Two finger touches of touch devices are simulated with ALT & CTRL modifiers.

Definition at line 300 of file AppGLFW.cpp.

{
    SLint x = mouseX;
    SLint y = mouseY;
    startX  = x;
    startY  = y;
 
    // Translate modifiers
    modifiers = K_none;
    if ((uint)mods & (uint)GLFW_MOD_SHIFT) modifiers = (SLKey)(modifiers | K_shift);
    if ((uint)mods & (uint)GLFW_MOD_CONTROL) modifiers = (SLKey)(modifiers | K_ctrl);
    if ((uint)mods & (uint)GLFW_MOD_ALT) modifiers = (SLKey)(modifiers | K_alt);
 
    if (action == GLFW_PRESS)
    {
        SLfloat mouseDeltaTime = (SLfloat)glfwGetTime() - lastMouseDownTime;
        lastMouseDownTime      = (SLfloat)glfwGetTime();
 
        // handle double click
        if (mouseDeltaTime < 0.3f)
        {
            switch (button)
            {
                case GLFW_MOUSE_BUTTON_LEFT:
                    slDoubleClick(svIndex, MB_left, x, y, modifiers);
                    break;
                case GLFW_MOUSE_BUTTON_RIGHT:
                    slDoubleClick(svIndex, MB_right, x, y, modifiers);
                    break;
                case GLFW_MOUSE_BUTTON_MIDDLE:
                    slDoubleClick(svIndex, MB_middle, x, y, modifiers);
                    break;
                default: break;
            }
        }
        else // normal mouse clicks
        {
            switch (button)
            {
                case GLFW_MOUSE_BUTTON_LEFT:
                    if (modifiers & K_alt && modifiers & K_ctrl)
                        slTouch2Down(svIndex, x - 20, y, x + 20, y);
                    else
                        slMouseDown(svIndex, MB_left, x, y, modifiers);
                    break;
                case GLFW_MOUSE_BUTTON_RIGHT:
                    slMouseDown(svIndex, MB_right, x, y, modifiers);
                    break;
                case GLFW_MOUSE_BUTTON_MIDDLE:
                    slMouseDown(svIndex, MB_middle, x, y, modifiers);
                    break;
                default: break;
            }
        }
    }
    else
    { // flag end of mouse click for long touches
        startX = -1;
        startY = -1;
 
        switch (button)
        {
            case GLFW_MOUSE_BUTTON_LEFT:
                slMouseUp(svIndex, MB_left, x, y, modifiers);
                break;
            case GLFW_MOUSE_BUTTON_RIGHT:
                slMouseUp(svIndex, MB_right, x, y, modifiers);
                break;
            case GLFW_MOUSE_BUTTON_MIDDLE:
                slMouseUp(svIndex, MB_middle, x, y, modifiers);
                break;
            default: break;
        }
    }
}

onMouseMove()

static void onMouseMove ( GLFWwindow *  myWindow, double  x, double  y  )

static

Mouse move event handler forwards the events to slMouseMove or slTouch2Move.

Definition at line 382 of file AppGLFW.cpp.

{
    // x & y are in screen coords.
    mouseX = (int)x;
    mouseY = (int)y;
 
    if (modifiers & K_alt && modifiers & K_ctrl)
        slTouch2Move(svIndex,
                     (int)(x - 20),
                     (int)y,
                     (int)(x + 20),
                     (int)y);
    else
        slMouseMove(svIndex,
                    (int)x,
                    (int)y);
}

onMouseWheel()

static void onMouseWheel ( GLFWwindow *  myWindow, double  xscroll, double  yscroll  )

static

Mouse wheel event handler forwards the events to slMouseWheel

Definition at line 405 of file AppGLFW.cpp.

{
    // make sure the delta is at least one integer
    int dY = (int)yscroll;
    if (dY == 0) dY = (int)(Utils::sign(yscroll));
 
    slMouseWheel(svIndex, dY, modifiers);
}

onPaint()

static SLbool onPaint ( )

static

Static paint function that gets called once every frame.

Definition at line 222 of file AppGLFW.cpp.

{
    PROFILE_SCOPE("AppGLFW::onPaint");
 
    if (AppCommon::sceneViews.empty())
        return false;
 
    SLSceneView* sv = AppCommon::sceneViews[svIndex];
 
    if (AppCommon::sceneToLoad)
    {
        slSwitchScene(sv, *AppCommon::sceneToLoad);
        AppCommon::sceneToLoad = {}; // sets optional to empty
    }
 
    if (AppCommon::assetLoader->isLoading())
        AppCommon::assetLoader->checkIfAsyncLoadingIsDone();
 
    ////////////////////////////////////////////////////////////////
    SLbool appNeedsUpdate  = App::config.onUpdate && App::config.onUpdate(sv);
    SLbool jobIsRunning    = slUpdateParallelJob();
    SLbool isLoading       = AppCommon::assetLoader->isLoading();
    SLbool viewNeedsUpdate = slPaintAllViews();
    ////////////////////////////////////////////////////////////////
 
    // Fast copy the back buffer to the front buffer. This is OS dependent.
    glfwSwapBuffers(window);
 
    return appNeedsUpdate || viewNeedsUpdate || jobIsRunning || isLoading;
}

onResize()

static void onResize ( GLFWwindow *  myWindow, int  width, int  height  )

static

onResize: Event handler called on the resize event of the window. This event should called once before the onPaint event.

Definition at line 265 of file AppGLFW.cpp.

{
    if (AppCommon::sceneViews.empty()) return;
    SLSceneView* sv = AppCommon::sceneViews[svIndex];
 
    if (fixAspectRatio)
    {
        float aspectRatio = (float)width / (float)height;
 
        // correct target width and height
        if ((float)height * aspectRatio <= (float)width)
        {
            width  = (int)((float)height * aspectRatio);
            height = (int)((float)width / aspectRatio);
        }
        else
        {
            height = (int)((float)width / aspectRatio);
            width  = (int)((float)height * aspectRatio);
        }
    }
 
    lastWidth  = width;
    lastHeight = height;
 
    // width & height are in screen coords.
    slResize(svIndex, width, height);
 
    onPaint();
}

Variable Documentation

contentScaleX

SLfloat contentScaleX

static

Content scale in X direction.

Definition at line 39 of file AppGLFW.cpp.

contentScaleY

SLfloat contentScaleY

static

Content scale in Y direction.

Definition at line 40 of file AppGLFW.cpp.

dpi

SLint dpi = 142

static

Dot per inch resolution of screen.

Definition at line 41 of file AppGLFW.cpp.

fixAspectRatio

SLbool fixAspectRatio = false

static

Flag if wnd aspect ratio should be fixed.

Definition at line 42 of file AppGLFW.cpp.

fullscreen

SLbool fullscreen = false

static

flag if window is in fullscreen mode

Definition at line 51 of file AppGLFW.cpp.

lastHeight

SLint lastHeight

static

Last window height in pixels.

Definition at line 48 of file AppGLFW.cpp.

lastMouseDownTime

SLfloat lastMouseDownTime = 0.0f

static

Last mouse press time.

Definition at line 49 of file AppGLFW.cpp.

lastWidth

SLint lastWidth

static

Last window width in pixels.

Definition at line 47 of file AppGLFW.cpp.

modifiers

SLKey modifiers = K_none

static

last modifier keys

Definition at line 50 of file AppGLFW.cpp.

mouseX

SLint mouseX

static

Last mouse position x in pixels.

Definition at line 45 of file AppGLFW.cpp.

mouseY

SLint mouseY

static

Last mouse position y in pixels.

Definition at line 46 of file AppGLFW.cpp.

scrHeight

SLint scrHeight

static

Window height at start up.

Definition at line 38 of file AppGLFW.cpp.

scrWidth

SLint scrWidth

static

Window width at start up.

Definition at line 37 of file AppGLFW.cpp.

startX

SLint startX

static

start position x in pixels

Definition at line 43 of file AppGLFW.cpp.

startY

SLint startY

static

start position y in pixels

Definition at line 44 of file AppGLFW.cpp.

svIndex

SLint svIndex

static

Scene view index.

Definition at line 36 of file AppGLFW.cpp.

window

GLFWwindow* window

static

The global glfw window handle.

Definition at line 35 of file AppGLFW.cpp.

windowPosBeforeFullscreen

SLVec2i windowPosBeforeFullscreen

static

Window position before entering fullscreen mode.

Definition at line 52 of file AppGLFW.cpp.