maspack.render

Class TextureContentImage

java.lang.Object

maspack.util.ReferenceCountedBase

maspack.render.TextureContentImage

All Implemented Interfaces:

TextureContent, ReferenceCounted

Direct Known Subclasses:

TextureContentFile

public class TextureContentImage
extends ReferenceCountedBase
implements TextureContent

Nested Class Summary

Nested classes/interfaces inherited from interface maspack.render.TextureContent

TextureContent.ContentFormat

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_USE_POWER_OF_TWO

Constructor Summary

Constructors

Constructor and Description
TextureContentImage()
TextureContentImage(java.awt.image.BufferedImage image)
TextureContentImage(java.awt.image.BufferedImage image, boolean powerOfTwo)

Method Summary

Modifier and Type	Method and Description
TextureContentImage	acquire() Signal the resource that something is holding a reference to it.
void	getData(java.nio.ByteBuffer buff) Get raw byte data of content, rasterized in row-major form, with (0,0) in the bottom-left corner.
void	getData(Rectangle region, java.nio.ByteBuffer buff) Get raw byte data for a region, rasterized in row-major form with (0,0) in the bottom-left corner.
Rectangle	getDirty() The portion of the texture that has been modified (marked "dirty")
TextureContent.ContentFormat	getFormat() Format of data returned by TextureContent.getData(java.nio.ByteBuffer)
int	getHeight() Number of pixels across height in content
java.awt.image.BufferedImage	getImage()
java.lang.Object	getKey() A key for referring to this texture.
int	getPixelSize() Size of pixels in bytes
int	getWidth() Number of pixels across width in content
boolean	isDirty() All or part of the texture has been marked as "dirty" (i.e.
void	markClean() Mark the entire texture as being clean

Methods inherited from class maspack.util.ReferenceCountedBase

acquireAndCount, getReferenceCount, release, releaseAndCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.util.ReferenceCounted

acquireAndCount, getReferenceCount, release, releaseAndCount

Field Detail

DEFAULT_USE_POWER_OF_TWO

public static boolean DEFAULT_USE_POWER_OF_TWO

Constructor Detail

TextureContentImage

public TextureContentImage()

TextureContentImage

public TextureContentImage(java.awt.image.BufferedImage image)

TextureContentImage

public TextureContentImage(java.awt.image.BufferedImage image,
                           boolean powerOfTwo)

Method Detail

getWidth

public int getWidth()

Description copied from interface: TextureContent

Number of pixels across width in content

Specified by:

getWidth in interface TextureContent

Returns:

number of pixels

getHeight

public int getHeight()

Description copied from interface: TextureContent

Number of pixels across height in content

Specified by:

getHeight in interface TextureContent

Returns:

number of pixels

getPixelSize

public int getPixelSize()

Description copied from interface: TextureContent

Size of pixels in bytes

Specified by:

getPixelSize in interface TextureContent

Returns:

size

getImage

public java.awt.image.BufferedImage getImage()

getData

public void getData(java.nio.ByteBuffer buff)

Description copied from interface: TextureContent

Get raw byte data of content, rasterized in row-major form, with (0,0) in the bottom-left corner.

Specified by:

getData in interface TextureContent

getData

public void getData(Rectangle region,
                    java.nio.ByteBuffer buff)

Description copied from interface: TextureContent

Get raw byte data for a region, rasterized in row-major form with (0,0) in the bottom-left corner.

Specified by:

getData in interface TextureContent

Parameters:

region - rectangular region to acquire data for

buff - buffer to fill

getFormat

public TextureContent.ContentFormat getFormat()

Description copied from interface: TextureContent

Format of data returned by TextureContent.getData(java.nio.ByteBuffer)

Specified by:

getFormat in interface TextureContent

Returns:

format of data in buffer

See Also:

TextureContent.getData(java.nio.ByteBuffer)

acquire

public TextureContentImage acquire()

Description copied from interface: ReferenceCounted

Signal the resource that something is holding a reference to it.

Specified by:

acquire in interface TextureContent

Specified by:

acquire in interface ReferenceCounted

Overrides:

acquire in class ReferenceCountedBase

Returns:

a reference to the acquired object for convenience.

isDirty

public boolean isDirty()

Description copied from interface: TextureContent

All or part of the texture has been marked as "dirty" (i.e. updated)

Specified by:

isDirty in interface TextureContent

getDirty

public Rectangle getDirty()

Description copied from interface: TextureContent

The portion of the texture that has been modified (marked "dirty")

Specified by:

getDirty in interface TextureContent

Returns:

bounding region of dirty area, null if nothing marked as dirty

markClean

public void markClean()

Description copied from interface: TextureContent

Mark the entire texture as being clean

Specified by:

markClean in interface TextureContent

getKey

public java.lang.Object getKey()

Description copied from interface: TextureContent

A key for referring to this texture. If two contents have the same key, then it is assumed they have the same underlying data (e.g. a filename, if loaded directly from a file). The key should be immutable (at least from a hashcode/equals perspective)

Specified by:

getKey in interface TextureContent

Returns:

uniquely identifying key