class ov::intel_gpu::ocl::ClContext¶
Overview¶
This class represents an abstraction for GPU plugin remote context which is shared with OpenCL context object. The plugin object derived from this class can be obtained either with CompiledModel::get_context() or Core::create_context() calls. More…
#include <ocl.hpp>
class ClContext: public ov::RemoteContext
{
public:
// construction
ClContext(, , );
ClContext(, );
// methods
static voidconst RemoteContext& type_check();
cl_context get();
operator cl_context ();
operator cl::Context ();
std::pair<ClImage2DTensor, ClImage2DTensor>const cl::Image2D&const cl::Image2D& create_tensor_nv12(
,
);
ClBufferTensorconst element::Typeconst Shape&const cl_mem create_tensor(, , );
ClBufferTensorconst element::Typeconst Shape&const cl::Buffer& create_tensor(
,
,
);
ClImage2DTensorconst element::Typeconst Shape&const cl::Image2D& create_tensor(
,
,
);
USMTensorconst element::Typeconst Shape&void \* create_tensor(, , );
USMTensorconst element::Typeconst Shape& create_usm_host_tensor(, );
USMTensorconst element::Typeconst Shape& create_usm_device_tensor(, );
RemoteTensorconst element::Type&const Shape&const AnyMap& create_tensor(, , );
};
// direct descendants
class D3DContext;
class VAContext;
Inherited Members¶
public:
// methods
RemoteContext&const RemoteContext& operator = ();
RemoteContext&RemoteContext&& operator = ();
operator bool () const;
template <>
bool is() const;
template <>
const T as() const;
RemoteTensorconst element::Type&const Shape&const AnyMap& create_tensor(, , );
AnyMap get_params() const;
Tensorconst element::Typeconst Shape& create_host_tensor(, );
static voidconst RemoteContext&const std::map<std::string, std::vector<std::string>>& type_check(
,
);
Detailed Documentation¶
This class represents an abstraction for GPU plugin remote context which is shared with OpenCL context object. The plugin object derived from this class can be obtained either with CompiledModel::get_context() or Core::create_context() calls.
Construction¶
ClContext(, , )
Constructs context object from user-supplied OpenCL context handle.
Parameters:
core |
A reference to OpenVINO Runtime Core object |
ctx |
A OpenCL context to be used to create shared remote context |
ctx_device_id |
An ID of device to be used from ctx |
ClContext(, )
Constructs context object from user-supplied OpenCL context handle.
Only latency mode is supported for such context sharing case.
Parameters:
core |
A reference to OpenVINO Runtime Core object |
queue |
An OpenCL queue to be used to create shared remote context. Queue will be reused inside the plugin. |
Methods¶
static voidconst RemoteContext& type_check()
Checks that type defined runtime parameters are presented in remote object.
Parameters:
remote_context |
A remote context to check |
cl_context get()
Returns the underlying OpenCL context handle.
Returns:
cl_context
operator cl_context ()
OpenCL context handle conversion operator for the ClContext object.
Returns:
cl_context
operator cl::Context ()
Standard Khronos cl::Context wrapper conversion operator for the ClContext object.
Returns:
cl::Context
object
std::pair<ClImage2DTensor, ClImage2DTensor>const cl::Image2D&const cl::Image2D& create_tensor_nv12(
,
)
This function is used to construct a NV12 compound tensor object from two cl::Image2D wrapper objects. The resulting compound contains two remote tensors for Y and UV planes of the surface.
Parameters:
nv12_image_plane_y |
cl::Image2D object containing Y plane data. |
nv12_image_plane_uv |
cl::Image2D object containing UV plane data. |
Returns:
A pair of remote tensors for each plane
ClBufferTensorconst element::Typeconst Shape&const cl_mem create_tensor(, , )
This function is used to obtain remote tensor object from user-supplied cl_mem object.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
buffer |
A cl_mem object that should be wrapped by a remote tensor |
Returns:
A remote tensor instance
ClBufferTensorconst element::Typeconst Shape&const cl::Buffer& create_tensor(
,
,
)
This function is used to obtain remote tensor object from user-supplied cl::Buffer object.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
buffer |
A cl::Buffer object that should be wrapped by a remote tensor |
Returns:
A remote tensor instance
ClImage2DTensorconst element::Typeconst Shape&const cl::Image2D& create_tensor(
,
,
)
This function is used to obtain remote tensor object from user-supplied cl::Image2D object.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
image |
A cl::Image2D object that should be wrapped by a remote tensor |
Returns:
A remote tensor instance
USMTensorconst element::Typeconst Shape&void \* create_tensor(, , )
This function is used to obtain remote tensor object from user-supplied USM pointer.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
usm_ptr |
A USM pointer that should be wrapped by a remote tensor |
Returns:
A remote tensor instance
USMTensorconst element::Typeconst Shape& create_usm_host_tensor(, )
This function is used to allocate USM tensor with host allocation type.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
Returns:
A remote tensor instance
USMTensorconst element::Typeconst Shape& create_usm_device_tensor(, )
This function is used to allocate USM tensor with device allocation type.
Parameters:
type |
Tensor element type |
shape |
Tensor shape |
Returns:
A remote tensor instance
RemoteTensorconst element::Type&const Shape&const AnyMap& create_tensor(, , )
Allocates memory tensor in device memory or wraps user-supplied memory handle using the specified tensor description and low-level device-specific parameters. Returns a pointer to the object that implements the RemoteTensor interface.
Parameters:
type |
Defines the element type of the tensor. |
shape |
Defines the shape of the tensor. |
params |
Map of the low-level tensor object parameters. |
Returns:
Pointer to a plugin object that implements the RemoteTensor interface.