r3fremp

Class

real/raytr/r3fremp.h

Library

r3raytr

Description:

FREngMultiThread Class Multi threaded rendering engine. Uses a number of FRENG objects in separate threads to speed up rendering.

See Also

real/raytr/r3frbase.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Frengmultithread

Class Identifier

R3CLID_FRENGMULTITHREAD - 111

Methods

OUTPUTOPTIMIZE, AUTOBOXCOUNT, DELETETHREADS, GETSRVSTATISTICS,

Attributes

ServerList, BoxName, BoxCountX, BoxCountY, BoxRendering, KeepBoxes, Resume, FailureBoxMth, ConnectTimeOut, ForceLocalThread, AutoBoxCount, BoxOrder,

R3FRMPM_OUTPUTOPTIMIZE

Method

OUTPUTOPTIMIZE

Identifier

R3FRMPM_OUTPUTOPTIMIZE

JavaScript

obj.OUTPUTOPTIMIZE();

Description

R3FRMPCM_AUTOBOXCOUNT

Method

AUTOBOXCOUNT

Identifier

R3FRMPCM_AUTOBOXCOUNT

Param 1:

R3INT*, number of x boxes

Param 2:

R3INT*, number of y boxes

Param 3:

R3TAG*, tag list including any of R3FRA_XResol, R3FRA_YResol, R3FRMPA_Concurrency, R3FRMPA_ServerList

JavaScript

obj.AUTOBOXCOUNT(p1, p2, p3);

Description

Estimates optimal box counts

R3FRMPM_DELETETHREADS

Method

DELETETHREADS

Identifier

R3FRMPM_DELETETHREADS

JavaScript

obj.DELETETHREADS();

Description

Delete rendering threads

R3FRMPM_GETSRVSTATISTICS

Method

GETSRVSTATISTICS

Identifier

R3FRMPM_GETSRVSTATISTICS

Return

R3BOOL, true if server was found

Param 1:

R3INT, ordnum of the server (0, ... )

JavaScript

rc = obj.GETSRVSTATISTICS(p1, 0);

Description

fetch statistics for the given server.

ServerList

Attribute

ServerList

Identifier

R3FRMPA_ServerList

JavaScript type

r3List

C type

R3LIST

Description

Syntax

jsobj.SetServerList(value);

R3LIST value = ...;
R3SetAttrs(r3obj, R3FRMPA_ServerList, value, R3TAG_END);

BoxName

Attribute

BoxName

Identifier

R3FRMPA_BoxName

JavaScript type

String

C type

char*

Description

a C sprintf format string of type 'name%d%d' for intermediate boxes, with two integer parameters - must be unique per frame/field/renderer etc.

Syntax

jsobj.SetBoxName(value);
value = jsobj.GetBoxName();

char* value = ...;
R3SetAttrs(r3obj, R3FRMPA_BoxName, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3FRMPA_BoxName, &value, R3TAG_END);

BoxCountX

Attribute

BoxCountX

Identifier

R3FRMPA_BoxCountX

JavaScript type

Integer

C type

int

Description

'R3FRMPA_BoxCountX' not documented

Syntax

jsobj.SetBoxCountX(value);
value = jsobj.GetBoxCountX();

int value = ...;
R3SetAttrs(r3obj, R3FRMPA_BoxCountX, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3FRMPA_BoxCountX, &value, R3TAG_END);

BoxCountY

Attribute

BoxCountY

Identifier

R3FRMPA_BoxCountY

JavaScript type

Integer

C type

int

Description

'R3FRMPA_BoxCountY' not documented

Syntax

jsobj.SetBoxCountY(value);
value = jsobj.GetBoxCountY();

int value = ...;
R3SetAttrs(r3obj, R3FRMPA_BoxCountY, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3FRMPA_BoxCountY, &value, R3TAG_END);

BoxRendering

Attribute

BoxRendering

Identifier

R3FRMPA_BoxRendering

JavaScript type

Boolean

C type

R3BOOL

Description

switches on/off box rendering

Syntax

jsobj.SetBoxRendering(value);
value = jsobj.GetBoxRendering();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FRMPA_BoxRendering, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FRMPA_BoxRendering, &value, R3TAG_END);

KeepBoxes

Attribute

KeepBoxes

Identifier

R3FRMPA_KeepBoxes

JavaScript type

Boolean

C type

R3BOOL

Description

do not delete boxes at cancel

Syntax

jsobj.SetKeepBoxes(value);
value = jsobj.GetKeepBoxes();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FRMPA_KeepBoxes, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FRMPA_KeepBoxes, &value, R3TAG_END);

Resume

Attribute

Resume

Identifier

R3FRMPA_Resume

JavaScript type

Boolean

C type

R3BOOL

Description

try resuming previously canceled rendering

Syntax

jsobj.SetResume(value);
value = jsobj.GetResume();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FRMPA_Resume, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FRMPA_Resume, &value, R3TAG_END);

FailureBoxMth

Attribute

FailureBoxMth

Identifier

R3FRMPA_FailureBoxMth

JavaScript type

Integer

C type

R3INT

Description

method for above

Syntax

jsobj.SetFailureBoxMth(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3FRMPA_FailureBoxMth, value, R3TAG_END);

ConnectTimeOut

Attribute

ConnectTimeOut

Identifier

R3FRMPA_ConnectTimeOut

JavaScript type

Integer

C type

R3INT

Description

seconds to wait servers to respond

Syntax

jsobj.SetConnectTimeOut(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3FRMPA_ConnectTimeOut, value, R3TAG_END);

ForceLocalThread

Attribute

ForceLocalThread

Identifier

R3FRMPA_ForceLocalThread

JavaScript type

Boolean

C type

R3BOOL

Description

make sure alocal thread is available for post proc actions

Syntax

jsobj.SetForceLocalThread(value);
value = jsobj.GetForceLocalThread();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FRMPA_ForceLocalThread, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FRMPA_ForceLocalThread, &value, R3TAG_END);

AutoBoxCount

Attribute

AutoBoxCount

Identifier

R3FRMPA_AutoBoxCount

JavaScript type

Boolean

C type

R3BOOL

Description

estimate box count internally

Syntax

jsobj.SetAutoBoxCount(value);
value = jsobj.GetAutoBoxCount();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FRMPA_AutoBoxCount, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FRMPA_AutoBoxCount, &value, R3TAG_END);

BoxOrder

Attribute

BoxOrder

Identifier

R3FRMPA_BoxOrder

JavaScript type

Integer

C type

R3INT

Description

box rendering order, see codes below

Syntax

jsobj.SetBoxOrder(value);
value = jsobj.GetBoxOrder();

R3INT value = ...;
R3SetAttrs(r3obj, R3FRMPA_BoxOrder, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3FRMPA_BoxOrder, &value, R3TAG_END);

R3MAX_CONCURRENCY