Skip to content

Latest commit

 

History

History
1083 lines (1083 loc) · 71.1 KB

File metadata and controls

1083 lines (1083 loc) · 71.1 KB

Список методов в категории Text:

UseNewDefaultFonts

Описание

Начиная с версии 2.0.20 AGK имеет новую систему шрифтов, которая может отображать больше символов и отображать символы более плавно, однако для сохранения обратной совместимости она по умолчанию отключена. Чтобы использовать новую систему, установите для этой команды значение 1. Это влияет только на шрифт по умолчанию, если вы его сами не установили.

Определение

void agk::UseNewDefaultFonts( int mode )

Параметры

mode - 1=использовать новые шрифты по умолчанию, 0=использовать старые шрифты по умолчанию

Пример кода


SetTextX

Описание

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

Определение

void agk::SetTextX( UINT iTextIndex, float fX )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fX - Новая позиция X.

Пример кода


SetTextY

Описание

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

Определение

void agk::SetTextY( UINT iTextIndex, float fY )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fY - Новая позиция Y.

Пример кода


SetTextVisible

Описание

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

Определение

void agk::SetTextVisible( UINT iTextIndex, int bVisible )

Параметры

iTextIndex - Идентификатор текста для изменения.
bVisible - 1, чтобы нарисовать этот текст, 0, чтобы скрыть его.

Пример кода


SetTextTransparency

Описание

Установите прозрачность текста на определенную настройку с выбором без прозрачности, альфа-прозрачности и аддитивного смешивания. По умолчанию текст создается с альфа-прозрачностью.

Определение

void agk::SetTextTransparency( UINT iTextIndex, int mode )

Параметры

iTextIndex - Идентификатор текста для изменения.
mode - Режим прозрачности для этого текста: 0=выкл., 1=альфа-прозрачность, 2=аддитивное смешивание

Пример кода


SetTextString

Описание

Обновляет строку текстового объекта, новый текст будет отображаться при следующем обновлении экрана.

Определение

void agk::SetTextString( UINT iTextIndex, const char *string )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
string - Новая строка для использования.

Пример кода


SetTextSpacing

Описание

Устанавливает интервал между буквами. Значение 0 не создает зазора между ограничивающими буквами, положительное значение увеличивает этот зазор, отрицательное значение перекрывает буквы. Если каждый символ построен с некоторым пробелом по обе стороны от него в изображении шрифта, то это значение интервала по умолчанию, и эта команда будет увеличивать или уменьшать расстояние от него.

Определение

void agk::SetTextSpacing( UINT iTextIndex, float fSpacing )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fSpacing - Новый интервал для использования.

Пример кода


SetTextSize

Описание

Устанавливает размер текстового объекта, по умолчанию 4. Это значение представляет высоту каждого символа в мировых единицах. Ширина каждого символа зависит от шрифта и рассчитывается в соответствии с заданным размером.

Определение

void agk::SetTextSize( UINT iTextIndex, float fSize )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fSize - Новый размер текста.

Пример кода


SetTextScissor

Описание

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

Определение

void agk::SetTextScissor( UINT iTextIndex, float x, float y, float x2, float y2 )

Параметры

iTextIndex - Идентификатор текста для изменения.
x - Координата x верхнего левого угла прямоугольника для использования в качестве границы клипа.
y - Координата y верхнего левого угла прямоугольника для использования в качестве границы клипа.
x2 - Координата x в правом нижнем углу окна для использования в качестве границы клипа.
y2 - Координата y в правом нижнем углу окна для использования в качестве границы клипа.

Пример кода


SetTextMaxWidth

Описание

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

Определение

void agk::SetTextMaxWidth( UINT iTextIndex, float width )

Параметры

iTextIndex - Идентификатор изменяемого текстового объекта
width - Максимальная ширина, которую будет использовать текст

Пример кода


SetTextPosition

Описание

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

Определение

void agk::SetTextPosition( UINT iTextIndex, float fX, float fY )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fX - Новая позиция X.
fY - Новая позиция Y.

Пример кода


SetTextLineSpacing

Описание

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

Определение

void agk::SetTextLineSpacing( UINT iTextIndex, float fSpacing )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fSpacing - Новый интервал для использования.

