1 /* Copyright (C) 2021-2022 Harry Godden (hgn) - All Rights Reserved */
7 | | .---------------------------------------------------------.
8 |API| | vg_enter( int argc, char *argv[], const char *window_name |
9 | | '---------------------------------------------------------'
12 |IMP| vg_launch_opt(void) <--.
14 | | |'---------------'
16 | | |'-----------------------------------| 1 |------.
19 | | | |IMP| vg_preload(void)
22 | | | | |IMP| vg_load(void)
24 |IMP| | vg_framebuffer_resize(void) |
26 |IMP| | |.------------- vg_start(void) ---------------'
29 |IMP| | vg_update(void)
34 |IMP| | '- vg_update_fixed(void)
39 |IMP| | vg_update_post(void)
42 |IMP| | vg_render(void)
52 | | .-------------------------------------.
53 |API| | vg_fatal_exit_loop( const char *err ) |
54 | | '-------------------------------------'
59 |IMP| '- vg_framebuffer_resize(void)
69 VG_STATIC
void vg_enter( int argc
, char *argv
[], const char *window_name
);
72 VG_STATIC
void vg_preload(void);
73 VG_STATIC
void vg_load(void);
76 VG_STATIC
void vg_launch_opt(void);
77 VG_STATIC
void vg_start(void);
79 VG_STATIC
void vg_framebuffer_resize(int w
, int h
);
80 VG_STATIC
void vg_update(void);
81 VG_STATIC
void vg_update_fixed(void);
82 VG_STATIC
void vg_update_post(void);
84 VG_STATIC
void vg_render(void);
85 VG_STATIC
void vg_ui(void);
90 #include "vg_platform.h"
98 #include "dep/glad/glad.h"
99 #include "submodules/SDL/include/SDL.h"
100 #include "vg_stdint.h"
102 void vg_register_exit( void( *funcptr
)(void), const char *name
);
107 #include "vg_steam.h"
109 //#define VG_SYNC_DEBUG
111 #define VG_SYNC_LOG(STR,...) \
112 vg_info(STR,SDL_GetThreadID(NULL),##__VA_ARGS__)
114 #define VG_SYNC_LOG(...)
121 SDL_GLContext gl_context
;
123 SDL_SpinLock sl_context
;
124 SDL_sem
*sem_allow_exec
,
128 SDL_threadID thread_id_main
,
130 thread_id_with_opengl_context
;
131 int context_ownership_depth
;
137 k_engine_status_none
,
138 k_engine_status_running
,
139 k_engine_status_crashed
142 const char *str_const_engine_err
;
145 /* Window information */
166 int fixed_iterations
;
171 k_engine_stage_update
,
172 k_engine_stage_update_fixed
,
173 k_engine_stage_rendering
,
182 k_quality_profile_high
= 0,
183 k_quality_profile_low
= 1,
187 VG_STATIC vg
= { .time_rate
= 1.0 };
189 enum vg_thread_purpose
191 k_thread_purpose_nothing
,
192 k_thread_purpose_main
,
193 k_thread_purpose_loader
196 VG_STATIC
void vg_fatal_exit_loop( const char *error
);
199 * Checks if the engine is running
201 VG_STATIC
void _vg_ensure_engine_running(void)
203 /* Check if the engine is no longer running */
204 SDL_AtomicLock( &vg
.sl_context
);
205 enum engine_status status
= vg
.engine_status
;
206 SDL_AtomicUnlock( &vg
.sl_context
);
208 if( status
!= k_engine_status_running
)
212 VG_SYNC_LOG( "[%d] No longer running...\n");
218 VG_STATIC
enum vg_thread_purpose
vg_thread_purpose(void)
220 SDL_AtomicLock( &vg
.sl_context
);
222 if( vg
.thread_id_main
== SDL_GetThreadID(NULL
) )
224 SDL_AtomicUnlock( &vg
.sl_context
);
225 return k_thread_purpose_main
;
229 SDL_AtomicUnlock( &vg
.sl_context
);
230 return k_thread_purpose_loader
;
235 * Sync execution so that the OpenGL context is switched onto this thread.
236 * Anything after this call will be in a valid context.
238 VG_STATIC
void vg_acquire_thread_sync(void)
240 /* We dont want to do anything if this is the main thread */
242 if( vg_thread_purpose() == k_thread_purpose_loader
)
244 VG_SYNC_LOG( "[%d] vg_acquire_thread_sync()\n" );
245 _vg_ensure_engine_running();
247 SDL_AtomicLock( &vg
.sl_context
);
248 if( vg
.context_ownership_depth
== 0 )
250 vg
.context_ownership_depth
++;
252 SDL_AtomicUnlock( &vg
.sl_context
);
254 /* wait until told we can go */
255 VG_SYNC_LOG( "[%d] Waiting to acuire sync.\n" );
256 SDL_SemWait( vg
.sem_allow_exec
);
258 _vg_ensure_engine_running();
260 SDL_GL_MakeCurrent( vg
.window
, vg
.gl_context
);
261 VG_SYNC_LOG( "[%d] granted\n" );
265 vg
.context_ownership_depth
++;
266 VG_SYNC_LOG( "[%d] granted\n" );
267 SDL_AtomicUnlock( &vg
.sl_context
);
273 * Signify that we are done with the OpenGL context in this thread.
274 * Anything after this call will be in an undefined context.
276 VG_STATIC
void vg_release_thread_sync(void)
278 if( vg_thread_purpose() == k_thread_purpose_loader
)
280 VG_SYNC_LOG( "[%d] vg_release_thread_sync()\n" );
282 SDL_AtomicLock( &vg
.sl_context
);
283 vg
.context_ownership_depth
--;
285 if( vg
.context_ownership_depth
== 0 )
287 SDL_AtomicUnlock( &vg
.sl_context
);
288 VG_SYNC_LOG( "[%d] Releasing context.\n" );
289 SDL_GL_MakeCurrent( NULL
, NULL
);
290 SDL_SemPost( vg
.sem_exec_finished
);
293 SDL_AtomicUnlock( &vg
.sl_context
);
297 VG_STATIC
void _vg_run_synced(void)
299 SDL_AtomicLock( &vg
.sl_context
);
301 if( vg
.exec_context
!= 0 )
303 VG_SYNC_LOG( "[%d] _vg_run_synced() (%d).\n", vg
.exec_context
);
305 SDL_AtomicUnlock( &vg
.sl_context
);
307 /* allow operations to go */
308 SDL_GL_MakeCurrent( NULL
, NULL
);
309 SDL_SemPost( vg
.sem_allow_exec
);
311 /* wait for operations to complete */
312 VG_SYNC_LOG( "[%d] Waiting for content.\n" );
313 SDL_SemWait( vg
.sem_exec_finished
);
315 /* check if we killed the engine */
316 _vg_ensure_engine_running();
318 /* re-engage main thread */
319 VG_SYNC_LOG( "[%d] Re-engaging.\n" );
320 SDL_GL_MakeCurrent( vg
.window
, vg
.gl_context
);
324 VG_SYNC_LOG( "[%d] Nothing to do.\n" );
325 SDL_AtomicUnlock( &vg
.sl_context
);
329 VG_STATIC
void _vg_opengl_sync_init(void)
331 vg
.sem_allow_exec
= SDL_CreateSemaphore(0);
332 vg
.sem_exec_finished
= SDL_CreateSemaphore(0);
333 vg
.sem_loader
= SDL_CreateSemaphore(1);
336 VG_STATIC
void vg_checkgl( const char *src_info
);
337 #define VG_STRINGIT( X ) #X
338 #define VG_CHECK_GL_ERR() vg_checkgl( __FILE__ ":L" VG_STRINGIT(__LINE__) )
340 #include "vg_console.h"
341 #include "vg_profiler.h"
342 #include "vg_audio.h"
343 #include "vg_shader.h"
345 #include "vg_input.h"
347 #include "vg_lines.h"
348 #include "vg_loader.h"
352 VG_STATIC
struct vg_profile vg_prof_update
= {.name
="update()"},
353 vg_prof_render
= {.name
="render()"};
355 VG_STATIC
void vg_checkgl( const char *src_info
)
360 while( (err
= glGetError()) != GL_NO_ERROR
)
362 vg_error( "(%s) OpenGL Error: #%d\n", src_info
, err
);
367 vg_fatal_exit_loop( "OpenGL Error" );
370 VG_STATIC
void vg_bake_shaders(void)
372 vg_acquire_thread_sync();
373 vg_console_reg_cmd( "reload_shaders", vg_shaders_live_recompile
, NULL
);
375 vg_shaders_compile();
376 vg_release_thread_sync();
379 VG_STATIC
void _vg_load_full(void)
384 vg_loader_step( vg_input_init
, vg_input_free
);
385 vg_loader_step( vg_lines_init
, NULL
);
386 vg_loader_step( vg_audio_init
, vg_audio_free
);
387 vg_loader_step( vg_profiler_init
, NULL
);
393 VG_STATIC
void _vg_process_events(void)
396 vg
.time_real_last
= vg
.time_real
;
397 vg
.time_real
= (double)SDL_GetTicks64() / 1000.0;
398 vg
.frame_delta
= vg
.time_real
-vg
.time_real_last
;
400 v2_zero( vg
.mouse_wheel
);
401 v2_zero( vg
.mouse_delta
);
405 while( SDL_PollEvent( &event
) )
407 if( event
.type
== SDL_KEYDOWN
)
409 console_proc_key( event
.key
.keysym
);
411 else if( event
.type
== SDL_MOUSEWHEEL
)
413 vg
.mouse_wheel
[0] += event
.wheel
.preciseX
;
414 vg
.mouse_wheel
[1] += event
.wheel
.preciseY
;
416 else if( event
.type
== SDL_CONTROLLERAXISMOTION
||
417 event
.type
== SDL_CONTROLLERBUTTONDOWN
||
418 event
.type
== SDL_CONTROLLERBUTTONUP
||
419 event
.type
== SDL_CONTROLLERDEVICEADDED
||
420 event
.type
== SDL_CONTROLLERDEVICEREMOVED
423 vg_input_controller_event( &event
);
425 else if( event
.type
== SDL_MOUSEMOTION
)
427 vg
.mouse_delta
[0] += event
.motion
.xrel
;
428 vg
.mouse_delta
[1] += event
.motion
.yrel
;
430 else if( event
.type
== SDL_WINDOWEVENT
)
432 if( event
.window
.event
== SDL_WINDOWEVENT_SIZE_CHANGED
)
435 SDL_GL_GetDrawableSize( vg
.window
, &w
, &h
);
439 vg_warn( "Got a invalid framebuffer size: "
440 "%dx%d... ignoring\n", w
, h
);
447 vg_framebuffer_resize(w
,h
);
450 else if( event
.window
.event
== SDL_WINDOWEVENT_CLOSE
)
452 vg
.window_should_close
= 1;
455 else if( event
.type
== SDL_TEXTINPUT
)
457 console_proc_utf8( event
.text
.text
);
461 vg
.mouse_pos
[0] += vg
.mouse_delta
[0];
462 vg
.mouse_pos
[1] += vg
.mouse_delta
[1];
468 VG_STATIC
void _vg_gameloop_update(void)
470 vg_profile_begin( &vg_prof_update
);
472 vg
.engine_stage
= k_engine_stage_update
;
475 /* Fixed update loop */
476 vg
.engine_stage
= k_engine_stage_update_fixed
;
477 vg
.accumulator
+= vg
.time_delta
;
479 vg
.fixed_iterations
= 0;
480 vg_lines
.allow_input
= 1;
481 while( vg
.accumulator
>= (VG_TIMESTEP_FIXED
-0.00125) )
484 vg_lines
.allow_input
= 0;
486 vg
.accumulator
-= VG_TIMESTEP_FIXED
;
487 vg
.accumulator
= VG_MAX( 0.0, vg
.accumulator
);
489 vg
.fixed_iterations
++;
490 if( vg
.fixed_iterations
== 8 )
495 vg_lines
.allow_input
= 1;
497 vg
.engine_stage
= k_engine_stage_update
;
499 vg_profile_end( &vg_prof_update
);
502 VG_STATIC
void _vg_gameloop_render(void)
504 vg_profile_begin( &vg_prof_render
);
509 vg
.engine_stage
= k_engine_stage_rendering
;
513 vg
.engine_stage
= k_engine_stage_ui
;
515 ui_begin( vg
.window_x
, vg
.window_y
);
518 ui_set_mouse( vg
.mouse_pos
[0], vg
.mouse_pos
[1], 0 );
521 (struct vg_profile
*[]){&vg_prof_update
,&vg_prof_render
}, 2,
522 (1.0f
/(float)vg
.refresh_rate
)*1000.0f
,
523 (ui_rect
){ 4, 4, 250, 0 }, 0
533 "refresh: %.1f (%.1fms)\n"
535 "iterations: %d (acc: %.3fms%%)\n",
536 vg
.window_x
, vg
.window_y
,
537 vg
.refresh_rate
, (1.0f
/vg
.refresh_rate
)*1000.0f
,
540 (vg
.accumulator
/VG_TIMESTEP_FIXED
)*100.0f
);
542 ui_text( (ui_rect
){258, 4+24+12,0,0},perf
, 1,0);
546 audio_debug_ui( vg
.pv
);
555 vg_profile_end( &vg_prof_render
);
558 VG_STATIC
void _vg_gameloop(void)
560 vg
.accumulator
= 0.75f
* (1.0f
/60.0f
);
565 _vg_process_events();
567 if( vg
.window_should_close
)
571 vg
.time_delta
= vg
.frame_delta
* vg
.time_rate
;
572 vg
.time
+= vg
.time_delta
;
587 _vg_gameloop_update();
588 _vg_gameloop_render();
590 SDL_GL_SwapWindow( vg
.window
);
595 VG_STATIC
void _vg_process_launch_opts_internal( int argc
, char *argv
[] )
598 while( vg_argp( argc
, argv
) )
600 if( (arg
= vg_opt_arg( 'w' )) )
602 vg
.window_x
= atoi( arg
);
605 if( (arg
= vg_opt_arg( 'h' )) )
607 vg
.window_y
= atoi( arg
);
610 if( (arg
= vg_long_opt_arg( "samples" )) )
612 vg
.samples
= VG_MAX( 0, VG_MIN( 8, atoi( arg
) ) );
615 if( vg_long_opt( "use-libc-malloc" ) )
617 vg_mem
.use_libc_malloc
= 1;
620 if( vg_long_opt( "high-performance" ) )
622 vg
.quality_profile
= k_quality_profile_low
;
629 VG_STATIC
void _vg_init_window( const char *window_name
)
631 vg_info( "SDL_INIT\n" );
633 if( SDL_Init( SDL_INIT_VIDEO
) != 0 ){
634 vg_error( "SDL_Init failed: %s\n", SDL_GetError() );
638 SDL_InitSubSystem( SDL_INIT_AUDIO
);
639 SDL_InitSubSystem( SDL_INIT_GAMECONTROLLER
);
641 SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER
, 1 );
642 SDL_GL_SetAttribute( SDL_GL_CONTEXT_MAJOR_VERSION
, 3 );
643 SDL_GL_SetAttribute( SDL_GL_CONTEXT_MINOR_VERSION
, 3 );
644 SDL_GL_SetAttribute( SDL_GL_CONTEXT_PROFILE_MASK
,
645 SDL_GL_CONTEXT_PROFILE_CORE
);
647 SDL_GL_SetAttribute( SDL_GL_CONTEXT_RELEASE_BEHAVIOR
,
648 SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH
);
650 SDL_GL_SetAttribute( SDL_GL_RED_SIZE
, 8 );
651 SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE
, 8 );
652 SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE
, 8 );
653 SDL_GL_SetAttribute( SDL_GL_ALPHA_SIZE
, 8 );
654 SDL_GL_SetAttribute( SDL_GL_STENCIL_SIZE
, 0 );
657 * Get monitor information
659 vg_info( "Getting display count\n" );
660 int display_count
= 0, display_index
= 0, mode_index
= 0;
661 if( (display_count
= SDL_GetNumVideoDisplays()) < 1 ){
662 vg_error( "SDL_GetNumVideoDisplays returned: %i\n", display_count
);
668 vg
.refresh_rate
= 60;
672 /* TODO: Allow chosing the modes at startup */
673 vg_info( "Getting default display mode\n" );
674 SDL_DisplayMode vm_ideal
= { 0, 0, 0, 0, 0 };
675 if( SDL_GetDisplayMode( display_index
, mode_index
, &vm_ideal
) != 0 ){
676 vg_error( "SDL_GetDisplayMode failed: %s", SDL_GetError() );
681 vm_ideal
.w
= vg
.window_x
;
684 vm_ideal
.h
= vg
.window_y
;
687 SDL_DisplayMode vm_best
;
688 if( !SDL_GetClosestDisplayMode( display_index
, &vm_ideal
, &vm_best
) ){
689 vg_error( "SDL_GetClosestDisplayMode failed: %s", SDL_GetError() );
693 vg
.refresh_rate
= vm_best
.refresh_rate
;
694 vg
.window_x
= vm_best
.w
;
695 vg
.window_y
= vm_best
.h
;
698 vg_info( "CreateWindow( %d %d @%.2fhz )\n", vg
.window_x
, vg
.window_y
,
701 /* TODO: Allow selecting closest video mode from launch opts */
702 if((vg
.window
= SDL_CreateWindow( window_name
,
705 0, 0, vg
.window_x
, vg
.window_y
,
706 SDL_WINDOW_BORDERLESS
|SDL_WINDOW_OPENGL
|SDL_WINDOW_INPUT_GRABBED
709 SDL_WINDOWPOS_UNDEFINED
,
710 SDL_WINDOWPOS_UNDEFINED
,
711 vg
.window_x
, vg
.window_y
,
713 SDL_WINDOW_FULLSCREEN_DESKTOP
|
715 SDL_WINDOW_INPUT_GRABBED
718 if( SDL_SetWindowDisplayMode( vg
.window
, &vm_best
) ){
719 vg_error( "SDL_SetWindowDisplayMode failed: %s", SDL_GetError() );
726 vg_error( "SDL_CreateWindow failed: %s", SDL_GetError() );
730 vg_info( "CreateContext\n" );
735 if( (vg
.gl_context
= SDL_GL_CreateContext(vg
.window
) ))
737 SDL_GL_GetDrawableSize( vg
.window
, &vg
.window_x
, &vg
.window_y
);
738 vg_success( "Window created (%dx%d)\n", vg
.window_x
, vg
.window_y
);
742 vg_error( "SDL_GL_CreateContext failed: %s\n", SDL_GetError() );
747 if( !gladLoadGLLoader((GLADloadproc
)SDL_GL_GetProcAddress
) )
749 vg_error( "Glad Failed to initialize\n" );
750 SDL_GL_DeleteContext( vg
.gl_context
);
755 const unsigned char* glver
= glGetString( GL_VERSION
);
756 vg_success( "Load setup complete, OpenGL version: %s\n", glver
);
758 vg_info( "Setting swap interval\n" );
760 if( SDL_GL_SetSwapInterval( -1 ) == -1 )
762 vg_warn( "Adaptive Vsync not supported\n" );
764 if( SDL_GL_SetSwapInterval( 1 ) == -1 )
766 vg_fatal_exit_loop( "Cannot enable Vsync! You might be overriding it"
767 " in your graphics control panel.\n" );
770 vg_success( "Using vsync\n" );
773 vg_success( "Using adaptive Vsync\n" );
775 SDL_DisplayMode dispmode
;
776 if( !SDL_GetWindowDisplayMode( vg
.window
, &dispmode
) )
778 if( dispmode
.refresh_rate
)
780 vg
.refresh_rate
= dispmode
.refresh_rate
;
781 vg_info( "Refresh rate: %d\n", dispmode
.refresh_rate
);
786 VG_STATIC
void vg_enter( int argc
, char *argv
[], const char *window_name
)
788 _vg_process_launch_opts_internal( argc
, argv
);
794 _vg_init_window( window_name
);
796 SDL_SetRelativeMouseMode(1);
797 vg
.thread_id_main
= SDL_GetThreadID(NULL
);
799 /* Opengl-required systems */
803 vg
.engine_status
= k_engine_status_running
;
805 _vg_opengl_sync_init();
806 vg_loader_start( _vg_load_full
);
810 _vg_console_write_persistent();
812 SDL_AtomicLock( &vg
.sl_context
);
813 vg
.engine_status
= k_engine_status_none
;
814 SDL_AtomicUnlock( &vg
.sl_context
);
818 vg_success( "If you see this it means everything went.. \"well\".....\n" );
820 SDL_GL_DeleteContext( vg
.gl_context
);
824 void vg_print_backtrace(void)
832 size
= backtrace( array
, 20 );
833 strings
= backtrace_symbols( array
, size
);
835 if( strings
!= NULL
)
837 vg_error( "---------------- gnu backtrace -------------\n" );
839 for( int i
=0; i
<size
; i
++ )
840 vg_info( "%s\n", strings
[i
] );
842 vg_error( "---------------- gnu backtrace -------------\n" );
851 * Immediately transfer away from calling thread into a safe loop, signal for
852 * others to shutdown, then free everything once the user closes the window.
854 * FIXME(bug): glfwWindowShouldClose() never returns 1 in windows via wine, ONLY
855 * when calling the program from outside its normal directory.
857 VG_STATIC
void vg_fatal_exit_loop( const char *error
)
860 * https://www.gnu.org/software/libc/manual/html_node/Backtraces.html
863 * TODO: this on windows?
866 vg_print_backtrace();
867 vg_error( "Fatal error: %s\n", error
);
869 SDL_AtomicLock( &vg
.sl_context
);
870 if( vg
.engine_status
== k_engine_status_none
)
872 SDL_AtomicUnlock( &vg
.sl_context
);
874 /* TODO: Correct shutdown before other systems */
879 SDL_AtomicUnlock( &vg
.sl_context
);
881 vg_acquire_thread_sync();
883 SDL_AtomicLock( &vg
.sl_context
);
884 vg
.engine_status
= k_engine_status_crashed
;
885 vg
.str_const_engine_err
= error
;
886 SDL_AtomicUnlock( &vg
.sl_context
);
888 /* Notify other thread for curtosey */
889 if( vg_thread_purpose() == k_thread_purpose_main
)
891 SDL_AtomicLock( &vg
.sl_context
);
893 if( vg
.exec_context
!= 0 )
894 SDL_SemPost( vg
.sem_allow_exec
);
896 SDL_AtomicUnlock( &vg
.sl_context
);
903 _vg_process_events();
904 if( vg
.window_should_close
)
907 if( vg_getkey( SDLK_ESCAPE
) )
910 glBindFramebuffer( GL_FRAMEBUFFER
, 0 );
912 glDisable(GL_DEPTH_TEST
);
913 glBlendFunc(GL_ONE_MINUS_DST_ALPHA
, GL_DST_ALPHA
);
914 glBlendEquation(GL_FUNC_ADD
);
916 glClearColor( 0.15f
+ sinf(vg
.time_real
)*0.1f
, 0.0f
, 0.0f
,1.0f
);
917 glClear( GL_COLOR_BUFFER_BIT
);
918 glViewport( 0,0, vg
.window_x
, vg
.window_y
);
921 SDL_GL_SwapWindow( vg
.window
);
924 /* Can now shutdown and EXIT */
926 SDL_GL_DeleteContext( vg
.gl_context
);
934 VG_STATIC
void vg_fatal_exit_loop( const char *error
)
936 vg_error( "Fatal error: %s\n", error
);
943 * Graphic cards will check these to force it to use the GPU
945 u32 NvOptimusEnablement
= 0x00000001;
946 int AmdPowerXpressRequestHighPerformance
= 1;
948 #endif /* VG_HEADER_H */