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

Issues with Qt3D docs



    • Type: Bug
    • Status: Reported
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: 5.12.3
    • Fix Version/s: None
    • Component/s: Documentation, Qt3D
    • Labels:
    • Platform/s:


      In the Qt 3D documentation, there are some issues that can easily be fixed to provide a real, proper developer experience.

      On this page: https://doc.qt.io/qt-5/qt3d-overview.html

      • Under "Basic 3D Features" the first sentence is redefining what Qt 3D is. This is repetitive, because the first sentence in the "Overview" above already defines what it is. Redefining the product is a waste of the reader's time.
      • Both "High dynamic range" and "Multitexturing" don't have a section that describes what they are. So, they look weird in the bullet list.
      • "Useful Tips" section is not helpful as it just links to another page. A whole section with a link to another page is a waste of space. That sentence should be merged into another paragraph where there's more context. Or added below as part of other "Related Links".
      • "Shadow Mapping" section – the first two sentences should be swapped. Actually define what Shadow Mapping is before explaining that it's not supported by OpenGL. This section also has a lot of back-and-forth about first pass vs. second pass. Cleaning it up would help the reader to skim better. Quickest way: Pull out the "In the first pass..." and "In the second pass..." as two bullet points. Then you take the related information after these sentences and add them to the description for these two bullet points.
      • "Instanced Rendering" is badly done because: In the "Basic Features" it's said that this is a basic feature that is supported. Then you go to the "Instanced Rendering" section and the last sentence is "Instanced rendering is planned for a future release." So, the question is, does Qt3D actually support instanced rendering?
      • The last two sections: "Task-based Engine" and "Aspects", they should actually be swapped over, because the section before mentions aspects, but the section after tells what aspects are provided. This is not logical.


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



            • Assignee:
              seanharmer Sean Harmer
              kdpalara Kavindra Palaraja
            • Votes:
              1 Vote for this issue
              3 Start watching this issue


              • Created:

                Gerrit Reviews

                There are no open Gerrit changes