PEXOCCTestExtent2D - Test Extent 2D Output Command (5.2)


Synopsis

 
   void PEXOCCTestExtent2D(
        PEXOCC context,
        PEXCoord2D corner1,
        PEXCoord2D corner2,
        int index,
        int condition,
        unsigned long clip_test_mask,
        unsigned long size_test_mask
   )
 

Arguments

context
An OC context returned by a successful PEXCreateOCC call.

display (OCC)
A pointer to a display structure returned by a successful XOpenDisplay call.

resource_id (OCC)
The resource identifier of the renderer or structure.

req_type (OCC)
The request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

corner1
One corner of the extent box.

corner2
The other corner of the extent box.

index
Index into the renderer's extent size table.

condition
Comparison condition for the extent size (PEXLessThan, PEXLessThanOrEqualTo, PEXGreaterThan, PEXGreaterThanOrEqualTo, PEXEqualTo or PEXNotEqualTo)

clip_test_mask
Bitmask indicating bits to be changed in the renderer's condition flags according to the result of the clip test.

size_test_mask Bitmask indicating bits to be changed in the renderer's condition flags according to the result of the size test.

Returns

None.

Description

Invoke PEXOCCTestExtent2D to create a test extent two-dimensional output command which, when encountered by a renderer, modifies the renderer's pipeline state condition flags based on the results of a clip test and a size test against the given extent.

T he command is a 2D form of the Test Extent output command, and differs from it only by containing a 2D value for corner1 and corner2. The z-coordinate of the corners is implicitly zero. Once these implicit values are associated with the output command, it is processed as a Test Extent output command.

Errors

BadPEXOutputCommand
The value of index is zero.

BadPEXOutputCommand
Condition is not one of the registered relational test values.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPEXStructure
The specified structure resource identifier is invalid.

See Also

See Structure Control and Miscellaneous Functions for an overview.