GoPxL_GrabSurface


Captures Surface from GoPxL device.

Syntax

C++
Python
 
def GoPxL_GrabSurface(
	state: GoPxL_State,
	outSurface: Surface,
	/,
	*,
	inAddress: str | None = None,
	inInputQueueSize: int = 1,
	inSourceID: int | None = None
)
-> (
	outResult: bool,
	outSurfaceIntensity: Image | None,
	outFrameInfo: GoPxLFrameInfo
)

Parameters

Name Type Range Default Description
Input will be modified ioState GoPxL_State
Input value inAddress str | None None GoPxL Device identifying IP address (e.g. "127.0.0.1" or "127.0.0.1:3600") or serial number (e.g. "SN:17335")
Input value inInputQueueSize int 1 - 50000 1 Number of incoming frames that can be buffered before the application is able to process them
Input value inSourceID int | None 0 - None ID of the data source in Gocator Protocol
Output value outSurface Surface Surface
Output value outSurfaceIntensity Image | None SurfaceIntensity
Output value outFrameInfo GoPxLFrameInfo Frame metadata