SoBMPImageRW Class Reference
[Image]

VSG extension Class for encoding and decoding a BMP raster image More...

#include <Inventor/image/SoBMPImageRW.h>

Inheritance diagram for SoBMPImageRW:
SoRasterImageRW

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoBMPImageRW ()
virtual ~SoBMPImageRW ()
virtual SbBool open (SoRasterImageIO *rasterImageIO, OpenMode openMode)
virtual void close ()
virtual SbBool write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0)
virtual SbBool writeFooter ()
virtual SbBool read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE)
virtual SbBool isMultipleBufferInverted () const
virtual
SoRasterImageRW::WriteCapability 
getWriteCapability () const
virtual
SoRasterImageRW::ReadCapability 
getReadCapability () const

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

VSG extension Class for encoding and decoding a BMP raster image

This class is used for encoding and decoding a BMP raster image.

The writeCapability is WRITE_FULL_IMAGE and isMultipleBufferInverted is FALSE.

See SoRasterImageRW for more information and code examples.

SEE ALSO

SoRasterImageFile, SoRasterImageRW, SbRasterImage

See related examples:

BigImageRender


Constructor & Destructor Documentation

SoBMPImageRW::SoBMPImageRW (  ) 

Constructor.

virtual SoBMPImageRW::~SoBMPImageRW (  )  [virtual]

Destructor.


Member Function Documentation

virtual void SoBMPImageRW::close (  )  [virtual]

Closes the reader/writer.

Reimplemented from SoRasterImageRW.

static SoType SoBMPImageRW::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoRasterImageRW.

virtual SoRasterImageRW::ReadCapability SoBMPImageRW::getReadCapability (  )  const [virtual]

Returns the read capability of the raster format.

Reimplemented from SoRasterImageRW.

virtual SoType SoBMPImageRW::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoRasterImageRW.

virtual SoRasterImageRW::WriteCapability SoBMPImageRW::getWriteCapability (  )  const [virtual]

Returns the write capability of the raster format.

Reimplemented from SoRasterImageRW.

virtual SbBool SoBMPImageRW::isMultipleBufferInverted (  )  const [virtual]

Returns the write direction when using multiple buffers.

Returns FALSE if buffers are written from top to bottom. Returns TRUE if buffers are written from bottom to top.

Reimplemented from SoRasterImageRW.

virtual SbBool SoBMPImageRW::open ( SoRasterImageIO rasterImageIO,
OpenMode  openMode 
) [virtual]

Opens the reader/writer in the specified open mode.

Reimplemented from SoRasterImageRW.

virtual SbBool SoBMPImageRW::read ( SbRasterImage rasterImage,
SbBool  infoOnly = FALSE 
) [virtual]

Reads, decodes, and fills the rasterImage parameter.

If infoOnly is TRUE, then the buffer will not be read; the parameter rasterImage will be set with raster size and raster number of components, the buffer will be NULL.

Implements SoRasterImageRW.

virtual SbBool SoBMPImageRW::write ( SbRasterImage rasterImage,
unsigned int  xPos = 0,
unsigned int  yPos = 0 
) [virtual]

Writes the given data in this specific format.

Implements SoRasterImageRW.

virtual SbBool SoBMPImageRW::writeFooter (  )  [virtual]

Writes and encodes the footer of this specific format.

Reimplemented from SoRasterImageRW.


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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/