record TLockedPixels

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TLockedPixels = record

Description

This structure stores information about locked texture's portion that can be accessed by CPU. It is only valid while that region remains locked.

Overview

Fields

Bits: Pointer;
Pitch: Integer;
BytesPerPixel: Integer;
PixelFormat: TPixelFormat;
LockedRect: TIntRect;

Methods

procedure Reset;

Properties

property PixelPtr[constX,Y:Integer]: Pointer read GetPixelPtr;
property Pixels[constX,Y:Integer]: TIntColor read GetPixel write SetPixel;
property Scanline[constIndex:Integer]: Pointer read GetScanline;
property Valid: Boolean read GetValid;

Description

Fields

Bits: Pointer;

Reference to top/left memory location (arranged in series of horizontal rows) that can be accessed.

Pitch: Integer;

The number of bytes each horizontal row of pixels occupies. This may differ than the actual calculated number and may include unused or even protected memory locations, which should simply be skipped.

BytesPerPixel: Integer;

Number of bytes each pixel occupies.

PixelFormat: TPixelFormat;

Pixel format that each pixel is stored in.

LockedRect: TIntRect;

Rectangle that represents the area that was locked.

Methods

procedure Reset;

Resets all values of the structure to zero.

Properties

property PixelPtr[constX,Y:Integer]: Pointer read GetPixelPtr;

Reference to each individual pixel in the locked region.

property Pixels[constX,Y:Integer]: TIntColor read GetPixel write SetPixel;

Provides access along with the appropriate pixel-format conversion to each of the pixels in the locked region.

property Scanline[constIndex:Integer]: Pointer read GetScanline;

Reference to each individual scanline in the locked region.

property Valid: Boolean read GetValid;

Provides a sanity check on structure's values to make sure it remains valid.


Copyright © 2000 - 2017 Yuriy Kotsarenko. Help files generated by PasDoc.