{"id":11,"date":"2010-05-24T18:16:11","date_gmt":"2010-05-24T18:16:11","guid":{"rendered":"https:\/\/blogs.scummvm.org\/vgvgf\/?p=11"},"modified":"2022-05-21T18:19:53","modified_gmt":"2022-05-21T18:19:53","slug":"backend-design","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/vgvgf\/2010\/05\/24\/backend-design\/","title":{"rendered":"Backend Design"},"content":{"rendered":"

The idea and goal<\/h2>\n

My first task is refactoring the backend structure. It has to be designed in a way to improve portability and make it easier to modify.\u00a0 Also, it has to allow an easy and fast way to use different libraries in platforms. This is mainly for making the next task, implementing OpenGL, easy to port.<\/p>\n

OpenGL is only a specification for rendering, and does not include Audio playing, timers, devices detection, and else functions that a library like SDL does have. So, the goal is to be able to use OpenGL for rendering and SDL for the other tasks, or other libraries\/sdks if needed.<\/p>\n

Now, the idea is to create a backend structure based on independent subsystems. Then, we can use the audio, timer, events, and else subsystems from SDL, and use the rendering subsystem from OpenGL.<\/p>\n

Planed design<\/h2>\n

Each backend, like for example the SDL one, will inhereit from its subsystems that already inhereit from their virtual subsystem classes. And each subsystem will inhereit from the OSystem class.<\/p>\n

<\/a>Example class diagram<\/em><\/p>\n

In the example diagram, SubSystem_Audio, SubSystem_Timer and SubSystem_Video are the virtual structure for the SubSystem_SDL* classes. The virtual subsystems will inhereit virtualy the class OSystem, then OSystem_SDL will only include one copy of OSystem. In actual ScummVM code, OSystem_SDL overrides all OSystem functions; in the planed desing, the OSystem functions will be mostly overriden by each subsystem, and only initialization or other special codes will be included in the OSystem_SDL backend.<\/p>\n

An idea I have in mind is also to separate the platform specify codes in OSystem_SDL, and create for each platform a new OSystem_*Platform* class that would inhereit the subsystems it needs. Then, we will have OSystem_Win, OSystem_Unix, OSystem_Mac, and else insteand of OSystem_SDL. This will help when implementing the OpenGL subsystem, as it will only be needed to change the inhereited video subsystem in the platform, and as the SDL name in the class doesn\u2019t reflect OpenGL is being used.<\/p>\n

\n
\n
view source<\/a><\/p>\n
<\/embed><\/div>\n

print<\/a>?<\/a><\/div>\n<\/div>\n

\n
\n\n\n\n
01<\/code><\/td>\n\/\/Example code<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
02<\/code><\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
03<\/code><\/td>\n\/\/ Virtual Subsystems<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
04<\/code><\/td>\nclass<\/code>\u00a0SubSystem_Timer :\u00a0<\/code>public<\/code>\u00a0virtual<\/code>\u00a0OSystem { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
05<\/code><\/td>\nclass<\/code>\u00a0SubSystem_Audio :\u00a0<\/code>public<\/code>\u00a0virtual<\/code>\u00a0OSystem { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
06<\/code><\/td>\nclass<\/code>\u00a0SubSystem_Video :\u00a0<\/code>public<\/code>\u00a0virtual<\/code>\u00a0OSystem { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
07<\/code><\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
08<\/code><\/td>\n\/\/ SDL subsystems<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
09<\/code><\/td>\nclass<\/code>\u00a0SubSystem_SDLTimer :\u00a0<\/code>public<\/code>\u00a0SubSystem_Timer { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
10<\/code><\/td>\nclass<\/code>\u00a0SubSystem_SDLAudio :\u00a0<\/code>public<\/code>\u00a0SubSystem_Audio { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
11<\/code><\/td>\nclass<\/code>\u00a0SubSystem_SDLVideo :\u00a0<\/code>public<\/code>\u00a0SubSystem_Video { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
12<\/code><\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
13<\/code><\/td>\n\/\/ OpenGL subsystem<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
14<\/code><\/td>\nclass<\/code>\u00a0SubSystem_OpenGL :\u00a0<\/code>public<\/code>\u00a0SubSystem_Video { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
15<\/code><\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
16<\/code><\/td>\n\/\/ Platfrom 1 - Using SDL<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
17<\/code><\/td>\nclass<\/code>\u00a0OSystem_Platform1 :\u00a0<\/code>public<\/code>\u00a0SubSystem_SDLTimer,\u00a0<\/code>public<\/code>\u00a0SubSystem_SDLAudio,\u00a0<\/code>public<\/code>\u00a0SubSystem_SDLVideo { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
18<\/code><\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
19<\/code><\/td>\n\/\/ Platform 2 - Using SDL and OpenGL<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n\n\n\n
20<\/code><\/td>\nclass<\/code>\u00a0OSystem_Platform2 :\u00a0<\/code>public<\/code>\u00a0SubSystem_SDLTimer,\u00a0<\/code>public<\/code>\u00a0\u00a0SubSystem_SDLAudio,\u00a0<\/code>public<\/code>\u00a0SubSystem_OpenGL { ...<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

The idea and goal My first task is refactoring the backend structure. It has to be designed in a way to improve portability and make it easier to modify.\u00a0 Also, it has to allow an easy and fast way to use different libraries in platforms. This is mainly for making the next task, implementing OpenGL, […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-11","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/posts\/11","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/comments?post=11"}],"version-history":[{"count":1,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/posts\/11\/revisions"}],"predecessor-version":[{"id":13,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/posts\/11\/revisions\/13"}],"wp:attachment":[{"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/media?parent=11"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/categories?post=11"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/vgvgf\/wp-json\/wp\/v2\/tags?post=11"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}