User Tools

Site Tools


api:dk11:delphi:gistypesui.tgis_bitmapabstract.lockpixels_tgis_pixels_boolean_tgis_bitmapformat_tgis_bitmaplinesorder

Table of Contents

TGIS_BitmapAbstract.LockPixels method

DK for Delphi | GisTypesUI.TGIS_BitmapAbstract.LockPixels | Fields | Methods | Properties

Prepare the bitmap for direct pixel access.

Available also on: .NET | Java | Python.

Syntax

// Delphi
public
  procedure LockPixels(
    var _pixels : TGIS_Pixels;
    const _writable : Boolean;
    const _format : TGIS_BitmapFormat;
    const _order : TGIS_BitmapLinesOrder
  ); virtual; abstract;
// C++ Builder
public:
  virtual void LockPixels(
    TGIS_Pixels* &_pixels,
    const bool _writable,
    TGIS_BitmapFormat* const _format,
    TGIS_BitmapLinesOrder* const _order
  ) = 0;

Parameters

Name Type Description
_pixels TGIS_Pixels pixel buffer allocated and maintained between LockPixels and UnlockPixels
_writable Boolean True if the caller will modify pixel values
_format TGIS_BitmapFormat desired bitmap format of locked pixels; some platform operations require a format different from the native default
_order TGIS_BitmapLinesOrder desired bitmap lines order of locked pixels; some platform operations require an order different from the native default

Remarks

Must be paired with UnlockPixels.

2026/07/11 00:44

Page Tools