r3channe

Class

real/frio/r3channe.h

Library

r3frio

Description:

Basic class for all channels.

See Also

oops/r3root.h

See Also

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Channel

Class Identifier

R3CLID_CHANNEL - 209

Methods

READ, WRITE, RENAMECHANNEL, MAPNORMALVALUE, MAPSIGNED,

Attributes

Width, Data, ExternalData,

Registration

int R3RegisterChannelClass(R3APP *app);

R3CHM_READ

Method

READ

Identifier

R3CHM_READ

JavaScript

obj.READ();

Description

R3CHM_WRITE

Method

WRITE

Identifier

R3CHM_WRITE

JavaScript

obj.WRITE();

Description

R3CHCM_RENAMECHANNEL

Method

RENAMECHANNEL

Identifier

R3CHCM_RENAMECHANNEL

JavaScript

obj.RENAMECHANNEL();

Description

R3CHCM_MAPNORMALVALUE

Method

MAPNORMALVALUE

Identifier

R3CHCM_MAPNORMALVALUE

Param 3:

R3INT*, type identifier (see r3typids.h)

JavaScript

obj.MAPNORMALVALUE(p3);

Description

Returns most suitable float-integet conversion factor for the given data type. * For example, a color channel returns 255 for R3TID_BYTE

R3CHCM_MAPSIGNED

Method

MAPSIGNED

Identifier

R3CHCM_MAPSIGNED

Param 3:

R3INT*, type identifier (see r3typids.h)

JavaScript

obj.MAPSIGNED(p3);

Description

Asks if a channel datatype should be stored as a signed quantity

Width

Attribute

Width

Identifier

R3CHA_Width

JavaScript type

Integer

C type

R3INT

Description

width of the channel

Syntax

jsobj.SetWidth(value);
value = jsobj.GetWidth();

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

Data

Attribute

Data

Identifier

R3CHA_Data

JavaScript type

String

C type

void*

Description

can be also set if R3CHA_ExternalData is TRUE

Syntax

jsobj.SetData(value);
value = jsobj.GetData();

void* value = ...;
R3SetAttrs(r3obj, R3CHA_Data, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3CHA_Data, &value, R3TAG_END);

ExternalData

Attribute

ExternalData

Identifier

R3CHA_ExternalData

JavaScript type

Boolean

C type

R3BOOL

Description

if true CREATE method does not allocate data

Syntax

jsobj.SetExternalData(value);
value = jsobj.GetExternalData();

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