r3rimage

Class

real/frio/r3rimage.h

Library

r3frio

Description:

RImage Class

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Rimage

Class Identifier

R3CLID_RIMAGE - 559

Methods

CLEANUPCACHE, CONVERTFILEIMAGE, INSTALLREFRESHHOOK, REMOVEREFRESHHOOK, GETACTUALNAME, CREATEBINDINGOBJECT,

Attributes

FileName, BindingObject, RamImage, Width, Height, Frame, TotalFrames, ImageChanged, TrueClass,

R3RIMGCM_CLEANUPCACHE

Method

CLEANUPCACHE

Identifier

R3RIMGCM_CLEANUPCACHE

Param 3:

R3BOOL, force full cleanup. If true all unused images are freed regardless of cleanup counting.

JavaScript

obj.CLEANUPCACHE(p3);

Description

Class method. Frees images which have not been used during the last R3RIMGCA_CleanupCount * cleanup method calls.

R3RIMGCM_CONVERTFILEIMAGE

Method

CONVERTFILEIMAGE

Identifier

R3RIMGCM_CONVERTFILEIMAGE

Return

R3BOOL, true if succeeded

Param 1:

char*, source file

Param 2:

char*, target file

Param 3:

R3TAG*, R3RIMGA_Width, R3RIMGA_Height, R3RIMGA_ImageClid

JavaScript

rc = obj.CONVERTFILEIMAGE(p1, p2, p3);

Description

Class method. Opens the given file image and converts it * to specified format and resolution.

R3RIMGCM_INSTALLREFRESHHOOK

Method

INSTALLREFRESHHOOK

Identifier

R3RIMGCM_INSTALLREFRESHHOOK

Return

R3BOOL, true if hook installation succeeded

Param 1:

R3OBJ*, callback object

Param 3:

R3INT, callback method

JavaScript

rc = obj.INSTALLREFRESHHOOK(p1, p3);

Description

Class method. Installs image cache refresh hook. The hook object is called if a searched image * file is not found or if it is not up to date. Hook call goes as: * * image_found = R3SendMsg3(hook_obj, hook_mth, filename, filestatus, taglist); * * Callback method should return TRUE if search was successful and image loading should be tried again. * If it returns FALSE, the next installed hook is called. * Hook parameter p2 is R3FILESTATUS *, an optional file specs. Taglist is currently unused.

R3RIMGCM_REMOVEREFRESHHOOK

Method

REMOVEREFRESHHOOK

Identifier

R3RIMGCM_REMOVEREFRESHHOOK

Param 1:

R3OBJ*, callback object

Param 3:

R3INT, callback method

JavaScript

obj.REMOVEREFRESHHOOK(p1, p3);

Description

Class method. Removes a hook set by R3RIMGCM_INSTALLREFRESHHOOK.

R3RIMGCM_GETACTUALNAME

Method

GETACTUALNAME

Identifier

R3RIMGCM_GETACTUALNAME

Return

R3BOOL, true if image found

Param 1:

char*, pointer to a string buffer (LEN_DOSNAME chars) to which the full file path is copied

JavaScript

rc = obj.GETACTUALNAME(p1, 0);

Description

Class method. Tries opening an image file with the given name. If succeeds, * the actual full path is copied to parameter string p1. Possible refresh hooks are called * if the image is not found.

R3RIMGM_CREATEBINDINGOBJECT

Method

CREATEBINDINGOBJECT

Identifier

R3RIMGM_CREATEBINDINGOBJECT

Return

R3OBJ*, binding object

JavaScript

rc = obj.CREATEBINDINGOBJECT();

Description

Create binding object for the image, with default bindings.

FileName

Attribute

FileName

Identifier

R3RIMGA_FileName

JavaScript type

String

C type

char*

Description

file name

Syntax

jsobj.SetFileName(value);
value = jsobj.GetFileName();

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

BindingObject

Attribute

BindingObject

Identifier

R3RIMGA_BindingObject

JavaScript type

Object

C type

R3OBJ*

Description

object which specifies channel bindings

Syntax

jsobj.SetBindingObject(value);
value = jsobj.GetBindingObject();

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

RamImage

Attribute

RamImage

Identifier

R3RIMGA_RamImage

JavaScript type

Object

C type

R3OBJ*

Description

actual image object

Syntax

value = jsobj.GetRamImage();

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

Width

Attribute

Width

Identifier

R3RIMGA_Width

JavaScript type

Integer

C type

R3INT

Description

horizontal resolution

Syntax

value = jsobj.GetWidth();

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

Height

Attribute

Height

Identifier

R3RIMGA_Height

JavaScript type

Integer

C type

R3INT

Description

vertical resolution

Syntax

value = jsobj.GetHeight();

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

Frame

Attribute

Frame

Identifier

R3RIMGA_Frame

JavaScript type

Integer

C type

R3INT

Description

frame index

Syntax

jsobj.SetFrame(value);

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

TotalFrames

Attribute

TotalFrames

Identifier

R3RIMGA_TotalFrames

JavaScript type

Integer

C type

R3INT

Description

total number of frames

Syntax

value = jsobj.GetTotalFrames();

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

ImageChanged

Attribute

ImageChanged

Identifier

R3RIMGA_ImageChanged

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax

jsobj.SetImageChanged(value);

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

TrueClass

Attribute

TrueClass

Identifier

R3RIMGA_TrueClass

JavaScript type

Integer

C type

int

Description

class id of the file object

Syntax

value = jsobj.GetTrueClass();

int value;
R3GetAttrs(r3obj, R3RIMGA_TrueClass, &value, R3TAG_END);

Tags

R3RIMGA_OpenSilently

R3RIMGA_OutputClid

R3RIMGA_OutputImage

R3RIMGA_ProgressData