Core classes

Classes

class  String
 Defines a string. More...
 
class  Matrix3f
 Represents a generic three-dimensional matrix. More...
 
class  Matrix4f
 Represents a generic fourth-dimensional matrix. More...
 
class  Vector2< T >
 Represents a two dimensions vector for both CPU and GPU. More...
 
class  Vector3< T >
 Represents a three dimensions vector for both CPU and GPU. More...
 
class  Vector4< T >
 Represents a four dimensions vector for both CPU and GPU. More...
 
struct  Resolution
 Width and height of an array. More...
 
class  Mat
 The Mat class can handle multiple matrix format from 1 to 4 channels, with different value types (float or uchar), and can be stored CPU and/or GPU side. More...
 

Enumerations

Functions

void sleep_ms (int time)
 Tells the program to wait for x ms. More...
 
String toString (const MEM &mem)
 Convert the given enumerated value into readable text. More...
 
String toString (const COPY_TYPE &cpy)
 Convert the given enumerated value into readable text. More...
 
String toString (const MAT_TYPE &type)
 Convert the given enumerated value into readable text. More...
 
int getZEDSDKRuntimeVersion (int &major, int &minor, int &patch)
 [Windows only] Returns the ZED SDK version currently installed on the computer. The major, minor, patch parameters will be filled by reference. More...
 
const void getZEDSDKBuildVersion (int &major, int &minor, int &patch)
 Returns the ZED SDK version which the current program has been compiled with. The major, minor, patch parameters will be filled by reference. More...
 

Enumeration Type Documentation

enum MEM

List available memory type.

Enumerator
MEM_CPU 

CPU Memory (Processor side).

MEM_GPU 

GPU Memory (Graphic card side).

enum COPY_TYPE

List available copy operation on Mat.

Enumerator
COPY_TYPE_CPU_CPU 

copy data from CPU to CPU.

COPY_TYPE_CPU_GPU 

copy data from CPU to GPU.

COPY_TYPE_GPU_GPU 

copy data from GPU to GPU.

COPY_TYPE_GPU_CPU 

copy data from GPU to CPU.

enum MAT_TYPE

List available Mat formats.

Enumerator
MAT_TYPE_32F_C1 

float 1 channel.

MAT_TYPE_32F_C2 

float 2 channels.

MAT_TYPE_32F_C3 

float 3 channels.

MAT_TYPE_32F_C4 

float 4 channels.

MAT_TYPE_8U_C1 

unsigned char 1 channel.

MAT_TYPE_8U_C2 

unsigned char 2 channels.

MAT_TYPE_8U_C3 

unsigned char 3 channels.

MAT_TYPE_8U_C4 

unsigned char 4 channels.

Function Documentation

void sl::sleep_ms ( int  time)
inline

Tells the program to wait for x ms.

Parameters
time: the number of ms to wait.
String sl::toString ( const MEM mem)

Convert the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const COPY_TYPE cpy)

Convert the given enumerated value into readable text.

Returns
The enumerated value as a string.
String sl::toString ( const MAT_TYPE type)

Convert the given enumerated value into readable text.

Returns
The enumerated value as a string.
int getZEDSDKRuntimeVersion ( int &  major,
int &  minor,
int &  patch 
)
inline

[Windows only] Returns the ZED SDK version currently installed on the computer. The major, minor, patch parameters will be filled by reference.

Returns
-1 if the SDK wasn't found, -2 if the version wasn't found, 0 if success. Will return -3 on Linux.
Note
Should be used on Windows with a /delayload on the ZED SDK DLLs.
const void getZEDSDKBuildVersion ( int &  major,
int &  minor,
int &  patch 
)
inline

Returns the ZED SDK version which the current program has been compiled with. The major, minor, patch parameters will be filled by reference.

// [Windows only]
//using /delayload on the ZED SDK DLLs, this snippet gives you boolean to decide if the SDK should be loaded.
int major_dll, minor_dll, patch_dll;
int major_prg, minor_prg, patch_prg;
bool older_ZED_SDK_available = false;
bool same_ZED_SDK_available = false;
bool newer_ZED_SDK_available = false;
bool ZED_SDK_available = false;
if (getZEDSDKRuntimeVersion(major_dll, minor_dll, patch_dll) == 0) {
getZEDSDKBuildVersion(major_prg, minor_prg, patch_prg);
if (major_dll == major_prg && minor_dll == minor_prg && patch_dll == patch_prg)
same_ZED_SDK_available = true;
if (major_dll > major_prg || (major_dll == major_prg && minor_dll > minor_prg) || (major_dll == major_prg && minor_dll == minor_prg && patch_dll > patch_prg))
newer_ZED_SDK_available = true;
else
older_ZED_SDK_available = true;
if (older_ZED_SDK_available || same_ZED_SDK_available || newer_ZED_SDK_available)
ZED_SDK_available = true;
}
//use ZED_SDK_available or older_ZED_SDK_available or same_ZED_SDK_available or newer_ZED_SDK_available