nvtiffGetProperty()

Gets the numeric value for the major or minor version, or the patch level, of the nvTIFF library.

Signature:

nvtiffStatus_t nvtiffGetProperty(libraryPropertyType type, int *value);

Parameters:

Parameter	Input/Output	Memory	Description
libraryPropertyType type	Input	Host	One of the supported libraryPropertyType values, that is, MAJOR_VERSION, MINOR_VERSION or PATCH_LEVEL
int *value	Output	Host	The numeric value corresponding to the specific libraryPropertyType requested.

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffStreamCreate()

Creates an instance of the bitstream handle.

Signature:

nvtiffStatus_t nvtiffStreamCreate(nvtiffStream_t *tiff_stream);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffStream_t *tiff_stream	Input/Output	Host	nvtiff bitstream handle

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffStreamDestroy()

Releases the bitstream handle.

Signature:

nvtiffStatus_t nvtiffStreamDestroy(nvtiffStream_t stream_handle);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffStream_t stream_handle	Input	Host	nvtiff bitstream handle

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffDecoderCreateSimple()

Creates an instance of the decoder handle with default memory allocators.

Signature:

nvtiffStatus_t nvtiffDecoderCreateSimple(nvtiffDecoder_t *decoder,
    cudaStream_t cuda_stream);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffDecoder_t *decoder	Input/Output	Host	nvtiff decoder handle
cudaStream_t cuda_stream	Input	Host	Used for asynchronous CUDA API calls

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffDecoderCreate

Creates an instance of the decoder handle.

Signature:

nvtiffStatus_t nvtiffDecoderCreate(nvtiffDecoder_t *decoder,
    nvtiffDeviceAllocator_t *device_allocator,
    nvtiffPinnedAllocator_t *pinned_allocator,
    cudaStream_t cuda_stream);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffDecoder_t *decoder	Input/Output	Host	nvtiff decoder handle
nvtiffDeviceAllocator_t *device_allocator	Input	Host	User provided device memory allocator. If set to NULL, the library will fallback to cudaMalloc/cudaFree.
nvtiffPinnedAllocator_t *pinned_allocator	Input	Host	User provided pinned memory allocator. If set to NULL, the library will fallback to cudaHostAlloc/cudaFreeHost.
cudaStream_t cuda_stream	Input	Host	Used for asynchronous CUDA API calls

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffDecoderDestroy()

Releases the decoder handle.

Signature:

nvtiffStatus_t nvtiffDecoderDestroy(nvtiffDecoder_t decoder,
    cudaStream_t cuda_stream);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffDecoder_t decoder	Input	Host	nvtiff decoder handle
cudaStream_t cuda_stream	Input	Host	Used for asynchronous CUDA API calls

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffDecodeParamsCreate()

Creates an instance of the decode output parameters handle.

Signature:

nvtiffStatus_t nvtiffDecodeParamsCreate(nvtiffDecodeParams_t *decode_params);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffDecodeParams_t *decode_params	Input/Output	Host	Decode output parameters handle

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffDecodeParamsDestroy()

Releases the decode output parameters handle.

Signature:

nvtiffStatus_t nvtiffDecodeParamsDestroy(nvtiffDecodeParams_t decode_params);

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffDecodeParams_t decode_params	Input	Host	Decode output parameters handle

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffEncoderCreate()

Creates and initializes a TIFF encoder instance.

Signature:

nvtiffStatus_t nvtiffEncoderCreate(nvtiffEncoder_t* encoder,
    nvtiffDeviceAllocator_t* deviceAllocator,
    nvtiffPinnedAllocator_t* pinnedAllocator,
    cudaStream_t stream)

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffEncoder_t* encoder	Output	Host	Pointer to encoder handle
nvtiffDeviceAllocator_t* deviceAllocator	Input	Host	Custom device memory allocator (can be NULL to use default which are cudaMalloc/cudaFree)
nvtiffPinnedAllocator_t* pinnedAllocator	Input	Host	Custom pinned memory allocator (can be NULL to use default which are cudaHostAlloc/cudaFreeHost)
cudaStream_t stream	Input	Host	CUDA stream

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffEncoderDestroy()

Destroys a TIFF encoder instance and frees associated resources.

Signature:

nvtiffStatus_t nvtiffEncoderDestroy(nvtiffEncoder_t encoder,
    cudaStream_t stream)

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffEncoder_t encoder	Input	Host	Encoder handle to destroy
cudaStream_t stream	Input	Host	CUDA stream

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffEncodeParamsCreate()

Creates and initializes encode parameters object.

Signature:

nvtiffStatus_t nvtiffEncodeParamsCreate(nvtiffEncodeParams_t* params)

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffEncodeParams_t* params	Output	Host	Pointer to encode parameters handle

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes

nvtiffEncodeParamsDestroy()

Destroys encode parameters object and frees associated resources.

Signature:

nvtiffStatus_t nvtiffEncodeParamsDestroy(nvtiffEncodeParams_t params,
    cudaStream_t stream)

Parameters:

Parameter	Input/Output	Memory	Description
nvtiffEncodeParams_t params	Input	Host	Encode parameters handle
cudaStream_t stream	Input	Host	CUDA stream

Returns:

nvtiffStatus_t - An error code as specified in Decode API Return Status Codes