From 77a314112172bbf5437a3beb38e3bbe462191e46 Mon Sep 17 00:00:00 2001 From: Ivan Mahonin Date: Dec 09 2020 11:53:46 +0000 Subject: update documentation --- diff --git a/doc/helianthus-doc-ru.odt b/doc/helianthus-doc-ru.odt index fd83f6f..8fb84b1 100644 Binary files a/doc/helianthus-doc-ru.odt and b/doc/helianthus-doc-ru.odt differ diff --git a/doc/ru/animation.html b/doc/ru/animation.html index 6b7e0e8..2727552 100644 --- a/doc/ru/animation.html +++ b/doc/ru/animation.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/camera.html b/doc/ru/camera.html deleted file mode 100644 index 9ce1a24..0000000 --- a/doc/ru/camera.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - -Буфер кадра - Helianthus - - -
-

Helianthus

-

Запуск и общие функции

-

Клавиатура и мышь

-

Рисование

-

Шрифты и текст

-

Текстуры и анимация

-

Буфер кадра

-

Спрайты

-
-

Все функции

-
-
- -

Буфер кадра

- -

Буфер кадра позволяет вам рисовать не только на экране, но и прямо на текстуре в видео-памяти применяя при этом те же функции рисования.

- -

Создать буфер кадра можно функцией createFramebuffer, которая возвращает значение типа Framebuffer, которое по сути является адресом в памяти — указателем на описание буфера кадра внутри библиотеки Helianthus. Количество буферов кадра с которыми вы можете одновременно работать и их максимальные размеры зависят от вашего видео-драйвера.

- -

После создания буфера кадра в можете создать связанную с ним однокадровую анимацию при помощи функции createAnimationFromFramebuffer. Это будет не простая анимация — изображение в ней анимации будет изменяться как только вы что-либо нарисуете на вашем буфере кадра.

- -

Для того чтобы начать рисовать на буфере кадра вам нужно вызвать функцию target. После завершение рисования вы можете снова вернуться к рисованию на экране обратившись к функции noTarget.

- -

Функции:

- -

Framebuffer createFramebuffer(int width, int height);

- -

Создаёт буфер кадра заданных размеров со включенным сглаживанием, но с выключенным повторением текстуры по горизонтали и вертикали. См. также createFramebufferEx, createAnimationFromFramebuffer, target.

- -

Параметры:

- -

width — ширина нового буфера кадра в пикселях;
-height — высота нового буфера кадра в пикселях.

- -

Framebuffer createFramebufferEx(int width, int height, const void *pixels, int horWrap, int vertWrap, int smooth);

- -

Создать буфер кадра с расширенным набором настроек. См. также createFramebuffer, createFramebufferFromFile, createAnimationFromFramebuffer, target.

- -

Параметры:

- -

width — ширина нового буфера кадра в пикселях;
-height — высота нового буфера кадра в пикселях;
-pixels — указатель на массив пикселей (смотрите формат в описании функции imageLoad), которые зададут начальное изображение буфера кадра; этот параметр может быть NULL, буфер будет заполнен прозрачными писелями;
-horWrap — включить горизонтальное повторение для текстуры созданной на основе буфера кадра (TRUE или FALSE);
-vertWrap — включить вертикальное повторение для текстуры созданной на основе буфера кадра (TRUE или FALSE);
-smooth — включить сглаживание (билинейная фильтрация) для текстуры созданной на основе буфера кадра (TRUE или FALSE).

- -

Framebuffer createFramebufferFromFile(const char *path);

- -

Создать буфер кадра на основе изображения загруженного из файла. Размеры буфера будут соответствовать размеру изображения и само изображение будет загружено в буфер кадра в качестве его начального состояния. Будет включено сглаживание, но отключено повторение узора текстуры по горизонтали и вертикали.

- -

Параметры:

- -

path — путь к файлу изображения.

- -

void framebufferDestroy(Framebuffer framebuffer);

- -

Удалить буфер кадра. См. также createFramebuffer.

- -

