Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 3.28 KB

README.md

File metadata and controls

46 lines (28 loc) · 3.28 KB

OpenGLGP

Najszybszym sposobem na zaczęcie przygody z OpenGL jest pobranie projektu opartego na CMake, który sam ściągnie odpowiednie biblioteki, dołączy je do projektu i odpowiednio skonfiguruje środowisko programistyczne.

Wymagania wstępne

Zanim zaczniemy będą nam potrzebne takie rzeczy jak:

  • Zainstalowane IDE (środowisko programistyczne) Visual Studio 2019, CLion lub inne.
  • Zainstalowany program CMake (należy pamiętać, aby podczas instalacji, dodać CMake do zmiennej PATH).
  • Zainstalowany program Git.

Kiedy jesteśmy już zaopatrzeni w ww. narzędzia, możemy ściągnąć lub sklonować repozytorium OpenGLGP.

Budowanie projektu

UWAGA: Użytkownicy systemu Windows 10/11 powinni upewnić się, czy mają włączony Tryb programisty (Developer Mode).

Aby zbudować projekt, wchodzimy do folderu OpenGLGP i wywołujemy następujące polecenie:

cmake -B build

To samo można osiągnąć poprzez uruchomienie skryptu setup_project.bat.

Spoowoduje to utworzenie w folderze build solucji Visual Studio 2019 (zakładając, że działamy na komputerze wyposażonym w system Windows i IDE Visual Studio 2019).

By uruchomić projekt za pomocą VS 2019, wchodzimy do folderu Build, otwieramy solucję OpenGLGP.sln. Następnie, klikamy prawym przyciskiem myszy na projekcie OpenGLGP i wybieramy opcję Ustaw jako projekt domyślny / Set as a startup project. Następnie budujemy i uruchamiamy aplikację.

Jeżeli korzystamy z IDE Clion (jest darmowa licencja dla studentów) lub Visual Studio 2019 Community, wystarczy wybrać w nim opcję otwarcia projektu, i z folderu OpenGLGP wybrać plik CMakeLists.txt. Następnie Clion / Visual Studio 2019 sam uruchomi skrypt CMake i pobierze odpowiednie biblioteki. Możemy teraz zbudować i uruchomić projekt.

W obu przypadkach powinno pojawić się okienko, w którym renderowane jest przykładowe GUI za pomocą biblioteki ImGUI.

Dokumentacja ImGUI znajduje się w pliku thirdparty/imgui/imgui.cpp.

Widok poprawnie zbudowanej i uruchomionej przykładowej aplikacji: Przykładowe okienko po poprawnym zbudowaniu projektu i uruchomieniu aplikacji

Jak korzystać z projektu

Po zbudowaniu projektu za pomocą CMake wg. powyższego opisu, w folderze głównym projektu (root) będzie znajdował się folder build. Jest to folder tymczasowy, służący jedynie przechowywaniu plików danego IDE (w tym wypadku Visual Studio).

Aby dodać nowe pliki .cpp/.h należy je dodać do folderu src, a następnie ponownie uruchomić komendę CMake do zbudowania projektu. Dzięki temu IDE będzie w stanie zarejestrować nowe pliki.

Podobna rzecz dotyczy również różnych assetów, które powinny być przechowywane w folderze res. W tym wypadku nie jest wymagane ponowne uruchomienie komendy CMake do zbudowania projektu. Pliki są od razu widoczne dla IDE za sprawą wcześniej stworzonego symlinka w folderze build, który bezpośrednio wskazuje na folder res w folderze głównym projektu (root).

W celu odwołania się do danego assetu w kodzie (np. do tekstury stone.jpg, która znajduje się w folderze res/textures/) wystarczy napisać: "res/textures/stone.jpg".