DrvTransparentBlt (Compact 2013)

3/26/2014

This function provides bit-block transfer capabilities with transparency.

Syntax

BOOL DrvTransparentBlt(
  SURFOBJ* psoDst,
  SURFOBJ* psoSrc,
  CLIPOBJ* pco,
  XLATEOBJ* pxlo,
  RECTL* prclDst,
  RECTL* prclSrc,
  ULONG iTransColor 
);

Parameters

• psoDst
  [in] Pointer to the SURFOBJ that identifies the target surface on which to draw.

• psoSrc
  [in] Pointer to the SURFOBJ that identifies the source surface of the bit-block transfer.

• pco
  [in] Pointer to a CLIPOBJ structure. The CLIPOBJ_XXX functions enumerate the clip region as a set of rectangles. This enumeration limits the area of the destination that is modified. Whenever possible, GDI simplifies the clipping involved.

• pxlo
  [in] Pointer to a XLATEOBJ structure that tells how the source color indices should be translated for writing to the target surface. If pxlo is NULL, no translation is needed.

• prclDst
  [in] Pointer to a RECTL structure that defines the rectangular area modify. The destination surface's coordinate system describes this rectangle with an upper left point and a lower right point. The rectangle is lower-right exclusive; that is, its lower and right edges are not a part of the bit-block transfer. The two points that define the rectangle are always in correct order.

  DrvTransparentBlt is never called with an empty destination rectangle.

• prclSrc
  [in] Pointer to a RECTL structure that defines the rectangular area to be copied. The destination surface's coordinate system describes this rectangle with an upper left point and a lower right point. The two points that define the rectangle are always well ordered.

  The source rectangle will never exceed the bounds of the source surface, and so will never overhang the source surface.

  This rectangle is mapped to the destination rectangle defined by prclDst. DrvTransparentBlt is never called with an empty source rectangle.

• iTransColor
  [in] Physical transparent color in the source surface format. For devices with palettes, this value is a palette index. For devices without palettes, this value is an RGB in the format that is used in the source surface. For example, if the source surface format is in 5:6:5 RGB form, the value in this parameter will be in the same form.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

Any pixels on the source surface that match the transparent color specified by iTransColor are not copied.

The driver will never be called with overlapping source and destination rectangles on the same surface.

The driver should ignore any unused bits in the color key comparison, such as for the most significant bit when the bitmap format is 5:5:5, five bits each of red, green, and blue.

Requirements

See Also

Reference

Display Driver Functions
DrvBitBlt
XLATEOBJ