Класс QSurfaceFormat

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

Этот класс был представлен в Qt 5.0.

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

Публичные типы

Публичные функции

Статические публичные члены

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

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

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

Примечание: При устранении неполадок с контекстом или форматом окна может быть полезно включить категорию логгирования qt.qpa.gl. В зависимости от платформы это может вывести полезную отладочную информацию, касающуюся инициализации OpenGL и конфигураций нативных визуальных или фреймбуферов, к которым QSurfaceFormat сопоставляется.

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

enum QSurfaceFormat::ColorSpace

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

enum QSurfaceFormat::FormatOptionflags QSurfaceFormat::FormatOptions

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

Тип FormatOptions является типом-псевдонимом для 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(const QSurfaceFormat &other)

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

QSurfaceFormat::QSurfaceFormat(QSurfaceFormat::FormatOptions options)

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

QSurfaceFormat::QSurfaceFormat()

Создает QSurfaceFormat с инициализацией по умолчанию.

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

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

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

QSurfaceFormat::~QSurfaceFormat()

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

int QSurfaceFormat::alphaBufferSize() const

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

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

int QSurfaceFormat::blueBufferSize() const

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

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

QSurfaceFormat::ColorSpace QSurfaceFormat::colorSpace() const

Возвращает цветовое пространство.

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

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

[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().

QSurfaceFormat::OpenGLContextProfile QSurfaceFormat::profile() const

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

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

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

int QSurfaceFormat::redBufferSize() const

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

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

QSurfaceFormat::RenderableType QSurfaceFormat::renderableType() const

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

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

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

int QSurfaceFormat::samples() const

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

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

void QSurfaceFormat::setAlphaBufferSize(int size)

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

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

void QSurfaceFormat::setBlueBufferSize(int size)

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

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

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

void QSurfaceFormat::setColorSpace(QSurfaceFormat::ColorSpace colorSpace)

Устанавливает предпочтительный цветовой пространство.

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

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

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

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

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

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

Устанавливает глобальный по умолчанию формат поверхности 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)

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

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

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

void QSurfaceFormat::setMajorVersion(int major)

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

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

void QSurfaceFormat::setMinorVersion(int minor)

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

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

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

void QSurfaceFormat::setOption(QSurfaceFormat::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(QSurfaceFormat::OpenGLContextProfile profile)

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

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

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

void QSurfaceFormat::setRedBufferSize(int size)

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

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

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

void QSurfaceFormat::setRenderableType(QSurfaceFormat::RenderableType type)

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

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

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

void QSurfaceFormat::setSamples(int numSamples)

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

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

void QSurfaceFormat::setStencilBufferSize(int size)

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

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

void QSurfaceFormat::setStereo(bool enable)

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

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

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

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

void QSurfaceFormat::setSwapBehavior(QSurfaceFormat::SwapBehavior behavior)

Устанавливает поведение обмена буферов (swap) для поверхности.

Поведение обмена буферов определяет, нужно ли использовать одно-, двойное или тройное буферирование. По умолчанию, 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().

QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior() const

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

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

int QSurfaceFormat::swapInterval() const

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

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

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

bool QSurfaceFormat::testOption(QSurfaceFormat::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().