Scarfski/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-09-13 14:08:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify readTexture's READ_BACK flag is CPU-only (#3691)

Browse Source 
Per maintainer feedback, distill the @attention block down to the
essence: it's a texture for CPU readback, and can't be a GPU resource
at the same time. Add a one-line pointer to examples/30-picking for
the rendered-content case rather than spelling out the blit-to-staging
sequence inline.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
ShuangLiu1992
2026-04-26 16:42:53 +01:00
committed by GitHub
parent cceedb60cf
commit 43fbfaba41
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/bgfx.idl
View File

@@ -1880,6 +1880,8 @@ func.updateTextureCube { section = "Textures" }
--- Read back texture content.
---
--- @attention Texture must be created with `BGFX_TEXTURE_READ_BACK` flag.
--- It's a texture for CPU readback, and can't be a GPU resource
--- at the same time. See `examples/30-picking`.
--- @attention Availability depends on: `BGFX_CAPS_TEXTURE_READ_BACK`.
---
func.readTexture { section = "Textures" }