mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

This commit is contained in:
Branimir Karadžić 2017-12-03 18:16:06 -08:00
parent 0e5f3457c3
commit 0ce8bd136d
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/bgfx/bgfx.h
View File

@ -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);