Класс QSurfaceFormat

Класс QSurfaceFormat представляет формат QSurface. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Открытые типы

Открытые функции

Статические открытые члены

Связанные внешние члены

Подробное описание

Класс QSurfaceFormat представляет формат QSurface.

Формат включает в себя размер буферов цвета: красный, зеленый и синий; размер альфа-буфера; размер буферов глубины и трафарета; и количество выборок на пиксель для многовыборки. Кроме того, формат содержит параметры конфигурации поверхности, такие как профиль и версия OpenGL для рендеринга, включение или отключение стерео буферов и поведение обмена.

Документация по типам членов

enum QSurfaceFormat::FormatOptionflags QSurfaceFormat::FormatOptions

Это перечисление содержит параметры формата для использования с QSurfaceFormat.

Тип FormatOptions является typedef для QFlags<FormatOption>. Он хранит логическое ИЛИ сочетание значений FormatOption.

enum QSurfaceFormat::OpenGLContextProfile

Этот перечисление используется для указания профиля контекста OpenGL в сочетании с QSurfaceFormat::setMajorVersion() и QSurfaceFormat::setMinorVersion().

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

Обратите внимание, что профиль ядра может по-прежнему содержать функциональность, которая устарела и запланирована к удалению в более поздней версии. Чтобы получить доступ к устаревшей функциональности для профиля ядра в установленной версии OpenGL, можно использовать опцию формата QSurfaceFormat QSurfaceFormat::DeprecatedFunctions.

enum QSurfaceFormat::RenderableType

Это перечисление определяет бэкэнд рендеринга для поверхности.

enum QSurfaceFormat::SwapBehavior

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

Документация функций-членов

QSurfaceFormat::QSurfaceFormat()

Создаёт QSurfaceFormat с инициализированными значениями по умолчанию.

Примечание: По умолчанию запрашивается OpenGL 2.0, так как это обеспечивает наивысший уровень портативности между платформами и реализациями OpenGL.

QSurfaceFormat::QSurfaceFormat(FormatOptions options)

Создаёт QSurfaceFormat с заданными параметрами формата options.

QSurfaceFormat::QSurfaceFormat(const QSurfaceFormat &other)

Создаёт копию other.

QSurfaceFormat::~QSurfaceFormat()

Уничтожает QSurfaceFormat.

int QSurfaceFormat::alphaBufferSize() const

Возвращает размер альфа-канала цветового буфера в битах.

См. также setAlphaBufferSize().

int QSurfaceFormat::blueBufferSize() const

Возвращает размер синего канала цветового буфера в битах.

См. также setBlueBufferSize().

[static] QSurfaceFormat QSurfaceFormat::defaultFormat()

Возвращает глобальный формат поверхности по умолчанию.

Если setDefaultFormat() не вызывался, возвращается QSurfaceFormat с значениями по умолчанию.

Эта функция была добавлена в Qt 5.4.

См. также setDefaultFormat().

int QSurfaceFormat::depthBufferSize() const

Возвращает размер буфера глубины.

См. также setDepthBufferSize().

int QSurfaceFormat::greenBufferSize() const

Возвращает размер зеленого канала цветового буфера в битах.

См. также setGreenBufferSize().

bool QSurfaceFormat::hasAlpha() const

Возвращает true, если размер буфера альфа больше нуля.

Это означает, что поверхность может быть использована с эффектами полупрозрачности на пиксельном уровне.

int QSurfaceFormat::majorVersion() const

Возвращает главную версию OpenGL.

Значение по умолчанию - 2.0.

См. также setMajorVersion().

int QSurfaceFormat::minorVersion() const

Возвращает второстепенную версию OpenGL.

См. также setMinorVersion().

QSurfaceFormat::FormatOptions QSurfaceFormat::options() const

Возвращает текущие установленные параметры формата.

Эта функция была добавлена в Qt 5.3.

См. также setOption(), setOptions(), и testOption().

OpenGLContextProfile QSurfaceFormat::profile() const

Получает настроенный профиль контекста OpenGL.

Это значение игнорируется, если запрошенная версия OpenGL меньше 3.2.

См. также setProfile().

int QSurfaceFormat::redBufferSize() const

Получить размер красного канала буфера цвета в битах.

См. также setRedBufferSize().

RenderableType QSurfaceFormat::renderableType() const

Получить тип рендерируемого объекта.

Выбор между настольным OpenGL, OpenGL ES и OpenVG.

См. также setRenderableType().

int QSurfaceFormat::samples() const

Возвращает количество выборок на пиксель при включенном многократном сэмплировании. По умолчанию многократное сэмплирование отключено.

См. также setSamples().

void QSurfaceFormat::setAlphaBufferSize(int size)

Установить желаемый размер альфа-канала буфера цвета в битах.

См. также alphaBufferSize().

void QSurfaceFormat::setBlueBufferSize(int size)

Установить желаемый размер синего канала буфера цвета в битах.

Примечание: В Mac OSX убедитесь, что установлены размеры буферов всех цветовых каналов, иначе это настройка не будет иметь эффекта. Если размер одного из буферов не задан, используется текущая глубина цвета экрана.

См. также blueBufferSize().

[static] void QSurfaceFormat::setDefaultFormat(const QSurfaceFormat &format)

Устанавливает глобальный формат поверхности по умолчанию.

Этот формат используется по умолчанию в QOpenGLContext, QWindow, QOpenGLWidget и аналогичных классах.

Его всегда можно переопределить для каждого экземпляра, используя функцию setFormat() соответствующего класса. Однако часто удобнее установить формат для всех окон один раз в начале приложения. Это также гарантирует правильное поведение в случаях, когда требуются общие контексты, поскольку установка формата через эту функцию гарантирует, что все контексты и поверхности, даже созданные Qt внутри, будут использовать один и тот же формат.

Примечание: При установке Qt::AA_ShareOpenGLContexts, настоятельно рекомендуется вызывать эту функцию перед созданием QGuiApplication или QApplication. В противном случае format не будет применена к глобальному контексту совместного использования, и впоследствии могут возникнуть проблемы с совместным использованием контекстов.

Эта функция была добавлена в Qt 5.4.

См. также defaultFormat().

void QSurfaceFormat::setDepthBufferSize(int size)

Установить минимальный размер буфера глубины на size.

См. также depthBufferSize().

void QSurfaceFormat::setGreenBufferSize(int size)

Установить желаемый размер зелёного канала буфера цвета в битах.

Примечание: В Mac OSX убедитесь, что установлены размеры буферов всех цветовых каналов, иначе эта настройка не будет иметь эффекта. Если размер одного из буферов не задан, используется текущая глубина цвета экрана.

См. также greenBufferSize().

void QSurfaceFormat::setMajorVersion(int major)

Установить желаемую major версию OpenGL.

См. также majorVersion().

void QSurfaceFormat::setMinorVersion(int minor)

Установить желаемую minor версию OpenGL.

Версия по умолчанию — 2.0.

См. также minorVersion().

void QSurfaceFormat::setOption(FormatOption option, bool on = true)

Устанавливает параметр формата option, если on равно true; в противном случае, сбрасывает параметр.

Эта функция была добавлена в Qt 5.3.

См. также setOptions(), options() и testOption().

void QSurfaceFormat::setOptions(QSurfaceFormat::FormatOptions options)

Устанавливает параметры формата на options.

Эта функция была добавлена в Qt 5.3.

См. также options() и testOption().

void QSurfaceFormat::setProfile(OpenGLContextProfile profile)

Устанавливает желаемый профиль контекста OpenGL.

Эта настройка игнорируется, если запрошенная версия OpenGL меньше 3.2.

См. также profile().

void QSurfaceFormat::setRedBufferSize(int size)

Установить желаемый размер красного канала буфера цвета в битах.

Примечание: В Mac OSX убедитесь, что установлены размеры буферов всех цветовых каналов, иначе это настройка не будет иметь эффекта. Если размер одного из буферов не задан, используется текущая глубина цвета экрана.

См. также redBufferSize().

void QSurfaceFormat::setRenderableType(RenderableType type)

Устанавливает желаемый тип рендерируемого объекта.

Выбор между настольным OpenGL, OpenGL ES и OpenVG.

См. также renderableType().

void QSurfaceFormat::setSamples(int numSamples)

Установить предпочтительное количество выборок на пиксель при включенном многократном сэмплировании на numSamples. По умолчанию многократное сэмплирование отключено.

См. также samples().

void QSurfaceFormat::setStencilBufferSize(int size)

Установить предпочтительный размер буфера трафарета в битах.

См. также stencilBufferSize().

void QSurfaceFormat::setStereo(bool enable)

Если enable равно true, включает стереобуферизацию; в противном случае отключает стереобуферизацию.

Стереобуферизация отключена по умолчанию.

Стереобуферизация предоставляет дополнительные буферы цвета для генерации изображений для левого и правого глаза.

См. также stereo().

void QSurfaceFormat::setSwapBehavior(SwapBehavior behavior)

Установить поведение обмена поверхностью.

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

См. также swapBehavior().

void QSurfaceFormat::setSwapInterval(int interval)

Устанавливает предпочтительный интервал обмена. Интервал обмена задаёт минимальное количество видеокадров, отображаемых перед выполнением обмена буферами. Это может использоваться для синхронизации рисования GL в окне с вертикальной разверткой экрана.

Установка значения interval равного 0 отключит вертикальную синхронизацию, любое значение больше 0 включит вертикальную синхронизацию. Установка interval на более высокое значение, например, 10, приводит к 10 вертикальным регенерациям между каждым обменом буферами.

Интервал по умолчанию равен 1.

Изменение интервала обмена может не поддерживаться базовой платформой. В этом случае запрос будет проигнорирован.

Эта функция была добавлена в Qt 5.3.

См. также swapInterval().

void QSurfaceFormat::setVersion(int major, int minor)

Устанавливает желаемые major и minor версии OpenGL.

Версия по умолчанию — 2.0.

См. также version().

int QSurfaceFormat::stencilBufferSize() const

Возвращает размер буфера трафарета в битах.

См. также setStencilBufferSize().

bool QSurfaceFormat::stereo() const

Возвращает true если стереобуферизация включена; в противном случае возвращает false. Стереобуферизация отключена по умолчанию.

См. также setStereo().

SwapBehavior QSurfaceFormat::swapBehavior() const

Возвращает настроенное поведение обмена.

См. также setSwapBehavior().

int QSurfaceFormat::swapInterval() const

Возвращает интервал обмена.

Эта функция была добавлена в Qt 5.3.

См. также setSwapInterval().

bool QSurfaceFormat::testOption(FormatOption option) const

Возвращает true, если опция формата option установлена; в противном случае возвращает false.

Эта функция была добавлена в Qt 5.3.

См. также options().

QPair<int, int> QSurfaceFormat::version() const

Возвращает QPair<int, int>, представляющий версию OpenGL.

Полезно для проверки версий, например, format.version() >= qMakePair(3, 2)

См. также setVersion().

QSurfaceFormat &QSurfaceFormat::operator=(const QSurfaceFormat &other)

Присваивает other этому объекту.