Пример кода


SetTextExtendedFontImage

Описание

Задает расширенный шрифт, используемый для этого текстового объекта. Расширенный шрифт предназначен для нестандартных символов выше значения ascii 127 и может быть установлен отдельно для стандартных символов, так что вы можете иметь несколько изображений для расширенного набора и базовое изображение для обычных символов шрифта. AGK имеет встроенный расширенный шрифт, который он использует для текстовых объектов с символами от 128 до 255, эта команда позволяет переопределить его. Если вы устанавливаете все свои текстовые объекты на один и тот же расширенный шрифт, вам следует использовать вместо этого SetTextDefaultExtendedFontImage, так как это сэкономит некоторое время обработки. Изображение должно содержать все белые символы, окруженные прозрачным альфа-каналом. Полностью прозрачные пиксели также должны содержать белый цвет в своих компонентах RGB. Изображение шрифта может быть либо фиксированной ширины, либо переменной ширины. Для фиксированной ширины изображение шрифта должно быть выложено в сетку из 16 символов поперек и 8 символов вниз, начиная с символа ascii 32 (пробел) в левом верхнем углу и продолжая слева направо, сверху вниз, заканчивая символом ascii 127 (DEL) в правом нижнем углу. Ширина изображения должна быть кратна 16, а высота изображения-6. Для переменной ширины изображение должно быть текстурой атласа, сопровождаемой subimages.txt файл, в котором указано расположение каждого символа на изображении. AGK будет искать изображения 32 до 127 включительно в файле подизображений, и любые не найденные будут по умолчанию использовать символ пробела (32). Символы переменной высоты не поддерживаются, и все символы должны быть одинаковой высоты с любым необходимым заполнением, включенным в изображение шрифта. Если этот текстовый объект использует шрифт TrueType, то эта команда не влияет, шрифт TrueType обрабатывает как обычные, так и расширенные символы (unicode).

Определение

void agk::SetTextExtendedFontImage( UINT iTextIndex, UINT iImageID )

Параметры

iTextIndex - Идентификатор изменяемого текстового объекта
iImageID - Изображение, содержащее новый шрифт.

Пример кода


SetTextFont

Описание

Задает шрифт TrueType, используемый для этого текстового объекта. Шрифт должен быть загружен с помощью LoadFont из файла шрифтов TrueType. Это отличается от старых растровых шрифтов тем, что он поддерживает символы юникода, и символы обычно появляются более четкими на экране всех размеров. Обратите внимание, что изменение размера текстового объекта, использующего шрифт TrueType, приведет к перерисовке всех символов из файла шрифта на изображение для рисования, для больших размеров текста с использованием сотен различных символов юникода это может быть медленным процессом, но при нормальном использовании он обычно не заметен. Недавно использованные размеры сохраняются в течение короткого периода времени, поэтому, если вы часто переключаетесь между двумя или тремя размерами текста, вам не нужно будет перерисовывать его, и это будет быстрее. Используйте идентификатор шрифта 0, чтобы использовать встроенный шрифт TrueType, поддерживающий широкий диапазон символов unicode.

Определение

void agk::SetTextFont( UINT iTextIndex, UINT iFontID )

Параметры

iTextIndex - Идентификатор изменяемого текстового объекта.
iFontID - Идентификатор используемого шрифта.

Пример кода


SetTextFontImage

Описание

Устанавливает шрифт, используемый для этого текстового объекта. AGK имеет встроенный шрифт, который он использует для текстовых объектов, это позволяет вам переопределить его. Если вы устанавливаете все свои текстовые объекты на один и тот же шрифт, вам следует использовать вместо этого SetTextDefaultFontImage, так как это сэкономит некоторое время обработки. Изображение должно содержать все белые символы, окруженные прозрачным альфа-каналом. Полностью прозрачные пиксели также должны содержать белый цвет в своих компонентах RGB. Изображение шрифта может быть либо фиксированной ширины, либо переменной ширины. Для фиксированной ширины изображение шрифта должно быть выложено в сетку из 16 символов поперек и 6 символов вниз, начиная с символа ascii 32 (пробел) в левом верхнем углу и продолжая слева направо, сверху вниз, заканчивая символом ascii 127 (DEL) в правом нижнем углу. Ширина изображения должна быть кратна 16, а высота изображения-6. Для переменной ширины изображение должно быть текстурой атласа, сопровождаемой subimages.txt файл, в котором указано расположение каждого символа на изображении. AGK будет искать изображения 32 до 127 включительно в файле подизображений, и любые не найденные будут по умолчанию использовать символ пробела (32). Символы переменной высоты не поддерживаются, и все символы должны быть одинаковой высоты с любым необходимым заполнением, включенным в изображение шрифта. Начиная с версии 2.0.20 вы можете использовать SetTextFont для использования шрифтов TrueType вместо растровых шрифтов. Вы должны выбрать один или другой, установка растрового шрифта удалит шрифт Truetype, а установка шрифта TrueType удалит растровый шрифт.

Определение

void agk::SetTextFontImage( UINT iTextIndex, UINT iImageID )

Параметры

iTextIndex - Идентификатор изменяемого текстового объекта
iImageID - Изображение, содержащее новый шрифт.

Пример кода


SetTextDepth

Описание

Устанавливает порядок рисования текста между 0-10000, 0 - передняя часть экрана, 10000 - задняя. Все, что больше 10000, приведет к тому, что текст будет вырезан из поля зрения. По умолчанию текст установлен на глубину 9 и отображается выше всех других спрайтов в сцене, установка большей глубины приведет к сортировке текста в прозрачный список порядка рисования, что может снизить производительность. Используйте глубину 0 для достижения наилучшей производительности.

Определение

void agk::SetTextDepth( UINT iTextIndex, int iDepth )

Параметры

iTextIndex - Идентификатор текста для изменения.
iDepth - На какой глубине должен быть нарисован этот текст.

Пример кода


SetTextDefaultMagFilter

Описание

Устанавливает фильтр изображений для всех текстовых объектов и функций печати, использующих шрифт по умолчанию, когда текстовое изображение больше занимаемого им пространства экрана. Ближайшая фильтрация выбирает ближайший пиксель для отображения и может выглядеть блочной. Линейная фильтрация смешивает 4 ближайших пикселя и может выглядеть размытой.

Определение

void agk::SetTextDefaultMagFilter( UINT mode )

Параметры

mode - Используемый режим фильтрации: 0=ближайший, 1=линейный

Пример кода


SetTextDefaultMinFilter

Описание

Устанавливает фильтр изображения для всех текстовых объектов и функций печати, использующих шрифт по умолчанию, когда текстовое изображение меньше занимаемого им пространства экрана. Ближайшая фильтрация выбирает ближайший пиксель для отображения и может выглядеть блочной. Линейная фильтрация смешивает 4 ближайших пикселя и может выглядеть размытой.

Определение

void agk::SetTextDefaultMinFilter( UINT mode )

Параметры

mode - Используемый режим фильтрации: 0=ближайший, 1=линейный

Пример кода


SetTextDefaultExtendedFontImage

Описание

Устанавливает расширенный шрифт по умолчанию для текстовых объектов. Расширенный шрифт предназначен для нестандартных символов выше значения ascii 127 и может быть установлен отдельно для стандартных символов, так что вы можете иметь несколько изображений для расширенного набора и базовое изображение для обычных символов шрифта. AGK имеет встроенный расширенный шрифт для символов от 128 до 255, который он использует для текстовых объектов, что позволяет переопределить его. Если вы решите переопределить его, вы должны сделать это перед созданием любых текстовых объектов. Вы можете установить шрифт для каждого текста с помощью Settextendedfontimage. Изображение должно содержать все белые символы, окруженные прозрачным альфа-каналом. Полностью прозрачные пиксели также должны содержать белый цвет в своих компонентах RGB. Расширенное изображение шрифта может быть либо фиксированной ширины, либо переменной ширины. Для фиксированной ширины изображение шрифта должно быть выложено в сетку из 16 символов поперек и 8 символов вниз, начиная с символа ascii 128 в левом верхнем углу и продолжая слева направо, сверху вниз, заканчивая символом ascii 255 в правом нижнем углу. Ширина изображения должна быть кратна 16, а высота-8. Для переменной ширины изображение должно быть текстурой атласа, сопровождаемой subimages.txt файл, в котором указано расположение каждого символа на изображении. AGK будет искать изображения 128 до 255 включительно в файле подизображений, а любые не найденные будут по умолчанию использовать символ пробела (32).

Определение

void agk::SetTextDefaultExtendedFontImage( UINT iImageID )

Параметры

iImageID - Изображение, содержащее новый шрифт.

Пример кода


SetTextDefaultFontImage

Описание

Устанавливает шрифт по умолчанию для текстовых объектов. AGK имеет встроенный шрифт, который он использует для текстовых объектов, это позволяет вам переопределить его. Если вы решите переопределить его, вы должны сделать это перед созданием любых текстовых объектов. Вы можете установить шрифт для каждого текста с помощью SetTextFontImage. Изображение должно содержать все белые символы, окруженные прозрачным альфа-каналом. Полностью прозрачные пиксели также должны содержать белый цвет в своих компонентах RGB. Изображение шрифта может быть либо фиксированной ширины, либо переменной ширины. Для фиксированной ширины изображение шрифта должно быть выложено в сетку из 16 символов поперек и 6 символов вниз, начиная с символа ascii 32 (пробел) в левом верхнем углу и продолжая слева направо, сверху вниз, заканчивая символом ascii 127 (DEL) в правом нижнем углу. Ширина изображения должна быть кратна 16, а высота изображения-6. Для переменной ширины изображение должно быть текстурой атласа, сопровождаемой subimages.txt файл, в котором указано расположение каждого символа на изображении. AGK будет искать изображения 32 до 127 включительно в файле подизображений, и любые не найденные будут по умолчанию использовать символ пробела (32).

Определение

void agk::SetTextDefaultFontImage( UINT iImageID )

Параметры

iImageID - Изображение, содержащее новый шрифт.

Пример кода


SetTextColorGreen

Описание

Установите зеленый компонент цвета текста. Значение должно находиться в диапазоне 0-255.

Определение

void agk::SetTextColorGreen( UINT iTextIndex, UINT iGreen )

Параметры

iTextIndex - Идентификатор текста для изменения.
iGreen - Зеленая составляющая цвета.

Пример кода


SetTextColorRed

Описание

Установите красный компонент цвета текста. Значение должно находиться в диапазоне 0-255.

Определение

void agk::SetTextColorRed( UINT iTextIndex, UINT iRed )

Параметры

iTextIndex - Идентификатор текста для изменения.
iRed - Красная составляющая цвета.

Пример кода


SetTextColorBlue

Описание

Установите синий компонент цвета текста. Значение должно находиться в диапазоне 0-255.

Определение

void agk::SetTextColorBlue( UINT iTextIndex, UINT iBlue )

Параметры

iTextIndex - Идентификатор текста для изменения.
iBlue - Синяя составляющая цвета.

Пример кода


SetTextColorAlpha

Описание

Установите альфа-компонент цвета текста. Значение должно находиться в диапазоне 0-255.

Определение

void agk::SetTextColorAlpha( UINT iTextIndex, UINT iAlpha )

Параметры

iTextIndex - Идентификатор текста для изменения.
iAlpha - Альфа-компонент цвета.

Пример кода


SetTextColor

Описание

Установите цвет текста, значения должны быть в диапазоне 0-255. Это приведет к тому, что все символы в тексте будут иметь этот цвет. Вы можете установить отдельные символы с помощью SetTextCharColor.

Определение

void agk::SetTextColor( UINT iTextIndex, UINT iRed, UINT iGreen, UINT iBlue, UINT iAlpha )

Параметры

iTextIndex - Идентификатор текста для изменения.
iRed - Красная составляющая цвета.
iGreen - Зеленая составляющая цвета.
iBlue - Синяя составляющая цвета.
iAlpha - Альфа-компонент цвета.

Пример кода


SetTextCharX

Описание

Установите положение X отдельного символа относительно позиции текста, установленной ранее. Символ будет расположен в верхнем левом углу. При вызове любой из следующих команд положение всех символов будет сброшено на прямую линию: SetTextPosition, SetTextX, SetTextY, setTextSize, SetTextSpacing, SetTextAlignment. Позиционирование символов внутри текстового объекта более эффективно, чем позиционирование множества небольших текстовых объектов, каждый из которых содержит символ, поскольку все символы могут быть нарисованы в одном вызове рисования.

Определение

void agk::SetTextCharX( UINT iTextIndex, UINT iCharIndex, float x )

Параметры

iTextIndex - Идентификатор текста для изменения.
iCharIndex - Индекс символа для изменения, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
x - Новая позиция X символа относительно текущей позиции текста.

Пример кода


SetTextCharY

Описание

Установите положение Y отдельного символа относительно позиции текста, установленной ранее. Символ будет расположен в верхнем левом углу. При вызове любой из следующих команд положение всех символов будет сброшено на прямую линию: SetTextPosition, SetTextX, SetTextY, setTextSize, SetTextSpacing, SetTextAlignment. Позиционирование символов внутри текстового объекта более эффективно, чем позиционирование множества небольших текстовых объектов, каждый из которых содержит символ, поскольку все символы могут быть нарисованы в одном вызове рисования.

Определение

void agk::SetTextCharY( UINT iTextIndex, UINT iCharIndex, float y )

Параметры

iTextIndex - Идентификатор текста для изменения.
iCharIndex - Индекс символа для изменения, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
y - Новая позиция символа Y относительно текущей позиции текста.

Пример кода


SetTextCharColorRed

Описание

Задает красный компонент заданного цвета символов. Использование команды SetTextColor переопределит это. Значения должны находиться в диапазоне 0-255.

Определение

void agk::SetTextCharColorRed( UINT iTextIndex, UINT iCharIndex, UINT red )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
red - Новое красное значение для использования

Пример кода


SetTextCharPosition

Описание

Установите положение отдельного символа относительно позиции текста, заданной ранее. Символ будет расположен в верхнем левом углу. При вызове любой из следующих команд положение всех символов будет сброшено на прямую линию: SetTextPosition, SetTextX, SetTextY, setTextSize, SetTextSpacing, SetTextAlignment. Позиционирование символов внутри текстового объекта более эффективно, чем позиционирование множества небольших текстовых объектов, каждый из которых содержит символ, поскольку все символы могут быть нарисованы в одном вызове рисования.

Определение

void agk::SetTextCharPosition( UINT iTextIndex, UINT iCharIndex, float x, float y )

Параметры

iTextIndex - Идентификатор текста для изменения.
iCharIndex - Индекс символа для изменения, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
x - Новая позиция X символа относительно текущей позиции текста.
y - Новая позиция символа Y относительно текущей позиции текста.

Пример кода


SetTextCharColorGreen

Описание

Устанавливает зеленый компонент цвета указанного символа. Использование команды SetTextColor переопределит это. Значения должны находиться в диапазоне 0-255.

Определение

void agk::SetTextCharColorGreen( UINT iTextIndex, UINT iCharIndex, UINT green )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
green - Новое зеленое значение для использования

Пример кода


SetTextCharColorBlue

Описание

Устанавливает синий компонент цвета указанного символа. Использование команды SetTextColor переопределит это. Значения должны находиться в диапазоне 0-255.

Определение

void agk::SetTextCharColorBlue( UINT iTextIndex, UINT iCharIndex, UINT blue )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
blue - Новое синее значение для использования

Пример кода


SetTextCharColor

Описание

Задает цвет указанного символа. Использование команды SetTextColor переопределит это. Значения должны находиться в диапазоне 0-255.

Определение

void agk::SetTextCharColor( UINT iTextIndex, UINT iCharIndex, UINT red, UINT green, UINT blue, UINT alpha )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
red - красная составляющая нового цвета.
green - зеленая составляющая нового цвета.
blue - синий компонент нового цвета.
alpha - альфа-компонент нового цвета.

Пример кода


SetTextCharColorAlpha

Описание

Задает альфа-компонент цвета указанного символа. Использование команды SetTextColor переопределит это. Значения должны находиться в диапазоне 0-255.

Определение

void agk::SetTextCharColorAlpha( UINT iTextIndex, UINT iCharIndex, UINT alpha )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
alpha - Новое альфа-значение для использования

Пример кода


SetTextCharAngleRad

Описание

Установите угол отдельного символа в радианах по часовой стрелке. Персонаж будет вращаться вокруг своего центра. Если какая - либо из следующих команд будет вызвана, то вращение всех символов будет сброшено: SetTextPosition, SetTextX, Settextty, setTextSize, SetTextSpacing, SetTextAlignment.

Определение

void agk::SetTextCharAngleRad( UINT iTextIndex, UINT iCharIndex, float angle )

Параметры

iTextIndex - Идентификатор текста для изменения.
iCharIndex - Индекс символа для изменения, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
angle - Новый угол в радианах.

Пример кода


SetTextCharBold

Описание

Задает символу полужирный стиль. Это применимо только в том случае, если текст использует шрифт TrueType, установленный с помощью SetTextFont. Если вы используете SetTextString, то этот параметр будет сброшен на 0. Вы можете использовать SetTextBold, чтобы установить всю строку жирным шрифтом.

Определение

void agk::SetTextCharBold( UINT iTextIndex, UINT iCharIndex, UINT bold )

Параметры

iTextIndex - Идентификатор устанавливаемого текстового объекта.
iCharIndex - Индекс устанавливаемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
bold - 1, чтобы установить символ как жирный, 0, чтобы установить его как нормальный вес (по умолчанию)

Пример кода


SetTextCharAngle

Описание

Установите угол наклона отдельного символа в градусах по часовой стрелке. Персонаж будет вращаться вокруг своего центра. Если какая - либо из следующих команд будет вызвана, то вращение всех символов будет сброшено: SetTextPosition, SetTextX, Settextty, setTextSize, SetTextSpacing, SetTextAlignment.

Определение

void agk::SetTextCharAngle( UINT iTextIndex, UINT iCharIndex, float angle )

Параметры

iTextIndex - Идентификатор текста для изменения.
iCharIndex - Индекс символа для изменения, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.
angle - Новый угол в градусах.

Пример кода


SetTextAngleRad

Описание

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

Определение

void agk::SetTextAngleRad( UINT iTextIndex, float fAngleRad )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fAngleRad - Новый угол в радианах.

Пример кода


SetTextBold

Описание

Устанавливает все символы в тексте полужирным шрифтом независимо от текущего состояния SetTextCharBold. Этот параметр будет оставаться активным до тех пор, пока он не будет изменен, установка новой текстовой строки не изменит его.

Определение

void agk::SetTextBold( UINT iTextIndex, UINT bold )

Параметры

iTextIndex - Идентификатор текста для изменения.
bold - 1 - жирный шрифт, 0 - нормальный вес (по умолчанию)

Пример кода


SetTextAngle

Описание

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

Определение

void agk::SetTextAngle( UINT iTextIndex, float fAngle )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
fAngle - Новый угол в градусах.

Пример кода


SetTextAlignment

Описание

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

Определение

void agk::SetTextAlignment( UINT iTextIndex, int iMode )

Параметры

iTextIndex - Идентификатор текстового объекта для обновления.
iMode - Режим выравнивания для использования. 0=слева, 1=в центре, 2=справа

Пример кода


SetPrintSpacing

Описание

Устанавливает интервал между буквами. Значение 0 не создает зазора между ограничивающими буквами, положительное значение увеличивает этот зазор, отрицательное значение перекрывает буквы. Это глобальная команда, которая будет влиять на весь печатный текст при следующем вызове синхронизации. Для управления интервалом на основе каждой строки используйте текстовые команды.

Определение

void agk::SetPrintSpacing( float fSpacing )

Параметры

fSpacing - Интервал между буквами для использования.

Пример кода


SetPrintSize

Описание

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

Определение

void agk::SetPrintSize( float fSize )

Параметры

fSize - Размер текста в пикселях виртуального разрешения.

Пример кода


SetPrintFont

Описание

Устанавливает шрифт для использования для всего печатного текста, шрифт должен быть предварительно загружен с помощью LoadFont. Используйте идентификатор шрифта 0, чтобы использовать шрифт AGK по умолчанию.

Определение

void agk::SetPrintFont( int fontID )

Параметры

fontID - Идентификатор шрифта, используемый для печати текста

Пример кода


SetPrintColor

Описание

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

Определение

void agk::SetPrintColor( UINT iRed, UINT iGreen, UINT iBlue )
void agk::SetPrintColor( UINT iRed, UINT iGreen, UINT iBlue, UINT iAlpha )

Параметры

iRed - Красная составляющая цвета.
iGreen - Зеленая составляющая цвета.
iBlue - Синяя составляющая цвета.
iAlpha - Альфа-компонент цвета.

Пример кода


PrintC

Описание

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

Определение

void agk::PrintC( const char *szString )
void agk::PrintC( int i )
void agk::PrintC( float f )

Параметры

szString - Строка для печати.
i - Целое число для печати.
f - float для печати.

Пример кода


Print

Описание

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

Определение

void agk::Print( int i )
void agk::Print( float f )
void agk::Print( const char *szString )

Параметры

i - Целое число для печати.
f - float для печати.
szString - Строка для печати.

Пример кода


GetTextX

Описание

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

Определение

float agk::GetTextX( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор возвращаемого текстового объекта.

Пример кода


GetTextY

Описание

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

Определение

float agk::GetTextY( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор возвращаемого текстового объекта.

Пример кода


GetTextVisible

Описание

Возвращает 0, если текущий текст был установлен как невидимый с помощью SetTextVisible, 1, если он установлен как видимый (по умолчанию). Это не проверяет, находится ли текст в данный момент в видимом видовом окне.

Определение

int agk::GetTextVisible( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextTotalWidth

Описание

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

Определение

float agk::GetTextTotalWidth( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор возвращаемого текстового объекта.

Пример кода


GetTextTotalHeight

Описание

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

Определение

float agk::GetTextTotalHeight( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор возвращаемого текстового объекта.

Пример кода


GetTextString

Описание

Возвращает текущую строку, отображаемую текстовым объектом. В tier 2 возвращаемая строка должна быть удалена, когда вы закончите с ней.

Определение

char* agk::GetTextString( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextSize

Описание

Возвращает текущий размер текстового объекта, заданного с помощью setTextSize.

Определение

float agk::GetTextSize( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextSpacing

Описание

Возвращает текущий интервал текстового объекта, заданного с помощью SetTextSpacing.

Определение

float agk::GetTextSpacing( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextLineSpacing

Описание

Возвращает текущий межстрочный интервал текстового объекта, заданного с помощью SetTextLineSpacing.

Определение

float agk::GetTextLineSpacing( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextLength

Описание

Возвращает текущую длину строки, отображаемой текстовым объектом.

Определение

UINT agk::GetTextLength( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор возвращаемого текстового объекта.

Пример кода


GetTextHitTest

Описание

Возвращает 1, если заданная точка в мировых координатах находится внутри ограничивающего прямоугольника текста. Если вы тестируете мышь или сенсорную координату, не забудьте преобразовать ее в мировые координаты с помощью ScreenToWorldX и ScreenToWorldY. Это не учитывает отдельные позиции символов, например, если вы расположили символ с помощью SetTextCharX или аналогичного. Проверяется только ограничивающая рамка, созданная путем рисования символов в их позициях по умолчанию.

Определение

int agk::GetTextHitTest( UINT iTextIndex, float x, float y )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
x - Координата x точки для проверки в мировых координатах.
y - Координата y точки для проверки в мировых координатах.

Пример кода


GetTextColorRed

Описание

Получите красную составляющую цвета текста. Значение будет находиться в диапазоне 0-255.

Определение

UINT agk::GetTextColorRed( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для проверки.

Пример кода


GetTextExists

Описание

Возвращает 1, если текст существует, и 0, если его нет.

Определение

UINT agk::GetTextExists( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для проверки

Пример кода


GetTextColorGreen

Описание

Получите зеленую составляющую цвета текста. Значение будет находиться в диапазоне 0-255.

Определение

UINT agk::GetTextColorGreen( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для проверки.

Пример кода


GetTextDepth

Описание

Возвращает текущую глубину текстового объекта, где 0-передняя часть экрана, а 10000 - задняя.

Определение

int agk::GetTextDepth( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextColorBlue

Описание

Получите синий компонент цвета текста. Значение будет находиться в диапазоне 0-255.

Определение

UINT agk::GetTextColorBlue( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для проверки.

Пример кода


GetTextColorAlpha

Описание

Получите альфа-компонент цвета текста. Значение будет находиться в диапазоне 0-255.

Определение

UINT agk::GetTextColorAlpha( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для проверки.

Пример кода


GetTextCharColorRed

Описание

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

Определение

UINT agk::GetTextCharColorRed( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharY

Описание

Возвращает текущую позицию Y указанного символа относительно текстового объекта.

Определение

float agk::GetTextCharY( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharX

Описание

Возвращает текущую позицию X указанного символа относительно текстового объекта.

Определение

float agk::GetTextCharX( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharColorGreen

Описание

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

Определение

UINT agk::GetTextCharColorGreen( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharColorBlue

Описание

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

Определение

UINT agk::GetTextCharColorBlue( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharAngleRad

Описание

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

Определение

float agk::GetTextCharAngleRad( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextCharColorAlpha

Описание

Возвращает альфа-компонент заданного цвета символа. Значение будет находиться в диапазоне 0-255.

Определение

UINT agk::GetTextCharColorAlpha( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


GetTextAlignment

Описание

Возвращает текущее выравнивание набора текстовых объектов с помощью SetTextAlignment.

Определение

int agk::GetTextAlignment( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.

Пример кода


GetTextCharAngle

Описание

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

Определение

float agk::GetTextCharAngle( UINT iTextIndex, UINT iCharIndex )

Параметры

iTextIndex - Идентификатор проверяемого текстового объекта.
iCharIndex - Индекс проверяемого символа, индексы начинаются с 0, если индекс находится вне диапазона, он будет проигнорирован.

Пример кода


FixTextToScreen

Описание

По умолчанию текстовые объекты создаются в мировых координатах, и SetViewOffset можно использовать для перемещения по всему миру. Используйте эту команду, чтобы вместо этого зафиксировать текст на экране, чтобы он перемещался вместе с видовым окном при перемещении видового окна. Вы все еще можете изменить положение текста, закрепленного на экране, это влияет только на то, что происходит при перемещении видового экрана.

Определение

void agk::FixTextToScreen( UINT iTextIndex, int mode )

Параметры

iTextIndex - Идентификатор текста, который нужно изменить.
mode - 1=экранный текст, 0=мировой текст

Пример кода


DrawText

Описание

Сразу же рисует текст в backbuffer в его текущем положении, размере и повороте. Это полезно, если вы хотите настроить сцену для захвата getImage. Не забудьте использовать ClearScreen для очистки любого вашего собственного рисунка перед вызовом Sync или Render для фактического кадра, иначе ваш рисунок может появиться дважды в окончательном рендеринге.

Определение

void agk::DrawText( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текста для рисования.

Пример кода


DeleteText

Описание

Удаляет текстовый объект.

Определение

void agk::DeleteText( UINT iTextIndex )

Параметры

iTextIndex - Идентификатор текстового объекта для удаления.

Пример кода


DeleteAllText

Описание

Удаляет все текстовые объекты, созданные с помощью CreateText. Это также сбрасывает идентификатор автотекста до 10000.

Определение

void agk::DeleteAllText()

Параметры

Пример кода


CreateText

Описание

Создает текстовый объект для отображения текста на экране с помощью пустого идентификатора, возвращает используемый идентификатор. По умолчанию текст рисуется на глубине 9 выше глубины спрайтов по умолчанию (10). Любые спрайты, установленные на глубину 8 или меньше, будут отображаться над текстом. Вы можете переопределить это с помощью SetTextDepth, чтобы установить свой собственный порядок розыгрыша.

Определение

UINT agk::CreateText( const char *string )
void agk::CreateText ( UINT iTextIndex, const char *string )

Параметры

string - Начальная строка, используемая в этом текстовом объекте, может быть пустой строкой.
iTextIndex - Текстовый идентификатор, который будет использоваться для ссылки на этот текст позже (отдельно от идентификаторов изображений и спрайтов, поэтому может быть как спрайт 1, так и текст 1)

Пример кода