Класс QOpenGLBuffer

Класс QOpenGLBuffer предоставляет функции для создания и управления объектами буфера OpenGL. Подробнее...

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

Типы публичного интерфейса

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

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

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

Класс QOpenGLBuffer предоставляет функции для создания и управления объектами буфера OpenGL.

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

Объекты QOpenGLBuffer могут быть скопированы как ссылка на базовый объект буфера OpenGL:

QOpenGLBuffer buffer1(QOpenGLBuffer::IndexBuffer);
buffer1.create();

QOpenGLBuffer buffer2 = buffer1;

Класс QOpenGLBuffer выполняет поверхностную копию, когда объекты копируются таким образом, но не реализует семантику копирования по записи. Исходный объект будет затронут всякий раз, когда копия изменяется.

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

Перечисление QOpenGLBuffer::Access

Это перечисление определяет режим доступа для QOpenGLBuffer::map().

Перечисление QOpenGLBuffer::RangeAccessFlagФлаги QOpenGLBuffer::RangeAccessFlags

Это перечисление определяет биты режима доступа для QOpenGLBuffer::mapRange().

Тип RangeAccessFlags является псевдонимом для QFlags<RangeAccessFlag>. Он хранит сочетание побитового ИЛИ значений RangeAccessFlag.

Перечисление QOpenGLBuffer::Type

Это перечисление определяет тип объекта буфера OpenGL для создания с помощью QOpenGLBuffer.

Перечисление QOpenGLBuffer::UsagePattern

Это перечисление определяет шаблон использования объекта QOpenGLBuffer.

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

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() был вызван для этого буфера и что он привязан к текущему контексту.

См. также create() и write().

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.

Предполагается, что этот буфер привязан к текущему контексту.

См. также write() и bind().

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 будет изменяться всякий раз, когда копия модифицируется.