Struct ProgramSource

pub struct ProgramSource { /* private fields */ }

Implementations

impl ProgramSource

pub fn default() -> ProgramSource

pub fn new( module: &str, name: &str, code_str: &str, code_hash: &str, ) -> Result<ProgramSource>

pub fn from_str(prog: &str) -> Result<ProgramSource>

pub fn copy(prog: &impl ProgramSourceTraitConst) -> Result<ProgramSource>

pub fn copy_mut(prog: ProgramSource) -> ProgramSource

pub fn from_binary( module: &str, name: &str, binary: &[u8], build_options: &str, ) -> Result<ProgramSource>

Describe OpenCL program binary. Do not call clCreateProgramWithBinary() and/or clBuildProgram().

Caller should guarantee binary buffer lifetime greater than ProgramSource object (and any of its copies).

This kind of binary is not portable between platforms in general - it is specific to OpenCL vendor / device / driver version.

Parameters

• module: name of program owner module
• name: unique name of program (module+name is used as key for OpenCL program caching)
• binary: buffer address. See buffer lifetime requirement in description.
• size: buffer size
• buildOptions: additional program-related build options passed to clBuildProgram()

Returns

created ProgramSource object

C++ default parameters

• build_options: cv::String()

pub fn from_binary_def( module: &str, name: &str, binary: &[u8], ) -> Result<ProgramSource>

Describe OpenCL program binary. Do not call clCreateProgramWithBinary() and/or clBuildProgram().

Caller should guarantee binary buffer lifetime greater than ProgramSource object (and any of its copies).

This kind of binary is not portable between platforms in general - it is specific to OpenCL vendor / device / driver version.

Parameters

• module: name of program owner module
• name: unique name of program (module+name is used as key for OpenCL program caching)
• binary: buffer address. See buffer lifetime requirement in description.
• size: buffer size
• buildOptions: additional program-related build options passed to clBuildProgram()

Returns

created ProgramSource object

Note

This alternative version of ProgramSource::from_binary function uses the following default values for its arguments:

• build_options: cv::String()

pub fn from_spir( module: &str, name: &str, binary: &[u8], build_options: &str, ) -> Result<ProgramSource>

Describe OpenCL program in SPIR format. Do not call clCreateProgramWithBinary() and/or clBuildProgram().

Supports SPIR 1.2 by default (pass ‘-spir-std=X.Y’ in buildOptions to override this behavior)

Caller should guarantee binary buffer lifetime greater than ProgramSource object (and any of its copies).

Programs in this format are portable between OpenCL implementations with ‘khr_spir’ extension: https://www.khronos.org/registry/OpenCL/sdk/2.0/docs/man/xhtml/cl_khr_spir.html (but they are not portable between different platforms: 32-bit / 64-bit)

Note: these programs can’t support vendor specific extensions, like ‘cl_intel_subgroups’.

Parameters

• module: name of program owner module
• name: unique name of program (module+name is used as key for OpenCL program caching)
• binary: buffer address. See buffer lifetime requirement in description.
• size: buffer size
• buildOptions: additional program-related build options passed to clBuildProgram() (these options are added automatically: ‘-x spir’ and ‘-spir-std=1.2’)

Returns

created ProgramSource object.

C++ default parameters

• build_options: cv::String()

pub fn from_spir_def( module: &str, name: &str, binary: &[u8], ) -> Result<ProgramSource>

Describe OpenCL program in SPIR format. Do not call clCreateProgramWithBinary() and/or clBuildProgram().

Supports SPIR 1.2 by default (pass ‘-spir-std=X.Y’ in buildOptions to override this behavior)

Caller should guarantee binary buffer lifetime greater than ProgramSource object (and any of its copies).

Programs in this format are portable between OpenCL implementations with ‘khr_spir’ extension: https://www.khronos.org/registry/OpenCL/sdk/2.0/docs/man/xhtml/cl_khr_spir.html (but they are not portable between different platforms: 32-bit / 64-bit)

Note: these programs can’t support vendor specific extensions, like ‘cl_intel_subgroups’.

Parameters

• module: name of program owner module
• name: unique name of program (module+name is used as key for OpenCL program caching)
• binary: buffer address. See buffer lifetime requirement in description.
• size: buffer size
• buildOptions: additional program-related build options passed to clBuildProgram() (these options are added automatically: ‘-x spir’ and ‘-spir-std=1.2’)

Returns

created ProgramSource object.

Note

This alternative version of ProgramSource::from_spir function uses the following default values for its arguments:

• build_options: cv::String()

Trait Implementations

impl Boxed for ProgramSource

unsafe fn from_raw( ptr: <ProgramSource as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <ProgramSource as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <ProgramSource as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <ProgramSource as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for ProgramSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProgramSource

fn default() -> Self

Forwards to infallible Self::default()

impl Drop for ProgramSource

fn drop(&mut self)

Executes the destructor for this type.

impl ProgramSourceTrait for ProgramSource

fn as_raw_mut_ProgramSource(&mut self) -> *mut c_void

fn set(&mut self, prog: &impl ProgramSourceTraitConst) -> Result<()>

fn set_1(&mut self, prog: ProgramSource)

impl ProgramSourceTraitConst for ProgramSource

fn as_raw_ProgramSource(&self) -> *const c_void

fn source(&self) -> Result<String>

fn hash(&self) -> Result<ProgramSource_hash_t>

fn empty(&self) -> Result<bool>

impl Send for ProgramSource