| java.lang.Object
 javax.media.j3d.NioImageBuffer
| NioImageBuffer | | public class NioImageBuffer (Code) | | The NioImageBuffer class is a container for an image whose DataBuffer
is specified via a java.nio.Buffer. An an NioImageBuffer can be wrapped by
an ImageComponent and used for texture mapping, or for rendering Raster
objects or background images. An NioImageBuffer must not be used as the
buffer of an off-screen Canvas3D, or for reading back a raster image.
See Also: ImageComponent2D
See Also: ImageComponent3D
since:
Java 3D 1.5 |
| Inner Class :public enum ImageType | |
| Inner Class : enum BufferType | |
| Constructor Summary | |
| public | NioImageBuffer(int width, int height, ImageType imageType)
Constructs an NIO image buffer of the specified size and type. | | public | NioImageBuffer(int width, int height, ImageType imageType, Buffer dataBuffer)
Constructs an NIO image buffer of the specified size and type, using
the specified dataBuffer.
The the byte order of the specified dataBuffer must match the native
byte order of the underlying platform.
For best performance, the NIO buffer should be a direct buffer.
Parameters:
width - width of the image
Parameters:
height - height of the image
Parameters:
imageType - type of the image.
Parameters:
dataBuffer - an NIO buffer of the correct type (ByteBuffer orIntBuffer) to match the specified imageType.This constructor will create a new view ofthe buffer, and will call rewind on that view,such that elements 0 through dataBuffer.limit()-1will be available internally. |
| Method Summary | |
| public Buffer | getDataBuffer()
Gets the data buffer to the specified input data buffer. | | public int | getHeight()
Gets the height of this data buffer. | | public ImageType | getImageType()
Gets the image type of this data buffer. | | public int | getWidth()
Gets the width of this data buffer. | | public void | setDataBuffer(Buffer dataBuffer)
Sets the data buffer to the specified input data buffer.
The the byte order of the specified dataBuffer must match the native
byte order of the underlying platform.
For best performance, the NIO buffer should be a direct buffer.
Parameters:
dataBuffer - an NIO buffer of the correct type (ByteBuffer orIntBuffer) to match the imageType of thisNioImageBuffer. |
| bufferType | | BufferType bufferType(Code) | | |
| bytesPerPixel | | int bytesPerPixel(Code) | | |
| elementsPerPixel | | int elementsPerPixel(Code) | | |
| imageType | | ImageType imageType(Code) | | |
| NioImageBuffer | | public NioImageBuffer(int width, int height, ImageType imageType)(Code) | | Constructs an NIO image buffer of the specified size and type.
A direct NIO buffer of the correct type (ByteBuffer or IntBuffer)
and size to match the input parameters
is allocated.
Parameters:
width - width of the image
Parameters:
height - height of the image
Parameters:
imageType - type of the image.
exception:
IllegalArgumentException - if width < 1 or height < 1
exception:
NullPointerException - if imageType is null |
| NioImageBuffer | | public NioImageBuffer(int width, int height, ImageType imageType, Buffer dataBuffer)(Code) | | Constructs an NIO image buffer of the specified size and type, using
the specified dataBuffer.
The the byte order of the specified dataBuffer must match the native
byte order of the underlying platform.
For best performance, the NIO buffer should be a direct buffer.
Parameters:
width - width of the image
Parameters:
height - height of the image
Parameters:
imageType - type of the image.
Parameters:
dataBuffer - an NIO buffer of the correct type (ByteBuffer orIntBuffer) to match the specified imageType.This constructor will create a new view ofthe buffer, and will call rewind on that view,such that elements 0 through dataBuffer.limit()-1will be available internally. The number of elements inthe buffer must be exactly width*height*numElementsPerPixel,where numElementsPerPixel is3 for TYPE_3BYTE_BGR and TYPE_3BYTE_RGB,4 for TYPE_4BYTE_ABGR and TYPE_4BYTE_RGBA,and 1 for all other types.
exception:
IllegalArgumentException - if width < 1 or height < 1
exception:
NullPointerException - if imageType or dataBuffer is null
exception:
IllegalArgumentException - if the type of the dataBuffer doesnot match the imageType
exception:
IllegalArgumentException - if dataBuffer.limit() !=width*height*numElementsPerPixel
exception:
IllegalArgumentException - if the byte order of the specifieddataBuffer does not match the native byte order of the underlyingplatform. |
| getDataBuffer | | public Buffer getDataBuffer()(Code) | | Gets the data buffer to the specified input data buffer.
a view of the current data buffer for this NIO image buffer.This view will be rewound such that elements 0through dataBuffer.limit()-1 are available. |
| getHeight | | public int getHeight()(Code) | | Gets the height of this data buffer.
the width of this data buffer. |
| getImageType | | public ImageType getImageType()(Code) | | Gets the image type of this data buffer.
the image type of this data buffer. |
| getWidth | | public int getWidth()(Code) | | Gets the width of this data buffer.
the width of this data buffer. |
| setDataBuffer | | public void setDataBuffer(Buffer dataBuffer)(Code) | | Sets the data buffer to the specified input data buffer.
The the byte order of the specified dataBuffer must match the native
byte order of the underlying platform.
For best performance, the NIO buffer should be a direct buffer.
Parameters:
dataBuffer - an NIO buffer of the correct type (ByteBuffer orIntBuffer) to match the imageType of thisNioImageBuffer. This method will create a new view ofthe buffer, and will call rewind on that view,such that elements 0 through dataBuffer.limit()-1will be available internally. The number of elements inthe buffer must be exactly width*height*numElementsPerPixel,where numElementsPerPixel is3 for TYPE_3BYTE_BGR and TYPE_3BYTE_RGB,4 for TYPE_4BYTE_ABGR and TYPE_4BYTE_RGBA,and 1 for all other types.
exception:
NullPointerException - if dataBuffer is null
exception:
IllegalArgumentException - if the type of the dataBuffer doesnot match the imageType
exception:
IllegalArgumentException - if dataBuffer.limit() !=width*height*numElementsPerPixel
exception:
IllegalArgumentException - if the byte order of the specifieddataBuffer does not match the native byte order of the underlyingplatform. |
|
|