GsSetClip

Sets the clipping area for drawing

void GsSetClip (
        RECT *clip
)

Arguments

clip Pointer to RECT structure defining the clipping area

Return Value

None.

Explanation

The clipping area defined by clip is set as the clipping area for drawing.
This function is different from GsSetDrawBuffClip() in that its argument can be used to specify a clipping area. Note that this clipping value is a relative one within the double buffer, and thus the clipping position will not change even when double buffers are swapped.
The clipping area set by GsSetClip() is valid only within the current drawing buffer and becomes invalid when the buffers are swapped using GsSwapDispBuff(). This is because GsSwapDispBuff() calls GsSetDrawBuffOffset() which sets the clipping area from the clip member in the global variable GsDRAWENV. This value is obtained from the global variable CLIP2.

Notes

This function does not execute correctly if it is called when GPU drawing is in progress. ResetGraph(1) should be used to terminate any current drawing process or DrawSync(0) should be used to wait until drawing is completed before this function is called.

See Also

GsSetDrawBuffClip()