User Tools

Site Tools


api:dk11:net:tatukgis.ndk.tgis_layerpixel.lockpixels_trect_boolean

TGIS_LayerPixel.LockPixels(TRect, bool) method

DK11 for .NET | TatukGIS.NDK.TGIS_LayerPixel.LockPixels | Overloads | Constructors | Fields | Methods | Properties | Events

Locks a fragment of the pixel layer for updating.

Available also on: Delphi | Java | ActiveX.

Syntax

// C#
public virtual TGIS_LayerPixelLock LockPixels(
  TRect _rct,
  bool _writable
);
' VisualBasic
Public Overridable Function LockPixels(
  ByVal _rct As TRect,
  ByVal _writable As Boolean
) As TGIS_LayerPixelLock
// Oxygene
public
  function LockPixels(
    _rct : TRect;
    _writable : Boolean
  ) : TGIS_LayerPixelLock; virtual;

Parameters

Name Type Description
_rct TRect rectangle on raster to be locked; if bigger then raster size then will be truncated
_writable bool
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

2021/12/07 09:02

Page Tools