maspack.render

Interface TextureContent

All Superinterfaces:

ReferenceCounted

All Known Implementing Classes:

DicomPlaneTextureContent, DicomTextureContent, DTITextureContent, NiftiTextureContent, TextureContentFile, TextureContentImage, TextureContentText

public interface TextureContent
extends ReferenceCounted

Content of Texture Properties (either raw data, or file)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TextureContent.ContentFormat

Method Summary

Modifier and Type	Method and Description
TextureContent	acquire() Signal the resource that something is holding a reference to it.
void	getData(java.nio.ByteBuffer out) Get raw byte data of content, rasterized in row-major form, with (0,0) in the bottom-left corner.
void	getData(Rectangle rect, java.nio.ByteBuffer out) 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 getData(java.nio.ByteBuffer)
int	getHeight() Number of pixels across height in content
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 interface maspack.util.ReferenceCounted

acquireAndCount, getReferenceCount, release, releaseAndCount

Method Detail

getWidth

int getWidth()

Number of pixels across width in content

Returns:

number of pixels

getHeight

int getHeight()

Number of pixels across height in content

Returns:

number of pixels

getPixelSize

int getPixelSize()

Size of pixels in bytes

Returns:

size

getData

void getData(java.nio.ByteBuffer out)

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

getData

void getData(Rectangle rect,
             java.nio.ByteBuffer out)

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

Parameters:

rect - rectangular region to acquire data for

out - buffer to fill

isDirty

boolean isDirty()

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

getDirty

Rectangle getDirty()

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

Returns:

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

markClean

void markClean()

Mark the entire texture as being clean

getFormat

TextureContent.ContentFormat getFormat()

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

Returns:

format of data in buffer

See Also:

getData(java.nio.ByteBuffer)

getKey

java.lang.Object getKey()

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)

Returns:

uniquely identifying key

acquire

TextureContent acquire()

Description copied from interface: ReferenceCounted

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

Specified by:

acquire in interface ReferenceCounted

Returns:

a reference to the acquired object for convenience.