User Tools

Site Tools


api:dk11:delphi:gislayerpixel.tgis_layerpixel.lockpixels_trect_integer_boolean

TGIS_LayerPixel.LockPixels(TRect; Integer; Boolean) method

DK11 for Delphi | GisLayerPixel.TGIS_LayerPixel.LockPixels | Overloads | Constructors | Fields | Methods | Properties | Events

Locks a fragment of the pixel layer for updating.

Available also on: .NET | Java | ActiveX | Python.

Syntax

// Delphi
public
  function LockPixels(
    const _rct : TRect;
    const _band : Integer;
    const _writable : Boolean
  ) : TGIS_LayerPixelLock; overload; virtual;
// C++ Builder
public:
  virtual TGIS_LayerPixelLock* LockPixels(
    TRect* const _rct,
    const int _band,
    const bool _writable
  ) /* overload */;

Parameters

Name Type Description
_rct TRect rectangle on raster to be locked; if bigger then raster size then will be truncated
_band Integer specific band to be locked
_writable Boolean if true than layer will post back any changes in locked area; if write is not possible then TGIS_LayerPixelLock.Writable will be set accordingly

Result

Type Description
TGIS_LayerPixelLock locked area

Remarks

Must be paired with UnlockPixels.

To speed-up operation, the function can return a larger area than requested. Use Bounds property of result value to obtain actual scope.

References

2023/02/22 01:15

Page Tools