Gocator_GrabSurface


Captures Surface from Gocator device.

Syntax

C++
Python
 
def Gocator_GrabSurface(
	state: Gocator_State,
	inInputQueueSize: int,
	outSurface: Surface,
	/,
	*,
	inAddress: str | None = None
)
-> (
	outResult: bool,
	outSurfaceIntensity: Image | None,
	outFrameInfo: GocatorFrameInfo
)

Parameters

Name Type Range Default Description
Input will be modified ioState Gocator_State
Input value inAddress str | None None Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
Input value inInputQueueSize int 1 - 50000 Number of incoming frames that can be buffered before the application is able to process them
Output value outSurface Surface
Output value outSurfaceIntensity Image | None
Output value outFrameInfo GocatorFrameInfo