Highlight Table

Related topics include:

• The data structure, PEXHighlightValues
• Table Types, Availability, and Definitions

For an overview and a list of lookup tables, see Lookup Tables.

Highlight table entries indicate how primitives are highlighted.

----------------------------------------------------------------------------------------------
Table Value                                         Description        Fallback            PEX
Mask
----------------------------------------------------------------------------------------------
PEXLUTVHighlightMethod                                                                     5.2
                                                    highlight method   PEXHighlightImpDep 
PEXLUTVHighlightColor                                                                      5.2
                                                    highlight color    (imp-dep)
PEXLUTVHighlightAll5_2 (selects all table values)                                          5.2
 
----------------------------------------------------------------------------------------------

The superseded requests PEXSetTableEntries, PEXGetTableEntries, PEXGetTableEntry, and PEXGetPredefinedEntries do not operate on highlight lookup tables.

PEXlib defines the following values:

highlight method:

Each method indicates how the specified color is used.

PEXHighlightImpDep -

highlights a primitive in an implementation-dependent way.

PEXHighlightColor -

highlights a primitive by overriding its color with the color specified by the highlight color table value of the active highlight color table entry. The implementation does not apply lighting, shading, depth cueing, transparency, texture mapping, nor data mapping to the primitive. The implementation applies the color to both the front-facing and back-facing facets of the surface primitives.

Remove highlighting by clearing and re-rendering the image.

highlight color:

specifies the color used. The resulting color overrides the primitive's color for highlight methods that use color.

Highlighting is performed when a primitive is rendered and the pipeline state's name set (see PEXOCCAddToNameSet) is contained in the renderer's highlight inclusion name set and not in the renderer's highlight exclusion name set. The value of the pipeline state's highlight index selects the desired entry of the table.

Direct color components that are out of range are treated in an implementation-dependent way. If you specify an unsupported color type, then the implementation issues a BadPEXColorType error. If the color type is PEXColorTypeIndexed and the color index is 65535, then the implementation issues a BadValue error. If you specify an unsupported highlight method, then the implementation issues a BadValue error.

Valid highlight table indices are in the range [1, 65535]. The fallback entry is entry 1.