PEXOCCSetBFSurfaceColorIndex - Set Back-Facing Surface Color Index (5.0)


Synopsis

 
    void PEXOCCSetBFSurfaceColorIndex(
         PEXOCC context,
         unsigned int index
     )
 

 
     void PEXSetBFSurfaceColorIndex(
          Display *display,
          XID resource_id,
          PEXOCRequestType req_type,
          unsigned int index
     )
 

Arguments

context
An OC context returned by a successful PEXCreateOCCcall.

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 color table index for back-facing surfaces.

Returns

None.

Description

Invoke PEXOCCSetBFSurfaceColorIndex to set the back-facing surface color attribute to an indexed color in the renderer's pipeline state according to the value specified by index. The index selects an entry of the renderer's color table. You can alternately use the PEXOCCSetBFSurfaceColor function which allows you to specify a color of any type.

By setting the back-facing surface color attribute's ASF to PEXIndividual (see PEXOCCSetIndividualASF), you use the pipeline state's surface color entry to determine the color of back-facing surface attributes. When you set the back-facing surface color attribute's ASF to PEXBundled, the implementation uses the surface color from the interior bundle table.

To apply the back-facing surface color index to the back-facing surfaces of output primitives, you must set the facet distinguish flag to True (see PEXOCCSetFacetDistinguishFlag). If you set the flag to False, then the implementation uses the surface color index when rendering back-facing surfaces (see PEXOCCSetSurfaceColorIndex).

If you specify an undefined color table index, then the index defaults to one. If color table index one is not defined, then the back-facing surface color defaults to white. If you specify a color table index which is greater than 65534, then the implementation issues a BadPEXOutputCommand error.

This function is a member of the styled and shaded surface attribute set.

Errors

BadPEXOutputCommand
The color index value exceeds 65534.

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 all output attribute functions, see Output Attribute Functions.