r3dc

r3dcgfx
r3dcogl
r3hidlin

r3dc

Class

oops/r3dc.h

Library

r3oops

Description:

Draw context base class. Defines interface for real-time 2D/3D rendering.

See Also

oops/r3root.h

See Also

oops/r3vect.h oops/r3color.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Drawcontext

Class Identifier

R3CLID_DRAWCONTEXT - 267

Methods

ENABLEBUFFERS, GETOPTIONS, BITSPERPIXEL, CLEAR, SHOWBACKDROP, SETCOLORRGBA, SETCOLORINDEX, SETDRAWMODE, SETDRAWPATTERN, RECT, RECTFILL, LINE, TEXT, POINT, POLY, POLYFILL, BLIT, SCANLINEBEGIN, SCANLINEEND, SCANLINE8, SCANLINE24, SWAPBUFFERS, GETPALETTEINDEX, GETCOLORFORINDEX, TRANSFORMATION, PUSHSCREENTRANSFORMATI, POPSCREENTRANSFORMATIO, PUSHMATRIX, POPMATRIX, POLY3D, POINTS3D, VERTEX3D, NORMAL3D, BEGIN3D, END3D, SETSHADED, LIGHTAMBIENT, LIGHTPOINT, LIGHTDISTANT, LIGHTSPOT, RGBTEXTURE, VERTEXCOLOR, VERTEXSPECULAR, VERTEXSHININESS, VERTEXEMISSION, VERTEXTEXTURECOORD, NEWDISPLAYLIST, ENDDISPLAYLIST, CALLDISPLAYLIST, DELETEDISPLAYLISTS, GENDISPLAYLISTS, ISDISPLAYLIST, DISABLELIGHTING, ENABLELIGHTING, DISABLEDEPTHTEST, ENABLEDEPTHTEST, PUSHTEXTUREMATRIX, POPTEXTUREMATRIX, SPHEREMAP, DRAWICON, DISABLEBUFFERS, PREPAREIMAGE, IMAGE, UNPREPAREIMAGE, BACKUPRECTANGLE, RESTORERECTANGLE, CANCELRECTANGLE, GETENABLEDBUFFERS, GETDRAWMODE, SETLINEWIDTH, GETLINEWIDTH, BEGINMOTION, ENDMOTION, BEGINFRAME, ENDFRAME, BEGINSAMPLE, ENDSAMPLE, PROJECTPOINTS, UNPROJECTPOINTS, ISPOINTVISIBLE, DRAWICON3D, LIGHTPOINTEXT, LIGHTDISTANTEXT, LIGHTSPOTEXT, GETCHANNELREADINGOPTIO, BEGINREADCHANNEL, ENDREADCHANNEL, READCHANNELROWBYTE, READCHANNELROWFLOAT, ENABLEBLEND, DISABLEBLEND, GETOWNERTHREAD, SETSPECULARCOLORRGBA, DRAWPOLYINDIRECT, ENABLETEXTURE, DISABLETEXTURE, RESETLIGHTS, RESTOREFROMBACKUP, SETPOINTSIZE, ARRAYQUADSETSHADED, ARRAYTRISETSHADED, ARRAYQUADSETFACESSHADE, ARRAYTRISETFACESSHADED, ARRAYQUADSET, ARRAYTRISET, POINTARRAY, POINTARRAYSHADED, SETFRONTFACE, ARRAYQUADSETFACESSHADE, ARRAYTRISETFACESSHADED, DRAWFACEARRAY, SETEMISSIONCOLORRGBA,

Attributes

Font, Shaded, CoordSys, Scale, Width, Height, Perspective, DoubleBuffer, Overlay, DoubleBufferOverlays, BackDrop, BackUp, ClipMinX, ClipMinY, ClipMaxX, ClipMaxY, Depth, MinClipDist, MaxClipDist, GlobalAlpha, NoVertPersp, PixelAspect, BackgroundColor,

Registration

int R3RegisterDrawContextClass(R3APP *app);

R3DCM_ENABLEBUFFERS

Method

ENABLEBUFFERS

Identifier

R3DCM_ENABLEBUFFERS

JavaScript

obj.ENABLEBUFFERS();

Description

Enable certain buffers for rendering. See ENABLEBUFFER flags below

R3DCM_GETOPTIONS

Method

GETOPTIONS

Identifier

R3DCM_GETOPTIONS

JavaScript

obj.GETOPTIONS();

Description

Fetch drawing options. This method is provided only for backward compability. Please use the attribute R3DCA_Options, to get and set these.

R3DCM_BITSPERPIXEL

Method

BITSPERPIXEL

Identifier

R3DCM_BITSPERPIXEL

JavaScript

obj.BITSPERPIXEL();

Description

Unused

R3DCM_CLEAR

Method

CLEAR

Identifier

R3DCM_CLEAR

Param 3:

R3INT, color index

JavaScript

obj.CLEAR(p3);

Description

Clear canvas with given color.

R3DCM_SHOWBACKDROP

Method

SHOWBACKDROP

Identifier

R3DCM_SHOWBACKDROP

JavaScript

obj.SHOWBACKDROP();

Description

Copy backdrop image into the visible buffer.

R3DCM_SETCOLORRGBA

Method

SETCOLORRGBA

Identifier

R3DCM_SETCOLORRGBA

Param 3:

R3FLOATCOLOR, rgba values for the current color

JavaScript

obj.SETCOLORRGBA(p3);

Description

Set current color

R3DCM_SETCOLORINDEX

Method

SETCOLORINDEX

Identifier

R3DCM_SETCOLORINDEX

Param 3:

R3INT, index

JavaScript

obj.SETCOLORINDEX(p3);

Description

Set current color by color index.

R3DCM_SETDRAWMODE

Method

SETDRAWMODE

Identifier

R3DCM_SETDRAWMODE

Param 3:

R3INT, draw mode to be set

JavaScript

obj.SETDRAWMODE(p3);

Description

Set current rendering mode. See draw modes below.

R3DCM_SETDRAWPATTERN

Method

SETDRAWPATTERN

Identifier

R3DCM_SETDRAWPATTERN

Param 3:

R3INT, see drawing patterns below

JavaScript

obj.SETDRAWPATTERN(p3);

Description

Set current rendering pattern

R3DCM_RECT

Method

RECT

Identifier

R3DCM_RECT

JavaScript

obj.RECT();

Description

Render rectangle

R3DCM_RECTFILL

Method

RECTFILL

Identifier

R3DCM_RECTFILL

JavaScript

obj.RECTFILL();

Description

Render filled rectangle

R3DCM_LINE

Method

LINE

Identifier

R3DCM_LINE

JavaScript

obj.LINE();

Description

Render line consisting of two points

R3DCM_TEXT

Method

TEXT

Identifier

R3DCM_TEXT

Param 3:

char*, string to be printed

JavaScript

obj.TEXT(p3);

Description

Not implemented yet

R3DCM_POINT

Method

POINT

Identifier

R3DCM_POINT

Param 1:

R3INT, number of points to be rendered

Param 2:

R3FLOATCOLOR, colors for points, if null, drawn with current color

JavaScript

obj.POINT(p1, p2, 0);

Description

Render given number of points

R3DCM_POLY

Method

POLY

Identifier

R3DCM_POLY

Param 1:

R3INT, number of points in the polygon

JavaScript

obj.POLY(p1, 0);

Description

Render polygon

R3DCM_POLYFILL

Method

POLYFILL

Identifier

R3DCM_POLYFILL

Param 1:

R3INT, number of points in the polygon

JavaScript

obj.POLYFILL(p1, 0);

Description

Render polygon

R3DCM_BLIT

Method

BLIT

Identifier

R3DCM_BLIT

Param 1:

R3INT, position for the left

Param 2:

R3INT, position for the top edge

Param 3:

R3OBJ*, image object to be blitted

JavaScript

obj.BLIT(p1, p2, p3);

Description

Blit an image to the dc

R3DCM_SCANLINEBEGIN

Method

SCANLINEBEGIN

Identifier

R3DCM_SCANLINEBEGIN

Param 3:

R3INT, width of the line to be rendered

JavaScript

obj.SCANLINEBEGIN(p3);

Description

Initialize DC for scanline rendering

R3DCM_SCANLINEEND

Method

SCANLINEEND

Identifier

R3DCM_SCANLINEEND

JavaScript

obj.SCANLINEEND();

Description

tell window that there will be no more scanlines.

R3DCM_SCANLINE8

Method

SCANLINE8

Identifier

R3DCM_SCANLINE8

Param 1:

R3INT, offset_x

Param 2:

R3INT, y coordinate

Param 3:

R3UBYTE*, array of 'width' palette indexes.

JavaScript

obj.SCANLINE8(p1, p2, p3);

Description

Write one line of palette indexes into the draw context

R3DCM_SCANLINE24

Method

SCANLINE24

Identifier

R3DCM_SCANLINE24

Param 1:

R3INT, offset_x

Param 2:

R3INT, y coordinate

JavaScript

obj.SCANLINE24(p1, p2, 0);

Description

Write one line of true color values into the draw context

R3DCM_SWAPBUFFERS

Method

SWAPBUFFERS

Identifier

R3DCM_SWAPBUFFERS

JavaScript

obj.SWAPBUFFERS();

Description

Do swap buffers for double buffered draw context

R3DCM_GETPALETTEINDEX

Method

GETPALETTEINDEX

Identifier

R3DCM_GETPALETTEINDEX

Return

R3INT, palette index

Param 3:

R3FLOATCOLOR, color

JavaScript

rc = obj.GETPALETTEINDEX(p3);

Description

Fetch palette index for the given color.

R3DCM_GETCOLORFORINDEX

Method

GETCOLORFORINDEX

Identifier

R3DCM_GETCOLORFORINDEX

Return

R3BOOL, true if succeeded

Param 1:

R3INT, color index

Param 3:

R3FLOATCOLOR, color

JavaScript

rc = obj.GETCOLORFORINDEX(p1, p3);

Description

Fetch color for given palette index

R3DCM_TRANSFORMATION

Method

TRANSFORMATION

Identifier

R3DCM_TRANSFORMATION

JavaScript

obj.TRANSFORMATION();

Description

Obsolete

R3DCM_PUSHSCREENTRANSFORMATI

Method

PUSHSCREENTRANSFORMATI

Identifier

R3DCM_PUSHSCREENTRANSFORMATI

JavaScript

obj.PUSHSCREENTRANSFORMATI();

Description

Push screen transformation on transformation stack.

R3DCM_POPSCREENTRANSFORMATIO

Method

POPSCREENTRANSFORMATIO

Identifier

R3DCM_POPSCREENTRANSFORMATIO

JavaScript

obj.POPSCREENTRANSFORMATIO();

Description

Fetch screen transformation off the stack.

R3DCM_PUSHMATRIX

Method

PUSHMATRIX

Identifier

R3DCM_PUSHMATRIX

Param 3:

R3MATRIX

JavaScript

obj.PUSHMATRIX(p3);

Description

Push given 4x4 matrix onto the stack

R3DCM_POPMATRIX

Method

POPMATRIX

Identifier

R3DCM_POPMATRIX

JavaScript

obj.POPMATRIX();

Description

Fetch matrix off the stack

R3DCM_POLY3D

Method

POLY3D

Identifier

R3DCM_POLY3D

Param 1:

R3INT, number of points

Param 2:

R3BOOL, closed if TRUE

Param 3:

R3VECTOR, array of points defining polygon

JavaScript

obj.POLY3D(p1, p2, p3);

Description

Render 3D polygon.

R3DCM_POINTS3D

Method

POINTS3D

Identifier

R3DCM_POINTS3D

Param 1:

R3INT, number of points to be renderer

Param 3:

R3VECTOR, point array

JavaScript

obj.POINTS3D(p1, p3);

Description

Render given number of points.

R3DCM_VERTEX3D

Method

VERTEX3D

Identifier

R3DCM_VERTEX3D

Param 3:

R3VECTOR, vertex to be defined.

JavaScript

obj.VERTEX3D(p3);

Description

Define 3D vertex for primitive defined by R3DCM_BEGIN3D.

R3DCM_NORMAL3D

Method

NORMAL3D

Identifier

R3DCM_NORMAL3D

JavaScript

obj.NORMAL3D();

Description

Define surface normal for primitive to be renderer. See R3DCM_BEGIN3D method.

R3DCM_BEGIN3D

Method

BEGIN3D

Identifier

R3DCM_BEGIN3D

JavaScript

obj.BEGIN3D();

Description

Begin definition of 3D geometry.

R3DCM_END3D

Method

END3D

Identifier

R3DCM_END3D

JavaScript

obj.END3D();

Description

Ends definition of geometric object. See R3DCM_BEGIN3D,

R3DCM_SETSHADED

Method

SETSHADED

Identifier

R3DCM_SETSHADED

Param 3:

R3BOOL, TRUE sets shaded mode, FALSE resets.

JavaScript

obj.SETSHADED(p3);

Description

Set shaded mode.

R3DCM_LIGHTAMBIENT

Method

LIGHTAMBIENT

Identifier

R3DCM_LIGHTAMBIENT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color of the ambient light

JavaScript

rc = obj.LIGHTAMBIENT(p1, p2, 0);

Description

Define ambient light source. This has no geometry.

R3DCM_LIGHTPOINT

Method

LIGHTPOINT

Identifier

R3DCM_LIGHTPOINT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

Param 3:

R3VECTOR, position

JavaScript

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

Description

Define point light. See also R3DCM_LIGHTPOINTEXT

R3DCM_LIGHTDISTANT

Method

LIGHTDISTANT

Identifier

R3DCM_LIGHTDISTANT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

Param 3:

R3VECTOR, direction

JavaScript

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

Description

Define distant light. See also R3DCM_LIGHTDISTANTEXT

R3DCM_LIGHTSPOT

Method

LIGHTSPOT

Identifier

R3DCM_LIGHTSPOT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

JavaScript

rc = obj.LIGHTSPOT(p1, p2, 0);

Description

Define spot light. See also R3DCM_LIGHTSPOTEXT

R3DCM_RGBTEXTURE

Method

RGBTEXTURE

Identifier

R3DCM_RGBTEXTURE

Param 1:

R3INT, width

Param 2:

R3INT, height

JavaScript

obj.RGBTEXTURE(p1, p2, 0);

Description

Define texture map

R3DCM_VERTEXCOLOR

Method

VERTEXCOLOR

Identifier

R3DCM_VERTEXCOLOR

Param 3:

R3FLOATCOLOR, color for the vertex

JavaScript

obj.VERTEXCOLOR(p3);

Description

Define color for vertex defined using R3DCM_VERTEX3D.

R3DCM_VERTEXSPECULAR

Method

VERTEXSPECULAR

Identifier

R3DCM_VERTEXSPECULAR

Param 3:

R3FLOATCOLOR, specular color for the vertex

JavaScript

obj.VERTEXSPECULAR(p3);

Description

Define specularity for vertex

R3DCM_VERTEXSHININESS

Method

VERTEXSHININESS

Identifier

R3DCM_VERTEXSHININESS

Param 3:

R3FLOAT, shininess

JavaScript

obj.VERTEXSHININESS(p3);

Description

Define shininess for vertex

R3DCM_VERTEXEMISSION

Method

VERTEXEMISSION

Identifier

R3DCM_VERTEXEMISSION

Param 3:

R3FLOATCOLOR, emission color for the vertex

JavaScript

obj.VERTEXEMISSION(p3);

Description

Define emission color for vertex

R3DCM_VERTEXTEXTURECOORD

Method

VERTEXTEXTURECOORD

Identifier

R3DCM_VERTEXTEXTURECOORD

JavaScript

obj.VERTEXTEXTURECOORD();

Description

Define U/V coordinates for the current vertex

R3DCM_NEWDISPLAYLIST

Method

NEWDISPLAYLIST

Identifier

R3DCM_NEWDISPLAYLIST

Param 3:

R3INT, identifier (name) for the display list

JavaScript

obj.NEWDISPLAYLIST(p3);

Description

Begin definition of display list

R3DCM_ENDDISPLAYLIST

Method

ENDDISPLAYLIST

