com.aspose.threed

Class TextureData

java.lang.Object

com.aspose.threed.A3DObject

com.aspose.threed.TextureData

All Implemented Interfaces:

INamedObject

public class TextureData
extends A3DObject

This class contains the raw data and format definition of a texture.

Field Summary

Fields inherited from class com.aspose.threed.A3DObject

name, properties

Constructor Summary

Constructors

Constructor and Description
TextureData() Constructor of TextureData
TextureData(int width, int height, int stride, int bytesPerPixel, PixelFormat pixelFormat, byte[] data) Constructor of TextureData
TextureData(int width, int height, PixelFormat pixelFormat) Constructs a new TextureData and allocate pixel data.

Method Summary

Modifier and Type	Method and Description
static TextureData	fromFile(java.lang.String fileName) Load a texture from file
static TextureData	fromStream(Stream stream) Load a texture from stream
int	getBytesPerPixel() Number of bytes of a pixel
byte[]	getData() Raw bytes of pixel data
int	getHeight() Number of vertical pixels
PixelFormat	getPixelFormat() The pixel's format
int	getStride() Number of bytes of a scanline.
int	getWidth() Number of horizontal pixels
PixelMapping	mapPixels(PixelMapMode mapMode) Map all pixels for read/write
PixelMapping	mapPixels(PixelMapMode mapMode, PixelFormat format) Map all pixels for read/write in given pixel format
PixelMapping	mapPixels(Rect rect, PixelMapMode mapMode, PixelFormat format) Map pixels addressed by rect for reading/writing in given pixel format
void	save(Stream stream, java.lang.String format) Save texture data into specified image format
void	save(java.lang.String fileName) Save texture data into image file
void	save(java.lang.String fileName, java.lang.String format) Save texture data into image file
void	transformPixelFormat(PixelFormat pixelFormat) Transform pixel's layout to new pixel format.

Methods inherited from class com.aspose.threed.A3DObject

findProperty, getName, getProperties, getProperty, removeProperty, removeProperty, setName, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextureData

public TextureData(int width,
                   int height,
                   int stride,
                   int bytesPerPixel,
                   PixelFormat pixelFormat,
                   byte[] data)

Constructor of TextureData

TextureData

public TextureData(int width,
                   int height,
                   PixelFormat pixelFormat)

Constructs a new TextureData and allocate pixel data.

TextureData

public TextureData()

Constructor of TextureData

Method Detail

getData

public byte[] getData()

Raw bytes of pixel data

Returns:

Raw bytes of pixel data

getWidth

public int getWidth()

Number of horizontal pixels

Returns:

Number of horizontal pixels

getHeight

public int getHeight()

Number of vertical pixels

Returns:

Number of vertical pixels

getStride

public int getStride()

Number of bytes of a scanline.

Returns:

Number of bytes of a scanline.

getBytesPerPixel

public int getBytesPerPixel()

Number of bytes of a pixel

Returns:

Number of bytes of a pixel

getPixelFormat

public PixelFormat getPixelFormat()

The pixel's format

Returns:

The pixel's format

fromStream

public static TextureData fromStream(Stream stream)

Load a texture from stream

fromFile

public static TextureData fromFile(java.lang.String fileName)
                            throws java.io.IOException

Load a texture from file

Throws:

java.io.IOException

save

public void save(Stream stream,
                 java.lang.String format)

Save texture data into specified image format

Parameters:

stream - The stream that holds the saved image

format - Image format, usually file extension

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Save texture data into image file

Parameters:

fileName - The file name of where the image will be saved.

Throws:

java.io.IOException

save

public void save(java.lang.String fileName,
                 java.lang.String format)
          throws java.io.IOException

Save texture data into image file

Parameters:

fileName - The file name of where the image will be saved.

format - Image format of the output file.

Throws:

java.io.IOException

mapPixels

public PixelMapping mapPixels(PixelMapMode mapMode)

Map all pixels for read/write

Parameters:

mapMode - Map mode

mapPixels

public PixelMapping mapPixels(PixelMapMode mapMode,
                              PixelFormat format)

Map all pixels for read/write in given pixel format

Parameters:

mapMode - Map mode

format - Pixel format

mapPixels

public PixelMapping mapPixels(Rect rect,
                              PixelMapMode mapMode,
                              PixelFormat format)

Map pixels addressed by rect for reading/writing in given pixel format

Parameters:

rect - The area of pixels to be accessed

mapMode - Map mode

format - Pixel format

Returns:

Returns a mapping object, it should be disposed when no longer needed.

transformPixelFormat

public void transformPixelFormat(PixelFormat pixelFormat)

Transform pixel's layout to new pixel format.

Parameters:

pixelFormat - Destination pixel format

Throws:

java.lang.UnsupportedOperationException - When the source or destination pixel format is not supported