GrayDBufGetPlane Function (Macro)

gray.h

void *GrayDBufGetPlane (short idx, short plane);

Returns a pointer to a specific plane of a specific buffer.

GrayDBufGetPlane acts like GrayGetPlane, but it has an additional parameter idx which contains the index of the buffer for which the plane pointer should be returned. idx should be 0 or 1; it is usually a value returned from GrayDBufGetActiveIdx or GrayDBufGetHiddenIdx. Usually, you do not need to call this function explicitly; call GrayDBufGetActivePlane or GrayDBufGetHiddenPlane instead.

Drawing into the currently visible buffer has (almost) direct effect on the contents of the screen. Drawing into the hidden buffer has no effect until GrayDBufSetActiveIdx or GrayDBufToggle is called.


See also: GrayGetPlane, GrayDBufGetActivePlane, GrayDBufGetHiddenPlane, GrayDBufGetActiveIdx, GrayDBufGetHiddenIdx, GrayDBufSetActiveIdx