Розробка фреймворка для 2-Д відеоігор на основі мультимедійної бібліотеки SDL2 Частина 3. Вдосконалюємо роботу з вікном.

Розробка фреймворка для 2-Д відеоігор на основі мультимедійної бібліотеки SDL2

Частина 3. Вдосконалюємо роботу з вікном.

Оптимізація класу

В попередній частині ми створили каркасний клас для фреймворка, який створює вікно засобами SDL2. Проте для комфортної роботи цей клас потрібно вдосконалити, використовуючи можливості бібліотеки SDL2 для роботи з вікнами.

В останньому варіанті коду я допустив помилку: код, який відповідає за ініціалізацію, виніс в конструктор класу, а потрібно було його описати в методі Initialize. В новому варіанті класу ми цю помилку виправимо, а також розширимо можливості створення та керування вікном.

Щоб не заплутуватись в лістингах, надалі я не буду приводити код повністю після кожної зміни, а лише сніпети коду, який додається або змінюється

І ще одна особливість, яку я виявив при виведенні заголовку вікна: для того, щоб коректно відображалась кирилиця, потрібно використовувати тип UTF8String, який приводиться до типу PChar. Але для того, щоб такий метод відпрацьовував коректно, заголовок вікна винесемо окремою властивісю класу:

//заголовок вікна
    property Caption : String;
    

Натискуй Ctrl+Shift+C і Lazarus сам створить весь додатковий код, тобі лише потрібно зробити виправлення в методі Init(): рядок

fSDLWindow:=SDL_CreateWindow(PChar(аCaption),SDL_WINDOWPOS_UNDEFINED,SDL_WINDOWPOS_UNDEFINED,_height,_width,SDL_WINDOW_SHOWN);

потрібно замінити на наступні рядки:

fSDLWindow:=SDL_CreateWindow(PChar(Utf8String(Caption)),
                  SDL_WINDOWPOS_UNDEFINED,
                  SDL_WINDOWPOS_UNDEFINED,
                  Height,Width,
                  SDL_WINDOW_SHOWN);
   

Тепер значення заголовку буде зберігатися у відповідній властивості класу і коректно відображатись на екрані.

Аналогічно винесемо розміри вікна у окремі властивості класу Width і Height:

//ширина і висота вікна
    property Width : Integer;
    property Height : Integer;
 

Теж натискуй Ctrl+Shift+C щоб Lazarus автоматично завершив код і поки що ці методи лишай без змін, до них ми повернемось трохи пізніше.

Ще, на мою думку, зручно було б винести обробку робочого циклу теж окремим методом (аналогічно як в класі Application в LCL). Тож я вирішив додати метод Run:

procedure TGOEngine.Run;
begin
 while IsRunning do begin
    DoEvents;
    Render;
   end;
end;

Відповідно в тестовій програмі весь цикл while потрібно замінити лише одним рядком TestEngine.Run. Можеш спробувати запустити програму і переконатись, що все працює так як і раніше.

Повноекранний режим SDL

Для створення вікна бібліотека SDL використовує певний набір параметрів. Це ширина і висота вікна, початкові координати верхнього лівого кута вікна, а також набір різних додаткових ознак. Якщо звернутись до документації по SDL, то можна використовувати наступні ознаки:

Ознака	Призначення
SDL_WINDOW_FULLSCREEN	Вікно повинне бути на весь екран
SDL_WINDOW_OPENGL	Вікно може використовуватись як контекст OpenGL
SDL_WINDOW_SHOWN	Вікно видиме на екрані
SDL_WINDOW_HIDDEN	Вікно сховане
SDL_WINDOW_BORDERLESS	Вікно не має обрамлення і заголовку
SDL_WINDOW_RESIZABLE	Вікно може змінювати розміри
SDL_WINDOW_MINIMIZED	Вікно згорнуте
SDL_WINDOW_MAXIMIZED	Вікно розгорнуте
SDL_WINDOW_INPUT_GRABBED	Вікно захопило фокус вводу
SDL_WINDOW_INPUT_FOCUS	Вікно має фокус вводу
SDL_WINDOW_MOUSE_FOCUS	Вікно має фокус вказівника мишки
SDL_WINDOW_FOREIGN	Вікно створене не бібліотекою SDL

Оскільки більшість відеоігор зручніше грати в повноекранному режимі, нас цікавить сама перша ознака SDL_WINDOW_FULLSCREEN. Спробуй змінити ознаку в функції створення вікна в методі Init() нашого класу і подивись результат. Щоб закрити вікно в повноекранному режимі, натисни Alt+F4, оскільки заголовок зі стандартними кнопками відсутній.

Проте періодично виникають ситуації, коли потрібно швидко переключитись між повноекранним/віконним режимами без виходу з програми. SDL дозволяє таке зробити за допомогою функції SDL_SetWindowFullscreen(), яка в якості параметрів приймає вікно, з яким відбувається дія, та ознаку 0 для віконного режиму або 1 для повноекранного.

Отже, для встановлення ознаки повноекранного режиму я ввів ще одну властивість:

property IsFullScreen : Boolean default true;

після чого натиснув вже добре знайому комбінацію Ctrl+Shift+C для автоматичного завершення коду. Далі, переходимо в згенерований Лазарусом внутрішній метод SetIsFullScreen() і в кінці додаємо наступні рядки коду:

if FIsFullScreen then SDL_SetWindowFullscreen(fSDLWindow,SDL_WINDOW_FULLSCREEN)
    else SDL_SetWindowFullscreen(fSDLWindow,0);
  SDL_UpdateWindowSurface(fSDLWindow);

Цей код реалізує перехід в повноекранний або віконний режим в залежності від поточного значення поля FIsFullScreen. Останній рядок необхідний для того, щоб вікно обновилось після зміни режиму.

Добре, код для реалізації зміни режиму вже є, тепер потрібно назначити коли цей код повинен виконуватись. В більшості програм для переключення між віконним та повноекранним режимами прийнято використовувати комбінацію клавіш Alt+Enter. Я вирішив теж реалізувати переключення між режимами цією комбінацією клавіш, і мене переклинило більше ніж на годину часу. Справа в тому, що потрібно відловити натискання комбінації клавіш, а за один раз вдається відловити лише натискання однієї клавіші. Звісно, є ще можливість перевірити які з клавіш-модифікаторів були в цей час натиснуті, але конкретного прикладу як це правильно зробити я знайти так і не зміг (навіть для C++!), тож довелось практичним шляхом виясняти самому.

Спочатку потрібно відловити подію натискання клавіш. Бібліотека SDL для цього має два типа подій, які виникають перша при натисканні клавіші, а друга при відпусканні. В нашому випадку краще підходить подія відпускання клавіші. Переходь в метод DoEvents() та після рядка

if fSDLEvent^.type_ = SDL_QUITEV then fRunning:=false;
      

додай наступний код:

if (fSDLEvent^.type_ = SDL_KEYUP) then begin
         //відловлюємо Alt+Enter для зміни режиму
         if (fSDLEvent^.key.keysym.sym = SDLK_RETURN) and ((fSDLEvent^.key.keysym._mod and KMOD_ALT) <> 0) then
            IsFullScreen:=not IsFullScreen;
      end

Спробуй запустити та потестити - повинно все працювати саме так, як і задумано. Якщо щось не виходить чи не можеш зрозуміти що куди в коді потрібно прописати, можеш скачати архів з сирцями (лише у властивостях проекту потрібно поправити шляхи до трансльованих заголовочних файлів SDL2, про що я писав ще в першій статті). В наступній частині ми завершимо рутинну роботу з вікном і поступово почнемо переходити до виведення зображень. А на сьогодні поки що все. Всі зауваження та побажання до статті пишіть в коментарях.

Розробка фреймворка для 2-Д відеоігор на основі мультимедійної бібліотеки SDL2 Частина 2. Перше вікно SDL2.

Розробка фреймворка для 2-Д відеоігор на основі мультимедійної бібліотеки SDL2

Частина 2. Перше вікно SDL2.

В попередній частині ми підготували усе необхідне для створення ігрового фреймворку на основі мультимедійної бібліотеки SDL2, а тепер почнемо роботу безпосередньо над самим фреймворком.

Оскільки сам термін “відеогра” передбачає виведення на екран, відповідно, основою для відеогри буде екран або якась його частина, у нашому випадку вікно. Спочатку я покажу тобі, яким способом можна отримати вікно за допомогою бібліотеки SDL2. Оскільки ми не будемо використовувати LCL, нам не потрібно нічого лишнього, тому в Lazarus створи новий проект типу “Проста програма”, і набери наступний код:

{******************************}program demo;{*********************************}
{*                                                                            *}
{*     Демонстрація створення пустого вікна за допомогою бібліотеки SDL2      *}
{*                                                                            *}
{******************************************************************************}
 {$mode objfpc}
uses sdl2;

 var SDLWindow   : PSDL_Window;
     SDLRenderer : PSDL_Renderer;
     SDLEvent    : PSDL_Event;
     isRun       : Boolean;

begin
   //спочатку пробуємо ініціалізувати бібліотеку
   if SDL_Init(SDL_INIT_EVERYTHING)>=0 then begin
      //якщо все пройшло добре - створюємо вікно
     SDLWindow:=SDL_CreateWindow('Game over!',SDL_WINDOWPOS_UNDEFINED,SDL_WINDOWPOS_UNDEFINED,640,480,SDL_WINDOW_SHOWN);
     //якщо вікно створене, потрібно створити рендерер
     if SDLWindow<>nil then begin
        SDLRenderer:=SDL_CreateRenderer(SDLWindow,-1,0);
        if SDLRenderer=nil then begin
           SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR,'Error!',SDL_GetError,SDLWindow);
           Exit;
        end;
     end;
     New(SDLEvent);
     isRun:=true; //ознака виконання робочого циклу
     while isRun do begin
          //встановлюємо колір вікна в голубий
          SDL_SetRenderDrawColor(SDLRenderer,0,128,255,255);
          //очищаємо вікно
          SDL_RenderClear(SDLRenderer);
          //показуємо вікно на екрані
          SDL_RenderPresent(SDLRenderer);
          //відловлюємо подію закриття вікна
          if SDL_PollEvent(SDLEvent)=1 then begin
              if SDLEvent^.type_ = SDL_QUITEV then isRun:=false;
          end;
     end;
     //прибираємо за собою
     Dispose(SDLEvent);
     SDL_DestroyRenderer(SDLRenderer);
     SDL_DestroyWindow(SDLWindow);
     //зупиняємо бібліотеку
     SDL_Quit;
   end;
end.

Я не буду в деталях зупинятись на описі кожної функції бібліотеки SDL2, ця інформація доступна як в сирцях трансляції заголовочних файлів, так і на багатьох сайтах. Розглянемо лише що робить цей код.

Для створення вікна нам необхідні наступні змінні: для вікна, рендерера (це така штука, яка відповідає за малювання зображення), відловлювання подій SDL2 та ознака виконання робочого циклу.

Після ініціалізації усіх підсистем SDL2 створюємо спочатку вікно, тоді рендерер. У випадку, якщо не вдається створити рендерер, програма виводить відповідне повідомдення і перериває виконання.

Коли все пройшло успішно, ми маємо вікно і рендерер, який на ньому буде промальовувати все, що нам потрібно.

Для того, щоб вікно можна було закрити, ми мусимо відловити відповідну подію SDL2. Оскільки спеціальної функції для ініціалізації змінної для роботи з повідомленнями немає, потрібно просто виділити для цього пам’ять стандартною функцією Pascal New(). Встановленням ознаки виконання робочого циклу в true завершується розділ ініціалізації і починається безпосередньо робочий цикл.

Сам цикл буде тривати до того моменту, поки змінна isRun буде мати значення true. Все, що в нас вібувається з кожною ітерацією циклу - встановлення кольору для вікна, заливка вікна цим кольором і показ його на екрані, після чого йде відловлювання події SDL2 і перевірка чи це саме та подія, яка нам потрібна. І коли нарешті настає момент закриття вікна, ми відловлюємо відповідну подію SQL_QUITEV. Змінна isRun приймає значення false і виконання циклу перериваєьтся. Програма переходить до наступної стадії - очистка використаної пам’яті. Усі змінні очищаємо в порядку, оберненому до порядку їх створення: спочатку звільняємо пам’ять, виділену під вказівник змінної для відловлювання подій, тоді рендерер, вікно і зупиняємо усі підсистеми SDL2.

Варто пам’ятати: усі змінні, які ініціалізуються функціями типу SDL_CreateXXX(), звільняються відповідними функціями SDL_DestroyXXX() в порядку, оберненому до порядку їх ініціалізації. Ті змінні, пам’ять для яких виділялась явно функцією New(), повинні очишатись теж в оберненому порядку функцією Dispose().

Здається, тут все досить просто, але й близько не видно, яке це має відношення до ігрового фреймворку. Що ж, давай тепер розглянемо, за яким принципом побудовані усі відеоігри.

Ігровий алгоритм, або з чого складається відеогра

Незалежно від жанру, ігрового дизайну, сукупності використовуваних технологій, ігрова механіка будь-якої відеогри складається із взаємодії різних підсистем, таких як графіка, ігрова механіка і ввід корисувача. При цьому графічна підсистема може нічого не знати про логіку гри, яким чином відбувається введення користувачем, тощо. Ми можемо думати про структуру гри наступним чином:

