Class TRGBFloatImage

Unit

Declaration

type TRGBFloatImage = class(TCastleImage)

Description

Image with high-precision RGB colors encoded as 3 floats.

Hierarchy

Overview

Methods

Protected function GetColors(const X, Y, Z: Integer): TCastleColor; override;
Protected procedure SetColors(const X, Y, Z: Integer; const C: TCastleColor); override;
Public class function PixelSize: Cardinal; override;
Public class function ColorComponentsCount: Cardinal; override;
Public function PixelPtr(const X, Y: Cardinal; const Z: Cardinal = 0): PVector3;
Public function RowPtr(const Y: Cardinal; const Z: Cardinal = 0): PVector3Array;
Public procedure InvertColors; override;
Public procedure Clear(const Pixel: TVector4Byte); overload; override;
Public function IsClear(const Pixel: TVector4Byte): boolean; overload; override;
Public procedure Clear(const Pixel: TVector3); reintroduce; overload;
Public function IsClear(const Pixel: TVector3): boolean; reintroduce; overload;
Public function ToRGBImage: TRGBImage; deprecated 'create TRGBImage and use TRGBImage.Assign';
Public function ToFpImage: TInternalCastleFpImage; override;
Public procedure ScaleColors(const Scale: Single);
Public procedure ExpColors(const Exp: Single);
Public procedure LerpWith(const Value: Single; SecondImage: TCastleImage); override;
Public class procedure MixColors(const OutputColor: Pointer; const Weights: TVector4; const AColors: TVector4Pointer); override;
Public procedure Assign(const Source: TCastleImage); override;

Properties

Public property Pixels: PVector3 read GetPixels;
Public property RGBFloatPixels: PVector3 read GetPixels; deprecated 'use Pixels';
Public property PixelsArray: PVector3Array read GetPixelsArray;

Description

Methods

Protected function GetColors(const X, Y, Z: Integer): TCastleColor; override;

This item has no description.

Protected procedure SetColors(const X, Y, Z: Integer; const C: TCastleColor); override;

This item has no description.

Public class function PixelSize: Cardinal; override;

This item has no description. Showing description inherited from TCastleImage.PixelSize.

Size of TPixel in bytes for this TCastleImage descendant.

Public class function ColorComponentsCount: Cardinal; override;

This item has no description. Showing description inherited from TCastleImage.ColorComponentsCount.

Number of color components in TPixel.

E.g. RGB is 3 components and RGB+Alpha is 4 components, RGB+Exponent is 3 components (because it describes only Red, Green and Blue values (Exponent value is just used to correctly interpret these, it's not a 4th component)).

Public function PixelPtr(const X, Y: Cardinal; const Z: Cardinal = 0): PVector3;

This item has no description.

Public function RowPtr(const Y: Cardinal; const Z: Cardinal = 0): PVector3Array;

This item has no description.

Public procedure InvertColors; override;

This item has no description. Showing description inherited from TCastleImage.InvertColors.

Inverts all colors (RGB or grayscale, but doesn't touch alpha channel). "Inverting" means changing color C in range [0..1] to 1-C, so black becomes white, white becomes black etc.

For descendants implementors: Override it if necessary, otherwise the default implementation in this class will raise EInternalError.

Public procedure Clear(const Pixel: TVector4Byte); overload; override;

This item has no description. Showing description inherited from TCastleImage.Clear.

Set all image pixels to the same color.

Public function IsClear(const Pixel: TVector4Byte): boolean; overload; override;

This item has no description. Showing description inherited from TCastleImage.IsClear.

Check do all image pixels have the same color.

Public procedure Clear(const Pixel: TVector3); reintroduce; overload;

This item has no description.

Public function IsClear(const Pixel: TVector3): boolean; reintroduce; overload;

This item has no description.

Public function ToRGBImage: TRGBImage; deprecated 'create TRGBImage and use TRGBImage.Assign';

Warning: this symbol is deprecated: create TRGBImage and use TRGBImage.Assign

Converts TRGBFloatImage to TRGBImage. Colors in pixels are simply rounded using Vector3Byte. So such conversion not only kills the floating-point precision in float format but also clamps color components to 0..1.

Public function ToFpImage: TInternalCastleFpImage; override;

This item has no description. Showing description inherited from TEncodedImage.ToFpImage.

Convert image contents to FpImage instance. The resulting instance is owned by the caller.

Public procedure ScaleColors(const Scale: Single);

Every component (red, green, blue) of every pixel is multiplied by Scale.

Public procedure ExpColors(const Exp: Single);

Every component (red, green, blue) or every pixel is changed to Power(Value, Exp). So e.g. Exp = 1/2.2 gives commonly used gamma correction.

Public procedure LerpWith(const Value: Single; SecondImage: TCastleImage); override;

This item has no description. Showing description inherited from TCastleImage.LerpWith.

Makes linear interpolation of colors from this image and the SecondImage. Intuitively, every pixel in new image is set to

(1 - Value) * Self[pixel] + Value * SecondImage[pixel]

Both images need to have the exact same size. If they are not, EImageLerpDifferentSizes is raised.

Not all TCastleImage combinations are allowed. Every subclass is required to override this to at least handle Lerp between itself. That is, TRGBImage.Lerp has to handle Lerp with other TRGBImage, TRGBAlphaImage.Lerp has to handle Lerp with other TRGBAlphaImage etc. Other combinations may be permitted, if useful and implemented. EImageLerpInvalidClasses is raised if given class combinations are not allowed.

In this class, this simply always raises EImageLerpInvalidClasses.

Public class procedure MixColors(const OutputColor: Pointer; const Weights: TVector4; const AColors: TVector4Pointer); override;

This item has no description. Showing description inherited from TCastleImage.MixColors.

Mix 4 colors, with 4 weights, into a resulting color. All 4 Colors and OutputColor must be pointers to a pixel of current image class, that is they must point to PixelSize bytes of memory.

Public procedure Assign(const Source: TCastleImage); override;

This item has no description. Showing description inherited from TCastleImage.Assign.

Copy size and contents from Source. This sets our size (Width, Height and Depth) to match Source image, and copies pixels from the Source image, converting them as closely as possible. For example, converting RGBA to RGB will strip alpha channel, but copy RGB values.

When implementing descendants: the base implementation of this method in TCastleImage handles only the case when Image class equals our own class. And raises EImageAssignmentError in other cases. Override this method if you want to actually handle some conversions when assignning.

Properties

Public property Pixels: PVector3 read GetPixels;

Pointer to pixels. Same as RawPixels, only typecasted to PVector3.

Public property RGBFloatPixels: PVector3 read GetPixels; deprecated 'use Pixels';

Warning: this symbol is deprecated: use Pixels

This item has no description.

Public property PixelsArray: PVector3Array read GetPixelsArray;

Pointer to pixels. Same as RawPixels, only typecasted to PVector3Array.


Generated by PasDoc 0.16.0.