Класс QOpenGLBuffer
Класс QOpenGLBuffer предоставляет функции для создания и управления объектами буферов OpenGL. Подробнее...
| Заголовок: | #include <QOpenGLBuffer> |
| qmake: | QT += gui |
| С тех пор: | Qt 5.0 |
Публичные типы
| Перечисление | Access { Только чтение, Только запись, Чтение/запись } |
| Перечисление | RangeAccessFlag { Диапазон чтения, Диапазон записи, Обнуление диапазона, Обнуление буфера, Явное сброс диапазона, Несинхронизированный диапазон } |
| Флаги | RangeAccessFlags |
| Перечисление | Type { Буфер вершин, Буфер индексов, Буфер пикселей (загрузка), Буфер пикселей (распаковка) } |
| Перечисление | UsagePattern { Потоковый вывод, Потоковое чтение, Потоковая копия, Статический вывод, ..., Динамическая копия } |
Публичные функции
| QOpenGLBuffer() | |
| QOpenGLBuffer(QOpenGLBuffer::Type type) | |
| QOpenGLBuffer(const QOpenGLBuffer &other) | |
| ~QOpenGLBuffer() | |
| void | allocate(const void *data, int count) |
| void | allocate(int count) |
| bool | bind() |
| GLuint | bufferId() const |
| bool | create() |
| void | destroy() |
| bool | isCreated() const |
| void * | map(QOpenGLBuffer::Access access) |
| void * | mapRange(int offset, int count, QOpenGLBuffer::RangeAccessFlags access) |
| bool | read(int offset, void *data, int count) |
| void | release() |
| void | setUsagePattern(QOpenGLBuffer::UsagePattern value) |
| int | size() const |
| QOpenGLBuffer::Type | type() const |
| bool | unmap() |
| QOpenGLBuffer::UsagePattern | usagePattern() const |
| void | write(int offset, const void *data, int count) |
| QOpenGLBuffer & | operator=(const QOpenGLBuffer &other) |
Статические публичные члены
| void | release(QOpenGLBuffer::Type type) |
Подробное описание
Класс QOpenGLBuffer предоставляет функции для создания и управления объектами буферов OpenGL.
Объекты буферов создаются на сервере OpenGL, чтобы приложение-клиент могло избежать загрузки вершин, индексов, данных изображения текстуры и т.д. каждый раз, когда они нужны.
Объекты QOpenGLBuffer могут копироваться как ссылка на лежащий в основе объект буфера OpenGL:
QOpenGLBuffer buffer1(QOpenGLBuffer::IndexBuffer);
buffer1.create();
QOpenGLBuffer buffer2 = buffer1; Класс QOpenGLBuffer выполняет поверхностную копию, когда объекты копируются таким образом, но не реализует семантику копирования при изменении. Исходный объект будет затронут всякий раз, когда копия изменяется.
Документация по типам членов
Перечисление QOpenGLBuffer::Access
Это перечисление определяет режим доступа для QOpenGLBuffer::map().
| Постоянная | Значение | Описание |
|---|---|---|
QOpenGLBuffer::ReadOnly |
0x88B8 |
Буфер будет отображен только для чтения. |
QOpenGLBuffer::WriteOnly |
0x88B9 |
Буфер будет отображен только для записи. |
QOpenGLBuffer::ReadWrite |
0x88BA |
Буфер будет отображен для чтения и записи. |
Перечисление QOpenGLBuffer::RangeAccessFlagфлаги QOpenGLBuffer::RangeAccessFlags
Это перечисление определяет биты режима доступа для QOpenGLBuffer::mapRange().
| Постоянная | Значение | Описание |
|---|---|---|
QOpenGLBuffer::RangeRead |
0x0001 |
Буфер будет отображен для чтения. |
QOpenGLBuffer::RangeWrite |
0x0002 |
Буфер будет отображен для записи. |
QOpenGLBuffer::RangeInvalidate |
0x0004 |
Отбросить предыдущее содержимое указанного диапазона. |
QOpenGLBuffer::RangeInvalidateBuffer |
0x0008 |
Отбросить предыдущее содержимое всего буфера. |
QOpenGLBuffer::RangeFlushExplicit |
0x0010 |
Указывает, что изменения должны быть явным образом сброшены с помощью glFlushMappedBufferRange. |
QOpenGLBuffer::RangeUnsynchronized |
0x0020 |
Указывает, что ожидаемые операции не должны быть синхронизированы перед возвратом из mapRange(). |
Тип RangeAccessFlags является типом-синонимом для QFlags<RangeAccessFlag>. Он хранит логическое ИЛИ комбинацию значений RangeAccessFlag.
Перечисление QOpenGLBuffer::Type
Это перечисление определяет тип объекта буфера OpenGL, который нужно создать с помощью QOpenGLBuffer.
| Постоянная | Значение | Описание |
|---|---|---|
QOpenGLBuffer::VertexBuffer |
0x8892 |
Объект буфера вершин для использования при указании массивов вершин. |
QOpenGLBuffer::IndexBuffer |
0x8893 |
Объект буфера индексов для использования с glDrawElements(). |
QOpenGLBuffer::PixelPackBuffer |
0x88EB |
Объект буфера пикселей (загрузка) для чтения данных пикселей с сервера OpenGL (например, с glReadPixels()). Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::PixelUnpackBuffer |
0x88EC |
Объект буфера пикселей (распаковка) для записи данных пикселей на сервер OpenGL (например, с glTexImage2D()). Не поддерживается в OpenGL/ES. |
Перечисление QOpenGLBuffer::UsagePattern
Это перечисление определяет шаблон использования объекта QOpenGLBuffer.
| Постоянная | Значение | Описание |
|---|---|---|
QOpenGLBuffer::StreamDraw |
0x88E0 |
Данные будут установлены один раз и использованы несколько раз для операций рисования. В OpenGL/ES 1.1 это идентично StaticDraw. |
QOpenGLBuffer::StreamRead |
0x88E1 |
Данные будут установлены один раз и использованы несколько раз для чтения данных обратно из сервера OpenGL. Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::StreamCopy |
0x88E2 |
Данные будут установлены один раз и использованы несколько раз для чтения данных обратно из сервера OpenGL для дальнейших операций рисования. Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::StaticDraw |
0x88E4 |
Данные будут установлены один раз и использованы многократно для операций рисования. |
QOpenGLBuffer::StaticRead |
0x88E5 |
Данные будут установлены один раз и использованы многократно для чтения данных обратно из сервера OpenGL. Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::StaticCopy |
0x88E6 |
Данные будут установлены один раз и использованы многократно для чтения данных обратно из сервера OpenGL для дальнейших операций рисования. Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::DynamicDraw |
0x88E8 |
Данные будут изменены многократно и использованы многократно для операций рисования. |
QOpenGLBuffer::DynamicRead |
0x88E9 |
Данные будут изменены многократно и использованы многократно для чтения данных обратно из сервера OpenGL. Не поддерживается в OpenGL/ES. |
QOpenGLBuffer::DynamicCopy |
0x88EA |
Данные будут изменены многократно и использованы многократно для чтения данных обратно из сервера OpenGL для дальнейших операций рисования. Не поддерживается в OpenGL/ES. |
Документация по функциям-членам
QOpenGLBuffer::QOpenGLBuffer()
Создает новый объект буфера типа QOpenGLBuffer::VertexBuffer.
Примечание: этот конструктор просто создает экземпляр QOpenGLBuffer. Фактический объект буфера на сервере OpenGL не создается до вызова create().
См. также create().
QOpenGLBuffer::QOpenGLBuffer(QOpenGLBuffer::Type type)
Создает новый объект буфера типа type.
Примечание: этот конструктор просто создает экземпляр QOpenGLBuffer. Фактический объект буфера на сервере OpenGL не создается до вызова create().
См. также create().
QOpenGLBuffer::QOpenGLBuffer(const QOpenGLBuffer &other)
Создает поверхностную копию other.
Примечание: QOpenGLBuffer не реализует семантику копирования с записью, поэтому other будет затронута всякий раз, когда копия изменяется.
QOpenGLBuffer::~QOpenGLBuffer()
Уничтожает этот объект буфера, включая хранилище, используемое на сервере OpenGL.
void QOpenGLBuffer::allocate(const void *data, int count)
Выделяет count байт памяти в буфере, инициализируя их содержимым data. Любое предыдущее содержимое будет удалено.
Предполагается, что create() был вызван для этого буфера и что он был привязан к текущему контексту.
См. также create(), read() и write().
void QOpenGLBuffer::allocate(int count)
Это перегруженная функция.
Выделяет count байт памяти в буфере. Любое предыдущее содержимое будет удалено.
Предполагается, что create() был вызван для этого буфера и что он был привязан к текущему контексту.
bool QOpenGLBuffer::bind()
Привязывает буфер, связанный с этим объектом, к текущему контексту OpenGL. Возвращает false если привязка невозможна, обычно потому, что type() не поддерживается этой реализацией OpenGL.
Буфер должен быть привязан к тому же QOpenGLContext, что и в момент вызова create(), или к другому QOpenGLContext, который с ним совместно используется. В противном случае из этой функции будет возвращено false.
См. также release() и create().
GLuint QOpenGLBuffer::bufferId() const
Возвращает идентификатор OpenGL, связанный с этим буфером; ноль, если буфер не был создан.
См. также isCreated().
bool QOpenGLBuffer::create()
Создает объект буфера на сервере OpenGL. Возвращает true если объект был создан; в противном случае — false.
Эта функция должна вызываться с текущим QOpenGLContext. Буфер будет привязан к этому контексту и может быть использован только в нём (или в любом другом контексте, который с ним совместно используется).
Эта функция вернет false, если реализация OpenGL не поддерживает буферы или текущего QOpenGLContext нет.
См. также isCreated(), allocate(), write() и destroy().
void QOpenGLBuffer::destroy()
Уничтожает этот объект буфера, включая хранилище, используемое на сервере OpenGL. Все ссылки на буфер станут недопустимыми.
bool QOpenGLBuffer::isCreated() const
Возвращает true если этот буфер был создан; в противном случае — false.
См. также create() и destroy().
void *QOpenGLBuffer::map(QOpenGLBuffer::Access access)
Картирует содержимое этого буфера в адресное пространство приложения и возвращает на него указатель. Возвращает null, если картографирование памяти невозможно. Параметр access указывает тип выполняемой операции доступа.
Предполагается, что create() был вызван для этого буфера и что он был привязан к текущему контексту.
Примечание: Эта функция поддерживается только в OpenGL ES 2.0 или более ранних версиях, если присутствует расширение GL_OES_mapbuffer.
Примечание: В OpenGL ES 3.0 и более поздних версиях, или, в случае настольного OpenGL, если поддерживается GL_ARB_map_buffer_range, эта функция использует glMapBufferRange вместо glMapBuffer.
См. также unmap(), create(), bind() и mapRange().
void *QOpenGLBuffer::mapRange(int offset, int count, QOpenGLBuffer::RangeAccessFlags access)
Картирует указанный диапазон offset и count содержимого этого буфера в адресное пространство приложения и возвращает на него указатель. Возвращает null, если картографирование памяти невозможно. Параметр access задает комбинацию флагов доступа.
Предполагается, что create() был вызван для этого буфера и что он был привязан к текущему контексту.
Примечание: Эта функция недоступна в OpenGL ES 2.0 и более ранних версиях.
См. также unmap(), create() и bind().
bool QOpenGLBuffer::read(int offset, void *data, int count)
Читает count байт из этого буфера, начиная с offset, в data. Возвращает true при успехе; false, если чтение из буфера не поддерживается. Чтение из буфера не поддерживается в OpenGL/ES.
Предполагается, что этот буфер привязан к текущему контексту.
void QOpenGLBuffer::release()
Освобождает буфер, связанный с этим объектом, из текущего контекста OpenGL.
Эта функция должна вызываться с тем же QOpenGLContext, что и при вызове bind() для буфера.
См. также bind().
[static] void QOpenGLBuffer::release(QOpenGLBuffer::Type type)
Освобождает буфер, связанный с type, в текущем QOpenGLContext.
Эта функция является прямым вызовом glBindBuffer(type, 0) для использования в случаях, когда вызывающий код не знает, какой QOpenGLBuffer привязан к контексту, но хочет убедиться, что он высвобожден.
QOpenGLBuffer::release(QOpenGLBuffer::VertexBuffer);
void QOpenGLBuffer::setUsagePattern(QOpenGLBuffer::UsagePattern value)
Устанавливает режим использования для этого объекта буфера в значение value. Эта функция должна быть вызвана до allocate() или write().
См. также usagePattern(), allocate() и write().
int QOpenGLBuffer::size() const
Возвращает размер данных в этом буфере для операций чтения. Возвращает -1, если получение размера буфера не поддерживается или буфер не был создан.
Предполагается, что этот буфер привязан к текущему контексту.
См. также isCreated() и bind().
QOpenGLBuffer::Type QOpenGLBuffer::type() const
Возвращает тип буфера, представленного этим объектом.
bool QOpenGLBuffer::unmap()
Отвязывает буфер после его отображения в адресное пространство приложения с помощью предыдущего вызова map(). Возвращает true если отвязка выполнена успешно; false в противном случае.
Предполагается, что этот буфер привязан к текущему контексту и был ранее отображён с помощью map().
Примечание: Эта функция поддерживается только в OpenGL ES 2.0 и более ранних версиях, если присутствует расширение GL_OES_mapbuffer.
См. также map().
QOpenGLBuffer::UsagePattern QOpenGLBuffer::usagePattern() const
Возвращает режим использования для этого объекта буфера. Значение по умолчанию — StaticDraw.
См. также setUsagePattern().
void QOpenGLBuffer::write(int offset, const void *data, int count)
Заменяет count байтов этого буфера, начиная с offset, содержимым из data. Другие байты в буфере останутся неизменными.
Предполагается, что для этого буфера был вызван create() и он привязан к текущему контексту.
См. также create(), read() и allocate().
QOpenGLBuffer &QOpenGLBuffer::operator=(const QOpenGLBuffer &other)
Присваивает поверхностную копию other этому объекту.
Примечание: QOpenGLBuffer не реализует семантику копирования с обновлением, поэтому other будет затронута всякий раз, когда копия будет изменена.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qopenglbuffer.html