From 0ce8bd136d220bd68b2ba615d86e698ef5aff1ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Branimir=20Karad=C5=BEi=C4=87?= Date: Sun, 3 Dec 2017 18:16:06 -0800 Subject: [PATCH] Updated docs. --- include/bgfx/bgfx.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index f39aabbb1..1d9cf9c66 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -2702,11 +2702,14 @@ namespace bgfx /// /// @param[in] _handle Texture handle. /// - /// @returns Pointer to texture memory. If pointer is `NULL` direct access is - /// not supported. If pointer is `UINTPTR_MAX` sentinel value it means texture - /// is pending creation. + /// @returns Pointer to texture memory. If returned pointer is `NULL` direct access + /// is not available for this texture. If pointer is `UINTPTR_MAX` sentinel value + /// it means texture is pending creation. Pointer returned can be cached and it + /// will be valid until texture is destroyed. + /// + /// @attention Availability depends on: `BGFX_CAPS_TEXTURE_DIRECT_ACCESS`. This feature + /// is available on GPUs that have unified memory architecture (UMA) support. /// - /// @attention Availability depends on: `BGFX_CAPS_TEXTURE_DIRECT_ACCESS`. /// @attention C99 equivalent is `bgfx_get_direct_access_ptr`. /// void* getDirectAccessPtr(TextureHandle _handle);