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

IPTCSurface.Clip

Sets or gets the surface clip area.

Declaration

Source position: line 0

procedure IPTCSurface.Clip(

  AArea: IPTCArea

);

function IPTCSurface.Clip: IPTCArea;

Arguments

AArea

  

The clip area.

Function result

The surface palette object.

Description

The procedure sets the surface clip area to the area specified by the AArea parameter. Before the clip area is set it is clipped against the surface area (0, 0, Width, Height). This ensures that the clip area is always contained within the boundaries of the surface.

The function gets the clip area of the surface. The surface clip area is used during clipping areas to the surface. The clip area is initially set to (0, 0, Width, Height).

Errors

TPTCError - a TPTCError exception is raised on failure.