PgDrawRepPhImage(), PgDrawRepPhImagemx()

Repeatedly draw an image stored in a PhImage_t structure

Synopsis:

int PgDrawRepPhImage( PhImage_t const *image,
                      int flags,
                      PhPoint_t const *pos,
                      PhPoint_t const *rep,
                      PhPoint_t const *space );

int PgDrawRepPhImagemx( PhImage_t const *image,
                        int flags,
                        PhPoint_t const *pos,
                        PhPoint_t const *rep,
                        PhPoint_t const *space );

Library:

ph

Description:

These functions unite the convenience of PgDrawPhImage() or PgDrawPhImagemx() and the ability to tile images of PgDrawRepImage() or PgDrawRepBitmap().

PgDrawRepPhImage() and PgDrawRepPhImagemx() draw:

• the first image at pos and the next image space.x pixels to the right
• the image rep.x times in the x direction and rep.y times in the y direction
• each row of images space.y pixels below the previous row.

The pos, rep, and space arguments all point to structures of type PhPoint_t.

You can pass any combination of the following bits in the flags argument:

Pg_GHOST or Pt_GHOST

Render the image using the ghost bitmap as a transparency mask.

Pg_REPBM_ALTERNATE

Draw all the images twice; the second time the position is offset by half of space.x and space.y.

If you call the "mx" form of this function, the data isn't physically copied into the draw buffer. Instead, a pointer to the image is stored until the draw buffer is flushed. Make sure you call PgFlush() before you modify the image. If the data is in shared memory, the "mx" form of this function automatically passes a shared memory reference instead of the image.

Returns:

0

Success.

-1

The draw buffer is too small to hold the current draw state, the draw command, and one pixel line of the image. Increase the size of the draw buffer, or decrease the width of the image.

Classification:

Photon

See also:

ApGetImageRes(), PgDrawPhImage(), PgDrawPhImagemx(), PgDrawPhImageRectmx(), PgDrawRepImage(), PgDrawRepBitmap(), PgFlush(), PhCreateImage(), PhImage_t, PhMakeGhostBitmap(), PhMakeTransBitmap(), PhMakeTransparent(), PhPoint_t, PhReleaseImage(), PmMemCreateMC(), PmMemFlush(), PxLoadImage()

"Images" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide