[Overview][Constants][Types][Classes][Index] Reference for unit 'ptc' (#ptc)

TPTCClear.Clear

Clears an area of pixels to a specified color.

Declaration

Source position: cleard.inc line 42

public procedure TPTCClear.Clear(

  APixels: Pointer;

  AX: Integer;

  AY: Integer;

  AWidth: Integer;

  AHeight: Integer;

  APitch: Integer;

  AColor: IPTCColor

);

Arguments

APixels

  

The pixel array.

AX

  

The x coordinate of the top-left corner of the clear area.

AY

  

The y coordinate of the top-left corner of the clear area.

AWidth

  

The width of the clear area in pixels.

AHeight

  

The height of the clear area in pixels.

APitch

  

The pitch of the pixel array in bytes.

AColor

  

The clear color.

Description

Clear an area of the pixel array pixels to the specified color color.

Warning: You must first call TPTCClear.Request to initialize the pixel format.

Errors

TPTCError - a TPTCError exception is raised on failure.