NVIDIA DeepStream SDK API Reference

6.2 Release
nvbufsurftransform.h File Reference

Detailed Description

NvBufSurfTransform Interface

This file specifies the NvBufSurfTransform image transformation APIs.

The NvBufSurfTransform API provides methods to set and get session parameters and to transform and composite APIs.

Definition in file nvbufsurftransform.h.

Go to the source code of this file.

Data Structures

struct  NvBufSurfTransformRect
 Holds the coordinates of a rectangle. More...
 
struct  _NvBufSurfTransformConfigParams
 Holds configuration parameters for a transform/composite session. More...
 
struct  _NvBufSurfaceTransformParams
 Holds transform parameters for a transform call. More...
 
struct  _NvBufSurfTransformCompositeParams
 Holds composite parameters for a composite call. More...
 
struct  _NvBufSurfTransform_ColorParams
 
struct  _NvBufSurfTransformCompositeBlendParams
 Holds composite blend parameters for a composite blender call. More...
 

Typedefs

typedef struct CUstream_st * cudaStream_t
 Forward declaration of cudaStream_t. More...
 
typedef struct _NvBufSurfTransformConfigParams NvBufSurfTransformConfigParams
 Holds configuration parameters for a transform/composite session. More...
 
typedef struct _NvBufSurfaceTransformParams NvBufSurfTransformParams
 Holds transform parameters for a transform call. More...
 
typedef struct _NvBufSurfTransformCompositeParams NvBufSurfTransformCompositeParams
 Holds composite parameters for a composite call. More...
 
typedef struct _NvBufSurfTransform_ColorParams NvBufSurfTransform_ColorParams
 
typedef struct _NvBufSurfTransformCompositeBlendParams NvBufSurfTransformCompositeBlendParams
 Holds composite blend parameters for a composite blender call. More...
 
typedef struct NvBufSurfTransformSyncObj * NvBufSurfTransformSyncObj_t
 Holds the information about synchronization objects for asynchronous transform/composite APIs. More...
 

Enumerations

enum  NvBufSurfTransform_Compute {
  NvBufSurfTransformCompute_Default,
  NvBufSurfTransformCompute_GPU,
  NvBufSurfTransformCompute_VIC
}
 Specifies compute devices used by NvBufSurfTransform. More...
 
enum  NvBufSurfTransform_Flip {
  NvBufSurfTransform_None,
  NvBufSurfTransform_Rotate90,
  NvBufSurfTransform_Rotate180,
  NvBufSurfTransform_Rotate270,
  NvBufSurfTransform_FlipX,
  NvBufSurfTransform_FlipY,
  NvBufSurfTransform_Transpose,
  NvBufSurfTransform_InvTranspose
}
 Specifies video flip methods. More...
 
enum  NvBufSurfTransform_Inter {
  NvBufSurfTransformInter_Nearest = 0,
  NvBufSurfTransformInter_Bilinear,
  NvBufSurfTransformInter_Algo1,
  NvBufSurfTransformInter_Algo2,
  NvBufSurfTransformInter_Algo3,
  NvBufSurfTransformInter_Algo4,
  NvBufSurfTransformInter_Default
}
 Specifies video interpolation methods. More...
 
enum  NvBufSurfTransform_Error {
  NvBufSurfTransformError_ROI_Error = -4,
  NvBufSurfTransformError_Invalid_Params = -3,
  NvBufSurfTransformError_Execution_Error = -2,
  NvBufSurfTransformError_Unsupported = -1,
  NvBufSurfTransformError_Success = 0
}
 Specifies error codes returned by NvBufSurfTransform functions. More...
 
enum  NvBufSurfTransform_Transform_Flag {
  NVBUFSURF_TRANSFORM_CROP_SRC = 1,
  NVBUFSURF_TRANSFORM_CROP_DST = 1 << 1,
  NVBUFSURF_TRANSFORM_FILTER = 1 << 2,
  NVBUFSURF_TRANSFORM_FLIP = 1 << 3,
  NVBUFSURF_TRANSFORM_NORMALIZE = 1 << 4
}
 Specifies transform types. More...
 
enum  NvBufSurfTransform_Composite_Flag {
  NVBUFSURF_TRANSFORM_COMPOSITE = 1,
  NVBUFSURF_TRANSFORM_COMPOSITE_FILTER = 1 << 2
}
 Specifies types of composition operations. More...
 

Functions

NvBufSurfTransform_Error NvBufSurfTransformSetSessionParams (NvBufSurfTransformConfigParams *config_params)
 Sets user-defined session parameters. More...
 
NvBufSurfTransform_Error NvBufSurfTransformGetSessionParams (NvBufSurfTransformConfigParams *config_params)
 Gets the session parameters used by NvBufSurfTransform(). More...
 
NvBufSurfTransform_Error NvBufSurfTransform (NvBufSurface *src, NvBufSurface *dst, NvBufSurfTransformParams *transform_params)
 Performs a transformation on batched input images. More...
 
NvBufSurfTransform_Error NvBufSurfTransformComposite (NvBufSurface *src, NvBufSurface *dst, NvBufSurfTransformCompositeParams *composite_params)
 Composites batched input images. More...
 
NvBufSurfTransform_Error NvBufSurfTransformAsync (NvBufSurface *src, NvBufSurface *dst, NvBufSurfTransformParams *transform_params, NvBufSurfTransformSyncObj_t *sync_obj)
 An asynchronous (non-blocking) transformation on batched input images. More...
 
NvBufSurfTransform_Error NvBufSurfTransformCompositeAsync (NvBufSurface *src, NvBufSurface *dst, NvBufSurfTransformCompositeParams *composite_params, NvBufSurfTransformSyncObj_t *sync_obj)
 Composites batched input images Asynchronously (non-blocking). More...
 
NvBufSurfTransform_Error NvBufSurfTransformCompositeBlend (NvBufSurface *src0, NvBufSurface *src1, NvBufSurface *alpha, NvBufSurface *dst, NvBufSurfTransformCompositeBlendParams *blend_params)
 Composites/Blends batched input images. More...
 
NvBufSurfTransform_Error NvBufSurfTransformMultiInputBufComposite (NvBufSurface **src, NvBufSurface *dst, NvBufSurfTransformCompositeParams *composite_params)
 Performs Composition on multiple input images with single batch size. More...
 
NvBufSurfTransform_Error NvBufSurfTransformMultiInputBufCompositeAsync (NvBufSurface **src, NvBufSurface *dst, NvBufSurfTransformCompositeParams *composite_params, NvBufSurfTransformSyncObj_t *sync_obj)
 Performs Composition on multiple input images with single batch size Asynchronously (non-blocking). More...
 
NvBufSurfTransform_Error NvBufSurfTransformSyncObjWait (NvBufSurfTransformSyncObj_t sync_obj, uint32_t time_out)
 Wait on the synchroization object. More...
 
NvBufSurfTransform_Error NvBufSurfTransformSyncObjDestroy (NvBufSurfTransformSyncObj_t *sync_obj)
 Destroy the synchroization object. More...
 

Typedef Documentation

◆ cudaStream_t

typedef struct CUstream_st* cudaStream_t

Forward declaration of cudaStream_t.

Definition at line 29 of file nvbufsurftransform.h.