MGD::DEVICE_RASTER_RGB24 Class Reference

Device for rendering to 24-bit RVC raster. More...

#include <mi32/mg2rast.h>

Inheritance diagram for MGD::DEVICE_RASTER_RGB24:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DEVICE_RASTER_RGB24 ()
virtual ~DEVICE_RASTER_RGB24 ()
ERRVALUE Create (RVC::OBJITEM &ObjItem, RVC::RASTER::MAKEPARMS &MakeParms, const RVC::CREDENTIALS *Credentials=0)
ERRVALUE Create (RVC::OBJECT &ParentObject, const RVC::DESCRIPTOR &Descriptor, RVC::RASTER::MAKEPARMS &MakeParms, const RVC::CREDENTIALS *Credentials=0)
ERRVALUE GetObjItem (RVC::OBJITEM &ObjItem) const
ERRVALUE Open (const RVC::OBJITEM &ObjItem, const RVC::CREDENTIALS *Credentials=0)
ERRVALUE WritePixArray ()

Protected Member Functions

ERRVALUE ReadPixArray ()
virtual UINT8v_GetImagePointer (INT32 x, INT32 y, INT32 len, UINT16 FrameBuffer)
virtual UINT8v_GetImagePointerNoRead (INT32 x, INT32 y, INT32 len, UINT16 FrameBuffer)
virtual ERRVALUE v_WriteImageBuffer (INT32 x, INT32 y, INT32 len, UINT8 *buf, UINT16 FrameBuffer)

Private Member Functions

virtual MGD::CONTEXTv_CreateContext ()

Detailed Description

Device for rendering to 24-bit RVC raster.

Raster must have CELLTYPE_RedGreenBlue_24 or BlueGreenRed_24.


Constructor & Destructor Documentation

MGD::DEVICE_RASTER_RGB24::DEVICE_RASTER_RGB24 (  ) 

Construct a 24-bit RGB raster device.

After constructing, you should call Create()

virtual MGD::DEVICE_RASTER_RGB24::~DEVICE_RASTER_RGB24 (  )  [virtual]

Destructor.


Member Function Documentation

ERRVALUE MGD::DEVICE_RASTER_RGB24::Create ( RVC::OBJITEM ObjItem,
RVC::RASTER::MAKEPARMS MakeParms,
const RVC::CREDENTIALS Credentials = 0 
)

Create a raster to draw into.

ERRVALUE MGD::DEVICE_RASTER_RGB24::Create ( RVC::OBJECT ParentObject,
const RVC::DESCRIPTOR Descriptor,
RVC::RASTER::MAKEPARMS MakeParms,
const RVC::CREDENTIALS Credentials = 0 
)

Create a raster to draw into.

ERRVALUE MGD::DEVICE_RASTER_RGB24::GetObjItem ( RVC::OBJITEM ObjItem  )  const [inline]

Get OBJITEM for raster.

ERRVALUE MGD::DEVICE_RASTER_RGB24::Open ( const RVC::OBJITEM ObjItem,
const RVC::CREDENTIALS Credentials = 0 
)

Open existing raster to draw into.

ERRVALUE MGD::DEVICE_RASTER_RGB24::ReadPixArray (  )  [protected]

Write the pixel array from raster to buffer.

If the raster is small (less than 4096x4096), we just allocate a buffer big enough for the whole raster.

virtual MGD::CONTEXT* MGD::DEVICE_RASTER_RGB24::v_CreateContext (  )  [private, virtual]

Create a GC for drawing.

Derived classes may override this and make it return anything derived from MGD_GC. MGD_GC's constructor is private, so this is the only way for calling code to create a GC.

Reimplemented from MGD::DEVICE.

virtual UINT8* MGD::DEVICE_RASTER_RGB24::v_GetImagePointer ( INT32  x,
INT32  y,
INT32  len,
UINT16  FrameBuffer 
) [protected, virtual]

In the Raster case, this will actually read the raster.

Reimplemented from MGD::DEVICE.

virtual UINT8* MGD::DEVICE_RASTER_RGB24::v_GetImagePointerNoRead ( INT32  x,
INT32  y,
INT32  len,
UINT16  FrameBuffer 
) [protected, virtual]

If GetImagePointer returns a pointer directly into the frame buffer, this function does not need to be overridden.

If GetImagePointer has to actually read something (say via an X call to the display or reading out of a raster, then this version should just return a temporary buffer big enough to hold a single line.

Reimplemented from MGD::DEVICE.

virtual ERRVALUE MGD::DEVICE_RASTER_RGB24::v_WriteImageBuffer ( INT32  x,
INT32  y,
INT32  len,
UINT8 buf,
UINT16  FrameBuffer 
) [protected, virtual]

Write an image buffer to the display If GetImagePointer reutrns a pointer directly into the frame buffer, this method can just return 0.

If GetImagePointer has to actually read something, this method is used to write the result back out. Typically used when drawing to a raster

Reimplemented from MGD::DEVICE.

ERRVALUE MGD::DEVICE_RASTER_RGB24::WritePixArray (  ) 

Write the pixel array back to the raster.

If the raster is small (less than 4096x4096), we just allocate a buffer big enough for the whole raster. In this case, nothing gets flushed until we call WritePixArray() (which the destructor will do if necessary)


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

Generated on Sun Oct 7 21:35:17 2012 for TNTsdk 2012 by  doxygen 1.6.1