org.bytedeco.opencv.opencv_core

Class ProgramSource

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.ProgramSource

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::ocl")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class ProgramSource
extends Pointer

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ProgramSource()
ProgramSource(BytePointer prog)
ProgramSource(BytePointer module, BytePointer name, BytePointer codeStr, BytePointer codeHash)
ProgramSource(long size) Native array allocator.
ProgramSource(Pointer p) Pointer cast constructor.
ProgramSource(ProgramSource prog)
ProgramSource(String prog)
ProgramSource(String module, String name, String codeStr, String codeHash)

Method Summary

Modifier and Type	Method and Description
static ProgramSource	fromBinary(BytePointer module, BytePointer name, byte[] binary, long size)
static ProgramSource	fromBinary(BytePointer module, BytePointer name, byte[] binary, long size, BytePointer buildOptions)
static ProgramSource	fromBinary(BytePointer module, BytePointer name, ByteBuffer binary, long size)
static ProgramSource	fromBinary(BytePointer module, BytePointer name, ByteBuffer binary, long size, BytePointer buildOptions)
static ProgramSource	fromBinary(BytePointer module, BytePointer name, BytePointer binary, long size)
static ProgramSource	fromBinary(BytePointer module, BytePointer name, BytePointer binary, long size, BytePointer buildOptions) \brief Describe OpenCL program binary.
static ProgramSource	fromBinary(String module, String name, byte[] binary, long size)
static ProgramSource	fromBinary(String module, String name, byte[] binary, long size, String buildOptions)
static ProgramSource	fromBinary(String module, String name, ByteBuffer binary, long size)
static ProgramSource	fromBinary(String module, String name, ByteBuffer binary, long size, String buildOptions)
static ProgramSource	fromBinary(String module, String name, BytePointer binary, long size)
static ProgramSource	fromBinary(String module, String name, BytePointer binary, long size, String buildOptions)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, byte[] binary, long size)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, byte[] binary, long size, BytePointer buildOptions)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, ByteBuffer binary, long size)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, ByteBuffer binary, long size, BytePointer buildOptions)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, BytePointer binary, long size)
static ProgramSource	fromSPIR(BytePointer module, BytePointer name, BytePointer binary, long size, BytePointer buildOptions) \brief Describe OpenCL program in SPIR format.
static ProgramSource	fromSPIR(String module, String name, byte[] binary, long size)
static ProgramSource	fromSPIR(String module, String name, byte[] binary, long size, String buildOptions)
static ProgramSource	fromSPIR(String module, String name, ByteBuffer binary, long size)
static ProgramSource	fromSPIR(String module, String name, ByteBuffer binary, long size, String buildOptions)
static ProgramSource	fromSPIR(String module, String name, BytePointer binary, long size)
static ProgramSource	fromSPIR(String module, String name, BytePointer binary, long size, String buildOptions)
Pointer	getImpl()
int	hash()
ProgramSource	position(long position)
ProgramSource	put(ProgramSource prog)
BytePointer	source()

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgramSource

public ProgramSource(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

ProgramSource

public ProgramSource(long size)

Native array allocator. Access with Pointer.position(long).

ProgramSource

public ProgramSource()

ProgramSource

public ProgramSource(@opencv_core.Str
                     BytePointer module,
                     @opencv_core.Str
                     BytePointer name,
                     @opencv_core.Str
                     BytePointer codeStr,
                     @opencv_core.Str
                     BytePointer codeHash)

ProgramSource

public ProgramSource(@opencv_core.Str
                     String module,
                     @opencv_core.Str
                     String name,
                     @opencv_core.Str
                     String codeStr,
                     @opencv_core.Str
                     String codeHash)

ProgramSource

public ProgramSource(@opencv_core.Str
                     BytePointer prog)

ProgramSource

public ProgramSource(@opencv_core.Str
                     String prog)

ProgramSource

public ProgramSource(@Const @ByRef
                     ProgramSource prog)

Method Detail

position

public ProgramSource position(long position)

Overrides:

position in class Pointer

put

@ByRef
 @Name(value="operator =")
public ProgramSource put(@Const @ByRef
                                                           ProgramSource prog)

source

@opencv_core.Str
public BytePointer source()

hash

@Cast(value="cv::ocl::ProgramSource::hash_t")
public int hash()

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              BytePointer binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              BytePointer buildOptions)

\brief 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

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              BytePointer binary,
                                              @Cast(value="const size_t")
                                              long size)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              ByteBuffer binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              String buildOptions)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              ByteBuffer binary,
                                              @Cast(value="const size_t")
                                              long size)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              byte[] binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              BytePointer buildOptions)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              byte[] binary,
                                              @Cast(value="const size_t")
                                              long size)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              BytePointer binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              String buildOptions)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              BytePointer binary,
                                              @Cast(value="const size_t")
                                              long size)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              ByteBuffer binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              BytePointer buildOptions)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              BytePointer module,
                                              @opencv_core.Str
                                              BytePointer name,
                                              @Cast(value="const unsigned char*")
                                              ByteBuffer binary,
                                              @Cast(value="const size_t")
                                              long size)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              byte[] binary,
                                              @Cast(value="const size_t")
                                              long size,
                                              @opencv_core.Str
                                              String buildOptions)

fromBinary

@ByVal
public static ProgramSource fromBinary(@opencv_core.Str
                                              String module,
                                              @opencv_core.Str
                                              String name,
                                              @Cast(value="const unsigned char*")
                                              byte[] binary,
                                              @Cast(value="const size_t")
                                              long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            BytePointer binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            BytePointer buildOptions)

\brief 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.

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            BytePointer binary,
                                            @Cast(value="const size_t")
                                            long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            ByteBuffer binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            String buildOptions)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            ByteBuffer binary,
                                            @Cast(value="const size_t")
                                            long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            byte[] binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            BytePointer buildOptions)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            byte[] binary,
                                            @Cast(value="const size_t")
                                            long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            BytePointer binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            String buildOptions)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            BytePointer binary,
                                            @Cast(value="const size_t")
                                            long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            ByteBuffer binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            BytePointer buildOptions)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            BytePointer module,
                                            @opencv_core.Str
                                            BytePointer name,
                                            @Cast(value="const unsigned char*")
                                            ByteBuffer binary,
                                            @Cast(value="const size_t")
                                            long size)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            byte[] binary,
                                            @Cast(value="const size_t")
                                            long size,
                                            @opencv_core.Str
                                            String buildOptions)

fromSPIR

@ByVal
public static ProgramSource fromSPIR(@opencv_core.Str
                                            String module,
                                            @opencv_core.Str
                                            String name,
                                            @Cast(value="const unsigned char*")
                                            byte[] binary,
                                            @Cast(value="const size_t")
                                            long size)

getImpl

@Cast(value="cv::ocl::ProgramSource::Impl*")
public Pointer getImpl()