S3DTK_BitBltTransparent

Copy a rectangular area from one surface to another with color keying.

Method of:

Syntax:

S3DTK_BitBltTransparent: function(
  pFuncStruct: Pointer;
  pDestSurface: TS3DTK_LPSURFACE;
  pDestRect: TS3DTK_LPRECTAREA;
  pSrcSurface: TS3DTK_LPSURFACE;
  pSrcRect: TS3DTK_LPRECTAREA;
  TransparentColor: ULONG): ULONG; cdecl;

Parameters:

• pFuncStruct - Pointer to the TS3DTK_FUNCTION_LIST that contains this method.
• pDestSurface - Pointer to a TS3DTK_SURFACE for the destination surface. The destination surface must be in video memory.
• pDestRect - Pointer to a TS3DTK_RECTAREA for the area in the destination surface to write to.
• pSrcSurface - Pointer to a TS3DTK_SURFACE for the source surface.
• pSrcRect - Pointer to a TS3DTK_RECTAREA for the area in the source surface to copy from.
• TransparentColor - The color key that marks the transparent pixels.

Returns:

S3DTK_OK if successful, S3DTK_ERR otherwise.

Description:

This works similarly to S3DTK_BitBlt but it also performs color keying against the specified color. The value depends on the format of the surface - for 8bit surfaces this is the index of the palette color whereas for 15bit surfaces this is the value to check for (only the lower 15 bits are taken into account).

Limitations:

Both surfaces must have the same pixel format and size. Also the destination surface must be in video memory. This only supports S3DTK_VIDEORGB8 and S3DTK_VIDEORGB15 formats. Other formats are not supported.

Unit: S3DTK

See Also:

S3DTK_BitBlt (in TS3DTK_FUNCTION_LIST)