Рис.1. Типовий алгоритм будь-якої гри.

Після одноразової ініціалізації усіх необхідних даних запускається ігровий цикл, який перевіряє ввід користувача, прораховує ігрову логіку і встановлює необхідні значення усіх об’єктів і змінних до того, як вивести графіку на екран.

Коли користувач вибирає завершити гру, ігровий цикл переривається, і гра переходить до стадії очищення даних та виходу.

Спробуємо розділити попередній код на окремі логічні блоки, які будуть відповідати за усі перечислені кроки:

{******************************}program demo_v2;{*********************************}
{*                                                                            *}
{*     Демонстрація створення пустого вікна за допомогою бібліотеки SDL2      *}
{*                                                                            *}
{******************************************************************************}
 {$mode objfpc}
uses sdl2;

 var SDLWindow   : PSDL_Window;
     SDLRenderer : PSDL_Renderer;
     SDLEvent    : PSDL_Event;
     isRun       : Boolean;

 function Initialize(aCaption : PChar; _height, _width : Integer) : Boolean;
 //ініціалізація SDL2 і створення вікна та рендерера
 begin
   result:=false;
   //спочатку пробуємо ініціалізувати бібліотеку
   if SDL_Init(SDL_INIT_EVERYTHING)>=0 then begin
      //якщо все пройшло добре - створюємо вікно
     SDLWindow:=SDL_CreateWindow(aCaption,SDL_WINDOWPOS_UNDEFINED,SDL_WINDOWPOS_UNDEFINED,_height,_width,SDL_WINDOW_SHOWN);
     //якщо вікно створене, потрібно створити рендерер
     if SDLWindow<>nil then begin
        SDLRenderer:=SDL_CreateRenderer(SDLWindow,-1,SDL_RENDERER_ACCELERATED);
        if SDLRenderer<>nil then begin
           New(SDLEvent);//потрібно виділити пам'ять для вказівника
           isRun:=true; //ознака виконання робочого циклу
           Result:=true;
           Exit;
        end;
     end;
   end;
 end;

procedure DoEvents;
begin
 //відловлюємо подію закриття вікна
  if SDL_PollEvent(SDLEvent)=1 then begin
     if SDLEvent^.type_ = SDL_QUITEV then isRun:=false;
  end;
end;

procedure Draw;
begin
  //встановлюємо колір вікна в бірюзовий
  SDL_SetRenderDrawColor(SDLRenderer,0,128,255,255);
  //очищаємо вікно
  SDL_RenderClear(SDLRenderer);
  //показуємо вікно на екрані
  SDL_RenderPresent(SDLRenderer);
end;

procedure Cleanup;
begin
  //прибираємо за собою
  Dispose(SDLEvent);
  SDL_DestroyRenderer(SDLRenderer);
  SDL_DestroyWindow(SDLWindow);
  //зупиняємо бібліотеку
  SDL_Quit;
end;

begin
   //спочатку пробуємо ініціалізувати бібліотеку
   isRun:= Initialize('Game over! v.2.0',640,480);
   if not isRun then begin
           SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR,'Error!',SDL_GetError,SDLWindow);
           Exit;
    end;
   while isRun do begin
     DoEvents;
     Draw;
   end;
   Cleanup;
end.

Коли ти запустиш цей код на виконання, то побачиш, що кінцевий результат не змінився, створюється те ж саме вікно, але тепер є окремі чітко виділені підпрограми для ініціалізації, обробки подій, рендерингу і очистки пам’яті. Це вже ближче до того, що нам потрібно. Не вистачає лише підпрограми для обчислення усієї ігрової логіки. Крім цього, такий підхід при розробці гри є не дуже гнучким, оскільки на кожну нову гру доведеться по новомо все це описувати. Це не наш метод, я хочу отримати в результаті фреймворк, який мені буде спрощувати написання коду і дозволить зосередитись безпосередньо на написанні гри, а не рутини по створенню вікон, обробці подій, виведенні на екран тощо. Для цього давай опишемо окремий клас, який стане основою для майбутнього фреймворку.

Оскільки ми вже впритул підійшли до написання фреймворку, потрібно придумати йому назву. Я пропоную “Game Over 2D Engine”, ти можеш придумати іншу назву.

Повернемось до нашого коду. Оскільки це буде базовий клас, я назвав його TGOEngine (скорочено від Game Over), і ось що в мене в результаті вийшло:

unit ugoengine;

{$mode objfpc}{$H+}

interface

uses sdl2;

