<meta charset="UTF-8">

<link href="style.css" rel="stylesheet" type="text/css">

<title>Запуск и общие функции - Helianthus</title>

  
Helianthus

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

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

  
Рисование

  
Спрайты

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

  
Камера

  
Звук

  
Все функции

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

Для подключения и использования библиотеки Helianthus нужно:

- подключить файл <helianthus.h>

- создать и зарегистрировать  функции для начальной загрузки и для перерисовки кадра (см. worldSetInit и worldSetDraw)

- также вы можете зарегистрировать функцию для выполнения каких-либо действий при завершении программы (worldSetDeinit);

- вызвать функцию worldRun для запуска вашей программы

Вот что должно получиться:

#include <helianthus.h>

void init() {

    // Здесь будут команды для начальной загрузки.

    // Они выполнятся только один раз в самом начале.

}

void draw() {

    // Здесь будут команды для движения и рисования.

    // Во время работы программы они будут запускаться

    // несколько раз в секунду.

}

void deinit() {

    // Команды внутри этой функции запустятся

    // только один раз в самом конце при завершении

    // работы программы.

}

int main() {

    worldSetInit(&init); 

    worldSetDraw(&draw);

    worldSetDeinit(&deinit);

    worldRun();

    return 0;

}

После завершения работы Helianthus (при окончании выполнения функции worldRun) все созданные вами объекты библиотеки будут удалены автоматически. Если вы хотите удалить что-то вручную, смотрите функции удаления для соответствующих объектов (spriteDestroy, groupDestroy, soundDestroy, fontDestroy, closeDirectory).

Вы можете задать размер окна программы функциями worldSetWidth, worldSetHeight и задать заголовок окна функцией worldSetTitle.

Изначально окно имеет фиксированный размер, который вы можете менять только из программы, командами указанными выше. Однако вы можете это изменить и разрешить пользователю изменять размер окна, смотрите функцию worldSetResizable.

Окно программы непрерывно перерисовывается с частотой 24 кадра в секунду. Частоту перерисовки вы можете поменять при помощи функции worldSetFrameRate.

Программа ведёт отсчёт времени и кадров с момента запуска вы можете получить значение этих счётчиков пи помощи функций worldGetSeconds и worldGetFrameCount. Длительность одного кадра можно узнать вызвав функцию worldGetTimeStep.

Также Helianthus предоставляет некоторые общие функции которые не представлены в стандартном я зыке C:

- помощники в генерации случайных чисел (randomNumber, randomFloat);

- функции для чтения папок (см. openDirectory);

- функции проверки существования файлов и папок — fileExists, directoryExists.

- функции для создания всплывающие окна с текстовыми сообщениями (messageBox) и окон для ввода текста (askText, askTextEx).

Функции:

void worldSetInit(Callback init);

Задать функцию для начальной инициализации (загрузки). Эта функция будет запущена только один раз в самом начале работы программы, как только будет вызвана функция worldRun.

Параметры:

init — указатель на функцию начальной инициализации (загрузки). Функция быть работать без параметров и не должна возвращать значение.

void worldSetDraw(Callback draw);

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

Параметры:

draw — указатель на функцию перерисовки кадра. Функция быть работать без параметров и не должна возвращать значение.

void worldSetDeinit(Callback deinit);

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

Параметры:

deinit — указатель на функцию которая будет выполнена перед завершением программы.

void worldRun();

Запустить вашу программу на Helianthus. Перед вызовом этой функции нужно зарегистрировать функции начальной загрузки и перерисовки кадра (см. выше)

void worldStop();

Остановить и закрыть программу. Программа всегда закрывается если пользователь нажмёт на крестик в верхнем правом углу окна, но вы можете добавить и свои способы выхода из программы. Например, в функцию перерисовки вы можете вставить возможность выхода по нажатию клавиши Esc (см. также раздел «Клавиатура и мышь»):

void draw() {

    …

    if (keyWentPressed("escape")) {

        worldStop()

    }

    …

}

int worldGetWidth();

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

void worldSetWidth(int width);

Установить ширину окна. См. также worldGetWidth.

Параметры:

width — новая ширина окна.

int worldGetHeight();

Возвращает высоту окна в пикселях. См. также worldSetHeight.

void worldSetHeight(int height);

Установить высоту окна. См. также worldGetHeight.

Параметры:

height — новая ширина окна.

int worldGetResizable();

Возвращает TRUE если пользователь имеет возможность изменять размер окна, в противном случае возвращает FALSE.

void worldSetResizable(int resizable);

