Package org.web3d.image

Class NIOBufferImage

java.lang.Object

org.web3d.image.NIOBufferImage

public class NIOBufferImage
extends Object

A representation of an image contained in a ByteBuffer.

Version:

$Revision: 1.4 $

Author:

Rex Melton

Constructor Summary

Constructors

Constructor	Description
NIOBufferImage(int width, int height, NIOBufferImageType type)	Constructor
NIOBufferImage(int width, int height, NIOBufferImageType type, boolean isGrayScale, ByteBuffer buffer)	Constructor
NIOBufferImage(int width, int height, NIOBufferImageType type, ByteBuffer buffer)	Constructor

Method Summary

Modifier and Type	Method	Description
ByteBuffer	getBuffer()	Return the image buffer
ByteBuffer[]	getBuffer(ByteBuffer[] ret_buf)	Return the image buffer array
int	getHeight()	Return the image height
int	getLevels()	Return the number of image levels
NIOBufferImageType	getType()	Return the image format type
int	getWidth()	Return the image width
boolean	hasTransparency()	Return whether the image includes alpha (1 - transparency) components
boolean	isGrayScale()	Return whether the image should be treated as grayscale
void	setBuffer(ByteBuffer buffer)	Set the image buffer
void	setBuffer(ByteBuffer[] buffer)	Set the image buffer array
String	toString()	Return a description of the image

Methods inherited from class java.lang.Object

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

Constructor Details

NIOBufferImage

public NIOBufferImage(int width,
 int height,
 NIOBufferImageType type)

Constructor

Parameters:

width - The image width

height - The image height

type - The image format type

Throws:

IllegalArgumentException - if either the width or height arguments are not positive integers

NullPointerException - if the type argument is null

NIOBufferImage

public NIOBufferImage(int width,
 int height,
 NIOBufferImageType type,
 ByteBuffer buffer)

Constructor

Parameters:

width - The image width

height - The image height

type - The image format type

buffer - The image data

Throws:

IllegalArgumentException - if either the width or height arguments are not positive integers

NullPointerException - if either the type or buffer argument are null

IllegalArgumentException - if the buffer is insufficiently sized

NIOBufferImage

public NIOBufferImage(int width,
 int height,
 NIOBufferImageType type,
 boolean isGrayScale,
 ByteBuffer buffer)

Constructor

Parameters:

width - The image width

height - The image height

type - The image format type

isGrayScale - Flag indicating that the image should be treated as grayscale, regardless of the format

buffer - The image data

Throws:

IllegalArgumentException - if either the width or height arguments are not positive integers

NullPointerException - if either the type or buffer argument are null

IllegalArgumentException - if the buffer is insufficiently sized

Method Details

getWidth

public int getWidth()

Return the image width

Returns:

The image width

getHeight

public int getHeight()

Return the image height

Returns:

The image height

getType

public NIOBufferImageType getType()

Return the image format type

Returns:

The image format type

isGrayScale

public boolean isGrayScale()

Return whether the image should be treated as grayscale

Returns:

whether the image should be treated as grayscale

hasTransparency

public boolean hasTransparency()

Return whether the image includes alpha (1 - transparency) components

Returns:

whether the image should be treated as having alpha (1 - transparency) components

getLevels

public int getLevels()

Return the number of image levels

Returns:

The number of image levels

getBuffer

public ByteBuffer getBuffer()

Return the image buffer

Returns:

The image buffer

getBuffer

public ByteBuffer[] getBuffer(ByteBuffer[] ret_buf)

Return the image buffer array

Parameters:

ret_buf -

Returns:

The image buffer array

setBuffer

public void setBuffer(ByteBuffer buffer)

Set the image buffer

Parameters:

buffer - The image buffer

Throws:

NullPointerException - if the argument buffer is null

IllegalArgumentException - if the buffer is insufficiently sized

setBuffer

public void setBuffer(ByteBuffer[] buffer)

Set the image buffer array

Parameters:

buffer - The image buffer

Throws:

NullPointerException - if the argument buffer is null

IllegalArgumentException - if the buffer is insufficiently sized

toString

public String toString()

Return a description of the image

Overrides:

toString in class Object

Returns:

a description of the image