SWDEV-270961 - Add doxygen for Texture APIs

Change-Id: I4038320a638292440d9ca8c23ffcabffcd9a48c2
Этот коммит содержится в:
jujiang
2021-03-08 21:23:31 -05:00
коммит произвёл Julia Jiang
родитель f265af744c
Коммит 3498f3600a
+61 -40
Просмотреть файл
@@ -3526,6 +3526,22 @@ hipError_t hipExtLaunchKernel(const void* function_address, dim3 numBlocks, dim3
* @}
*/
/**
*-------------------------------------------------------------------------------------------------
*-------------------------------------------------------------------------------------------------
* @defgroup Textur Texture Management
* @{
* This section describes the texture management functions of HIP runtime API.
*/
/**
*
* @addtogroup TexturD Texture Management [Deprecated]
* @{
* @ingroup Texture
* This section describes the deprecated texture management functions of HIP runtime API.
*/
DEPRECATED(DEPRECATED_MSG)
hipError_t hipBindTexture(
size_t* offset,
@@ -3550,23 +3566,28 @@ hipError_t hipBindTextureToArray(
hipArray_const_t array,
const hipChannelFormatDesc* desc);
hipError_t hipBindTextureToMipmappedArray(
const textureReference* tex,
hipMipmappedArray_const_t mipmappedArray,
const hipChannelFormatDesc* desc);
DEPRECATED(DEPRECATED_MSG)
hipError_t hipGetTextureAlignmentOffset(
size_t* offset,
const textureReference* texref);
hipError_t hipGetTextureReference(
const textureReference** texref,
const void* symbol);
DEPRECATED(DEPRECATED_MSG)
hipError_t hipUnbindTexture(const textureReference* tex);
// doxygen end deprecated texture management
/**
* @}
*/
hipError_t hipBindTextureToMipmappedArray(
const textureReference* tex,
hipMipmappedArray_const_t mipmappedArray,
const hipChannelFormatDesc* desc);
hipError_t hipGetTextureReference(
const textureReference** texref,
const void* symbol);
hipError_t hipCreateTextureObject(
hipTextureObject_t* pTexObject,
const hipResourceDesc* pResDesc,
@@ -3656,10 +3677,6 @@ hipError_t hipTexRefSetArray(
hipArray_const_t array,
unsigned int flags);
hipError_t hipTexRefSetBorderColor(
textureReference* texRef,
float* pBorderColor);
hipError_t hipTexRefSetFilterMode(
textureReference* texRef,
enum hipTextureFilterMode fm);
@@ -3677,6 +3694,37 @@ hipError_t hipTexRefSetMaxAnisotropy(
textureReference* texRef,
unsigned int maxAniso);
hipError_t hipTexObjectCreate(
hipTextureObject_t* pTexObject,
const HIP_RESOURCE_DESC* pResDesc,
const HIP_TEXTURE_DESC* pTexDesc,
const HIP_RESOURCE_VIEW_DESC* pResViewDesc);
hipError_t hipTexObjectDestroy(
hipTextureObject_t texObject);
hipError_t hipTexObjectGetResourceDesc(
HIP_RESOURCE_DESC* pResDesc,
hipTextureObject_t texObject);
hipError_t hipTexObjectGetResourceViewDesc(
HIP_RESOURCE_VIEW_DESC* pResViewDesc,
hipTextureObject_t texObject);
hipError_t hipTexObjectGetTextureDesc(
HIP_TEXTURE_DESC* pTexDesc,
hipTextureObject_t texObject);
// doxygen end Texture management
/**
* @}
*/
// The following are not supported.
hipError_t hipTexRefSetBorderColor(
textureReference* texRef,
float* pBorderColor);
hipError_t hipTexRefSetMipmapFilterMode(
textureReference* texRef,
enum hipTextureFilterMode fm);
@@ -3708,27 +3756,6 @@ hipError_t hipMipmappedArrayGetLevel(
hipMipmappedArray_t hMipMappedArray,
unsigned int level);
hipError_t hipTexObjectCreate(
hipTextureObject_t* pTexObject,
const HIP_RESOURCE_DESC* pResDesc,
const HIP_TEXTURE_DESC* pTexDesc,
const HIP_RESOURCE_VIEW_DESC* pResViewDesc);
hipError_t hipTexObjectDestroy(
hipTextureObject_t texObject);
hipError_t hipTexObjectGetResourceDesc(
HIP_RESOURCE_DESC* pResDesc,
hipTextureObject_t texObject);
hipError_t hipTexObjectGetResourceViewDesc(
HIP_RESOURCE_VIEW_DESC* pResViewDesc,
hipTextureObject_t texObject);
hipError_t hipTexObjectGetTextureDesc(
HIP_TEXTURE_DESC* pTexDesc,
hipTextureObject_t texObject);
/**
* Callback/Activity API
*/
@@ -3940,12 +3967,6 @@ static inline hipError_t hipUnbindTexture(
return hipUnbindTexture(&tex);
}
// doxygen end Texture
/**
* @}
*/
#endif // __cplusplus
#ifdef __GNUC__