cuPHY  0.1
CUDA PHY Layer Acceration Library
Typedefs | Functions
Library context

This section describes the context functions of the cuPHY application programming interface. More...

Typedefs

typedef struct cuphyContext * cuphyContext_t
 

Functions

cuphyStatus_t cuphyCreateContext (cuphyContext_t *pcontext, unsigned int flags)
 Allocates and initializes a cuPHY context. More...
 
cuphyStatus_t cuphyDestroyContext (cuphyContext_t ctx)
 Destroys a cuPHY context. More...
 

Detailed Description

Typedef Documentation

◆ cuphyContext_t

typedef struct cuphyContext* cuphyContext_t

cuPHY context

Function Documentation

◆ cuphyCreateContext()

cuphyStatus_t cuphyCreateContext ( cuphyContext_t pcontext,
unsigned int  flags 
)

Allocates a cuPHY library context and returns a handle in the address provided by the caller.

Returns CUPHY_STATUS_INVALID_ARGUMENT if pcontext is NULL.

Returns CUPHY_STATUS_ALLOC_FAILED if a context cannot be allocated on the host.

Returns CUPHY_STATUS_SUCCESS if allocation and initialization were successful.

Parameters
pcontext- Address to return the new cuphyContext_t instance
flags- Creation flags (currently unused)
Returns
CUPHY_STATUS_SUCCESS, CUPHY_STATUS_ALLOC_FAILED, CUPHY_STATUS_INVALID_ARGUMENT
See also
cuphyStatus_t,cuphyGetErrorName,cuphyGetErrorString,cuphyDestroyContext

◆ cuphyDestroyContext()

cuphyStatus_t cuphyDestroyContext ( cuphyContext_t  ctx)

Destroys a cuPHY context object that was previously created by a call to cuphyCreateContext. The handle provided to this function should not be used for any operations after this function returns.

Returns CUPHY_STATUS_INVALID_ARGUMENT if decoder is NULL.

Returns CUPHY_STATUS_SUCCESS if destruction was successful.

Parameters
ctx- previously allocated cuphyContext_t instance
Returns
CUPHY_STATUS_SUCCESS, CUPHY_STATUS_INVALID_ARGUMENT
See also
cuphyStatus_t,cuphyCreateContext