---

ScreenClient Class Reference

A client to send screen buffers from VCC. More...

#include <ScreenClient.h>

Inherits PClient.

List of all members.

Public Methods
bool	write (const int, const int, const int, const int, const RGBTRIPLE *, const LPBYTE)
	ScreenClient (const TString &)
Private Types
typedef ScreenClient::screenInfo	screenInfo

---

Detailed Description

This object is responsible for writting screen buffers to a pipe

Definition at line 19 of file ScreenClient.h.

---

Member Typedef Documentation

typedef struct ScreenClient::screenInfo ScreenClient::screenInfo [private]

See the documentation of ScreenPipe::screenInfo

---

Constructor & Destructor Documentation

ScreenClient::ScreenClient (  const TString &    name )

Parameters: name  : A TString used to generate unique names for the various kernel objects Definition at line 17 of file ScreenClient.cpp. :PClient(TString( TEXT("SCREEN") ) + name, true) {}

---

Member Function Documentation

bool ScreenClient::write (  const int    width, const int    height, const int    clrUsed, const int    bitCount, const RGBTRIPLE *    palette, const LPBYTE    imageBits )

Writes a screen buffer to the pipe Parameters: width  : The screen buffers width height  : The screen bufers signed height clrUsed  : The number of colours in the palette bitCount  : The number of bits per pixel palette  : An array of RGBTRIPLE structures imageBits  : An array of bytes representing pixels (index or colour values depending on bpp) Definition at line 36 of file ScreenClient.cpp. References ScreenClient::screenInfo::bitCount, ScreenClient::screenInfo::clrUsed, ScreenClient::screenInfo::hdrSize, ScreenClient::screenInfo::height, Pipe::hPipe, and ScreenClient::screenInfo::width. Referenced by screenThread(). { screenInfo header; DWORD numBytesWritten; bool fOk; if( (palette == NULL && clrUsed > 0) || imageBits == NULL ) return false; header.hdrSize = sizeof(screenInfo); header.width = width; header.height = height; header.clrUsed = clrUsed; header.bitCount = bitCount; fOk = !WriteFile(hPipe, &header, sizeof(screenInfo), &numBytesWritten, NULL); if( fOk || (numBytesWritten != sizeof(screenInfo)) ) return false; if(palette != NULL){ fOk = !WriteFile(hPipe, palette, sizeof(RGBTRIPLE) * clrUsed, &numBytesWritten, NULL); if( fOk || (numBytesWritten != (sizeof(RGBTRIPLE) * clrUsed)) ) return false; } /* \note see DIBitmap documentation for an explanation of this formula */ DWORD size = (((( width * bitCount ) + 31) & ~31) >> 3) * height; fOk = !WriteFile(hPipe, imageBits, size, &numBytesWritten, NULL); if( fOk || (numBytesWritten != size) ) return false; return true; }

---

The documentation for this class was generated from the following files:

• ScreenClient.h
• ScreenClient.cpp

---