| SoDDSImageRW Class |
Class for decoding a DDS raster image.
Inheritance HierarchyNamespace: OIV.Inventor.Image
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.0.0 (2024.1.0)
SyntaxThe SoDDSImageRW type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoDDSImageRW | Constructor. |
Methods| Name | Description | |
|---|---|---|
| CheckRead | Checks if the specified file can be read. |
| Close | Closes the reader/writer. |
| EnableMultipleWriting | Enable writing image with multiple calls to write method. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetReadCapability | Returns the read capability of the raster format. |
| GetSuffixes | Returns the list of file suffixes supported. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWriteCapability | Returns the write capability of the raster format. |
| IsMultipleBufferInverted | Returns the write order when using multiple buffers. |
| IsMultipleWritingEnabled | Returns true if multiple buffer writing is enabled. |
| Open | Opens the reader/writer in the specified open mode. |
| Read(SbRasterImage) | Calls Read(rasterImage, false). (Inherited from SoRasterImageRW.) |
| Read(SbRasterImage, Boolean) | Read the current open image into rasterImage. |
| ReadRegion | Read the specified region of current open image into rasterImage. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write(SbRasterImage) | Calls Write(rasterImage, System.UInt32(0), System.UInt32(0)). (Inherited from SoRasterImageRW.) |
| Write(SbRasterImage, UInt32) | Calls Write(rasterImage, xPos, System.UInt32(0)). (Inherited from SoRasterImageRW.) |
| Write(SbRasterImage, UInt32, UInt32) | Writes and encodes the given data in the specific format. |
| WriteFooter | (Inherited from SoRasterImageRW.) |
| WriteHeader(SbVec2i32) | Writes and encodes the header for this specific format. |
| WriteHeader(SbVec2s) | Obsolete. Writes and encodes the header for this specific format. |
RemarksThis class is used for decoding a DDS (DirectDraw Surface) raster image.
DDS files are faster to load and use less memory than other image file formats, because the compressed data is sent directly to the graphics device (no decompression is done on the CPU).
Formats: This class is able to read DDS files compressed with DXT1 with 1-bit Alpha, DXT3, and DXT5 compression. The other formats which can be contained by a DDS file (e.g. DXT2 and DXT4) are not currently supported.
Mipmaps: This format can also embed mipmaps (levels of resolution), but all levels (from higher resolution to a 1*1 pixel image) are not necessarily required. The OIV.Inventor.Nodes.SoComplexity.textureQuality field has no effect on mipmap generation if the DDS file already embeds mipmaps.
NOTE: File encoding and writing is not currently supported.
See OIV.Inventor.Image.SoRasterImageRW for more information and code examples.
See Also