Index

C/C++ Functions

pdCanvasAddFrames

DT_SWORD pdCanvasAddFrames(DT_PD_DOCDRAW_CANVAS* canvas, DT_SRAST_L x_off, DT_SRAST_L y_off, DT_SLONG idx_off, DT_ID_SLONG parent_obj, DT_SLONG local_number, DT_ID_SWORD frames_format, DT_PD_FRAMES frames, DT_SLONG frames_len)

Short Description: Add frames to canvas

The pdCanvasAddFrames function associates the supplied array of frames with the PowerDoc object that is currenlty selected in the canvas. This is a specialized function intended for developers who wish to implement their own user-defined PowerDoc objects.

Parameters

ParameterDescription

canvas

A valid pointer to DT_PD_DOCDRAW_CANVAS structure.

x_off

Horizontal offset to apply when associating the frames, in pixels.

y_off

Vertical offset to apply when associating the frames, in pixels.

idx_off

Reserved for future use. Must be set to 0.

parent_obj

Reserved for future use. Must be set to 0.

local_number

Reserved for future use. Must be set to 0.

frames_format

Specifies whether the frames to be associated are in DT_PD_FRAME_FORMAT1 or DT_PD_FRAME_FORMAT2 format. Set to 1 for DT_PD_FRAME_FORMAT1 and 2 for DT_PD_FRAME_FORMAT2.

frames

The DT_PD_FRAMES union defining the array of frames to be associated.

frames_len

The size of the frames array.

Return Value

If successful, the return value is 1. Otherwise, the function returns 0.

 

Index