PEXGetEnumTypeInfo - Get Enumerated Type Information (5.0)

Synopsis

 
   Status PEXGetEnumTypeInfo(
          Display *display,
          Drawable drawable,
          unsigned long count,
          int *enum_types,
          unsigned long item_mask,
          unsigned long **info_count_return,
          PEXEnumTypeDesc **enum_info_return
   )

Arguments

display: A pointer to a display structure returned by a successful XOpenDisplay call.
drawable: The resource identifier of a drawable.
count: The number of enumerated types.
enum_types: The list of enumerated types about which you want information returned. (See the Description for valid values.)
item_mask: A mask indicating the data you want returned for each enumerated type. (See the Description for valid values.)
info_count_return: Returns an array of counts. For each enumerated type, there is an entry specifying the number of descriptors in the return value array.
enum_info_return: Returns an array of enumerated type descriptors containing the enumerated type information.

Returns

Zero if unsuccessful; non-zero otherwise.

Description

Invoke PEXGetEnumTypeInfo to get the supported values for each enumerated type.

For each specified enumerated type you request, this function returns a descriptor made up of an index field and a mnemonic field. The index field contains the numeric value of the supported type, and the mnemonic field contains a string describing the type. These fields contain values valid for all drawables having the same root window, depth and visual ID as the specified drawable.

Use the item_mask argument to specify the type of data you want returned in each enumerated type descriptor. PEXlib defines the following item_mask values:

PEXETCounts -: the function returns only the counts, not the descriptor values.
PEXETIndex -: the function returns the supported index values in addition to the counts.
PEXETMnemonic -: the function returns the mnemonic strings describing the supported values in addition to the counts. The mnemonic strings are returned in the ISO-LATIN1 character encoding.
PEXETAll -: the function returns both the supported index values and the mnemonic strings in addition to the counts.

PEXlib allocates memory for the returned array of counts and for the return value array of enumerated type descriptors. Invoke the PEXFreeEnumInfo function to deallocate this memory. (SeeFreeing Memory Allocated by PEXlib functions.)

The following are the standard enumerated type index, mnemonic pairs which this function may return for each standard enumerated type.

Note: A convenience function is provided for determining if an alpha blend function is supported by the implementation, given a source blend factor and a destination blend factor pair. See PEXQueryAlphaBlend. The list of 42 enum type values listed below correspond directly to the entries in Alpha Blend Functions.

PEXETAlphaBlendFunction (entire enum type new for 5.2)

 

  PEXAlphaBlendNone                    PEXETMAlphaBlendNone
  PEXAlphaBlendSimple                  PEXETMAlphaBlendSimple
  PEXAlphaBlendFunction2               PEXETMAlphaBlendFunction2
  PEXAlphaBlendFunction3               PEXETMAlphaBlendFunction3
  PEXAlphaBlendFunction4               PEXETMAlphaBlendFunction4
  PEXAlphaBlendFunction5               PEXETMAlphaBlendFunction5
  PEXAlphaBlendFunction6               PEXETMAlphaBlendFunction6
  PEXAlphaBlendFunction7               PEXETMAlphaBlendFunction7
  PEXAlphaBlendFunction8               PEXETMAlphaBlendFunction8
  PEXAlphaBlendFunction9               PEXETMAlphaBlendFunction9
  PEXAlphaBlendFunction10              PEXETMAlphaBlendFunction10
  PEXAlphaBlendFunction11              PEXETMAlphaBlendFunction11
  PEXAlphaBlendFunction12              PEXETMAlphaBlendFunction12
  PEXAlphaBlendFunction13              PEXETMAlphaBlendFunction13
  PEXAlphaBlendFunction14              PEXETMAlphaBlendFunction14
  PEXAlphaBlendFunction15              PEXETMAlphaBlendFunction15
  PEXAlphaBlendFunction16              PEXETMAlphaBlendFunction16
  PEXAlphaBlendFunction17              PEXETMAlphaBlendFunction17
  PEXAlphaBlendFunction18              PEXETMAlphaBlendFunction18
  PEXAlphaBlendFunction19              PEXETMAlphaBlendFunction19
  PEXAlphaBlendFunction20              PEXETMAlphaBlendFunction20
  PEXAlphaBlendFunction21              PEXETMAlphaBlendFunction21
  PEXAlphaBlendFunction22              PEXETMAlphaBlendFunction22
  PEXAlphaBlendFunction23              PEXETMAlphaBlendFunction23
  PEXAlphaBlendFunction24              PEXETMAlphaBlendFunction24
  PEXAlphaBlendFunction25              PEXETMAlphaBlendFunction25
  PEXAlphaBlendFunction26              PEXETMAlphaBlendFunction26
  PEXAlphaBlendFunction27              PEXETMAlphaBlendFunction27
  PEXAlphaBlendFunction28              PEXETMAlphaBlendFunction28
  PEXAlphaBlendFunction29              PEXETMAlphaBlendFunction29
  PEXAlphaBlendFunction30              PEXETMAlphaBlendFunction30
  PEXAlphaBlendFunction31              PEXETMAlphaBlendFunction31
  PEXAlphaBlendFunction32              PEXETMAlphaBlendFunction32
  PEXAlphaBlendFunction33              PEXETMAlphaBlendFunction33
  PEXAlphaBlendFunction34              PEXETMAlphaBlendFunction34
  PEXAlphaBlendFunction35              PEXETMAlphaBlendFunction35
  PEXAlphaBlendFunction36              PEXETMAlphaBlendFunction36
  PEXAlphaBlendFunction37              PEXETMAlphaBlendFunction37
  PEXAlphaBlendFunction38              PEXETMAlphaBlendFunction38
  PEXAlphaBlendFunction39              PEXETMAlphaBlendFunction39
  PEXAlphaBlendFunction40              PEXETMAlphaBlendFunction40
  PEXAlphaBlendFunction41              PEXETMAlphaBlendFunction41