Identifier

R3DCM_ENDDISPLAYLIST

JavaScript

obj.ENDDISPLAYLIST();

Description

End definition of display list

R3DCM_CALLDISPLAYLIST

Method

CALLDISPLAYLIST

Identifier

R3DCM_CALLDISPLAYLIST

Param 3:

R3INT, indentifier of the list to be called

JavaScript

obj.CALLDISPLAYLIST(p3);

Description

Execute given display list.

R3DCM_DELETEDISPLAYLISTS

Method

DELETEDISPLAYLISTS

Identifier

R3DCM_DELETEDISPLAYLISTS

Param 1:

R3INT, list to be deleted

Param 3:

R3INT, number of lists to be deleted.

JavaScript

obj.DELETEDISPLAYLISTS(p1, p3);

Description

Delete given display list

R3DCM_GENDISPLAYLISTS

Method

GENDISPLAYLISTS

Identifier

R3DCM_GENDISPLAYLISTS

Param 3:

R3INT, range

JavaScript

obj.GENDISPLAYLISTS(p3);

Description

Create a continuous set of display lists

R3DCM_ISDISPLAYLIST

Method

ISDISPLAYLIST

Identifier

R3DCM_ISDISPLAYLIST

Return

R3BOOL, TRUE if exists.

Param 3:

R3INT, list to be tested

JavaScript

rc = obj.ISDISPLAYLIST(p3);

Description

Test for display list existence.

R3DCM_DISABLELIGHTING

Method

DISABLELIGHTING

Identifier

R3DCM_DISABLELIGHTING

JavaScript

obj.DISABLELIGHTING();

Description

Disable lighiting if shaded mode is set

R3DCM_ENABLELIGHTING

Method

ENABLELIGHTING

Identifier

R3DCM_ENABLELIGHTING

JavaScript

obj.ENABLELIGHTING();

Description

Enable lighiting again if shaded mode is set

R3DCM_DISABLEDEPTHTEST

Method

DISABLEDEPTHTEST

Identifier

R3DCM_DISABLEDEPTHTEST

JavaScript

obj.DISABLEDEPTHTEST();

Description

Disable depth test if shaded mode is set

R3DCM_ENABLEDEPTHTEST

Method

ENABLEDEPTHTEST

Identifier

R3DCM_ENABLEDEPTHTEST

JavaScript

obj.ENABLEDEPTHTEST();

Description

enable depth test again if shaded mode is set

R3DCM_PUSHTEXTUREMATRIX

Method

PUSHTEXTUREMATRIX

Identifier

R3DCM_PUSHTEXTUREMATRIX

Param 3:

R3MATRIX

JavaScript

obj.PUSHTEXTUREMATRIX(p3);

Description

Push given 4x4 matrix onto the stack

R3DCM_POPTEXTUREMATRIX

Method

POPTEXTUREMATRIX

Identifier

R3DCM_POPTEXTUREMATRIX

JavaScript

obj.POPTEXTUREMATRIX();

Description

Pop the topmost matrix off the stack

R3DCM_SPHEREMAP

Method

SPHEREMAP

Identifier

R3DCM_SPHEREMAP

JavaScript

obj.SPHEREMAP();

Description

Use spherical mapping to define uv texture coordinates

R3DCM_DRAWICON

Method

DRAWICON

Identifier

R3DCM_DRAWICON

Param 1:

R3INT, left coordinate

Param 2:

R3INT, top

Param 3:

R3OBJ*, icon object

JavaScript

obj.DRAWICON(p1, p2, p3);

Description

Draw icon

R3DCM_DISABLEBUFFERS

Method

DISABLEBUFFERS

Identifier

R3DCM_DISABLEBUFFERS

Param 3:

R3INT, buffers to be disabled, see the buffer flags

JavaScript

obj.DISABLEBUFFERS(p3);

Description

Disable buffers

R3DCM_PREPAREIMAGE

Method

PREPAREIMAGE

Identifier

R3DCM_PREPAREIMAGE

Return

void*, image buffer

Param 1:

R3INT, width of the image

Param 2:

R3INT, height of the image

JavaScript

rc = obj.PREPAREIMAGE(p1, p2, 0);

Description

Creates an image buffer for fast drawing

R3DCM_IMAGE

Method

IMAGE

Identifier

R3DCM_IMAGE

Param 1:

R3INT, position for the left edge

Param 2:

R3INT, position for the top edge

Param 3:

void*, image to be blitted

JavaScript

obj.IMAGE(p1, p2, p3);

Description

Draws an image prepared by the R3DCM_PREPAREIMAGE method

R3DCM_UNPREPAREIMAGE

Method

UNPREPAREIMAGE

Identifier

R3DCM_UNPREPAREIMAGE

Param 3:

void*, image buffer

JavaScript

obj.UNPREPAREIMAGE(p3);

Description

Free resources allocated by the R3DCM_PREPAREIMAGE method

R3DCM_BACKUPRECTANGLE

Method

BACKUPRECTANGLE

Identifier

R3DCM_BACKUPRECTANGLE

Return

void*, buffer containing the backed-up rectangle

JavaScript

rc = obj.BACKUPRECTANGLE();

Description

Backs up a rectangle. Either R3DCM_RESTORERECTANGLE or R3DCM_CANCELRECTANGLE * (but not both) must be called to free resources allocated by this method.

R3DCM_RESTORERECTANGLE

Method

RESTORERECTANGLE

Identifier

R3DCM_RESTORERECTANGLE

Return

R3INT, TRUE

Param 3:

void*, buffer containing the backed-up rectangle

JavaScript

rc = obj.RESTORERECTANGLE(p3);

Description

Restores the rectangle and frees resources allocated by the R3DCM_BACKUPRECTANGLE method

R3DCM_CANCELRECTANGLE

Method

CANCELRECTANGLE

Identifier

R3DCM_CANCELRECTANGLE

Return

R3INT, TRUE

Param 3:

void*, buffer containing the backed-up rectangle

JavaScript

rc = obj.CANCELRECTANGLE(p3);

Description

Frees resources allocated by the R3DCM_BACKUPRECTANGLE method but does not restore the rectangle onto the canvas.

R3DCM_GETENABLEDBUFFERS

Method

GETENABLEDBUFFERS

Identifier

R3DCM_GETENABLEDBUFFERS

Return

R3INT, flags

JavaScript

rc = obj.GETENABLEDBUFFERS();

Description

Return enabled buffer flags. See ENABLEBUFFER flags below

R3DCM_GETDRAWMODE

Method

GETDRAWMODE

Identifier

R3DCM_GETDRAWMODE

Return

R3INT, draw mode

JavaScript

rc = obj.GETDRAWMODE();

Description

Get current rendering mode. See draw modes below.

R3DCM_SETLINEWIDTH

Method

SETLINEWIDTH

Identifier

R3DCM_SETLINEWIDTH

Param 3:

R3FLOAT, line width in pixels

JavaScript

obj.SETLINEWIDTH(p3);

Description

Set line width

R3DCM_GETLINEWIDTH

Method

GETLINEWIDTH

Identifier

R3DCM_GETLINEWIDTH

Param 3:

R3FLOAT, line width

JavaScript

obj.GETLINEWIDTH(p3);

Description

Get current line width

R3DCM_BEGINMOTION

Method

BEGINMOTION

Identifier

R3DCM_BEGINMOTION

Param 3:

R3INT, number of samples per frame

JavaScript

obj.BEGINMOTION(p3);

Description

Begin motion blur rendering

R3DCM_ENDMOTION

Method

ENDMOTION

Identifier

R3DCM_ENDMOTION

JavaScript

obj.ENDMOTION();

Description

R3DCM_BEGINFRAME

Method

BEGINFRAME

Identifier

R3DCM_BEGINFRAME

Param 3:

R3INT, frame to be rendered

JavaScript

obj.BEGINFRAME(p3);

Description

Begin frame rendering. Subsequent swap buffers are taken as samples for the frame

R3DCM_ENDFRAME

Method

ENDFRAME

Identifier

R3DCM_ENDFRAME

JavaScript

obj.ENDFRAME();

Description

Show motion blurred frame.

R3DCM_BEGINSAMPLE

Method

BEGINSAMPLE

Identifier

R3DCM_BEGINSAMPLE

Param 3:

R3INT, sample to be rendered, must be between 0 ... samples/frame-1

JavaScript

obj.BEGINSAMPLE(p3);

Description

Begin sample

R3DCM_ENDSAMPLE

Method

ENDSAMPLE

Identifier

R3DCM_ENDSAMPLE

JavaScript

obj.ENDSAMPLE();

Description

R3DCM_PROJECTPOINTS

Method

PROJECTPOINTS

Identifier

R3DCM_PROJECTPOINTS

Param 2:

R3INT, number of points in the array

JavaScript

obj.PROJECTPOINTS(0, p2, 0);

Description

Project given 3d points on screen using the * current canvas model-view transformaton. Only 3D * canvases support this method.

R3DCM_UNPROJECTPOINTS

Method

UNPROJECTPOINTS

Identifier

R3DCM_UNPROJECTPOINTS

Param 2:

R3INT, number of points in the array

JavaScript

obj.UNPROJECTPOINTS(0, p2, 0);

Description

Project given screen points to 3d using the * canvases model-view inverse transformaton. Only 3D * canvases support this method.

R3DCM_ISPOINTVISIBLE

Method

ISPOINTVISIBLE

Identifier

R3DCM_ISPOINTVISIBLE

Return

R3BOOL, true if visible

Param 3:

R3VECTOR, point to be studied

JavaScript

rc = obj.ISPOINTVISIBLE(p3);

Description

See if the given point is visible in the canavas * Only 3D canvases support this method.

R3DCM_DRAWICON3D

Method

DRAWICON3D

Identifier

R3DCM_DRAWICON3D

Param 1:

R3VECTOR, position in obj space

Param 2:

R3VECTOR, position in screen coordinates

Param 3:

R3OBJ*, icon object

JavaScript

obj.DRAWICON3D(p1, p2, p3);

Description

Draw icon

R3DCM_LIGHTPOINTEXT

Method

LIGHTPOINTEXT

Identifier

R3DCM_LIGHTPOINTEXT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

JavaScript

rc = obj.LIGHTPOINTEXT(p1, p2, 0);

Description

Define point light with extended atttributes

R3DCM_LIGHTDISTANTEXT

Method

LIGHTDISTANTEXT

Identifier

R3DCM_LIGHTDISTANTEXT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

JavaScript

rc = obj.LIGHTDISTANTEXT(p1, p2, 0);

Description

Define distant light with extended atttributes

R3DCM_LIGHTSPOTEXT

Method

LIGHTSPOTEXT

Identifier

R3DCM_LIGHTSPOTEXT

Return

R3BOOL, TRUE if succeeded

Param 1:

R3FLOAT, intensity

