SoPNGImageRW Class Reference
[Image]

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

#include <Inventor/image/SoPNGImageRW.h>

Inheritance diagram for SoPNGImageRW:
SoRasterImageRW

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoPNGImageRW ()
virtual ~SoPNGImageRW ()
virtual SbBool open (SoRasterImageIO *rasterImageIO, OpenMode openMode)
virtual SbBool write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0)
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 PNG raster image

This class is used for encoding and decoding a PNG 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:

BigImageRender


Constructor & Destructor Documentation

SoPNGImageRW::SoPNGImageRW (  ) 

Constructor.

virtual SoPNGImageRW::~SoPNGImageRW (  )  [virtual]

Destructor.


Member Function Documentation

static SoType SoPNGImageRW::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoRasterImageRW.

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

Returns if the class can read the specific raster format.

Reimplemented from SoRasterImageRW.

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

Returns the type identifier for this specific instance.

Implements SoRasterImageRW.

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

Returns if the class can write in the specific raster format.

Reimplemented from SoRasterImageRW.

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

Specifies the write way 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 SoPNGImageRW::open ( SoRasterImageIO rasterImageIO,
OpenMode  openMode 
) [virtual]

Opens the reader/writer in the given open mode.

Reimplemented from SoRasterImageRW.

virtual SbBool SoPNGImageRW::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 SoPNGImageRW::write ( SbRasterImage rasterImage,
unsigned int  xPos = 0,
unsigned int  yPos = 0 
) [virtual]

Writes and encodes the given data in the 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.


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

Open Inventor Toolkit reference manual, generated on 4 Sep 2023
Copyright © Thermo Fisher Scientific All rights reserved.
https://www.openinventor.com/