SoJPEGImageRW Class Reference
[Image]
Class for encoding and decoding a JPEG raster image
More...
#include <Inventor/image/SoJPEGImageRW.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoJPEGImageRW () | |
| virtual | ~SoJPEGImageRW () |
| 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 |
| void | setOutputQuality (float quality) |
| float | getOutputQuality () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Class for encoding and decoding a JPEG raster image
This class is used for encoding and decoding a JPEG raster image.
The writeCapability is WRITE_SCANLINES and isMultipleBufferInverted is TRUE.
See SoRasterImageRW for more information and code examples.
SEE ALSO
SoRasterImageFile, SoRasterImageRW, SbRasterImage
- See related examples:
Constructor & Destructor Documentation
| SoJPEGImageRW::SoJPEGImageRW | ( | ) |
Constructor.
| virtual SoJPEGImageRW::~SoJPEGImageRW | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void SoJPEGImageRW::close | ( | ) | [virtual] |
Closes the reader/writer.
Reimplemented from SoRasterImageRW.
| static SoType SoJPEGImageRW::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageRW.
| float SoJPEGImageRW::getOutputQuality | ( | ) | const |
Returns the output quality.
| virtual SoRasterImageRW::ReadCapability SoJPEGImageRW::getReadCapability | ( | ) | const [virtual] |
Returns the read capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SoType SoJPEGImageRW::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
| virtual SoRasterImageRW::WriteCapability SoJPEGImageRW::getWriteCapability | ( | ) | const [virtual] |
Returns the write capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoJPEGImageRW::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 SoJPEGImageRW::open | ( | SoRasterImageIO * | rasterImageIO, | |
| OpenMode | openMode | |||
| ) | [virtual] |
Opens the reader/writer in the specified open mode.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoJPEGImageRW::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.
| void SoJPEGImageRW::setOutputQuality | ( | float | quality | ) |
Sets the output quality of the image, from 0.0 (lowest quality) to 1.0 (highest quality).
Default is 0.7
| virtual SbBool SoJPEGImageRW::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 specify the offset (with xPos,yPos) you want to write to.
Implements SoRasterImageRW.
| virtual SbBool SoJPEGImageRW::writeFooter | ( | ) | [virtual] |
Writes and encodes the header for this specific format.
Reimplemented from SoRasterImageRW.
The documentation for this class was generated from the following file:
- Inventor/image/SoJPEGImageRW.h