Класс QSGGeometry

Класс QSGGeometry предоставляет низкоуровневое хранилище для графических примитивов в графическом дереве Qt Quick Scene Graph. Подробнее...

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

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

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

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

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

Класс QSGGeometry хранит геометрию примитивов, отрисовываемых с помощью графического интерфейса сцены. Он содержит данные вершин и, необязательно, данные индексов. Режим отрисовки геометрии задается методом setDrawingMode(), который напрямую отображается в режиме отрисовки графического API, таком как GL_TRIANGLE_STRIP, GL_TRIANGLES, или GL_POINTS в случае OpenGL.

Вершины могут быть простыми, такими как точки, определяемые значениями x и y, или более сложными, где каждая вершина содержит нормаль, координаты текстуры и 3D позицию. Для описания построения данных вершин используется QSGGeometry::AttributeSet. Набор атрибутов может быть задан только при создании. Класс QSGGeometry по умолчанию предоставляет несколько удобных атрибутов и наборов атрибутов. Функция defaultAttributes_Point2D() возвращает набор атрибутов, используемых для обычных прямоугольников сплошного цвета, а функция defaultAttributes_TexturedPoint2D() возвращает атрибуты, используемые для текстурированной 2D геометрии. Данные вершин хранятся в виде void * и доступны с помощью функции vertexData(). Удобные методы доступа к общим наборам атрибутов доступны с помощью vertexDataAsPoint2D() и vertexDataAsTexturedPoint2D(). Данные вершин выделяются путём передачи количества вершин в конструктор или путём вызова allocate() позже.

Объект QSGGeometry может необязательно содержать индексы целых чисел без знака 32-битных, 16-битных или 8-битных. Тип индекса должен быть указан во время создания и не может быть изменён.

Ниже приведён фрагмент, иллюстрирующий, как можно построить геометрию, состоящую из вершин позиции и цвета.

struct MyPoint2D {
    float x;
    float y;
    float r;
    float g;
    float b;
    float a;

    void set(float x_, float y_, float r_, float g_, float b_, float a_) {
        x = x_;
        y = y_;
        r = r_;
        g = g_;
        b = b_;
        a = a_;
    }
};

QSGGeometry::Attribute MyPoint2D_Attributes[] = {
    QSGGeometry::Attribute::create(0, 2, GL_FLOAT, true),
    QSGGeometry::Attribute::create(1, 4, GL_FLOAT, false)
};

QSGGeometry::AttributeSet MyPoint2D_AttributeSet = {
    2,
    sizeof(MyPoint2D),
    MyPoint2D_Attributes
};

...

geometry = new QSGGeometry(MyPoint2D_AttributeSet, 2);
geometry->setDrawingMode(GL_LINES);

MyPoint2D *vertices = static_cast<MyPoint2D *>(geometry->vertexData());
vertices[0].set(0, 0, 1, 0, 0, 1);
vertices[1].set(width(), height(), 0, 0, 1, 1);

Объект QSGGeometry является программным буфером и клиентом в терминах рендеринга OpenGL, так как буферы, используемые в 2D графике, обычно состоят из многих небольших буферов, которые изменяются каждый кадр и не извлекают выгоды из загрузки в графическую память. Однако QSGGeometry поддерживает подсказки для рендерера о том, что буфер должен быть загружен с помощью функций setVertexDataPattern() и setIndexDataPattern(). Будет ли эта подсказка учтена или нет, зависит от реализации.

Примечание: Все классы с префиксом QSG должны использоваться только в потоке рендеринга графа сцены. Подробнее см. Граф сцены и рендеринг.

См. также QSGGeometryNode и Граф сцены — настройка геометрии.

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

перечисление QSGGeometry::AttributeType

Это перечисление идентифицирует несколько типов атрибутов.

перечисление QSGGeometry::DataPattern

Перечисление DataPattern используется для указания шаблона использования данных вершин и индексов в объекте геометрии.

перечисление QSGGeometry::DrawingMode

Значения соответствуют значениям перечисления OpenGL, таким как GL_POINTS, GL_LINES, и т.д. QSGGeometry предоставляет свой собственный тип, чтобы иметь возможность предоставлять тот же API с бэкендами, не связанными с OpenGL.

перечисление QSGGeometry::Type

Значения соответствуют константам типа OpenGL, таким как GL_BYTE, GL_UNSIGNED_BYTE, и т.д. QSGGeometry предоставляет свой собственный тип, чтобы иметь возможность предоставлять тот же API с бэкендами, не связанными с OpenGL.

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

QSGGeometry::QSGGeometry(const QSGGeometry::AttributeSet &attributes, int vertexCount, int indexCount = 0, int indexType = UnsignedShortType)

Создаёт объект геометрии на основе attributes.

Объект выделяет память для vertexCount вершин на основе накопленного размера в attributes и для indexCount.

