Класс QSurfaceFormat

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

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

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

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

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

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

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

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

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

перечисление QSurfaceFormat::ColorSpace

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

перечисление QSurfaceFormat::FormatOptionфлаги QSurfaceFormat::FormatOptions

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

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

перечисление QSurfaceFormat::OpenGLContextProfile

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

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

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

перечисление QSurfaceFormat::RenderableType

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

перечисление QSurfaceFormat::SwapBehavior

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

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

QSurfaceFormat::QSurfaceFormat(const QSurfaceFormat &other)

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

QSurfaceFormat::QSurfaceFormat(QSurfaceFormat::FormatOptions options)

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

QSurfaceFormat::QSurfaceFormat()

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

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 на платформах, которые это поддерживают.

Эта функция была добавлена в 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 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)

Устанавливает требуемый тип 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().

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