PEXOCCSetHighlightIndex - Set Highlight Index (5.2)

Synopsis

   void PEXOCCSetHighlightIndex(
        PEXOCC context,
        unsigned int index
   )

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

index

The highlight table index.

Returns

None.

Description

Invoke PEXOCCSetHighlightIndex to create an attribute output command which sets the highlight table index attribute in the renderer's pipeline state according to the value specified by index.

Specify the highlight index to select an entry of the renderer's highlight table. When the pipeline state's name set and the highlight filter defined by the renderer's highlight inclusion and highlight exclusion entries (see highlight inclusion name set and highlight exclusion name set) indicate a primitive is to be highlighted, the selected entry of the highlight table defines the highlight method.

If you specify a highlight table index of zero, then the implementation issues a BadPEXOutputCommand error.

This function is a member of the global attribute set.

Errors

BadPEXOutputCommand

The output command contains an invalid value.

BadPEXRenderer

The specified renderer resource identifier is invalid.

BadPEXStructure

The specified structure resource identifier is invalid.

See Also

For an overview and for a list of output attribute functions, see Output Attribute Functions.