PEXOCCIncludeStructure - Include Structure (5.2)

Synopsis 

 
   void PEXOCCIncludeStructure(
        PEXOCC context,
        PEXStructure structure
   )

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

structure
The resource identifier of the structure.

Returns

None.

Description

Invoke PEXOCCIncludeStructure to create an include structure output command which causes the specified structure to be included during structure traversal.

The implementation includes the structure by processing all the output commands in the structure without saving or restoring renderer pipeline state or modifying the global or local transforms as part of the include structure processing.

If structure does not exist at the time PEXOCCIncludeStructure is processed, then the implementation issues a BadPEXOutputCommand error. You must first create the structure.

Errors

BadPEXOutputCommand
The structure argument references an non-existent structure.

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.