Skip to content

docs: add an allocation readback example - #552

Open
Mr444-dev wants to merge 1 commit into
GPUOpen-LibrariesAndSDKs:masterfrom
Mr444-dev:docs/readback-copy-example
Open

Mr444-dev wants to merge 1 commit into
GPUOpen-LibrariesAndSDKs:masterfrom
Mr444-dev:docs/readback-copy-example

Conversation

@Mr444-dev

Copy link
Copy Markdown

Resolves #476 by adding a concrete CPU readback example next to the existing upload example. The repository already has regression coverage for vmaCopyAllocationToMemory in TestCopyMemoryToAllocation; this makes the corresponding usage visible in the API documentation.

The example shows the HOST_ACCESS_RANDOM allocation flag required for CPU reads and calls out the GPU fence wait before reading the allocation.

Validation

  • Compiled the new C++ snippet with MSVC 2026 in C++14 mode against Vulkan SDK 1.4.350.0 headers.
  • git diff --check passed.
  • Doxygen is not installed locally, so I could not regenerate the checked-in HTML reference.

@sawickiap

Copy link
Copy Markdown
Contributor

Thank you for this contribution. I merged it - to my fork for now. It will be merged to this repo in the future.

https://github.com/sawickiap/VulkanMemoryAllocator

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a new test which covers readback using vmaCopyAllocationToMemory?

2 participants