Skip to content

Expand compute shader tutorials and custom geometry documentation (+ bug fix in docs) - #208

Open
cNori wants to merge 1 commit into
FlaxEngine:masterfrom
cNori:renderer-guide-update
Open

cNori wants to merge 1 commit into
FlaxEngine:masterfrom
cNori:renderer-guide-update

Conversation

@cNori

@cNori cNori commented Nov 3, 2026

Copy link
Copy Markdown

The documentation now reflects the current renderer behaviour, including previously undocumented limitations of direct drawing identified during the investigation.

The compute shader documentation includes a complete mesh-generation guide covering:

  • Reading textures in compute shaders.
  • Writing to read/write buffers.
  • Using constant buffers.
  • Reading generated data back from the GPU to the CPU.
  • Updating a mesh with the generated data.
    A placeholder page was also added for a future high-level compute API. The expanded low-level examples show the amount of setup currently required and why a higher-level API would be useful.

Writing and testing these examples also exposed limitations in the current rendering pipeline, which are now documented. These changes describe existing functionality and behaviour.

For the proposed renderer changes addressing these limitations, see Renderer V2 proposal. This PR focuses on documenting the current renderer and compute shader usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants