PEXOCCConditionalReturn - Conditional Return (5.2)

Synopsis 

 
   void PEXOCCConditionalReturn(
        PEXOCC context,
        unsigned long mask,
        int test
   )

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).

mask
The bit mask to use in the conditional test.

test
The type of conditional test to use (PEXCTAllEnabled, PEXCTAllDisabled, PEXCTNotAllDisabled, PEXCTNotAllEnabled, PEXCTAlwaysPass or PEXCTAlwaysFail).

Returns

None.

Description

Invoke PEXOCCConditionalReturn to create a conditional return output command.

Use the mask argument to select which bits in the renderer's condition flags are used in the test. The test passes if these selected bits in the renderer's condition flags meet the condition described by the test argument. If the test passes, then the implementation terminates the processing of output commands in the current structure, restores the saved renderer pipeline state, and then resumes processing output commands in the parent structure. If the implementation is processing the root structure or if this output command is included in a PEXRenderOutputCommands or PEXRenderElements request, then the implementation ignores all subsequent output commands until encountering the next PEXEndRendering or PEXEndStructure request.

If the test fails, then the implementation continues processing output commands.

Errors

BadPEXOutputCommand
The test argument is not a registered value.

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.