PVideoOutputDeviceRGB Class Reference

#include <videoio.h>

Inheritance diagram for PVideoOutputDeviceRGB:

PVideoOutputDevice PVideoDevice PObject

List of all members.

Public Member Functions

 PVideoOutputDeviceRGB ()
virtual BOOL SetColourFormat (const PString &colourFormat)
virtual BOOL SetFrameSize (unsigned width, unsigned height)
virtual PINDEX GetMaxFrameBytes ()
virtual BOOL SetFrameData (unsigned x, unsigned y, unsigned width, unsigned height, const BYTE *data, BOOL endFrame=TRUE)
virtual BOOL FrameComplete ()=0

Protected Attributes

PMutex mutex
PBYTEArray frameStore
PINDEX bytesPerPixel
PINDEX scanLineWidth
bool swappedRedAndBlue


Detailed Description

This class defines a video output device for RGB in a frame store.

Constructor & Destructor Documentation

PVideoOutputDeviceRGB::PVideoOutputDeviceRGB (  ) 

Create a new video output device.


Member Function Documentation

virtual BOOL PVideoOutputDeviceRGB::SetColourFormat ( const PString colourFormat  )  [virtual]

Set the colour format to be used. Note that this function does not do any conversion. If it returns TRUE then the video device does the colour format in native mode.

To utilise an internal converter use the SetColourFormatConverter() function.

Default behaviour sets the value of the colourFormat variable and then returns TRUE.

Reimplemented from PVideoDevice.

virtual BOOL PVideoOutputDeviceRGB::SetFrameSize ( unsigned  width,
unsigned  height 
) [virtual]

Set the frame size to be used.

Note that devices may not be able to produce the requested size, and this function will fail. See SetFrameSizeConverter().

Default behaviour sets the frameWidth and frameHeight variables and returns TRUE.

Parameters:
width  New width of frame
height  New height of frame

Reimplemented from PVideoDevice.

virtual PINDEX PVideoOutputDeviceRGB::GetMaxFrameBytes (  )  [virtual]

Get the maximum frame size in bytes.

Note a particular device may be able to provide variable length frames (eg motion JPEG) so will be the maximum size of all frames.

Implements PVideoDevice.

virtual BOOL PVideoOutputDeviceRGB::SetFrameData ( unsigned  x,
unsigned  y,
unsigned  width,
unsigned  height,
const BYTE *  data,
BOOL  endFrame = TRUE 
) [virtual]

Set a section of the output frame buffer.

Implements PVideoOutputDevice.

virtual BOOL PVideoOutputDeviceRGB::FrameComplete (  )  [pure virtual]

Indicate frame may be displayed.


Member Data Documentation

PMutex PVideoOutputDeviceRGB::mutex [protected]

PBYTEArray PVideoOutputDeviceRGB::frameStore [protected]

PINDEX PVideoOutputDeviceRGB::bytesPerPixel [protected]

PINDEX PVideoOutputDeviceRGB::scanLineWidth [protected]

bool PVideoOutputDeviceRGB::swappedRedAndBlue [protected]


The documentation for this class was generated from the following file:
Generated on Fri Sep 21 14:40:16 2007 for PWLib by  doxygen 1.5.3