Включает или выключает возможность измерения размеров окна пользователем. Когда включено пользователь может менять размер окна растягивая его, хватаясь за границы, и, появляется кнопка для разворачивания окна на весь экран.

Параметры:

resizable — если TRUE, то разрешает пользователю изменять размер окна.

const char* worldGetTitle();

Возвращает установленный ранее заголовок окна (строка текста).

void worldSetTitle(const char *title);

Установить заголовок окна.

Параметры:

title — новый заголовок окна.

double worldGetFrameRate();

Возвращает частоту перерисовки окна, количество кадров в секунду. См. также worldSetFrameRate.

void worldSetFrameRate(double frameRate);

Установить частоту перерисовки окна. См. также worldGetFrameRate.

Параметры:

frameRate — количество кадров в секунду, от 1 до 100.

double worldGetTimeStep();

Возвращает длительность одного кадра в секундах. См. также worldGetFrameRate.

int worldGetFrameCount();

Возвращает количество кадров прошедшее с момента запуска программы (с момента вызова функции worldRun. См. также worldGetSeconds.

double worldGetSeconds();

Возвращает количество секунд прошедшее с момента запуска программы (с момента вызова функции worldRun. См. также worldGetFrameCount.

int randomNumber(int min, int max);

Возвращает случайное целое число от min до max включительно.

Параметры:

min — минимальное значение для случайного числа;

max — максимальное значение для случайного числа.

double randomFloat();

Возвращает случайное дробное число в диапазоне от 0 до 1.

Directory openDirectory(const char *path);

Если папка существует, то функция читает список файлов в папке и сохраняет этот список в памяти. Возвращает значение типа Directory, которое является адресом в памяти — указателем на описание списка внутри библиотеки Helianthus.

Если папка не существует или её по какой-то причине невозможно открыть, то функция возвращает нулевой указатель (NULL).

Имена файлов можно получить при помощи функций directoryGetCount и directoryGet. После использования список нужно удалить функцией closeDirectory.

Пример:

Directory dir = openDirectory("my/directory");

if (dir) {

    for(int i = 0; i < directoryGetCount(dir); ++i) {

        printf("file: %s", directoryGet(dir, i));

    }

    closeDirectory(dir);

}

Параметры:

path — путь к папке.

void closeDirectory(Directory directory);

Удаляет ранее загруженный список файлов из памяти. См. также openDirectory.

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

int directoryGetCount(Directory directory);

Возвращает количество файлов в списке. См. также openDirectory и directoryGet.

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

Возвращает имя файла с указанным номером из ранее открытого списка. См. также openDirectory и directoryGet.

Параметры:

i — номер файла в списке.

int fileExists(const char *path);

Возвращает TRUE (число 1) если файл по заданному пути существует, иначе возвращает FALSE (число 0).

Параметры:

path — путь к проверяемому файлу.

int directoryExists(const char *path);

Возвращает TRUE (число 1) если папке по заданному пути существует, иначе возвращает FALSE (число 0).

Параметры:

path — путь к проверяемой папке.

void messageBox(const char *message);

Показать окно с текстовым сообщением. Работа программы будет приостановлена, до тех пор пока пользователь не закроет окно (нажав на кнопку OK, например).

Параметры:

message — текстовое сообщение.

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

Создаёт окно для ввода текста. Пользователю будет предоставлена для редактирования строка текста из параметра answer. Работа программы будет приостановлена, до тех пор пока пользователь не закончит ввод и не закроет окно. См. также askTextEx.

Параметры:

question — сообщение для пользователя;

answer — указатель на строку куда будет сохранён ответ, также этот параметр используется чтобы задать начальное значение для текстового поля;

maxAnswerSize — максимальный размер для строки ответа в байтах включая ограничивающий нулевой байт.

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

Создаёт окно для ввода текста. Пользователю будет предоставлен для редактирования текст из параметра answer. Позволяет работать с многострочным текстом и прятать вводимые символы (для ввода пароля). Работа программы будет приостановлена, до тех пор пока пользователь не закончит ввод и не закроет окно. См. также askText.

Параметры:

question — сообщение для пользователя;

answer — указатель на строку куда будет сохранён ответ, также этот параметр используется чтобы задать начальное значение для текстового поля;

maxAnswerSize — максимальный размер для строки ответа в байтах включая ограничивающий нулевой байт;

multiline — если TRUE, то будет отображаться поле для ввода многострочного текста;

password — если TRUE, то вводимые символы будут спрятаны (можно использовать для ввода паролей).