r3postpr

Class

real/raytr/r3postpr.h

Library

r3raytr

Description:

Post processing image effect base class. Post processors derived from this class manipulate the image without any external geometric information (such a processor may contain geometric data itself, but it does not refer to particles etc. objects in the scene). This class is suitable base class for example for all purely 2d image effects.

See Also

real/raytr/r3frlibo.h

Super Class

r3Frlibobject

R3CLID_FRLIBOBJECT

JavaScript

r3Postprocessor

Class Identifier

R3CLID_POSTPROCESSOR - 251

Methods

LINK, UPDATE, ENUMNEEDEDCHANNELS, FINDEFFECT, FINDCHILDEFFECT,

Attributes

XExtend, YExtend, XExtendRel, YExtendRel, ResolX, ResolY, Parent, IsActive,

Registration

int R3RegisterPostProcessorClass(R3APP *app);

R3POSTPRM_LINK

Method

LINK

Identifier

R3POSTPRM_LINK

Param 1:

R3LIST, the list of post particles. Each node is R3REFNODE and its .obj field points to a particle.

Param 3:

R3TAG*, tag array including R3POSTPRA_Time, R3POSTPRA_PeriodicTime, R3POSTPRA_Projection, * R3POSTPRA_FocusingDistance, R3POSTPRA_FStop and R3POSTPRA_DepthOfField

JavaScript

obj.LINK(p1, p3);

Description

informs post effect system that all objects have been defined. Some camera attributes such * as modelview projection and image resolution are still unknown.

R3POSTPRM_UPDATE

Method

UPDATE

Identifier

R3POSTPRM_UPDATE

Param 3:

R3TAG*, tag array, see attribute list below

JavaScript

obj.UPDATE(p3);

Description

informs post effect system that whole configuration is ready.

R3POSTPRM_ENUMNEEDEDCHANNELS

Method

ENUMNEEDEDCHANNELS

Identifier

R3POSTPRM_ENUMNEEDEDCHANNELS

Param 1:

R3OBJ*, retobj

Param 3:

R3INT, retmth

JavaScript

obj.ENUMNEEDEDCHANNELS(p1, p3);

Description

enumerate all raysample channels that are needed (to render by raytracer) * by sending R3SendMsgA(retobj, retmth, channelname)

R3POSTPRM_FINDEFFECT

Method

FINDEFFECT

Identifier

R3POSTPRM_FINDEFFECT

Param 3:

char*, name of the effect

JavaScript

obj.FINDEFFECT(p3);

Description

search for an effect whose name is specified. Search starting from the root effect

R3POSTPRM_FINDCHILDEFFECT

Method

FINDCHILDEFFECT

Identifier

R3POSTPRM_FINDCHILDEFFECT

JavaScript

obj.FINDCHILDEFFECT();

Description

used internally by R3POSTPRM_FINDEFFECT

XExtend

Attribute

XExtend

Identifier

R3POSTPRA_XExtend

JavaScript type

Integer

C type

R3INT

Description

number of pixels. Extend values define an additional area around the outputted area, which should be rendered for this effect to work continuously in animations, box rendering etc. Rendering engine clips the additional area automatically before outputting it. Maximum area defined by XExtend and XExtendRel if both are given, will be used

Syntax

value = jsobj.GetXExtend();

R3INT value;
R3GetAttrs(r3obj, R3POSTPRA_XExtend, &value, R3TAG_END);

YExtend

Attribute

YExtend

Identifier

R3POSTPRA_YExtend

JavaScript type

Integer

C type

R3INT

Description

'R3POSTPRA_YExtend' not documented

Syntax

value = jsobj.GetYExtend();

R3INT value;
R3GetAttrs(r3obj, R3POSTPRA_YExtend, &value, R3TAG_END);

XExtendRel

Attribute

XExtendRel

Identifier

R3POSTPRA_XExtendRel

JavaScript type

Number

C type

R3FLOAT

Description

proportion extension area width/image width. E.g 0.1 = 10 % of the image

Syntax

value = jsobj.GetXExtendRel();

R3FLOAT value;
R3GetAttrs(r3obj, R3POSTPRA_XExtendRel, &value, R3TAG_END);

YExtendRel

Attribute

YExtendRel

Identifier

R3POSTPRA_YExtendRel

JavaScript type

Number

C type

R3FLOAT

Description

'R3POSTPRA_YExtendRel' not documented

Syntax

value = jsobj.GetYExtendRel();

R3FLOAT value;
R3GetAttrs(r3obj, R3POSTPRA_YExtendRel, &value, R3TAG_END);

ResolX

Attribute

ResolX

Identifier

R3POSTPRA_ResolX

JavaScript type

Integer

C type

R3INT

Description

width of the image in pixels

Syntax

jsobj.SetResolX(value);

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

ResolY

Attribute

ResolY

Identifier

R3POSTPRA_ResolY

JavaScript type

Integer

C type

R3INT

Description

height of the image in pixels

Syntax

jsobj.SetResolY(value);

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

Parent

Attribute

Parent

Identifier

R3POSTPRA_Parent

JavaScript type

Object

C type

R3OBJ*

Description

parent effect

Syntax

jsobj.SetParent(value);
value = jsobj.GetParent();

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

IsActive

Attribute

IsActive

Identifier

R3POSTPRA_IsActive

JavaScript type

Integer

C type

R3INT

Description

TRUE if the effect can be rendered and will have an effect

Syntax

value = jsobj.GetIsActive();

R3INT value;
R3GetAttrs(r3obj, R3POSTPRA_IsActive, &value, R3TAG_END);

R3PPR_PERSPECTIVE

R3PPR_ORTHOGRAPHIC

Tags

R3POSTPRA_FocusingDistance

R3POSTPRA_FStop

R3POSTPRA_DepthOfField

R3POSTPRA_Tracer

R3POSTPRA_TraceMethod

R3POSTPRA_ProgressIndicator