Prototype declaration:
KMSTATUS KMAPI kmSetUserClipping( IN PKMVERTEXBUFFDESC pVertexBuffDesc, IN KMUSERCLIPMODE nPrevUserClipMode, IN KMLISTTYPE nListType, IN PKMRECT pRect );
Description:
Parameters:This function sets up the user clipping area. The user clipping area that is specified here is valid for polygons for which KM_USERCLIP_INSIDE or KM_USERCLIP_OUTSIDE was specified in the KMSTRIPCONTEXT structure's StripControl.nUserClipMode member and the KMVERTEXCONTEXT structure's UserClipMode member. Note that this area is valid for individual ListTypes. Note: It is not possible to clip only a portion of a strip when registering a vertex strip. Specifically, kmSetUserClipping must not be issued from the point when a vertex strip started by kmStartVertexStrip is registered until KMVERTEXPARAM_ENDOFSTRIP is registered by kmSetVertex.
Return values:pVertexBuffDesc(input) This parameter is a pointer to KMVERTEXBUFFDESC. nPrevUserClipMode(input) This sets UserClipMode before switching. KM_USERCLIP_DISABLE KM_USERCLIP_INSIDE KM_USERCLIP_OUTSIDE When specifying this at the start of each pass, set KM_USERCLIP_DISABLE. nListType(input) This sets the ListType for which the UserClipping area is to be set up. KM_OPAQUE_POLYGON KM_OPAQUE_MODIFIER KM_TRANS_POLYGON KM_TRANS_MODIFIER KM_PUNCHTHROUGH_POLYGON pRect(input) This specifies the pointer to KMRECT. This sets the upper left and lower right coordinates for a user clipping area in KMRECT. The values that are specified here are given in units of tiles. (1 = 32 pixels) pRect->nXmin (only lower 6 bits are valid) pRect->nYmin (only lower 4 bits are valid) pRect->nXmax (only lower 6 bits are valid) pRect->nYmax (only lower 4 bits are valid)
Value Explanation KMSTATUS_SUCCESS Success