Param 2:

R3FLOATCOLOR, color

JavaScript

rc = obj.LIGHTSPOTEXT(p1, p2, 0);

Description

Define spot light with extended atttributes

R3DCM_GETCHANNELREADINGOPTIO

Method

GETCHANNELREADINGOPTIO

Identifier

R3DCM_GETCHANNELREADINGOPTIO

Return

R3INT, TRUE if the specified channel can be read

Param 3:

R3CLID, channel to query for (see canvas channels below)

JavaScript

rc = obj.GETCHANNELREADINGOPTIO(p3);

Description

queries whether a channel can be read from the canvas using * the R3DCM_READCHANNELROWBYTE and R3DCM_READCHANNELROWFLOAT methods

R3DCM_BEGINREADCHANNEL

Method

BEGINREADCHANNEL

Identifier

R3DCM_BEGINREADCHANNEL

Return

R3INT, void *, handle to be passed to R3DCM_READCHANNELROWBYTE, R3DCM_READCHANNELROWFLOAT * and R3DCM_BEGINREADCHANNEL methods. NULL if the method fails.

Param 3:

R3INT, channel to read (see canvas channels below)

JavaScript

rc = obj.BEGINREADCHANNEL(p3);

Description

prepares to read the selected channel from the canvas.

R3DCM_ENDREADCHANNEL

Method

ENDREADCHANNEL

Identifier

R3DCM_ENDREADCHANNEL

Return

R3INT, TRUE if successful

Param 3:

void*, handle allocated by R3DCM_BEGINREADCHANNEL method.

JavaScript

rc = obj.ENDREADCHANNEL(p3);

Description

frees resources allocated by R3DCM_BEGINREADCHANNEL method.

R3DCM_READCHANNELROWBYTE

Method

READCHANNELROWBYTE

Identifier

R3DCM_READCHANNELROWBYTE

Return

R3INT, TRUE if successful

Param 1:

void*, handle allocated by R3DCM_BEGINREADCHANNEL method.

Param 2:

R3INT, index of the row to read

Param 3:

void*, buffer to read to

JavaScript

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

Description

read a row of the selected channel from the canvas as bytes.

R3DCM_READCHANNELROWFLOAT

Method

READCHANNELROWFLOAT

Identifier

R3DCM_READCHANNELROWFLOAT

Return

R3INT, TRUE if successful

Param 1:

void*, handle allocated by R3DCM_BEGINREADCHANNEL method.

Param 2:

R3INT, index of the row to read

Param 3:

void*, buffer to read to

JavaScript

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

Description

read a row of the selected channel from the canvas as R3FLOATs.

R3DCM_ENABLEBLEND

Method

ENABLEBLEND

Identifier

R3DCM_ENABLEBLEND

Param 3:

R3FLOAT, global alpha

JavaScript

obj.ENABLEBLEND(p3);

Description

Enable alpha blending

R3DCM_DISABLEBLEND

Method

DISABLEBLEND

Identifier

R3DCM_DISABLEBLEND

JavaScript

obj.DISABLEBLEND();

Description

Disable alpha blending

R3DCM_GETOWNERTHREAD

Method

GETOWNERTHREAD

Identifier

R3DCM_GETOWNERTHREAD

Return

R3OBJ*, owner thread.

JavaScript

rc = obj.GETOWNERTHREAD();

Description

Returns the owner thread object. Note: DC provides threads a port to rendering to windows. Only the owner thread (the thread that created the dc) is allowed to render to it.

R3DCM_SETSPECULARCOLORRGBA

Method

SETSPECULARCOLORRGBA

Identifier

R3DCM_SETSPECULARCOLORRGBA

Param 3:

R3FLOATCOLOR, rgba

JavaScript

obj.SETSPECULARCOLORRGBA(p3);

Description

Set current specular color

R3DCM_DRAWPOLYINDIRECT

Method

DRAWPOLYINDIRECT

Identifier

R3DCM_DRAWPOLYINDIRECT

Param 1:

R3VECTOR, vertices

Param 2:

R3INT, number of indices

Param 3:

R3INT*, array of vertex indices

JavaScript

obj.DRAWPOLYINDIRECT(p1, p2, p3);

Description

Draw a polygon through vertex index array

R3DCM_ENABLETEXTURE

Method

ENABLETEXTURE

Identifier

R3DCM_ENABLETEXTURE

JavaScript

obj.ENABLETEXTURE();

Description

Enable texture mapping

R3DCM_DISABLETEXTURE

Method

DISABLETEXTURE

Identifier

R3DCM_DISABLETEXTURE

JavaScript

obj.DISABLETEXTURE();

Description

Disable texture mapping

R3DCM_RESETLIGHTS

Method

RESETLIGHTS

Identifier

R3DCM_RESETLIGHTS

JavaScript

obj.RESETLIGHTS();

Description

Reset light sources

R3DCM_RESTOREFROMBACKUP

Method

RESTOREFROMBACKUP

Identifier

R3DCM_RESTOREFROMBACKUP

Return

R3BOOL, FALSE if failed

JavaScript

rc = obj.RESTOREFROMBACKUP();

Description

Ask drawing context to restore the contents of the damaged window.

R3DCM_SETPOINTSIZE

Method

SETPOINTSIZE

Identifier

R3DCM_SETPOINTSIZE

Param 3:

R3INT, point size

JavaScript

obj.SETPOINTSIZE(p3);

Description

Set point size

R3DCM_ARRAYQUADSETSHADED

Method