indexType сопоставляется с типом индекса OpenGL и может быть GL_UNSIGNED_SHORT и GL_UNSIGNED_BYTE. В реализациях OpenGL, которые это поддерживают, таких как настольный OpenGL, также можно использовать GL_UNSIGNED_INT.

Объекты геометрии создаются со значением GL_TRIANGLE_STRIP по умолчанию в качестве режима отображения.

Структура атрибутов предполагается как POD, и объект геометрии предполагает, что она не исчезнет. Управление памятью не используется.

[virtual] QSGGeometry::~QSGGeometry()

Удаляет объект геометрии и данные вершин и индексов, которые он выделил.

void QSGGeometry::allocate(int vertexCount, int indexCount = 0)

Изменяет размер данных вершин и индексов этого объекта геометрии, чтобы вместить vertexCount вершин и indexCount индексов.

Данные вершин и индексов будут недействительными после этого вызова, и вызывающий должен пометить связанный узел геометрии как грязный, вызвав node->markDirty(QSGNode::DirtyGeometry), чтобы гарантировать, что рендерер имеет возможность обновить внутренние буферы.

int QSGGeometry::attributeCount() const

Возвращает количество атрибутов в наборе атрибутов, используемом этой геометрией.

const QSGGeometry::Attribute *QSGGeometry::attributes() const

Возвращает массив с атрибутами этой геометрии. Размер массива задаётся с помощью attributeCount().

[static] const QSGGeometry::AttributeSet &QSGGeometry::defaultAttributes_ColoredPoint2D()

Функция, возвращающая атрибуты, используемые для 2D отрисовки с цветом каждой вершины.

[static] const QSGGeometry::AttributeSet &QSGGeometry::defaultAttributes_Point2D()

Удобная функция, возвращающая атрибуты, используемые для 2D отрисовки сплошным цветом.

[static] const QSGGeometry::AttributeSet &QSGGeometry::defaultAttributes_TexturedPoint2D()

Удобная функция, возвращающая атрибуты, используемые для 2D текстурированной отрисовки.

unsigned int QSGGeometry::drawingMode() const

Возвращает режим отрисовки этой геометрии.

Значение по умолчанию — GL_TRIANGLE_STRIP.

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

int QSGGeometry::indexCount() const

Возвращает количество индексов в этом объекте геометрии.

void *QSGGeometry::indexData()

Возвращает указатель на исходные данные индексов этого объекта геометрии.

См. также indexDataAsUShort() и indexDataAsUInt().

const void *QSGGeometry::indexData() const

Возвращает указатель на исходные данные индексов этого объекта геометрии.

См. также indexDataAsUShort() и indexDataAsUInt().

uint *QSGGeometry::indexDataAsUInt()

Функция-утилита для доступа к данным индексов как к изменяемому массиву 32-битных беззнаковых целых чисел.

const uint *QSGGeometry::indexDataAsUInt() const

Функция-утилита для доступа к данным индексов как к неизменяемому массиву 32-битных беззнаковых целых чисел.

quint16 *QSGGeometry::indexDataAsUShort()

Функция-утилита для доступа к данным индексов как к изменяемому массиву 16-битных беззнаковых целых чисел.

const quint16 *QSGGeometry::indexDataAsUShort() const

Функция-утилита для доступа к данным индексов как к неизменяемому массиву 16-битных беззнаковых целых чисел.

QSGGeometry::DataPattern QSGGeometry::indexDataPattern() const

Возвращает шаблон использования индексов в этой геометрии. Шаблон по умолчанию — AlwaysUploadPattern.

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

int QSGGeometry::indexType() const

Возвращает тип примитива, используемого для индексов в этом объекте геометрии.

float QSGGeometry::lineWidth() const

Получает текущую ширину линии или точки, используемую для этой геометрии. Это свойство применяется только к ширине линии, когда режим drawingMode равен DrawLines, DrawLineStrip или DrawLineLoop. Для настольного OpenGL также применяется к размеру точки, когда drawingMode равен DrawPoints.

Значение по умолчанию — 1.0

Примечание: Когда не используется OpenGL, поддержка рисования точек и линий может быть ограничена. Например, некоторые API не поддерживают точки-спрайты, поэтому установка размера, отличного от 1, невозможна. Некоторые бэкэнды могут реализовать поддержку с помощью шейдеров геометрии, но это не гарантируется.

См. также setLineWidth() и drawingMode().

void QSGGeometry::markIndexDataDirty()

Пометить вершины в этой геометрии как изменённые и требующие повторной загрузки.

Эта функция имеет эффект только в том случае, если шаблон использования вершин — StaticData и рендерер, который отрисовывает эту геометрию, загружает геометрию в объекты буфера вершин (VBO).

void QSGGeometry::markVertexDataDirty()

Пометить вершины в этой геометрии как изменённые и требующие повторной загрузки.

Эта функция имеет эффект только в том случае, если шаблон использования вершин — StaticData и рендерер, который отрисовывает эту геометрию, загружает геометрию в объекты буфера вершин (VBO).

