SoSGIRGBImageRW Class Reference
[Image]
Class for encoding and decoding an SGI raster image
More...
#include <Inventor/image/SoSGIRGBImageRW.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoSGIRGBImageRW () | |
| virtual | ~SoSGIRGBImageRW () |
| virtual SbBool | open (SoRasterImageIO *rasterImageIO, OpenMode openMode) |
| 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
Class for encoding and decoding an SGI raster image
This class is used for encoding and decoding an SGI raster image.
The writeCapability is WRITE_SCANLINES and isMultipleBufferInverted is FALSE.
See SoRasterImageRW for more information and code examples.
SEE ALSO
- See related examples:
Constructor & Destructor Documentation
| SoSGIRGBImageRW::SoSGIRGBImageRW | ( | ) |
Constructor.
| virtual SoSGIRGBImageRW::~SoSGIRGBImageRW | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| static SoType SoSGIRGBImageRW::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageRW.
| virtual SoRasterImageRW::ReadCapability SoSGIRGBImageRW::getReadCapability | ( | ) | const [virtual] |
Returns the read capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SoType SoSGIRGBImageRW::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
| virtual SoRasterImageRW::WriteCapability SoSGIRGBImageRW::getWriteCapability | ( | ) | const [virtual] |
Returns the write capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoSGIRGBImageRW::isMultipleBufferInverted | ( | ) | const [virtual] |
Specifies 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 SoSGIRGBImageRW::open | ( | SoRasterImageIO * | rasterImageIO, | |
| OpenMode | openMode | |||
| ) | [virtual] |
Opens the reader/writer in the specified open mode.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoSGIRGBImageRW::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 SoSGIRGBImageRW::write | ( | SbRasterImage * | rasterImage, | |
| unsigned int | xPos = 0, |
|||
| unsigned int | yPos = 0 | |||
| ) | [virtual] |
Writes and encodes the given data in this specific format.
If you are using the multiple writing mode, then you can give the offset (with xPos,yPos) you want to write to.
Implements SoRasterImageRW.
| virtual SbBool SoSGIRGBImageRW::writeFooter | ( | ) | [virtual] |
Writes and encodes the footer for this specific format.
Reimplemented from SoRasterImageRW.
The documentation for this class was generated from the following file:
- Inventor/image/SoSGIRGBImageRW.h