PEXOCCSetDepthCueIndex - Set Depth Cue Index (5.0)

Synopsis 

 
   void PEXOCCSetDepthCueIndex(
        PEXOCC context,
        unsigned int index
   )
 


 
   void PEXSetDepthCueIndex(
           Display *display,
           XID resource_id,
           PEXOCRequestType req_type,
           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 depth cue table index.

Returns

None.

Description

Invoke PEXOCCSetDepthCueIndex to create an attribute output command which sets the depth-cue index attribute in the renderer's pipeline state according to the value specified by index.

Use the depth cue index to select an entry of the renderer's depth cue table. Depth cueing blends the color computed by the lighting, shading, and texturing stages of the rendering pipeline with a depth cue color. The blending is controlled relative to the depth in normalized projection coordinate (NPC) space. Use depth cueing, for example, to blend with the background color the portion of an image that is furthest away from the viewer. This heightens the sensation of depth in the image.

If you specify an undefined depth cue index, then the index defaults to zero. If index zero is defined, then depth cueing is turned off. If you specify an index which exceeds 65534, then the implementation issues a BadPEXOutputCommand error.

This function is a member of the global attribute set and affects all output primitives.

Errors

BadPEXOutputCommand
The depth cue 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.