Класс QSGMaterial

Класс QSGMaterial инкапсулирует состояние отрисовки для программы шейдеров. Подробнее...

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

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

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

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

Класс QSGMaterial инкапсулирует состояние отрисовки для программы шейдеров.

API QSGMaterial очень низкого уровня. Более удобный API, который предоставляет практически все те же функции, доступен через QSGSimpleMaterialShader.

Подклассы QSGMaterial и QSGMaterialShader образуют тесную взаимосвязь. Для одного графа сцены (включая вложенные графы) существует один уникальный экземпляр QSGMaterialShader, который инкапсулирует QOpenGLShaderProgram, используемый графом сцены для отрисовки этого материала, например, шейдер для плоского окрашивания геометрии. Каждый QSGGeometryNode может иметь уникальный QSGMaterial, содержащий сведения о том, как следует настроить шейдер при отрисовке этого узла, например, фактический цвет, используемый для отрисовки геометрии.

Класс QSGMaterial имеет две виртуальные функции, которые необходимо реализовать. Функция type() должна возвращать уникальный экземпляр для всех экземпляров конкретного подкласса. Функция createShader() должна возвращать новый экземпляр QSGMaterialShader, специфичный для подкласса QSGMaterial.

Минимальная реализация QSGMaterial может выглядеть так:

class Material : public QSGMaterial
{
public:
    QSGMaterialType *type() const { static QSGMaterialType type; return &type; }
    QSGMaterialShader *createShader() const { return new Shader; }
};

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

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

Перечисление QSGMaterial::FlagФлаги QSGMaterial::Flags

Тип Flags является типом-синонимом для QFlags<Flag>. Он хранит результат побитового ИЛИ комбинации значений Flag.

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

[virtual] int QSGMaterial::compare(const QSGMaterial *other) const

Сравнивает этот материал с other и возвращает 0, если они равны; -1, если этот материал должен быть отсортирован перед other, и 1, если other должен быть отсортирован перед этим.

Граф сцены может переупорядочивать узлы геометрии для минимизации изменений состояния. Функция compare вызывается во время процесса сортировки, чтобы материалы можно было отсортировать для минимизации изменений состояния в каждом вызове QSGMaterialShader::updateState().

Указатель this и other гарантированно имеют одинаковый тип type().

[pure virtual] QSGMaterialShader *QSGMaterial::createShader() const

Эта функция возвращает новый экземпляр реализации QSGMaterialShader, используемой для отрисовки геометрии для конкретной реализации QSGMaterial.

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

QSGMaterial::Flags QSGMaterial::flags() const

Возвращает флаги материала.

void QSGMaterial::setFlag(Flags flags, bool on = true)

Устанавливает флаги flags для этого материала, если on равно true; в противном случае очищает атрибут.

[pure virtual] QSGMaterialType *QSGMaterial::type() const

Эта функция вызывается графом сцены для возвращения уникального экземпляра на подкласс.