type

 { TGOEngine }

 TGOEngine =class
  private
    fWindow   : PSDL_Window;
    fRenderer : PSDL_Renderer;
    fError    : Boolean; //якщо відбулась помилка
    fIsRun    : Boolean; //чи запущений ігровий цикл
  public
    constructor Create;
    destructor Destroy;override;

    procedure Initialize(aCaption : PChar; _height, _width : Integer);
    procedure DoEvents;
    procedure Update;
    procedure Draw;
  published
    property Error : Boolean read fError;
    property IsRunning : Boolean read fIsRun;
  end;

implementation

{ TGOEngine }

constructor TGOEngine.Create;
begin
  inherited Create;
  //ініціалізація SDL2 і створення вікна та рендерера
   begin
     fError:=true;
     //спочатку пробуємо ініціалізувати бібліотеку
     if SDL_Init(SDL_INIT_EVERYTHING)>=0 then begin
        //якщо все пройшло добре - створюємо вікно
       fWindow:=SDL_CreateWindow('Game over!',SDL_WINDOWPOS_UNDEFINED,SDL_WINDOWPOS_UNDEFINED,640,480,SDL_WINDOW_SHOWN);
       //якщо вікно створене, потрібно створити рендерер
       if fWindow<>nil then begin
          fRenderer:=SDL_CreateRenderer(fWindow,-1,0);
          if fRenderer<>nil then begin
             fError:=false;
             Exit;
          end;
       end;
     end;
   SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR,'Error',SDL_GetError,fWindow);
   end;
end;

destructor TGOEngine.Destroy;
begin
   //прибираємо за собою
   SDL_DestroyRenderer(fRenderer);
   SDL_DestroyWindow(fWindow);
   //зупиняємо бібліотеку
   SDL_Quit;
   inherited Destroy;
end;

procedure TGOEngine.Initialize(aCaption : PChar; _height, _width : Integer);
begin
  //тут буде проходити ініціалізація даних
   fIsRun:=true;
end;

procedure TGOEngine.DoEvents;
var _Event : PSDL_Event;
begin
   New(_Event);
  //тут буде проходити обробка подій
   if SDL_PollEvent(_Event)=1 then begin
      case _Event^.type_ of
SDL_QUITEV: fIsRun:=false;
      end;//case
   end;
   Dispose(_Event);
end;

procedure TGOEngine.Update;
begin
  //тут буде оновлюватись поточний стан виконання
end;

procedure TGOEngine.Draw;
begin
  if fError then Exit;
  //встановлюємо колір вікна в бірюзовий
  SDL_SetRenderDrawColor(fRenderer,0,128,255,255);
  //очищаємо вікно
  SDL_RenderClear(fRenderer);
  //показуємо вікно на екрані
  SDL_RenderPresent(fRenderer);
end;


end.

А ось код основної програми:

{******************************}program demo_v3;{*********************************}
{*                                                                            *}
{*     Демонстрація створення пустого вікна за допомогою бібліотеки SDL2      *}
{*                                                                            *}
{******************************************************************************}
 {$mode objfpc}{$H+}

uses ugoengine;

var TestEngine : TGOEngine;

begin
   //створюємо екземпляр класу
   TestEngine:=TGOEngine.Create;
   //ініціалізуємо початкові дані
   TestEngine.Initialize('Game Over v.3.0',640,480);
   while TestEngine.IsRunning do begin;
    TestEngine.DoEvents;
    TestEngine.Update;
    TestEngine.Draw;
   end;
   TestEngine.Free;
end.

Як бачиш, використання класу дозволяє не думати про рутину створення вікна і зосередитись лише над тим, що ти хочеш отримати в результаті. Проте цей клас ще не забезпечує усієї потрібної роботи з вікном і рендерером. Спробуємо його вдосконалити в наступній частині.

Перезавантаження...

Всім привіт! Я довго обдумував, як краще мені викладати матеріали на мій блог, і нарешті вирішив зробити перезавантаження , що уроки буду формувати і публікувати по мірі можливості, наскільки мені буде вистачати часу працювати над ними. Але регулярно буду публікувати різні цікаві матеріали на тему програмування і не тільки, частина з яких потім можливо буде використано для уроків. Таким чином, хоча б раз на тиждень блог буде доповнюватись новими матеріалами, і обіцяю, що ні плагіату, ні копіпасту з інших сайтів у мене не буде. Вже на цих вихідних викладу початок циклу по використанню чудової мультимедійної бібліотеки SDL2, а точніше - почну розробку фреймворка для створення ігор.