Важно: Скорее всего у вас в программе останется переменная в которой хранился указатель на буфер кадра. Этот указатель станет недействителен — будет указывать на неопределённую область памяти — не на буфер кадра, буфер удалён. Вы можете занести в эту переменную другой буфер кадра, но использовать старое значение переменной больше нельзя это приведёт у ошибкам и непредсказуемому поведению программы.

- -

void framebufferFlush(Framebuffer framebuffer);

- -

Видео-драйвер обычно выполняет рисование не в тот момент, когда вы отправляете соответствующую команду, а откладывает этот процесс до тех под пока операционная система не затребует отобразить результат рисования на экране.

- -

Данная функция заставляет видео-драйвер завершить все операции немедленно. Обычно вам не нужно будет её использовать, везде где это требуется Helianthus сделает это за вас. Однако, эта функция вам может понадобиться если вы используете функции OpenGL напрямую, минуя функции рисования библиотеки Helianthus.

- -

int framebufferGetWidth(Framebuffer framebuffer);

- -

Возвращает ширину буфера кадра в пикселях. См. также framebufferGetHeight.

- -

int framebufferGetHeight(Framebuffer framebuffer);

- -

Возвращает высоту буфера кадра в пикселях. См. также framebufferGetWidth.

- -

unsigned int framebufferGetGLTexId(Framebuffer framebuffer);

- -

Возвращает внутренний идентификатор текстуры OpenGL связанной с буфером кадра. См. также framebufferGetGLId, framebufferFlush.

- -

unsigned int framebufferGetGLId(Framebuffer framebuffer);

- -

Возвращает внутренний идентификатор буфера кадра OpenGL. См. также framebufferGetGLTexId, framebufferFlush.

- -

void projectionByViewport();

- -

Устанавливает матрицу проекции OpenGL таким образом, чтобы начало координат было в верхнем левом углу области вывода OpenGL, а единичный отрезок соответствовал размеру пикселя. См. также targetEx.

- -

void viewportByFramebuffer(Framebuffer framebuffer);

- -

Устанавливает область вывода OpenGL на всю площадь заданного буфера кадра. См. также targetEx.

- -

void viewportByWindow();

- -

Устанавливает область вывода OpenGL на всю площадь окна. См. также targetEx.

- -

void targetEx(Framebuffer framebuffer, int updateViewport, int updateProjection);

- -

Устанавливает текущую область рисования. Если framebuffer не NULL, то рисование будет производиться на буфере кадра, иначе на окне. Параметры updateViewport и updateProjection позволяют вам отключить изменение области вывода OpenGL и матрици проекции соответственно. См. также target, noTarget, viewportByFramebuffer, viewportByWindow, projectionByViewport.

- -

Параметры:

- -

framebuffer — буфер кадра, если NULL, то окно программы будет выбрано в качестве целевого холста для рисования;
-updateViewport — задать область вывода OpenGL соответствующую новому целевому холсту (TRUE или FALSE, см. viewportByFramebuffer, viewportByWindow);
-updateProjection — задать матрицу проекции OpenGL соответствующую новой области вывода (TRUE или FALSE, см. projectionByViewport), игнорируется если updateViewport выключен.

- -

void target(Framebuffer framebuffer);

- -

Функция выбирает буфер кадра в качестве целевого холста для рисования. Последующие операции рисование будет проводиться на данном буфере кадра. Если вы будете работать с функциями OpenGL напрямую, минуя функции рисования Helianthus, то вам необходимо знать, что данная функция меняет область вывода (glViewport) и матрицу проекции OpenGL.

- -

См. также noTarget, targetEx, saveState, restoreState.

- -

Параметры:

- -

framebuffer — буфер кадра, если NULL, то окно программы будет выбрано в качестве целевого холста для рисования

- -

void noTarget();

- -

Выбрать окно программы в качестве целевого холста для рисования. См. также target, saveState, restoreState.

- -
- - diff --git a/doc/ru/common.html b/doc/ru/common.html index 839ddfd..8fae1fb 100644 --- a/doc/ru/common.html +++ b/doc/ru/common.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/drawing.html b/doc/ru/drawing.html index 2291219..93e623c 100644 --- a/doc/ru/drawing.html +++ b/doc/ru/drawing.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/font.html b/doc/ru/font.html index 7427acd..72e1d1d 100644 --- a/doc/ru/font.html +++ b/doc/ru/font.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/framebuffer.html b/doc/ru/framebuffer.html index 69c597f..722bc48 100644 --- a/doc/ru/framebuffer.html +++ b/doc/ru/framebuffer.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/functions.html b/doc/ru/functions.html index cb53fb3..0ad7246 100644 --- a/doc/ru/functions.html +++ b/doc/ru/functions.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/groups.html b/doc/ru/groups.html index 951a507..d5b2e63 100644 --- a/doc/ru/groups.html +++ b/doc/ru/groups.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/image/figure2.png b/doc/ru/image/figure2.png new file mode 100644 index 0000000..cd1642b Binary files /dev/null and b/doc/ru/image/figure2.png differ diff --git a/doc/ru/image/figure3.png b/doc/ru/image/figure3.png new file mode 100644 index 0000000..ed6433e Binary files /dev/null and b/doc/ru/image/figure3.png differ diff --git a/doc/ru/image/figure4.png b/doc/ru/image/figure4.png new file mode 100644 index 0000000..bfd402e Binary files /dev/null and b/doc/ru/image/figure4.png differ diff --git a/doc/ru/index.html b/doc/ru/index.html index 12742a3..ceb90ed 100644 --- a/doc/ru/index.html +++ b/doc/ru/index.html @@ -2,11 +2,14 @@ -Helianthus +Helianthus: Документация - Helianthus
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

@@ -21,34 +24,16 @@
-

Helianthus

- -

Мультимедиа библиотека для того чтобы изучать язык Си было весело и интересно.

- -

Язык Си максимально приближен к машинному языку процессора, и, программирование на Си позволяет вам лучше понять как устроен компьютер. Поняв язык Си вы с лёгкостью освоите любой другой язык программирования.

- -

Однако начинать изучать язык Си опираясь только на стандартные функции достаточно скучно. Всё с чем мы можем работать (помимо вычислений) — это текстовый терминал где мы можем читать и выводить текст.

- -

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

+

Helianthus: Документация

-

Данная библиотека предоставляет вам набор простых функций для работы с графикой, звуком и физикой, для того чтобы вы в самом начале изучения языка Си могли создавать интересные и наглядные примеры.

+

Библиотека Helianthus предоставляет вам набор простых функций для работы с графикой, звуком и физикой, для того чтобы вы в самом начале изучения языка Си могли создавать интересные и наглядные примеры.

+

Сайт:

+

https://coolbug.org/users/bw/helianthus/ru.html

-

Ссылки для скачивания:

- -

Репозиторий библиотеки:

- -

https://coolbug.org/earthworm/user/bw/repo/helianthus
-https://repo.coolbug.org/bw/helianthus

- -

Репозиторий с примерами:

- -

https://coolbug.org/earthworm/user/bw/repo/helianthusexamples
-https://repo.coolbug.org/bw/helianthusexamples

-
diff --git a/doc/ru/input.html b/doc/ru/input.html index 4da9595..1a9141c 100644 --- a/doc/ru/input.html +++ b/doc/ru/input.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/install.html b/doc/ru/install.html new file mode 100644 index 0000000..ebf0baf --- /dev/null +++ b/doc/ru/install.html @@ -0,0 +1,126 @@ + + + + +Установка - Helianthus + + +
+

Helianthus

+
+

Helianthus: Документация

+

Установка

+

Запуск и общие функции

+

Клавиатура и мышь

+

Рисование

+

Шрифты и текст

+

Текстуры и анимация

+

Буфер кадра

+

Спрайты

+

Группы спрайтов

+

Звук

+
+

Все функции

+
+
+ +

Установка

+ +

Сборка с исходных кодов под Linux:

+ +

*инструкции для Windows ниже

+ +

Для установки под Linux вам нужно установить следующие зависимости:
+    GCC, Scons, SDL2, SDL2-mixer, SDL2-image, FreeType2, git

