r3filren

Class

real/code2/r3filren.h

Library

r3code2

Description:

File Render Class

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Filerender

Class Identifier

R3CLID_FILERENDER - 244

Methods

RENDER, CANCEL, SYNC, SETSTATHOOK,

Attributes

PrimLayer, MaterialLayer, ImageEffectLayer, ParticleEffectLayer, OutputLayer, Animator, RSpec, Output, BoxRelX, BoxRelY, BoxRelW, BoxRelH, RenderBoxActive, Resume, IgnoreMissingTextur, ImageEffectName, FieldEffectName, FrameEffectName, FailureBoxMth, RenderAction, RenderingEngine,

Registration

int R3RegisterFileRenderClass(R3APP *app);

R3FLRENM_RENDER

Method

RENDER

Identifier

R3FLRENM_RENDER

Return

R3BOOL, true if rendering succeeded.

JavaScript

rc = obj.RENDER();

Description

Start rendering. Rendering runs on a separate threads and this method returns immediately.

R3FLRENM_CANCEL

Method

CANCEL

Identifier

R3FLRENM_CANCEL

JavaScript

obj.CANCEL();

Description

Cancel rendering. Note: call returns immediately. Use R3FLRENM_SYNC if you need to make sure renderers are really stopped before you continue.

R3FLRENM_SYNC

Method

SYNC

Identifier

R3FLRENM_SYNC

JavaScript

obj.SYNC();

Description

Wait till the current rendering request has finished.

R3FLRENM_SETSTATHOOK

Method

SETSTATHOOK

Identifier

R3FLRENM_SETSTATHOOK

Param 1:

R3OBJ*, callback object

Param 3:

R3INT, callback method

JavaScript

obj.SETSTATHOOK(p1, p3);

Description

Set callback for reporting server statistics

PrimLayer

Attribute

PrimLayer

Identifier

R3FLRENA_PrimLayer

JavaScript type

Object

C type

R3OBJ*

Description

geometric primitives

Syntax

jsobj.SetPrimLayer(value);
value = jsobj.GetPrimLayer();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_PrimLayer, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3FLRENA_PrimLayer, &value, R3TAG_END);

MaterialLayer

Attribute

MaterialLayer

Identifier

R3FLRENA_MaterialLayer

JavaScript type

Object

C type

R3OBJ*

Description

materials

Syntax

jsobj.SetMaterialLayer(value);
value = jsobj.GetMaterialLayer();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_MaterialLayer, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3FLRENA_MaterialLayer, &value, R3TAG_END);

ImageEffectLayer

Attribute

ImageEffectLayer

Identifier

R3FLRENA_ImageEffectLayer

JavaScript type

Object

C type

R3OBJ*

Description

image effects

Syntax

jsobj.SetImageEffectLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_ImageEffectLayer, value, R3TAG_END);

ParticleEffectLayer

Attribute

ParticleEffectLayer

Identifier

R3FLRENA_ParticleEffectLayer

JavaScript type

Object

C type

R3OBJ*

Description

particle effects

Syntax

jsobj.SetParticleEffectLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_ParticleEffectLayer, value, R3TAG_END);

OutputLayer

Attribute

OutputLayer

Identifier

R3FLRENA_OutputLayer

JavaScript type

Object

C type

R3OBJ*

Description

output objects

Syntax

jsobj.SetOutputLayer(value);
value = jsobj.GetOutputLayer();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_OutputLayer, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3FLRENA_OutputLayer, &value, R3TAG_END);

Animator

Attribute

Animator

Identifier

R3FLRENA_Animator

JavaScript type

Object

C type

R3OBJ*

Description

animator

Syntax

jsobj.SetAnimator(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_Animator, value, R3TAG_END);

RSpec

Attribute

RSpec

Identifier

R3FLRENA_RSpec

JavaScript type

Object

C type

R3OBJ*

Description

rendering settings

Syntax

jsobj.SetRSpec(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_RSpec, value, R3TAG_END);

Output

Attribute

Output

Identifier

R3FLRENA_Output

JavaScript type

Object

C type

R3OBJ*

Description

output object

Syntax

jsobj.SetOutput(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3FLRENA_Output, value, R3TAG_END);

BoxRelX

Attribute

BoxRelX

Identifier

R3FLRENA_BoxRelX