PEXETATextStyle

 

    PEXATextNotConnected               PEXETMATextNotConnected
    PEXATextConnected                  PEXETMATextConnected

PEXETColorApproxModel

 

     PEXColorApproxRGB                 PEXETMColorApproxRGB
     PEXColorApproxCIE                 PEXETMColorApproxCIE
     PEXColorApproxHSV                 PEXETMColorApproxHSV
     PEXColorApproxHLS                 PEXETMColorApproxHLS
     PEXColorApproxYIQ                 PEXETMColorApproxYIQ

PEXETColorApproxType

 

     PEXColorSpace                     PEXETMColorSpace
     PEXColorRange                     PEXETMColorRange

PEXETColorType

 

     PEXColorTypeIndexed               PEXETMColorTypeIndexed
     PEXColorTypeRGB                   PEXETMColorTypeRGB
     PEXColorTypeCIE                   PEXETMColorTypeCIE
     PEXColorTypeHSV                   PEXETMColorTypeHSV
     PEXColorTypeHLS                   PEXETMColorTypeHLS
     PEXColorTypeRGB8                  PEXETMColorTypeRGB8
     PEXColorTypeRGB16                 PEXETMColorTypeRGB16
     PEXColorTypeRGBA                  PEXETMColorTypeRGBA (new for 5.2)
     PEXColorTypeRGBA8                 PEXETMColorTypeRGBA8 (new for 5.2)
     PEXColorTypeRGBA16                PEXETMColorTypeRGBA16 (new for 5.2)

PEXETCurveApproxMethod

 

 
     PEXApproxImpDep                   implementation-dependent string
     PEXApproxConstantBetweenKnots     PEXETMApproxConstantBetweenKnots
     PEXApproxWCChordalSize            PEXETMApproxWCChordalSize
     PEXApproxNPCChordalSize           PEXETMApproxNPCChordalSize
     PEXApproxDCChordalSize            PEXETMApproxDCChordalSize
     PEXCurveApproxWCChordalDev        PEXETMCurveApproxWCChordalDev
     PEXCurveApproxNPCChordalDev       PEXETMCurveApproxNPCChordalDev
     PEXCurveApproxDCChordalDev        PEXETMCurveApproxDCChordalDev
     PEXApproxWCRelative               PEXETMApproxWCRelative
     PEXApproxNPCRelative              PEXETMApproxNPCRelative
     PEXApproxDCRelative               PEXETMApproxDCRelative

PEXETDataMapMethod (entire enum type new for 5.2)

 

     PEXDataMapNone                    PEXETMDataMapNone
     PEXDataMapColor                   PEXETMDataMapColor

PEXETDisplayUpdateMode

 

     PEXVisualizeEach                  PEXETMVisualizeEach
     PEXVisualizeEasy                  PEXETMVisualizeEasy
     PEXVisualizeNone                  PEXETMVisualizeNone
     PEXSimulateSome                   PEXETMSimulateSome
     PEXVisualizeWhenever              PEXETMVisualizeWhenever

PEXETEchoMethod (entire enum type new for 5.2)

 

     PEXEchoDestructiveColor           PEXETMEchoDestructiveColor
     PEXEchoNonDestructiveColor        PEXETMEchoNonDestructiveColor
     PEXEchoXORColor                   PEXETMEchoXORColor

PEXETEscape (entire enum type new for 5.1)

 

     PEXEscapeSetEchoColor             PEXETMEscapeSetEchoColor

PEXETFloatFormat

 

     PEXIEEE_754_32                    PEXETMIEEE_754_32
     PEXDEC_F_Floating                 PEXETMDEC_F_Floating
     PEXIEEE_754_64                    PEXETMIEEE_754_64
     PEXDEC_D_Floating                 PEXETMDEC_D_Floating

PEXETGDP2D

There are currently no standard 2D generalized drawing primitives.

PEXETGDP

There are currently no standard 3D generalized drawing primitives.

PEXETGSE

There are currently no standard generalized structure elements.

PEXETHatchStyle

 

     PEXHatchStyle45Degrees            PEXETMHatchStyle45Degrees (new for 5.2)
     PEXHatchStyle135Degrees           PEXETMHatchStyle135Degrees (new for 5.2)

PEXETHighlightMethod (entire enum type new for 5.2)

 

     PEXHighlightColor                 PEXETMHighlightColor

PEXETHLHSRIdentifier (entire enum type new for 5.2)

 

     PEXHLHSRIDDisable                 PEXETMHLHSRIDDisable
     PEXHLHSRIDEnable                  PEXETMHLHSRIDEnable
     PEXHLHSRIDEnableTestOnly          PEXETMHLHSRIDEnableTestOnly

PEXETHLHSRMode

 

     PEXHLHSROff                       PEXETMHLHSROff
     PEXHLHSRZBuffer                   PEXETMHLHSRZBuffer
     PEXHLHSRPainters                  PEXETMHLHSRPainters
     PEXHLHSRScanline                  PEXETMHLHSRScanline
     PEXHLHSRHiddenLineOnly            PEXETMHLHSRHiddenLineOnly
     PEXHLHSRZBufferID                 PEXETMHLHSRZBufferID

PEXETInteriorStyle

 

     PEXInteriorStyleHollow            PEXETMInteriorStyleHollow
     PEXInteriorStyleSolid             PEXETMInteriorStyleSolid
     PEXInteriorStylePattern           PEXETMInteriorStylePattern
     PEXInteriorStyleHatch             PEXETMInteriorStyleHatch
     PEXInteriorStyleEmpty             PEXETMInteriorStyleEmpty
     PEXInteriorStyleTexture           PEXETMInteriorStyleTexture (new for 5.2)

PEXETLightType

 

     PEXLightAmbient                   PEXETMLightAmbient
     PEXLightWCVector                  PEXETMLightWCVector
     PEXLightWCPoint                   PEXETMLightWCPoint
     PEXLightWCSpot                    PEXETMLightWCSpot

PEXETLineCapStyle (entire enum type new for 5.2)

 

     PEXLineCapButt                    PEXETMLineCapButt
     PEXLineCapRound                   PEXETMLineCapRound
     PEXLineCapProject                 PEXETMLineCapProject

PEXETLineJoinStyle (entire enum type new for 5.2)

 

     PEXLineJoinImpDep                 implementation-dependent string
     PEXLineJoinRound                  PEXETMLineJoinRound
     PEXLineJoinMiter                  PEXETMLineJoinMiter
     PEXLineJoinBevel                  PEXETMLineJoinBevel

PEXETLineType

 

     PEXLineTypeSolid                  PEXETMLineTypeSolid
     PEXLineTypeDashed                 PEXETMLineTypeDashed
     PEXLineTypeDotted                 PEXETMLineTypeDotted
     PEXLineTypeDashDot                PEXETMLineTypeDashDot
     PEXLineTypeCenterLine             PEXETMLineTypeCenterLine (new for 5.2)
     PEXLineTypePhantom                PEXETMLineTypePhantom (new for 5.2)

PEXETMarkerGlyphType (entire enum type new for 5.2)

 

     PEXMarkerGlyphStroke              PEXETMMarkerGlyphStroke

PEXETMarkerType

 

     PEXMarkerDot                      PEXETMMarkerDot
     PEXMarkerCross                    PEXETMMarkerCross
     PEXMarkerAsterisk                 PEXETMMarkerAsterisk
     PEXMarkerCircle                   PEXETMMarkerCircle
     PEXMarkerX                        PEXETMMarkerX

PEXETModelClipOperator

 

     PEXModelClipReplace               PEXETMModelClipReplace
     PEXModelClipIntersection          PEXETMModelClipIntersection

PEXETParaSurfCharacteristics

 

     PEXPSCNone                        PEXETMPSCNone
     PEXPSCImpDep                      implementation-dependent string
     PEXPSCIsoCurves                   PEXETMPSCIsoCurves
     PEXPSCMCLevelCurves               PEXETMPSCMCLevelCurves
     PEXPSCWCLevelCurves               PEXETMPSCWCLevelCurves

PEXETPickAllMethod (entire enum type new for 5.1)

 

     PEXPickAllAll                     PEXETMPickAllAll
     PEXPickAllVisible                 PEXETMPickAllVisible

PEXETPickDeviceType

 

     PEXPickDeviceDCHitBox             PEXETMPickDeviceDCHitBox
     PEXPickDeviceNPCHitVolume         PEXETMPickDeviceNPCHitVolume

PEXETPickOneMethod (entire enum type new for 5.1)

 

     PEXPickLast                       PEXETMPickLast
     PEXPickClosestZ                   PEXETMPickClosestZ
     PEXPickVisibleAny                 PEXETMPickVisibleAny
     PEXPickVisibleClosest             PEXETMPickVisibleClosest

PEXETPolylineInterpMethod

 

     PEXPolylineInterpNone             PEXETMPolylineInterpNone
     PEXPolylineInterpColor            PEXETMPolylineInterpColor

PEXETPrimitiveAABlendFunction (entire enum type new for 5.2)

 

 
     PEXPrimitiveAABlendImpDep         PEXETMPrimitiveAABlendImpDep
     PEXPrimitiveAABlendSimpleAlpha    PEXETMPrimitiveAABlendSimpleAlpha

PEXETPromptEchoType

 

     PEXEchoPrimitive                  PEXETMEchoPrimitive               

     PEXEchoStructure                  PEXETMEchoStructure
     PEXEchoNetwork                    PEXETMEchoNetwork

PEXETReflectionModel

The first four index/mnemonic pairs have the same values and meaning as the last four. The first four are compatible with the PEXlib 5.1 specification, but are also available in PEXlib 5.2 for compatibility with existing PEXlib 5.1 applications. Use the last four in PEXlib 5.2 and later applications.

 

     PEXReflectionNone                 PEXETMReflectionNone
     PEXReflectionAmbient              PEXETMReflectionAmbient
     PEXReflectionDiffuse              PEXETMReflectionDiffuse
     PEXReflectionSpecular             PEXETMReflectionSpecular
 
 
     PEXRMNone                         PEXETMRMNone (new for 5.2)
     PEXRMAmbient                      PEXETMRMAmbient (new for 5.2)
     PEXRMAmbientDiffuse               PEXETMRMAmbientDiffuse (new for 5.2)
     PEXRMAmbientDiffuseSpecular       PEXETMRMAmbientDiffuseSpecular (new for 5.2)

PEXETRenderingColorModel

 

     PEXRenderingColorModelImpDep      implementation-dependent string
     PEXRenderingColorModelRGB         PEXETMRenderingColorModelRGB
     PEXRenderingColorModelCIE         PEXETMRenderingColorModelCIE
     PEXRenderingColorModelHSV         PEXETMRenderingColorModelHSV
     PEXRenderingColorModelHLS         PEXETMRenderingColorModelHLS