ARRAYQUADSETSHADED

Identifier

R3DCM_ARRAYQUADSETSHADED

JavaScript

obj.ARRAYQUADSETSHADED();

Description

Render shaded quad set array

R3DCM_ARRAYTRISETSHADED

Method

ARRAYTRISETSHADED

Identifier

R3DCM_ARRAYTRISETSHADED

JavaScript

obj.ARRAYTRISETSHADED();

Description

Render shaded triset array

R3DCM_ARRAYQUADSETFACESSHADE

Method

ARRAYQUADSETFACESSHADE

Identifier

R3DCM_ARRAYQUADSETFACESSHADE

JavaScript

obj.ARRAYQUADSETFACESSHADE();

Description

Render shaded quadset array with uv coordinates

R3DCM_ARRAYTRISETFACESSHADED

Method

ARRAYTRISETFACESSHADED

Identifier

R3DCM_ARRAYTRISETFACESSHADED

JavaScript

obj.ARRAYTRISETFACESSHADED();

Description

Render shaded triset array with uvs

R3DCM_ARRAYQUADSET

Method

ARRAYQUADSET

Identifier

R3DCM_ARRAYQUADSET

JavaScript

obj.ARRAYQUADSET();

Description

Render quad set array

R3DCM_ARRAYTRISET

Method

ARRAYTRISET

Identifier

R3DCM_ARRAYTRISET

JavaScript

obj.ARRAYTRISET();

Description

Render triset array

R3DCM_POINTARRAY

Method

POINTARRAY

Identifier

R3DCM_POINTARRAY

JavaScript

obj.POINTARRAY();

Description

Render points

R3DCM_POINTARRAYSHADED

Method

POINTARRAYSHADED

Identifier

R3DCM_POINTARRAYSHADED

JavaScript

obj.POINTARRAYSHADED();

Description

Render shaded points

R3DCM_SETFRONTFACE

Method

SETFRONTFACE

Identifier

R3DCM_SETFRONTFACE

Param 3:

R3INT, either R3DCWINDING_CLOCKWISE or R3DCWINDING_COUNTERCLOCKWISE

JavaScript

obj.SETFRONTFACE(p3);

Description

Sets whether clockwise or counterclockwise winding generates front-facing faces.

R3DCM_ARRAYQUADSETFACESSHADE

Method

ARRAYQUADSETFACESSHADE

Identifier

R3DCM_ARRAYQUADSETFACESSHADE

Param 3:

R3TAG*, R3DCA_Indices, R3DCA_ActiveIndex, R3DCA_DrawNonTextured

JavaScript

obj.ARRAYQUADSETFACESSHADE(p3);

Description

Render shaded quadset array with uv coordinates

R3DCM_ARRAYTRISETFACESSHADED

Method

ARRAYTRISETFACESSHADED

Identifier

R3DCM_ARRAYTRISETFACESSHADED

Param 3:

R3TAG*, R3DCA_Indices, R3DCA_ActiveIndex, R3DCA_DrawNonTextured

JavaScript

obj.ARRAYTRISETFACESSHADED(p3);

Description

Render shaded triset array with uv coordinates

R3DCM_DRAWFACEARRAY

Method

DRAWFACEARRAY

Identifier

R3DCM_DRAWFACEARRAY

JavaScript

obj.DRAWFACEARRAY();

Description

Draw an array of polygons through vertex index arrays

R3DCM_SETEMISSIONCOLORRGBA

Method

SETEMISSIONCOLORRGBA

Identifier

R3DCM_SETEMISSIONCOLORRGBA

Param 3:

R3FLOATCOLOR, rgba

JavaScript

obj.SETEMISSIONCOLORRGBA(p3);

Description

Set current emission color

Font

Attribute

Font

Identifier

R3DCA_Font

JavaScript type

Object

C type

R3OBJ*

Description

font to be used

Syntax


jsobj.SetFont(value);


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

Shaded

Attribute

Shaded

Identifier

R3DCA_Shaded

JavaScript type

Boolean

C type

R3BOOL

Description

if true shaded otherwise wire frame

Syntax


jsobj.SetShaded(value);


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

CoordSys

Attribute

CoordSys

Identifier

R3DCA_CoordSys

Type

r3Coordsys

Description

Syntax


jsobj.SetCoordSys(value);


R3COORDSYS value = ...;
R3SetAttrs(r3obj, R3DCA_CoordSys, &value, R3TAG_END);

Scale

Attribute

Scale

Identifier

R3DCA_Scale

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetScale(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DCA_Scale, value, R3TAG_END);

Width

Attribute

Width

Identifier

R3DCA_Width

JavaScript type

Integer

C type

R3INT

Description

width

Syntax


jsobj.SetWidth(value);


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

Height

Attribute

Height

Identifier

R3DCA_Height

JavaScript type

Integer

C type

R3INT

Description

height

Syntax


jsobj.SetHeight(value);


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

Perspective

Attribute

Perspective

Identifier

R3DCA_Perspective

JavaScript type

Boolean

C type

R3BOOL

Description

if true, perspective project, otherwise orthographic

Syntax


jsobj.SetPerspective(value);


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

DoubleBuffer

Attribute

DoubleBuffer

Identifier

R3DCA_DoubleBuffer

JavaScript type

Boolean

C type

R3BOOL

Description

true for doublebuffered, false for singlebuffered

Syntax


jsobj.SetDoubleBuffer(value);


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

Overlay

Attribute

Overlay

Identifier

R3DCA_Overlay

