r3postef

Class

real/code/r3postef.h

Library

r3code

Description:

Base class for post processing effects

See Also

real/code/r3ttag.h

Super Class

r3Ttag

R3CLID_TTAG

JavaScript

r3Posteffectmodel

Class Identifier

R3CLID_POSTEFFECTMODEL - 1211

Methods

RENDER, RENDERBEGIN, RENDEREND, ENUMCHANNELS, RENAMECHANNELREF,

Attributes

RenderBaseClass,

R3PEFMM_RENDER

Method

RENDER

Identifier

R3PEFMM_RENDER

Param 3:

R3OBJ*, rendering engine

JavaScript

obj.RENDER(p3);

Description

Object describes its structure to the rendering engine. This base class does this in 2 phases by sending R3PEFMM_RENDERBEGIN and R3PEFMM_RENDEREND methods to itself, see the methods below.

R3PEFMM_RENDERBEGIN

Method

RENDERBEGIN

Identifier

R3PEFMM_RENDERBEGIN

Param 1:

R3OBJ*, rendering engine

JavaScript

obj.RENDERBEGIN(p1, 0);

Description

1st phase of rendering description. A sub class should make the following actions: - Define the clid of the object which will be created by the rendering engine to render this effect. The clid is defined by the parameter p2. If it is not 0, then a sub class has already set it and the value must be inherited further as is. - Add the own attributes in the tag list given in 'p3'. - Inherit the method to its super class with the abovementioned parameter changes When this base class receives the RENDERBEGIN method, it sends R3FRM_BEGINLIBOBJECT to the rendering engine.

R3PEFMM_RENDEREND

Method

RENDEREND

Identifier

R3PEFMM_RENDEREND

Param 3:

R3OBJ*, rendering engine

JavaScript

obj.RENDEREND(p3);

Description

2nd phase of rendering description. Sub classes usually simply inherit this to the super class. This base class sends R3FRM_ENDLIBOBJECT to the rendering engine when it receives this method. This finishes the rendering actions.

R3PEFMM_ENUMCHANNELS

Method

ENUMCHANNELS

Identifier

R3PEFMM_ENUMCHANNELS

Param 1:

R3OBJ*, callback object

Param 2:

R3INT, callback method

Param 3:

void*, callback context

JavaScript

obj.ENUMCHANNELS(p1, p2, p3);

Description

enumerate all (static and dynamic) channel requirements R3DoA3(cbobj, cbmth, channelname, typeid (0 if unknown), context);

R3PEFMM_RENAMECHANNELREF

Method

RENAMECHANNELREF

Identifier

R3PEFMM_RENAMECHANNELREF

Param 1:

char*, old name

Param 3:

char*, new name

JavaScript

obj.RENAMECHANNELREF(p1, p3);

Description

rename possible references to a given channel

RenderBaseClass

Attribute

RenderBaseClass

Identifier

R3PEFMA_RenderBaseClass

JavaScript type

Integer

C type

int

Description

class id of rendering base class or NULL

Syntax

jsobj.SetRenderBaseClass(value);
value = jsobj.GetRenderBaseClass();

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

Tags

R3PEFMA_RenderingEngine