Jump to content

GreExcludeClipRectangle: Difference between revisions

From EDM2
Created page with "GreExcludeClipRectangle excludes the specified rectangle from the clipping region, that is, the area covered by the rectangle will be outside the resulting clip region. If COM..."
 
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
 
Line 1: Line 1:
GreExcludeClipRectangle excludes the specified rectangle from the clipping region, that is, the area covered by the rectangle will be outside the resulting clip region. If COM_TRANSFORM is not set, the function expects the rectangle points to be in device coordinates. GreExcludeClipRectangle creates a clip region when none exists. The application is responsible for deleting this clip region when it is finished. Otherwise, it is not deleted until the DC is closed.  
GreExcludeClipRectangle excludes the specified rectangle from the clipping region, that is, the area covered by the rectangle will be outside the resulting clip region. If COM_TRANSFORM is not set, the function expects the rectangle points to be in device coordinates. GreExcludeClipRectangle creates a clip region when none exists. The application is responsible for deleting this clip region when it is finished. Otherwise, it is not deleted until the DC is closed.


This function can be hooked by the presentation driver.  
This function can be hooked by the presentation driver.


; Simulation support: This function is simulated by a handling routine in the graphics engine.  
;Simulation support: This function is simulated by a handling routine in the graphics engine.


 
== Syntax ==
== Syntax ==  
  GreExcludeClipRectangle(hdc, prclRect, pInstance, lFunction)
  GreExcludeClipRectangle(hdc, prclRect, pInstance, lFunction);


== Parameters ==
== Parameters ==
;hdc (HDC) - input  
;hdc (HDC) - input:Device context handle.
:Device context handle.  
;prclRect (P[[RECTL]]) - input:Pointer to rectangle in world or device coordinates.
 
;pInstance (PVOID) - input:Pointer to instance data.
;prclRect (PRECTL) - input  
;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreExcludeClipRectangle.
:Pointer to rectangle in world or device coordinates.  
 
:RECTL structure:
 
::xLeft Minimum x-coordinate of rectangle
::yBottom Minimum y-coordinate
::xRight Maximum x-coordinate of rectangle
::yTop Maximum y-coordinate
 
:All the boundaries of this rectangle are considered to be part of the interior and are clipped accordingly.
 
;pInstance (PVOID) - input  
:Pointer to instance data.  
 
;lFunction (ULONG) - input  
:High-order WORD=flags; low-order WORD=NGreExcludeClipRectangle.  


== Returns ==
== Returns ==
;rc (LONG) - returns  
;rc (LONG) - returns:Return codes.
:Return codes.  
:This function returns an integer (lComplexity) indicating the complexity of the DC region:
 
:*RGN_ERROR Error
:This function returns an integer (lComplexity) indicating the complexity of the DC region:  
:*RGN_NULL Null region
 
:*RGN_RECT Rectangular region
:*RGN_ERROR Error  
:*RGN_COMPLEX Complex region (more than 1 rectangle)
:*RGN_NULL Null region  
:Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
:*RGN_RECT Rectangular region  
:*PMERR_COORDINATE_OVERFLOW
:*RGN_COMPLEX Complex region (more than 1 rectangle)  
:*PMERR_DEV_FUNC_NOT_INSTALLED
 
:*PMERR_HDC_BUSY
:Possible Errors Detected:   When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:  
:*PMERR_INSUFFICIENT_MEMORY
 
:*PMERR_INV_COORD_SPACE
:*PMERR_COORDINATE_OVERFLOW  
:*PMERR_INV_COORDINATE
:*PMERR_DEV_FUNC_NOT_INSTALLED  
:*PMERR_INV_HDC
:*PMERR_HDC_BUSY  
:*PMERR_INV_HRGN
:*PMERR_INSUFFICIENT_MEMORY  
:*PMERR_INV_IN_AREA
:*PMERR_INV_COORD_SPACE  
:*PMERR_INV_IN_PATH
:*PMERR_INV_COORDINATE  
:*PMERR_INV_LENGTH_OR_COUNT
:*PMERR_INV_HDC  
:*PMERR_INV_RECT
:*PMERR_INV_HRGN  
:*PMERR_INV_REGION_CONTROL
:*PMERR_INV_IN_AREA  
:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.
:*PMERR_INV_IN_PATH  
:*PMERR_INV_LENGTH_OR_COUNT  
:*PMERR_INV_RECT  
:*PMERR_INV_REGION_CONTROL  
 
:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.  
 


== Sample ==
== Sample ==
Line 72: Line 48:
LONG      rc;        /*  Return codes. */
LONG      rc;        /*  Return codes. */


rc = GreExcludeClipRectangle(hdc, prclRect,
rc = GreExcludeClipRectangle(hdc, prclRect, pInstance, lFunction);
      pInstance, lFunction);
</pre>
</pre>


[[Category:Gre]]
[[Category:Gre]]

Latest revision as of 03:25, 24 January 2020

GreExcludeClipRectangle excludes the specified rectangle from the clipping region, that is, the area covered by the rectangle will be outside the resulting clip region. If COM_TRANSFORM is not set, the function expects the rectangle points to be in device coordinates. GreExcludeClipRectangle creates a clip region when none exists. The application is responsible for deleting this clip region when it is finished. Otherwise, it is not deleted until the DC is closed.

This function can be hooked by the presentation driver.

Simulation support
This function is simulated by a handling routine in the graphics engine.

Syntax

GreExcludeClipRectangle(hdc, prclRect, pInstance, lFunction)

Parameters

hdc (HDC) - input
Device context handle.
prclRect (PRECTL) - input
Pointer to rectangle in world or device coordinates.
pInstance (PVOID) - input
Pointer to instance data.
lFunction (ULONG) - input
High-order WORD=flags; low-order WORD=NGreExcludeClipRectangle.

Returns

rc (LONG) - returns
Return codes.
This function returns an integer (lComplexity) indicating the complexity of the DC region:
  • RGN_ERROR Error
  • RGN_NULL Null region
  • RGN_RECT Rectangular region
  • RGN_COMPLEX Complex region (more than 1 rectangle)
Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
  • PMERR_COORDINATE_OVERFLOW
  • PMERR_DEV_FUNC_NOT_INSTALLED
  • PMERR_HDC_BUSY
  • PMERR_INSUFFICIENT_MEMORY
  • PMERR_INV_COORD_SPACE
  • PMERR_INV_COORDINATE
  • PMERR_INV_HDC
  • PMERR_INV_HRGN
  • PMERR_INV_IN_AREA
  • PMERR_INV_IN_PATH
  • PMERR_INV_LENGTH_OR_COUNT
  • PMERR_INV_RECT
  • PMERR_INV_REGION_CONTROL
Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

Sample

#define INCL_GRE_CLIP
#include <os2.h>

HDC       hdc;        /*  Device context handle. */
PRECTL    prclRect;   /*  Pointer to rectangle in world or device coordinates. */
PVOID     pInstance;  /*  Pointer to instance data. */
ULONG     lFunction;  /*  High-order WORD=flags; low-order  WORD=NGreExcludeClipRectangle. */
LONG      rc;         /*  Return codes. */

rc = GreExcludeClipRectangle(hdc, prclRect, pInstance, lFunction);
Retrieved from "https://www.edm2.com/index.php?title=GreExcludeClipRectangle&oldid=69726"