+ +

Для Debian и других apt-дистрибутивов команда установки зависимостей будет выглядеть так:

+ +
+sudo apt-get install build-essential gcc scons \
+libsdl2-dev libsdl2-mixer-dev libsdl2-image-dev \
+libfreetype6-dev git
+
+ + +

Далее необходимо скачать исходные коды:

+ +
+git clone https://coolbug.org/earthworm/repo/bw/helianthus
+cd helianthus
+
+ + +

И запустить процесс компиляции и установки:

+ +
+scons
+sudo scons install
+
+ + +

Теперь вы можете использовать Helianthus в ваших программах. Командная строка для компиляции программы состоящей из одного файла может, например, выглядеть так:

+ +
+cc `pkg-config --cflags --libs helianthus` myprogram.c -o myprogram
+
+ + +

Установка под Windows:

+ +

Для Windows вы можете скачать, распаковать и использовать скомпилированные файлы библиотеки:
+    https://coolbug.org/downloads/bw/helianthus/helianthus-bin-latest.zip

+ +

В качестве компилятора используйте Mingw-w64:
+    https://mingw-w64.org

+ +

Для компиляции вам необходимо указать путь к папке include/helianthus, например:

+ +
+-I"C:/dev/helianthus-bin-v0.0/include/helianthus"
+
+ + +

И добавить следующие библиотеки для компоновщика (linker):

+ +
+"C:/dev/helianthus-bin-v0.0/lib-win64/libhelianthus.a" \
+-lmingw32 -mconsole -lm -static-libgcc \
+-lopengl32 -ldinput8 -ldxguid -ldxerr8 \
+-luser32 -lgdi32    -lshlwapi -lwinmm -limm32 \
+-lole32 -loleaut32 -lshell32 -lsetupapi -lversion -luuid
+
+ + +

Будьте внимательны здесь вам правильно необходимо указать путь к своей папке с файлами Helianthus, а также выбрать архитектуру (win32 или win64) для библиотеки.

+ +

В качестве среды разработки можете попробовать CodeBlocks (https://codeblocks.org). Возможно, это не самая лучшая среда разработки, но она позволяет быстро скомпилировать любой выбранный вами *.c файл без создания проекта. Выбирайте версию со встроенным Mingw-w64, тогда вам не придётся устанавливать его отдельно и настраивать под него CodeBlocks.

+ +

Проверена работа с версией codeblocks-20.03mingw:
+    http://sourceforge.net/projects/codeblocks/files/Binaries/20.03/Windows/codeblocks-20.03mingw-setup.exe

+ +

Для подключения Helianthus в CodeBlocks вам необходимо выполнить следующие настройки:

+ +

Открыть настройки компилятора:

+ + +

Зайти в раздел «Global Compiler Settings» на вкладку «Search directories» → «Compiler», и добавить путь к папке, которая содержит файл helianthus.h:

+ + +

Затем перейти на вкладку «Linker settings» и вписать в окно «Other linking options» путь к файлу libhelianthus.a соответствующему вашей архитектуре (win32 или win64), а также следующие библиотеки:

+ +
+-lmingw32 -mconsole -lm -static-libgcc
+-lopengl32 -ldinput8 -ldxguid
+-ldxerr8 -luser32 -lgdi32
+-lshlwapi -lwinmm -limm32
+-lole32 -loleaut32 -lshell32
+-lsetupapi -lversion -luuid
+
+ + + +

Теперь вы можете использовать Helianthus в ваших программах в CodeBlocks.

+ +
+ + diff --git a/doc/ru/sound.html b/doc/ru/sound.html index 368d670..5a5fd0e 100644 --- a/doc/ru/sound.html +++ b/doc/ru/sound.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

diff --git a/doc/ru/sprites.html b/doc/ru/sprites.html index 7de0f49..79f9fa4 100644 --- a/doc/ru/sprites.html +++ b/doc/ru/sprites.html @@ -6,7 +6,10 @@
-

Helianthus

+

Helianthus

+
+

Helianthus: Документация

+

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование