@@ -2775,6 +2775,10 @@ hipError_t hipExternalMemoryGetMappedBuffer(void **devPtr, hipExternalMemory_t e
2775
2775
* @see
2776
2776
*/
2777
2777
hipError_t hipDestroyExternalMemory (hipExternalMemory_t extMem);
2778
+ // end of external resource
2779
+ /* *
2780
+ * @}
2781
+ */
2778
2782
/* *
2779
2783
* @brief Allocate memory on the default accelerator
2780
2784
*
@@ -2788,10 +2792,6 @@ hipError_t hipDestroyExternalMemory(hipExternalMemory_t extMem);
2788
2792
* @see hipMallocPitch, hipFree, hipMallocArray, hipFreeArray, hipMalloc3D, hipMalloc3DArray,
2789
2793
* hipHostFree, hipHostMalloc
2790
2794
*/
2791
- // end of external resource
2792
- /* *
2793
- * @}
2794
- */
2795
2795
hipError_t hipMalloc (void ** ptr, size_t size);
2796
2796
/* *
2797
2797
* @brief Allocate memory on the default accelerator
@@ -2818,7 +2818,7 @@ hipError_t hipExtMallocWithFlags(void** ptr, size_t sizeBytes, unsigned int flag
2818
2818
*
2819
2819
* @return #hipSuccess, #hipErrorOutOfMemory
2820
2820
*
2821
- * @deprecated use hipHostMalloc() instead
2821
+ * @warning This API is deprecated use hipHostMalloc() instead
2822
2822
*/
2823
2823
DEPRECATED (" use hipHostMalloc instead" )
2824
2824
hipError_t hipMallocHost(void ** ptr, size_t size);
@@ -2832,7 +2832,7 @@ hipError_t hipMallocHost(void** ptr, size_t size);
2832
2832
*
2833
2833
* @return #hipSuccess, #hipErrorOutOfMemory
2834
2834
*
2835
- * @deprecated use hipHostMalloc() instead
2835
+ * @warning This API is deprecated, use hipHostMalloc() instead
2836
2836
*/
2837
2837
DEPRECATED (" use hipHostMalloc instead" )
2838
2838
hipError_t hipMemAllocHost(void ** ptr, size_t size);
@@ -3544,7 +3544,7 @@ hipError_t hipFree(void* ptr);
3544
3544
* @return #hipSuccess,
3545
3545
* #hipErrorInvalidValue (if pointer is invalid, including device pointers allocated with
3546
3546
hipMalloc)
3547
- * @deprecated use hipHostFree() instead
3547
+ * @warning This API is deprecated, use hipHostFree() instead
3548
3548
*/
3549
3549
DEPRECATED (" use hipHostFree instead" )
3550
3550
hipError_t hipFreeHost(void * ptr);
@@ -4302,7 +4302,7 @@ hipError_t hipMemcpy2DToArrayAsync(hipArray* dst, size_t wOffset, size_t hOffset
4302
4302
size_t spitch, size_t width, size_t height, hipMemcpyKind kind,
4303
4303
hipStream_t stream __dparm (0 ));
4304
4304
/* *
4305
- * @brief Copies data between host and device.
4305
+ * @brief Copies data between host and device. [Deprecated]
4306
4306
*
4307
4307
* @param[in] dst Destination memory address
4308
4308
* @param[in] wOffset Destination starting X offset
@@ -4315,16 +4315,18 @@ hipError_t hipMemcpy2DToArrayAsync(hipArray* dst, size_t wOffset, size_t hOffset
4315
4315
*
4316
4316
* @see hipMemcpy, hipMemcpy2DToArray, hipMemcpy2D, hipMemcpyFromArray, hipMemcpyToSymbol,
4317
4317
* hipMemcpyAsync
4318
+ *
4319
+ * @warning : This API is deprecated.
4318
4320
*/
4319
4321
DEPRECATED (DEPRECATED_MSG)
4320
4322
hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset, const void * src,
4321
4323
size_t count, hipMemcpyKind kind);
4322
4324
/* *
4323
- * @brief Copies data between host and device.
4325
+ * @brief Copies data between host and device. [Deprecated]
4324
4326
*
4325
4327
* @param[in] dst Destination memory address
4326
4328
* @param[in] srcArray Source memory address
4327
- * @param[in] woffset Source starting X offset
4329
+ * @param[in] wOffset Source starting X offset
4328
4330
* @param[in] hOffset Source starting Y offset
4329
4331
* @param[in] count Size in bytes to copy
4330
4332
* @param[in] kind Type of transfer
@@ -4333,6 +4335,8 @@ hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset, const
4333
4335
*
4334
4336
* @see hipMemcpy, hipMemcpy2DToArray, hipMemcpy2D, hipMemcpyFromArray, hipMemcpyToSymbol,
4335
4337
* hipMemcpyAsync
4338
+ *
4339
+ * @warning : This API is deprecated.
4336
4340
*/
4337
4341
DEPRECATED (DEPRECATED_MSG)
4338
4342
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
4570
4574
* This section describes the deprecated context management functions of HIP runtime API.
4571
4575
*/
4572
4576
/* *
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]
4574
4578
*
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
4577
4581
* @param [in] device device handle
4578
4582
*
4579
4583
* @return #hipSuccess
@@ -4586,7 +4590,7 @@ hipError_t hipMemcpyPeerAsync(void* dst, int dstDeviceId, const void* src, int s
4586
4590
DEPRECATED (DEPRECATED_MSG)
4587
4591
hipError_t hipCtxCreate(hipCtx_t* ctx, unsigned int flags, hipDevice_t device);
4588
4592
/* *
4589
- * @brief Destroy a HIP context.
4593
+ * @brief Destroy a HIP context. [Deprecated]
4590
4594
*
4591
4595
* @param [in] ctx Context to destroy
4592
4596
*
@@ -4600,7 +4604,7 @@ hipError_t hipCtxCreate(hipCtx_t* ctx, unsigned int flags, hipDevice_t device);
4600
4604
DEPRECATED (DEPRECATED_MSG)
4601
4605
hipError_t hipCtxDestroy(hipCtx_t ctx);
4602
4606
/* *
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]
4604
4608
*
4605
4609
* @param [out] ctx
4606
4610
*
@@ -4614,7 +4618,7 @@ hipError_t hipCtxDestroy(hipCtx_t ctx);
4614
4618
DEPRECATED (DEPRECATED_MSG)
4615
4619
hipError_t hipCtxPopCurrent(hipCtx_t* ctx);
4616
4620
/* *
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]
4618
4622
*
4619
4623
* @param [in] ctx
4620
4624
*
@@ -4628,7 +4632,7 @@ hipError_t hipCtxPopCurrent(hipCtx_t* ctx);
4628
4632
DEPRECATED (DEPRECATED_MSG)
4629
4633
hipError_t hipCtxPushCurrent(hipCtx_t ctx);
4630
4634
/* *
4631
- * @brief Set the passed context as current/default
4635
+ * @brief Set the passed context as current/default. [Deprecated]
4632
4636
*
4633
4637
* @param [in] ctx
4634
4638
*
@@ -4642,7 +4646,7 @@ hipError_t hipCtxPushCurrent(hipCtx_t ctx);
4642
4646
DEPRECATED (DEPRECATED_MSG)
4643
4647
hipError_t hipCtxSetCurrent(hipCtx_t ctx);
4644
4648
/* *
4645
- * @brief Get the handle of the current/ default context
4649
+ * @brief Get the handle of the current/ default context. [Deprecated]
4646
4650
*
4647
4651
* @param [out] ctx
4648
4652
*
@@ -4656,7 +4660,7 @@ hipError_t hipCtxSetCurrent(hipCtx_t ctx);
4656
4660
DEPRECATED (DEPRECATED_MSG)
4657
4661
hipError_t hipCtxGetCurrent(hipCtx_t* ctx);
4658
4662
/* *
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]
4660
4664
*
4661
4665
* @param [out] device
4662
4666
*
@@ -4670,7 +4674,7 @@ hipError_t hipCtxGetCurrent(hipCtx_t* ctx);
4670
4674
DEPRECATED (DEPRECATED_MSG)
4671
4675
hipError_t hipCtxGetDevice(hipDevice_t* device);
4672
4676
/* *
4673
- * @brief Returns the approximate HIP api version.
4677
+ * @brief Returns the approximate HIP api version. [Deprecated]
4674
4678
*
4675
4679
* @param [in] ctx Context to check
4676
4680
* @param [out] apiVersion
@@ -4691,7 +4695,7 @@ hipError_t hipCtxGetDevice(hipDevice_t* device);
4691
4695
DEPRECATED (DEPRECATED_MSG)
4692
4696
hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int * apiVersion);
4693
4697
/* *
4694
- * @brief Get Cache configuration for a specific function
4698
+ * @brief Get Cache configuration for a specific function. [Deprecated]
4695
4699
*
4696
4700
* @param [out] cacheConfig Cache configuration
4697
4701
*
@@ -4708,7 +4712,7 @@ hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int* apiVersion);
4708
4712
DEPRECATED (DEPRECATED_MSG)
4709
4713
hipError_t hipCtxGetCacheConfig(hipFuncCache_t* cacheConfig);
4710
4714
/* *
4711
- * @brief Set L1/Shared cache partition.
4715
+ * @brief Set L1/Shared cache partition. [Deprecated]
4712
4716
*
4713
4717
* @param [in] cacheConfig Cache configuration to set
4714
4718
*
@@ -4742,7 +4746,7 @@ hipError_t hipCtxSetCacheConfig(hipFuncCache_t cacheConfig);
4742
4746
DEPRECATED (DEPRECATED_MSG)
4743
4747
hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config);
4744
4748
/* *
4745
- * @brief Get Shared memory bank configuration.
4749
+ * @brief Get Shared memory bank configuration. [Deprecated]
4746
4750
*
4747
4751
* @param [out] pConfig Pointer of shared memory configuration
4748
4752
*
@@ -4759,7 +4763,7 @@ hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config);
4759
4763
DEPRECATED (DEPRECATED_MSG)
4760
4764
hipError_t hipCtxGetSharedMemConfig(hipSharedMemConfig* pConfig);
4761
4765
/* *
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]
4763
4767
*
4764
4768
* @return #hipSuccess
4765
4769
*
@@ -4788,15 +4792,15 @@ hipError_t hipCtxSynchronize(void);
4788
4792
DEPRECATED (DEPRECATED_MSG)
4789
4793
hipError_t hipCtxGetFlags(unsigned int * flags);
4790
4794
/* *
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]
4792
4796
*
4793
4797
* Memory which already allocated on peer device will be mapped into the address space of the
4794
4798
* current device. In addition, all future memory allocations on peerDeviceId will be mapped into
4795
4799
* the address space of the current device when the memory is allocated. The peer memory remains
4796
4800
* accessible from the current device until a call to hipDeviceDisablePeerAccess or hipDeviceReset.
4797
4801
*
4798
4802
*
4799
- * @param [in] peerCtx Peer context
4803
+ * @param [in] peerCtx Peer context
4800
4804
* @param [in] flags flags, need to set as 0
4801
4805
*
4802
4806
* @returns #hipSuccess, #hipErrorInvalidDevice, #hipErrorInvalidValue,
@@ -4813,7 +4817,7 @@ hipError_t hipCtxEnablePeerAccess(hipCtx_t peerCtx, unsigned int flags);
4813
4817
/* *
4814
4818
* @brief Disable direct access from current context's virtual address space to memory allocations
4815
4819
* 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]
4817
4821
*
4818
4822
* Returns #hipErrorPeerAccessNotEnabled if direct access to memory on peerDevice has not yet been
4819
4823
* enabled from the current device.
@@ -5249,16 +5253,16 @@ hipError_t hipOccupancyMaxPotentialBlockSize(int* gridSize, int* blockSize,
5249
5253
*/
5250
5254
// TODO - expand descriptions:
5251
5255
/* *
5252
- * @brief Start recording of profiling information
5256
+ * @brief Start recording of profiling information. [Deprecated]
5253
5257
* 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 .
5255
5259
*/
5256
5260
DEPRECATED (" use roctracer/rocTX instead" )
5257
5261
hipError_t hipProfilerStart();
5258
5262
/* *
5259
- * @brief Stop recording of profiling information.
5263
+ * @brief Stop recording of profiling information. [Deprecated]
5260
5264
* 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 .
5262
5266
*/
5263
5267
DEPRECATED (" use roctracer/rocTX instead" )
5264
5268
hipError_t hipProfilerStop();
@@ -5618,7 +5622,7 @@ DEPRECATED(DEPRECATED_MSG)
5618
5622
const textureReference** texref,
5619
5623
const void * symbol);
5620
5624
/* *
5621
- * @brief Sets address mode for a texture reference.
5625
+ * @brief Sets address mode for a texture reference. [Deprecated]
5622
5626
*
5623
5627
* @param [in] texRef texture reference.
5624
5628
* @param [in] dim Dimension of the texture.
@@ -5634,7 +5638,7 @@ hipError_t hipTexRefSetAddressMode(
5634
5638
int dim,
5635
5639
enum hipTextureAddressMode am);
5636
5640
/* *
5637
- * @brief Binds an array as a texture reference.
5641
+ * @brief Binds an array as a texture reference. [Deprecated]
5638
5642
*
5639
5643
* @param [in] tex Pointer texture reference.
5640
5644
* @param [in] array Array to bind.
@@ -5651,7 +5655,7 @@ hipError_t hipTexRefSetArray(
5651
5655
hipArray_const_t array,
5652
5656
unsigned int flags);
5653
5657
/* *
5654
- * @brief Set filter mode for a texture reference.
5658
+ * @brief Set filter mode for a texture reference. [Deprecated]
5655
5659
*
5656
5660
* @param [in] texRef Pointer texture reference.
5657
5661
* @param [in] fm Value of texture filter mode.
@@ -5666,7 +5670,7 @@ hipError_t hipTexRefSetFilterMode(
5666
5670
textureReference* texRef,
5667
5671
enum hipTextureFilterMode fm);
5668
5672
/* *
5669
- * @brief Set flags for a texture reference.
5673
+ * @brief Set flags for a texture reference. [Deprecated]
5670
5674
*
5671
5675
* @param [in] texRef Pointer texture reference.
5672
5676
* @param [in] Flags Value of flags.
@@ -5681,7 +5685,7 @@ hipError_t hipTexRefSetFlags(
5681
5685
textureReference* texRef,
5682
5686
unsigned int Flags);
5683
5687
/* *
5684
- * @brief Set format for a texture reference.
5688
+ * @brief Set format for a texture reference. [Deprecated]
5685
5689
*
5686
5690
* @param [in] texRef Pointer texture reference.
5687
5691
* @param [in] fmt Value of format.
@@ -5698,7 +5702,7 @@ hipError_t hipTexRefSetFormat(
5698
5702
hipArray_Format fmt,
5699
5703
int NumPackedComponents);
5700
5704
/* *
5701
- * @brief Binds a memory area to a texture.
5705
+ * @brief Binds a memory area to a texture. [Deprecated]
5702
5706
*
5703
5707
* @param [in] offset Offset in bytes.
5704
5708
* @param [in] tex Texture to bind.
@@ -5717,7 +5721,7 @@ hipError_t hipBindTexture(
5717
5721
const hipChannelFormatDesc* desc,
5718
5722
size_t size __dparm (UINT_MAX));
5719
5723
/* *
5720
- * @brief Binds a 2D memory area to a texture.
5724
+ * @brief Binds a 2D memory area to a texture. [Deprecated]
5721
5725
*
5722
5726
* @param [in] offset Offset in bytes.
5723
5727
* @param [in] tex Texture to bind.
@@ -5740,7 +5744,7 @@ hipError_t hipBindTexture2D(
5740
5744
size_t height,
5741
5745
size_t pitch);
5742
5746
/* *
5743
- * @brief Binds a memory area to a texture.
5747
+ * @brief Binds a memory area to a texture. [Deprecated]
5744
5748
*
5745
5749
* @param [in] tex Pointer of texture reference.
5746
5750
* @param [in] array Array to bind.
@@ -5755,7 +5759,7 @@ hipError_t hipBindTextureToArray(
5755
5759
hipArray_const_t array,
5756
5760
const hipChannelFormatDesc* desc);
5757
5761
/* *
5758
- * @brief Get the offset of the alignment in a texture.
5762
+ * @brief Get the offset of the alignment in a texture. [Deprecated]
5759
5763
*
5760
5764
* @param [in] offset Offset in bytes.
5761
5765
* @param [in] texref Pointer of texture reference.
@@ -5768,7 +5772,7 @@ hipError_t hipGetTextureAlignmentOffset(
5768
5772
size_t * offset,
5769
5773
const textureReference* texref);
5770
5774
/* *
5771
- * @brief Unbinds a texture.
5775
+ * @brief Unbinds a texture. [Deprecated]
5772
5776
*
5773
5777
* @param [in] tex Texture to unbind.
5774
5778
*
@@ -5778,7 +5782,7 @@ hipError_t hipGetTextureAlignmentOffset(
5778
5782
DEPRECATED (DEPRECATED_MSG)
5779
5783
hipError_t hipUnbindTexture(const textureReference* tex);
5780
5784
/* *
5781
- * @brief Gets the the address for a texture reference.
5785
+ * @brief Gets the the address for a texture reference. [Deprecated]
5782
5786
*
5783
5787
* @param [out] dev_ptr Pointer of device address.
5784
5788
* @param [in] texRef Pointer of texture reference.
@@ -5791,7 +5795,7 @@ hipError_t hipTexRefGetAddress(
5791
5795
hipDeviceptr_t* dev_ptr,
5792
5796
const textureReference* texRef);
5793
5797
/* *
5794
- * @brief Gets the address mode for a texture reference.
5798
+ * @brief Gets the address mode for a texture reference. [Deprecated]
5795
5799
*
5796
5800
* @param [out] pam Pointer of address mode.
5797
5801
* @param [in] texRef Pointer of texture reference.
@@ -5806,7 +5810,7 @@ hipError_t hipTexRefGetAddressMode(
5806
5810
const textureReference* texRef,
5807
5811
int dim);
5808
5812
/* *
5809
- * @brief Gets filter mode for a texture reference.
5813
+ * @brief Gets filter mode for a texture reference. [Deprecated]
5810
5814
*
5811
5815
* @param [out] pfm Pointer of filter mode.
5812
5816
* @param [in] texRef Pointer of texture reference.
@@ -5819,7 +5823,7 @@ hipError_t hipTexRefGetFilterMode(
5819
5823
enum hipTextureFilterMode* pfm,
5820
5824
const textureReference* texRef);
5821
5825
/* *
5822
- * @brief Gets flags for a texture reference.
5826
+ * @brief Gets flags for a texture reference. [Deprecated]
5823
5827
*
5824
5828
* @param [out] pFlags Pointer of flags.
5825
5829
* @param [in] texRef Pointer of texture reference.
@@ -5832,7 +5836,7 @@ hipError_t hipTexRefGetFlags(
5832
5836
unsigned int * pFlags,
5833
5837
const textureReference* texRef);
5834
5838
/* *
5835
- * @brief Gets texture format for a texture reference.
5839
+ * @brief Gets texture format for a texture reference. [Deprecated]
5836
5840
*
5837
5841
* @param [out] pFormat Pointer of the format.
5838
5842
* @param [out] pNumChannels Pointer of number of channels.
@@ -5847,7 +5851,7 @@ hipError_t hipTexRefGetFormat(
5847
5851
int * pNumChannels,
5848
5852
const textureReference* texRef);
5849
5853
/* *
5850
- * @brief Gets the maximum anisotropy for a texture reference.
5854
+ * @brief Gets the maximum anisotropy for a texture reference. [Deprecated]
5851
5855
*
5852
5856
* @param [out] pmaxAnsio Pointer of the maximum anisotropy.
5853
5857
* @param [in] texRef Pointer of texture reference.
@@ -5860,7 +5864,7 @@ hipError_t hipTexRefGetMaxAnisotropy(
5860
5864
int * pmaxAnsio,
5861
5865
const textureReference* texRef);
5862
5866
/* *
5863
- * @brief Gets the mipmap filter mode for a texture reference.
5867
+ * @brief Gets the mipmap filter mode for a texture reference. [Deprecated]
5864
5868
*
5865
5869
* @param [out] pfm Pointer of the mipmap filter mode.
5866
5870
* @param [in] texRef Pointer of texture reference.
@@ -5874,7 +5878,7 @@ hipError_t hipTexRefGetMipmapFilterMode(
5874
5878
const textureReference* texRef);
5875
5879
DEPRECATED (DEPRECATED_MSG)
5876
5880
/* *
5877
- * @brief Gets the mipmap level bias for a texture reference.
5881
+ * @brief Gets the mipmap level bias for a texture reference. [Deprecated]
5878
5882
*
5879
5883
* @param [out] pbias Pointer of the mipmap level bias.
5880
5884
* @param [in] texRef Pointer of texture reference.
@@ -5886,7 +5890,7 @@ hipError_t hipTexRefGetMipmapLevelBias(
5886
5890
float * pbias,
5887
5891
const textureReference* texRef);
5888
5892
/* *
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]
5890
5894
*
5891
5895
* @param [out] pminMipmapLevelClamp Pointer of the minimum mipmap level clamp.
5892
5896
* @param [out] pmaxMipmapLevelClamp Pointer of the maximum mipmap level clamp.
@@ -5901,7 +5905,7 @@ hipError_t hipTexRefGetMipmapLevelClamp(
5901
5905
float * pmaxMipmapLevelClamp,
5902
5906
const textureReference* texRef);
5903
5907
/* *
5904
- * @brief Gets the mipmapped array bound to a texture reference.
5908
+ * @brief Gets the mipmapped array bound to a texture reference. [Deprecated]
5905
5909
*
5906
5910
* @param [out] pArray Pointer of the mipmapped array.
5907
5911
* @param [in] texRef Pointer of texture reference.
@@ -5914,7 +5918,7 @@ hipError_t hipTexRefGetMipMappedArray(
5914
5918
hipMipmappedArray_t* pArray,
5915
5919
const textureReference* texRef);
5916
5920
/* *
5917
- * @brief Sets an bound address for a texture reference.
5921
+ * @brief Sets an bound address for a texture reference. [Deprecated]
5918
5922
*
5919
5923
* @param [out] ByteOffset Pointer of the offset in bytes.
5920
5924
* @param [in] texRef Pointer of texture reference.
@@ -5931,7 +5935,7 @@ hipError_t hipTexRefSetAddress(
5931
5935
hipDeviceptr_t dptr,
5932
5936
size_t bytes);
5933
5937
/* *
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]
5935
5939
*
5936
5940
* @param [in] texRef Pointer of texture reference.
5937
5941
* @param [in] desc Pointer of array descriptor.
@@ -5948,7 +5952,7 @@ hipError_t hipTexRefSetAddress2D(
5948
5952
hipDeviceptr_t dptr,
5949
5953
size_t Pitch);
5950
5954
/* *
5951
- * @brief Sets the maximum anisotropy for a texture reference.
5955
+ * @brief Sets the maximum anisotropy for a texture reference. [Deprecated]
5952
5956
*
5953
5957
* @param [in] texRef Pointer of texture reference.
5954
5958
* @param [out] maxAniso Value of the maximum anisotropy.
@@ -5961,7 +5965,7 @@ hipError_t hipTexRefSetMaxAnisotropy(
5961
5965
textureReference* texRef,
5962
5966
unsigned int maxAniso);
5963
5967
/* *
5964
- * @brief Sets border color for a texture reference.
5968
+ * @brief Sets border color for a texture reference. [Deprecated]
5965
5969
*
5966
5970
* @param [in] texRef Pointer of texture reference.
5967
5971
* @param [in] pBorderColor Pointer of border color.
@@ -5974,7 +5978,7 @@ hipError_t hipTexRefSetBorderColor(
5974
5978
textureReference* texRef,
5975
5979
float * pBorderColor);
5976
5980
/* *
5977
- * @brief Sets mipmap filter mode for a texture reference.
5981
+ * @brief Sets mipmap filter mode for a texture reference. [Deprecated]
5978
5982
*
5979
5983
* @param [in] texRef Pointer of texture reference.
5980
5984
* @param [in] fm Value of filter mode.
@@ -5987,7 +5991,7 @@ hipError_t hipTexRefSetMipmapFilterMode(
5987
5991
textureReference* texRef,
5988
5992
enum hipTextureFilterMode fm);
5989
5993
/* *
5990
- * @brief Sets mipmap level bias for a texture reference.
5994
+ * @brief Sets mipmap level bias for a texture reference. [Deprecated]
5991
5995
*
5992
5996
* @param [in] texRef Pointer of texture reference.
5993
5997
* @param [in] bias Value of mipmap bias.
@@ -6000,7 +6004,7 @@ hipError_t hipTexRefSetMipmapLevelBias(
6000
6004
textureReference* texRef,
6001
6005
float bias);
6002
6006
/* *
6003
- * @brief Sets mipmap level clamp for a texture reference.
6007
+ * @brief Sets mipmap level clamp for a texture reference. [Deprecated]
6004
6008
*
6005
6009
* @param [in] texRef Pointer of texture reference.
6006
6010
* @param [in] minMipMapLevelClamp Value of minimum mipmap level clamp.
@@ -6015,7 +6019,7 @@ hipError_t hipTexRefSetMipmapLevelClamp(
6015
6019
float minMipMapLevelClamp,
6016
6020
float maxMipMapLevelClamp);
6017
6021
/* *
6018
- * @brief Binds mipmapped array to a texture reference.
6022
+ * @brief Binds mipmapped array to a texture reference. [Deprecated]
6019
6023
*
6020
6024
* @param [in] texRef Pointer of texture reference to bind.
6021
6025
* @param [in] mipmappedArray Pointer of mipmapped array to bind.
@@ -6035,14 +6039,6 @@ hipError_t hipTexRefSetMipmappedArray(
6035
6039
* @}
6036
6040
*/
6037
6041
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
- */
6046
6042
/* *
6047
6043
* @brief Create a mipmapped array.
6048
6044
*
@@ -6080,10 +6076,6 @@ hipError_t hipMipmappedArrayGetLevel(
6080
6076
hipArray_t* pLevelArray,
6081
6077
hipMipmappedArray_t hMipMappedArray,
6082
6078
unsigned int level);
6083
- // doxygen end unsuppported texture management
6084
- /* *
6085
- * @}
6086
- */
6087
6079
6088
6080
// doxygen end Texture management
6089
6081
/* *
@@ -8069,8 +8061,8 @@ hipError_t hipDestroySurfaceObject(hipSurfaceObject_t surfaceObject);
8069
8061
*/
8070
8062
8071
8063
/* *
8072
- * @brief Binds a memory area to a texture.
8073
- *
8064
+ * @brief Binds a memory area to a texture. [Deprecated]
8065
+ * @ingroup TextureD
8074
8066
* @param [in] offset Offset in bytes.
8075
8067
* @param [in] tex Texture to bind.
8076
8068
* @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,
8086
8078
return hipBindTexture (offset, &tex, devPtr, &tex.channelDesc , size);
8087
8079
}
8088
8080
/* *
8089
- * @brief Binds a memory area to a texture.
8090
- *
8081
+ * @brief Binds a memory area to a texture. [Deprecated]
8082
+ * @ingroup TextureD
8091
8083
* @param [in] offset Offset in bytes.
8092
8084
* @param [in] tex Texture to bind.
8093
8085
* @param [in] devPtr Pointer of memory on the device.
@@ -8105,8 +8097,8 @@ static inline hipError_t
8105
8097
return hipBindTexture (offset, &tex, devPtr, &desc, size);
8106
8098
}
8107
8099
/* *
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
8110
8102
* @param [in] offset Offset in bytes.
8111
8103
* @param [in] tex Texture to bind.
8112
8104
* @param [in] devPtr Pointer of 2D memory area on the device.
@@ -8130,8 +8122,8 @@ static inline hipError_t hipBindTexture2D(
8130
8122
return hipBindTexture2D (offset, &tex, devPtr, &tex.channelDesc , width, height, pitch);
8131
8123
}
8132
8124
/* *
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
8135
8127
* @param [in] offset Offset in bytes.
8136
8128
* @param [in] tex Texture to bind.
8137
8129
* @param [in] devPtr Pointer of 2D memory area on the device.
@@ -8157,8 +8149,8 @@ static inline hipError_t hipBindTexture2D(
8157
8149
return hipBindTexture2D (offset, &tex, devPtr, &desc, width, height, pitch);
8158
8150
}
8159
8151
/* *
8160
- * @brief Binds an array to a texture.
8161
- *
8152
+ * @brief Binds an array to a texture. [Deprecated]
8153
+ * @ingroup TextureD
8162
8154
* @param [in] tex Texture to bind.
8163
8155
* @param [in] array Array of memory on the device.
8164
8156
*
@@ -8176,8 +8168,8 @@ static inline hipError_t hipBindTextureToArray(
8176
8168
return (err == hipSuccess) ? hipBindTextureToArray (&tex, array, &desc) : err;
8177
8169
}
8178
8170
/* *
8179
- * @brief Binds an array to a texture.
8180
- *
8171
+ * @brief Binds an array to a texture. [Deprecated]
8172
+ * @ingroup TextureD
8181
8173
* @param [in] tex Texture to bind.
8182
8174
* @param [in] array Array of memory on the device.
8183
8175
* @param [in] desc Texture channel format.
@@ -8196,12 +8188,10 @@ static inline hipError_t hipBindTextureToArray(
8196
8188
}
8197
8189
/* *
8198
8190
* @brief Binds a mipmapped array to a texture.
8199
- *
8191
+ * @ingroup Texture
8200
8192
* @param [in] tex Texture to bind.
8201
8193
* @param [in] mipmappedArray Mipmapped Array of memory on the device.
8202
8194
*
8203
- * @warning This API is deprecated.
8204
- *
8205
8195
*/
8206
8196
template <class T , int dim, enum hipTextureReadMode readMode>
8207
8197
static inline hipError_t hipBindTextureToMipmappedArray (
@@ -8219,13 +8209,11 @@ static inline hipError_t hipBindTextureToMipmappedArray(
8219
8209
}
8220
8210
/* *
8221
8211
* @brief Binds a mipmapped array to a texture.
8222
- *
8212
+ * @ingroup Texture
8223
8213
* @param [in] tex Texture to bind.
8224
8214
* @param [in] mipmappedArray Mipmapped Array of memory on the device.
8225
8215
* @param [in] desc Texture channel format.
8226
8216
*
8227
- * @warning This API is deprecated.
8228
- *
8229
8217
*/
8230
8218
template <class T , int dim, enum hipTextureReadMode readMode>
8231
8219
static inline hipError_t hipBindTextureToMipmappedArray (
@@ -8236,8 +8224,8 @@ static inline hipError_t hipBindTextureToMipmappedArray(
8236
8224
return hipBindTextureToMipmappedArray (&tex, mipmappedArray, &desc);
8237
8225
}
8238
8226
/* *
8239
- * @brief Unbinds a texture.
8240
- *
8227
+ * @brief Unbinds a texture. [Deprecated]
8228
+ * @ingroup TextureD
8241
8229
* @param [in] tex Texture to unbind.
8242
8230
*
8243
8231
* @warning This API is deprecated.
0 commit comments