ReadImage(D3nfb)

ReadImage -- NFB routine to read a rectangular area of the screen

Syntax

#include "nfbWinStr.h"

void xxxReadImage (
	BoxPtr pbox,
	void *image,
	unsigned int stride,
	DrawablePtr pDraw);

Description

ReadImage( ) reads a rectangular area of the screen into image.

Arguments

pbox: describes the region to read.
image: area into which the image will be read.
stride: number of bytes from the start line of one scan line to the start of the next scan line within image. Pixels in the destination are packed to different boundaries based on the depth of the window. For depths less than 8, the pixels are packed one per byte, except for monochrome drawables, which are packed 1 bit per pixel. For depths greater than 8 bits, pixels are packed one per 32-bit word.
pDraw

Exit codes

None

Usage

The driver writer must provide this routine.

Unlike DrawImage(D3nfb), this routine does not require the hardware to deal with a planemask or alu. The driver must read the rectangle in the frame buffer specified by pbox. The contents of this rectangle must be copied into the memory pointed to by image. stride has the same meaning as when used by DrawImage(D3nfb); see ``stride'' in Developing NFB graphics adapter drivers.

Version applicability

This function is supported for NFB drivers on all releases of SCO OpenServer 5, SVR5, and AIX 5L.

Source files

Routine source: None
Driver source file: xxxImage.c
Defined in: nfbWinOps structure in xxxData.c
Prototyped in: xxxProcs.h

References

nfbWinOps(D4nfb)