Class TGrayscaleMask

Description

Hierarchy

Fields

Methods

Properties

Unit

BGRAGrayscaleMask

Declaration

type TGrayscaleMask = class(specialize TGenericUniversalBitmap<TByteMask,TByteMaskColorspace>)

Description

8-bit grayscale image.

Example on applying a grayscale mask:

A red triangle is masked using an ellipse shape. mask_poly

uses BGRABitmap, BGRABitmapTypes, BGRAGrayscaleMask;

procedure TForm1.FormPaint(Sender: TObject);
var tmp, layer: TBGRABitmap;
    mask: TGrayscaleMask;
    poly : ArrayOfTPointF;
begin
  layer := TBGRABitmap.Create(clientwidth, clientheight, BGRAPixelTransparent);
  setLength(Poly,3);
  poly[0] := PointF(10, 10);
  Poly[1] := PointF(layer.width-10, 10);
  Poly[2] := PointF(10, layer.height-10);
  layer.DrawPolygonAntialias(poly, cssBlack, 3, cssRed);

  mask := TGrayscaleMask.Create(clientwidth, clientheight, TByteMask.New(0));
  mask.FillEllipseAntialias(mask.Width/2-0.5, mask.Height/2-0.5,
                            mask.Width/2, mask.Height/2, TByteMask.New(255));
  layer.ApplyMask(mask);
  mask.Free;

  tmp := TBGRABitmap.create (clientwidth, clientheight, cssWhite);
  tmp.PutImage(0,0, layer, dmDrawWithTransparency);
  tmp.Draw (canvas,0,0);
  tmp.free;
end;

Hierarchy

TFPCustomImage
TCustomUniversalBitmap
TGenericUniversalBitmap
TGrayscaleMask

Overview

Fields

ScanInterpolationFilter: TResampleFilter;

Methods

	`constructor Create(AWidth,AHeight: Integer; AValue: byte); overload;`
	`constructor Create(ABitmap: TBGRACustomBitmap; AChannel: TChannel); overload;`
	`constructor CreateDownSample(ABitmap: TGrayscaleMask; AWidth,AHeight: integer);`
	`constructor CreateDownSample(ABitmap: TBGRACustomBitmap; AWidth,AHeight: integer);`
	`constructor CreateDownSample(ABitmap: TGrayscaleMask; AWidth,AHeight: integer; ASourceRect: TRect);`
	`constructor CreateDownSample(ABitmap: TBGRACustomBitmap; AWidth,AHeight: integer; ASourceRect: TRect);`
	`function CreateBrushTexture(ABrushStyle: TBrushStyle; APatternColor, ABackgroundColor: TByteMask; AWidth: integer = 8; AHeight: integer = 8; APenWidth: single = 1): TGrayscaleMask; override;`
	`function Duplicate(DuplicateProperties: Boolean = False): TGrayscaleMask; overload; override;`
	`function FilterBlurMotion(distance: single; angle: single; oriented: boolean; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterBlurMotion(const ABounds: TRect; distance: single; angle: single; oriented: boolean; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterBlurRadial(radiusX, radiusY: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterBlurRadial(const ABounds: TRect; radius: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterBlurRadial(radius: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterBlurRadial(const ABounds: TRect; radiusX, radiusY: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterContour(ABorderValue: byte = 0): TGrayscaleMask;`
	`function FilterCustomBlur(mask: TCustomUniversalBitmap; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterCustomBlur(const ABounds: TRect; mask: TCustomUniversalBitmap; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
	`function FilterCylinder: TGrayscaleMask;`
	`function FilterSphere: TGrayscaleMask;`
	`function GetImageBounds: TRect; overload; override;`
	`function GetImageBoundsWithin(const ARect: TRect; Channels: TChannels; ANothingValue: Byte = 0): TRect; overload; override;`
	`function GetImageBoundsWithin(const ARect: TRect; Channel: TChannel = cAlpha; ANothingValue: Byte = 0): TRect; overload; override;`
	`function GetPart(const ARect: TRect; CopyProperties: Boolean=False): TGrayscaleMask; override;`
	`function GetPixel(X,Y: integer): byte; overload;`
	`function GetPixel(x, y: single; AResampleFilter: TResampleFilter = rfLinear; smoothBorder: boolean = true): TByteMask; overload;`
	`function GetPixel256(x, y, fracX256,fracY256: int32or64; AResampleFilter: TResampleFilter = rfLinear; smoothBorder: boolean = true): TByteMask;`
	`function GetUnique: TGrayscaleMask; override;`
	`function NewBitmap(AWidth, AHeight: integer; const Color: TByteMask): TGrayscaleMask; overload; override;`
	`function NewBitmap(AWidth, AHeight: integer; AColor: Pointer): TGrayscaleMask; overload; override;`
	`function NewBitmap: TGrayscaleMask; overload; override;`
	`function NewBitmap(AWidth, AHeight: integer): TGrayscaleMask; overload; override;`
	`function NewReference: TGrayscaleMask; override;`
	`function RotateCCW(ACopyProperties: Boolean=False): TGrayscaleMask; override;`
	`function RotateCW(ACopyProperties: Boolean=False): TGrayscaleMask; override;`
	`function RotateUD(ACopyProperties: Boolean=False): TGrayscaleMask; override;`
	`function ScanAt(X, Y: Single): TBGRAPixel; override;`
	`function ScanAtInteger(X, Y: integer): TBGRAPixel; override;`
	`function ScanAtIntegerMask(X,Y: integer): TByteMask; override;`
	`function ScanAtMask(X,Y: Single): TByteMask; override;`
	`function InternalGetPixel256(ix,iy: int32or64; iFactX,iFactY: int32or64; smoothBorder: boolean): TByteMask;`
	`function InternalGetPixelCycle256(ix,iy: int32or64; iFactX,iFactY: int32or64): TByteMask;`
	`function InternalNew: TCustomUniversalBitmap; override;`
	`class procedure AlphaBrush(out ABrush: TUniversalBrush; AAlpha: Word); override;`
	`procedure CopyFrom(ABitmap: TBGRACustomBitmap; AChannel: TChannel); overload;`
	`procedure CopyFrom(ABitmap: TGrayscaleMask); overload;`
	`procedure CopyPropertiesTo(ABitmap: TCustomUniversalBitmap); override;`
	`procedure Draw(ABitmap: TBGRACustomBitmap; X,Y: Integer; AGammaCorrection: boolean = false);`
	`procedure DrawAsAlpha(ABitmap: TBGRACustomBitmap; X,Y: Integer; texture: IBGRAScanner); overload;`
	`procedure DrawAsAlpha(ABitmap: TBGRACustomBitmap; X,Y: Integer; const c: TBGRAPixel); overload;`
	`class procedure EraseBrush(out ABrush: TUniversalBrush; AAlpha: Word); override;`
	`procedure InplaceNormalize(ABounds: TRect); overload;`
	`procedure InplaceNormalize; overload;`
	`class procedure MaskBrush(out ABrush: TUniversalBrush; AScanner: IBGRAScanner; AOffsetX: integer = 0; AOffsetY: integer = 0); override;`
	`procedure Negative;`
	`procedure NegativeRect(ABounds: TRect);`
	`class procedure ScannerBrush(out ABrush: TUniversalBrush; AScanner: IBGRAScanner; ADrawMode: TDrawMode = dmDrawWithTransparency; AOffsetX: integer = 0; AOffsetY: integer = 0); override;`
	`procedure ScanNextMaskChunk(var ACount: integer; out AMask: PByteMask; out AStride: integer); override;`
	`procedure SetPixel(X,Y: integer; AValue: byte);`
	`class procedure SolidBrush(out ABrush: TUniversalBrush; const AColor: TByteMask; ADrawMode: TDrawMode = dmDrawWithTransparency); override;`
	`procedure AssignTransparentPixel(out ADest); override;`
	`procedure Init; override;`

Properties

	`property Data: PByte read FDataByte;`
	`property ScanLine[Y: Integer]: PByte read GetScanLine;`

Description

Fields

	`ScanInterpolationFilter: TResampleFilter;`
This item has no description.

Methods

	`constructor Create(AWidth,AHeight: Integer; AValue: byte); overload;`
This item has no description.

	`constructor Create(ABitmap: TBGRACustomBitmap; AChannel: TChannel); overload;`
This item has no description.

	`constructor CreateDownSample(ABitmap: TGrayscaleMask; AWidth,AHeight: integer);`
This item has no description.

	`constructor CreateDownSample(ABitmap: TBGRACustomBitmap; AWidth,AHeight: integer);`
This item has no description.

	`constructor CreateDownSample(ABitmap: TGrayscaleMask; AWidth,AHeight: integer; ASourceRect: TRect);`
This item has no description.

	`constructor CreateDownSample(ABitmap: TBGRACustomBitmap; AWidth,AHeight: integer; ASourceRect: TRect);`
This item has no description.

	`function CreateBrushTexture(ABrushStyle: TBrushStyle; APatternColor, ABackgroundColor: TByteMask; AWidth: integer = 8; AHeight: integer = 8; APenWidth: single = 1): TGrayscaleMask; override;`
This item has no description.

	`function Duplicate(DuplicateProperties: Boolean = False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterBlurMotion(distance: single; angle: single; oriented: boolean; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterBlurMotion(const ABounds: TRect; distance: single; angle: single; oriented: boolean; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterBlurRadial(radiusX, radiusY: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterBlurRadial(const ABounds: TRect; radius: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

function FilterBlurRadial(radius: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.FilterBlurRadial.

filters

	`function FilterBlurRadial(const ABounds: TRect; radiusX, radiusY: single; blurType: TRadialBlurType; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterContour(ABorderValue: byte = 0): TGrayscaleMask;`
This item has no description.

	`function FilterCustomBlur(mask: TCustomUniversalBitmap; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterCustomBlur(const ABounds: TRect; mask: TCustomUniversalBitmap; ACopyProperties: Boolean=False): TGrayscaleMask; overload; override;`
This item has no description.

	`function FilterCylinder: TGrayscaleMask;`
This item has no description.

	`function FilterSphere: TGrayscaleMask;`
This item has no description.

	`function GetImageBounds: TRect; overload; override;`
This item has no description.

	`function GetImageBoundsWithin(const ARect: TRect; Channels: TChannels; ANothingValue: Byte = 0): TRect; overload; override;`
This item has no description.

	`function GetImageBoundsWithin(const ARect: TRect; Channel: TChannel = cAlpha; ANothingValue: Byte = 0): TRect; overload; override;`
This item has no description.

function GetPart(const ARect: TRect; CopyProperties: Boolean=False): TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.GetPart.

Get a part of the image with repetition in both directions. It means that if the bounds are within the image, the result is just that part of the image, but if the bounds are bigger than the image, the image is tiled.

	`function GetPixel(X,Y: integer): byte; overload;`
This item has no description.

	`function GetPixel(x, y: single; AResampleFilter: TResampleFilter = rfLinear; smoothBorder: boolean = true): TByteMask; overload;`
This item has no description.

	`function GetPixel256(x, y, fracX256,fracY256: int32or64; AResampleFilter: TResampleFilter = rfLinear; smoothBorder: boolean = true): TByteMask;`
This item has no description.

function GetUnique: TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.GetUnique.

Returns an object with a reference count equal to 1. Duplicate this bitmap if necessary

	`function NewBitmap(AWidth, AHeight: integer; const Color: TByteMask): TGrayscaleMask; overload; override;`
This item has no description.

	`function NewBitmap(AWidth, AHeight: integer; AColor: Pointer): TGrayscaleMask; overload; override;`
This item has no description.

	`function NewBitmap: TGrayscaleMask; overload; override;`
return type helpers

	`function NewBitmap(AWidth, AHeight: integer): TGrayscaleMask; overload; override;`
This item has no description.

function NewReference: TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.NewReference.

Adds a reference (this reference count is not the same as the reference count of an interface, it changes only by explicit calls)

function RotateCCW(ACopyProperties: Boolean=False): TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.RotateCCW.

Return a new bitmap rotated in a counter clock wise direction.

function RotateCW(ACopyProperties: Boolean=False): TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.RotateCW.

Return a new bitmap rotated in a clock wise direction.

function RotateUD(ACopyProperties: Boolean=False): TGrayscaleMask; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.RotateUD.

Return a new bitmap rotated 180° (upside down).

function ScanAt(X, Y: Single): TBGRAPixel; override;

This item has no description. Showing description inherited from IBGRAScanner.ScanAt.

Scan at any location using floating point coordinates

function ScanAtInteger(X, Y: integer): TBGRAPixel; override;

This item has no description. Showing description inherited from IBGRAScanner.ScanAtInteger.

Scan at any location using integer coordinates

	`function ScanAtIntegerMask(X,Y: integer): TByteMask; override;`
This item has no description.

	`function ScanAtMask(X,Y: Single): TByteMask; override;`
This item has no description.

	`function InternalGetPixel256(ix,iy: int32or64; iFactX,iFactY: int32or64; smoothBorder: boolean): TByteMask;`
This item has no description.

	`function InternalGetPixelCycle256(ix,iy: int32or64; iFactX,iFactY: int32or64): TByteMask;`
This item has no description.

	`function InternalNew: TCustomUniversalBitmap; override;`
This item has no description.

	`class procedure AlphaBrush(out ABrush: TUniversalBrush; AAlpha: Word); override;`
This item has no description.

	`procedure CopyFrom(ABitmap: TBGRACustomBitmap; AChannel: TChannel); overload;`
This item has no description.

	`procedure CopyFrom(ABitmap: TGrayscaleMask); overload;`
This item has no description.

	`procedure CopyPropertiesTo(ABitmap: TCustomUniversalBitmap); override;`
This item has no description.

	`procedure Draw(ABitmap: TBGRACustomBitmap; X,Y: Integer; AGammaCorrection: boolean = false);`
This item has no description.

	`procedure DrawAsAlpha(ABitmap: TBGRACustomBitmap; X,Y: Integer; texture: IBGRAScanner); overload;`
This item has no description.

	`procedure DrawAsAlpha(ABitmap: TBGRACustomBitmap; X,Y: Integer; const c: TBGRAPixel); overload;`
This item has no description.

	`class procedure EraseBrush(out ABrush: TUniversalBrush; AAlpha: Word); override;`
This item has no description.

	`procedure InplaceNormalize(ABounds: TRect); overload;`
This item has no description.

	`procedure InplaceNormalize; overload;`
This item has no description.

	`class procedure MaskBrush(out ABrush: TUniversalBrush; AScanner: IBGRAScanner; AOffsetX: integer = 0; AOffsetY: integer = 0); override;`
This item has no description.

	`procedure Negative;`
inplace filters

	`procedure NegativeRect(ABounds: TRect);`
This item has no description.

	`class procedure ScannerBrush(out ABrush: TUniversalBrush; AScanner: IBGRAScanner; ADrawMode: TDrawMode = dmDrawWithTransparency; AOffsetX: integer = 0; AOffsetY: integer = 0); override;`
This item has no description.

	`procedure ScanNextMaskChunk(var ACount: integer; out AMask: PByteMask; out AStride: integer); override;`
This item has no description.

	`procedure SetPixel(X,Y: integer; AValue: byte);`
This item has no description.

	`class procedure SolidBrush(out ABrush: TUniversalBrush; const AColor: TByteMask; ADrawMode: TDrawMode = dmDrawWithTransparency); override;`
This item has no description.

	`procedure AssignTransparentPixel(out ADest); override;`
This item has no description.

procedure Init; override;

This item has no description. Showing description inherited from TCustomUniversalBitmap.Init.

ReadWriteConfig: TBGRAReadWriteConfig;

Properties

	`property Data: PByte read FDataByte;`
This item has no description.

	`property ScanLine[Y: Integer]: PByte read GetScanLine;`
This item has no description.

Getting started

Class TGrayscaleMask

Unit

Declaration

Description

Hierarchy

Overview

Fields

Methods

Properties

Description

Fields

Methods

Properties