JavaScript type

Number

C type

R3FLOAT

Description

0..1, relative box coordinates for box ray tracing

Syntax

jsobj.SetBoxRelX(value);
value = jsobj.GetBoxRelX();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FLRENA_BoxRelX, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FLRENA_BoxRelX, &value, R3TAG_END);

BoxRelY

Attribute

BoxRelY

Identifier

R3FLRENA_BoxRelY

JavaScript type

Number

C type

R3FLOAT

Description

'R3FLRENA_BoxRelY' not documented

Syntax

jsobj.SetBoxRelY(value);
value = jsobj.GetBoxRelY();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FLRENA_BoxRelY, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FLRENA_BoxRelY, &value, R3TAG_END);

BoxRelW

Attribute

BoxRelW

Identifier

R3FLRENA_BoxRelW

JavaScript type

Number

C type

R3FLOAT

Description

'R3FLRENA_BoxRelW' not documented

Syntax

jsobj.SetBoxRelW(value);
value = jsobj.GetBoxRelW();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FLRENA_BoxRelW, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FLRENA_BoxRelW, &value, R3TAG_END);

BoxRelH

Attribute

BoxRelH

Identifier

R3FLRENA_BoxRelH

JavaScript type

Number

C type

R3FLOAT

Description

'R3FLRENA_BoxRelH' not documented

Syntax

jsobj.SetBoxRelH(value);
value = jsobj.GetBoxRelH();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FLRENA_BoxRelH, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FLRENA_BoxRelH, &value, R3TAG_END);

RenderBoxActive

Attribute

RenderBoxActive

Identifier

R3FLRENA_RenderBoxActive

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax

jsobj.SetRenderBoxActive(value);
value = jsobj.GetRenderBoxActive();

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

Resume

Attribute

Resume

Identifier

R3FLRENA_Resume

JavaScript type

Boolean

C type

R3BOOL

Description

reuse existing boxes

Syntax

jsobj.SetResume(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FLRENA_Resume, value, R3TAG_END);

IgnoreMissingTextur

Attribute

IgnoreMissingTextur

Identifier

R3FLRENA_IgnoreMissingTextur

JavaScript type

Boolean

C type

R3BOOL

Description

if true rendering is performed even if textures are not found

Syntax

jsobj.SetIgnoreMissingTextur(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3FLRENA_IgnoreMissingTextures, value, R3TAG_END);

ImageEffectName

Attribute

ImageEffectName

Identifier

R3FLRENA_ImageEffectName

JavaScript type

String

C type

char*

Description

effect applied to full images (not render boxes)

Syntax

jsobj.SetImageEffectName(value);

char* value = ...;
R3SetAttrs(r3obj, R3FLRENA_ImageEffectName, value, R3TAG_END);

FieldEffectName

Attribute

FieldEffectName

Identifier

R3FLRENA_FieldEffectName

JavaScript type

String

C type

char*

Description

post effect for fields

Syntax

jsobj.SetFieldEffectName(value);

char* value = ...;
R3SetAttrs(r3obj, R3FLRENA_FieldEffectName, value, R3TAG_END);

FrameEffectName

Attribute

FrameEffectName

Identifier

R3FLRENA_FrameEffectName

JavaScript type

String

C type

char*

Description

post effect for frames

Syntax

jsobj.SetFrameEffectName(value);

char* value = ...;
R3SetAttrs(r3obj, R3FLRENA_FrameEffectName, value, R3TAG_END);

FailureBoxMth

Attribute

FailureBoxMth

Identifier

R3FLRENA_FailureBoxMth

JavaScript type

Integer

C type

R3INT

Description

method for above

Syntax

jsobj.SetFailureBoxMth(value);

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

RenderAction

Attribute

RenderAction

Identifier

R3FLRENA_RenderAction

JavaScript type

Integer

C type

R3INT

Description

see enum below

Syntax

jsobj.SetRenderAction(value);

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

RenderingEngine

Attribute

RenderingEngine

Identifier

R3FLRENA_RenderingEngine

JavaScript type

Object

C type

R3OBJ*

Description

the actual rendering engine

Syntax

value = jsobj.GetRenderingEngine();

R3OBJ* value;
R3GetAttrs(r3obj, R3FLRENA_RenderingEngine, &value, R3TAG_END);