PgContextBlit()

Copy data from a rectangle in one context to another context

Synopsis:

void PgContextBlit( PdOffscreenContext_t *src,
                    PhRect_t *src_rect, 
                    PdOffscreenContext_t *dst,
                    PhRect_t *dst_rect );

Library:

ph

Description:

PgContextBlit() copies data from a rectangle in one context to a rectangle in another context. This function obeys many of the parameters in the current draw state: Chroma, Alpha, Raster Operation (DrawMode), Fill Pattern (FillDither), and Fill Transparency pattern (FillTransp).

Fill Patterns are used only if the Raster Operation requested includes a pattern operation (e.g. Pg_DrawModePSo). Fill Transparency patterns are obeyed whether or not the Raster operation includes a pattern. If the current Raster Operation is a Photon 1.xx raster operation (e.g. Pg_DRAWMODE_OPAQUE), then all patterns are ignored.

The arguments are:

src

The source context, or NULL to copy from the display.

src_rect

A pointer to a PhRect_t structure that defines the rectangle in the source to copy. If src is NULL, src_rect is relative to the emitting region (see PgSetRegion()) but isn't clipped by overlapping windows.

dst

The destination context, or NULL to copy to the display.

dst_rect

The rectangle in the destination to which to copy.

Currently the smaller of the two rectangles is used for the width and height of the copied data. In the future, the source data will be scaled to the destination rectangle, so to insure compatibility with future versions of Photon, use the same size of rectangle for both.

Classification:

Photon

See also:

PdCreateOffscreenContext(), PdDupOffscreenContext(), PdGetOffscreenContextPtr(), PdOffscreenContext_t, PgContextBlitArea(), PgSetRegion(), PgSwapDisplay(), PhRect_t

"Video memory offscreen" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide