XLATEOBJ (Compact 2013)

3/26/2014

This structure is used to translate color indexes from one palette to another.

Syntax

typedef struct _XLATEOBJ {
  ULONG iUniq;
  FLONG flXlate;
  USHORT iSrcType;
  USHORT iDstType;
  ULONG cEntries;
  ULONG* pulXlate;
} XLATEOBJ;

Members

  • iUniq
    A cache identifier that enables the driver to recognize an XLATEOBJ structure that it has previously cached. If this member is zero, the driver should not cache the XLATEOBJ structure.
  • flXlate
    Flags specifying hints about the translation. This member can be any combination of flags shown in the following table.

    Flag

    Description

    XO_TABLE

    A table is provided to translate source indices to target indices.

    XO_TO_MONO

    Source indices are translated to a monochrome format with the special property that all indices map to zero, except for one. A driver can use this to accelerate a block transfer.

    XO_TRIVIAL

    Source indices are usable as target indices.

    XO_DEVICE_ICM

    Not supported.

    XO_FROM_CMYK

    Not supported.

    XO_HOST_ICM

    Not supported.

  • cEntries
    Specifies the number of entries in the array pointed to by the pulXlate member. Indexing into pulXlate with a value greater than cEntries results in a memory access violation.
  • pulXlate
    Pointer to an array of translation entries.

Remarks

The destination palette always belongs to the destination surface of some drawing operation. The source palette is an application-selected palette or a palette from another surface.

The XLATEOBJ structure is used to translate color indices that refer to the source palette to indices for the destination palette. The resulting index identifies a color that matches the source color as closely as possible.

Requirements

Header

winddi.h

See Also

Reference

Display Driver Structures