Render Connection

Groups
	ColorResolution
	FILEFORMAT
	IPCOMMANDRESULT
	OVERVIEW
	PROGRESSTYPE
	RENDERCONNECTION
	RENDERCONNECTION_COMMAND
	RENDERERROR
	SELECTION

Classes
class	BaseCommunicationThread
class	IpCommunicationThread

Typedefs
typedef void	UpdateImage(void *userdata, Int32 xpos, Int32 ypos, Int32 xcnt, ColorResolution bpp, UChar *rgba_data)

Functions
Bool	IsServerStarted (const Char *ipAddress, Int32 timeOut=0)
Bool	StartRenderServer (const Filename &filename, Int32 listen_port=1234, Bool forceNewServer=true, Int32 startUpWaitTime=NOTOK, const String &args=String())

Detailed Description

Typedef Documentation

UpdateImage

typedef void UpdateImage(void *userdata, Int32 xpos, Int32 ypos, Int32 xcnt, ColorResolution bpp, UChar *rgba_data)

Update image callback.

See also

IpCommunicationThread::GetImageUpdate()
IpCommunicationThread::GetFullImage() IpCommunicationThread::GetFullImageMP()

Parameters

[in]	userdata	A pointer to a local structure that contains for example the image buffer address. Can be nullptr. The caller owns the pointed data.
[in]	xpos	Starting X-position of the RGBA data.
[in]	ypos	Starting Y-position of the RGBA data.
[in]	xcnt	The number of pixels of the image buffer.
[in]	bpp	The color depth of the RGBA image.
[in]	rgba_data	Contains the RGBA image data (4 bytes per pixel).

Function Documentation

IsServerStarted()

Bool cineware::IsServerStarted	(	const Char *	ipAddress,
		Int32	timeOut = 0
	)

Checks if a render server at ip_address is present.

Note

Should be called only once before the first render.

Parameters

[in]	ipAddress	IP address of the render server. The default IP (127.0.0.1:1234) is used if nullptr is passed.
[in]	timeOut	Timeout in seconds to open the connection with the render server. Pass 0 to use the default behaviour. Since R19.

Returns

true if successful, otherwise false.

StartRenderServer()

Bool cineware::StartRenderServer	(	const Filename &	filename,
		Int32	listen_port = 1234,
		Bool	forceNewServer = true,
		Int32	startUpWaitTime = NOTOK,
		const String &	args = String()
	)

Starts the render server.

Note

Alternatively call GeExecute(filename,"-listen") to start the render server.

Parameters

[in]	filename	The path to the render server executable.
[in]	listen_port	Port of the render server.
[in]	forceNewServer	If false, the client connects to an already running server process, otherwise it forces a new server process.
[in]	startUpWaitTime	If NOTOK the function returns immediately after the process was created, otherwise it waits until the server process is responding. Since R19.
[in]	args	Optional commdand line arguments to be added to the execution or if the given timeout in seconds is reached. Since R19.

Returns

true if successful, otherwise false.