Intermec ck1 Reference Guide

Page of 390
Chapter 5 — Nano-X APIs 
CK1 SDK Programmer’s Reference Manual 
279 
GrSetGCRegion () 
 
Purpose:  Set the clip mask of the specified graphics context to the specified region. 
Subsequent drawing operations using this graphics context do not draw 
outside the specified region. The region identification can be set to 0 to 
remove the clipping region from the specified graphics context. 
 
Syntax: 
void        GrSetGCRegion                   (GR_GC_ID gc,
 
                                    GR_REGION_ID region); 
 
Parameters:  gc  
Identification of the graphics context to set the clip mask to. 
region  Identification of the region to use as the clip mask  
GrPointInRegion () 
 
Purpose:  Test whether the specified point is within the specified region. 
 
Syntax: 
GR_BOOL     GrPointInRegion         (GR_REGION_ID region,
 
                                             GR_COORD x
                                             GR_COORD y); 
 
Parameters:  region  the identification of the region to examine  
x 
X coordinate of the point to test for  
y 
Y coordinate of the point to test for  
 
Return:  True  If the point is within the region 
False   If the point is outside the region  
GrRectInRegion () 
 
Purpose:  Test whether the specified rectangle is contained within the specified 
region.  
 
Syntax: 
int         GrRectInRegion          (GR_REGION_ID region,
 
                                             GR_COORD x
                                             GR_COORD y
                                             GR_COORD w
                                             GR_COORD h); 
 
Parameters:  region  the identification of the region to examine  
x 
X coordinates of the rectangle to test  
y 
Y coordinates of the rectangle to test  
w 
Width of the rectangle to test  
h 
Height of the rectangle to test  
 
Return:  GR_RECT_PARTIN  If it is partially contained within the region 
GR_RECT_ALLIN 
If it is completely contained within the region 
GR_RECT_OUT 
If it is not inside it at all