VPI - Vision Programming Interface

3.0 Release

Context.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 NVIDIA Corporation. All rights reserved.
3  *
4  * NOTICE TO LICENSEE:
5  *
6  * This source code and/or documentation ("Licensed Deliverables") are
7  * subject to NVIDIA intellectual property rights under U.S. and
8  * international Copyright laws.
9  *
10  * These Licensed Deliverables contained herein is PROPRIETARY and
11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12  * conditions of a form of NVIDIA software license agreement by and
13  * between NVIDIA and Licensee ("License Agreement") or electronically
14  * accepted by Licensee. Notwithstanding any terms or conditions to
15  * the contrary in the License Agreement, reproduction or disclosure
16  * of the Licensed Deliverables to any third party without the express
17  * written consent of NVIDIA is prohibited.
18  *
19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32  * OF THESE LICENSED DELIVERABLES.
33  *
34  * U.S. Government End Users. These Licensed Deliverables are a
35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36  * 1995), consisting of "commercial computer software" and "commercial
37  * computer software documentation" as such terms are used in 48
38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39  * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41  * U.S. Government End Users acquire the Licensed Deliverables with
42  * only those rights set forth herein.
43  *
44  * Any use of the Licensed Deliverables in individual and commercial
45  * software must include, in the user documentation and internal
46  * comments to the code, the above Disclaimer and U.S. Government End
47  * Users Notice.
48  */
49 
56 #ifndef NV_VPI_CONTEXT_H
57 #define NV_VPI_CONTEXT_H
58 
59 #include "Export.h"
60 #include "Status.h"
61 #include "Types.h"
62 #include "Version.h"
63 
64 #include <stdint.h>
65 
92 #ifdef __cplusplus
93 extern "C" {
94 #endif
95 
100 typedef struct CUctx_st *CUcontext;
101 
104 #define VPI_GLOBAL_CONTEXT ((VPIContext)0x610BA1C1D)
110 #define VPI_INVALID_CONTEXT ((VPIContext)-1)
111 
149 VPI_PUBLIC VPIStatus vpiContextCreate(uint64_t flags, VPIContext *ctx);
150 
187 VPI_PUBLIC VPIStatus vpiContextCreateWrapperCUDA(uint64_t flags, CUcontext cudaCtx, VPIContext *ctx);
188 
209 VPI_PUBLIC void vpiContextDestroy(VPIContext ctx);
210 
233 
248 
260 
274 
292 
307 
325 VPI_PUBLIC VPIStatus vpiContextGetFlags(VPIContext ctx, uint64_t *flags);
326 
327 #ifdef __cplusplus
328 }
329 #endif
330 
333 #endif /* NV_VPI_CONTEXT_H */
Declaration of VPI status codes handling functions.
Defines all types needed for programming with VPI.
Functions and structures for handling VPI library version.
VPIStatus vpiContextSetParallelFor(VPIContext ctx, const VPIParallelForConfig *config)
Controls low-level task parallelism of CPU devices owned by the context.
VPIStatus vpiContextCreate(uint64_t flags, VPIContext *ctx)
Create a context instance.
VPIStatus vpiContextSetCurrent(VPIContext ctx)
Sets the context for the calling thread.
VPIStatus vpiContextPush(VPIContext ctx)
Pushes the context to a per-thread context stack and sets this context as the current context for the...
void vpiContextDestroy(VPIContext ctx)
Destroy a context instance as well as all resources it owns.
VPIStatus vpiContextCreateWrapperCUDA(uint64_t flags, CUcontext cudaCtx, VPIContext *ctx)
Create a context instance that wraps a CUDA context.
VPIStatus vpiContextGetParallelFor(VPIContext ctx, VPIParallelForConfig *config)
Returns parameters set by vpiContextSetParallelFor.
VPIStatus vpiContextGetFlags(VPIContext ctx, uint64_t *flags)
Get the current context flags.
VPIStatus vpiContextGetCurrent(VPIContext *ctx)
Gets the context for the calling thread.
VPIStatus vpiContextPop(VPIContext *ctx)
Pops a context from a per-thread context stack and saves it to the ctx variable.
struct VPIContextImpl * VPIContext
A handle to a context.
Definition: Types.h:238
Stores the ParallelFor configuration.
Definition: Types.h:199
VPIStatus
Status codes.
Definition: Status.h:81