Spec-Zone.ru › Qt 5.15

Класс QSGSimpleMaterialShader

шаблон <typename State> класс QSGSimpleMaterialShader

Класс QSGSimpleMaterialShader предоставляет удобный способ создания пользовательских материалов на основе OpenGL для графического дерева сцены. Подробнее...

Заголовок: #include <QSGSimpleMaterialShader>
qmake: QT += quick
Наследуется от: QSGMaterialShader

Этот класс устарел. Он предоставлен для совместимости со старым кодом. Мы настоятельно рекомендуем не использовать его в новом коде.

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

Открытые функции

виртуальный QList<QByteArray> attributes() const = 0
виртуальный void resolveUniforms()
const char * uniformMatrixName() const
const char * uniformOpacityName() const
виртуальный void updateState(const State *newState, const State *oldState) = 0

Макросы

QSG_DECLARE_SIMPLE_COMPARABLE_SHADER(Shader, State)
QSG_DECLARE_SIMPLE_SHADER(Shader, State)

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

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

Там, где API QSGMaterial и QSGMaterialShader требует немного шаблонного кода для создания функционирующего материала, QSGSimpleMaterialShader пытается скрыть часть этого через использование шаблонов.

QSGSimpleMaterialShader::vertexShader() и QSGSimpleMaterialShader::fragmentShader() используются для указания фактического кода шейдера. Названия вершинных атрибутов должны быть перечислены в QSGSimpleMaterialShader::attributes()

QSGSimpleMaterialShader::updateState() используется для передачи состояния материала в программу OpenGL.

Фактическая программа OpenGL шейдера доступна через функцию QSGSimpleMaterialShader::program()

Каждая реализация QSGSimpleMaterialShader работает с уникальной структурой состояния. Структура состояния должна быть объявлена с помощью макроса QSG_DECLARE_SIMPLE_SHADER.

Вот простой пример пользовательского однотонного цвета:

struct Color
{
    float r, g, b, a;
};

class MinimalShader : public QSGSimpleMaterialShader<Color>
{
    QSG_DECLARE_SIMPLE_SHADER(MinimalShader, Color)
public:

    const char *vertexShader() const {
        return
        "attribute highp vec4 vertex;               \n"
        "uniform highp mat4 qt_Matrix;              \n"
        "void main() {                              \n"
        "    gl_Position = qt_Matrix * vertex;      \n"
        "}";
    }

    const char *fragmentShader() const {
        return
        "uniform lowp float qt_Opacity;             \n"
        "uniform lowp vec4 color;                   \n"
        "void main() {                              \n"
        "    gl_FragColor = color * qt_Opacity;     \n"
        "}";
    }

    QList<QByteArray> attributes() const {
        return QList<QByteArray>() << "vertex";
    }

    void updateState(const Color *color, const Color *) {
        program()->setUniformValue("color", color->r, color->g, color->b, color->a);
    }

};

Экземпляры материалов, использующих этот шейдер, можно создать с помощью функции createMaterial(), которая будет определена макросом QSG_DECLARE_SIMPLE_SHADER.

QSGSimpleMaterial<Color> *material = MinimalShader::createMaterial();
material->state()->r = 1;
material->state()->g = 0;
material->state()->b = 0;
material->state()->a = 1;

node->setMaterial(material);

Графическое дерево сцены часто пытается найти материалы, которые имеют то же или по крайней мере похожее состояние, чтобы их можно было объединить в рендерере, что улучшает производительность. Для указания сортируемых состояний материала используйте QSG_DECLARE_SIMPLE_COMPARABLE_SHADER вместо QSG_DECLARE_SIMPLE_SHADER. Структура состояния также должна определить функцию:

int compare(const Type *other) const;

Предупреждение: QSGSimpleMaterialShader полагается на шаблонизацию для создания QSGMaterialType, которое используется рендерером графического дерева для идентификации этого шейдера. По этой причине уникальная реализация QSGSimpleMaterialShader должна быть создана с уникальным типом C++.

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

См. также Графическое дерево — Простой материал.

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

[pure virtual] QList<QByteArray> QSGSimpleMaterialShader::attributes() const

Возвращает список имен, объявляющих вершинные атрибуты в вершинном шейдере.

[virtual] void QSGSimpleMaterialShader::resolveUniforms()

Переопределите эту функцию для разрешения местоположения именованных униформ в программе шейдера.

Эта функция вызывается при инициализации шейдера материала.

const char *QSGSimpleMaterialShader::uniformMatrixName() const

Возвращает имя униформы матрицы преобразования этого элемента. Значение по умолчанию — qt_Matrix.

const char *QSGSimpleMaterialShader::uniformOpacityName() const

Возвращает имя униформы непрозрачности этого элемента. Значение по умолчанию — qt_Opacity.

[pure virtual] void QSGSimpleMaterialShader::updateState(const State *newState, const State *oldState)

Вызывается всякий раз, когда состояние этого шейдера должно быть обновлено из oldState в newState, типично для каждого нового набора геометрий, которые будут отрисованы.

И старое, и новое состояние передаются, чтобы реализация могла сравнить и свести к минимуму изменения состояния, когда это возможно.

Документация по макросам

QSG_DECLARE_SIMPLE_COMPARABLE_SHADER(Shader, State)

Этот макрос используется для объявления QSGMaterialType и функции createMaterial() для Shader с заданным State, где класс State должен определять функцию сравнения в виде:

int compare(const State *other) const;

QSG_DECLARE_SIMPLE_SHADER(Shader, State)

Этот макрос используется для объявления QSGMaterialType и функции createMaterial() для Shader с заданным State.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qsgsimplematerialshader.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API