/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h File Reference

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h File Reference#

RPP: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h File Reference
rpp.h File Reference

RPP top-level header with RPP handle API. More...

#include <export.h>
#include <hip/hip_runtime_api.h>
#include "rppdefs.h"
#include "rppi.h"
#include "rppt.h"
#include "rpp_version.h"

Go to the source code of this file.

Macros

#define RPP_DECLARE_OBJECT(name)
 Construct type name from a struct. More...
 
#define SHARED_PUBLIC   __attribute__ ((visibility ("default")))
 

Typedefs

typedef hipStream_t rppAcceleratorQueue_t
 Set rppAcceleratorQueue_t to hipStream_t if RPP_BACKEND_HIP.
 
typedef rppHandle_t RppHandle_t
 RPP handle.
 
typedef void *(* rppAllocatorFunction) (void *context, size_t sizeBytes)
 Handles RPP context allocations. More...
 
typedef void(* rppDeallocatorFunction) (void *context, void *memory)
 Handles RPP context allocations. More...
 

Functions

 RPP_DECLARE_OBJECT (rppHandle)
 RPP handle type creation.
 
SHARED_PUBLIC const char * rppGetErrorString (rppStatus_t error)
 Returns error string. More...
 
SHARED_PUBLIC rppStatus_t rppCreate (rppHandle_t *handle)
 Creates RPP handle for HOST single image processing - To be deprecated. More...
 
SHARED_PUBLIC rppStatus_t rppCreateWithBatchSize (rppHandle_t *handle, size_t nBatchSize, Rpp32u numThreads=0)
 Creates RPP handle for HOST batch processing. More...
 
SHARED_PUBLIC rppStatus_t rppDestroy (rppHandle_t handle)
 Destory RPP handle. More...
 
SHARED_PUBLIC rppStatus_t rppDestroyHost (rppHandle_t handle)
 Destory RPP HOST handle - To be deprecated. More...
 
SHARED_PUBLIC rppStatus_t rppSetBatchSize (rppHandle_t handle, size_t batchSize)
 Set batch size given a RPP handle. More...
 
SHARED_PUBLIC rppStatus_t rppGetBatchSize (rppHandle_t handle, size_t *batchSize)
 Get batch size given a RPP Handle. More...
 
SHARED_PUBLIC rppStatus_t rppCreateWithStream (rppHandle_t *handle, rppAcceleratorQueue_t stream)
 Creates RPP handle with accelerator stream for GPU single image processing - To be deprecated. More...
 
SHARED_PUBLIC rppStatus_t rppCreateWithStreamAndBatchSize (rppHandle_t *handle, rppAcceleratorQueue_t stream, size_t nBatchSize)
 Creates RPP handle with accelerator stream for GPU batch processing. More...
 
SHARED_PUBLIC rppStatus_t rppDestroyGPU (rppHandle_t handle)
 Destory RPP GPU handle. More...
 
SHARED_PUBLIC rppStatus_t rppSetStream (rppHandle_t handle, rppAcceleratorQueue_t streamID)
 Set accelerator stream given a RPP handle. More...
 
SHARED_PUBLIC rppStatus_t rppGetStream (rppHandle_t handle, rppAcceleratorQueue_t *streamID)
 Get accelerator stream given a RPP handle. More...
 
SHARED_PUBLIC rppStatus_t rppSetAllocator (rppHandle_t handle, rppAllocatorFunction allocator, rppDeallocatorFunction deallocator, void *allocatorContext)
 Set allocator given a RPP handle. More...
 
SHARED_PUBLIC rppStatus_t rppGetKernelTime (rppHandle_t handle, float *time)
 Get time taken by previous kernel. More...
 
SHARED_PUBLIC rppStatus_t rppEnableProfiling (rppHandle_t handle, bool enable)
 Enable Profiling. More...
 

Detailed Description

RPP top-level header with RPP handle API.