PEXETSupportedTexelResources (entire enum type new for 5.2)

 

     PEXTexelResourcesWindow           PEXETMTexelResourcesWindow
     PEXTexelResourcesPixmap           PEXETMTexelResourcesPixmap
     PEXTexelResourcesBuffer           PEXETMTexelResourcesBuffer
     PEXTexelResourcesPhotomap         PEXETMTexelResourcesPhotomap

PEXETSurfaceApproxMethod

 

     PEXApproxImpDep                   implementation-dependent string
     PEXApproxConstantBetweenKnots     PEXETMApproxConstantBetweenKnots
     PEXApproxWCChordalSize            PEXETMApproxWCChordalSize
     PEXApproxNPCChordalSize           PEXETMApproxNPCChordalSize
     PEXApproxDCChordalSize            PEXETMApproxDCChordalSize
     PEXSurfaceApproxWCPlanarDev       PEXETMSurfaceApproxWCPlanarDev
     PEXSurfaceApproxNPCPlanarDev      PEXETMSurfaceApproxNPCPlanarDev
     PEXSurfaceApproxDCPlanarDev       PEXETMSurfaceApproxDCPlanarDev
     PEXApproxWCRelative               PEXETMApproxWCRelative
     PEXApproxNPCRelative              PEXETMApproxNPCRelative
     PEXApproxDCRelative               PEXETMApproxDCRelative

PEXETSurfaceEdgeType

 

     PEXSurfaceEdgeSolid               PEXETMSurfaceEdgeSolid
     PEXSurfaceEdgeDashed              PEXETMSurfaceEdgeDashed
     PEXSurfaceEdgeDotted              PEXETMSurfaceEdgeDotted
     PEXSurfaceEdgeDashDot             PEXETMSurfaceEdgeDashDot

PEXETSurfaceInterpMethod

 

     PEXSurfaceInterpNone              PEXETMSurfaceInterpNone
     PEXSurfaceInterpColor             PEXETMSurfaceInterpColor
     PEXSurfaceInterpDotProduct        PEXETMSurfaceInterpDotProduct
     PEXSurfaceInterpNormal            PEXETMSurfaceInterpNormal

PEXETTMBoundaryClampMethod (entire enum type new for 5.2)

 

     PEXTMBoundaryClampExplicitDiscontinue  PEXETMTMBoundaryClampExplicitDiscontinue
     PEXTMBoundaryClampExplicitColor        PEXETMTMBoundaryClampExplicitColor

PEXETTMBoundaryCondition (entire enum type new for 5.2)

 

     PEXTMBoundaryClampExplicit          PEXETMTMBoundaryClampExplicit
     PEXTMBoundaryClampBorder            PEXETMTMBoundaryClampBorder
     PEXTMBoundaryWrap                   PEXETMTMBoundaryWrap
     PEXTMBoundaryMirror                 PEXETMTMBoundaryMirror

PEXETTMCompositionMethod (entire enum type new for 5.2)

 

     PEXTMCompReplace                     PEXETMTMCompReplace
     PEXTMCompModulate                    PEXETMTMCompModulate
     PEXTMCompBlendEnvColor               PEXETMTMCompBlendEnvColor
     PEXTMCompDecal                       PEXETMTMCompDecal
     PEXTMCompDecalBackground             PEXETMTMCompDecalBackground

PEXETTMDimension (entire enum type new for 5.2)

 

     PEXTMDimension1D                     PEXETMTMDimension1D
     PEXTMDimension2D                     PEXETMTMDimension2D
     PEXTMDimension3D                     PEXETMTMDimension3D

PEXETTMParameterizationMethod (entire enum type new for 5.2)

 

     PEXTMParamVertexMCCoord              PEXETMTMParamVertexMCCoord
     PEXTMParamVertexWCCoord              PEXETMTMParamVertexWCCoord
     PEXTMParamVertexMCNormal             PEXETMTMParamVertexMCNormal
     PEXTMParamVertexWCNormal             PEXETMTMParamVertexWCNormal
     PEXTMParamNURBUV                     PEXETMTMParamNURBUV
     PEXTMParamFloatData                  PEXETMTMParamFloatData
     PEXTMParamReflectionSphereVRC        PEXETMTMParamReflectionSphereVRC
     PEXTMParamReflectionSphereWC         PEXETMTMParamReflectionSphereWC

