Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 65a3a55

Browse files
jujiang-delmangupta
authored andcommittedJun 20, 2023
SWDEV-392153 - Marked deprecated APIs in hip api header
Change-Id: I05e40ba94ed7431d6cb062ca73b48a76e1ec59b2
1 parent e8437f6 commit 65a3a55

File tree

1 file changed

+79
-91
lines changed

1 file changed

+79
-91
lines changed
 

‎include/hip/hip_runtime_api.h

+79-91
Original file line numberDiff line numberDiff line change
@@ -2775,6 +2775,10 @@ hipError_t hipExternalMemoryGetMappedBuffer(void **devPtr, hipExternalMemory_t e
27752775
* @see
27762776
*/
27772777
hipError_t hipDestroyExternalMemory(hipExternalMemory_t extMem);
2778+
// end of external resource
2779+
/**
2780+
* @}
2781+
*/
27782782
/**
27792783
* @brief Allocate memory on the default accelerator
27802784
*
@@ -2788,10 +2792,6 @@ hipError_t hipDestroyExternalMemory(hipExternalMemory_t extMem);
27882792
* @see hipMallocPitch, hipFree, hipMallocArray, hipFreeArray, hipMalloc3D, hipMalloc3DArray,
27892793
* hipHostFree, hipHostMalloc
27902794
*/
2791-
// end of external resource
2792-
/**
2793-
* @}
2794-
*/
27952795
hipError_t hipMalloc(void** ptr, size_t size);
27962796
/**
27972797
* @brief Allocate memory on the default accelerator
@@ -2818,7 +2818,7 @@ hipError_t hipExtMallocWithFlags(void** ptr, size_t sizeBytes, unsigned int flag
28182818
*
28192819
* @return #hipSuccess, #hipErrorOutOfMemory
28202820
*
2821-
* @deprecated use hipHostMalloc() instead
2821+
* @warning This API is deprecated use hipHostMalloc() instead
28222822
*/
28232823
DEPRECATED("use hipHostMalloc instead")
28242824
hipError_t hipMallocHost(void** ptr, size_t size);
@@ -2832,7 +2832,7 @@ hipError_t hipMallocHost(void** ptr, size_t size);
28322832
*
28332833
* @return #hipSuccess, #hipErrorOutOfMemory
28342834
*
2835-
* @deprecated use hipHostMalloc() instead
2835+
* @warning This API is deprecated, use hipHostMalloc() instead
28362836
*/
28372837
DEPRECATED("use hipHostMalloc instead")
28382838
hipError_t hipMemAllocHost(void** ptr, size_t size);
@@ -3544,7 +3544,7 @@ hipError_t hipFree(void* ptr);
35443544
* @return #hipSuccess,
35453545
* #hipErrorInvalidValue (if pointer is invalid, including device pointers allocated with
35463546
hipMalloc)
3547-
* @deprecated use hipHostFree() instead
3547+
* @warning This API is deprecated, use hipHostFree() instead
35483548
*/
35493549
DEPRECATED("use hipHostFree instead")
35503550
hipError_t hipFreeHost(void* ptr);
@@ -4302,7 +4302,7 @@ hipError_t hipMemcpy2DToArrayAsync(hipArray* dst, size_t wOffset, size_t hOffset
43024302
size_t spitch, size_t width, size_t height, hipMemcpyKind kind,
43034303
hipStream_t stream __dparm(0));
43044304
/**
4305-
* @brief Copies data between host and device.
4305+
* @brief Copies data between host and device. [Deprecated]
43064306
*
43074307
* @param[in] dst Destination memory address
43084308
* @param[in] wOffset Destination starting X offset
@@ -4315,16 +4315,18 @@ hipError_t hipMemcpy2DToArrayAsync(hipArray* dst, size_t wOffset, size_t hOffset
43154315
*
43164316
* @see hipMemcpy, hipMemcpy2DToArray, hipMemcpy2D, hipMemcpyFromArray, hipMemcpyToSymbol,
43174317
* hipMemcpyAsync
4318+
*
4319+
* @warning : This API is deprecated.
43184320
*/
43194321
DEPRECATED(DEPRECATED_MSG)
43204322
hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset, const void* src,
43214323
size_t count, hipMemcpyKind kind);
43224324
/**
4323-
* @brief Copies data between host and device.
4325+
* @brief Copies data between host and device. [Deprecated]
43244326
*
43254327
* @param[in] dst Destination memory address
43264328
* @param[in] srcArray Source memory address
4327-
* @param[in] woffset Source starting X offset
4329+
* @param[in] wOffset Source starting X offset
43284330
* @param[in] hOffset Source starting Y offset
43294331
* @param[in] count Size in bytes to copy
43304332
* @param[in] kind Type of transfer
@@ -4333,6 +4335,8 @@ hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset, const
43334335
*
43344336
* @see hipMemcpy, hipMemcpy2DToArray, hipMemcpy2D, hipMemcpyFromArray, hipMemcpyToSymbol,
43354337
* hipMemcpyAsync
4338+
*
4339+
* @warning : This API is deprecated.
43364340
*/
43374341
DEPRECATED(DEPRECATED_MSG)
43384342
hipError_t hipMemcpyFromArray(void* dst, hipArray_const_t srcArray, size_t wOffset, size_t hOffset,
@@ -4570,10 +4574,10 @@ hipError_t hipMemcpyPeerAsync(void* dst, int dstDeviceId, const void* src, int s
45704574
* This section describes the deprecated context management functions of HIP runtime API.
45714575
*/
45724576
/**
4573-
* @brief Create a context and set it as current/default context
4577+
* @brief Create a context and set it as current/default context [Deprecated]
45744578
*
4575-
* @param [out] ctx Context to create
4576-
* @param [in] flags Context creation flags
4579+
* @param [out] ctx Context to create
4580+
* @param [in] flags Context creation flags
45774581
* @param [in] device device handle
45784582
*
45794583
* @return #hipSuccess
@@ -4586,7 +4590,7 @@ hipError_t hipMemcpyPeerAsync(void* dst, int dstDeviceId, const void* src, int s
45864590
DEPRECATED(DEPRECATED_MSG)
45874591
hipError_t hipCtxCreate(hipCtx_t* ctx, unsigned int flags, hipDevice_t device);
45884592
/**
4589-
* @brief Destroy a HIP context.
4593+
* @brief Destroy a HIP context. [Deprecated]
45904594
*
45914595
* @param [in] ctx Context to destroy
45924596
*
@@ -4600,7 +4604,7 @@ hipError_t hipCtxCreate(hipCtx_t* ctx, unsigned int flags, hipDevice_t device);
46004604
DEPRECATED(DEPRECATED_MSG)
46014605
hipError_t hipCtxDestroy(hipCtx_t ctx);
46024606
/**
4603-
* @brief Pop the current/default context and return the popped context.
4607+
* @brief Pop the current/default context and return the popped context. [Deprecated]
46044608
*
46054609
* @param [out] ctx
46064610
*
@@ -4614,7 +4618,7 @@ hipError_t hipCtxDestroy(hipCtx_t ctx);
46144618
DEPRECATED(DEPRECATED_MSG)
46154619
hipError_t hipCtxPopCurrent(hipCtx_t* ctx);
46164620
/**
4617-
* @brief Push the context to be set as current/ default context
4621+
* @brief Push the context to be set as current/ default context. [Deprecated]
46184622
*
46194623
* @param [in] ctx
46204624
*
@@ -4628,7 +4632,7 @@ hipError_t hipCtxPopCurrent(hipCtx_t* ctx);
46284632
DEPRECATED(DEPRECATED_MSG)
46294633
hipError_t hipCtxPushCurrent(hipCtx_t ctx);
46304634
/**
4631-
* @brief Set the passed context as current/default
4635+
* @brief Set the passed context as current/default. [Deprecated]
46324636
*
46334637
* @param [in] ctx
46344638
*
@@ -4642,7 +4646,7 @@ hipError_t hipCtxPushCurrent(hipCtx_t ctx);
46424646
DEPRECATED(DEPRECATED_MSG)
46434647
hipError_t hipCtxSetCurrent(hipCtx_t ctx);
46444648
/**
4645-
* @brief Get the handle of the current/ default context
4649+
* @brief Get the handle of the current/ default context. [Deprecated]
46464650
*
46474651
* @param [out] ctx
46484652
*
@@ -4656,7 +4660,7 @@ hipError_t hipCtxSetCurrent(hipCtx_t ctx);
46564660
DEPRECATED(DEPRECATED_MSG)
46574661
hipError_t hipCtxGetCurrent(hipCtx_t* ctx);
46584662
/**
4659-
* @brief Get the handle of the device associated with current/default context
4663+
* @brief Get the handle of the device associated with current/default context. [Deprecated]
46604664
*
46614665
* @param [out] device
46624666
*
@@ -4670,7 +4674,7 @@ hipError_t hipCtxGetCurrent(hipCtx_t* ctx);
46704674
DEPRECATED(DEPRECATED_MSG)
46714675
hipError_t hipCtxGetDevice(hipDevice_t* device);
46724676
/**
4673-
* @brief Returns the approximate HIP api version.
4677+
* @brief Returns the approximate HIP api version. [Deprecated]
46744678
*
46754679
* @param [in] ctx Context to check
46764680
* @param [out] apiVersion
@@ -4691,7 +4695,7 @@ hipError_t hipCtxGetDevice(hipDevice_t* device);
46914695
DEPRECATED(DEPRECATED_MSG)
46924696
hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int* apiVersion);
46934697
/**
4694-
* @brief Get Cache configuration for a specific function
4698+
* @brief Get Cache configuration for a specific function. [Deprecated]
46954699
*
46964700
* @param [out] cacheConfig Cache configuration
46974701
*
@@ -4708,7 +4712,7 @@ hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int* apiVersion);
47084712
DEPRECATED(DEPRECATED_MSG)
47094713
hipError_t hipCtxGetCacheConfig(hipFuncCache_t* cacheConfig);
47104714
/**
4711-
* @brief Set L1/Shared cache partition.
4715+
* @brief Set L1/Shared cache partition. [Deprecated]
47124716
*
47134717
* @param [in] cacheConfig Cache configuration to set
47144718
*
@@ -4742,7 +4746,7 @@ hipError_t hipCtxSetCacheConfig(hipFuncCache_t cacheConfig);
47424746
DEPRECATED(DEPRECATED_MSG)
47434747
hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config);
47444748
/**
4745-
* @brief Get Shared memory bank configuration.
4749+
* @brief Get Shared memory bank configuration. [Deprecated]
47464750
*
47474751
* @param [out] pConfig Pointer of shared memory configuration
47484752
*
@@ -4759,7 +4763,7 @@ hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config);
47594763
DEPRECATED(DEPRECATED_MSG)
47604764
hipError_t hipCtxGetSharedMemConfig(hipSharedMemConfig* pConfig);
47614765
/**
4762-
* @brief Blocks until the default context has completed all preceding requested tasks.
4766+
* @brief Blocks until the default context has completed all preceding requested tasks. [Deprecated]
47634767
*
47644768
* @return #hipSuccess
47654769
*
@@ -4788,15 +4792,15 @@ hipError_t hipCtxSynchronize(void);
47884792
DEPRECATED(DEPRECATED_MSG)
47894793
hipError_t hipCtxGetFlags(unsigned int* flags);
47904794
/**
4791-
* @brief Enables direct access to memory allocations in a peer context.
4795+
* @brief Enables direct access to memory allocations in a peer context. [Deprecated]
47924796
*
47934797
* Memory which already allocated on peer device will be mapped into the address space of the
47944798
* current device. In addition, all future memory allocations on peerDeviceId will be mapped into
47954799
* the address space of the current device when the memory is allocated. The peer memory remains
47964800
* accessible from the current device until a call to hipDeviceDisablePeerAccess or hipDeviceReset.
47974801
*
47984802
*
4799-
* @param [in] peerCtx Peer context
4803+
* @param [in] peerCtx Peer context
48004804
* @param [in] flags flags, need to set as 0
48014805
*
48024806
* @returns #hipSuccess, #hipErrorInvalidDevice, #hipErrorInvalidValue,
@@ -4813,7 +4817,7 @@ hipError_t hipCtxEnablePeerAccess(hipCtx_t peerCtx, unsigned int flags);
48134817
/**
48144818
* @brief Disable direct access from current context's virtual address space to memory allocations
48154819
* physically located on a peer context.Disables direct access to memory allocations in a peer
4816-
* context and unregisters any registered allocations.
4820+
* context and unregisters any registered allocations. [Deprecated]
48174821
*
48184822
* Returns #hipErrorPeerAccessNotEnabled if direct access to memory on peerDevice has not yet been
48194823
* enabled from the current device.
@@ -5249,16 +5253,16 @@ hipError_t hipOccupancyMaxPotentialBlockSize(int* gridSize, int* blockSize,
52495253
*/
52505254
// TODO - expand descriptions:
52515255
/**
5252-
* @brief Start recording of profiling information
5256+
* @brief Start recording of profiling information. [Deprecated]
52535257
* When using this API, start the profiler with profiling disabled. (--startdisabled)
5254-
* @warning : hipProfilerStart API is under development.
5258+
* @warning : THe hipProfilerStart API is deprecated, use roctracer/rocTX instead.
52555259
*/
52565260
DEPRECATED("use roctracer/rocTX instead")
52575261
hipError_t hipProfilerStart();
52585262
/**
5259-
* @brief Stop recording of profiling information.
5263+
* @brief Stop recording of profiling information. [Deprecated]
52605264
* When using this API, start the profiler with profiling disabled. (--startdisabled)
5261-
* @warning : hipProfilerStop API is under development.
5265+
* @warning : hipProfilerStop API is deprecated, use roctracer/rocTX instead.
52625266
*/
52635267
DEPRECATED("use roctracer/rocTX instead")
52645268
hipError_t hipProfilerStop();
@@ -5618,7 +5622,7 @@ DEPRECATED(DEPRECATED_MSG)
56185622
const textureReference** texref,
56195623
const void* symbol);
56205624
/**
5621-
* @brief Sets address mode for a texture reference.
5625+
* @brief Sets address mode for a texture reference. [Deprecated]
56225626
*
56235627
* @param [in] texRef texture reference.
56245628
* @param [in] dim Dimension of the texture.
@@ -5634,7 +5638,7 @@ hipError_t hipTexRefSetAddressMode(
56345638
int dim,
56355639
enum hipTextureAddressMode am);
56365640
/**
5637-
* @brief Binds an array as a texture reference.
5641+
* @brief Binds an array as a texture reference. [Deprecated]
56385642
*
56395643
* @param [in] tex Pointer texture reference.
56405644
* @param [in] array Array to bind.
@@ -5651,7 +5655,7 @@ hipError_t hipTexRefSetArray(
56515655
hipArray_const_t array,
56525656
unsigned int flags);
56535657
/**
5654-
* @brief Set filter mode for a texture reference.
5658+
* @brief Set filter mode for a texture reference. [Deprecated]
56555659
*
56565660
* @param [in] texRef Pointer texture reference.
56575661
* @param [in] fm Value of texture filter mode.
@@ -5666,7 +5670,7 @@ hipError_t hipTexRefSetFilterMode(
56665670
textureReference* texRef,
56675671
enum hipTextureFilterMode fm);
56685672
/**
5669-
* @brief Set flags for a texture reference.
5673+
* @brief Set flags for a texture reference. [Deprecated]
56705674
*
56715675
* @param [in] texRef Pointer texture reference.
56725676
* @param [in] Flags Value of flags.
@@ -5681,7 +5685,7 @@ hipError_t hipTexRefSetFlags(
56815685
textureReference* texRef,
56825686
unsigned int Flags);
56835687
/**
5684-
* @brief Set format for a texture reference.
5688+
* @brief Set format for a texture reference. [Deprecated]
56855689
*
56865690
* @param [in] texRef Pointer texture reference.
56875691
* @param [in] fmt Value of format.
@@ -5698,7 +5702,7 @@ hipError_t hipTexRefSetFormat(
56985702
hipArray_Format fmt,
56995703
int NumPackedComponents);
57005704
/**
5701-
* @brief Binds a memory area to a texture.
5705+
* @brief Binds a memory area to a texture. [Deprecated]
57025706
*
57035707
* @param [in] offset Offset in bytes.
57045708
* @param [in] tex Texture to bind.
@@ -5717,7 +5721,7 @@ hipError_t hipBindTexture(
57175721
const hipChannelFormatDesc* desc,
57185722
size_t size __dparm(UINT_MAX));
57195723
/**
5720-
* @brief Binds a 2D memory area to a texture.
5724+
* @brief Binds a 2D memory area to a texture. [Deprecated]
57215725
*
57225726
* @param [in] offset Offset in bytes.
57235727
* @param [in] tex Texture to bind.
@@ -5740,7 +5744,7 @@ hipError_t hipBindTexture2D(
57405744
size_t height,
57415745
size_t pitch);
57425746
/**
5743-
* @brief Binds a memory area to a texture.
5747+
* @brief Binds a memory area to a texture. [Deprecated]
57445748
*
57455749
* @param [in] tex Pointer of texture reference.
57465750
* @param [in] array Array to bind.
@@ -5755,7 +5759,7 @@ hipError_t hipBindTextureToArray(
57555759
hipArray_const_t array,
57565760
const hipChannelFormatDesc* desc);
57575761
/**
5758-
* @brief Get the offset of the alignment in a texture.
5762+
* @brief Get the offset of the alignment in a texture. [Deprecated]
57595763
*
57605764
* @param [in] offset Offset in bytes.
57615765
* @param [in] texref Pointer of texture reference.
@@ -5768,7 +5772,7 @@ hipError_t hipGetTextureAlignmentOffset(
57685772
size_t* offset,
57695773
const textureReference* texref);
57705774
/**
5771-
* @brief Unbinds a texture.
5775+
* @brief Unbinds a texture. [Deprecated]
57725776
*
57735777
* @param [in] tex Texture to unbind.
57745778
*
@@ -5778,7 +5782,7 @@ hipError_t hipGetTextureAlignmentOffset(
57785782
DEPRECATED(DEPRECATED_MSG)
57795783
hipError_t hipUnbindTexture(const textureReference* tex);
57805784
/**
5781-
* @brief Gets the the address for a texture reference.
5785+
* @brief Gets the the address for a texture reference. [Deprecated]
57825786
*
57835787
* @param [out] dev_ptr Pointer of device address.
57845788
* @param [in] texRef Pointer of texture reference.
@@ -5791,7 +5795,7 @@ hipError_t hipTexRefGetAddress(
57915795
hipDeviceptr_t* dev_ptr,
57925796
const textureReference* texRef);
57935797
/**
5794-
* @brief Gets the address mode for a texture reference.
5798+
* @brief Gets the address mode for a texture reference. [Deprecated]
57955799
*
57965800
* @param [out] pam Pointer of address mode.
57975801
* @param [in] texRef Pointer of texture reference.
@@ -5806,7 +5810,7 @@ hipError_t hipTexRefGetAddressMode(
58065810
const textureReference* texRef,
58075811
int dim);
58085812
/**
5809-
* @brief Gets filter mode for a texture reference.
5813+
* @brief Gets filter mode for a texture reference. [Deprecated]
58105814
*
58115815
* @param [out] pfm Pointer of filter mode.
58125816
* @param [in] texRef Pointer of texture reference.
@@ -5819,7 +5823,7 @@ hipError_t hipTexRefGetFilterMode(
58195823
enum hipTextureFilterMode* pfm,
58205824
const textureReference* texRef);
58215825
/**
5822-
* @brief Gets flags for a texture reference.
5826+
* @brief Gets flags for a texture reference. [Deprecated]
58235827
*
58245828
* @param [out] pFlags Pointer of flags.
58255829
* @param [in] texRef Pointer of texture reference.
@@ -5832,7 +5836,7 @@ hipError_t hipTexRefGetFlags(
58325836
unsigned int* pFlags,
58335837
const textureReference* texRef);
58345838
/**
5835-
* @brief Gets texture format for a texture reference.
5839+
* @brief Gets texture format for a texture reference. [Deprecated]
58365840
*
58375841
* @param [out] pFormat Pointer of the format.
58385842
* @param [out] pNumChannels Pointer of number of channels.
@@ -5847,7 +5851,7 @@ hipError_t hipTexRefGetFormat(
58475851
int* pNumChannels,
58485852
const textureReference* texRef);
58495853
/**
5850-
* @brief Gets the maximum anisotropy for a texture reference.
5854+
* @brief Gets the maximum anisotropy for a texture reference. [Deprecated]
58515855
*
58525856
* @param [out] pmaxAnsio Pointer of the maximum anisotropy.
58535857
* @param [in] texRef Pointer of texture reference.
@@ -5860,7 +5864,7 @@ hipError_t hipTexRefGetMaxAnisotropy(
58605864
int* pmaxAnsio,
58615865
const textureReference* texRef);
58625866
/**
5863-
* @brief Gets the mipmap filter mode for a texture reference.
5867+
* @brief Gets the mipmap filter mode for a texture reference. [Deprecated]
58645868
*
58655869
* @param [out] pfm Pointer of the mipmap filter mode.
58665870
* @param [in] texRef Pointer of texture reference.
@@ -5874,7 +5878,7 @@ hipError_t hipTexRefGetMipmapFilterMode(
58745878
const textureReference* texRef);
58755879
DEPRECATED(DEPRECATED_MSG)
58765880
/**
5877-
* @brief Gets the mipmap level bias for a texture reference.
5881+
* @brief Gets the mipmap level bias for a texture reference. [Deprecated]
58785882
*
58795883
* @param [out] pbias Pointer of the mipmap level bias.
58805884
* @param [in] texRef Pointer of texture reference.
@@ -5886,7 +5890,7 @@ hipError_t hipTexRefGetMipmapLevelBias(
58865890
float* pbias,
58875891
const textureReference* texRef);
58885892
/**
5889-
* @brief Gets the minimum and maximum mipmap level clamps for a texture reference.
5893+
* @brief Gets the minimum and maximum mipmap level clamps for a texture reference. [Deprecated]
58905894
*
58915895
* @param [out] pminMipmapLevelClamp Pointer of the minimum mipmap level clamp.
58925896
* @param [out] pmaxMipmapLevelClamp Pointer of the maximum mipmap level clamp.
@@ -5901,7 +5905,7 @@ hipError_t hipTexRefGetMipmapLevelClamp(
59015905
float* pmaxMipmapLevelClamp,
59025906
const textureReference* texRef);
59035907
/**
5904-
* @brief Gets the mipmapped array bound to a texture reference.
5908+
* @brief Gets the mipmapped array bound to a texture reference. [Deprecated]
59055909
*
59065910
* @param [out] pArray Pointer of the mipmapped array.
59075911
* @param [in] texRef Pointer of texture reference.
@@ -5914,7 +5918,7 @@ hipError_t hipTexRefGetMipMappedArray(
59145918
hipMipmappedArray_t* pArray,
59155919
const textureReference* texRef);
59165920
/**
5917-
* @brief Sets an bound address for a texture reference.
5921+
* @brief Sets an bound address for a texture reference. [Deprecated]
59185922
*
59195923
* @param [out] ByteOffset Pointer of the offset in bytes.
59205924
* @param [in] texRef Pointer of texture reference.
@@ -5931,7 +5935,7 @@ hipError_t hipTexRefSetAddress(
59315935
hipDeviceptr_t dptr,
59325936
size_t bytes);
59335937
/**
5934-
* @brief Set a bind an address as a 2D texture reference.
5938+
* @brief Set a bind an address as a 2D texture reference. [Deprecated]
59355939
*
59365940
* @param [in] texRef Pointer of texture reference.
59375941
* @param [in] desc Pointer of array descriptor.
@@ -5948,7 +5952,7 @@ hipError_t hipTexRefSetAddress2D(
59485952
hipDeviceptr_t dptr,
59495953
size_t Pitch);
59505954
/**
5951-
* @brief Sets the maximum anisotropy for a texture reference.
5955+
* @brief Sets the maximum anisotropy for a texture reference. [Deprecated]
59525956
*
59535957
* @param [in] texRef Pointer of texture reference.
59545958
* @param [out] maxAniso Value of the maximum anisotropy.
@@ -5961,7 +5965,7 @@ hipError_t hipTexRefSetMaxAnisotropy(
59615965
textureReference* texRef,
59625966
unsigned int maxAniso);
59635967
/**
5964-
* @brief Sets border color for a texture reference.
5968+
* @brief Sets border color for a texture reference. [Deprecated]
59655969
*
59665970
* @param [in] texRef Pointer of texture reference.
59675971
* @param [in] pBorderColor Pointer of border color.
@@ -5974,7 +5978,7 @@ hipError_t hipTexRefSetBorderColor(
59745978
textureReference* texRef,
59755979
float* pBorderColor);
59765980
/**
5977-
* @brief Sets mipmap filter mode for a texture reference.
5981+
* @brief Sets mipmap filter mode for a texture reference. [Deprecated]
59785982
*
59795983
* @param [in] texRef Pointer of texture reference.
59805984
* @param [in] fm Value of filter mode.
@@ -5987,7 +5991,7 @@ hipError_t hipTexRefSetMipmapFilterMode(
59875991
textureReference* texRef,
59885992
enum hipTextureFilterMode fm);
59895993
/**
5990-
* @brief Sets mipmap level bias for a texture reference.
5994+
* @brief Sets mipmap level bias for a texture reference. [Deprecated]
59915995
*
59925996
* @param [in] texRef Pointer of texture reference.
59935997
* @param [in] bias Value of mipmap bias.
@@ -6000,7 +6004,7 @@ hipError_t hipTexRefSetMipmapLevelBias(
60006004
textureReference* texRef,
60016005
float bias);
60026006
/**
6003-
* @brief Sets mipmap level clamp for a texture reference.
6007+
* @brief Sets mipmap level clamp for a texture reference. [Deprecated]
60046008
*
60056009
* @param [in] texRef Pointer of texture reference.
60066010
* @param [in] minMipMapLevelClamp Value of minimum mipmap level clamp.
@@ -6015,7 +6019,7 @@ hipError_t hipTexRefSetMipmapLevelClamp(
60156019
float minMipMapLevelClamp,
60166020
float maxMipMapLevelClamp);
60176021
/**
6018-
* @brief Binds mipmapped array to a texture reference.
6022+
* @brief Binds mipmapped array to a texture reference. [Deprecated]
60196023
*
60206024
* @param [in] texRef Pointer of texture reference to bind.
60216025
* @param [in] mipmappedArray Pointer of mipmapped array to bind.
@@ -6035,14 +6039,6 @@ hipError_t hipTexRefSetMipmappedArray(
60356039
* @}
60366040
*/
60376041

6038-
// The following are not supported.
6039-
/**
6040-
*
6041-
* @addtogroup TextureU Texture Management [Not supported]
6042-
* @{
6043-
* @ingroup Texture
6044-
* This section describes the texture management functions currently unsupported in HIP runtime.
6045-
*/
60466042
/**
60476043
* @brief Create a mipmapped array.
60486044
*
@@ -6080,10 +6076,6 @@ hipError_t hipMipmappedArrayGetLevel(
60806076
hipArray_t* pLevelArray,
60816077
hipMipmappedArray_t hMipMappedArray,
60826078
unsigned int level);
6083-
// doxygen end unsuppported texture management
6084-
/**
6085-
* @}
6086-
*/
60876079

60886080
// doxygen end Texture management
60896081
/**
@@ -8069,8 +8061,8 @@ hipError_t hipDestroySurfaceObject(hipSurfaceObject_t surfaceObject);
80698061
*/
80708062

80718063
/**
8072-
* @brief Binds a memory area to a texture.
8073-
*
8064+
* @brief Binds a memory area to a texture. [Deprecated]
8065+
* @ingroup TextureD
80748066
* @param [in] offset Offset in bytes.
80758067
* @param [in] tex Texture to bind.
80768068
* @param [in] devPtr Pointer of memory on the device.
@@ -8086,8 +8078,8 @@ static inline hipError_t hipBindTexture(size_t* offset, const struct texture<T,
80868078
return hipBindTexture(offset, &tex, devPtr, &tex.channelDesc, size);
80878079
}
80888080
/**
8089-
* @brief Binds a memory area to a texture.
8090-
*
8081+
* @brief Binds a memory area to a texture. [Deprecated]
8082+
* @ingroup TextureD
80918083
* @param [in] offset Offset in bytes.
80928084
* @param [in] tex Texture to bind.
80938085
* @param [in] devPtr Pointer of memory on the device.
@@ -8105,8 +8097,8 @@ static inline hipError_t
81058097
return hipBindTexture(offset, &tex, devPtr, &desc, size);
81068098
}
81078099
/**
8108-
* @brief Binds a 2D memory area to a texture.
8109-
*
8100+
* @brief Binds a 2D memory area to a texture. [Deprecated]
8101+
* @ingroup TextureD
81108102
* @param [in] offset Offset in bytes.
81118103
* @param [in] tex Texture to bind.
81128104
* @param [in] devPtr Pointer of 2D memory area on the device.
@@ -8130,8 +8122,8 @@ static inline hipError_t hipBindTexture2D(
81308122
return hipBindTexture2D(offset, &tex, devPtr, &tex.channelDesc, width, height, pitch);
81318123
}
81328124
/**
8133-
* @brief Binds a 2D memory area to a texture.
8134-
*
8125+
* @brief Binds a 2D memory area to a texture. [Deprecated]
8126+
* @ingroup TextureD
81358127
* @param [in] offset Offset in bytes.
81368128
* @param [in] tex Texture to bind.
81378129
* @param [in] devPtr Pointer of 2D memory area on the device.
@@ -8157,8 +8149,8 @@ static inline hipError_t hipBindTexture2D(
81578149
return hipBindTexture2D(offset, &tex, devPtr, &desc, width, height, pitch);
81588150
}
81598151
/**
8160-
* @brief Binds an array to a texture.
8161-
*
8152+
* @brief Binds an array to a texture. [Deprecated]
8153+
* @ingroup TextureD
81628154
* @param [in] tex Texture to bind.
81638155
* @param [in] array Array of memory on the device.
81648156
*
@@ -8176,8 +8168,8 @@ static inline hipError_t hipBindTextureToArray(
81768168
return (err == hipSuccess) ? hipBindTextureToArray(&tex, array, &desc) : err;
81778169
}
81788170
/**
8179-
* @brief Binds an array to a texture.
8180-
*
8171+
* @brief Binds an array to a texture. [Deprecated]
8172+
* @ingroup TextureD
81818173
* @param [in] tex Texture to bind.
81828174
* @param [in] array Array of memory on the device.
81838175
* @param [in] desc Texture channel format.
@@ -8196,12 +8188,10 @@ static inline hipError_t hipBindTextureToArray(
81968188
}
81978189
/**
81988190
* @brief Binds a mipmapped array to a texture.
8199-
*
8191+
* @ingroup Texture
82008192
* @param [in] tex Texture to bind.
82018193
* @param [in] mipmappedArray Mipmapped Array of memory on the device.
82028194
*
8203-
* @warning This API is deprecated.
8204-
*
82058195
*/
82068196
template<class T, int dim, enum hipTextureReadMode readMode>
82078197
static inline hipError_t hipBindTextureToMipmappedArray(
@@ -8219,13 +8209,11 @@ static inline hipError_t hipBindTextureToMipmappedArray(
82198209
}
82208210
/**
82218211
* @brief Binds a mipmapped array to a texture.
8222-
*
8212+
* @ingroup Texture
82238213
* @param [in] tex Texture to bind.
82248214
* @param [in] mipmappedArray Mipmapped Array of memory on the device.
82258215
* @param [in] desc Texture channel format.
82268216
*
8227-
* @warning This API is deprecated.
8228-
*
82298217
*/
82308218
template<class T, int dim, enum hipTextureReadMode readMode>
82318219
static inline hipError_t hipBindTextureToMipmappedArray(
@@ -8236,8 +8224,8 @@ static inline hipError_t hipBindTextureToMipmappedArray(
82368224
return hipBindTextureToMipmappedArray(&tex, mipmappedArray, &desc);
82378225
}
82388226
/**
8239-
* @brief Unbinds a texture.
8240-
*
8227+
* @brief Unbinds a texture. [Deprecated]
8228+
* @ingroup TextureD
82418229
* @param [in] tex Texture to unbind.
82428230
*
82438231
* @warning This API is deprecated.

0 commit comments

Comments
 (0)
Please sign in to comment.