Класс QSurfaceFormat

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

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

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

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

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

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

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

Формат включает размер цветовых буферов, красного, зеленого и синего каналов; размер буфера альфа-канала; размер буферов глубины и трафарета; и количество выборок на пиксель для многовыборочного сэмплирования. Кроме того, формат содержит параметры конфигурации поверхности, такие как профиль и версия 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().

[since 5.10] const QColorSpace &QSurfaceFormat::colorSpace() const

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

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

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

[static, since 5.4] 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().

[since 5.3] 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)

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

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

[since 6.0] void QSurfaceFormat::setColorSpace(const QColorSpace &colorSpace)

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

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

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

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

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

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

[since 5.10] void QSurfaceFormat::setColorSpace(QSurfaceFormat::ColorSpace colorSpace)

Это перегруженная функция.

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

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

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

[static, since 5.4] 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)

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

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

void QSurfaceFormat::setMajorVersion(int major)

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

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

void QSurfaceFormat::setMinorVersion(int minor)

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

По умолчанию версия 2.0.

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

[since 5.3] void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on = true)

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

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

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

[since 5.3] 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)

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

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

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

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

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

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

void QSurfaceFormat::setSamples(int numSamples)

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

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

void QSurfaceFormat::setStencilBufferSize(int size)

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

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

void QSurfaceFormat::setStereo(bool enable)

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

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

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

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

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

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

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

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

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

[since 5.3] int QSurfaceFormat::swapInterval() const

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

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

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

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