void QSGGeometry::setDrawingMode(unsigned int mode)

Устанавливает режим, используемый для отрисовки этой геометрии.

Значение по умолчанию — QSGGeometry::DrawTriangleStrip.

См. также drawingMode() и DrawingMode.

void QSGGeometry::setIndexDataPattern(QSGGeometry::DataPattern p)

Устанавливает шаблон использования индексов на p.

По умолчанию — AlwaysUploadPattern. Если установлено значение, отличное от значения по умолчанию, пользователь должен вызвать markIndexDataDirty() после изменения данных индексов, кроме вызова QSGNode::markDirty() со значением QSGNode::DirtyGeometry.

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

void QSGGeometry::setLineWidth(float width)

Устанавливает ширину линии или точки, используемой для этой геометрии, на width. Это свойство применяется только к ширине линии, когда режим drawingMode равен DrawLines, DrawLineStrip или DrawLineLoop. Для настольного OpenGL также применяется к размеру точки, когда drawingMode равен DrawPoints.

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

См. также lineWidth() и drawingMode().

void QSGGeometry::setVertexDataPattern(QSGGeometry::DataPattern p)

Устанавливает шаблон использования вершин на p.

По умолчанию — AlwaysUploadPattern. Если установлено значение, отличное от значения по умолчанию, пользователь должен вызвать markVertexDataDirty() после изменения данных вершин, кроме вызова QSGNode::markDirty() со значением QSGNode::DirtyGeometry.

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

int QSGGeometry::sizeOfIndex() const

Возвращает размер в байтах типа индекса.

Это значение равно 1 при типе индекса GL_UNSIGNED_BYTE или 2 при типе индекса GL_UNSIGNED_SHORT. Для настольного OpenGL также поддерживается GL_UNSIGNED_INT со значением 4.

int QSGGeometry::sizeOfVertex() const

Возвращает размер в байтах одной вершины.

Это значение получено из атрибутов.

[static] void QSGGeometry::updateColoredRectGeometry(QSGGeometry *g, const QRectF &rect)

Обновляет геометрию g координатами в rect.

Функция предполагает, что объект геометрии содержит одну полосу треугольников вершин QSGGeometry::ColoredPoint2D.

[static] void QSGGeometry::updateRectGeometry(QSGGeometry *g, const QRectF &rect)

Обновляет геометрию g координатами в rect.

Функция предполагает, что объект геометрии содержит одну полосу треугольников вершин QSGGeometry::Point2D.

[static] void QSGGeometry::updateTexturedRectGeometry(QSGGeometry *g, const QRectF &rect, const QRectF &textureRect)

Обновляет геометрию g координатами в rect и координатами текстуры из textureRect.

textureRect должна быть в нормализованных координатах.

g предполагается, что это полоса треугольников из четырёх вершин типа QSGGeometry::TexturedPoint2D.

int QSGGeometry::vertexCount() const

Возвращает количество вершин в этом объекте геометрии.

void *QSGGeometry::vertexData()

Возвращает указатель на исходные данные вершин этого объекта геометрии.

См. также vertexDataAsPoint2D() и vertexDataAsTexturedPoint2D().

const void *QSGGeometry::vertexData() const

Возвращает указатель на исходные данные вершин этого объекта геометрии.

См. также vertexDataAsPoint2D() и vertexDataAsTexturedPoint2D().

QSGGeometry::ColoredPoint2D *QSGGeometry::vertexDataAsColoredPoint2D()

Функция-утилита для доступа к данным вершин как к изменяемому массиву QSGGeometry::ColoredPoint2D.

const QSGGeometry::ColoredPoint2D *QSGGeometry::vertexDataAsColoredPoint2D() const

Функция-утилита для доступа к данным вершин в виде неизменяемого массива QSGGeometry::ColoredPoint2D.

QSGGeometry::Point2D *QSGGeometry::vertexDataAsPoint2D()

Функция-утилита для доступа к данным вершин в виде изменяемого массива QSGGeometry::Point2D.

const QSGGeometry::Point2D *QSGGeometry::vertexDataAsPoint2D() const

Функция-утилита для доступа к данным вершин в виде неизменяемого массива QSGGeometry::Point2D.

QSGGeometry::TexturedPoint2D *QSGGeometry::vertexDataAsTexturedPoint2D()

Функция-утилита для доступа к данным вершин в виде изменяемого массива QSGGeometry::TexturedPoint2D.

const QSGGeometry::TexturedPoint2D *QSGGeometry::vertexDataAsTexturedPoint2D() const

Функция-утилита для доступа к данным вершин в виде неизменяемого массива QSGGeometry::TexturedPoint2D.

QSGGeometry::DataPattern QSGGeometry::vertexDataPattern() const

Возвращает шаблон использования вершин в этой геометрии. По умолчанию используется шаблон AlwaysUploadPattern.

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