Tree - bw/helianthus - Cool Bug Repo

bw / helianthus

Blame doc/ru/common.html

Blob History Raw

Ivan Mahonin	7a004b	`<html>`
Ivan Mahonin	7a004b	`<head>`
Ivan Mahonin	7a004b	`<meta charset="UTF-8" />`
Ivan Mahonin	7a004b	`<link rel="stylesheet" type="text/css" href="style.css" />`
Ivan Mahonin	7a004b	`<title>Запуск и общие функции - Helianthus</title>`
Ivan Mahonin	7a004b	`</head>`
Ivan Mahonin	7a004b	`<body>`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Helianthus`
Ivan Mahonin	7a004b	`Запуск и общие функции`
Ivan Mahonin	7a004b	`Клавиатура и мышь`
Ivan Mahonin	7a004b	`Рисование`
Ivan Mahonin	7a004b	`Спрайты`
Ivan Mahonin	7a004b	`Группы спрайтов`
Ivan Mahonin	7a004b	`Камера`
Ivan Mahonin	7a004b	`Звук`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Все функции`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Запуск и общие функции`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Для подключения и использования библиотеки Helianthus нужно:`
Ivan Mahonin	7a004b	`- подключить файл <helianthus.h>`
Ivan Mahonin	7a004b	`- создать и зарегистрировать функции для начальной загрузки и для перерисовки кадра (см. worldSetInit и worldSetDraw)`
Ivan Mahonin	1badb6	`- также вы можете зарегистрировать функцию для выполнения каких-либо действий при завершении программы (worldSetDeinit);`
Ivan Mahonin	7a004b	`- вызвать функцию worldRun для запуска вашей программы`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Вот что должно получиться:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`#include <helianthus.h>`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void init() {`
Ivan Mahonin	7a004b	`// Здесь будут команды для начальной загрузки.`
Ivan Mahonin	7a004b	`// Они выполнятся только один раз в самом начале.`
Ivan Mahonin	7a004b	`}`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void draw() {`
Ivan Mahonin	7a004b	`// Здесь будут команды для движения и рисования.`
Ivan Mahonin	7a004b	`// Во время работы программы они будут запускаться`
Ivan Mahonin	7a004b	`// несколько раз в секунду.`
Ivan Mahonin	7a004b	`}`
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	`void deinit() {`
Ivan Mahonin	1badb6	`// Команды внутри этой функции запустятся`
Ivan Mahonin	1badb6	`// только один раз в самом конце при завершении`
Ivan Mahonin	1badb6	`// работы программы.`
Ivan Mahonin	1badb6	`}`
Ivan Mahonin	1badb6
Ivan Mahonin	7a004b	`int main() {`
Ivan Mahonin	7a004b	`worldSetInit(&init);`
Ivan Mahonin	7a004b	`worldSetDraw(&draw);`
Ivan Mahonin	1badb6	`worldSetDeinit(&deinit);`
Ivan Mahonin	7a004b	`worldRun();`
Ivan Mahonin	7a004b	`return 0;`
Ivan Mahonin	7a004b	`}`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	После завершения работы Helianthus (при окончании выполнения функции worldRun) все созданные вами объекты библиотеки будут удалены автоматически. Если вы хотите удалить что-то вручную, смотрите функции удаления для соответствующих объектов (spriteDestroy, groupDestroy, soundDestroy, fontDestroy, closeDirectory).
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Вы можете задать размер окна программы функциями worldSetWidth, worldSetHeight и задать заголовок окна функцией worldSetTitle.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Изначально окно имеет фиксированный размер, который вы можете менять только из программы, командами указанными выше. Однако вы можете это изменить и разрешить пользователю изменять размер окна, смотрите функцию worldSetResizable.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Окно программы непрерывно перерисовывается с частотой 24 кадра в секунду. Частоту перерисовки вы можете поменять при помощи функции worldSetFrameRate.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Программа ведёт отсчёт времени и кадров с момента запуска вы можете получить значение этих счётчиков пи помощи функций worldGetSeconds и worldGetFrameCount. Длительность одного кадра можно узнать вызвав функцию worldGetTimeStep.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Также Helianthus предоставляет некоторые общие функции которые не представлены в стандартном я зыке C:`
Ivan Mahonin	1badb6	`- помощники в генерации случайных чисел (randomNumber, randomFloat);`
Ivan Mahonin	1badb6	`- функции для чтения папок (см. openDirectory);`
Ivan Mahonin	1badb6	`- функции проверки существования файлов и папок — fileExists, directoryExists.`
Ivan Mahonin	1badb6	`- функции для создания всплывающие окна с текстовыми сообщениями (messageBox) и окон для ввода текста (askText, askTextEx).`
Ivan Mahonin	1badb6
Ivan Mahonin	7a004b	`Функции:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldSetInit(Callback init);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Задать функцию для начальной инициализации (загрузки). Эта функция будет запущена только один раз в самом начале работы программы, как только будет вызвана функция worldRun.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`init — указатель на функцию начальной инициализации (загрузки). Функция быть работать без параметров и не должна возвращать значение.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldSetDraw(Callback draw);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Задать основную функцию вашей программы — функцию для перерисовки кадра. Во время работы программы заданная функция будет запускаться несколько раз в секунду перед перерисовкой каждого кадра. Поместите в неё команды для движения и рисования.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`draw — указатель на функцию перерисовки кадра. Функция быть работать без параметров и не должна возвращать значение.`
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	`void worldSetDeinit(Callback deinit);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Задать функцию для выполнения каких-либо действий при завершении программы. Эта функция будет запущена только один раз при окончании работы программы, непосредственно перед завершением выполнения функции worldRun.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`deinit — указатель на функцию которая будет выполнена перед завершением программы.`
Ivan Mahonin	1badb6
Ivan Mahonin	7a004b	`void worldRun();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Запустить вашу программу на Helianthus. Перед вызовом этой функции нужно зарегистрировать функции начальной загрузки и перерисовки кадра (см. выше)`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldStop();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	Остановить и закрыть программу. Программа всегда закрывается если пользователь нажмёт на крестик в верхнем правом углу окна, но вы можете добавить и свои способы выхода из программы. Например, в функцию перерисовки вы можете вставить возможность выхода по нажатию клавиши Esc (см. также раздел «Клавиатура и мышь»):
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void draw() {`
Ivan Mahonin	7a004b	`…`
Ivan Mahonin	7a004b	`if (keyWentPressed("escape")) {`
Ivan Mahonin	7a004b	`worldStop()`
Ivan Mahonin	7a004b	`}`
Ivan Mahonin	7a004b	`…`
Ivan Mahonin	7a004b	`}`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`int worldGetWidth();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает ширину окна в пикселях. См. также worldSetWidth.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldSetWidth(int width);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Установить ширину окна. См. также worldGetWidth.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`width — новая ширина окна.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`int worldGetHeight();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает высоту окна в пикселях. См. также worldSetHeight.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldSetHeight(int height);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Установить высоту окна. См. также worldGetHeight.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`height — новая ширина окна.`
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	`int worldGetResizable();`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает TRUE если пользователь имеет возможность изменять размер окна, в противном случае возвращает FALSE.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void worldSetResizable(int resizable);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Включает или выключает возможность измерения размеров окна пользователем. Когда включено пользователь может менять размер окна растягивая его, хватаясь за границы, и, появляется кнопка для разворачивания окна на весь экран.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`resizable — если TRUE, то разрешает пользователю изменять размер окна.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`const char* worldGetTitle();`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает установленный ранее заголовок окна (строка текста).`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void worldSetTitle(const char *title);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Установить заголовок окна.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`title — новый заголовок окна.`
Ivan Mahonin	1badb6
Ivan Mahonin	7a004b	`double worldGetFrameRate();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает частоту перерисовки окна, количество кадров в секунду. См. также worldSetFrameRate.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`void worldSetFrameRate(double frameRate);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Установить частоту перерисовки окна. См. также worldGetFrameRate.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`frameRate — количество кадров в секунду, от 1 до 100.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`double worldGetTimeStep();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает длительность одного кадра в секундах. См. также worldGetFrameRate.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`int worldGetFrameCount();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает количество кадров прошедшее с момента запуска программы (с момента вызова функции worldRun. См. также worldGetSeconds.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`double worldGetSeconds();`
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	`Возвращает количество секунд прошедшее с момента запуска программы (с момента вызова функции worldRun. См. также worldGetFrameCount.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`int randomNumber(int min, int max);`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает случайное целое число от min до max включительно.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Параметры:`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`min — минимальное значение для случайного числа;`
Ivan Mahonin	7a004b	`max — максимальное значение для случайного числа.`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`double randomFloat();`
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`Возвращает случайное дробное число в диапазоне от 0 до 1.`
Ivan Mahonin	7a004b
Ivan Mahonin	1badb6	`Directory openDirectory(const char *path);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Если папка существует, то функция читает список файлов в папке и сохраняет этот список в памяти. Возвращает значение типа Directory, которое является адресом в памяти — указателем на описание списка внутри библиотеки Helianthus.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Если папка не существует или её по какой-то причине невозможно открыть, то функция возвращает нулевой указатель (NULL).`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Имена файлов можно получить при помощи функций directoryGetCount и directoryGet. После использования список нужно удалить функцией closeDirectory.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Пример:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Directory dir = openDirectory("my/directory");`
Ivan Mahonin	1badb6	`if (dir) {`
Ivan Mahonin	1badb6	`for(int i = 0; i < directoryGetCount(dir); ++i) {`
Ivan Mahonin	1badb6	`printf("file: %s", directoryGet(dir, i));`
Ivan Mahonin	1badb6	`}`
Ivan Mahonin	1badb6	`closeDirectory(dir);`
Ivan Mahonin	1badb6	`}`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`path — путь к папке.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void closeDirectory(Directory directory);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Удаляет ранее загруженный список файлов из памяти. См. также openDirectory.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	Важно: Скорее всего у вас в программе останется переменная в которой хранился указатель на список. Этот указатель станет недействителен — будет указывать на неопределённую область памяти — не на список файлов. Вы можете занести в эту переменную другую список файлов, но использовать старое значение переменной больше нельзя это приведёт к ошибкам и непредсказуемому поведению программы.
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`int directoryGetCount(Directory directory);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает количество файлов в списке. См. также openDirectory и directoryGet.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`const char* directoryGet(Directory directory, int i);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает имя файла с указанным номером из ранее открытого списка. См. также openDirectory и directoryGet.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`i — номер файла в списке.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`int fileExists(const char *path);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает TRUE (число 1) если файл по заданному пути существует, иначе возвращает FALSE (число 0).`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`path — путь к проверяемому файлу.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`int directoryExists(const char *path);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Возвращает TRUE (число 1) если папке по заданному пути существует, иначе возвращает FALSE (число 0).`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`path — путь к проверяемой папке.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void messageBox(const char *message);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Показать окно с текстовым сообщением. Работа программы будет приостановлена, до тех пор пока пользователь не закроет окно (нажав на кнопку OK, например).`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`message — текстовое сообщение.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void askText(const char question, char answer, int maxAnswerSize);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Создаёт окно для ввода текста. Пользователю будет предоставлена для редактирования строка текста из параметра answer. Работа программы будет приостановлена, до тех пор пока пользователь не закончит ввод и не закроет окно. См. также askTextEx.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`question — сообщение для пользователя;`
Ivan Mahonin	1badb6	`answer — указатель на строку куда будет сохранён ответ, также этот параметр используется чтобы задать начальное значение для текстового поля;`
Ivan Mahonin	1badb6	`maxAnswerSize — максимальный размер для строки ответа в байтах включая ограничивающий нулевой байт.`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`void askTextEx(const char question, char answer, int maxAnswerSize, int multiline, int password);`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	Создаёт окно для ввода текста. Пользователю будет предоставлен для редактирования текст из параметра answer. Позволяет работать с многострочным текстом и прятать вводимые символы (для ввода пароля). Работа программы будет приостановлена, до тех пор пока пользователь не закончит ввод и не закроет окно. См. также askText.
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`Параметры:`
Ivan Mahonin	1badb6
Ivan Mahonin	1badb6	`question — сообщение для пользователя;`
Ivan Mahonin	1badb6	`answer — указатель на строку куда будет сохранён ответ, также этот параметр используется чтобы задать начальное значение для текстового поля;`
Ivan Mahonin	1badb6	`maxAnswerSize — максимальный размер для строки ответа в байтах включая ограничивающий нулевой байт;`
Ivan Mahonin	1badb6	`multiline — если TRUE, то будет отображаться поле для ввода многострочного текста;`
Ivan Mahonin	1badb6	`password — если TRUE, то вводимые символы будут спрятаны (можно использовать для ввода паролей).`
Ivan Mahonin	1badb6
Ivan Mahonin	7a004b
Ivan Mahonin	7a004b	`</body>`
Ivan Mahonin	7a004b	`</html>`

bw / helianthus

Source Code

Blame doc/ru/common.html

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

Функции:

void worldSetInit(Callback init);

Параметры:

void worldSetDraw(Callback draw);

Параметры:

void worldSetDeinit(Callback deinit);

Параметры:

void worldRun();

void worldStop();

int worldGetWidth();

void worldSetWidth(int width);

Параметры:

int worldGetHeight();

void worldSetHeight(int height);

Параметры:

int worldGetResizable();

void worldSetResizable(int resizable);

Параметры:

const char* worldGetTitle();

void worldSetTitle(const char *title);

Параметры:

double worldGetFrameRate();

void worldSetFrameRate(double frameRate);

Параметры:

double worldGetTimeStep();

int worldGetFrameCount();

double worldGetSeconds();

int randomNumber(int min, int max);

Параметры:

double randomFloat();

Directory openDirectory(const char *path);

Параметры:

void closeDirectory(Directory directory);

int directoryGetCount(Directory directory);

const char* directoryGet(Directory directory, int i);

Параметры:

int fileExists(const char *path);

Параметры:

int directoryExists(const char *path);

Параметры:

void messageBox(const char *message);

Параметры:

void askText(const char *question, char *answer, int maxAnswerSize);

Параметры:

void askTextEx(const char *question, char *answer, int maxAnswerSize, int multiline, int password);

Параметры:

void askText(const char question, char answer, int maxAnswerSize);

void askTextEx(const char question, char answer, int maxAnswerSize, int multiline, int password);