Класс QSurfaceFormat

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

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

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

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

Общедоступные функции

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

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

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

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

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

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

enum QSurfaceFormat::ColorSpace

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

enum QSurfaceFormat::FormatOptionflags QSurfaceFormat::FormatOptions

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

Тип FormatOptions является typedef для QFlags<FormatOption>. Он хранит комбинацию значений FormatOption, полученную с помощью операции OR.

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)

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

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

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

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

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

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

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

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

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

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

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

См. также 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.

Это значение игнорируется, если запрошенная версия 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)

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

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

void QSurfaceFormat::setStereo(bool enable)

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

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

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

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

void QSurfaceFormat::setSwapBehavior(QSurfaceFormat::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().

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