JavaScript type

Boolean

C type

R3BOOL

Description

request overlay buffers

Syntax


jsobj.SetOverlay(value);


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

DoubleBufferOverlays

Attribute

DoubleBufferOverlays

Identifier

R3DCA_DoubleBufferOverlays

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetDoubleBufferOverlays(value);


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

BackDrop

Attribute

BackDrop

Identifier

R3DCA_BackDrop

JavaScript type

Boolean

C type

R3BOOL

Description

alloc backdrop buffer

Syntax


jsobj.SetBackDrop(value);


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

BackUp

Attribute

BackUp

Identifier

R3DCA_BackUp

JavaScript type

Boolean

C type

R3BOOL

Description

backing store

Syntax


jsobj.SetBackUp(value);


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

ClipMinX

Attribute

ClipMinX

Identifier

R3DCA_ClipMinX

JavaScript type

Integer

C type

R3INT

Description

clip region

Syntax


jsobj.SetClipMinX(value);


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

ClipMinY

Attribute

ClipMinY

Identifier

R3DCA_ClipMinY

JavaScript type

Integer

C type

R3INT

Description

min clip x

Syntax


jsobj.SetClipMinY(value);


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

ClipMaxX

Attribute

ClipMaxX

Identifier

R3DCA_ClipMaxX

JavaScript type

Integer

C type

R3INT

Description

max clip x

Syntax


jsobj.SetClipMaxX(value);


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

ClipMaxY

Attribute

ClipMaxY

Identifier

R3DCA_ClipMaxY

JavaScript type

Integer

C type

R3INT

Description

max clip y

Syntax


jsobj.SetClipMaxY(value);


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

Depth

Attribute

Depth

Identifier

R3DCA_Depth

JavaScript type

Integer

C type

R3INT

Description

bits per pixel

Syntax


jsobj.SetDepth(value);


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

MinClipDist

Attribute

MinClipDist

Identifier

R3DCA_MinClipDist

JavaScript type

Number

C type

R3FLOAT

Description

near clipping distance

Syntax


jsobj.SetMinClipDist(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DCA_MinClipDist, value, R3TAG_END);

MaxClipDist

Attribute

MaxClipDist

Identifier

R3DCA_MaxClipDist

JavaScript type

Number

C type

R3FLOAT

Description

far clipping distance

Syntax


jsobj.SetMaxClipDist(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DCA_MaxClipDist, value, R3TAG_END);

GlobalAlpha

Attribute

GlobalAlpha

Identifier

R3DCA_GlobalAlpha

JavaScript type

Number

C type

R3FLOAT

Description

current global alpha value

Syntax


jsobj.SetGlobalAlpha(value);
value = jsobj.GetGlobalAlpha();


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

NoVertPersp

Attribute

NoVertPersp

Identifier

R3DCA_NoVertPersp

JavaScript type

Boolean

C type

R3BOOL

Description

keep vertical lines parallel

Syntax


jsobj.SetNoVertPersp(value);


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

PixelAspect

Attribute

PixelAspect

Identifier

R3DCA_PixelAspect

JavaScript type

Number

C type

R3FLOAT

Description

pixel h/w

Syntax


jsobj.SetPixelAspect(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DCA_PixelAspect, value, R3TAG_END);

BackgroundColor

Attribute

BackgroundColor

Identifier

R3DCA_BackgroundColor

JavaScript type

Integer

C type

R3INT

Description

background color

Syntax


jsobj.SetBackgroundColor(value);


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

Flags for ENABLEBUFFERS method

R3RPF_DRAWFRONT
R3RPF_DRAWBACK
R3RPF_DRAWBACKDROP

Line patterns for SETDRAWPATTERN method

R3PTRN_SOLID
R3PTRN_DASH
R3PTRN_DOT

Draw Modes for SETDRAWMODE method

RGM_NORMAL
RGM_COMPLEMENTDRAW
RGM_OVERLAY
RGM_OVERLAY2
RGM_COMPLEMENTCLEAR

Geometry for spot light

Light source intensity fallof by distance

R3FALLOF_NONE
R3FALLOF_LINEAR
R3FALLOF_QUADRATIC

Flags for Options attribute

R3GA_OVERLAY
R3GA_DOUBLEBUFFER
R3GA_DRAW3D
R3GA_SINGLEBUFFER
R3GA_CLEARREMOVESCOMPLEMENT
R3GA_DISPLAYLISTS
R3GA_RESTORESCANLINE
R3GA_RESTOREALL
R3GA_SHADED
R3GA_SCANLINESB

R3GO_LINES
R3GO_LINE_LOOP
R3GO_POLYGON
R3GO_QUADS
R3GO_QUAD_STRIP
R3GO_TRIANGLE_STRIP
R3GO_TRIANGLE_FAN
R3GO_POINTS

canvas channels

R3CANVASCHANNEL_COLOR
R3CANVASCHANNEL_ALPHA
R3CANVASCHANNEL_DEPTH

4 * facecount

4 * facecount

4 * facecount

4 * facecount, private normal for each face corner

3 * facecount

3 * facecount

3 * facecount

3 * facecount, private normal for each face corner

R3DCWINDING_CLOCKWISE
R3DCWINDING_COUNTERCLOCKWISE

number of vertices pointed by 'vertices'

size of actual array elements pointed by 'faces'

Tags

Tags

R3DCA_Main
R3DCA_TrueColor
R3DCA_Indices
R3DCA_ActiveIndex
R3DCA_DrawNonTextured