PEXETTMPerspectiveCorrection (entire enum type new for 5.2)

 

     PEXTMPerspectiveCorrectionNone       PEXETMTMPerspectiveCorrectionNone
     PEXTMPerspectiveCorrectionVertex     PEXETMTMPerspectiveCorrectionVertex
     PEXTMPerspectiveCorrectionPixel      PEXETMTMPerspectiveCorrectionPixel

PEXETTMRenderingControl (entire enum type new for 5.2)

 

     PEXTMRenderingControlPreLight        PEXETMTMRenderingControlPreLight
     PEXTMRenderingControlPostLight       PEXETMTMRenderingControlPostLight

PEXETTMResourceHints (entire enum type new for 5.2)

 

     PEXTMResourceHintsNone               PEXETMResourceHintsNone
     PEXTMResourceHintsSpeed              PEXETMResourceHintsSpeed
     PEXTMResourceHintsSpace              PEXETMResourceHintsSpace

PEXETTMSampleFrequency (entire enum type new for 5.2)

 

     PEXTMSampleFrequencyPixel            PEXETMTMSampleFrequencyPixel
     PEXTMSampleFrequencyInterpDep        PEXETMTMSampleFrequencyInterpDep

PEXETTMSampleMethod (entire enum type new for 5.2)

 

     PEXTMSampleSingleBase                PEXETMTMSampleSingleBase
     PEXTMSampleWeightedBase              PEXETMTMSampleWeightedBase
     PEXTMSampleSingleInMipmap            PEXETMTMSampleSingleInMipmap
     PEXTMSampleWeightedInMipmap          PEXETMTMSampleWeightedInMipmap
     PEXTMSampleSingleBetweenMipmaps      PEXETMTMSampleSingleBetweenMipmaps
     PEXTMSampleWeightedBetweenMipmaps    PEXETMTMSampleWeightedBetweenMipmaps

PEXETTMTexelType (entire enum type new for 5.2)

 

     PEXTMTexelTypeLum                    PEXETMTMTexelTypeLum
     PEXTMTexelTypeLum8                   PEXETMTMTexelTypeLum8
     PEXTMTexelTypeLum16                  PEXETMTMTexelTypeLum16
     PEXTMTexelTypeLumA                   PEXETMTMTexelTypeLumA
     PEXTMTexelTypeLumA8                  PEXETMTMTexel                 TypeLumA8

     PEXTMTexelTypeLumA16                 PEXETMTMTexelTypeLumA16
     PEXTMTexelTypeRGB                    PEXETMTMTexelTypeRGB
     PEXTMTexelTypeRGB8                   PEXETMTMTexelTypeRGB8
     PEXTMTexelTypeRGB16                  PEXETMTMTexelTypeRGB16
     PEXTMTexelTypeRGBA                   PEXETMTMTexelTypeRGBA
     PEXTMTexelTypeRGBA8                  PEXETMTMTexelTypeRGBA8
     PEXTMTexelTypeRGBA6                  PEXETMTMTexelTypeRGBA16

PEXETTransparencyMethod (entire enum type new for 5.2)

 

     PEXTransparencyNone                  PEXETMTransparencyNone
     PEXTransparencyScreenDoor            PEXETMTransparencyScreenDoor
     PEXTransparencyAlphaBlend            PEXETMTransparencyAlphaBlend
     PEXTransparencyTwoPass               PEXETMTransparencyTwoPass
     PEXTransparencyMultipass             PEXETMTransparencyMultipass

PEXETTrimCurveApproxMethod

 

     PEXApproxImpDep                      implementation-dependent string
     PEXApproxConstantBetweenKnots        PEXETMApproxConstantBetweenKnots

PEXETZBufferTest (entire enum type new for 5.2)

 

     PEXZBufferTestLessThan               PEXETMZBufferTestLessThan
     PEXZBufferTestLessThanOrEqual        PEXETMZBufferTestLessThanOrEqual
     PEXZBufferTestGreaterThan            PEXETMZBufferTestGreaterThan
     PEXZBufferTestGreaterThanOrEqual     PEXETMZBufferTestGreaterThanOrEqual
     PEXZBufferTestEqual                  PEXETMZBufferTestEqual
     PEXZBufferTestNotEqual               PEXETMZBufferTestNotEqual
     PEXZBufferTestPass                   PEXETMZBufferTestPass

Errors