You are here: Start » Function Reference » Document

Assertions

Icon Name Description / Applications Modules
AssertImageEqualTo AssertImageEqualTo

Asserts that two images are equal or differ by a small given margin.

FoundationLite

Configuration

Icon Name Description / Applications Modules
ChargeImageMemoryPools ChargeImageMemoryPools

Preallocates memory buffers for images.


This may improve performance when many images are created and destroyed in an application.

FoundationLite
CheckLicense CheckLicense

Check license for a specified module.

FoundationLite
ControlAVX2 ControlAVX2

Enables or disables AVX2 cpu extension usage by other filters.

FoundationLite
ControlImageMemoryPools ControlImageMemoryPools

Enables or disables deterministic image memory allocator.


This may improve performance when many images are created and destroyed in an application.

FoundationLite
ControlParallelComputing ControlParallelComputing

Enables or disables filters multithreading parallelization.

FoundationLite
ControlSIMD ControlSIMD

Enables or disables SIMD cpu extension (e.g. SSE, AVX2, NEON) usage by other filters. This filter does not affect third party components e.g. camera software, OpenCV.

FoundationLite
ControlSSE ControlSSE

Enables or disables SSE cpu extension usage by other filters.

FoundationLite
DischargeImageMemoryPools DischargeImageMemoryPools

Releases preallocated image memory buffers.

FoundationLite
GetAvailableLicenses GetAvailableLicenses

Reads available licenses in the system.

FoundationLite
GetComputerID GetComputerID

Gets current Computer ID.


Can be used for creating custom license protection for integrator's applications.

FoundationLite
GetDongleSerialNumber GetDongleSerialNumber

Gets the current usb dongle's serial number.

FoundationBasic
GetLibraryVersion GetLibraryVersion

Gets current library version.

FoundationLite
GetThreadLimitInfo GetThreadLimitInfo

Returns how many threads are possible and a list of threads currently being used.


Makes it easier to diagnose licensing problems related to exceeding the limit of threads.

FoundationLite
InitLibrary

Initializes library internals. Should be called before any other function from FIL.


If you do not call this first, initialization will be done in the first iteration, possibly affecting system's performance.

FoundationLite
InspectImageMemoryPools InspectImageMemoryPools

Returns information about allocated image memory buffers. This information can be used for preallocation.

FoundationLite
VerifyProjectID VerifyProjectID

Verifies a project ID.


This tools is useful for system integrators who need verification if a system is used with a license coming from a legitimate source.

FoundationBasic
WriteLog WriteLog

Write log message with selected log level.

FoundationLite

FTP

Icon Name Description / Applications Modules
Ftp_ReceiveFile Ftp_ReceiveFile

Downloads a file from a remote server using FTP (File Transfer Protocol).

FoundationLite
Ftp_ReceiveImage Ftp_ReceiveImage

Downloads an image from a remote server using FTP (File Transfer Protocol).

FoundationLite
Ftp_ReceiveString Ftp_ReceiveString

Downloads a text string from a remote server using FTP (File Transfer Protocol).

FoundationLite
Ftp_SendFile Ftp_SendFile

Sends a file to a remote server using FTP (File Transfer Protocol).

FoundationLite
Ftp_SendImage Ftp_SendImage

Sends an image to a remote server using FTP (File Transfer Protocol).

FoundationLite
Ftp_SendString Ftp_SendString

Sends a string to a remote serve using FTP (File Transfer Protocol).

FoundationLite

HTTP

Icon Name Description / Applications Modules
Http_DecodeURL Http_DecodeURL

Converts text from URL friendly text to a string.

FoundationLite
Http_EncodeURL Http_EncodeURL

Converts string to URL friendly text.

FoundationLite
Http_SendBinaryData Http_SendBinaryData

Sends a raw HTTP request.

FoundationLite
Http_SendCustomRequest Http_SendCustomRequest

Sends a custom HTTP request.

FoundationLite
Http_SendRequest_DELETE Http_SendRequest_DELETE

Sends a DELETE request to server and receives a text answer.

FoundationLite
Http_SendRequest_DELETE_ByteBuffer Http_SendRequest_DELETE_ByteBuffer

Sends a DELETE request to server and receives a binary answer.

FoundationLite
Http_SendRequest_GET Http_SendRequest_GET

Sends a GET request to server and receives a text answer.

FoundationLite
Http_SendRequest_GET_ByteBuffer Http_SendRequest_GET_ByteBuffer

Sends a GET request to server and receives a binary answer.

FoundationLite
Http_SendRequest_PATCH Http_SendRequest_PATCH

Sends a PATCH request to the server and receives a text answer.

FoundationLite
Http_SendRequest_PATCH_ByteBuffer Http_SendRequest_PATCH_ByteBuffer

Sends a PATCH request to the server and receives a text answer.

FoundationLite
Http_SendRequest_PATCH_JSON Http_SendRequest_PATCH_JSON

Sends a PATCH request in JSON format to the server and receives a text answer.

FoundationLite
Http_SendRequest_POST Http_SendRequest_POST

Sends a POST request to the server and receives a text answer.

FoundationLite
Http_SendRequest_POST_ByteBuffer Http_SendRequest_POST_ByteBuffer

Sends a POST request to the server and receives a text answer.

FoundationLite
Http_SendRequest_POST_JSON Http_SendRequest_POST_JSON

Sends a POST request in JSON format to the server and receives a text answer.

FoundationLite
Http_SendRequest_PUT Http_SendRequest_PUT

Sends a PUT request to the server and receives a text answer.

FoundationLite
Http_SendRequest_PUT_ByteBuffer Http_SendRequest_PUT_ByteBuffer

Sends a PUT request to the server and receives a text answer.

FoundationLite
Http_SendRequest_PUT_JSON Http_SendRequest_PUT_JSON

Sends a PUT request in JSON format to the server and receives a text answer.

FoundationLite

Interoperability

Icon Name Description / Applications Modules
LoadEntities_FromDxf LoadEntities_FromDxf

Loads entities from a DXF file as an array of point arrays.

FoundationPro
LoadImage_FromDxf LoadImage_FromDxf

Loads data from a DXF file as an image.

FoundationPro
LoadImage_FromWebsite LoadImage_FromWebsite

Loads a JPG image from a website.

FoundationBasic
LoadPoint3DGrid LoadPoint3DGrid

Loads entities from a file of one of available types as an array of points in 3D.

FoundationBasic
LoadPoint3DGridWithImage LoadPoint3DGridWithImage

Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an ordered rectangular grid with no holes.

FoundationBasic
LoadSurfaceWithImage LoadSurfaceWithImage

Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an unordered grid with possible holes.

FoundationBasic
SavePoint3DGrid SavePoint3DGrid

Saves Point3DGrid in to file in one of the supported formats.

FoundationBasic

WebSocket

Icon Name Description / Applications Modules
WebSocket_Close WebSocket_Close

Closes a WebSocket connection.

FoundationBasic
WebSocket_Connect WebSocket_Connect

Connects to a remote server using WebSocket protocol.

FoundationBasic
WebSocket_ReadBuffer WebSocket_ReadBuffer

Receives a byte buffer from a connected WebSocket.

FoundationBasic
WebSocket_ReadText WebSocket_ReadText

Receives a string from a connected WebSocket.

FoundationBasic
WebSocket_WriteBuffer WebSocket_WriteBuffer

Outputs a byte buffer through a connected WebSocket.

FoundationBasic
WebSocket_WriteText WebSocket_WriteText

Outputs a string through a connected WebSocket.

FoundationBasic