Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-73248

Improve documentation on QSGMaterial

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 5.9.7, 5.12.0
    • None

    Description

      I suggest to update documentation on QSGMaterial. In particular append
      to Detailed description a link to Qt Quick Scene Graph Renderer document.
      Also link to 'Qt Quick Scene Graph Renderer -> Batch Roots
      -> Transform Nodes' should be added to QSGMaterial::RequiresFullMatrix flag
      documentation with description (or even just link to Performance chapter) 'copied' from Performance
      chapter - Settings this flag prevents all batching.

      The motive for this suggestion is that most developers (me to)
      find the sample 'Scene Graph - Graph' and try to hack it for
      their needs - custom geometry and shaders. But they may
      be astonished - 'where is my triangle, its coordinates in NDC?!' -
      similiar https://bugreports.qt.io/browse/QTBUG-38545 .
      And then devs go to read docs on QSGMaterial, QSGMaterialShader,
      QSGGeometry, QSGGeometryNode, QEtc BUT hardly to discover
      the mentioned doc 'Qt Quick Scene Graph Renderer' and
      comprehend what happend there actually.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            docteam Qt Documentation Team
            gshep Georgy Shepelev
            Votes:
            6 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes