Getting Started

SDK API Reference

SDK API Features

Other Documentation

PixelMemoryDesc Struct Reference
[Channel Ports Suite Callbacks (DEPRECATED Standard Suite)]

#include <PIGeneral.h>

Detailed Description

Describes an area of memory as pixels.


Data Fields

void * data
 Coordinate of the first byte of the first pixel.
int32 rowBits
 Number of bits per row.
int32 colBits
 Number of bits per column.
int32 bitOffset
 Bit offset from the data pointer value.
int32 depth
 Pixel depth.

Field Documentation

void* PixelMemoryDesc::data

Coordinate of the first byte of the first pixel.

int32 PixelMemoryDesc::rowBits

Number of bits per row.

Should be multiple of depth, and is generally a multiple of 8, since this reflects bits rather than bytes.

int32 PixelMemoryDesc::colBits

Number of bits per column.

Should be a multiple of depth. If depth=1, then set colBits=1.

int32 PixelMemoryDesc::bitOffset

Bit offset from the data pointer value.

int32 PixelMemoryDesc::depth

Pixel depth.

The documentation for this struct was generated from the following file: