XLATEOBJ_cGetPalette, fonction (winddi.h)

La fonction XLATEOBJ_cGetPalette récupère les couleurs RVB ou le format des champs de bits à partir de la palette spécifiée.

Syntaxe

ENGAPI ULONG XLATEOBJ_cGetPalette(
       XLATEOBJ *pxlo,
  [in] ULONG    iPal,
       ULONG    cPal,
       ULONG    *pPal
);

Paramètres

pxlo

Pointeur vers la structure XLATEOBJ à partir de laquelle GDI récupère les informations demandées.

[in] iPal

Identifie les informations de palette à écrire. Ce paramètre peut être l’une des valeurs suivantes :

cPal

Spécifie le nombre d’entrées dans la mémoire tampon pointée par pPal. Elle peut être inférieure à la taille totale de la palette.

pPal

Pointeur vers une mémoire tampon dans laquelle GDI écrit les informations de palette demandées. Si iPal est XO_SRCPALETTE ou XO_DESTPALETTE et que le type de palette respectif est PAL_INDEXED, chaque entrée est une valeur RVB 24 bits.

Si iPal est XO_SRCBITFIELDS ou XO_DESTBITFIELDS et que le type de palette respectif est PAL_BITFIELDS, PAL_RGB ou PAL_BGR, pPal pointe vers trois masques ULONG qui représentent les masques de couleur rouge, vert et bleu.

Valeur retournée

XLATEOBJ_cGetPalette retourne le nombre d’entrées écrites si pPal n’est pas null. La valeur zéro est retournée si le XLATEOBJ a la valeur Null ou si sa palette n’est pas valide. XLATEOBJ_cGetPalette retourne également zéro si les données pointées par pxlo ne sont pas cohérentes avec la valeur dans iPal. Par exemple, si les données pointées sont un champ de bits, mais que iPal est défini sur XO_SRCPALETTE ou XO_DESTPALETTE, XLATEOBJ_cGetPalette retourne zéro. De même, si les données pointées par pxlo sont une palette, mais que iPal est défini sur XO_SRCBITFIELDS ou XO_DESTBITFIELDS, XLATEOBJ_cGetPalette retourne également zéro.

Remarques

Le pilote doit avoir des informations sur la palette pour effectuer certaines méthodes de fusion de couleurs.

Configuration requise

Voir aussi

XLATEOBJ